Media
On this page
Play (resume) or pause a media or VLC source.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to (if using multiple OBS) |
| Source Name | String | Name of the source to play or pause. Select from dropdown or input manually. |
| pause | Checkbox | checked = pause, unchecked = resume |
OBS WebSocket 5 Request: TriggerMediaInputAction
| Request Field | Type | Description |
|---|---|---|
| inputName | String | Name of the media source. |
| mediaAction | String | OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE to pause, OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY to resume. |
Restart a media or VLC source.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to (if using multiple OBS) |
| Source Name | String | Name of the source to restart. Select from dropdown or input manually. |
OBS WebSocket 5 Request: TriggerMediaInputAction
| Request Field | Type | Description |
|---|---|---|
| inputName | String | Name of the media source. |
| mediaAction | String | OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART |
Stop a media or VLC source.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to (if using multiple OBS) |
| Source Name | String | Name of the source to stop. Select from dropdown or input manually. |
OBS WebSocket 5 Request: TriggerMediaInputAction
| Request Field | Type | Description |
|---|---|---|
| inputName | String | Name of the media source. |
| mediaAction | String | OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP |
Plays the next track. Can only be a VLC source.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to (if using multiple OBS) |
| Source Name | String | Name of the source to skip a track. Select from dropdown or input manually. |
OBS WebSocket 5 Request: TriggerMediaInputAction
| Request Field | Type | Description |
|---|---|---|
| inputName | String | Name of the VLC source. |
| mediaAction | String | OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT |
Play a previous track. Can only be a VLC source.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to (if using multiple OBS) |
| Source Name | String | Name of the source to play a previous track. Select from dropdown or input manually. |
OBS WebSocket 5 Request: TriggerMediaInputAction
| Request Field | Type | Description |
|---|---|---|
| inputName | String | Name of the VLC source. |
| mediaAction | String | OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS |
Seek to position in a currently playing source. Can be a media or VLC source.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to (if using multiple OBS) |
| Source Name | String | Name of the source. Select from dropdown or input manually. |
| Time (ms) | Int | Time in milliseconds |
OBS WebSocket 5 Request: SetMediaInputCursor
| Request Field | Type | Description |
|---|---|---|
| inputName | String | Name of the media source. |
| mediaCursor | Number | Position to seek to in milliseconds (e.g. 5000 = 5 seconds in). |