Playbacks
Start Playback
Video playback can be added to meetings in addition to image data. Media files must be available through a public URL and can be in WEBM format (recommended) or MP4/MP3 format.
This feature does not include file hosting - you'll need to host the media files elsewhere.
POST /rooms/<access_key>/playbacks # play a video
RESPONSES 201 CREATED, 400 BAD REQUEST, 404 NOT FOUND, 409 CONFLICT, 410 GONE
audio
type: BOOLEAN
Play audio (default: false)
play_id
Type: STRING
Choose an identifier, e.g. current timestamp or use a custom layout position identifier.
replacement_id
Type: STRING
User-id of the participants video to be replaced
If replacement_id is set, the video will replace the current stream of a specific user. Without replacement_id, the video is attached as a new spot.
You can use the layout to set the user or the play_id to fullscreen during the video
playback and switch back afterwards using the layout feature. As with layers, ensure to disable SFU mode.
url
Type: STRING (required)
Hosted MP4/WEBM video or MP3 audio file
name
Type: STRING
Custom readable name for identification
loop_count
Type: NUMBER
Default: 0
Number of repetitions. Set -1 for infinite loop.
The feature `loop_count will NOT work if video codec is h264! You can check this for example with ffprobe (see ffprobe documentation).
The deprecated "playback" object e.g. playback[url]=... is not needed anymore, but can still be used.
Stop playback
If the playback has been started with play_id, it can be stopped using the following request:
DELETE /rooms/<access_key>/playbacks/<play_id> # stop playback with play_id
RESPONSES 200 OK, 404 NOT FOUND