zn-android-sdk/live.videosdk.rtc.android/Meeting

Meeting

Represents a live meeting session containing participants, streams, and associated states.

This class maintains references to the local participant, remote participants, pinned participants, and streaming/recording/transcription states. It also provides access to PubSub messaging, RealtimeStore, and custom media streams.

Obtain an instance using initMeeting and call join to connect.

Constructors

Meeting

constructor(meetingId: String, localParticipant: Participant)

Types

PubSub

inner class PubSub

Provides publish-subscribe messaging within the meeting.

RealtimeStore

inner class RealtimeStore

Provides a shared key-value store for real-time data synchronization across participants.

Properties

localParticipant

val localParticipant: Participant

The local participant (current user) in this meeting.

meetingId

val meetingId: String

The unique identifier of this meeting session.

participants

val participants: Map<String, Participant>

A map of all remote participants keyed by participant ID.

pubSub

var pubSub: Meeting.PubSub

Provides access to the PubSub (publish-subscribe) messaging system.

realtimeStore

var realtimeStore: Meeting.RealtimeStore

Provides access to the RealtimeStore for key-value data sharing.

Functions

addEventListener

fun addEventListener(listener: MeetingEventListener)

This method can be used to register a MeetingEventListener to receive meeting-related event callbacks.

changeMic

fun changeMic(device: AppRTCAudioManager.AudioDevice)

fun changeMic(device: AppRTCAudioManager.AudioDevice, customTrack: CustomStreamTrack)

Switches the active audio output routing and optionally replaces the microphone audio track with a custom audio track.

changeMode

fun changeMode(mode: String)

This method can be used to change the meeting mode of the local participant.

changeWebcam

fun changeWebcam(deviceId: String)

This method can be used to switch to a specific camera device by its device ID.

disableAdaptiveSubscriptions

fun disableAdaptiveSubscriptions()

This method can be used to disable the adaptive subscription manager.

disableScreenShare

fun disableScreenShare()

This method can be used to disable screen sharing for the local participant.

disableWebcam

fun disableWebcam()

This method can be used to disable the local participant's webcam.

enableAdaptiveSubscriptions

fun enableAdaptiveSubscriptions()

Enables the adaptive subscription manager on the server, which automatically adjusts the quality of incoming video streams based on network conditions and viewport size.

enableScreenShare

@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)

fun enableScreenShare(data: Intent, enableAudio: Boolean)

fun enableScreenShare(customTrack: CustomStreamTrack, enableAudio: Boolean)

This method can be used to enable screen sharing for the local participant using a custom stream track.

enableWebcam

fun enableWebcam()

This method can be used to enable the local participant's webcam.

fun enableWebcam(customTrack: CustomStreamTrack)

This method can be used to enable the local participant's webcam using a custom video track.

end

fun end()

This method can be used to end the meeting for all participants.

fetchBase64File

fun fetchBase64File(url: String, token: String, listener: TaskCompletionListener<String, String>)

Fetches a file from the given URL and returns its contents as a base64-encoded string.

getMeetingState

fun getMeetingState(): MeetingState

This method can be used to get the current state of the meeting.

getMics

fun getMics(): Set<AppRTCAudioManager.AudioDevice>

This method can be used to get the set of available audio devices (microphones).

isE2eeEnabled

fun isE2eeEnabled(): Boolean

This method can be used to check whether end-to-end encryption (E2EE) is enabled for the current meeting session.

join

fun join()

This method can be used to join the meeting.

leave

fun leave()

This method can be used to leave the meeting.

muteMic

fun muteMic()

This method can be used to mute the local participant's microphone.

pauseAllStreams

fun pauseAllStreams()

This method can be used to pause all incoming streams of all kinds (audio, video, and share).

fun pauseAllStreams(kind: String)

Pauses all incoming (remote) streams of the specified kind across all participants.

removeAllListeners

fun removeAllListeners()

This method can be used to remove all previously registered MeetingEventListener instances.

removeEventListener

fun removeEventListener(listener: MeetingEventListener)

This method can be used to remove a previously registered MeetingEventListener.

requestMediaRelay

fun requestMediaRelay(destinationMeetingId: String, token: String, userKinds: List<String>)

Requests the server to relay the local participant's media streams to a different meeting room.

respondEntry

fun respondEntry(pId: String, decision: String)

This method can be used to respond to a participant's entry request.

resumeAllStreams

fun resumeAllStreams()

This method can be used to resume all incoming streams of all kinds (audio, video, and share).

fun resumeAllStreams(kind: String)

Resumes all incoming (remote) streams of the specified kind that were previously paused.

setAudioDeviceChangeListener

fun setAudioDeviceChangeListener(audioManagerEvents: AppRTCAudioManager.AudioManagerEvents)

This method can be used to register a listener for audio device changes (e.g., when a Bluetooth headset is connected or disconnected).

startHls

fun startHls(config: JSONObject, transcription: PostTranscriptionConfig)

This method can be used to start HLS (HTTP Live Streaming) for the meeting.

startLivestream

fun startLivestream(outputs: List<LivestreamOutput>, config: JSONObject)

This method can be used to start RTMP livestreaming of the meeting to the specified outputs.

startRecording

fun startRecording(webhookUrl: String, awsDirPath: String, config: JSONObject, transcription: PostTranscriptionConfig)

This method can be used to start cloud recording of the meeting.

startTranscription

fun startTranscription(config: TranscriptionConfig)

This method can be used to start real-time transcription of the meeting audio.

startWhiteboard

fun startWhiteboard()

This method can be used to start a whiteboard session in the meeting.

stopHls

fun stopHls()

This method can be used to stop the ongoing HLS streaming.

stopLivestream

fun stopLivestream()

This method can be used to stop the ongoing RTMP livestream.

stopMediaRelay

fun stopMediaRelay(destinationMeetingId: String)

This method can be used to stop an ongoing media relay to the specified meeting.

stopRecording

fun stopRecording()

This method can be used to stop the ongoing cloud recording.

stopTranscription

fun stopTranscription()

This method can be used to stop the ongoing real-time transcription.

stopWhiteboard

fun stopWhiteboard()

This method can be used to stop the ongoing whiteboard session.

switchTo

fun switchTo(meetingId: String)

Switches the local participant from the current meeting to a different meeting room without requiring a full leave/rejoin cycle.

fun switchTo(meetingId: String, token: String)

Switches the local participant from the current meeting to a different meeting room using a specific authentication token.

unmuteMic

fun unmuteMic()

This method can be used to unmute the local participant's microphone.

fun unmuteMic(customTrack: CustomStreamTrack)

This method can be used to unmute the local participant's microphone using a custom audio track.

uploadBase64File

fun uploadBase64File(base64Data: String, token: String, fileName: String, listener: TaskCompletionListener<String, String>)

Uploads a base64-encoded file to the VideoSDK temporary file storage.