The Communicator Audio/Telephony Server (CATS) | ||
---|---|---|
<<< Previous | Server Application | Next >>> |
reinitialize responds to a hub connection request to CATS, initializing default server behavior according to the following input keys:
Table 2. reinitialize input keys
parameter | type | optional | depends on | description/constraints |
---|---|---|---|---|
:encoding | string | Yes | N/A | Sample encoding. Same options as listed in command line arguments. |
:sample_rate | integer | Yes | N/A | Sample rate. |
:sample_size_in_bits | integer | Yes | N/A | Sample size in bits. |
:channels | integer | Yes | N/A | Sample channels. |
:frame_size | integer | Yes | N/A | Frame size in bytes. |
:frame_rate | integer | Yes | N/A | Frame rate, frames per second. |
:big_endian | string | Yes | N/A | Big endian byte ordering indicator; recognized values are "true" and "false". |
reinitialize causes CATS to issue a server status message. This function returns a frame.
receive_audio handles incoming audio broker requests, and places receive audio data in a playback queue.
Table 3. receive_audio input keys
parameter | type | optional | depends on | description/constraints |
---|---|---|---|---|
:binary_host | string | No | N/A | Broker server host. |
:binary_port | integer | No | N/A | Broker server port. |
:call_id | string | No | N/A | Call ID string. |
:binary_proxy | broker proxy (4.0 only) | No | N/A | If :binary_host and :binary_port are present, CATS will attempt to access the audio data via a broker. In 4.0, if :binary_proxy is present, CATS will use the specified proxy as the audio source if :binary_host and :binary_port are absent. |
:encoding | string | Yes | N/A | Sample encoding. Same options as listed in command line arguments. |
:sample_rate | integer | Yes | N/A | Sample rate. |
:sample_size_in_bits | integer | Yes | N/A | Sample size in bits. |
:channels | integer | Yes | N/A | Sample channels. |
:frame_size | integer | Yes | N/A | Frame size in bytes. |
:frame_rate | integer | Yes | N/A | Frame rate, frames per second. |
:big_endian | string | Yes | N/A | Big endian byte ordering indicator; recognized values are "true" and "false". |
This function returns a frame.
off_hook implements a hub-driven "off hook" request to CATS, which responds to this request by issuing an off hook message. This function returns a frame.
on_hook implements a hub-driven "on hook" request to CATS, which responds to this request by issuing an on hook message. This function returns a frame.
touchtone causes CATS to behave as though a keypad were being pressed, causing the server to generatetouch tone messages. This function returns a frame.
mute implements hub-driven muting of input audio. CATS responds by issuing a mute status message. This function returns a frame.
unmute implements hub-driven unmuting of input audio. CATS responds by issuing a mute status message. This function returns a frame.
start_recording implements a hub-driven request to start recording. CATS responds by issuing a recording status message. This function returns a frame.
stop_recording implements a hub-driven request to stop recording. CATS responds by issuing a recording status message. This function returns a frame.
resend_audio implements a hub-driven request to resend the last recorded utterance. CATS responds by issuing a resend status message. This function returns a frame.
query_status implements a hub-driven query status request to CATS, which responds to this request by issuing a server status message. This function returns a frame.
<<< Previous | Home | Next >>> |
Usage | Up | Messages issued |