DetectSilence

Metreos.MediaControl.DetectSilence

Asynchronous Callbacks

Summary

DetectSilence monitors a connection for an incidence of silence.

Usage

DetectSilence will fire DetectSilence_Complete if silence is detected for a continuous amount of time as specified in SilenceTime.

A DetectSilence to a connection or a conference results in a voice resource being utilized until the action results in the DetectSilence_Complete event.

Action Parameters
Parameter Name.NET TypeDefaultDescription
ConnectionId *System.StringIndicates the connection to detect silence on.
SilenceTime *System.UInt32The amount of continuous silence to observe (in milliseconds) before firing the DetectSilence_Complete event.
CommandTimeoutSystem.UInt32Indicates a command timeout value (in milliseconds). If this condition is met, the DetectSilence command will result in the DetectSilence_Complete event with a TerminationCondition of timeout.
TimeoutSystem.Int32The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.
Result Data
Parameter Name.NET TypeDescription
OperationIdSystem.StringA unique identifier to this DetectSilence operation. This identifier can later be used by the StopMediaOperation action to stop just this particular operation on a connection, even if multiple media operations are concurrently executing on that connection.
ResultCodeSystem.StringA numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes.
ConnectionIdSystem.StringThe value of the ConnectionId result data is the same as that specified as an action parameter. This ConnectionId is what one would later specify in StopMediaOperation if one were to abort the command programmatically.

Branch Conditions 

Success

No description.

Failure

No description.

Timeout

No description.