Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 490
   
6-14
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(3)
Chapter 6      Event Interfaces and Events
ISessionEvents Interface
Figure 6-6
ScreenPreferences Arguments Array
SoundPreferences – Arguments array that contains information configured on the CTI OS 
server in the SoundPreferences/Name subtree. This array includes a nested Arguments array 
that includes a setting for each sound, including .wav files to be played, and whether or not each 
one is mute. It can also include custom name/value pairs for a custom application. 
The SoundPreferences array contains the following key-value pairs:
Table 6-12
SoundPreferences: Key Values
Registry values added to this registry key in the CTI OS server registry are included in the 
arguments array. Subkeys added to this registry key are not present.
The DTMF, DialTone, OriginatingTone, RingInTone, and All arrays each contain the keyword 
Mute, which has a boolean value. Custom registry values added to the DialTone DTMF, 
DialTone, OriginatingTone, RingInTone, and All registry keys are present in the array. Subkeys 
added to the these registry keys are not present in the array.
You can add custom keys in the SoundPreferences subtree at the same level as the All, DTMF, 
DialTone, OriginatingTone, and RingInTone keys. The SoundPreferences array contains items 
corresponding to these custom keys. Any custom element that you add must follow the same 
hierarchy in the registry as that used by the existing top level elements.
“ScreenPreferences”, <Arguments array>
“MainScreen”, <Arguments array>
“BringToFrontOnCall”, 1
“FlashOnCall”, 0
“CustomName”, “CustomValue”
...
“CustomScreen”, <Arguments array>
“BringToFrontOnCall”, 1
...
“CustomName”, “CustomValue”
Keyword
Value
Subtree
DTMF
*
Arguments array
SoundPreferences/Name/DTMF
DialTone
*
Arguments array
SoundPreferences/Name/DialTone
OriginatingTone
*
Arguments array
SoundPreferences/Name/OriginatingTone
RingInTone
*
Arguments array 
SoundPreferences/Name/RingInTone
All
*
Arguments array
SoundPreferences/Name/All