Skip to main content

RoomSessionStream

Represents a specific stream of a room session. This is an RTMP stream of the audio/video content of the room, which will be sent to an external party (e.g., to YouTube).

You can start a stream with RoomSession.startStream.

Properties​

duration​

• Optional duration: number

Total seconds of time spent streaming, if available. This is equal to (endedAt - startedAt).

endedAt​

• Optional endedAt: Date

End time, if available.

id​

• id: string

The unique id of this stream.

roomSessionId​

• roomSessionId: string

The id of the room session associated to this stream.

startedAt​

• startedAt: Date

Start time, if available.

state​

• state: "streaming" | "completed"

Current state of the stream.

url​

• url: string

The RTMP URL of the stream.

Methods​

stop​

▸ stop(): Promise<void>

Stops the stream.

Returns​

Promise<void>

Example​

await stream.stop();