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 2014 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 31.
CounterPath Corporation 2.2 Configuring X-Lite Setting up Notifications X-Lite uses OS notifications. Make sure that the notifications are set up for X-Lite in system preferences. From the menu, click Apple logo > System Preferences > Notifications. In the notification center, choose XLite. Choose Banner or Alerts for the alert style. For details on incoming call notifications, see page 15.
X-Lite for Mac User Guide You can: • • Add addresses to the Contact list one by one. See page 21. During a call that you place or receive, you can add the other party to your contact list. See “Handling an Established Call” on page 13. For general information on contacts, see page 21. 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.
6
X-Lite for Mac User Guide 3 Making Phone Calls 3.1 The Onscreen Softphone Minimize to dock Close window The Call button Call entry field See page 9. Resources.
CounterPath Corporation The X-Lite Menu The menu contains the following items that are specific to X-Lite: • • • • X-Lite > Preferences. See page 41. View. Changes how X-Lite looks. Contacts. Lets you work with contacts. Help. Provides access to various service-related features. Receiving an Online Status Request When you start X-Lite, one of the first things you may see (if presence is enabled) is an Online Status Request dialog. See “Sharing Online Status” on page 25.
X-Lite for Mac User Guide 3.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 3.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.) When X-Lite is in the foreground, the new call appears in its own call panel. When X-Lite is in the background (the focus is on other application), the incoming call notification appears in the upper-right corner.
X-Lite for Mac User Guide 3.4 Handling an Established Call Voicemail Volume on all See page 17 calls Missed calls Mute what you See page 29 hear on all calls Speakerphone or headset mode 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 22. Place another call Conference Calls See page 15 Instant Message See page 19 The current call is automatically put on hold).
CounterPath Corporation 3.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. Adding Video If you have a camera, you can click Start Video to add video to an established call. When you add video, the other party may (or may not) start sending their video to you.
X-Lite for Mac User Guide 3.
CounterPath Corporation 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, click Invite to Conference Call and then click Add.
X-Lite for Mac User Guide Video Conference Calls “Video” appears beside each person Closing the video window stops sending video. Start and stop sending your video to all participants Start 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.
18
X-Lite for Mac User Guide 4 Other X-Lite Features 4.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.
20
X-Lite for Mac User Guide 5 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. Search field Add a Contact 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 25.
CounterPath Corporation 5.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 21). 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 5.2 Using Contacts Hover to reveal icons Click to send an IM using the primary presence address for this contact. Click to call using the primary phone number. You can watch the contact’s online status, if the contact has a softphone address. See page 27 for the meaning of the online status icons. See “Sharing Online Status” on page 25 for information on obtaining online status information.
CounterPath Corporation 5.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.
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 6 Using Other Resources 6.1 The History Tab From the menu bar, choose View > Show History Filter list Blue: Incoming call that was answered Red: Incoming missed call Green: Outgoing call, either attempted or established 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 6.2 The Favorites Tab 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. o to the menu bar and choose View > Show Favorites. Quick links to phone or IM 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.
7 Configuring X-Lite From the menu bar, choose X-Lite > Preferences. The Preferences window appears. 7.1 Account Setting up an Account to Make Phone Calls Choose X-Lite > Preferences and click the Accounts tab. Complete the tabs as described on the following pages. When you click OK on any tab, the Account list reappears The newly created account now appears in the list.
CounterPath Corporation 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. For example, the name of the VoIP service provider. Read-only. Always specifies SIP. If checked, this account is eligible to be used for phone calls. If unchecked, this account will never be used for placing phone calls.
X-Lite for Mac User Guide Field Dial Plan Description Information about the syntax of the numbers used by this VoIP service provider. Provided by the service provider. The default plan is: #1\a\a.T;match=1;prestrip=2; For information on determining whether you need to modify the default dial plan, see page 51.
CounterPath Corporation 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.
X-Lite for Mac User Guide Field Send calls to voicemail if unanswered Description Complete only if your VoIP service includes voicemail. To send to voicemail after the specified number of seconds. Your service provider may also provide a similar feature that is set up outside of X-Lite. If so, make sure you do not enter competing information in X-Lite and in the service provider’s user interface.
CounterPath Corporation 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.
X-Lite for Mac User Guide 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.
CounterPath Corporation 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.
X-Lite for Mac User Guide 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.
CounterPath Corporation Field Send outgoing request directly to target Use old style hold 40 Description When checked, requests with a complete URI (user@ABC.com) go to ABC.com and the “Send outbound via” field on the General tab (page 32) is ignored. If you check this field, make sure you also set “Send outbound via” (on the General tab) to “Domain”. Typically off. This field is intended for test labs and may cause problems in a NAT environment.
X-Lite for Mac User Guide 7.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.
CounterPath Corporation Preferences – Alerts & Sounds This panel lets you control the alert box and lets you assign sounds. Enable Alert Displays You can control whether notifications are displayed in different situations. To receive notifications: 1. Set up to use either Banners or Alerts under OS’s system preferences (page 4). When “Enable alert displays” is on, X-Lite shows either a banner or an alert for selected situations. 2.
X-Lite for Mac User Guide 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.
CounterPath Corporation Field Camera Description 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. Resolution Leave at standard, or change the size as follows: • Set it to high if you have a good camera and a computer with a fast CPU.
X-Lite for Mac User Guide 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. Typically, leave the enabled codecs list at its default state; only enable or disable a codec if advised to do so by your VoIP service provider. With only one codec enabled, all calls made will use that codec. With more than one codec enabled, X-Lite offers all the enabled codecs and negotiates a common codec with the other party.
CounterPath Corporation Video Codecs This panel shows all the video codecs that are included in X-Lite. You can enable or disable codecs as desired. Typically, leave the enabled codecs list at its default state; only enable or disable a codec if advised to do so by your VoIP service provider. With only one codec enabled, all calls made will use that particular compression format. With more than one codec enabled, X-Lite offers all the enabled codecs and negotiates a common codec with the other party.
X-Lite for Mac User Guide 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).
X-Lite for Mac User Guide 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).
CounterPath Corporation 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.
X-Lite for Mac User Guide B Dial Plan When a call attempt is made, the call input (what you type or select in 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.
CounterPath Corporation 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. x Digit map rules Wildcard for any single digit, 0 to 9.
X-Lite for Mac User Guide 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.
CounterPath Corporation [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).
X-Lite for Mac User Guide 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.
CounterPath Corporation D Glossary Broadband Codec Dial plan DTMF Firewall IM MWI Narrowband Presence PSTN SIP account Softphone address USB device VoIP service provider 56 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.
X-Lite for Mac User Guide 57
