Video SDK Room Class - iOS

Introduction

The Room class includes properties, methods and events for managing a room, participants, video, audio and share streams, and messaging.

Create a Room with VideoSDK.createRoom(). Most Room methods are async throws: call them with try await and catch VideoSDKError. See Room Class Methods.

Room Properties

• id

• localParticipant

• participants

• pubSub

• realtimeStore

• LeaveReason Enum

• roomState

• roomMode

• isMicEnabled

• isCamEnabled

• hlsUrls

• hlsState

• liveStreamState

• recordingState

• transcriptionState

• translationState

• pinnedParticipants

• isScreenSharing

• e2eeEnabled

Room Methods

• join

• leave

• end

• enableCam

• disableCam

• changeCam

• unmuteMic

• muteMic

• startRecording

• stopRecording

• startLivestream

• stopLivestream

• startHLS

• stopHLS

• startTranscription

• stopTranscription

• startTranslation

• stopTranslation

• changeTranslationLanguage

• changeMode

• enableScreenShare

• disableScreenShare

• changeMic

• setAudioDevice

• setAudioDeviceChangeListener

• send

• uploadBase64File

• fetchBase64File

• setVideoProcessor

• removeVideoProcessor

• startWhiteboard

• stopWhiteboard

• pauseAllStreams

• resumeAllStreams

• enableAdaptiveSubscription

• disableAdaptiveSubscription

• setWebcamQuality

• getAppliedVideoConfig

• getActivePresenterId

• getActiveSpeakerId

• requestMediaRelay

• stopMediaRelay

• switchTo

• respondEntry

• addEventListener

• removeEventListener

• removeAllEventListeners

Room Events

• onRoomJoined

• onRoomLeft

• onParticipantJoined

• onParticipantLeft

• onSpeakerChanged

• onMicRequested

• onWebcamRequested

• onRecordingStateChanged

• onRecordingStarted

• onRecordingStopped

• onLivestreamStateChanged

• onLivestreamStarted

• onLivestreamStopped

• onHlsStateChanged

• onTranscriptionStateChanged

• onTranscriptionText

• onTranslationStateChanged

• onTranslationText

• onTranslationLanguageChanged

• onRoomStateChanged

• onError

• onPinStateChanged

• onParticipantModeChanged

• onWhiteboardStarted

• onWhiteboardStopped

• onPausedAllStreams

• onResumedAllStreams

• onEntryRequested

• onEntryResponded

• onPresenterChanged

• onCodecChanged

• onExternalCallRinging

• onExternalCallAnswered

• onExternalCallRejected

• onExternalCallHangup

• onMediaRelayRequestReceived

• onMediaRelayRequestResponse

• onMediaRelayStarted

• onMediaRelayStopped

• onMediaRelayError

• onQualityLimitation

• onDataReceived