Class RoomConsumer

A React component that subscribes to context changes and stays updated with the room instance, participants, and streams.
It requires a function as child, which receives the current context value and returns a React node.

Example

<RoomConsumer
  {...{
    onParticipantJoined: (participant) => {
      setParticipant(participant);
    },
    //All Event Callbacks can be specified here
  }}
>
  {({}) => {
    return <RoomView />;
  }}
</RoomConsumer>

Constructors

constructor

new RoomConsumer(): RoomConsumer

Returns RoomConsumer

Events

onCodecChanged

onCodecChanged(
    data: {
        causedBy?: Participant;
        currentCodec: string;
        kind: string;
        previousCodec: string;
        unsupportedRemoteCodec: string;
    },
): void
- Triggered when the room's active media codec changes because a newly joined participant does not support the current codec.
- The room automatically negotiates and switches to a mutually compatible codec to maintain connectivity for all participants.
Parameters
- data: {
      causedBy?: Participant;
      currentCodec: string;
      kind: string;
      previousCodec: string;
      unsupportedRemoteCodec: string;
  }
  - OptionalcausedBy?: Participant
    
    The Participant instance of the participant whose joining triggered the codec change.
  - currentCodec: string
    
    The new codec that the room switched to after the change.
  - kind: string
    
    The media type for which the codec changed.
  - previousCodec: string
    
    The codec that was in use before the change.
  - unsupportedRemoteCodec: string
    
    The codec that the newly joined participant did not support, which triggered the switch.
Returns void
- Defined in index.d.ts:823

onDataReceived

onDataReceived(
    data: {
        data: Uint8Array<ArrayBufferLike>;
        isBinary: boolean;
        reliable: boolean;
        senderId: string;
        text: string;
        timestamp: number;
    },
): void
- Triggered whenever a message is received over the DataStream.
Parameters
- data: {
      data: Uint8Array<ArrayBufferLike>;
      isBinary: boolean;
      reliable: boolean;
      senderId: string;
      text: string;
      timestamp: number;
  }
  - data: Uint8Array<ArrayBufferLike>
  - isBinary: boolean
  - reliable: boolean
    
    Whether the frame was sent on the reliable channel.
  - senderId: string
  - text: string
  - timestamp: number
    
    Timestamp (in milliseconds since epoch) when the message was sent.
Returns void
- Defined in index.d.ts:483

onEntryRequested

onEntryRequested(
    option: {
        allow: () => void;
        deny: () => void;
        name: string;
        participantId: string;
    },
): void
- Triggered when a participant requests to join the room and their token includes the ask_join permission.
- This event is emitted only to participants whose token includes the allow_join permission.
Parameters
- option: { allow: () => void; deny: () => void; name: string; participantId: string }
  - allow: () => void
    
    Call this function to allow the participant to join the room.
  - deny: () => void
    
    Call this function to deny the participant’s request.
  - name: string
    
    Display name of the participant requesting to join.
  - participantId: string
    
    Unique ID of the participant requesting to join the room.
Returns void
- Defined in index.d.ts:393

onEntryResponded

onEntryResponded(participantId: string, decision: string): void
- Triggered when a participant’s join() request is responded to with an allow or deny decision.
This event is emitted to:
- All participants whose token includes the allow_join permission.
- The participant who requested to join the room.
Parameters
- participantId: string
  ID of the participant who requested to join the room.
- decision: string
  The final decision for the join request.
  
  Possible values:
  
  "allowed" – The participant was allowed to join.
  
  "denied" – The participant was denied entry.
Returns void
- Defined in index.d.ts:421

onError

onError(option: { code: number; message: string }): void
- Triggered when an error occurs during the room lifecycle.
- The event provides an error code and a descriptive message. Refer to VideoSDKError for a complete list of supported error codes.
Parameters
- option: { code: number; message: string }
  - code: number
    
    Numeric error code representing the type of error.
  - message: string
    
    Human-readable description of the error.
Returns void
- Defined in index.d.ts:580

onHlsStateChanged

