See alsoVideo control management including playing and pausing an AV stream or file.
WebVue support - No. Returns an unsuccessful code if used in this context.
| Mode | Mnemonic | Syntax | WebVue support |
| 1 | PLAY | 1 | No |
| 2 | STOP | 2 | No |
| 3 | PAUSE | 2 | No |
| 4 | LOOP | 3 | No |
| 5 | MUTE | 3 | No |
| 6 | SNAPSHOT | 4 | No |
| 7 | SEEKTO | 5 | No |
| 8 | JUMPFORWARD | 5 | No |
| 9 | JUMPBACKWARD | 5 | No |
| 10 | SETPREFERENCE | 6 | No |
Arguments common to more than one mode
| Argument | Meaning |
| Window | The name of the window that contains the Video control. Type STR. |
| Branch | The branch (if any) of the window. Use "*" to indicate the current branch of the program. Type STR. |
| Identity | The identity of the Video control within the specified window. Type STR. |
Syntax 1
LongVal = VIDEODISPLAY(Mode, Window, Branch, Identity[, Uri]);
Return type: LONG.
| Argument | Meaning |
| Media | The Url of a stream or the name of an AV file. Optional. Type STR. |
Execution
|
Mode |
Mnemonic |
Action |
| 1 | PLAY | Display the stream or file available at Uri. If it is not provided, the currently configured media is played. Return: 1 if successful, else 0 (no media configured). |
Syntax 2
LongVal = VIDEODISPLAY(Mode, Window, Branch, Identity);
Return type: LONG.
Execution
| Mode | Mnemonic | Action |
| 2 | STOP | Stop the playback. Return: 1 if successful, else 0. |
| 3 | PAUSE | Pause or resume the playback (toggle). Return: 1 if successful, else 0. |
Syntax 3
LongVal = VIDEODISPLAY(Mode, Window, Branch, Identity, SubMode);
Return type: LONG.
| Argument | Meaning |
| SubMode | Sub-mode for the instruction. Type INTEGER. |
Execution
| Mode | Mnemonic | Action |
| 4 | LOOP | Set the loop action for when the end of the video stream is reached according to the specified SubMode: 1 - Play the video stream again (loop) 0 - Do not play the video stream again Return: 1 if successful, else 0. |
| 5 | MUTE | Set the mute status according to the specified SubMode: 1 - Mute 2 - Unmute 3 - Toggle the mute status Return: 1 if successful, else 0. |
Syntax 4
LongVal = VIDEODISPLAY(Mode, Window, Branch, Identity[, Path]);
Return type: LONG.
| Argument | Meaning |
| Path | The path in which to store the snapshot. If omitted, the snapshot directory configured on the Video control is used. If not configured, the project's TP folder is used. Optional. Type STR. |
Execution
| Mode | Mnemonic | Action |
|
6 |
SNAPSHOT |
Take a snapshot and store it in the specified path. The generated Jpg file is named after the rule configured at the control level. Return: 1 if successful, else 0. |
Syntax 5
LongVal = VIDEODISPLAY(Mode, Window, Branch, Identity, Time);
Return type: LONG.
| Argument | Meaning |
| Time | Time interval as a number of seconds. Type INTEGER. |
Execution
| Mode | Mnemonic | Action |
| 7 | SEEKTO | Seek to the location specified by Time within the video. Return: 1 if successful, else 0. |
| 8 | JUMPFORWARD | Jump forward the number of seconds specified by Time. Return: 1 if successful, else 0. |
| 9 | JUMPBACKWARD | Jump backward the number of seconds specified by Time. Return: 1 if successful, else 0. |
Syntax 6
LongVal = VIDEODISPLAY(Mode, Window, Branch, Identity, PrefName[, PrefValue);
Return type: LONG.
| Argument | Meaning |
| PrefName |
The Id of a Video control preference to set. Type INTEGER. 1 - To set the sound volume in percent. Range 0 to 100%. 2 - To set the file caching period. Range 0 to 60000 milliseconds. 3 - To set the network caching period. Range 0 to 60000 milliseconds. 4 - To enable (1) or disable (0) hardware decoding. |
| PrefValue | The value to set for the preference PrefName (see above for allowed values). Type INTEGER. |
Execution
| Mode | Mnemonic | Action |
|
10 |
SETPREFERENCE |
Set the Video control preference PrefName to the value PrefValue. Return: 1 if successful, else 0. |