X-Lite 4 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 © August 2011 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 4 ............................................................
CounterPath Corporation ii
1 Introduction Standard Telephone Features The CounterPath X-Lite 4 for Mac softphone has all standard telephone features, including: • • • • Call display and Message Waiting Indicator (MWI). Speakerphone and Mute. Redial, Hold. Call history – list of received, missed, and dialed calls. Enhanced Features and Functions X-Lite 4 also supports the following features and functions: • • • • • • Video IM and presence using the SIMPLE protocol. Managed contact list.
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 password Authorization Name (if applicable) Domain Firewall traversal and other network information; see “Configuring X-Lite 4” on page 25. System Requirements • Operating System: Mac OS 10.5 or above operating system software.
CounterPath Corporation 2.2 Configuring X-Lite 4 Setting up your Account After obtaining SIP account information from your VoIP service provider, you can set up your X-Lite 4 account. 1. From the menu, choose X-Lite 4 Beta > Preferences. The Application - Preferences window appears. 2. Click on Accounts and complete the User Details area with the information obtained from your VoIP service provider. 3. Complete the remaining tabs as specified by your service provider or to suit your setup.
X-Lite 4 for Mac User Guide Setting up a Contact List Typically, you will want to create contacts in order to easily make calls and send IMs. See page 18. 2.3 Troubleshooting X-Lite 4 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).
CounterPath Corporation 6
3 Using X-Lite 4 3.1 The Onscreen Softphone Minimize to dock Close window Open/close video window Show/hide dial pad Call entry field See page 9. The Call button Resources. See page 17 Resize softphone Show/hide resources tabs You can still receive calls when X-Lite is hidden or minimized.
CounterPath Corporation The X-Lite 4 Menu The menu contains the following items that are specific to X-Lite 4: • • • • • X-Lite > Preferences. This menu item lets you configure X-Lite to work with your VoIP service and lets you change the way you work with X-Lite. See page 25. View. Change how X-Lite looks and show and hide specific modules. Contacts. Lets you work with contacts. Everything in this menu can also be performed directly in the contact list. Action.
X-Lite 4 for Mac User Guide 3.2 Placing a Call You can contact someone using: • • A softphone address (for example, 6045550008@domainA.com or kperera@domainA.com). A traditional phone number, if supported by your VoIP service provider. You can place one more call when another call is already in progress. Call entry field Auto complete suggestions Click to place the call Place the call. See the table on the next page. The outgoing call opens in its own call panel, below any other existing call panels.
CounterPath Corporation Placing another Call To place a new call (without hanging up on the current call), simply place the call in the normal way. A second call panel opens below the current call. The first call is automatically put on hold. Switch between the different calls by clicking Resume on the desired call panel. That call becomes the active call and all other calls are on hold.
X-Lite 4 for Mac User Guide 3.3 Handling an Incoming Call 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.) As soon as an incoming call is received, a call panel appears, showing information about the call. The name and phone number of the person calling you is displayed. In addition, the Call Alert box appears, even if X-Lite is minimized. Action Answer From the...
CounterPath Corporation 3.4 Handling an Established Call While the call is in progress you can: • • Control the audio: use the speakerphone, mute the call, control volume. Put the call on hold. Open or close the video window. If you close it, X-Lite stops sending your video to the other party Show/hide dialpad Audio controls Place another call (current call is automatically put on hold). See page 10 Mute Send an IM to this person (this menu appears only if the user has an IM address).
X-Lite 4 for Mac User Guide 3.5 Handling Video Calls Placing a Video Call Call entry field 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. How 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.
CounterPath Corporation Show/hide video window Start and stop your video 3.6 Voicemail If your service includes voicemail and you have set up voicemail options (page 27), then when you have voicemail messages, a number appears beside the voicemail icon at the top of the phone. You can click the icon to automatically connect to voicemail and listen to your messages.
X-Lite 4 for Mac User Guide 3.7 Instant Messaging Instant messages are made using softphone addresses. Therefore, you can send or receive an instant message (IM) to: • • • Any contact who has a softphone address. Any party who phoned you from a softphone address. Any party whom you phoned using a softphone address. Sending an IM 1. There are several ways to select the person to send an IM to. From the Contacts tab An active phone call Control-click on the contact and choose Send IM.
CounterPath Corporation Viewing the IM Archive To view the archive of incoming and outgoing IMs, from the menu bar, choose View > Show Message Archive.
4 Using the Resources 4.1 Contacts Tab Add a Contact Search field The availability of others. See page 21. Filter and sort options The Contacts tab displays your contacts and lets you specify multiple contact methods for them, including: • • Softphone address Home phone number, business phone number, mobile phone number You can identify one of these contacts as the primary contact method.
CounterPath Corporation Managing Contacts and Groups Adding a Contact Click table. , or control-click a group and choose Add Contact to Group. The Contact dialog appears. See the Click to change the type of phone number: “Softphone”, “Home”, “Work” and so on Click + to add another phone number field Click - to delete the selected entry Table 1: Contact Fields Field Description Group Click to show the list of groups and check each group to add this contact to.
X-Lite 4 for Mac User Guide Changing Contact Information To change the information for a contact, control-click the contact and choose Edit Profile. The Contact dialog appears (see page 18). 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.
CounterPath Corporation 4.2 History Tab Incoming missed call Filter list Outgoing call, either attempted or established Incoming call that was answered Managing the Lists 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. For more information on this dialog, see “Adding a Contact using an Existing Address” on page 18.
X-Lite 4 for Mac User Guide 4.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.
CounterPath Corporation Receiving an Online Status Request When someone who is not one of your contacts has you as a contact on their end, you receive an Online Status Request. The request appears to you as an Online Status Request. You must respond to the request: • • Allow the request and create a new contact using this address. This option is selected for you if you do not currently have a contact with this SIP address. Allow the request and update the contact to allow the person to see your presence.
X-Lite 4 for Mac User Guide Setting your Online Status Changing your Status Click the down arrow beside the availability indicator on X-Lite, and select the desired availability. See Table 2, below. When your availability changes, the new availability is sent to your contacts. Table 2: Availability Indicators Indicator Available Meaning for your Availability Either: Meaning for Others’ Availability You can contact this person. • You have set your availability to this status.
CounterPath Corporation 24
5 Configuring X-Lite 4 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. 5.1 Configuring your Account To set up an account and configure X-Lite to work with your VoIP service, from the menu bar, choose X-Lite 4 > Preferences > Accounts. The Accounts window appears.
CounterPath Corporation Accounts – General Fields with an asterisk are required Table 3: Accounts – General Field Account name Protocol Use for 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. Leave these fields checked. User Details User ID Domain Password Display name Authorization name Provided by your VoIP service provider. This name is displayed in the X-Lite title bar.
X-Lite 4 for Mac User Guide Accounts – Voicemail These settings let you set up to interact with your VoIP service provider’s voicemail service. They also let you configure X-Lite to forward calls in several situations, independent of 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.
CounterPath Corporation Table 4: Accounts – Voicemail 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 provider’s voicemail.
X-Lite 4 for Mac User Guide Accounts – Topology Table 5: Accounts – Topology Field Firewall traversal method Description Leave the default. Or if you have problems making phone calls, contact your VoIP service provider for information on which of the other options might work: • Auto detect using ICE: Automatically determine the contact address for signaling traffic.
CounterPath Corporation Accounts – Presence Presence allows your contacts to see your online availability and allows you to see the online availability of contacts. See “Sharing Online Status” on page 21. Table 6: Accounts – Presence Field Mode Description Choose the setting specified by your VoIP service provider: • Disabled: Presence is not supported. • Peer-to-Peer. Poll time Enter the value specified by your VoIP service provider.
X-Lite 4 for Mac User Guide Accounts – Transport 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 Accounts – Advanced Table 7: Accounts – 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 4 for Mac User Guide Table 7: Accounts – Advanced 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 5.2 General Preferences From the menu bar, choose X-Lite 4 > 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 XLite. Preferences – Application This panel lets you set your preferences for general GUI behavior.
X-Lite 4 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.
X-Lite 4 for Mac User Guide Field Description Headset Mode Microphone, Speaker Change these fields only if you want to override the devices that X-Lite automatically selected. In both these fields, select the headset you are using. The headset is the device that is usually used for audio out (the sound you hear) and audio in (recording your voice). The only situation in which the headset is not used is when the Speaker Phone button on the dialpad is pressed.
CounterPath Corporation Preferences – Network Select the type of network connection for your computer. The sliders move to show the bitrate that will be used for sending and receiving. These rates are typical rates for the selected configuration. If you know that your computer and network can handle a faster sending speed, click Custom and move the slider. It is recommended that you not change the receiving speed.
X-Lite 4 for Mac User Guide Preferences – Codecs Audio Codecs This panel shows all the 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.
CounterPath Corporation Codec Narrowband Wideband Speex Wideband 3 Speex Wideband FEC 3 * Generally, at least one of these codecs must be enabled in order to place a PSTN (land line) call. Video Codecs Video codecs describe the format by which video streams are compressed for transmission over networks. Some codecs require less bandwidth than others, but may result in lower video quality. You can enable or disable codecs as desired.
X-Lite 4 for Mac User Guide Preferences – Media Quality Field Description Audio Quality Reduce echo Reduce background noise Turning this feature on improves sound quality. This feature is typically on. Automatically attempts to remove background noise. Typically on for the speakerphone. Automatic gain control This feature is typically on. Preserve bandwidth When this feature is on, X-Lite stops sending audio when you are not talking.
CounterPath Corporation Preferences – Advanced 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 Choose Help > Troubleshooting to display the Troubleshooting window. 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). Testing the Network Connection You can verify that you are successfully connected to the network.
X-Lite 4 for Mac User Guide Testing 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 Diagnostics Only use this panel if instructed to do so by your support representative at your VoIP service provider. To start logging X-Lite activity and send a logging report to customer support: 1. Click Start Logging. The first Diagnostics Logging window appears. 2. Select the problem you are experiencing and click Start Logging. 3. On the second Diagnostics Logging screen, click Finish. Logging will start. 4.
X-Lite 4 for Mac User Guide B Dial Plan You can create a dial plan to modify the the call input (what you type, select or drag onto the call entry field) to ensure that the call gets placed successfully. Modifying the input is useful when using numbers from a contact, which may include symbols such as the + symbol. Do You Need to Read this Information? You do not have to read this dial plan information if the default dial plan behavior (below) is acceptable.
CounterPath Corporation • • Pattern: the pattern that will be matched. One or more patterns. Each pattern is separated by a | pipe. The pipe is optional after the last pattern. Each pattern is implicitly numbered, starting from 1. Match; Transformation: A pair that identifies the pattern number to compare with the input, and the transformation to perform on the input when a match is obtained.
X-Lite 4 for Mac User Guide Element Origin Description . Digit map rules Repeat the last element 0 or more times. For example, xxxx. means repeat the last x 0 or more times, which means this pattern matches three or more digits (not four or more digits)! Use of this element results in a pattern with “minimum requirements”. T Digit map rules A timeout period will take place before automatic dialing starts. The T timer forces X-Lite to wait after a match is made.
CounterPath Corporation Results of the Comparison X-Lite finds a match according to the following rules. Type of Match Result If User Presses Enter or Call Result if User Stops typing The input matches the pattern and the pattern does not include the T timer The transformation is performed. X-Lite attempts the call. Nothing happens even after the T timer has expired. The input matches the pattern and the pattern includes the T timer The transformation is performed. X-Lite attempts the call.
X-Lite 4 for Mac User Guide C Location of Data Files Data files are saved in the standard location for application data.
CounterPath Corporation D Glossary AEC AGC Broadband Codec Default account Dial plan DTMF IM IP IP address Media MOV MWI Narrowband Presence Proxy PSTN RFC RTP 52 Acoustic echo cancellation. Processing of the audio signal to reduce the echo effect that can arise with a speakerphone or that can arise if the sound from the speakerphone or headphone leaks into the microphone. Automatic gain control.
X-Lite 4 for Mac User Guide Signaling SIMPLE protocol SIP SIP account softphone address SRTP TCP UDP URI URL USB device VAD VoIP WAV In a VoIP phone call, the information in a call that deals with establishing and controlling the connection, and managing the network. The non-signaling portion of the call is the Media. Session Initiation Protocol for Instant Messaging and Presence Leveraging Extensions. The instant messaging (IM) protocol followed by X-Lite.
CounterPath Corporation 54