onHlsStateChanged(
    option: {
        livestreamUrl: string;
        playbackHlsUrl: string;
        status:
            | "HLS_STARTING"
            | "HLS_STARTED"
            | "HLS_PLAYABLE"
            | "HLS_STOPPING"
            | "HLS_STOPPED";
    },
): void
- Triggered when the HLS (HTTP Live Streaming) state changes.
Parameters
- option: {
      livestreamUrl: string;
      playbackHlsUrl: string;
      status:
          | "HLS_STARTING"
          | "HLS_STARTED"
          | "HLS_PLAYABLE"
          | "HLS_STOPPING"
          | "HLS_STOPPED";
  }
  - livestreamUrl: string
    
    Live HLS without playback support
  - playbackHlsUrl: string
    
    Live HLS with playback support
  - status: "HLS_STARTING" | "HLS_STARTED" | "HLS_PLAYABLE" | "HLS_STOPPING" | "HLS_STOPPED"
    
    Possible values:
    
    HLS_STARTING - Hls is in starting phase and hasn't started yet.
    
    HLS_STARTED- Hls has started successfully will return playbackHlsUrl and livestreamUrl.
    
    HLS_PLAYABLE - Hls has started and the playbackHlsUrl and livestreamUrl is now playable.
    
    HLS_STOPPING - Hls is in stopping phase and hasn't stopped yet.
    
    HLS_STOPPED- Hls has stopped successfully.
Returns void
- Defined in index.d.ts:604

onLivestreamStateChanged

onLivestreamStateChanged(
    option: {
        state:
            | "LIVESTREAM_STARTING"
            | "LIVESTREAM_STARTED"
            | "LIVESTREAM_STOPPING"
            | "LIVESTREAM_STOPPED";
    },
): void
- Triggered when the room’s livestream state changes.
Parameters
- option: {
      state:
          | "LIVESTREAM_STARTING"
          | "LIVESTREAM_STARTED"
          | "LIVESTREAM_STOPPING"
          | "LIVESTREAM_STOPPED";
  }
  - state:
        | "LIVESTREAM_STARTING"
        | "LIVESTREAM_STARTED"
        | "LIVESTREAM_STOPPING"
        | "LIVESTREAM_STOPPED"
    
    Possible values:
    
    LIVESTREAM_STARTING - Livestream is in starting phase and hasn't started yet.
    
    LIVESTREAM_STARTED - Livestream has started successfully.
    
    LIVESTREAM_STOPPING - Livestream is in stopping phase and hasn't stopped yet.
    
    LIVESTREAM_STOPPED - Livestream has stopped successfully.
Returns void
- Defined in index.d.ts:654

onMediaRelayError

onMediaRelayError(option: { error: string; roomId: string }): void
- Triggered when an error occurs during media relay.
Parameters
- option: { error: string; roomId: string }
  - error: string
    
    Description of the error.
  - roomId: string
    
    ID of the room where the error occurred.
Returns void
- Defined in index.d.ts:720

onMediaRelayRequestReceived

onMediaRelayRequestReceived(
    option: {
        accept: () => void;
        displayName: string;
        participantId: string;
        reject: () => void;
        roomId: string;
    },
): void
- Triggered when a media relay request is received in the destination room.
Parameters
- option: {
      accept: () => void;
      displayName: string;
      participantId: string;
      reject: () => void;
      roomId: string;
  }
  - accept: () => void
    
    Call this function to accept the media relay request.
  - displayName: string
    
    Display name of the participant requesting the media relay.
  - participantId: string
    
    ID of the participant who initiated the media relay request.
  - reject: () => void
    
    Call this function to reject the media relay request.
  - roomId: string
    
    ID of the room from which the media relay request originated.
Returns void
- Defined in index.d.ts:766

onMediaRelayRequestResponse

onMediaRelayRequestResponse(
    option: {
        decidedBy: string;
        decision: "ACCEPTED" | "REJECTED";
        participantId: string;
    },
): void
- Triggered when a response is received for a media relay request in the source room.
Parameters
- option: { decidedBy: string; decision: "ACCEPTED" | "REJECTED"; participantId: string }
  - decidedBy: string
    
    ID of the participant who decided the decision.
  - decision: "ACCEPTED" | "REJECTED"
    
    Decision taken for the request.
  - participantId: string
    
    ID of the participant who responded to the media relay request.
Returns void
- Defined in index.d.ts:737

