Eyebeam 1.5 For Mac: User Guide
Eyebeam 1.5 For Mac: User Guide
Eyebeam 1.5 For Mac: User Guide
5 for Mac
User Guide
CounterPath eyeBeam 1.5 for Mac
© 2006
This document contains information proprietary to Counterpath Solutions, Inc., and shall not be used for
engineering, design, procurement, or manufacture, in whole or in part, without the consent of CounterPath
Solutions, Inc.
CounterPath, eyeBeam, and the logo are trademarks of CounterPath Solutions Inc.
The content of this publication is intended to demonstrate typical uses and capabilities of the eyeBeam 1.5
softphone application from CounterPath Solutions Inc. Users of this material must determine for themselves
whether the information contained herein applies to a particular IP-based networking system.
CounterPath makes no warranty regarding the content of this document, including—but not limited to—implied
warranties of fitness for any particular purpose.
In no case will CounterPath or persons involved in the production of this documented material be liable for any
incidental, indirect or otherwise consequential damage or loss that may result after the use of this publication.
Contents
Introduction................................................................................................................................ 1
What is eyeBeam? .............................................................................................................. 1
Installation and Setup................................................................................................................. 2
Getting Ready ..................................................................................................................... 2
Installing eyeBeam ............................................................................................................. 3
Configuring eyeBeam ......................................................................................................... 3
Setting up for Voicemail ..................................................................................................... 5
Setting up a Contacts List ................................................................................................... 5
Using the Softphone................................................................................................................... 6
The Onscreen Phone ........................................................................................................... 6
Starting eyeBeam ................................................................................................................ 7
Placing a Call ...................................................................................................................... 8
Answering a Call ................................................................................................................ 9
Handling a Call ................................................................................................................... 10
Conference Calls ................................................................................................................. 13
Managing Calls and Contacts .................................................................................................... 16
Calls & Contacts Drawer .................................................................................................... 16
Contacts Tab ....................................................................................................................... 17
Calls Tab ............................................................................................................................. 21
Availability ......................................................................................................................... 23
Privacy Rules ...................................................................................................................... 27
Instant Messaging (IM).............................................................................................................. 29
The eyeBeam Menu ................................................................................................................... 30
Options ................................................................................................................................ 31
SIP Account Settings .......................................................................................................... 42
Privacy Rules ...................................................................................................................... 57
Open Diagnostic Log and Folder ........................................................................................ 58
Appendix A: Application Hot Keys .......................................................................................... 59
Appendix B: Dialing Plan ......................................................................................................... 60
Appendix C: Location of Data Files ......................................................................................... 65
Appendix D: Glossary .............................................................................................................. 66
1
CounterPath eyeBeam 1.5 for Mac
1 Introduction
1
CounterPath eyeBeam 1.5 for Mac
Optimized Devices
eyeBeam is optimized to work with Apple iSight™
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 Mac
Uninstalling eyeBeam
Uninstall eyeBeam as you would uninstall any other program: Drag the eyeBeam icon to the Trash.
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. You can enable more than one account at the same
time. Each time you start eyeBeam, you will automatically be logged into every enabled account.
To enable an account, click at the top of the softphone, choose SIP Account Settings and click enable for
the desired account. For more information on enabling, see page 42.
3
CounterPath eyeBeam 1.5 for Mac
Setting up Accounts
1. Create the account: Click at the top of the phone and choose SIP Account Settings. Click Add. The
Properties of Account window appears.
2. In the Account tab, complete the User Details area
3. For the remaining tabs, you can accept the default settings, or you change them 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.
• Security tab, if you want to set up secure calls.
For complete details on the Account Settings window, see “SIP Account Settings” on page 42.
4
CounterPath eyeBeam 1.5 for Mac
5
CounterPath eyeBeam 1.5 for Mac
Dial Hang up
Display
The following information and icons may appear on the Call display:
Video Drawer
This drawer appears only on versions of eyeBeam that include video functionality. To display this drawer, click
the black button toward the extreme left edge of the softphone application. You can open (display) and close
(hide) this drawer at any time. You can click the to display the standard window for setting camera
properties; this is not an eyeBeam window.
You can detach this drawer, then reattach it, if desired.
This drawer has two panels. The top panel shows incoming video (video from the other party). The lower panel
shows outgoing video. The Start button lets you start and stop video.
Calls & Contacts Drawer
This drawer displays your Contacts list, lists of recent calls, and availability information for you and your
contacts. For more information, see page 16.
6
CounterPath eyeBeam 1.5 for Mac
Click to hide only the dialpad; if the drawers are detached, they will not be minized.
You can still receive calls when the phone is hidden or minimized.
You can set up eyeBeam so that when the softphone is completely or partially covered, hidden, or minimized,
you will be notified when a call comes in. See “Options – General – Alerts and Sounds” on page 32.
7
CounterPath eyeBeam 1.5 for Mac
How Description
Keying 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. See “Options – General – Application” on page 31 for
details on the Turn Letters feature.
2. Click or press Enter.
Partial keying As you key in an entry, a suggestion for completing the entry may appear. Press Tab to accept the suggestion.
Then click or press Enter.
Drag-and-drop Drag an entry from the Contacts tab or any of the lists in the Calls tab to the Call display. (For information on
this drawer, see page 16.)
If the Contacts list contains lots of contacts, use the field to filter the list. Then drag the entry.
Right clicking Right-click an entry on the Contacts tab or any of the lists in the Calls tab, and choose Phone this Person. (For
information on this drawer, see page 16.)
If the Contacts list contains lots of contacts, use the field to filter the list. Then right-click the entry.
Redialing Press Redial.
The outgoing call may be encrypted, depending on your security settings. For information on the current
security settings, see page 53.
• If an encrypted call is established, the icon appears on the Call display. This icon indicates that the call is
guaranteed to be secure between you and your proxy, and may or may not be secure beyond that first hop.
See page 53 for more details on how encryption works.
• If an unencrypted call is established, the unencrypted icon appears.
• If the call cannot be established with the specified security, the call will fail.
Ending a Call
Click on the Call display or right-click in the dock and choose End Call. Details of the call remain on the
Call display. To clear the Call display, click Clear.
Note that selecting another line does not hang up; it puts the call on hold.
8
CounterPath eyeBeam 1.5 for Mac
Ending a Call
Click on the Call display .
Details of the call remain on the Call display. To clear the Call display, click Clear.
Note that selecting another line does not hang up the current call; it puts the call on hold.
9
CounterPath eyeBeam 1.5 for Mac
10
CounterPath eyeBeam 1.5 for Mac
AA – Auto Answer
Click AA on the dialpad to automatically answer calls as they come in.
11
CounterPath eyeBeam 1.5 for Mac
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.
When a call comes in, you can send it to voicemail by clicking on the Call display.
You can access your voicemail messages by clicking the on the Call display (this icon is only displayed if
you have new messages).
For important information on how voicemail works, see “Setting up for Voicemail” on page 5.
DND – Do Not Disturb
Click DND on the dialpad. All incoming calls will be sent to voicemail or given an audible “busy” indication,
depending on how the VoIP service provider has set up this feature.
Forwarding Calls
You can enable or disable forwarding. When forwarding is enabled, every call comes in will be forwarded to
another phone number (other than voicemail). To enable forwarding, click at the top of the phone and
choose SIP Account Settings. Click Properties, click the Voicemail tab, and complete the Forwarding section.
For complete details, see “Account Properties – Voicemail” on page 45.
12
CounterPath eyeBeam 1.5 for Mac
13
CounterPath eyeBeam 1.5 for Mac
AA Off and AC On
“You answer calls manually and eyeBeam adds each to the conference automatically”
1. Click AC on.
2. Manually answer the first call. There is no need to put the call on hold.
3. When the next call comes in, on another line, answer the call. As soon as you answer the call, a conference
will be set up among the three parties.
• The conference is established even if you had another line on hold.
• All lines are included in the conference call, including all those that are on hold.
4. While the conference is in progress and if another call comes in, as soon as you answer the call, it will
automatically be added to the conference. If the conference was on hold, it will be automatically be re-
established with all lines, both those on hold and those that are active.
14
CounterPath eyeBeam 1.5 for Mac
If you have not yet set up for recording, do so before recording: Click near the top of the phone and select
Options. Display the Application pane. In the Media area, enter the folder where you want the recording file to
be saved.
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. Information appears in the tool tip.
Add to the Contacts List
At any time during a call, you can click on the Call display to add the other party to the Contacts list. For
information on contacts lists, see page 16.
15
CounterPath eyeBeam 1.5 for Mac
16
CounterPath eyeBeam 1.5 for Mac
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. If the contact has a SIP address, you can also and send instant messages, watch their
availability, and let them watch your availability. If the contact has an e-mail address, you can send an e-mail
from eyeBeam.
Contacts are typically organized into groups. eyeBeam includes three built-in groups: “Friends”, “Home”,
“Work”. You can add more groups, as desired.
17
CounterPath eyeBeam 1.5 for Mac
Using Contacts
Call a contact 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.
E-mail a contact who has an Right-click and choose Send E-mail.
e-mail address
You can watch the contact’s See Table 2 on page 26 for the meaning of the availability icons.
availability, if the contact has a See “Availability” on page 23 for information on obtaining availability
SIP address information.
Managing Contacts
Adding, Deleting or Renaming Groups
Click the Contacts menu and choose Manage Groups.The Manage Groups dialog box appears.
• To create a new group, click New Group, type a name, and press Enter.
• To rename, click on the group so that only the text is selected. Type the new text and press Enter.
• To delete a group, select the group and choose Delete Group. The group is deleted. The contacts in that
group are moved to No Group.
Adding a Contact
Click the Contacts menu and choose Add Contact. The Contact Properties dialog box appears, see below.
Finding a Contact
If the contacts list is long, use the field to filter the contacts that are displayed. To clear the filter and
redisplay all contacts, clear the field.
Changing Contact Information
To change the information for a contact, right-click the contact and choose Edit. The Contact Properties dialog
box appears, see below. Some of the changes you can make are:
• Change any contact details.
• Add, delete or change a contact method.
• Change the primary contact method.
• Move a contact to another group by selecting a different group.
• Add an existing contact to more groups by selecting one or more extra groups.
• Change the Show this contact’s Availability checkbox to enable or disable availability information for this
contact. For information on availability, see page 23.
Moving or Deleting a Contact
• To drag a contact to a different group, select it and drag it to the new Group name.
• To delete a contact, right-click the contact and choose Delete. The contact is removed from this group.
18
CounterPath eyeBeam 1.5 for Mac
Field Description
Name Complete as desired.
Display as Required. This is the name that will appear in the Call display and the Call Alert when this
person phones you.
Group(s) Either:
• Choose one group.
• Click Select More and select several groups. The new contact will be added to each group.
• Create a new group by clearing the field and typing in a new name. The new contact will be
added to this new group.
• Clear the displayed group in order to add the contact to No Group
Contact Methods Enter as many contact methods as you want. E-mail and SIP entries must have the format
<name>@<domain>
If necessary, change the primary Contact Method.
Show this contact’s Click in order to obtain this contact’s availability and display it on the Contacts list. This field is
Availability only enabled when a SIP address is specified.
This contact will have a beside their name in the Contacts list. Initially this icon will be gray,
later its color will change to indicate the current availability.
For details on availability, see page 23.
Details tab Complete as desired.
19
CounterPath eyeBeam 1.5 for Mac
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.
• An XML file.
The new contacts will be added to the existing contacts.
1. Click the Contacts menu and choose Import. The Import Contacts wizard starts.
2. As soon as you click Finish on the wizard, the Contacts tab in eyeBeam is updated to show the imported
entries. Note that none of the entries are set up with availability turned on; in order to view availability of
contacts, you must modify the appropriate entries by changing the Show this contact’s Availability
checkbox. See above for details.
Exporting Contacts
You can export a contacts list to a comma-separated file.
1. Click the Contacts menu and choose Export. The Export Contacts wizard starts.
2. When you click Next, the export starts. A file of the specified type is created.
Using Remote Storage
A contacts list can be stored remotely for retrieval using XCap or WebDAV. The contacts list must be formatted
for the chosen protocol. Specify the remote location on the Accounts Storage tab; see “Account Properties –
Storage” on page 51.
Each time eyeBeam is started, the contacts list is retrieved from the remote storage. Each time a contact is added
to the contacts list, it is immediately copied to remote storage.
20
CounterPath eyeBeam 1.5 for Mac
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.
• Blocked: an incoming call will be blocked (rejected) if it is from a person you have banned (see “Privacy
Rules” on page 57) or if it is does not match the security option you have specified (see “Account Properties
– Security” on page 53).
21
CounterPath eyeBeam 1.5 for Mac
22
CounterPath eyeBeam 1.5 for Mac
4.4 Availability
Availability refers to the ability to see whether a person is available or not: online, on phone, busy, and so on.
Availability information is displayed in the Calls & Contacts drawer.
You can publish your availability to contacts who have SIP addresses, and you can set up eyeBeam to view the
availability of other contacts.
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. The
request asks that you be able to see that person’s availability. If the person allows this request, then the icon
beside their name (in your Contacts lists) becomes color coded (see below for details), so you can determine
their availability.
Allowing Other Parties to See your Availability (Publishing your Availability)
Continuing from above, when the other person allows the notification request, your name is added to their
Contacts list. As soon as you are added to their list, a request is sent back to you requesting that that they be able
to see you. You can reply to this request to complete the sharing loop.
Troubleshooting: When You Cannot See Availability
If you have multiple accounts set up, icons may remain gray when you expect them to be color coded. For
information on how this can happen, see “Account Properties – Presence” on page 49.
23
CounterPath eyeBeam 1.5 for Mac
Joseph Kokila
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. See “Privacy Rules” on
page 27.
• If you do not yet have a privacy rule set up for this person, this request appears to you as a New Contact
Request.
24
CounterPath eyeBeam 1.5 for Mac
25
CounterPath eyeBeam 1.5 for Mac
26
CounterPath eyeBeam 1.5 for Mac
2. Complete the dialog box. If you click “Add rule for a person”, enter a SIP address. If you omit the domain,
your domain is automatically added when you click Add. If you click “Add rule for a domain”, enter just the
domain.
The new name is added to the Privacy Rules list with all groups set to Yes or No.
If a new contact request is received from this person, eyeBeam automatically responds according to the rule: the
New Contact Request dialog box will not be displayed.
27
CounterPath eyeBeam 1.5 for Mac
Changing Settings
To change the settings for an existing name, click in the cell you want to change; the value changes, for example
from No to Yes.
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.
Therefore, you should only remove the privacy rule for a person when the address is no longer valid.
• If the rule is for a domain: If you are in the contact list of anyone in that domain or if people in that domain
are in your contact list, you will receive a New Contact Request from each of those people, because you no
longer have a rule for any of them.
Therefore, in general, you should not remove the privacy rule for a domain. Instead, you may want to set up
several rules. For example, an allow rule for the domain and ban rules for some people in that domain. Or a
ban rule for the domain and allow rules for some people in that domain.
28
CounterPath eyeBeam 1.5 for Mac
Conversation area
Message input
29
CounterPath eyeBeam 1.5 for Mac
30
CounterPath eyeBeam 1.5 for Mac
6.1 Options
Field Description
Confirm before closing application Click on or off, to suit your preference.
Turn letters into digits when typing into the Click on or off, to suit your preference.
phone You can also turn this feature on and off at any time by pressing the spacebar.
Prompt me when an upgrade is available Click on or off, to suit your preference.
Number of calls in each list Enter number to suit your preference.
Double clicking Choose the action that suits your preference.
Enable Zero Touch bandwidth detection 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 34.
The recommended setting is On.
Enable status bar messages When clicked on, messages relating to zero touch configuration will appear in a
notification balloon at the lower right corner of the screen, whenever the
configuration automatically changes.
Recorded calls location Specify a location for saving files when you record your conversations.
31
CounterPath eyeBeam 1.5 for Mac
32
CounterPath eyeBeam 1.5 for Mac
• 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”.
• You can add a custom indicator, click New, type in the availability description, and assign an icon. For
example, you might create an indicator called “Client meeting” with the Away icon.
• You can edit or delete a custom indicator.
33
CounterPath eyeBeam 1.5 for Mac
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.
Table 4: Options – General – Devices
Field Description
Headset
Speaker device Change these fields only if you want to override the devices that eyeBeam
Microphone device 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.
Therefore, unless you will always be using eyeBeam in speakerphone mode,
you must make a selection here.
Select the headset in both the Speaker device field and Microphone device field.
Use acoustic echo cancellation (AEC) Reduces 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.
Turning this feature on improves sound quality.
Typically on.
Use auto gain control (AGC) Automatically adjusts the microphone volume level so that the other party does
not hear the distortion that might be caused by too high a microphone input or
too low volume (due to too low input level).
Typically on.
Use noise reduction Automatically attempts to remove background noise.
Typically off for the headset.
34
CounterPath eyeBeam 1.5 for Mac
Field Description
Speakerphone
Speaker device Change this field only if you want to override the devices that eyeBeam
automatically selected.
Make the appropriate choice:
• 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. The Speaker Phone button
on the dialpad is disabled.
Microphone device Change this field only if you want to override the devices that eyeBeam
automatically selected.
Make the appropriate choice:
• Select the device that you want to use for audio in (recording your voice)
when the Speaker Phone button is pressed.
It can be any microphone: it does not have to be the microphone on the
device you specified as the speaker device. For example, it can be the
microphone on your camera.
• Select None if you do not have a speaker phone. The Speaker Phone button
on the dialpad is disabled.
Use acoustic echo cancellation (AEC) Reduces 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.
Turning this feature on may . However, the drawback is that it uses more
processing power, which may slow down your applications.
Typically on.
Use auto gain control (AGC) Automatically adjusts the microphone volume level so that the other party does
not hear the distortion that might be caused by too high a microphone input or
too low volume (due to too low input level).
Typically on.
Use noise reduction Automatically attempts to remove background noise.
Typically on for the speakerphone.
Ring Device
Speaker device Change this field only if you want to override the devices that eyeBeam
automatically selected.
The device where you want to hear the phone ringing: the headset, the
speakephone, or none.
Camera
Camera This field appears only on version of eyeBeam that include video functionality.
Change this field only if you want to override the devices that eyeBeam
automatically selected.
Select the camera model.
35
CounterPath eyeBeam 1.5 for Mac
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.
About Codecs
Audio codecs describe the format by which audio streams are compressed for transmission over networks.
Codecs can be categorized as either narrowband or wideband:
• Narrowband codecs work with low bandwidth such as a dialup internet connection. These codecs have a
sampling rate of 8 KHz.
• Wideband codecs work with high bandwidths and result in better audio quality. However, they do not work
with PSTN. These codecs have a sampling rate of 16 KHz.
36
CounterPath eyeBeam 1.5 for Mac
Supported Codecs
eyeBeam supports a wide range of codecs. See the table.
Included in Retail
Codec Narrowband Wideband Royalty-bearing
eyeBeam
DVI4 3 3
DVI4 Wideband 3 3
EVRC 3 3
G.711aLaw * 3 3
G.711uLaw * 3 3
G.729 * 3 3 3
GSM 3 3
iLBC 3 3
L16 PCM Wideband 3 3
Speex 3 3
Speex FEC 3 3
Speex Wideband 3 3
Speex Wideband FEC 3 3
* Generally, at least one of these codecs must be enabled in order to place a PSTN (land line) call.
37
CounterPath eyeBeam 1.5 for Mac
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.
With only one codec enabled, all calls made will use that particular compression format. 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.
Supported Codecs
Table 6: Audio Codecs Supported in eyeBeam
Included in Retail
Codec Narrowband Wideband Royalty-bearing
eyeBeam
H.263 3 3
H.263+ 1998 3 3
38
CounterPath eyeBeam 1.5 for Mac
Field Description
Network connection speed Complete this field only if you have disabled zero-touch bandwidth detection
(see page 31).
Select the type of network connection for your computer.
Preserve bandwidth When this feature is on, eyeBeam stops sending audio when you are not talking.
When this feature is off, eyeBeam always sends audio, which uses more
bandwidth but may result in better call quality.
Typically off. However, if you are using a slow (dial-up or ISDN) connection,
you may want to turn it on.
Call inactivity When this feature is on, eyeBeam automatically hangs up a call when it detects
the specified period of inactivity. In other words, if you are on a call and the call
gets disconnected (the call session ends) because of network problems (rather
than because of one of the parties hanging up), then eyeBeam ends the call after
the specified period.
Typically on. This feature might be turned off if, for example, a PBX server
already handles inactivity issues.
DNS Optionally, enter addresses for up to two DNS servers.
• If these fields are completed, eyeBeam uses these servers.
• If they are blank, eyeBeam uses the servers specified by the operating system.
39
CounterPath eyeBeam 1.5 for Mac
The Quality of Service pane lets you request a specific transport service for audio, video and signaling
traffic.This service is through DSCP (also known as ToS). In a network that has the default configuration, the
recommended value for audio is 46, because “46” is the standard marking for audio.
eyeBeam supports 802.1p QoS packet tagging. If you set up for QoS, eyeBeam will include the specified
information in the packets that it sends to the network provider. Whether the packet is delivered with the
specified service depends on whether your broadband router and the network provider between you and the
other party supports multiple transport services. In other words, whether each network provider reads the QoS
information and prioritizes packet delivery based on the requested service.
40
CounterPath eyeBeam 1.5 for Mac
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. In order not to create large files when logging (which may create computer problems), you must not
remain logged on indefinitely when logging. You should occasionally exit and restart eyeBeam.
If requested by a customer support representative, you can:
• Open the logging folder and then open a log file using a text editor.
• E-mail the logs in the specified folder to customer support: Click Send logs to customer support. A dialog
box appears showing all the logs. Select files and click Open; the selected files are sent and the dialog box
closes.
You can delete log files from the specified folder as you would delete any file on your computer.
41
CounterPath eyeBeam 1.5 for Mac
SIP Accounts
To work with accounts, click at the top of the phone and choose SIP Account Settings. The SIP Account
window appears, showing all the accounts set up. Each account is automatically assigned a number: the first
account in the list is 0, the second account is 1, and so on. These numbers do not imply any ranking.
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.. Click the Enable box beside each account.
The rules for enabled accounts are:
• When multiple accounts are enabled, you will be able to receive calls on all those accounts.
• You can never place a call on a disabled account (even if you enter the account prefix). If you place a call that
is only “known” to the service provider of a disabled account, it will fail with a “Not found” message.
• You can never receive a call on a disabled account. If another party phones you on a number that is only
known to a disabled account, the call will never appear on your phone.
• When multiple accounts are enabled, the account to use for an outgoing call is determined as follows:
• If you enter the account prefix before the number (for example, #1 for the first account) then that account
is used.
• If you have set up dial plans, then the rules of the dial plan determine which account is used. See “Dialing
Plan” on page 60.
• If you have not set up any dial plans, then the default account is used.
42
CounterPath eyeBeam 1.5 for Mac
Field Description
User Details
Display name This name is displayed in the eyeBeam display.
Other parties will see this name they are when connnected to you.
User name 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.
Authorization user name May not be required. If it is required, it will be provided by your VoIP service
provider.
43
CounterPath eyeBeam 1.5 for Mac
Field Description
Domain For example, in kpereira@domain.com, the domain is “domain.com”. Provided
by your VoIP service provider.
Domain Proxy
Register with domain and receive incoming Check this box if you want to register with your VoIP service provider, so that
calls you can receive incoming calls.
Typically, this field is checked.
A situation in which this field is unchecked is, for example, if your level of
service does not include the ability to receive incoming calls. In this case, turning
this field on may cause registration to fail (when you close the Account
Properties window), meaning that your eyeBeam cannot register with your VoIP
service provider.
Send outbound via 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.com) or an IP address (for example,
123.456.789.012).
• Target domain: To send directly to the other party’s domain.
Dialing Plan 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;
It is possible that this plan will work for you. If you can place a successful call,
then the dialing plan is suitable. If you cannot make a call, or if you want to set
up a dialing plan for you own reasons, see “Dialing Plan” on page 60.
44
CounterPath eyeBeam 1.5 for Mac
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. If so, check what the
settings are in that setup, and make sure you do enter compatible information in eyeBeam. In particular, if your
service provider has a mechanism for call forwarding, find out if you should leave the Forwarding settings on
this Voicemail tab blank.
Field Description
Check for voicemail If your VoIP service includes voicemail, choose the setting specified by your
VoIP service provider:
• On: eyeBeam will subscribe to be notified when there is a voicemail for you.
• Off: the service provider may be set up to advise eyeBeam when there is a
voicemail for you; check with your service provider for details.
If your VoIP service does not include voicemail, choose Off.
Voicemail is controlled by your VoIP service provider, not by eyeBeam. Contact
your service provider for information on using voicemail.
Number to dial for checking voicemail Complete only if your VoIP service includes voicemail.
This is the number that will be called when you click the icon on the Call
display, in order to connect to voicemail and listen to your messages.
If you leave this field empty, then this icon will not work; you will have to
manually dial this number in order to connect to voicemail.
Enter the number provided by your VoIP service provider.
45
CounterPath eyeBeam 1.5 for Mac
Field Description
Number for sending calls to voicemail 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. It only means that
this icon cannot be used to send to voicemail immediately.
Enter the number provided by your VoIP service provider.
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
eyeBeam. If so, make sure you do not enter competing information in eyeBeam
and in the service provider’s user interface. For example, if you turn off this
field, make sure the same feature at your service provider is also turned off.
Otherwise, all your calls will continue to be forwarded.
Always forward to this address You can use this feature even if your VoIP service does not include voicemail.
To forward calls to another number instead of sending them to voicemail. For
example, when you are on vacation and want another person to take your calls.
• To enable forwarding, click the checkbox and enter the number to forward to.
• To disable forwarding, clear the checkbox.
(To send calls to voicemail while you are at your desk, use the DND button on
the dial pad.)
Forward to this address when busy You can use this feature even if your VoIP service does not include voicemail.
To forward only when your are busy on another line.
• To enable forwarding, click the checkbox and enter the number to forward to.
If your VoIP service service includes voicemail, you can enter your voicemail
number in this field.
• To disable forwarding, clear the checkbox.
Your service provider may also a provide similar features that is set up outside of
eyeBeam. If so, make sure you do not enter competing information in eyeBeam
and in the service provider’s user interface. For example, if your turn off this
field, make sure the same feature at your service provider is also turned off.
Otherwise, all your calls will continue to be forwarded.
46
CounterPath eyeBeam 1.5 for Mac
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.
The recommended setting is Discover global address.
STUN Server This setting specifies the STUN server to use.
• Discover the server: Choose this option to let eyeBeam find the address of a
STUN server.
• Use specified server: To use a different STUN server. For the address enter a
domain name or an IP address.
The recommended setting is Discover server.
Enable ICE ICE optimizes traffic and may help with firewall traversal.
Typically, ICE is enabled. However, it may need to be disabled if your VoIP
service provider has implemented a firewall traversal solution that is not
compatible with ICE enabled.
If you have problems with calls, contact your service provider for information on
their firewall traversal solution.
47
CounterPath eyeBeam 1.5 for Mac
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.)
• Unchecked: If your computer is not behind a restrictive firewall.
XTunnels
Use XTunnels The appropriate setting for XTunnels depends on whether your VoIP service
provider has an XTunnels server.
• Automatic: Use XTunnels when eyeBeam detects a firewall that prohibits
communications. This is the recommended setting if your service provider
has an XTunnels server.
• Always: Always use XTunnels.
• Never: Do not use XTunnels. This is the correct setting if your service
provider does not have an XTunnels server.
Server address Optionally, specify the name or IP address of the XTunnels server to use.
• If the field completed, eyeBeam will use that server.
• If it is blank, eyeBeam will perform a DNS lookup to discover the server.
Use SIP user login and password Check this box to use the username and password from your SIP account in order
to log into the XTunnels server.
Otherwise, uncheck this box and complete the Username and Password fields.
48
CounterPath eyeBeam 1.5 for Mac
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.
The icons in the Contacts tab on the Calls & Contacts drawer will be color-coded to show the contacts’
availability.
Once you have configured presence on this page, you can set up rules; see “Availability” on page 23 and
“Privacy Rules” on page 27.
How Availability Works for Multiple Accounts
The Presence tab appears only for the account that is currently the default account. If you change the default
account, the Presence tab will appear for that account and not for the previous default account.
The tab only appears for the default account because typically you can only see the presence for contacts who
are contacted through the proxy for the account that is currently the default. For example, when the account
domain.com is the default, all the contacts with the address “@domain.com” are watchable. The contacts at
other domains are not watchable; their availability icons appear as gray.
(The only exception to this rule is if the default account supports “passthrough”, in which case you will be able
to watch contacts for domains that the service provider passes through. Contact your VoIP service provider for
details.)
The procedure for configuring availability for multiple accounts is:
• Choose which account you want to watch availability on. Set that account as the default. Note that the choice
of default will affect how your dial plans work (if you use dial plans). See “Dialing Plan” on page 60.
• Enter the appropriate values on the Presence tab for that account.
49
CounterPath eyeBeam 1.5 for Mac
The icons of the eligible contacts in the Contacts tab on the Calls & Contacts drawer will be color-coded to
show the contacts’ availability.
Field Description
Presence Mode 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. The factory setting is
300.
Refresh Interval Enter the value specified by your VoIP service provider. The factory setting is
3600.
50
CounterPath eyeBeam 1.5 for Mac
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.
How Storage Works for Multiple Accounts
If you have multiple accounts, the local storage method is supported and easily managed.
However, if you are thinking of setting up remote storage, keep the following in mind: When you add a contact
(either manually or through a new contact notification), the contact is stored at the remote storage location for
the current default account. Keep in mind that this account may not allow the new contact’s availability to be
watched (for an explanation see “Account Properties – Presence” on page 49). In addition, when you switch
default accounts, the list of contacts displayed on the Contacts tab switches from the old default account to the
new default account.
Table 12: Account Properties – Storage
Field Description
Storage method The storage method to be used for the Contacts list file and the presence rules.
The file can be stored locally or on a remote computer.
• Local
• WebDAV
• XCAP.
51
CounterPath eyeBeam 1.5 for Mac
Field Description
Use SIP credentials 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.
Not used for “Local”.
Root URL URL of an appropriate root folder on the remote server.
Not used for “Local”. The factory setting is https://webdav.$domain$/webdav/
$username$/
WebDAV poll time Enabled only for WebDAV. The time that elapses between polling for new
contact data from the remote server.
The factory setting is 600.
52
CounterPath eyeBeam 1.5 for Mac
Field Description
Signaling Transport 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.
• Encrypted: Currently, this option means TLS will be used. Choose this option
to request signaling encryption or both signaling and media encryption.
• TCP: This transport provides no signaling security.
• UDP: This transport provides no signaling security.
• TLS: Choose this option to request signaling encryption or both signaling and
media encryption.
Media Encryption See Table 14 on page 54.
The factory setting is Make unencrypted calls, accept all calls.
You can set up eyeBeam for the type of security (encryption) you want for incoming and outgoing calls.
eyeBeam supports:
• Signaling encryption using TLS
• Media encryption using SRTP.
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.
53
CounterPath eyeBeam 1.5 for Mac
Setting up the root certificate on your computer ensures that the connection to the proxy is TLS secure (the first
hop). Any proxy in the chain (between you and the caller) that does not support TLS may cause an insecure link
in the chain. Therefore, if the other party is outside your domain, you cannot be completely sure that the call is
secured at the signaling level, which means that you cannot be sure that it is secured at the media level.
When a call with both signaling and media encryption is established, eyeBeam displays the encryption icon
( ). This icon indicates that the call is secure between each caller and their proxy (first and last hop) and that it
may or may not be secure for other hops.
When a call with no encryption or with only signaling encryption is established, eyeBeam displays the
unencrypted icon ( ).
Setting up for Security within eyeBeam
The options for media encryption are described in the following table.
Table 14: Security Options
Option How Outgoing Calls are Handled How Incoming Calls Are Handled
Make and accept only eyeBeam will place all calls with TLS. The call eyeBeam will only accept INVITEs that are for
encrypted calls INVITE will specify SRTP media encryption. encrypted calls.
If the correct certificates are not in place or if the If eyeBeam receives a call INVITE that is not
other party does not accept encrypted calls, the call encrypted, the call will be rejected and will be
will fail. placed in the Blocked list in the Calls & Contacts
drawer.
Prefer to make and eyeBeam will place all calls with TLS. The call eyeBeam will accept INVITEs for both encrypted
accept encrypted calls INVITE will specify SRTP media encryption. and unencrypted calls.
If the correct certificates are not in place or if the
other party does not accept encrypted calls, the call
will fail. eyeBeam will then place the call without
encryption.
Make unencrypted calls, eyeBeam will place only unencrypted calls. eyeBeam will accept INVITEs for both encrypted
accept all calls If the other party does not accept unencrypted and unencrypted calls.
calls, the call will fail.
Do not allow encrypted eyeBeam will place only unencrypted calls. eyeBeam will only accept INVITEs that are for
call If the other party does not accept unencrypted unencrypted calls.
calls, the call will fail. If eyeBeam receives a call INVITE that is
encrypted, the call will be rejected and will be
placed in the Blocked list in the Calls & Contacts
drawer.
54
CounterPath eyeBeam 1.5 for Mac
Field Description
Reregister every 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.
The factory setting is 3600.
Min. time If the reregistration fails, eyeBeam will wait this amount of time, then attempt to
reregister. If the second attempt fails, eyeBeam will wait twice this time and try
again, then four times this time, and so on, until reregistration succeeds.
The factory setting is 20.
55
CounterPath eyeBeam 1.5 for Mac
Field Description
Max. time 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:
• Wait 20 secs.
• Attempt to connect.
• If fail, wait 40 secs.
• Attempt to connect.
• If fail, wait 80 secs.
• Attempt to connect.
• If fail, wait 120 secs (the maximum)
• Attempt to connect.
• If fail, wait 120 secs, and so on.
The factory setting is 1800.
Send SIP keep-alives Typically on, to instruct eyeBeam to send SIP keep-alive messages in order to
maintain a “pinhole” through your firewall for SIP messaging.
Session timer preference 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:
• None: No preference.
• Local refreshes: Your computer sends.
• Remote refreshes: The other party sends.
• UAC refreshes: The user agent client (the party that initiated establishment of
the communications) sends.
• UAS refreshes: The user agent server (the other party) sends.
56
CounterPath eyeBeam 1.5 for Mac
57
CounterPath eyeBeam 1.5 for Mac
58
CounterPath eyeBeam 1.5 for Mac
59
CounterPath eyeBeam 1.5 for Mac
B.1 If you want to be able to place calls on a specific account without including the account prefix, then you
must create a dial plan for one or more accounts.Dialing Plan Syntax
In eyeBeam, the dialing plan establishes the expected patterns of characters for a telephone number or SIP
address, and allows for modification (transformation) of input based on the match to a pattern.
The dialing plan has the following syntax:
pattern[|pattern];match=1;<transformation>=<value>;[match=2;
<transformation>=<value>;]
Where:
• Items in [ ] are optional.
• 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. The transformation is optional (meaning
that if there is no transformation for a pattern, then the input that matches this pattern is not transformed).
One or more pairs.
60
CounterPath eyeBeam 1.5 for Mac
“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 <value> 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.
• match=1;prestrip=2;is the first match-transformation pair.
• match=2;pre=8;is the second match-transformation pair.
Pattern
Valid Content
The content for a pattern follows the digit map rules of RFC 2705, supplemented by the rules for regular
expressions. Where there is an overlap between the digit map and regular expression rules, the digit map rules
apply. For this reason, there are some special cases, included in the table below.
The following table describes the most common elements. As mentioned, all regular expression elements are
supported.
Element Origin Description
0 1 2 3 4 5 6 7 8 9 Literals Literal digits, used as is.
# * a to z Literals Literal characters, used as is.
Special cases:
• 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.
\a Regular Wildcard for any single alphanumeric character.
expression rules
[digit-digit] Regular A digit within the specified range.
expression rules
[character- Regular A character within the specified range.
character] expression rules
[digit1, digit2, Regular One of the characters in the collection.
digit3] expression rules
. 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 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. If there is no timer, then as soon as you type
three digits, eyeBeam makes the match as soon as you type three digits.
• Any dialing plan that has two patterns that are similar in elements but different in
length. For example, if one pattern is xxx and the other pattern is xxxxxxx, then
adding the timer lets you continue typing past three digits, in order to get a match on
the second pattern.
In this situation, the T timer should be included in the shorter pattern.
61
CounterPath eyeBeam 1.5 for Mac
Timers
There are two timers:
• T timer is 4 seconds.
• The long timer is 20 seconds.
These timers are used in input comparison, as described in “How the Input Is Processed” on page 62.
Transformation Keywords
Keyword Description
prestrip Strip the first n characters from the input before
placing the call.
poststrip Remove n number of characters from the end of
the input before placing the call.
pre Add the specified account prefix to the input
before placing the call.
post Attach the specified postfix to the input before
placing the call.
replace Replaces the input with the specified string
before placing the call.
Order of Transformations
These transformations are always performed in the following order (the order in which the transformations are
entered in the dialing plan is not significant):
prestrip > poststrip > pre > post > replace
62
CounterPath eyeBeam 1.5 for Mac
B.3 Examples
Example 1
\a\a.T|xxxxxxx.T;match=2;pre="9"
This simple example shows how to differentiate between a PSTN number and a SIP address, and how to add a
“9” dialing prefix only to the PSTN number.
Example 2
3xxT|1xxxxxxxxxx|[2-9]xxxxxxxxx|+x.T;match=2;pre="9";
match=3;pre="91";match=4;prestrip=1;pre="9011"
3xxT The first pattern is any three-digit number beginning with 3. No transformation. The
assumption is that this is an internal extension. The timer forces eyeBeam to wait after
detecting a three-digit number beginning with 3, in case you are actually dialing a local call
starting with 3.
1xxxxxxxxxx The second pattern is any eleven-digit number beginning with 1. Prefix with 9 and dial as is.
The assumption is that this is a long-distance PSTN call within North America (within North
America, all long-distance calls start with 1).
[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).
match=2;pre="9"; For the second pattern, prefix 9 to access an outside line.
match=3;pre="91"; For the third pattern, prefix 9 and 1 to access an outside line and enter the long-distance code.
match=4;prestrip=1;pre="9011" For the fourth pattern, remove the + and prefix 9011 to access an outside line and enter the
international code.
63
CounterPath eyeBeam 1.5 for Mac
Example 3
#1xxxxxxxT|#19xxxxxxx|xxxxxxxT|9xxxxxxx|;match=1;prestrip=2;pre=9;match=2;
prestrip=2;match=3;pre=9;
Table 17:
#1xxxxxxxT 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.
#19xxxxxxx The pattern is an account prefix followed by a 9 and seven digits. The #1 is stripped off.
xxxxxxxT The pattern is seven digits. The timer forces eyeBeam to wait to allow matching to the
fourth pattern. 9 is prepended to access an outside line.
9xxxxxxx The pattern is a 9 and seven digits. The input is not transformed.
This example assumes that the dialing plan belongs to the first account.
The dialing plan is slightly trivial, because it does not cover all the situations that a dialing plan should be
designed for (local calls, long-distance calls, international calls, and so on for the locale).
However, the example does illustrate two ideas:
• Handling of the account prefix (#1), if you are upgrading from eyeBeam 1.1 and are accustomed to entering
the account number.
Use of # to identify the account is now deprecated. The dialing plan should be capable of determining the
account to use for this number. However, since users may still be in the habit of entering the account prefix,
you may want to include this pattern to handle such a scenario.
• Distinguishing between a local seven-digit call in which 9 is not dialed (to access an outside line) and one in
which 9 is dialed to access an outside line.
64
CounterPath eyeBeam 1.5 for Mac
65
CounterPath eyeBeam 1.5 for Mac
Appendix D: Glossary
AEC 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.
AGC Automatic gain control. Processing of the audio or video signal to adjust the
microphone volume level so that the other party does not hear the distortion that
might be caused by too high a microphone input or too low volume (due to too low
input level).
Broadband Broad or wide bandwidth. In data transmssion, 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.
Codec The format by which audio or video streams are compressed for transmission over
networks.
Default account The SIP account that will be used when placing an outgoing call, if eyeBeam does not
determine that another account should be used. eyeBeam uses the dialing plan to
determine the account to use. You can mark one account as the default account; see
“Setting the Default Account” on page 43.
Dialing plan The rules that eyeBeam follows in order to interpret the SIP address or phone number
that the user has entered and to modify the number or address, as required, to ensure
that the call will be placed successfully.
DTMF Dual-tone multifrequency. DTMF is the system that is used in interactive voice-
response menu systems such as the menu system for accessing voicemail messages.
The DTMF system allows the user to interact with the menu by pressing keys on a
dialpad or keyboard.
IM Instant Messaging. A technology that lets users send text message and files for near
instantaneous delivery and display on each others’ computers.
IP Internet Protocol. A data-oriented protocol used for communicating data across a
network. IP is the most common protocol used on the internet.
IP address A unique number that devices use in order to identify and communicate with each
other on a computer network using the IP standard.
Media In a VoIP phone call, the audio and video portion of the information in a call.
Compare to “Signaling”.
MOV The Mac QuickTime multimedia container format. MOV files contain both audio and
video data in a standard container that allows simultaneous playback.
MWI Message Waiting Indicator. An indicator that there is a voicemail message for the
owner of an account.
Narrowband In data transmssion, 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.
Presence An instant messaging feature that allows users to share information about their
availability, mood, location and so on.
Proxy See SIP account.
PSTN Public Switch Telephone Network. The traditional land-line phone network.
66
CounterPath eyeBeam 1.5 for Mac
RFC Request for Comment. A document that describes an aspect of an internet technology.
An RFC may be a proposed, draft or full internet standard.
RTP Real-time Transport Protocol. A protocol for delivering the media portion of a data
transmission over an IP network. SRTP is another media protocol.
Signaling In a VoIP phone call, the information in a call that deals with establishing and
controling the connection, and managing the network. The non-signaling portion of
the call is the Media.
SIMPLE protocol Session Initiation Protocol for Instant Messaging and Presence Leveraging
Extensions. The instant messaging (IM) protocol followed by eyeBeam. It
encapsulate the rules for exchanging instant messages.
SIP Session Initiation Protocol. The signaling protocol followed by eyeBeam for handling
phone calls.
SIP account An account that provides the user the ability to make VoIP phone calls. The account
encapsulates the rules and functions the user can access.
SIP address The address used to connect to a SIP endpoint. In other words, the “phone number”
used in a VoIP phone call. For example, sip:joseph@domainA.com.
SRTP Secure Real-time Transport Protocol. A protocol for delivering the media portion of a
data transmission over an IP network. SRTP is a secure protocol, which means tht the
media is encrypted. RTP is another media protocol.
TCP Transmission Control Protocol. A transport protocol for delivering data over an IP
network. Other transport protocols are TLS and UDP.
TLS Transport Layer Security. A transport protocol for delivering data over an IP network.
TLS is a secure transport protocol, which means that all the data being transmitted
(signaling and media) is encrypted. Other transport protocols are TCP and UDP.
UDP User Datagram Protocol. A transport protocol for delivering data over an IP network.
Other transport protocols are TCP and TLS.
URI Uniform Resource Identifier. A name or address that identifies a location on the world
wide web. A SIP address is a type of URI.
URL Uniform Resource Locator. A URI that both identifies a name or address and indicates
how to locate it.
USB device Universal Serial Bus device. A device that follows a specific communications
standard. A headset may be a “USB type” of headset.
VAD Voice Activity Detection. A technology that detects if audio is a human voice or
background noise. eyeBeam includes a feature (Preserve bandwidth on the Network
pane of the Options window) that controls whether audio is transmitted when VAD
determines that noone is actually speaking.
VoIP Voice over Internet Protocol. A variation of IP used for sending voice data over the
internet, in other words, used for making phone calls over the internet.
VoIP service provider A business that provides a VoIP service, allowing a user to connect to the internet in
order to make VoIP phone calls using eyeBeam. The VoIP service provider sets up a
SIP account for the user.
WAV Or WAVE. A file format standard for storing audio on PCs.
67