> For the complete documentation index, see [llms.txt](https://docs.whereby.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.whereby.com/reference/core-sdk-reference/api-reference/roomconnectionclient.md). # RoomConnectionClient ```jsx const roomConnection = client.getRoomConnection() ``` RoomConnectionClient manages entire room connection. It exposes state subscriptions and provides actions to manage and observe remoteParticipants and in room actions. Room connection s retrieved from the WherebyClient. ## Utilities | Method | Returns | Description | | ---------- | --------------------- | ------------------------------------------ | | `getState` | `RoomConnectionState` | Returns the entire room connection state | | `destroy` | `void` | Destroy the RoomConnectionClient instance. | ## State Subscriptions All subscribe methods follow this format: * Call signature: `subscribeX(callback: (payload: T) => void: () => void` * Contract: Invokes a callback on initial subscription and whenever the state changes. * Returns: an unsubscribe function ### Methods

Method	Payload Type	Description
`subscribeToChatMessages`	`ChatMessage[]`	Emits chat messages from remote participants
`subscribeToCloudRecording`	`CloudRecordingState` `\| undefined`	Emits cloud recording status
`subscribeToBreakoutConfig`	`BreakoutState`	Emits breakout config
`subscribeToConnectionStatus`	`ConnectionStatus`	Emits the connection status
`subscribeToLiveStream`	`{ status: "streaming" } \| undefined`	Emits streaming status
`subscribeToLiveCaptions`	`LiveCaptionsState` `\| undefined`	Emits live captions status
`subscribeToLiveTranscription`	`LiveTranscriptionState` `\| undefined`	Emits live transcription status
`subscribeToLocalScreenshareStatus`	`LocalScreenshareStatus` `\| undefined`	Emits local screenshare status
`subscribeToLocalParticipant`	`LocalParticipantState`	Emits local participant state
`subscribeToRemoteParticipants`	`RemoteParticipantState[]`	Emits the remote participant state
`subscribeToScreenshares`	`ScreenshareState[]`	Emits screenshare state
`subscribeToWaitingParticipants`	`WaitingParticipantState[]`	Emits waiting participants
`subscribeToSpotlightedParticipants`	`ClientView[]`	Emits spotlighted participants

## Actions

Method	Parameters	Returns	Description
`joinRoom`		`Promise<RoomJoinedSuccess>`	Join the room specified in WherebyClientOptions
`knock`		`void`	Let the room host know that the local participant is waiting and wants to join
`cancelKnock`		`void`	Cancel the knock request
`setDisplayName`	`(displayName: string)`	`void`	Change your display name
`sendChatMessage`	`(text: string, parentId?: string)`	`void`	Send a chat message to the room. If `parentId` is provided and matches the `id` of a previously received chat message then the chat message will be sent as a reply to the original chat message.
`removeChatMessage`	`(id: string, sig?: string \| null)`	`void`	Mark a chat message with `removed: true` in the rooms state's `chatMessages`. To remove a chat message, a `sig` provided in a previously sent ChatMessage must be included. Hosts can remove any chat message without needing to send any `sig.`
`toggleCamera`	`(enabled?: boolean)`	`void`	Change the state of your camera
`toggleMicrophone`	`(enabled?: boolean)`	`void`	Change the state of your microphone
`toggleHdMode`	`(enabled?: boolean)`	`void`	Enables / disables high-definition (hd) video mode. Default: `true`
`toggleLowDataMode`	`(enabled?: boolean)`	`void`	Change the state of low data mode
`toggleWidescreenMode`	`(enabled?: boolean)`	`void`	Enables / disables widescreen video mode. Default: `true`
`toggleRaiseHand`	`(enabled?: boolean)`	`void`	Toggle raising and lowering your hand in the meeting. Any host in the meeting can acknowledge your request with the `askToSpeak` host action.
`startScreenshare`		`void`	Start screen share
`stopScreenshare`		`void`	Stop screen share
`leaveRoom`		`void`	Leave the room
`joinBreakoutGroup`	`(group: string)`	`void`	Join a breakout group.
`joinBreakoutMainRoom`		`void`	Join the main room in a breakout session.
`switchCameraEffect`	`(effectId: string)`	`void`	Enable a camera effect.
`clearCameraEffect`		`void`	Disable a camera effect.
`enableAudioDenoiser`		`void`	Enable noise suppression on the local microphone stream. Automatically re-applied if the microphone device is later switched. Use `isAudioDenoiserSupported()` to check browser support first.
`disableAudioDenoiser`		`void`	Disable noise suppression on the local microphone stream.
`startLiveCaptions`		`void`	Start live captions for local participant only (if enabled for room)
`stopLiveCaptions`		`void`	Stop live captions for local participant only (if enabled for room)

## Host-only actions When a participant provides a valid "host" `roomKey` in the [`RoomConnectionOptions`](https://docs.whereby.com/reference/react-hooks-reference/types#roomconnectionoptions-less-than-object-greater-than) when the RoomConnectionClient is initialized, they will have access to a number of addition host-only actions in rooms: | Method | Parameters | Returns | Description | | --------------------------- | --------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `lockRoom` | `(locked: boolean)` | `void` | Lock (`true`) or unlock (`false`) the current room | | `acceptWaitingParticipant` | `(participantId: string) => void` | `void` | Accept waiting participant | | `rejectWaitingParticipant` | `(participantId: string) => void` | `void` | Reject waiting participant | | `askToSpeak` | `(participantId: string)` | `void` |

Ask the specified remote participant to unmute their microphone and speak in the meeting.

This is typically useful in response to a toggleRaiseHand request from a participant in the meeting.

Put a spotlight on a participant.

When used in combination with the video grid, the spotlighted participant will move to the presentation stage, and their video cell will be bigger.

End the meeting for all remote participants.

If stayBehind is not provided or is not true, then the local participant will also leave the room

| ## Events `RoomConnectionClient` extends `EventEmitter` . You can listen to lifecycle and state change events directly: ```jsx import { REMOTE_PARTICIPANTS_CHANGED } from "@whereby.com/core"; const roomConnection = client.getRoomConnection(); function logChatMessage(message: ChatMessage) { console.log("New chat message received", message); } roomConnection.on(REMOTE_PARTICIPANTS_CHANGED, logChatMessage); ``` #### RoomConnectionEvents

Event (constant)	Event name (string)	Payload	Emitted when
`BREAKOUT_CONFIG_CHANGED`	`breakout:config-changed`	`config:BreakoutState`	Breakout config changes
`CHAT_NEW_MESSAGE`	`chat:new-message`	`messages:` `ChatMessage[]`	A new chat message is received
`CLOUD_RECORDING_STATUS_CHANGED`	`cloud-recording:status-changed`	`{ status: "requested" \| "recording" \| "error" }, startedAt?: string, error?: string } \| undefined`	Cloud recording is started or stopped
`CONNECTION_STATUS_CHANGED`	`connection:status-changed`	`status:` `ConnectionStatus`	There's a change to connection status
`LOCAL_PARTICIPANT_CHANGED`	`local-participant:changed`	`participant?:` `LocalParticipantState`	There's a change to the local participant state
`LOCAL_SCREENSHARE_STATUS_CHANGED`	`local-screenshare:status-changed`	`status?:` `LocalScreenshareStatus`	Local screenshare is started or stopped
`LIVE_TRANSCRIPTION_STATUS_CHANGED`	`live-transcription:status-changed`	`status:` `LiveTranscriptionState`	Live transcription is started or stopped
`LIVE_CAPTIONS_STATUS_CHANGED`	`live-captions:status-changed`	`status:` `LiveCaptionsState`	Live captions is started or stopped for local participant
`REMOTE_PARTICIPANTS_CHANGED`	`remote-participants:changed`	`participants:` `RemoteParticipantState[]`	There's a change to the remote participant state
`SCREENSHARE_STARTED`	`screenshare:started`	`screenshares:` `ScreenshareState[]`	Remote screenshare is started or stopped
`ROOM_JOINED`	`room:joined`	`room:` `RoomJoinedEvent`	A client joins the room
`ROOM_JOINED_ERROR`	`room:joined:error`	`error: RoomJoinedErrors \| string`	A client leaves the room
`WAITING_PARTICIPANT_JOINED`	`waiting-participant:joined`	`participant:` `WaitingParticipantState`	A client joins the waiting room
`WAITING_PARTICIPANT_LEFT`	`waiting-participant:left`	`participantId: string`	A client leaves the waiting room
`SPOTLIGHT_PARTICIPANT_ADDED`	`spotlight:participant-added`	`particpant:` `ClientView`	A client is spotlighted
`SPOTLIGHT_PARTICIPANT_REMOVED`	`spotlight:participant-removed`	`participantId: string`	A client is removed from the spotlight
`STREAMING_STARTED`	`streaming:started`	`streaming:` `LiveStreamState`	Streaming is started
`STREAMING_STOPPED`	`streaming:stopped`	`void`	Streaming is stopped

[^1]: `Only needed when the roomConnectionStatus is room_locked` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.whereby.com/reference/core-sdk-reference/api-reference/roomconnectionclient.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.