onMediaRelayStarted

onMediaRelayStarted(option: { roomId: string }): void
- Triggered when media relay successfully starts for a destination room.
Parameters
- option: { roomId: string }
  - roomId: string
    
    ID of the room where the media relay has started.
Returns void
- Defined in index.d.ts:691

onMediaRelayStopped

onMediaRelayStopped(option: { reason: string; roomId: string }): void
- Triggered when media relay stops for a destination room.
Parameters
- option: { reason: string; roomId: string }
  - reason: string
    
    Reason why the media relay stopped.
  - roomId: string
    
    ID of the room where the media relay stopped.
Returns void
- Defined in index.d.ts:707

onMicRequested

onMicRequested(
    option: {
        accept: () => void;
        participantId: string;
        reject: () => void;
    },
): void
- This event will be emitted to the participant B when any other participant A requests to enable mic of participant B.
- On accepting the request, mic of participant B will be enabled.
Parameters
- option: { accept: () => void; participantId: string; reject: () => void }
  - accept: () => void
    
    Call this function to accept the request and enable your microphone.
  - participantId: string
    
    ID of the participant who requested to enable your microphone.
  - reject: () => void
    
    Call this function to reject the request.
Returns void
- Defined in index.d.ts:535

onParticipantJoined

onParticipantJoined(participant: Participant): void
- Triggered when a new participant joins the room.
Parameters
- participant: Participant
  The Participant instance representing the newly joined participant.
Returns void
- Defined in index.d.ts:246

onParticipantLeft

onParticipantLeft(
participant: Participant,
reason: { code: number; message: string },
): void

Triggered when a participant leaves the room.
When this event is emitted, a reason object is provided that describes why the participant left.

Possible reason codes:

Reason	Code	Description
WEBSOCKET_DISCONNECTED	1001	Socket disconnected
REMOVE_PEER	1002	Participant was removed from the room
REMOVE_PEER_VIEWER_MODE_CHANGED	1003	Participant removed because viewer mode was changed
REMOVE_PEER_MEDIA_RELAY_STOP	1004	Participant removed because media relay was stopped
SWITCH_ROOM	1005	Participant switched to a different room
ROOM_CLOSE	1006	The room has been closed
UNKNOWN	1007	Participant disconnected due to an unknown reason
REMOVE_ALL	1008	Remove All from the room
MEETING_END_API	1009	Room Ended.
REMOVE_PEER_API	1010	Participant removed from the room
DUPLICATE_PARTICIPANT	1011	Leaving room, since this participantId joined from another device.
MANUAL_LEAVE_CALLED	1101	Participant manually called the leave() method to exit the room
WEBSOCKET_CONNECTION_ATTEMPTS_EXHAUSTED	1102	Room left after multiple failed websocket connection attempts.
JOIN_ROOM_FAILED	1103	Room left due to an error while joining the room.
SWITCH_ROOM_FAILED	1104	Room left due to an error while switching rooms.

Parameters

participant: Participant
The Participant instance who left the room.
reason: { code: number; message: string }
An object describing the reason and corresponding code.

Returns void

onParticipantModeChanged

onParticipantModeChanged(
    options: {
        mode: "SEND_AND_RECV" | "SIGNALLING_ONLY" | "RECV_ONLY";
        participantId: string;
    },
): void
- Triggered when a participant’s mode changes.
Parameters
- options: {
  mode: "SEND_AND_RECV" | "SIGNALLING_ONLY" | "RECV_ONLY";
  participantId: string;
  }
  - mode: "SEND_AND_RECV" | "SIGNALLING_ONLY" | "RECV_ONLY"
    
    The new mode of the participant. Possible values are defined in Mode.
  - participantId: string
    
    ID of the participant whose mode has changed.
Returns void
- Defined in index.d.ts:297

onPausedAllStreams

onPausedAllStreams(option: { kind: "audio" | "video" | "share" | "all" }): void
- Triggered when all or specific media streams are paused.
Parameters
- option: { kind: "audio" | "video" | "share" | "all" }
  - kind: "audio" | "video" | "share" | "all"
    
    Indicates which media type was paused:
    
    "audio" – Audio streams
    
    "video" – Video streams
    
    "share" – Screen-share video streams
