eyeBeam 1.
CounterPath eyeBeam 1.5 for Windows CounterPath Corporation Suite 300, Bentall One Centre 505 Burrard Street Box 95 Vancouver BC V7X 1M3 Tel: 1.604.320.3344 sales@counterpath.com www.counterpath.
CounterPath eyeBeam 1.5 for Windows Contents Introduction................................................................................................................................ 1 What is eyeBeam? .............................................................................................................. 1 Installation and Setup................................................................................................................. 2 Getting Ready .........................................
CounterPath eyeBeam 1.
CounterPath eyeBeam 1.5 for Windows 1 Introduction 1.1 What is eyeBeam? CounterPath’s next generation telephony client, eyeBeam 1.5 lets you integrate your telephony experience with your desktop and mobile computer solutions. With the click of a button or the tap on the keyboard you can dial, answer, or choose how you want to personally manage your calls and availability.
CounterPath eyeBeam 1.5 for Windows 2 Installation and Setup 2.
CounterPath eyeBeam 1.5 for Windows • • • • • • TigerJet USB Phone Set (incorporating the Tiger560C) VoIP Voice Cyberphone (V550MLR USB Phone) VoIP Voice Cyberphone K (V652VVMLR USB Phone) Yealink USB-P1K USB hand phone Yealink USB-P8D Yealink USB-W1D. • Legerity PhonePort™ PCI card • Intel® 600SM PCI card. Video Cameras Calls made with eyeBeam will work without a video camera, but one is necessary to allow other parties to see your image. eyeBeam will work with most USB video cameras. 2.
CounterPath eyeBeam 1.5 for Windows 2.3 Configuring eyeBeam 1. If eyeBeam is not already running, start it as you would any other program: Use the Windows Start menu or double-click the desktop icon. The softphone appears. 2. The Call display shows Initializing, followed by Discovering network. If no accounts have been set up, the final message is Awaiting proxy login information. You must set up accounts. See “Setting up Accounts” on page 4. 3. Make sure that you have enabled at least one account.
CounterPath eyeBeam 1.5 for Windows 2.4 Setting up for Voicemail Your VoIP service provider may offer voicemail. If it does, then you can set up some voicemail features in eyeBeam. See “Account Properties – Voicemail” on page 44. In particularly: • If you want to be able to connect to voicemail by clicking on the Call display, you must complete the Number to dial for checking voicemail field.
CounterPath eyeBeam 1.5 for Windows 3 Using the Softphone 3.
CounterPath eyeBeam 1.5 for Windows Display The following information and icons may appear on the Call display: When the phone is ringing with an incoming call, click here to ignore. A message appears to the caller advising that the call could not be made. The phone stops ringing. When the phone is ringing with an incoming call , click here to send the call immediately to voicemail. Information on voicemail is provided by your VoIP service provider; it is not part of eyeBeam.
CounterPath eyeBeam 1.5 for Windows 3.2 Starting eyeBeam 1. Start eyeBeam as you would any other program: Use the Windows Start menu or double-click the desktop icon. The softphone appears. 2. If you are prompted for a license key, then you have not yet set up eyeBeam. See “Configuring eyeBeam” on page 4. 3. Take the appropriate action: • If one or more accounts have been set up, and at least one account is enabled, the next message is Registering. eyeBeam attempts to log into every enabled account.
CounterPath eyeBeam 1.5 for Windows How Keying Description 1. Enter the SIP address or number in the Call display using the softphone keypad or the computer keyboard. • For the name, you can enter the entire name (kpereira@domain.com) or just the name (kpereira). • If you start to enter a name and the Turn Letters feature is on, then these letters are converted to numbers. Press Clear, then press spacebar and try again.
CounterPath eyeBeam 1.5 for Windows You can answer the call in any of these ways: • Click on the softphone or click Answer on the Call Alert box. • Click the line number on the softphone. • Press Enter (on the keyboard), if the softphone is the active application. You can ignore the call in any of these ways: • Click on the Call display; a message appears to the caller advising that the call could not be made. The phone stops ringing. The call is added to the Received Calls list.
CounterPath eyeBeam 1.5 for Windows Call Record Click REC at any time during the call. Click again to stop recording. Recordings are saved as WAV files (for audio) AVI files (for video), in the location specified in the Options window. (Click display and select Options, then display the Application pane.) near the top of the Call Call Information To view information such as the current codecs, hover over the line button (for example, line 1) that the call is being made on.
CounterPath eyeBeam 1.5 for Windows Flash The Flash button on eyeBeam works the same way as Flash or Link works on a traditional telephone. Click Flash on the dialpad. • If you are on an active call, clicking Flash will provide a new line. The active calls is put on hold. • If a call is coming in, clicking Flash will pick up the call. • If a line is on hold, clicking Flash will pick up the line. The exact functionality depends on how your VoIP service provider supports Flash.
CounterPath eyeBeam 1.5 for Windows If another call comes in while the conference is on hold, you can choose to answer this line. If you then click CONF again, all lines (including the new line) will be added to the conference. 4. To restart the conference, click CONF again. Note that you can be the host even if you did not initiate the call to the first person. For example, one person can phone you, then you can place and accept other calls, and establish the conference.
CounterPath eyeBeam 1.5 for Windows 3. As new calls come in, eyeBeam will automatically answer it and add it to the conference call. 4. If you put the conference on hold and a new call comes in, it will automatically be added. While the Call Is in Progress Changing the Mode While the conference call is in progress, you can change to any of the other modes by enabling the desired combination of AA and AC. eyeBeam will start handling the conference in the appropriate way.
CounterPath eyeBeam 1.5 for Windows Multiple Conference Hosts An eyeBeam conference call may include up to seven individuals—the conference host plus a participant on each of the six lines. You can establish multiple conference hosts in order to “daisy chain” together a conference call with more than seven participants. For example, one person may host six other parties (to occupy all of its available lines) with one of those parties being a conference of their own containing five other parties.
CounterPath eyeBeam 1.5 for Windows 4 Managing Calls and Contacts 4.1 Calls & Contacts Drawer To display the eyeBeam Calls & Contacts drawer, click the black button toward the extreme right edge of the softphone application. You can open (display) and close (hide) this drawer at any time. Your availability. See page 22 Contacts. See page 17 Calls: received, dialed and blocked calls. See page 21.
CounterPath eyeBeam 1.5 for Windows 4.2 Contacts Tab Your availability. See page 22. The Contacts menu The search field The availability of others. See page 22. The Contacts tab displays your contacts and lets you specify multiple contact methods for them, including: • • • • SIP address (softphone) Home phone number Cellphone number E-mail. You can identify one of these contacts as the primary contact method. You can phone any contact.
CounterPath eyeBeam 1.5 for Windows Using Contacts Call a contact E-mail a contact who has an e-mail address To use the person’s primary number, double-click or drag the contact to the Call display. To choose the number to use, right-click and choose Call, then click the desired number. Right-click and choose Send E-mail. Send an IM to a contact who has a SIP address Right-click and choose Instant Message.
CounterPath eyeBeam 1.5 for Windows Contact Properties Dialog Box 1. Enter the desired information on the two tabs. 2. When you click OK, the contact is added to the specified group or groups, with the specified primary contact method displayed in the list. Table 1: Contact Properties Dialog Box Field Name Display as Group(s) Contact Methods Show this contact’s Availability Description Complete as desired. Required.
CounterPath eyeBeam 1.5 for Windows Importing Contacts You can import a contacts list from: • A comma-separated file. Use this method to import from a Microsoft® Excel ® file. You will first have to set up the file; see below. • A Microsoft® Outlook® or Microsoft® Exchange contacts list (a *.pst file). • A vCard file (*.vcf file). A vCard is an electronic business card that is often attached to an email. The new contacts will be added to the existing contacts. 1. Click the Contacts menu and choose Import.
CounterPath eyeBeam 1.5 for Windows 4.3 Calls Tab There are three lists that show calls you have made and received: • • • • Missed Calls: incoming calls that you missed. Received Calls: incoming calls, both answered and missed. Dialed Calls: outgoing calls, both answered, unanswered and hung up.
CounterPath eyeBeam 1.5 for Windows You can right-click on an entry in the Received or Dialed list to: • Ban this person. This person will not be able to send you phone calls or instant messages, and will not be able to see your online availability. You can change these privacy rules at any time; see page 26. • Delete the call. • Add to contacts.The Add Contact dialog box appears. Complete the dialog box and press OK. For more information on the fields, see “Managing Contacts” on page 18.
CounterPath eyeBeam 1.5 for Windows Sharing Availability Watching Others’ Availability To be able to see the availability of another person, either add that person to the Contacts list with the “Show this contact’s Availability” field checked, or modify the existing contact information so that this field is checked. For more information, see page 18. As soon as the person is set up in this way in your Contacts list, eyeBeam sends them a notification request.
CounterPath eyeBeam 1.5 for Windows Receiving a New Contact Request Your eyeBeam receives a new contact request when you add a contact to your list (with “Show this contact’s Availability” checked) or when another person adds you as a contact at their end. The request is handled in one of two ways: • If you set up a privacy rule before this person has a chance to contact you, then you will never see this request. eyeBeam will automatically reply to the request according to the rule.
CounterPath eyeBeam 1.5 for Windows Setting your Availability Changing your Availability Click the down arrow beside the availability indicator, and select the desired availability. See Table 2, below. When your availability changes, the new availability is sent to everyone who has permission to see your availability.
CounterPath eyeBeam 1.5 for Windows 4.5 Privacy Rules You can allow or ban another person from contacting you. There are separate rules for each “action” – incoming phone calls, incoming instant messages, and availability detection. You can ban or allow an individual person, or an entire domain. You can set up a default rule, which applies when the incoming phone call, instant message or availability request does not fall in the scope of a specific rule.
CounterPath eyeBeam 1.5 for Windows Changing Settings To change the settings for an existing name, click in the cell you want to change; the value changes, for example from Deny to Allow. Deleting an Entry Click on the entry and click Delete. The entry is immediately deleted. • If the rule is for a person: If you are in the other person’s contact list or if the other person is in your contact list, then you will receive a New Contact Request for that person, requesting to share availability.
CounterPath eyeBeam 1.5 for Windows 5 Instant Messaging (IM) Sending and Receiving an IM To display the IM window, right-click any entry in the Calls & Contacts drawer and select Instant Message. 1. Type the message. Include emoticons and formatting, as desired. 2. Press Send. You can press Ctrl-F to search for text in the large message area.
CounterPath eyeBeam 1.5 for Windows 6 The eyeBeam Menu Access the eyeBeam menu by clicking at the top of the phone. The menu items are: • Options. Options control the way that you work with eyeBeam. Options apply to all accounts. See “Options – General – Application” on page 29. • SIP Account Settings. These settings control how eyeBeam interacts with your VoIP service provider, and are set individually for each account. See page 40. • Privacy Rules. See page 56. • Open Diagnostic Log.
CounterPath eyeBeam 1.5 for Windows Table 3: Options – General – Application Field Double clicking Enable Zero Touch bandwidth detection Description Choose the action that suits your preference. When clicked on, eyeBeam detects the speed of your network connection and hence the potential bandwidth. If you move your computer to a different IP address, eyeBeam automatically detects the new speed. When clicked off, you must specify the network connection . See “Options – General – Devices” on page 33.
CounterPath eyeBeam 1.5 for Windows Options – General – Alerts and Sounds On this page you can: • Work with ringtones. You can import a ringtone (a .WAV file). You can play to try it out. You can activate one ringtone. You can delete a ringtone. • Set up eyeBeam to bring the softphone to the front automatically when a call comes in. • Set up eyeBeam to display the Call Alert box (see right) when a call comes in and the softphone is not in focus.
CounterPath eyeBeam 1.5 for Windows Options – General – Availability This screen lets you add indicators to the standard Availability indicators built into eyeBeam. For more information on availability, see page 22. • You can set the Idle timer. This is the time since you last moved or clicked the mouse or pressed a keyboard key, after which eyeBeam will automatically change your Availability to Idle, but only if your current Availability is “Auto-detect”.
CounterPath eyeBeam 1.5 for Windows Options – General – Devices This panel lets you specify the devices you are using and then enable features for those devices. There are two ways to specify devices: • Automatically. eyeBeam automatically detects the devices attached to your computer and chooses which ones to use for audio and video. These choices are shown on this panel. • Manually. If you do not like the selections made by eyeBeam, you can override them on this panel.
CounterPath eyeBeam 1.5 for Windows Table 4: Options – General – Devices Field Description Speakerphone Speaker device Change this field only if you want to override the devices that eyeBeam automatically selected. Make the appropriate choice: Microphone device • Select the device that you want to use for audio out (the sound you hear) when the Speaker Phone button is pressed. Make sure you select a speaker device (not the headset). • Select None if you do not have a speaker phone.
CounterPath eyeBeam 1.5 for Windows Options – Advanced – Audio Codecs This pane shows all the codecs that are included in the retail version of eyeBeam. 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, eyeBeam 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 eyeBeam 1.5 for Windows Supported Codecs eyeBeam supports a wide range of codecs. See the table. Table 5: Audio Codecs Supported in eyeBeam Codec Narrowband Wideband Royalty-bearing Included in Retail eyeBeam AMR Wideband (G.722.2) 3 3 Broadvoice-32 3 3 Broadvoice-32 FEC 3 3 DVI4 3 3 DVI4 Wideband 3 3 EVRC 3 3 G.711aLaw * 3 3 G.711uLaw * 3 3 G.722 3 G.723 3 3 G.726 3 3 G.
CounterPath eyeBeam 1.5 for Windows Options – Advanced – Video Codecs This pane appears only on versions of eyeBeam that include video functionality. 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 service provider supports it.
CounterPath eyeBeam 1.5 for Windows Options – Advanced – Network Table 7: Options – Advanced – Network Field Network connection speed Preserve bandwidth Description Complete this field only if you have disabled zero-touch bandwidth detection (see page 29). Select the type of network connection for your computer. When this feature is on, eyeBeam stops sending audio when you are not talking.
CounterPath eyeBeam 1.5 for Windows Options – Advanced – Quality of Service . These fields appear only on versions of eyeBeam that include video. The Quality of Service pane lets you request a specific transport service for audio, video and signaling traffic. There are two types of services. The service to use depends on what your internet service provider supports: • GQoS, which is available for audio and video. • DSCP (also known as ToS), which is available for audio, video and signaling.
CounterPath eyeBeam 1.5 for Windows Options – Advanced – Diagnostics This screen lets you enable logging to files. Logging uses computer resources, so you should only enable it when instructed by a customer support representative. To set up logging: 1. Click Enable logging. 2. Set the logging level. 3. Specify the folder where logs will be saved. 4. Click Apply. Activity on eyeBeam will be logged to .csv files in the specified folder. A new set of files is started each time you log on.
CounterPath eyeBeam 1.5 for Windows You can: • • • • • • Resize the columns in this window. Add an account. Remove an account. Enable one or more accounts. See below for details. Set one account as the default. See below for details. Set or change the properties of an account. Click the Properties button, then see the following pages for details. Enabling Accounts You must enable an account in order to make and receive calls on that account. You can enable as many accounts as you want.
CounterPath eyeBeam 1.5 for Windows Account Properties – Account Table 8: Account Properties – Account Field Description User Details Display name User name Password Authorization user name Domain This name is displayed in the eyeBeam display. Other parties will see this name they are when connnected to you. Typically the account number for the SIP account. For example, in kpereira@domain.com, the user name is “kpereira”. Provided by your VoIP service provider. Provided by the service provider.
CounterPath eyeBeam 1.5 for Windows Table 8: Account Properties – Account Field Send outbound via Description Choose the setting specified by your VoIP service provider: • Domain: If your VoIP service provider requires that traffic be directed to proxies that are discovered via the domain. • Proxy: If your VoIP service provider has an outbound proxy address and requires that you provide the address to eyeBeam. For the address enter a domain name (for example, domain.
CounterPath eyeBeam 1.5 for Windows Account Properties – Voicemail These settings let you set up eyeBeam to forward calls in several situations. Your service provider may also provide the ability to set up for voicemail outside of eyeBeam, for example, by phoning a SIP 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 eyeBeam 1.5 for Windows Table 9: Account Properties – Voicemail Field Number for sending calls to voicemail Description Complete only if your VoIP service includes voicemail. This is the number that incoming calls will be forwarded to if they are unanswered after the specified interval (below), or when you click the icon on the Call display. If you leave this field empty, then this icon will not be displayed. However, leaving this field does not mean that voicemail does not work.
CounterPath eyeBeam 1.5 for Windows Account Properties – Topology Table 10: Account Properties – Topology Field Description Firewall Traversal IP Address This setting controls how your IP address is presented. • Discover global address: Let eyeBeam determine your public IP address. This is the recommended setting unless your VoIP service provider advises otherwise. • Use local IP address: use the IP address of the eyeBeam computer. STUN Server The recommended setting is Discover global address.
CounterPath eyeBeam 1.5 for Windows Table 10: Account Properties – Topology Field Description Port Used on Local Computer Manually specify range The appropriate setting depends on your computer setup: • 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.
CounterPath eyeBeam 1.5 for Windows Account Properties – Presence Presence allows other softphone users to see your online availability, and also allows you to see the online availability of others. How Availability Works for Single Accounts If you have only one account, enter the appropriate values on this tab, in order to configure eyeBeam according to how presence is supported by the VoIP service provider.
CounterPath eyeBeam 1.5 for Windows • Enter the appropriate values on the Presence tab for that account. The icons of the eligible contacts in the Contacts tab on the Calls & Contacts drawer will be color-coded to show the contacts’ availability. Table 11: Account Properties – Presence Field Presence Mode Description Choose the setting specified by your VoIP service provider: • Disabled: Presence is not supported. • Presence Agent. • Peer-to-Peer.
CounterPath eyeBeam 1.5 for Windows Account Properties – Storage These settings let you set up a storage system for your contact list: either a local one or a remote one (WebDAV or XCAP). The tab only appears for the current default account: see below for an explanation. How Storage Works for a Single Account If you have only one account, all three storage methods are supported and easily managed.
CounterPath eyeBeam 1.5 for Windows Table 12: Account Properties – Storage Field Use SIP credentials Description Check this box to use the username and password from your SIP account in order to log into the storage server. Otherwise, uncheck this box and complete the Username and Password fields. Root URL WebDAV poll time Not used for “Local”. URL of an appropriate root folder on the remote server. Not used for “Local”. The factory setting is https://webdav.
CounterPath eyeBeam 1.5 for Windows Account Properties – Security Table 13: Account Properties – Security Field Signaling Transport Media Encryption Description Contact your VoIP service provider to identify the types of transport that are supported. Then choose a supported transport: • Automatic: eyeBeam sets up the transport based on the capabilities of the network and the eyeBeam computer. Choose this option if you do not care which transport is used.
CounterPath eyeBeam 1.5 for Windows Setting up for Security outside of eyeBeam When using TLS, you must have the root certificate that signs the proxy's chain of certificates. In most cases, the root certification will already be installed. Procedures for the exchange of certificates are outside the scope of this documentation. The certificates must be stored on the eyeBeam computer, in the root certificate store.
CounterPath eyeBeam 1.5 for Windows Account Properties – Advanced s Table 15: Account Properties – Advanced Field Reregister every Description The time interval between eyeBeam’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. Min. time The factory setting is 3600.
CounterPath eyeBeam 1.5 for Windows Table 15: Account Properties – Advanced Field Max. time Description This is the maximum wait time between attempts to reregister. Once this maximum is reached, eyeBeam will wait this time for all subsequent attempts. For example, the min. time is 20 secs, the maximum time is 120 secs. eyeBeam will attempt to reregister as follows: • • • • • • • • • Send SIP keep-alives Use rport Enable session timers Wait 20 secs. Attempt to connect. If fail, wait 40 secs.
CounterPath eyeBeam 1.5 for Windows 6.3 Privacy Rules For information on privacy rules, see page 26. 6.4 Open Diagnostic Log and Folder For information on these menu items, see “Options – Advanced – Diagnostics” on page 40.
CounterPath eyeBeam 1.
CounterPath eyeBeam 1.5 for Windows Appendix B: Dialing Plan When a call attempt is made, the call input (what you type, select or drag onto the Call display) is processed to select the account to use and to modify the input if that is required to ensure that the call gets placed successfully. This ability to select an account and modify the input relies on the existence of a “dialing plan” for each account.
CounterPath eyeBeam 1.5 for Windows that if there is no transformation for a pattern, then the input that matches this pattern is not transformed). One or more pairs. “match=” is a literal. “n” identifies the pattern. “transformation=” is replaced by a keyword, see below. “value” is replaced by a value. Spaces are allowed only in the items. Example \a\a.T|xxxxxxxxxx;match=1;prestrip=2;match=2;pre=8; where: • • • • \a\a.Tis the first pattern. xxxxxxxxxx;is the second pattern.
CounterPath eyeBeam 1.5 for Windows Element T Origin Digit map rules Description A timeout period will take place before automatic dialing starts. The T timer forces eyeBeam to wait after a match is made. This timer should always be included in , and situations: • Any pattern that uses the . (dot). For example, if the pattern is xxxx. then adding a timer lets you type three or more digits.
CounterPath eyeBeam 1.5 for Windows Results of the Comparison Type of Match Partial match Pending match Complete match No match Result if You Press Enter or Dial Conditions Result if You Stop Typing The characters typed so far follow the pattern but The default account is If you stop typing for the there are not yet enough characters for a pending selected. No transformation long timer length (20 or complete match. is performed. seconds), then the default account is selected.
CounterPath eyeBeam 1.5 for Windows Example 3 #1xxxxxxxT|#19xxxxxxx|xxxxxxxT|9xxxxxxx|;match=1;prestrip=2;pre=9;match=2; prestrip=2;match=3;pre=9; Table 17: #1xxxxxxxT #19xxxxxxx xxxxxxxT 9xxxxxxx The pattern is an acount prefix followed by seven digits. The timer forces eyeBeam to wait to allow a match to the second pattern. The #1 is stripped off and 9 is prepended to access an outside line. The pattern is an account prefix followed by a 9 and seven digits. The #1 is stripped off.
CounterPath eyeBeam 1.5 for Windows Appendix C: Contact List Headings Following is a list of all the headings that are used in the eyeBeam contacts list. This list can be useful when formatting a contacts list in order to import it into eyeBeam.
CounterPath eyeBeam 1.5 for Windows Appendix D: Location of Files System files get copied to the installation directory specified when installing eyeBeam. The default installation directory is: C:\Program Files\CounterPath\eyeBeam n.n The directory contains: • • • • • • • • • the executable (eyeBeam.exe) emoticons\*.* eyeCall.dll, used to make calls from Microsoft Outlook. other dll files, including dll files for supported codecs. unins000.dat, which contains information about uninstalls of eyeBeam. *.
CounterPath eyeBeam 1.5 for Windows Appendix E: Alternative Ways of Running eyeBeam E.1 From a Hyperlink You can attach a hyperlink to a phone number or SIP address that, when clicked, starts eyeBeam and dials the number. Attach a hyperlink with this format: dial
For example: dial kpereira@domain.com E.2 From the Command Line You can start eyeBeam from a DOS prompt. You may need to add eyeBeam.exe to the PATH.CounterPath eyeBeam 1.5 for Windows Appendix F: Glossary AEC AGC AVI Broadband Codec Default account Dialing plan DTMF IM IP IP address Media MWI Narrowband Presence Proxy PSTN Acoustic echo cancelation. 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.
CounterPath eyeBeam 1.5 for Windows RFC RTP Signaling SIMPLE protocol SIP SIP account SIP address SRTP TCP TLS UDP URI URL USB device VAD vCard VoIP VoIP service provider WAV Request for Comment. A document that describes an aspect of an internet technology. An RFC may be a proposed, draft or full internet standard. Real-time Transport Protocol. A protocol for delivering the media portion of a data transmission over an IP network. SRTP is another media protocol.
