Integrator C Series API

Events

This overview list what feedback events are available on the API.

Outgoing Call Indication

Event reported as soon as an outgoing call is about to be dialled. Contains the CallId that this call has been assigned.

*e OutgoingCallIndication CallId: x
** end

Call Disconnect

Event reported when a call is disconnected. Contains the CallId of the disconnected call and reason for the call disconnecting. We recommend that you currently use CauseType to get the reason for the call disconnecting. Currently (TC1.x TC2.x and TC3.x) the causeValue is unfortunately unreliable and should not be used. This will be fixed in later software releases.

*e CallDisconnect CallId: x CauseValue: 0 CauseString: "" CauseType: LocalDisconnect OrigCallDirection: "outgoing"
** end

TString Availability

Event reported when a call is connected. Reports whether or not remote site supports TString.

*e TStringAvailability CallId: 132 Available: "True"
** end

Call Successful

Event reported when a call is connected successfully (all channels are up and established)

*e CallSuccessful CallId: 132 Protocol: "h223" Direction: "outgoing" CallRate: 768 RemoteURI: "h223:integratorHQ@tandberg.com" EncryptionIn: "Off" EncryptionOut: "Off"
** end

FECC Capabilities for remote site

Event reported when a call is connected. Reports the farend sources and FECC capabilities.

*e FeccCapsInd Id: 132
*e FeccCapsInd NumPresets: 15
*e FeccCapsInd NumSources: 5
*e FeccCapsInd Source 1 VideoSrc: 6
*e FeccCapsInd Source 1 Standard: 0
*e FeccCapsInd Source 1 Name: "BluRay"
*e FeccCapsInd Source 1 Pan: 1
*e FeccCapsInd Source 1 Tilt: 1
*e FeccCapsInd Source 1 Zoom: 1
*e FeccCapsInd Source 1 Focus: 1
*e FeccCapsInd Source 1 Motion: 1
*e FeccCapsInd Source 1 NormRes: 1
*e FeccCapsInd Source 1 DoubRes: 1
...
** end

FECC Action request

Event reported when far end is sending FECC commands.

*e FeccActionInd Id: 132 Req: 1 Pan: 1 PanRight: 1 Tilt: 0 TiltUp: 0 Zoom: 0 ZoomIn: 0 Focus: 0 FocusIn: 0 Timeout: 300 VideoSrc: 0 m: 0
** end

TString message received

Event reported when far end has sent a TString message.

*e TString CallId: 132 Message: "ee"
** end

unfortunately a signature bug in the Event document has been introduced in TC4.0 and TC4.0.1. This has been fixed and will be released with TC4.1. TC4.0 and TC4.0.1:

*e TPEString TPEString: "ee" CallId: 2
** end

The workaround for TC4.0 and TC4.0.1 is thus to register for feedback on /Event/TPEString and handle the TPEString feedback:

xfeedback register /Event/TPEString

SString message received

Event reported when far end has sent a SString message.

*e SString String: "ee" Id: 132
** end