Returns void
- Defined in index.d.ts:438

onPinStateChanged

onPinStateChanged(
    option: {
        peerId: string;
        pinnedBy: string;
        state: { cam: boolean; share: boolean };
    },
): void
- Triggered when the pin state of a participant changes.
- This event is emitted for all participants whenever a participant is pinned or unpinned.
Parameters
- option: { peerId: string; pinnedBy: string; state: { cam: boolean; share: boolean } }
  - peerId: string
    
    ID of the participant whose pin state changed.
  - pinnedBy: string
    
    ID of the participant who performed the pin or unpin action.
  - state: { cam: boolean; share: boolean }
    
    Current pin state (true if pinned, false if unpinned).
Returns void
- Defined in index.d.ts:559

onPresenterChanged

onPresenterChanged(presenterId: string): void
- Triggered when a participant starts or stops screen sharing.
- If screen sharing stops, the callback receives null.
Parameters
- presenterId: string
  ID of the participant currently presenting, or null if no one is presenting.
Returns void
- Defined in index.d.ts:361

onQualityLimitation

onQualityLimitation(
    option: {
        state: "detected" | "resolved";
        timestamp: number;
        type: "congestion" | "bandwidth" | "cpu";
    },
): void
- This callback is triggered when a quality limitation is detected or resolved during the room.
- Triggered when a quality limitation is detected or resolved during the room.
Parameters
- option: {
      state: "detected" | "resolved";
      timestamp: number;
      type: "congestion" | "bandwidth" | "cpu";
  }
  - state: "detected" | "resolved"
    
    Indicates whether the limitation is currently active or resolved.
  - timestamp: number
    
    Time (in milliseconds since epoch) when the event occurred.
  - type: "congestion" | "bandwidth" | "cpu"
    
    Specifies the type of limitation.
Returns void
- Defined in index.d.ts:792

onRecordingStateChanged

onRecordingStateChanged(
    option: {
        state:
            | "RECORDING_STARTING"
            | "RECORDING_STARTED"
            | "RECORDING_STOPPING"
            | "RECORDING_STOPPED";
    },
): void
- Triggered when the room’s recording state changes.
Parameters
- option: {
      state:
          | "RECORDING_STARTING"
          | "RECORDING_STARTED"
          | "RECORDING_STOPPING"
          | "RECORDING_STOPPED";
  }
  - state:
        | "RECORDING_STARTING"
        | "RECORDING_STARTED"
        | "RECORDING_STOPPING"
        | "RECORDING_STOPPED"
    
    The current recording state:
    
    RECORDING_STARTING - Recording is in starting phase and hasn't started yet.
    
    RECORDING_STARTED - Recording has started successfully.
    
    RECORDING_STOPPING - Recording is in stopping phase and hasn't stopped yet.
    
    RECORDING_STOPPED - Recording has stopped successfully.
Returns void
- Defined in index.d.ts:631

onResumedAllStreams

onResumedAllStreams(option: { kind: "audio" | "video" | "share" | "all" }): void
- Triggered when paused media streams are resumed.
Parameters
- option: { kind: "audio" | "video" | "share" | "all" }
  - kind: "audio" | "video" | "share" | "all"
    
    Indicates which media type was resumed:
    
    "audio" – Audio streams
    
    "video" – Video streams
    
    "share" – Screen-share video streams
Returns void
- Defined in index.d.ts:457

onRoomJoined

onRoomJoined(): void
- Triggered when the local participant successfully joins the room.
Returns void
- Defined in index.d.ts:307

onRoomLeft

onRoomLeft(reason: { code: number; message: string }): void

Triggered when the local participant leaves the room.
When this event is emitted, a reason object is also provided that explains why the participant left the room.

The table below lists the possible reason codes:

