For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
ReferenceGuidesClick-to-Call
ReferenceGuidesClick-to-Call
  • Core
    • Overview
  • SignalWire Client
    • Overview
    • Notifications
    • Client
    • Utility functions
  • Video
    • Overview
    • LocalOverlay
    • RoomSession
    • RoomSessionDevice
    • RoomSessionPlayback
    • RoomSessionRecording
    • RoomSessionScreenShare
    • RoomSessionStream
    • RoomDevice
    • RoomScreenShare
  • Chat
    • Overview
    • Client
    • ChatMember
    • ChatMemberEntity
    • ChatMessage
    • ChatMessageEntity
  • PubSub
    • Overview
    • Client
    • PubSubMessage
  • WebRTC
    • Overview
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Properties
  • Methods
  • stop
Video

RoomSessionStream

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

RoomDevice

Next
Built with

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
number

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

endedAt
Date

End time, if available.

id
stringRequired

The unique id of this stream.

roomSessionId
stringRequired

The id of the room session associated to this stream.

startedAt
DateRequired

Start time, if available.

state
"streaming" | "completed"Required

Current state of the stream.

url
stringRequired

The RTMP URL of the stream.

Methods

stop

  • stop(): Promise<void>

Stops the stream.

Returns

Promise<void>

Example

1await stream.stop();