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
  • setMirrored
Video

LocalOverlay

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

RoomSession

Next
Built with

Represents the local overlay, which displays the user’s local camera feed.

Properties

mirrored
booleanRequired

Whether the local video overlay is mirrored.

Methods

setMirrored

▸ setMirrored(): void

Mirror the local video overlay when true. The mirrored stream is sent to the SignalWire server and is visible to all participants.

Parameters

mirror
booleanRequired

Whether to mirror the local video overlay.

Returns

void

Example

1await roomSession.localOverlay.setMirrored(true);