Package-level declarations

Types

Link copied to clipboard

The different types of audio devices which may be available on mobile.

Link copied to clipboard
@Serializable
data class AvailableDevices(val camera: List<MediaDeviceInfo>, val microphone: List<MediaDeviceInfo>, val speaker: List<MediaDeviceInfo>, val audio: List<MediaDeviceInfo>)
Link copied to clipboard
@Serializable
data class CallConfiguration(val roomName: String, val initialUserName: String? = null, val userId: String? = null, val isOwner: Boolean, val initialCameraEnabled: Boolean, val initialMicrophoneEnabled: Boolean, val recordingMode: RecordingMode, val roomExpiration: Long? = null, val tokenExpiration: Long? = null, val roomNotBefore: Long? = null, val tokenNotBefore: Long? = null, val ejectAtRoomExpiration: Boolean, val ejectAtTokenExpiration: Boolean, val permissionsOnJoin: ParticipantPermissions, val defaultStreamingEndpoints: List<StreamingEndpoint>, val terseLoggingEnabled: Boolean)
Link copied to clipboard
@Serializable
data class CallJoinData(val meetingSession: MeetingSession, val callConfig: CallConfiguration)

Information returned when a call is joined successfully.

Link copied to clipboard
@Serializable
enum CallState : Enum<CallState>

A new CallClient instance starts in the new state. As soon as CallClient.join is invoked, it progresses to the joining state, and when the client has joined the call, it progresses further to the joined state. As soon as CallClient.leave is invoked, the state changes to leaving, followed by left when this process has completed.

Link copied to clipboard
Link copied to clipboard
@Serializable
data class CanReceiveMediaPermissionFull(val camera: Boolean, val microphone: Boolean, val screenVideo: Boolean, val screenAudio: Boolean, val customVideo: Map<String, Boolean>, val customAudio: Map<String, Boolean>)
Link copied to clipboard
@Serializable
data class CanReceiveMediaPermissionPartial(val camera: Boolean? = null, val microphone: Boolean? = null, val screenVideo: Boolean? = null, val screenAudio: Boolean? = null, val customVideo: Map<String, Boolean>? = null, val customAudio: Map<String, Boolean>? = null)
Link copied to clipboard
@Serializable
data class CanReceivePermission
Link copied to clipboard
@Serializable
data class CanReceivePermissionUpdate(val base: CanReceiveMediaPermissionFull? = null, val byUserId: Map<String, CanReceiveMediaPermissionPartial>? = null, val byParticipantId: Map<String, CanReceiveMediaPermissionPartial>? = null)

A desired update to a participant's canReceive permission.

Link copied to clipboard
Link copied to clipboard
@Serializable(with = DailyJsonElementSerializer::class)
sealed interface DailyJsonElement
Link copied to clipboard
@Serializable
data class DetailedNetworkStats
Link copied to clipboard
@Serializable
data class Info
Link copied to clipboard
@Serializable
data class LatestStats
Link copied to clipboard
@Serializable
data class Media
Link copied to clipboard
@Serializable
data class MediaDeviceInfo(val deviceId: String, val groupId: String, val kind: String, val label: String)

Information that describes a single media input or output device.

Link copied to clipboard
@Serializable
enum MediaOffReason : Enum<MediaOffReason>
Link copied to clipboard
@Serializable
enum MediaState : Enum<MediaState>
Link copied to clipboard
@Serializable
data class MediaStreamTrack(val id: String)
Link copied to clipboard
interface MediaTrackSink

Interface for objects which consume a MediaStreamTrack

Link copied to clipboard
@Serializable
@SerialName(value = "meetingSession")
data class MeetingSession

Information about the meeting session.

Link copied to clipboard
@Serializable
data class MeetingToken(val token: String)

A meeting token.

Link copied to clipboard
@Serializable
data class NetworkConnectionStatusUpdate(val connection: NetworkConnectionType, val event: NetworkConnectionEventType)
Link copied to clipboard

A type of network connection managed by the CallClient.

Link copied to clipboard
@Serializable
data class NetworkStats
Link copied to clipboard
@Serializable
data class Participant

All the information pertaining to a participant in the call, including metadata regarding the participant as well as the tracks being published by the participant.

Link copied to clipboard
@Serializable
data class ParticipantAudioInfo
Link copied to clipboard
@Serializable
data class ParticipantCounts
Link copied to clipboard
@Serializable(with = PeerIdSerializer::class)
data class ParticipantId(val uuid: UUID) : Comparable<ParticipantId>
Link copied to clipboard

The reason a participant appears to have left the call.

Link copied to clipboard
@Serializable
data class ParticipantPermissions
Link copied to clipboard
@Serializable
data class ParticipantPermissionsUpdate(val hasPresence: Boolean? = null, val canSend: Set<CanSendPermission>? = null, val canAdmin: Set<CanAdminPermission>? = null, val canReceive: CanReceivePermissionUpdate? = null)

A desired update to a remote participant's permissions.

Link copied to clipboard
@Serializable
data class Participants(val local: Participant, val all: Map<ParticipantId, Participant>)

Contains all the Participants currently in the call.

Link copied to clipboard
@Serializable
data class ParticipantVideoInfo
Link copied to clipboard
sealed class Recipient

The recipient of a custom app message.

Link copied to clipboard
@Serializable
enum RecordingMode : Enum<RecordingMode>
Link copied to clipboard
@Serializable
data class RemoteInputsEnabledUpdate(val microphone: Boolean? = null, val camera: Boolean? = null, val screenShare: Boolean? = null)

A desired update to a remote participant's input enabled states.

Link copied to clipboard
@Serializable
data class RemoteParticipantUpdate(val permissions: ParticipantPermissionsUpdate? = null, val inputsEnabled: RemoteInputsEnabledUpdate? = null)

A desired update to things about a remote participant that you can control as a participant admin or meeting owner.

Link copied to clipboard
@Serializable
data class RequestError(val msg: String)

Represents an error that occurred when making an API request.

Link copied to clipboard
fun interface RequestListener

Notified when a request completes, or encounters an error.

Link copied to clipboard
fun interface RequestListenerWithData<E>

Notified when a request completes, or encounters an error.

Link copied to clipboard
data class RequestResult(val error: RequestError?)

Information returned when a request completes. If no error is present, then the request was successful.

Link copied to clipboard

Information returned when a request completes. If no error is present, then the request was successful.

Link copied to clipboard
@Serializable
data class StreamingEndpoint(val name: String, val type: StreamingEndpointType, val config: Int)
Link copied to clipboard
Link copied to clipboard
@Serializable
enum Threshold : Enum<Threshold>
Link copied to clipboard

The state of a given track subscription.

Link copied to clipboard
data class TrackSubscriptionStateUpdate(val camera: SubscriptionState? = null, val microphone: SubscriptionState? = null, val screenVideo: SubscriptionState? = null, val screenAudio: SubscriptionState? = null)

Functions

Link copied to clipboard
fun <Error class: unknown class>.all(): <Error class: unknown class>
fun <Error class: unknown class>.all(): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class>.none(): <Error class: unknown class>
fun <Error class: unknown class>.none(): <Error class: unknown class>