play

play(params): Promise<RoomSessionPlayback> - See RoomSessionPlayback for more details.

Starts a playback in the room. You can use the returned RoomSessionPlayback object to control the playback (e.g., pause, resume, setVolume and stop).

Name	Type	Description
`params`	`Object`	-
`params.url`	`string`	The url (http, https, rtmp, rtmps) of the stream to reproduce.
`params.seekPosition?`	`number`	The starting timecode in milliseconds for playback. Defaults to `0`.
`params.positions?`	`VideoPositions`	Positions to assign as soon as the playback starts. You can use the special keyword `self` to refer to the id of the playback.
`params.layout?`	`string`	Layout to change to when the playback starts.

Promise<RoomSessionPlayback> - See RoomSessionPlayback for more details.

1 const playback = await roomSession.play({ url: "rtmp://example.com/foo" });
2 await playback.stop();