SignalWire DocsInstances of this class allow you to control (e.g., pause, resume, stop) the playback inside a room session. You can obtain instances of this class by starting a playback from the desired RoomSession (see RoomSession.play).
End time, if available.
Unique id for this playback.
Current playback position, in milliseconds.
Id of the room session associated to this playback.
Start time, if available.
Current state of the playback.
Url of the file reproduced by this playback.
Audio volume at which the playback file is reproduced.
▸ forward(offset): Promise<void>
Seeks the current playback forward by the specified offset.
Relative number of milliseconds to seek forward from the current position. Defaults to 5000 (5 seconds).
Promise<void>
room.playback.seek or the more permissive room.playbackYou need to specify the permissions when creating the Video Room Token on the server side.
▸ pause(): Promise<void>
Pauses the playback.
Promise<void>
▸ resume(): Promise<void>
Resumes the playback.
Promise<void>
▸ rewind(offset): Promise<void>
Seeks the current playback backwards by the specified offset.
Relative number of milliseconds to seek backwards from the current position. Defaults to 5000 (5 seconds).
Promise<void>
room.playback.seek or the more permissive room.playbackYou need to specify the permissions when creating the Video Room Token on the server side.
▸ seek(timecode): Promise<void>
Seeks the current playback to the specified absolute position.
The absolute position in milliseconds to seek to in the playback.
Promise<void>
room.playback.seek or the more permissive room.playbackYou need to specify the permissions when creating the Video Room Token on the server side.
▸ setVolume(volume): Promise<void>
Sets the audio volume for the playback.
The desired volume. Values range from -50 to 50, with a default of 0.
Promise<void>
▸ stop(): Promise<void>
Stops the playback.
Promise<void>