X-Lite 5 for Windows 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 © June 2012 CounterPath Corporation. All rights reserved. Windows and Windows Vista are registered trademarks of Microsoft Corporation in the United States and other countries.
Contents Introduction...................................................................................................................................1 Installation and Setup....................................................................................................................3 Getting Ready .........................................................................................................................3 Installing X-Lite................................................................
CounterPath Corporation ii
1 Introduction Standard Telephone Features The CounterPath X-Lite for Windows 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. Three-party conferencing. Enhanced Features and Functions X-Lite for Windows also supports the following features and functions: • • • • • Video. Managed contact list.
CounterPath Corporation 2
2 Installation and Setup 2.1 Getting Ready Hardware and Other System Requirements For information on the supported hardware and other system requirements, see https://support.counterpath.com/ default.asp?W336. Multimedia Device Requirements X-Lite requires both speakers and a microphone to make calls. Any of the following configurations are acceptable: • • • • • External speakers and microphone Built-in speakers and microphone Dual-jack multimedia headset USB multimedia headset USB phone.
CounterPath Corporation You can use X-Lite without signing up for SoftPhone.com , but if you do sign up for SoftPhone.com you will be able to make freee phone calls to people outside your enterprise and you will have access to IM and presence features. For more information, see www,softphone.com.
X-Lite 5 for Windows User Guide 2.3 Configuring X-Lite If X-Lite is not already running, start it as you would any other program: Use the Windows Start menu or double-click the desktop icon. X-Lite appears. You can set up X-Lite in one of these ways: • • • With your PBX account (in other words, your office phone number). With your PBX account and with SoftPhone.com . With a SoftPhone.com account only. This guide explains how to set up your PBX account. For information on the SoftPhone.
CounterPath Corporation 4. Complete the remaining tabs as specified by your IT administrator or VoIP service provider, or to suit your setup. Settings that you may need to change immediately include: • Account tab, Domain Proxy area. • Topology tab, if your computer is on a network and/or behind a firewall. For more information, see “Configuring X-Lite” on page 25. Setting up for Voicemail Your enteprise or VoIP service provider may offer voicemail.
3 Using X-Lite 3.1 Starting X-Lite If X-Lite is not already running, start it as you would any other program: Use the Windows Start menu or double-click the desktop icon. X-Lite appears. USB Device Alert If your headset is a “HID-compliant device”, the USB Device alert may appear the first time you start X-Lite. You can assign functions to the headset. For example, you can set the green button so that it answers an incoming call. If you click Yes, the USB Device Button Setup window appears; see page 37.
CounterPath Corporation Compact View To display a compact view of the softphone, hide the dialpad and hide all the resources tabs (View > Hide). The X-Lite Menu Softphone • • • • • Sign in to SoftPhone.com . For information on this menu, see www,softphone.com. Share with Contacts. For information on this menu, see www,softphone.com. Account Settings. These settings control how X-Lite interacts with your PBX and network. See “Configuring your Account” on page 25. Preferences.
X-Lite 5 for Windows User Guide Showing and Hiding Parts of the Softphone Show/hide various tabs Minimize to task bar Close to system tray Show/hide dial pad Open/close video window Resize softphone You can still receive calls when X-Lite is hidden or minimized. If you exit when X-Lite is minimized, X-Lite will start next time as minimized.
CounterPath Corporation 3.3 Placing a Call You can place one more call when another call is already in progress. The first time you make a call, select Softphone > Preferences and set your dialing preferences. See page 45. Call entry field Place the call. See below for different ways to specify the number. Click to place the call Auto complete suggestions The outgoing call opens in its own call panel, below any other existing call panels.
X-Lite 5 for Windows User Guide • A phone number and extension with a separator in between. For example, 6045551222x1300. X-Lite will dial the phone number, wait for the call to get established, then dial the extension. Valid separators are: x extension ext ; (semi-colon) , (comma) If X-Lite sees that the phone number is actually your own PBX, it drops the phone number and dials the extension directly. • A SIP address ((for example, kperera@yourNormalPBX.
CounterPath Corporation 3.4 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 IT administrator or VoIP service provider.) As soon as an incoming call is received, a call panel appears, showing information about the call. Action Answer or Description Click Answer. If you are on another call, that first call is automatically put on hold. You are now talking to the new caller.
X-Lite 5 for Windows User Guide 3.5 Handling an Established Call Place another call (current call is automatically put on hold). See page 11 Open or close the video window. If you close it, X-Lite stops sending your video to the other party. Volume control and Speakerphone (this button is enabled if your computer has a speakerphone) Show/hide dialpad Mute If a plus symbol appears here, you can add the current caller as a contact. Hold or resume the call Start your video.
CounterPath Corporation 3.6 Handling Video Calls Placing a Video Call Click the down arrow and choose Video call Call entry field Specify the number by: • • • Typing the number on the dialpad or computer keyboard, then clicking the arrow beside the Call button and choose Video call. Right-clicking an entry in the Contacts or History tab and choosing Video Call Redialing: click the down arrow and select a recent call and choose Video call.
X-Lite 5 for Windows User Guide Show/hide video window Control your video Status of your video Other Party Adds Video If the other party starts their video, your video window automatically opens and the video is played. You can start sending your own video, if desired (and assuming you have a camera) by clicking Start Video. Pausing and Resuming Video Click Stop Video 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 3.
X-Lite 5 for Windows User Guide Managing the Conference Mute. When you mute during a video call, you may also want to click Stop Video to stop the video feed. Participant menu This menu is disabled Removing a Participant To remove one call from the conference, click the down arrow beside a participant name and choose Separate. The call becomes a separate call. Ending the Conference To hang up on everyone, choose End conference from the conference menu.
CounterPath Corporation This person does not have video. To remedy this situation, stop video and start it again. Video will be sent to all the current participants. This person has video. Closing the video window stops sending video. Including Video in a Conference When you start a conference from established calls, video is automatically included if at least one of the calls already includes video and is sent to all the participants. When you start a conference from scratch, video is not included.
X-Lite 5 for Windows User Guide 3.8 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.
CounterPath Corporation 20
4 Using Resources 4.1 Contacts Tab If the Contacts tab is not showing, go to the menu bar and choose View > Show Contacts. Select display options Add a Contact Search field The Contacts tab displays your contacts and lets you specify multiple contact methods for them.
CounterPath Corporation Managing Contacts Adding a Contact Click ,. The Contact Profile dialog appears. Complete the details and click OK. Adding a Contact using an Existing Address You can add a contact by capturing existing information. On the History tab, select an entry that is not a contact. Right-click and choose Add as Contact. Changing Contact Information To change the information for a contact, right-click the contact and choose Edit Profile.
X-Lite 5 for Windows User Guide Using Contacts Phone the person Drag the contact to the call entry field to start a phone call. Phone the person Right-click and choose Call, then click the desired number. Contact Flyout Single-click on a contact to show the Contact flyout. This flyout shows all the contact methods set up for the contact. You can click a contact method to perform its action.
CounterPath Corporation 4.2 History Tab Filter list Outgoing call, either attempted or established Incoming call that was answered Incoming missed call Managing the Lists of Calls You can right-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 Add a Contact dialog appears.
5 Configuring X-Lite You can configure X-Lite in several ways: • • Configure global behavior. See “Configuring Preferences” on page 33. Configure the behavior on a per-account basis. See “Configuring your Account” on page 25. 5.1 Configuring your Account Choose Softphone > Accounts. The Account Settings window appears.
CounterPath Corporation Field Account name Protocol Description Always “My PBX” Read-only. Always specifies SIP. User Details User ID Domain Password Display name Authorization name Typically the account number for the account. For example, kperera. Provided by your IT administrator or VoIP service provider. For example, yourNormalPBX.com. Provided by your IT administrator or VoIP service provider. Provided by your IT administrator or VoIP service provider.
X-Lite 5 for Windows User Guide SIP Account Properties – Voicemail These settings let you set up to interact with your VoIP service provider’s or enterprise’s voicemail service. . Your service provider may provide the ability to set up for voicemail outside of X-Lite, for example, by phoning a number and following the voice prompts, or by accessing a website. Check with your service provider or IT administrator to determine if another setup mechanism is available.
CounterPath Corporation Field Description Send calls to voicemail if unanswered 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.
X-Lite 5 for Windows User Guide Field Description Range of ports used The appropriate setting depends on your computer setup: on local computer • Checked: If your computer is behind a restrictive firewall that only allows specific port ranges to be used. Enter the range of ports to use for your SIP account. (You must also open those ports on your firewall; refer to applicable firewall documentation for information.) • Unchecked: If your computer is not behind a restrictive firewall.
CounterPath Corporation SIP Account Properties – Transport Field Signaling Transport Encryption 30 Description Contact your IT administrator or 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. • TCP: This transport provides no signaling security.
X-Lite 5 for Windows User Guide SIP Account Properties – 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 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 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: • • • • Hold Method Send SIP keep-alives Use rport 32 None: No preference. Local refreshes: Your computer sends. Remote refreshes: The other party sends.
X-Lite 5 for Windows User Guide 5.2 Configuring Preferences Choose Softphone > Preferences. The Preferences window appears. The Preferences panels let you control the way that you work with X-Lite. Preferences – Application This panel lets you set your preferences for general GUI behavior.
CounterPath Corporation Preferences – Sounds You can assign specific sounds to a variety of actions or “events”. 1. Select the Enable sounds check box and select the check boxes for each desired event, or clear the Enable sounds check box to disable all sounds. 2. If enabling sounds, you can change the sound for each event: select the individual event. The value in Sound preference will change. Select the desired sound.
X-Lite 5 for Windows 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.
CounterPath Corporation Field Description Headset Mode Speaker Change these fields only if you want to override the devices that X-Lite automatically selected. Microphone 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 (capturing your voice). The only situation in which the headset is not used is when the Speaker Phone button on the dialpad is pressed.
X-Lite 5 for Windows User Guide USB Device Button Setup You can assign functions to a USB-compliant device. For example, you can set the green button so that it answers an incoming call.
CounterPath Corporation Preferences – Network Field Description 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 5 for Windows User Guide Preferences – 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 Supported Codecs Codec Narrowband Wideband Broadvoice-32 3 Broadvoice-32 FEC 3 DVI4 3 3 DVI4 Wideband G.711aLaw * 3 G.711uLaw * 3 GSM 3 iLBC 3 L16 PCM Wideband 3 Speex 3 Speex FEC 3 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.
X-Lite 5 for Windows User Guide Preferences – 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. You may decide to disable a codec even though your enteprise or VoIP service provider supports it. With only one codec enabled, all calls made will use that particular compression format.
CounterPath Corporation Preferences – Media Quality Audio Quality Reduce echos Turning this feature on improves sound quality. This feature is typically on. Reduce background noise 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.
X-Lite 5 for Windows User Guide 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. You will know that you have set the size too large if: Your computer slows down (the video is using too much CPU) The video shows black areas or is slow or jerky. • Typically set it to low only in special situations, for example, when using wi-fi in a hotel. You will know that you have set the size too small if the video is fuzzy.
CounterPath Corporation Preferences – Advanced Field Description DTMF 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). RTP This timer controls how calls are disconnected when X-Lite determines that there is a problem with the call and the other party has probably disappeared (assuming that you have not yourself detected the problem and hung up manually). Typically, the timer is enabled.
X-Lite 5 for Windows User Guide Preferences – Dialing Preferences Field Description Dial out prefix The number to dial out of your enterprise. For example, 9. International prefix The prefix required on a phone number in order to handle this number as an international phone call. For example, +43. X-Lite handles international calling as follows: • It looks at the phone number for this international prefix.
CounterPath Corporation Preferences – Privacy Options This panel applies only if you have a SoftPhone.com account. See www,softphone.com.
A Troubleshooting Choose Help > Troubleshooting to display the Troubleshooting window. Testing Audio and Video Devices You can verify that your microphone, speakers and camera are working and can set the volume to a comfortable level without having to actually place a phone call.
CounterPath Corporation 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 5 for Windows User Guide Diagnostics 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. Perform the actions you want to capture; for example, attempt to make a phone call. 5.
CounterPath Corporation B Glossary AEC AGC Broadband Codec Dial plan DTMF HID IP IP address Media MWI Narrowband Proxy PSTN RTP Signaling SIP account SRTP 50 Acoustic echo cancellation. Processing of the audio or video 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 5 for Windows User Guide TCP UDP VAD VoIP service provider data transmission over an IP network. SRTP is a secure protocol, which means that the media is encrypted. RTP is another media protocol. Transmission Control Protocol. A transport protocol for delivering data over an IP network. Other transport protocols are TLS and UDP. User Datagram Protocol. A transport protocol for delivering data over an IP network. Another transport protocol is TCP. Voice Activity Detection.
CounterPath Corporation 52
