Provider
Synchronous
No Custom Parameters
Modifies the properties of a currently executing play operation.
Allows one to vary the volume and speed of a play operation as it is executing.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| ToggleType | System.UInt32 | 0 | If AdjustmentType is toggle, this value indicates how Volume should be toggled; however, Speed is not affected in any way by the use of toggle. A value of 1 toggles Volume between the origin and the last modification to Volume. A value of 2 resets volume to the origin. A value of 3 sets Volume to the last modification to Volume. A value of 4 indicates to put Volume to the origin and also resets the last modification to origin (essentially clearing the history of modifications). |
| ConnectionId * | System.String | The connection to perform the AdjustPlay on. | |
| Volume * | System.Int32 | If AdjustmentType is absolute, then one can set Volume to a value between -10 and 10.
However, if AdjustmentType is relative, then Volume could be between -20 and 20, depending on the value of Volume before the AdjustPlay is executed.
Finally, if AdjustmentType is toggle, then the Volume action parameter is ignored. | |
| Speed * | System.Int32 | If AdjustmentType is absolute, then one can set Speed to a value between -10 and 10.
However, if AdjustmentType is relative, then Speed could be between -20 and 20, depending on the value of Speed before the AdjustPlay is executed.
Finally, if AdjustmentType is toggle, then the Speed action parameter is ignored. | |
| AdjustmentType | System.String | Indicates how the Volume and Speed values are interpreted. Valid values are absolute, relative, and toggle. | |
| Timeout | System.Int32 | The 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. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ResultCode | System.String | A 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. |
Branch Conditions
No description.
No description.
No description.