Soundstructure Api Behavior Changes - Polycom SoundStructure C16 Design Manual

The SoundStructure VoIP Interface

SoundStructure API Behavior Changes

This section reviews changes made to the SoundStructure API as a result of
supporting the SoundStructure VoIP Interface. The behavior of the following
commands have changed:
phone_dial
In version 1.5.0 of the SoundStructure firmware, the behavior of the
phone_dial command has changed to store the dialed digits when the phone
is onhook and to dial those digits once the phone is taken offhook if the phone
is taken offhook within 20 seconds of dialing the digits. If you send subsequent
phone_dial commands while the phone is onhook, the digits will be appended
to the previous set dialed digits. After 20 seconds with no phone_dial or
phone_connect commands, the dialed digit buffer will be cleared.
In previous versions of SoundStructure firmware a phone_dial command
issued when the phone was onhook would be ignored and digits would nei-
ther be dialed nor stored for subsequent dialing.
There is no change to the phone_dial behavior if the phone was already off-
hook when the phone_dial command is issued.
To dial a SIP URL call, the digits must be dialed while phone_connect is set to
0. The phone_connect command can then be sent to take the phone offhook
and cause the digits to be dialed. Dialing a SIP URL when offhook is not
supported.
run Preset
The run action for presets has been enhanced to provide an immediate "run
Preset" acknowledgement once the preset begins execution. After the preset
has finished executing, the "ran Preset" acknowledgment is generated. This
enhancement allows both SoundStructure Studio and control system applica-
tions to know that a preset is being executed and control system programmers
can make a preset button inactive after the initial "run" acknowledgment is
received and then make the preset button active again once the final "ran"
acknowledgment has been received to prevent users from pressing a preset
button multiple times for presets that take longer to run than expected.
# Execute a preset with the "run" syntax.
run "My Preset"
# Immediately SoundStructure will send an acknowledgment that
# the preset has begun executing
run "My Preset"
# Once the preset has finished executing, SoundStructure continues
# to send the final "ran" acknowledgment
12 - 85