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
      • Events
        • addCamera
        • addDevice
        • addMicrophone
        • audioMute
        • audioUnmute
        • createScreenShareObject
        • deaf
        • deleteMemberMeta
        • deleteMeta
        • demote
        • destroy
        • getLayouts
        • getMemberMeta
        • getMembers
        • getMeta
        • getPlaybacks
        • getRecordings
        • getStreams
        • hangupAll
        • hideVideoMuted
        • join
        • leave
        • lock
        • off
        • on
        • once
        • play
        • promote
        • removeAllListeners
        • removeAllMembers
        • removeMember
        • sendDigits
        • setHideVideoMuted
        • setInputSensitivity
        • setInputVolume
        • setLayout
        • setLocalStream
        • setMemberMeta
        • setMemberPosition
        • setMeta
        • setOutputVolume
        • setPositions
        • setPrioritizeHandraise
        • setRaisedHand
        • showVideoMuted
        • startRecording
        • startScreenShare
        • startStream
        • undeaf
        • unlock
        • updateCamera
        • updateMemberMeta
        • updateMeta
        • updateMicrophone
        • updateSpeaker
        • videoMute
        • videoUnmute
    • 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
  • undeaf
VideoRoomSessionMethods

undeaf

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

unlock

Next
Built with

undeaf

  • undeaf(params?): Promise<void>

Unmutes the incoming audio. The affected participant will start hearing audio from the other participants again. You can use this method to undeaf either yourself or another participant in the room.

Note that in addition to allowing a participants to hear the others, this will also automatically unmute the microphone of the target participant (even if there is no audio_unmute permission). If you want, you can then manually mute it by calling audioMute.

Parameters

params
object

Object containing the parameters of the method.

memberId
string

Id of the member to affect. If omitted, affects the default device in the local client.

Returns

Promise<void>

Permissions

  • room.self.deaf: to make yourself deaf.
  • room.member.deaf: to make deaf a remote member.

You need to specify the permissions when creating the Video Room Token on the server side.

Examples

Undeaf yourself:

1await roomSession.undeaf();

Undeaf another participant:

1const id = "de550c0c-3fac-4efd-b06f-b5b8614b8966"; // you can get this from getMembers()
2await roomSession.undeaf({ memberId: id });