enableCam

Enables the local participant's webcam and publishes it to the room.

Without a customCameraTrack, the camera opens with the settings this room already holds: those of the last custom track, plus the lens and device in use, or the default capture profile if the camera has never been opened. Passing a track replaces those settings, and later enableCam() calls reuse them until another track replaces them.

Requires a joined room. Called before the join completes, it does nothing and emits RoomEventListener.onError with code 3035 (ERROR_ACTION_PERFORMED_BEFORE_ROOM_JOINED); while the room is RoomState.RECONNECTING, with code 3065 (ERROR_ROOM_RECONNECTING). A rejected call releases customCameraTrack, so a refused enable never leaves the camera open. An ended track is reported on onError as code 3031 (ERROR_CUSTOM_VIDEO_TRACK_ENDED) and the camera opens with the stored settings instead.

Events:

• ParticipantEventListener.onStreamEnabled — emitted on all participants when the video stream is enabled

• RoomEventListener.onError — emitted when the room is not joined or is reconnecting, or when the camera cannot be opened

Code Example:

lifecycleScope.launch { room.enableCam() }

// or publish a custom camera track
lifecycleScope.launch {
    val track = VideoSDK.createCameraVideoTrack(
        encoderConfig = CustomCameraTrackConfig.H720P_W1280P,
        facingMode = FacingMode.front,
    )
    room.enableCam(track)
}

Parameters

See also

Throws