*setPlaybackSpeed
- Tom Polman
Configuration Article | CA-20220907-TP-22 VDG Sense | API | Functions | Client & Server Control  |  |
Note: This function requires an API license.
This function sets the playback speed on the selected client or on all clients.
The playback speed can be taken from a fixed list of values. If the speed is positive, the client(s) will play forwards. If the speed is negative, the client(s) will play backwards.
Request
command=setPlaybackSpeed&divaid=[uid]&speed=[value] |
parameter | type | remarks |
|---|---|---|
divaid | [UID] | Unique diva id. Determines the viewer, if omitted or -1 all viewers are addressed |
speed | [value] | Sets the playback speed at a specific value. Allowed values are: 0.5, 1, 2, 4, 8, 16 for forward playback and -0.5, -1, -2, -4, -8, -16 for backward playback |
Response
<result errorcode="0">
    <description>Ok</description>
</result> |
error code | description | remarks |
|---|---|---|
0 | Ok | Ok, no error |
-1 | Not implemented | The function requires an api license |
-12 | No Diva | There's no system found with the supplied divaid |
-18 | General error | An undefined error occurred |
-22 | Value is out of range | The speed parameter value is not in the list of allowed values |
-23 | An empty value is not allowed | The speed parameter is missing |
-28 | Not a Diva client | The system with the supplied divaid is not a client |
Changelog
2.4.5 – Added