X-Lite for Mac User Guide
CounterPath Corporation CounterPath Corporation Suite 300, One Bentall Centre 505 Burrard Street, Box 95 Vancouver, BC V7X 1M3 Tel: 604.320.3344 sales@counterpath.com www.counterpath.com © May 2013 CounterPath Corporation. All rights reserved. This document contains information proprietary to CounterPath Corporation, and shall not be used for engineering, design, procurement, or manufacture, in whole or in part, without the consent of CounterPath Corporation.
Contents Introduction................................................................................................................................ 1 Installation and Setup................................................................................................................. 3 Getting Ready ...................................................................................................................... 3 Configuring X-Lite ....................................................................
CounterPath Corporation iv
1 Introduction X-Lite is a softphone from CounterPath that enables you to make VoIP voice and video calls, send and receive instant messages, share online status (presence) information, and exchange files. X-Lite implements SIP-based standards for phone calls, IM and presence, allowing you to work with different VoIP service providers. X-Lite also uses XMPP-based standards for IM and presence.
CounterPath Corporation 2
2 Installation and Setup 2.1 Getting Ready Account Information After choosing a VoIP service provider, you will need the following information: • • • • User name and domain. For example, 1331@domainA.com Password Authorization Name (if applicable) Firewall traversal and other network information; see “Configuring X-Lite” on page 33. System Requirements • • Operating System: Mac OS 10.7 or 10.8. (Mac OS 10.6 is supported on a “best efforts” basis.
CounterPath Corporation 2.2 Configuring X-Lite Setting up Accounts After obtaining SIP account information from your VoIP service provider, you can set up X-Lite accounts. 1. From the menu bar, choose X-Lite > Preferences > Accounts. The Account list appears with one account (the Mac Address Book account) enabled; see below. 2. Click the + button and choose New SIP Account. The SIP Account window opens. 3.
X-Lite for Mac User Guide 2.3 Troubleshooting X-Lite includes tools for helping you troubleshoot problems. From the menu, choose Help > Troubleshooting. • • • Audio tab: While you are on a phone call, you can test the quality of the audio. Note that to perform a valid test, you should be on an established call (not a call attempt). Video tab: You can verify that your camera is working.
CounterPath Corporation 6
1 Making Phone Calls 1.1 The Onscreen Softphone Minimize to dock Close window Show/hide dial pad The Call button Call entry field See page 9. Resources. See page 23 Resize softphone Compact View To display a compact view of the softphone, hide the dialpad and hide all the resources tabs (View > Hide).
CounterPath Corporation The X-Lite Menu The menu contains the following items that are specific to X-Lite: • • • • • X-Lite > Preferences. See page 42. View. Changes how X-Lite looks. Contacts. Lets you work with contacts. Actions. Lists the actions that you can perform, depending on the current “state” of X-Lite. For example, if a contact is selected, it lists all the actions that can be performed on that contact. Help. Provides access to various service-related features.
X-Lite for Mac User Guide 1.2 Placing a Call Place the call as described in the table below. The outgoing call opens in its own call panel, below any other existing call panels. You will hear a ringing tone while X-Lite attempts to make a connection. Option Keying From the... Dialpad or computer keyboard Description 1. Enter the number or address in the call entry field using the dialpad or the computer keyboard. If entering a softphone address, you can enter the entire address (6045551212@domainA.
CounterPath Corporation Call entry field Click to place the call Auto complete suggestions For information on working with the call, see “Handling an Established Call” on page 13. Dealing with an Auto Attendant If you know that your call will be answered by an auto attendant and you know what menu items you will choose, you can include those menu items (DTMF) in the phone number when you dial it: • • • Before the first DTMF number, include at least one capital P. You can include other Ps.
X-Lite for Mac User Guide Placing another Call You can place another call. There is no limit to the number of calls you can make, although eventually the quality of audio and video will degrade because of limitations on the computer. Place the call in the usual way Existing call is automatically put on hold New outgoing call Switch between the different calls by clicking Resume on the desired call panel. That call becomes the active call and all other calls are put on hold.
CounterPath Corporation 1.3 Handling Incoming Calls X-Lite must be running to answer incoming calls. (If X-Lite is not running, incoming calls may be directed to voicemail; check with your VoIP service provider.) The new call appears in its own call panel. In addition, the Call Alert box appears, even if X-Lite is minimized. For information on call alerts, see page 43. Click. If you are on another call, that first call is automatically put on hold. You are now talking to the new caller.
X-Lite for Mac User Guide 1.4 Handling an Established Call Speakerphone Voicemail See page 19 Missed calls See page 31 Speaker and microphone control Place another call The current call is automatically put on hold). See page 11 Add as Contact If a plus symbol appears here, you can add the current caller as a contact. See “Adding a Contact using an Existing Address” on page 25. Mute Hold and resume Add video.
CounterPath Corporation 1.5 Handling Video Calls Placing a Video Call From the Dashboard Click the down arrow and choose Video call. If you mostly make video calls, you can Option-click this down arrow to reveal the “Set Video Call as default action” menu item. From the Contact List or History Click the Call icon and choose Video Call Adding Video If you have a camera, you can click Start Video to add video to an established call.
X-Lite for Mac User Guide Pausing and Resuming Video Click Stop Video on the call panel or close the video window to pause sending your video. Click Start Video to resume sending your video; the video window will open.
CounterPath Corporation 1.
X-Lite for Mac User Guide Managing the Conference Participant menu Mute. When you mute during a video call, you may also want to click Stop Video to stop the video feed. Adding another Participant If your conference currently has only one participant, you can add the other participant in any of these ways: • • • Control-click on a contact and choose Add to Conference Call. In the conference call panel, enter a name in the call entry field and click Add.
CounterPath Corporation Video Conference Calls “Video” appears beside each person Closing the video window stops sending video. tart and stop sending your video to all participants Starting a Conference with Video When you start a conference from established calls, video is included if at least one of the calls already includes video. Video is sent to all the participants. When you start a conference from scratch, video is not included. You can open your video window and choose to add video at any time.
X-Lite for Mac User Guide 1.7 Voicemail If your service includes voicemail and you have set up voicemail options (page 35), then when you have voicemail messages, the voicemail icon appears at the top of the phone (the icon may include a number). You can click the icon to automatically connect to voicemail and listen to your messages.
CounterPath Corporation 20
X-Lite for Mac User Guide 2 Other X-Lite Features 2.1 Instant Messaging Sending an IM 1. You can send an IM to a contact who has a softphone address. From the Contacts tab Control-click on the contact and choose Send IM. The contact must have a softphone address. Or click on the IM icon that appears to the right of the contact name. An active phone call If the person is a contact, choose Send Instant Message from the call panel menu.
CounterPath Corporation 2.2 Viewing the Message Archive You can view your recent IM activity for any contact. • • Control-click a contact and choose View Message Archive. Or go to the menu bar and choose View > Message Archive.
1 The Contacts Tab The Contacts tab displays your contacts. Each contact is shown with presence information and icons for singleclick phoning and IMing. If the Contacts tab is not showing, go to the menu bar and choose View > Show Contacts. Add a Contact Search field Contacts are typically organized into groups. X-Lite includes built-in groups. You can add more groups, as desired. The online status of contacts. See page 28.
CounterPath Corporation 1.1 Managing Contacts and Groups Adding a Contact Click , or control-click a group and choose Add Contact to Group. The Contact dialog appears. To enter a phone number, select the type, enter the number, and click + The new number appears in the list Field Description Contact Summary Group Click to show the list of groups. Check each group this contact should belong to. Primary Call If the contact has more than one number, select the primary number.
X-Lite for Mac User Guide Example This example shows how to add a contact when your VoIP service supports online availability via your SIP account. Enter the person’s softphone number in the Softphone field As soon as you add a Softphone entry, this field automatically appears. X-Lite will share online presence information with this person using this phone number. In addition, these fields appear. See the table for information on these fields.
CounterPath Corporation Modifying the Contact List Changing Contact Information To change the information for a contact, control-click the contact and choose Edit Profile. The Contact dialog appears (see page 24). Moving or Deleting a Contact • • To drag one or more contacts to a different group, select them and drag to the title bar of the new group. To delete one or more contacts, select them, control-click, and choose Delete or Delete Selected Items. The contacts are removed from this group.
X-Lite for Mac User Guide 1.2 Using Contacts Hover to reveal icons. Click the phone icon to call using the primary phone number. Or click the IM icon to send an IM using the primary presence address for this contact. You can watch the contact’s online status, if the contact has a softphone address. See page 30 for the meaning of the online status icons. See “Sharing Online Status” on page 28 for information on obtaining online status information.
CounterPath Corporation 1.3 Sharing Online Status You can publish your online status to contacts who have softphone address, and you can set up X-Lite to view the online status of other contacts. Typical online statuses are available, on the phone, busy, and so on.
X-Lite for Mac User Guide Receiving an Online Status Request Someone who is not one of your contacts may add you as a contact on their end, and may include your SIP address. In this case, X-Lite receives an online status request.
CounterPath Corporation Setting your Online Status Changing your Status Click the down arrow beside the online status indicator on X-Lite, and select the desired value. See the table below. Setting up Online Status Indicators Indicator Available Meaning for your Status Either: Meaning for Others’ Status You can contact this person. • You have set your status to this value. • X-Lite has determined that you are logged on but not on the phone or idle.
X-Lite for Mac User Guide 2 Using Other Resources 2.1 The History Tab Filter list Red: Incoming missed call Blue: Incoming call that was answered Green: Outgoing call, either attempted or established From the menu bar, choose View > Show History. Managing the List of Calls You can control-click on an entry in a list to: • • • • Delete the call. Delete all entries in this list. Edit the profile if the entry is a contact. Add as contact. The Contact dialog appears.
CounterPath Corporation 2.2 The Favorites Tab To view the Favorites tab go to the menu bar and choose View > Show Favorites. You can create favorites from your contact list. They will be displayed in both the contact list and in the Favorites tab. Select the desired contacts, then control-click and choose Add to Favorites. Quick links to IM or phone this person Menu for other actions You can perform nearly all the same actions on the contact in Favorites as you can in the contact list.
3 Configuring X-Lite From the menu bar, choose X-Lite > Preferences. The Preferences window appears. • • When configuring X-Lite the first time, click the Accounts tab and set up the account. Then complete other tabs as desired. After the initial setup, display whichever tab you want. 3.1 Account Account – General Fields with an asterisk are required Field Account name Protocol Use for Call Use for IM/Presence Description If desired, change the account name to something that is meaningful to you.
CounterPath Corporation Field User ID Description Domain Password Display name Typically the account number for the softphone account. For example, 6045551212 or 2766. Provided by your VoIP service provider. For example, domainA.com. Provided by your VoIP service provider. Provided by your VoIP service provider. This name is displayed in the X-Lite title bar. Authorization name Other people will see you as this name. May not be required.
X-Lite for Mac User Guide Account – Voicemail These settings let you set up to interact with your VoIP service provider’s voicemail service. Your service provider may provide the ability to set up for voicemail outside of X-Lite, for example, by phoning a softphone address and following the voice prompts, or by accessing a website. Check with your service provider to determine if another setup mechanism is available.
CounterPath Corporation Field Number for sending calls to voicemail Description Complete only if your VoIP service includes voicemail. Optional, but you must complete it if you check “Send calls to voicemail if unanswered”. This is the number that incoming calls will be forwarded to if they are unanswered after the specified interval (below). If you leave this field empty, then X-Lite will never forward calls to your service providers’ voicemail.
X-Lite for Mac User Guide Account – Topology Field Firewall traversal method Description Choose the setting recommended by your VoIP service provider: • Auto detect using ICE: Automatically determine the contact address for signaling traffic. Advertise the local IP, public IP (discovered via STUN, if available) and media relay IP and use these to automatically determine the best route for media traffic during calls.
CounterPath Corporation Account – Presence Presence allows other softphone users to see your online status, and also allows you to see the online status of others. This tab lets you set up to share presence information with contacts. Field Mode Description Choose the setting specified by your VoIP service provider: • Disabled: Presence is not supported. • Presence Agent. • Peer-to-Peer. Poll time Enter the value specified by your VoIP service provider.
X-Lite for Mac User Guide Account – Transport Field Signaling Transport Description Contact your VoIP service provider to identify the types of transport that are supported. Then choose a supported transport: • Automatic: X-Lite sets up the transport based on the capabilities of the network and the X-Lite computer. Choose this option if you do not care which transport is used.
CounterPath Corporation Account – Advanced Field Description Register Settings Reregister every Minimum time Maximum time The time interval between X-Lite’s attempts to reregister in order to refresh the account registration with the VoIP service provider for this account. A value of zero means not to reregister after the initial registration. This value is placed in the “Expires” header field of the REGISTER message.
X-Lite for Mac User Guide Field Session timer preference Description This field specifies your preference for which party should send the refresh. The preference is not a guarantee that the refresh will be performed by the specified party. The choices are: • • • • Send SIP keep-alives Use rport Send outgoing request directly to target Use old style hold None: No preference. Local refreshes: Your computer sends. Remote refreshes: The other party sends.
CounterPath Corporation 3.2 General Preferences From the menu bar, choose X-Lite > Preferences. The Preferences window appears. All the tabs on this window except for “Accounts” are preferences tabs. These tabs let you control the way that you work with X-Lite. The icons (other than Accounts) let you set up general features of X-Lite. Preferences – Application This panel lets you set your preferences for general UI behavior.
X-Lite for Mac User Guide Preferences – Alerts & Sounds This panel lets you control the alert box and lets you assign sounds. Enable Alert Displays You can control whether the Call Alert box is displayed in different situations. You can also control how you are alerted to an incoming IM: either with a small IM Alert box or with the IM window itself. Assigning Sounds You can assign specific sounds to a variety of actions or “events”. 1.
CounterPath Corporation Preferences – Devices X-Lite automatically detects devices at each startup, and selects the most appropriate device for each purpose. If you do not like this selection, you can override it on this panel. If you override a selection, it will apply the next time you start X-Lite, unless the device is no longer available, in which case X-Lite will again select the device to use. Field Description Zero touch device configuration Typically, leave on.
X-Lite for Mac User Guide Field Description Other Devices Ring on The device where you want to hear the phone ringing. Change this field only if you want to override the devices that X-Lite automatically selected. Camera This field appears only on versions of X-Lite that include video functionality. Change this field only if you want to override the devices that X-Lite automatically selected. Select the camera model.
CounterPath Corporation Preferences – Codecs Audio Codecs This panel shows all the audio codecs that are included in X-Lite. You can enable or disable codecs as desired. With only one codec enabled, all calls made will use that codec. With more than one codec enabled, X-Lite automatically chooses the best codec based on the other party’s capability, the available bandwidth, and network conditions. You cannot change the properties of any codecs.
X-Lite for Mac User Guide Video Codecs This panel shows all the video codecs that are included in X-Lite. You can enable or disable codecs as desired. You can enable or disable codecs as desired. You may decide to disable a codec even though your VoIP service provider supports it. With only one codec enabled, all calls made will use that particular compression format.
CounterPath Corporation Preferences – Calls These settings let you configure how you want auto answer to handle incoming calls, when Auto Answer is enabled. (To enable Auto Answer, see page 12). Field DTMF Description You may need to change the DTMF configuration if you cannot interact with interactive voice response systems (auto attendants, voice-activated menus, and so on). Contact your VoIP service provider for the correct setting.
A Troubleshooting From the menu bar, choose Help > Troubleshooting. The Troubleshooting window appears. Testing Audio Quality While you are on a phone call, you can test the quality of the audio. Note that to perform a valid test, you should be on an established call (not a call attempt).
CounterPath Corporation Testing Video Quality While you are on a phone call, you can test the quality of the video. Note that to perform a valid test, you should be on an established call (not a call attempt).
X-Lite for Mac User Guide Testing Audio Devices You can verify that your microphone and speakers are working and can set the volume to a comfortable level without having to actually place a phone call.
CounterPath Corporation B Dial Plan When a call attempt is made, the call input (what you type, select or drag onto the call entry field) can be modified to ensure that the call gets placed successfully. This ability to modify the input relies on the existence of a “dial plan” for the account. B.1 Dial Plan Syntax The dial plan has the following syntax: pattern[|pattern];match=1;=;[match=2; =;] Where: • • • Items in [ ] are optional.
X-Lite for Mac User Guide The following table describes the most common elements. All regular expression elements are supported. Element | Origin Regular expression rules Description Pipe character, used to separate patterns. 0 1 2 3 4 5 6 7 8 9 Literals Literal digits, used as is. # * a to z Literal characters, used as is. Special cases: Literals • The literal x character is represented by \x. • The literal t character is represented by \t.
CounterPath Corporation B.2 How the Input Is Processed Comparing Input to the Dial Plan Patterns The input is compared to the dial plan. Keep in mind that the input being compared is different depending on whether the input is dragged/selected or typed: • • If the input is dragged or selected, then the entire input is compared to the dial plan. If you are typing the input, then the digits are compared one by one as they are entered. Each time a new digit is entered, the comparison starts over.
X-Lite for Mac User Guide [2-9]xxxxxxxxx The third pattern is any ten-digit number beginning with a number other than 1. The assumption is that this is a local PSTN call within a ten-digit dialing zone. +x.T; The fourth pattern is a number of any length that begins with +, to indicate an international PSTN call from North America. Delete the +, prefix with 9011 (011 is the number to access an international line from North America).
CounterPath Corporation C Exporting Contacts You can export a contact list to a comma-separated file. 1. From the menu bar, choose Contacts > Export Contacts. The Export Contacts wizard starts. 2. Select the file type and file location for the created file. A file of the specified type is created.
X-Lite for Mac User Guide D Glossary Broadband Codec Dial plan DTMF Firewall IM MWI Narrowband Presence PSTN SIP account Softphone address USB device VoIP service provider Broad or wide bandwidth. In data transmission, the wider the band, the more data it is possible to transmit in a given time span. A cable, DSL and ADSL connection to the network provide broadband for data transmission. A dialup or ISDN connection typically provide a narrow bandwidth for data transmission.
CounterPath Corporation 58
