This returns the local microphone volume level. The audio volume is a linear value between 0 (no sound) and 1 (maximum volume). This is not a raw output - it is a smoothed-out volume level that gradually goes to the highest measured level and will then gradually over 250ms return back to 0 or next measured value. This value can be used directly in your UI for displaying a volume/speaking indicator for the local participant. Note: Doesn't return any values until the session is established!

microphone

val microphone: MicrophoneManager

screenShare

val screenShare: ScreenShareManager

sessionId

var sessionId: String

speaker

val speaker: SpeakerManager

state

val state: CallState

The call state contains all state such as the participant list, reactions etc

statLatencyHistory

val statLatencyHistory: MutableStateFlow<List<Int>>

Contains stats history.

statsReport

val statsReport: MutableStateFlow<CallStatsReport?>

Contains stats events for observation.

type

val type: String

user

val user: User

videoFilter

var videoFilter: VideoFilter?

Set a custom VideoFilter that will be applied to the video stream coming from your device.

Functions

suspend fun accept(): Result<AcceptCallResponse>

blockUser

suspend fun blockUser(userId: String): Result<BlockUserResponse>

cleanup

fun cleanup()

collectUserFeedback

fun collectUserFeedback(rating: Int, reason: String? = null, custom: Map<String, Any>? = null)

create

suspend fun create(memberIds: List<String>? = null, members: List<MemberRequest>? = null, custom: Map<String, Any>? = null, settings: CallSettingsRequest? = null, startsAt: OffsetDateTime? = null, team: String? = null, ring: Boolean = false, notify: Boolean = false): Result<GetOrCreateCallResponse>

Create a call. You can create a call client side, many apps prefer to do this server side though

end

suspend fun end(): Result<Unit>

ends the call for yourself as well as other users

fastReconnect

suspend fun fastReconnect()

Fast reconnect to the same SFU with the same participant session.

fireEvent

fun fireEvent(event: VideoEvent)

get

suspend fun get(): Result<GetCallResponse>

Basic crud operations

goLive

suspend fun goLive(startHls: Boolean = false, startRecording: Boolean = false, startTranscription: Boolean = false): Result<GoLiveResponse>

grantPermissions

suspend fun grantPermissions(userId: String, permissions: List<String>): Result<UpdateUserPermissionsResponse>

handleEvent

fun handleEvent(event: VideoEvent)

hasCapability

fun hasCapability(vararg capability: OwnCapability): Boolean

initRenderer

fun initRenderer(videoRenderer: VideoTextureViewRenderer, sessionId: String, trackType: <Error class: unknown class>, onRendered: (VideoTextureViewRenderer) -> Unit = {})

Perhaps it would be nicer to have an interface. Any UI elements that renders video should implement it

isAudioProcessingEnabled

fun isAudioProcessingEnabled(): Boolean

isLocalPin

fun isLocalPin(sessionId: String): Boolean

isPinnedParticipant

fun isPinnedParticipant(sessionId: String): Boolean

isServerPin

fun isServerPin(sessionId: String): Boolean

isVideoEnabled

fun isVideoEnabled(): Boolean

join

suspend fun join(create: Boolean = false, createOptions: CreateCallOptions? = null, ring: Boolean = false, notify: Boolean = false): Result<RtcSession>

leave

fun leave()

Leave the call, but don't end it for other users

listRecordings

suspend fun listRecordings(sessionId: String? = null): Result<ListRecordingsResponse>

List the recordings for this call.

listTranscription

suspend fun listTranscription(): Result<ListTranscriptionsResponse>

migrate

suspend fun migrate()

Migrate to another SFU.

muteAllUsers

suspend fun muteAllUsers(audio: Boolean = true, video: Boolean = false, screenShare: Boolean = false): Result<MuteUsersResponse>

muteUser

suspend fun muteUser(userId: String, audio: Boolean = true, video: Boolean = false, screenShare: Boolean = false): Result<MuteUsersResponse>

muteUsers

suspend fun muteUsers(userIds: List<String>, audio: Boolean = true, video: Boolean = false, screenShare: Boolean = false): Result<MuteUsersResponse>

notify

suspend fun notify(): Result<GetCallResponse>

pinForEveryone

suspend fun pinForEveryone(sessionId: String, userId: String): Result<PinResponse>

processAudioSample

fun processAudioSample(audioSample: JavaAudioDeviceModule.AudioSamples)

queryMembers

suspend fun queryMembers(filter: Map<String, Any>, sort: List<SortField> = mutableListOf(SortField.Desc("created_at")), limit: Int = 25, prev: String? = null, next: String? = null): Result<QueriedMembers>

reject

suspend fun reject(reason: RejectReason? = null): Result<RejectCallResponse>

rejoin

suspend fun rejoin()

Rejoin a call. Creates a new session and joins as a new participant.

removeMembers

suspend fun removeMembers(userIds: List<String>): Result<UpdateCallMembersResponse>

requestPermissions

suspend fun requestPermissions(vararg permission: String): Result<Unit>

Permissions

revokePermissions

suspend fun revokePermissions(userId: String, permissions: List<String>): Result<UpdateUserPermissionsResponse>

ring

suspend fun ring(): Result<GetCallResponse>

sendCustomEvent

suspend fun sendCustomEvent(data: Map<String, Any>): Result<SendCallEventResponse>

sendReaction

suspend fun sendReaction(type: String, emoji: String? = null, custom: Map<String, Any>? = null): Result<SendReactionResponse>

setAudioProcessingEnabled

fun setAudioProcessingEnabled(enabled: Boolean)

setIncomingVideoEnabled

fun setIncomingVideoEnabled(enabled: Boolean?, sessionIds: List<String>? = null)

Enables/disables incoming video feed.

setPreferredIncomingVideoResolution

fun setPreferredIncomingVideoResolution(resolution: PreferredVideoResolution?, sessionIds: List<String>? = null)

Sets the preferred incoming video resolution.

setVisibility

fun setVisibility(sessionId: String, trackType: <Error class: unknown class>, visible: Boolean)

startHLS

suspend fun startHLS(): Result<Any>

startRecording

suspend fun startRecording(): Result<Any>

startScreenSharing

fun startScreenSharing(mediaProjectionPermissionResultData: Intent)

User needs to have OwnCapability.Screenshare capability in order to start screen sharing.

startTranscription

suspend fun startTranscription(): Result<StartTranscriptionResponse>

stopHLS

suspend fun stopHLS(): Result<Any>

stopLive

suspend fun stopLive(): Result<StopLiveResponse>

stopRecording

suspend fun stopRecording(): Result<Any>

stopScreenSharing

fun stopScreenSharing()

stopTranscription

suspend fun stopTranscription(): Result<StopTranscriptionResponse>

fun subscribe(listener: VideoEventListener<VideoEvent>): EventSubscription

subscribeFor

fun subscribeFor(vararg eventTypes: Class<out VideoEvent>, listener: VideoEventListener<VideoEvent>): EventSubscription

takeScreenshot

suspend fun takeScreenshot(track: VideoTrack): Bitmap?

toggleAudioProcessing

fun toggleAudioProcessing(): Boolean

unpinForEveryone

suspend fun unpinForEveryone(sessionId: String, userId: String): Result<UnpinResponse>

update

suspend fun update(custom: Map<String, Any>? = null, settingsOverride: CallSettingsRequest? = null, startsAt: OffsetDateTime? = null): Result<UpdateCallResponse>

Update a call

updateMembers

suspend fun updateMembers(memberRequests: List<MemberRequest>): Result<UpdateCallMembersResponse>