Reason	Code	Description
WEBSOCKET_DISCONNECTED	1001	Socket disconnected
REMOVE_PEER	1002	Participant was removed from the room
REMOVE_PEER_VIEWER_MODE_CHANGED	1003	Participant removed due to viewer mode change
REMOVE_PEER_MEDIA_RELAY_STOP	1004	Participant removed because media relay was stopped
SWITCH_ROOM	1005	Participant switched to another room
ROOM_CLOSE	1006	The room was closed
UNKNOWN	1007	Participant disconnected due to an unknown reason
REMOVE_ALL	1008	All participants were removed
MEETING_END_API	1009	Room ended programmatically
REMOVE_PEER_API	1010	Participant removed via API
DUPLICATE_PARTICIPANT	1011	Participant joined from another device
MANUAL_LEAVE_CALLED	1101	Participant manually left the room
WEBSOCKET_CONNECTION_ATTEMPTS_EXHAUSTED	1102	WebSocket connection retries exhausted
JOIN_ROOM_FAILED	1103	Failed to join the room
SWITCH_ROOM_FAILED	1104	Failed to switch rooms

Parameters

reason: { code: number; message: string }
Object containing the reason and corresponding code.

Returns void

onRoomStateChanged

onRoomStateChanged(option: { roomState: string }): void
- Triggered whenever the room state changes.
Parameters
- option: { roomState: string }
  - roomState: string
    
    The current room state. Possible values:
    
    CONNECTING
    
    CONNECTED
    
    RECONNECTING
    
    DISCONNECTED
    
    FAILED
Returns void
- Defined in index.d.ts:678

onSpeakerChanged

onSpeakerChanged(activeSpeakerId: string): void
- Triggered when the active speaker changes.
- If no participant is actively speaking, null is returned.
Parameters
- activeSpeakerId: string
  ID of the currently active speaker, or null if no one is speaking.
Returns void
- Defined in index.d.ts:349

onWebcamRequested

onWebcamRequested(
    option: {
        accept: () => void;
        participantId: string;
        reject: () => void;
    },
): void
- This event will be emitted to the participant B when any other participant A requests to enable webcam of participant B.
- On accepting the request, webcam of participant B will be enabled.
Parameters
- option: { accept: () => void; participantId: string; reject: () => void }
  - accept: () => void
    
    Call this function to accept the request and enable your webcam.
  - participantId: string
    
    ID of the participant who requested to enable your webcam.
  - reject: () => void
    
    Call this function to reject the request.
Returns void
- Defined in index.d.ts:510

Class RoomConsumer

Example

Index

Constructors

Events

Constructors

constructor

Returns RoomConsumer

Events

onCodecChanged

Parameters

OptionalcausedBy?: Participant

currentCodec: string

kind: string

previousCodec: string

unsupportedRemoteCodec: string

Returns void

onDataReceived

Parameters

data: Uint8Array<ArrayBufferLike>

isBinary: boolean

reliable: boolean

senderId: string

text: string

timestamp: number

Returns void

onEntryRequested

Parameters

allow: () => void

deny: () => void

name: string

participantId: string

Returns void

onEntryResponded

Parameters

Returns void

onError

Parameters

code: number

message: string

Returns void

onHlsStateChanged

Parameters

livestreamUrl: string

playbackHlsUrl: string

status: "HLS_STARTING" | "HLS_STARTED" | "HLS_PLAYABLE" | "HLS_STOPPING" | "HLS_STOPPED"

Returns void

onLivestreamStateChanged

Parameters

state: | "LIVESTREAM_STARTING" | "LIVESTREAM_STARTED" | "LIVESTREAM_STOPPING" | "LIVESTREAM_STOPPED"

Returns void

onMediaRelayError

Parameters

error: string

roomId: string

Returns void

onMediaRelayRequestReceived

Parameters

accept: () => void

displayName: string

participantId: string

reject: () => void

roomId: string

Returns void

onMediaRelayRequestResponse

Parameters

decidedBy: string

decision: "ACCEPTED" | "REJECTED"

participantId: string

Returns void

onMediaRelayStarted

Parameters

roomId: string

Returns void

onMediaRelayStopped

Parameters

reason: string

roomId: string

Returns void

onMicRequested

`Optional`causedBy?: Participant

state:
| "LIVESTREAM_STARTING"
| "LIVESTREAM_STARTED"
| "LIVESTREAM_STOPPING"
| "LIVESTREAM_STOPPED"

state:
| "RECORDING_STARTING"
| "RECORDING_STARTED"
| "RECORDING_STOPPING"
| "RECORDING_STOPPED"