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
  • getMembers
VideoRoomSessionMethods

getMembers

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

getMeta

Next
Built with

getMembers

  • getMembers(): Promise<{ members: VideoMemberEntity[] }>

Returns a list of members currently in the room.

Returns

Promise<{ members: VideoMemberEntity[] }>

Example

1await roomSession.getMembers()
2// returns:
3{
4"members": [
5 {
6 "visible": true,
7 "room_session_id": "fde15619-13c1-4cb5-899d-96afaca2c52a",
8 "input_volume": 0,
9 "id": "1bf4d4fb-a3e4-4d46-80a8-3ebfdceb2a60",
10 "input_sensitivity": 50,
11 "output_volume": 0,
12 "audio_muted": false,
13 "name": "Mark",
14 "deaf": false,
15 "video_muted": false,
16 "room_id": "aae25822-892c-4832-b0b3-34aac3a0e8d1",
17 "type": "member"
18 },
19 {
20 "visible": true,
21 "room_session_id": "fde15619-13c1-4cb5-899d-96afaca2c52a",
22 "input_volume": 0,
23 "id": "e0c5be44-d6c7-438f-8cda-f859a1a0b1e7",
24 "input_sensitivity": 50,
25 "output_volume": 0,
26 "audio_muted": false,
27 "name": "David",
28 "deaf": false,
29 "video_muted": false,
30 "room_id": "aae25822-892c-4832-b0b3-34aac3a0e8d1",
31 "type": "member"
32 }
33]
34}