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
  • pause
  • resume
  • stop
Video

RoomSessionRecording

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

RoomSessionScreenShare

Next
Built with

Represents a specific recording of a room session.

Properties

duration
number

Duration, if available.

endedAt
Date

End time, if available.

id
stringRequired

The unique id of this recording.

roomSessionId
stringRequired

The id of the room session associated to this recording.

startedAt
Date

Start time, if available.

state
"recording" | "paused" | "completed"Required

Current state.

Methods

pause

▸ pause(): Promise<void>

Pauses the recording.

Returns

Promise<void>

resume

▸ resume(): Promise<void>

Resumes the recording.

Returns

Promise<void>

stop

▸ stop(): Promise<void>

Stops the recording.

Returns

Promise<void>