stream-video-android-core/io.getstream.android.video.generated.models

Package-level declarations

Types

data class AcceptCallResponse(@Json(name = "duration") val duration: String)

AcceptCallResponse is the payload for accepting a call.

data class AggregatedStats( @Json(name = "publisher_aggregate_stats") val publisherAggregateStats: PublisherAggregateStats? = null, @Json(name = "turn") val turn: TURNAggregatedStats? = null)

APIError

data class APIError( @Json(name = "code") val code: Int, @Json(name = "duration") val duration: String, @Json(name = "message") val message: String, @Json(name = "more_info") val moreInfo: String, @Json(name = "StatusCode") val statusCode: Int, @Json(name = "details") val details: List<Int>, @Json(name = "unrecoverable") val unrecoverable: Boolean? = null, @Json(name = "exception_fields") val exceptionFields: Map<String, String>? = null)

AudioSettingsRequest

data class AudioSettingsRequest( @Json(name = "default_device") val defaultDevice: AudioSettingsRequest.DefaultDevice, @Json(name = "access_request_enabled") val accessRequestEnabled: Boolean? = null, @Json(name = "mic_default_on") val micDefaultOn: Boolean? = null, @Json(name = "opus_dtx_enabled") val opusDtxEnabled: Boolean? = null, @Json(name = "redundant_coding_enabled") val redundantCodingEnabled: Boolean? = null, @Json(name = "speaker_default_on") val speakerDefaultOn: Boolean? = null, @Json(name = "noise_cancellation") val noiseCancellation: NoiseCancellationSettings? = null)

AudioSettingsResponse

data class AudioSettingsResponse( @Json(name = "access_request_enabled") val accessRequestEnabled: Boolean, @Json(name = "default_device") val defaultDevice: AudioSettingsResponse.DefaultDevice, @Json(name = "mic_default_on") val micDefaultOn: Boolean, @Json(name = "opus_dtx_enabled") val opusDtxEnabled: Boolean, @Json(name = "redundant_coding_enabled") val redundantCodingEnabled: Boolean, @Json(name = "speaker_default_on") val speakerDefaultOn: Boolean, @Json(name = "noise_cancellation") val noiseCancellation: NoiseCancellationSettings? = null)

BackstageSettingsRequest

data class BackstageSettingsRequest( @Json(name = "enabled") val enabled: Boolean? = null, @Json(name = "join_ahead_time_seconds") val joinAheadTimeSeconds: Int? = null)

BackstageSettingsResponse

data class BackstageSettingsResponse( @Json(name = "enabled") val enabled: Boolean, @Json(name = "join_ahead_time_seconds") val joinAheadTimeSeconds: Int? = null)

BlockedUserEvent

data class BlockedUserEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String, @Json(name = "blocked_by_user") val blockedByUser: UserResponse? = null) : VideoEvent, WSCallEvent

This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.

BlockUserRequest

data class BlockUserRequest(@Json(name = "user_id") val userId: String)

BlockUserRequest is the payload for blocking a user.

BlockUserResponse

data class BlockUserResponse(@Json(name = "duration") val duration: String)

BlockUserResponse is the payload for blocking a user.

Bound

data class Bound(@Json(name = "inclusive") val inclusive: Boolean, @Json(name = "value") val value: Float)

BroadcastSettingsRequest

data class BroadcastSettingsRequest( @Json(name = "enabled") val enabled: Boolean? = null, @Json(name = "hls") val hls: HLSSettingsRequest? = null, @Json(name = "rtmp") val rtmp: RTMPSettingsRequest? = null)

BroadcastSettingsResponse

data class BroadcastSettingsResponse( @Json(name = "enabled") val enabled: Boolean, @Json(name = "hls") val hls: HLSSettingsResponse, @Json(name = "rtmp") val rtmp: RTMPSettingsResponse)

BroadcastSettingsResponse is the payload for broadcasting settings

CallAcceptedEvent

data class CallAcceptedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "call") val call: CallResponse, @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a user accepts a notification to join a call.

CallClosedCaption

data class CallClosedCaption( @Json(name = "end_time") val endTime: OffsetDateTime, @Json(name = "speaker_id") val speakerId: String, @Json(name = "start_time") val startTime: OffsetDateTime, @Json(name = "text") val text: String, @Json(name = "user") val user: UserResponse)

CallClosedCaption represents a closed caption of a call.

CallClosedCaptionsFailedEvent

data class CallClosedCaptionsFailedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call closed captions has failed

CallClosedCaptionsStartedEvent

data class CallClosedCaptionsStartedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call closed caption has started

CallClosedCaptionsStoppedEvent

data class CallClosedCaptionsStoppedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call closed captions has stopped

CallCreatedEvent

data class CallCreatedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a call is created. Clients receiving this event should check if the ringing

CallDeletedEvent

data class CallDeletedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a call is deleted. Clients receiving this event should leave the call screen

CallDurationReport

data class CallDurationReport(@Json(name = "histogram") val histogram: List<ReportByHistogramBucket>)

CallDurationReportResponse

data class CallDurationReportResponse(@Json(name = "daily") val daily: List<DailyAggregateCallDurationReportResponse>)

CallEndedEvent

data class CallEndedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String, @Json(name = "user") val user: UserResponse? = null) : VideoEvent, WSCallEvent

This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen

CallEvent

data class CallEvent( @Json(name = "description") val description: String, @Json(name = "end_timestamp") val endTimestamp: Int, @Json(name = "internal") val internal: Boolean, @Json(name = "kind") val kind: String, @Json(name = "severity") val severity: Int, @Json(name = "timestamp") val timestamp: Int, @Json(name = "type") val type: String, @Json(name = "category") val category: String? = null, @Json(name = "component") val component: String? = null, @Json(name = "issue_tags") val issueTags: List<String>? = null)

CallHLSBroadcastingFailedEvent

data class CallHLSBroadcastingFailedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when HLS broadcasting has failed

CallHLSBroadcastingStartedEvent

data class CallHLSBroadcastingStartedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "hls_playlist_url") val hlsPlaylistUrl: String, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when HLS broadcasting has started

CallHLSBroadcastingStoppedEvent

data class CallHLSBroadcastingStoppedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when HLS broadcasting has stopped

CallIngressResponse

data class CallIngressResponse(@Json(name = "rtmp") val rtmp: RTMPIngress)

CallIngressResponse is the payload for ingress settings

CallLiveStartedEvent

data class CallLiveStartedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a call is started. Clients receiving this event should start the call.

CallMemberAddedEvent

data class CallMemberAddedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when one or more members are added to a call

CallMemberRemovedEvent

data class CallMemberRemovedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "members") val members: List<String>, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when one or more members are removed from a call

CallMemberUpdatedEvent

data class CallMemberUpdatedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when one or more members are updated

CallMemberUpdatedPermissionEvent

data class CallMemberUpdatedPermissionEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "call") val call: CallResponse, @Json(name = "capabilities_by_role") val capabilitiesByRole: Map<String, List<String>>, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when one or more members get its role updated

CallMissedEvent

data class CallMissedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "notify_user") val notifyUser: Boolean, @Json(name = "session_id") val sessionId: String, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "call") val call: CallResponse, @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent to call members who did not accept/reject/join the call to notify they missed the call

CallNotificationEvent

data class CallNotificationEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "session_id") val sessionId: String, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "call") val call: CallResponse, @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent to all call members to notify they are getting called

CallParticipantCountReport

data class CallParticipantCountReport(@Json(name = "histogram") val histogram: List<ReportByHistogramBucket>)

CallParticipantCountReportResponse

data class CallParticipantCountReportResponse(@Json(name = "daily") val daily: List<DailyAggregateCallParticipantCountReportResponse>)

CallParticipantResponse

data class CallParticipantResponse( @Json(name = "joined_at") val joinedAt: OffsetDateTime, @Json(name = "role") val role: String, @Json(name = "user_session_id") val userSessionId: String, @Json(name = "user") val user: UserResponse)

CallReactionEvent

data class CallReactionEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "reaction") val reaction: ReactionResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen

CallRecording

data class CallRecording( @Json(name = "end_time") val endTime: OffsetDateTime, @Json(name = "filename") val filename: String, @Json(name = "start_time") val startTime: OffsetDateTime, @Json(name = "url") val url: String)

CallRecording represents a recording of a call.

CallRecordingFailedEvent

data class CallRecordingFailedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "egress_id") val egressId: String, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call recording has failed

CallRecordingReadyEvent

data class CallRecordingReadyEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "egress_id") val egressId: String, @Json(name = "call_recording") val callRecording: CallRecording, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call recording is ready

CallRecordingStartedEvent

data class CallRecordingStartedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "egress_id") val egressId: String, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call recording has started

CallRecordingStoppedEvent

data class CallRecordingStoppedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "egress_id") val egressId: String, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call recording has stopped

CallRejectedEvent

data class CallRejectedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "call") val call: CallResponse, @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String, @Json(name = "reason") val reason: String? = null) : VideoEvent, WSCallEvent

This event is sent when a user rejects a notification to join a call.

CallRequest

data class CallRequest( @Json(name = "starts_at") val startsAt: OffsetDateTime? = null, @Json(name = "team") val team: String? = null, @Json(name = "video") val video: Boolean? = null, @Json(name = "members") val members: List<MemberRequest>? = null, @Json(name = "custom") val custom: Map<String, Any?>? = null, @Json(name = "settings_override") val settingsOverride: CallSettingsRequest? = null)

CallRequest is the payload for creating a call.

CallResponse

data class CallResponse( @Json(name = "backstage") val backstage: Boolean, @Json(name = "captioning") val captioning: Boolean, @Json(name = "cid") val cid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "current_session_id") val currentSessionId: String, @Json(name = "id") val id: String, @Json(name = "recording") val recording: Boolean, @Json(name = "transcribing") val transcribing: Boolean, @Json(name = "type") val type: String, @Json(name = "updated_at") val updatedAt: OffsetDateTime, @Json(name = "blocked_user_ids") val blockedUserIds: List<String>, @Json(name = "created_by") val createdBy: UserResponse, @Json(name = "custom") val custom: Map<String, Any?> = emptyMap(), @Json(name = "egress") val egress: EgressResponse, @Json(name = "ingress") val ingress: CallIngressResponse, @Json(name = "settings") val settings: CallSettingsResponse, @Json(name = "ended_at") val endedAt: OffsetDateTime? = null, @Json(name = "join_ahead_time_seconds") val joinAheadTimeSeconds: Int? = null, @Json(name = "starts_at") val startsAt: OffsetDateTime? = null, @Json(name = "team") val team: String? = null, @Json(name = "session") val session: CallSessionResponse? = null, @Json(name = "thumbnails") val thumbnails: ThumbnailResponse? = null)

Represents a call

CallRingEvent

data class CallRingEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "session_id") val sessionId: String, @Json(name = "video") val video: Boolean, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "call") val call: CallResponse, @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent to all call members to notify they are getting called

CallRtmpBroadcastFailedEvent

data class CallRtmpBroadcastFailedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "name") val name: String, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a call RTMP broadcast has failed

CallRtmpBroadcastStartedEvent

data class CallRtmpBroadcastStartedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "name") val name: String, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when RTMP broadcast has started

CallRtmpBroadcastStoppedEvent

data class CallRtmpBroadcastStoppedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "name") val name: String, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when RTMP broadcast has stopped

CallSessionEndedEvent

data class CallSessionEndedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "session_id") val sessionId: String, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a call session ends

CallSessionParticipantCountsUpdatedEvent

data class CallSessionParticipantCountsUpdatedEvent( @Json(name = "anonymous_participant_count") val anonymousParticipantCount: Int, @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "session_id") val sessionId: String, @Json(name = "participants_count_by_role") val participantsCountByRole: Map<String, Int> = emptyMap(), @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when the participant counts in a call session are updated

CallSessionParticipantJoinedEvent

data class CallSessionParticipantJoinedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "session_id") val sessionId: String, @Json(name = "participant") val participant: CallParticipantResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a participant joins a call session

CallSessionParticipantLeftEvent

data class CallSessionParticipantLeftEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "duration_seconds") val durationSeconds: Int, @Json(name = "session_id") val sessionId: String, @Json(name = "participant") val participant: CallParticipantResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a participant leaves a call session

CallSessionResponse

data class CallSessionResponse( @Json(name = "anonymous_participant_count") val anonymousParticipantCount: Int, @Json(name = "id") val id: String, @Json(name = "participants") val participants: List<CallParticipantResponse>, @Json(name = "accepted_by") val acceptedBy: Map<String, OffsetDateTime>, @Json(name = "missed_by") val missedBy: Map<String, OffsetDateTime>, @Json(name = "participants_count_by_role") val participantsCountByRole: Map<String, Int>, @Json(name = "rejected_by") val rejectedBy: Map<String, OffsetDateTime>, @Json(name = "ended_at") val endedAt: OffsetDateTime? = null, @Json(name = "live_ended_at") val liveEndedAt: OffsetDateTime? = null, @Json(name = "live_started_at") val liveStartedAt: OffsetDateTime? = null, @Json(name = "started_at") val startedAt: OffsetDateTime? = null, @Json(name = "timer_ends_at") val timerEndsAt: OffsetDateTime? = null)

CallSessionStartedEvent

data class CallSessionStartedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "session_id") val sessionId: String, @Json(name = "call") val call: CallResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a call session starts

CallSettingsRequest

data class CallSettingsRequest( @Json(name = "audio") val audio: AudioSettingsRequest? = null, @Json(name = "backstage") val backstage: BackstageSettingsRequest? = null, @Json(name = "broadcasting") val broadcasting: BroadcastSettingsRequest? = null, @Json(name = "geofencing") val geofencing: GeofenceSettingsRequest? = null, @Json(name = "limits") val limits: LimitsSettingsRequest? = null, @Json(name = "recording") val recording: RecordSettingsRequest? = null, @Json(name = "ring") val ring: RingSettingsRequest? = null, @Json(name = "screensharing") val screensharing: ScreensharingSettingsRequest? = null, @Json(name = "session") val session: SessionSettingsRequest? = null, @Json(name = "thumbnails") val thumbnails: ThumbnailsSettingsRequest? = null, @Json(name = "transcription") val transcription: TranscriptionSettingsRequest? = null, @Json(name = "video") val video: VideoSettingsRequest? = null)

CallSettingsResponse

data class CallSettingsResponse( @Json(name = "audio") val audio: AudioSettingsResponse, @Json(name = "backstage") val backstage: BackstageSettingsResponse, @Json(name = "broadcasting") val broadcasting: BroadcastSettingsResponse, @Json(name = "geofencing") val geofencing: GeofenceSettingsResponse, @Json(name = "limits") val limits: LimitsSettingsResponse, @Json(name = "recording") val recording: RecordSettingsResponse, @Json(name = "ring") val ring: RingSettingsResponse, @Json(name = "screensharing") val screensharing: ScreensharingSettingsResponse, @Json(name = "session") val session: SessionSettingsResponse, @Json(name = "thumbnails") val thumbnails: ThumbnailsSettingsResponse, @Json(name = "transcription") val transcription: TranscriptionSettingsResponse, @Json(name = "video") val video: VideoSettingsResponse)

CallsPerDayReport

data class CallsPerDayReport(@Json(name = "count") val count: Int)

CallsPerDayReportResponse

data class CallsPerDayReportResponse(@Json(name = "daily") val daily: List<DailyAggregateCallsPerDayReportResponse>)

CallStateResponseFields

data class CallStateResponseFields( @Json(name = "members") val members: List<MemberResponse>, @Json(name = "own_capabilities") val ownCapabilities: List<OwnCapability>, @Json(name = "call") val call: CallResponse, @Json(name = "membership") val membership: MemberResponse? = null)

CallStateResponseFields is the payload for call state response

CallStatsReportSummaryResponse

data class CallStatsReportSummaryResponse( @Json(name = "call_cid") val callCid: String, @Json(name = "call_duration_seconds") val callDurationSeconds: Int, @Json(name = "call_session_id") val callSessionId: String, @Json(name = "call_status") val callStatus: String, @Json(name = "first_stats_time") val firstStatsTime: OffsetDateTime, @Json(name = "created_at") val createdAt: OffsetDateTime? = null, @Json(name = "min_user_rating") val minUserRating: Int? = null, @Json(name = "quality_score") val qualityScore: Int? = null)

CallTimeline

data class CallTimeline(@Json(name = "events") val events: List<CallEvent>)

CallTranscription

data class CallTranscription( @Json(name = "end_time") val endTime: OffsetDateTime, @Json(name = "filename") val filename: String, @Json(name = "start_time") val startTime: OffsetDateTime, @Json(name = "url") val url: String)

CallTranscription represents a transcription of a call.

CallTranscriptionFailedEvent

data class CallTranscriptionFailedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "egress_id") val egressId: String, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call transcription has failed

CallTranscriptionReadyEvent

data class CallTranscriptionReadyEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "egress_id") val egressId: String, @Json(name = "call_transcription") val callTranscription: CallTranscription, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call transcription is ready

CallTranscriptionStartedEvent

data class CallTranscriptionStartedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "egress_id") val egressId: String, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call transcription has started

CallTranscriptionStoppedEvent

data class CallTranscriptionStoppedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "egress_id") val egressId: String, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when call transcription has stopped

CallUpdatedEvent

data class CallUpdatedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "call") val call: CallResponse, @Json(name = "capabilities_by_role") val capabilitiesByRole: Map<String, List<String>>, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a call is updated, clients should use this update the local state of the call.

CallUserMutedEvent

data class CallUserMutedEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "from_user_id") val fromUserId: String, @Json(name = "muted_user_ids") val mutedUserIds: List<String>, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a call member is muted

ClosedCaptionEvent

data class ClosedCaptionEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "closed_caption") val closedCaption: CallClosedCaption, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen

CollectUserFeedbackRequest

data class CollectUserFeedbackRequest( @Json(name = "rating") val rating: Int, @Json(name = "sdk") val sdk: String, @Json(name = "sdk_version") val sdkVersion: String, @Json(name = "user_session_id") val userSessionId: String, @Json(name = "reason") val reason: String? = null, @Json(name = "custom") val custom: Map<String, Any?>? = null)

CollectUserFeedbackResponse

data class CollectUserFeedbackResponse(@Json(name = "duration") val duration: String)

Basic response information

ConnectedEvent

data class ConnectedEvent( @Json(name = "connection_id") val connectionId: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "me") val me: OwnUserResponse, @Json(name = "type") val type: String) : VideoEvent

This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server

ConnectionErrorEvent

data class ConnectionErrorEvent( @Json(name = "connection_id") val connectionId: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "error") val error: APIError, @Json(name = "type") val type: String) : VideoEvent

This event is sent when the WS connection fails

ConnectUserDetailsRequest

data class ConnectUserDetailsRequest( @Json(name = "id") val id: String, @Json(name = "image") val image: String? = null, @Json(name = "invisible") val invisible: Boolean? = null, @Json(name = "language") val language: String? = null, @Json(name = "name") val name: String? = null, @Json(name = "custom") val custom: Map<String, Any?>? = null)

Coordinates

data class Coordinates(@Json(name = "latitude") val latitude: Float, @Json(name = "longitude") val longitude: Float)

Count

data class Count(@Json(name = "approximate") val approximate: Boolean, @Json(name = "value") val value: Int)

CreateDeviceRequest

data class CreateDeviceRequest( @Json(name = "id") val id: String, @Json(name = "push_provider") val pushProvider: CreateDeviceRequest.PushProvider, @Json(name = "push_provider_name") val pushProviderName: String? = null, @Json(name = "voip_token") val voipToken: Boolean? = null)

Create device request

CreateGuestRequest

data class CreateGuestRequest(@Json(name = "user") val user: UserRequest)

CreateGuestResponse

data class CreateGuestResponse( @Json(name = "access_token") val accessToken: String, @Json(name = "duration") val duration: String, @Json(name = "user") val user: UserResponse)

Credentials

data class Credentials( @Json(name = "token") val token: String, @Json(name = "ice_servers") val iceServers: List<ICEServer>, @Json(name = "server") val server: SFUResponse)

CustomVideoEvent

data class CustomVideoEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "custom") val custom: Map<String, Any?> = emptyMap(), @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

A custom event, this event is used to send custom events to other participants in the call.

DailyAggregateCallDurationReportResponse

data class DailyAggregateCallDurationReportResponse(@Json(name = "date") val date: String, @Json(name = "report") val report: CallDurationReport)

DailyAggregateCallParticipantCountReportResponse

data class DailyAggregateCallParticipantCountReportResponse( @Json(name = "date") val date: String, @Json(name = "report") val report: CallParticipantCountReport)

DailyAggregateCallsPerDayReportResponse

data class DailyAggregateCallsPerDayReportResponse(@Json(name = "date") val date: String, @Json(name = "report") val report: CallsPerDayReport)

DailyAggregateQualityScoreReportResponse

data class DailyAggregateQualityScoreReportResponse( @Json(name = "date") val date: String, @Json(name = "report") val report: QualityScoreReport)

DailyAggregateSDKUsageReportResponse

data class DailyAggregateSDKUsageReportResponse(@Json(name = "date") val date: String, @Json(name = "report") val report: SDKUsageReport)

DailyAggregateUserFeedbackReportResponse

data class DailyAggregateUserFeedbackReportResponse( @Json(name = "date") val date: String, @Json(name = "report") val report: UserFeedbackReport)

DeleteCallRequest

data class DeleteCallRequest(@Json(name = "hard") val hard: Boolean? = null)

DeleteCallRequest is the payload for deleting a call.

DeleteCallResponse

data class DeleteCallResponse( @Json(name = "duration") val duration: String, @Json(name = "call") val call: CallResponse, @Json(name = "task_id") val taskId: String? = null)

DeleteCallResponse is the payload for deleting a call.

DeleteRecordingResponse

data class DeleteRecordingResponse(@Json(name = "duration") val duration: String)

Response for DeleteRecording

DeleteTranscriptionResponse

data class DeleteTranscriptionResponse(@Json(name = "duration") val duration: String)

DeleteTranscriptionResponse is the payload for deleting a transcription.

DeviceResponse

data class DeviceResponse( @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "id") val id: String, @Json(name = "push_provider") val pushProvider: String, @Json(name = "user_id") val userId: String, @Json(name = "disabled") val disabled: Boolean? = null, @Json(name = "disabled_reason") val disabledReason: String? = null, @Json(name = "push_provider_name") val pushProviderName: String? = null, @Json(name = "voip") val voip: Boolean? = null)

Response for Device

EdgeResponse

data class EdgeResponse( @Json(name = "continent_code") val continentCode: String, @Json(name = "country_iso_code") val countryIsoCode: String, @Json(name = "green") val green: Int, @Json(name = "id") val id: String, @Json(name = "latency_test_url") val latencyTestUrl: String, @Json(name = "latitude") val latitude: Float, @Json(name = "longitude") val longitude: Float, @Json(name = "red") val red: Int, @Json(name = "subdivision_iso_code") val subdivisionIsoCode: String, @Json(name = "yellow") val yellow: Int)

EgressHLSResponse

data class EgressHLSResponse(@Json(name = "playlist_url") val playlistUrl: String, @Json(name = "status") val status: String)

EgressResponse

data class EgressResponse( @Json(name = "broadcasting") val broadcasting: Boolean, @Json(name = "rtmps") val rtmps: List<EgressRTMPResponse>, @Json(name = "hls") val hls: EgressHLSResponse? = null)

EgressRTMPResponse

data class EgressRTMPResponse( @Json(name = "name") val name: String, @Json(name = "started_at") val startedAt: OffsetDateTime, @Json(name = "stream_key") val streamKey: String? = null, @Json(name = "stream_url") val streamUrl: String? = null)

EndCallResponse

data class EndCallResponse(@Json(name = "duration") val duration: String)

Response for ending a call

GeofenceSettingsRequest

data class GeofenceSettingsRequest(@Json(name = "names") val names: List<String>? = null)

GeofenceSettingsResponse

data class GeofenceSettingsResponse(@Json(name = "names") val names: List<String>)

GeolocationResult

data class GeolocationResult( @Json(name = "accuracy_radius") val accuracyRadius: Int, @Json(name = "city") val city: String, @Json(name = "continent") val continent: String, @Json(name = "continent_code") val continentCode: String, @Json(name = "country") val country: String, @Json(name = "country_iso_code") val countryIsoCode: String, @Json(name = "latitude") val latitude: Float, @Json(name = "longitude") val longitude: Float, @Json(name = "subdivision") val subdivision: String, @Json(name = "subdivision_iso_code") val subdivisionIsoCode: String)

GetCallResponse

data class GetCallResponse( @Json(name = "duration") val duration: String, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "own_capabilities") val ownCapabilities: List<OwnCapability>, @Json(name = "call") val call: CallResponse, @Json(name = "membership") val membership: MemberResponse? = null)

GetCallStatsResponse

data class GetCallStatsResponse( @Json(name = "call_duration_seconds") val callDurationSeconds: Int, @Json(name = "call_status") val callStatus: String, @Json(name = "duration") val duration: String, @Json(name = "max_freezes_duration_seconds") val maxFreezesDurationSeconds: Int, @Json(name = "max_participants") val maxParticipants: Int, @Json(name = "max_total_quality_limitation_duration_seconds") val maxTotalQualityLimitationDurationSeconds: Int, @Json(name = "publishing_participants") val publishingParticipants: Int, @Json(name = "quality_score") val qualityScore: Int, @Json(name = "sfu_count") val sfuCount: Int, @Json(name = "participant_report") val participantReport: List<UserStats>, @Json(name = "sfus") val sfus: List<SFULocationResponse>, @Json(name = "average_connection_time") val averageConnectionTime: Float? = null, @Json(name = "aggregated") val aggregated: AggregatedStats? = null, @Json(name = "call_timeline") val callTimeline: CallTimeline? = null, @Json(name = "jitter") val jitter: TimeStats? = null, @Json(name = "latency") val latency: TimeStats? = null)

Basic response information

GetEdgesResponse

data class GetEdgesResponse(@Json(name = "duration") val duration: String, @Json(name = "edges") val edges: List<EdgeResponse>)

Basic response information

GetOrCreateCallRequest

data class GetOrCreateCallRequest( @Json(name = "members_limit") val membersLimit: Int? = null, @Json(name = "notify") val notify: Boolean? = null, @Json(name = "ring") val ring: Boolean? = null, @Json(name = "video") val video: Boolean? = null, @Json(name = "data") val data: CallRequest? = null)

GetOrCreateCallResponse

data class GetOrCreateCallResponse( @Json(name = "created") val created: Boolean, @Json(name = "duration") val duration: String, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "own_capabilities") val ownCapabilities: List<OwnCapability>, @Json(name = "call") val call: CallResponse, @Json(name = "membership") val membership: MemberResponse? = null)

GoLiveRequest

data class GoLiveRequest( @Json(name = "recording_storage_name") val recordingStorageName: String? = null, @Json(name = "start_closed_caption") val startClosedCaption: Boolean? = null, @Json(name = "start_hls") val startHls: Boolean? = null, @Json(name = "start_recording") val startRecording: Boolean? = null, @Json(name = "start_rtmp_broadcasts") val startRtmpBroadcasts: Boolean? = null, @Json(name = "start_transcription") val startTranscription: Boolean? = null, @Json(name = "transcription_storage_name") val transcriptionStorageName: String? = null)

GoLiveResponse

data class GoLiveResponse(@Json(name = "duration") val duration: String, @Json(name = "call") val call: CallResponse)

Basic response information

HealthCheckEvent

data class HealthCheckEvent( @Json(name = "connection_id") val connectionId: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "custom") val custom: Map<String, Any?> = emptyMap(), @Json(name = "type") val type: String, @Json(name = "cid") val cid: String? = null, @Json(name = "received_at") val receivedAt: OffsetDateTime? = null) : VideoEvent

HLSSettingsRequest

data class HLSSettingsRequest( @Json(name = "quality_tracks") val qualityTracks: List<String>, @Json(name = "auto_on") val autoOn: Boolean? = null, @Json(name = "enabled") val enabled: Boolean? = null)

HLSSettingsResponse

data class HLSSettingsResponse( @Json(name = "auto_on") val autoOn: Boolean, @Json(name = "enabled") val enabled: Boolean, @Json(name = "quality_tracks") val qualityTracks: List<String>)

HLSSettings is the payload for HLS settings

ICEServer

data class ICEServer( @Json(name = "password") val password: String, @Json(name = "username") val username: String, @Json(name = "urls") val urls: List<String>)

JoinCallRequest

data class JoinCallRequest( @Json(name = "location") val location: String, @Json(name = "create") val create: Boolean? = null, @Json(name = "members_limit") val membersLimit: Int? = null, @Json(name = "migrating_from") val migratingFrom: String? = null, @Json(name = "notify") val notify: Boolean? = null, @Json(name = "ring") val ring: Boolean? = null, @Json(name = "video") val video: Boolean? = null, @Json(name = "data") val data: CallRequest? = null)

JoinCallResponse

data class JoinCallResponse( @Json(name = "created") val created: Boolean, @Json(name = "duration") val duration: String, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "own_capabilities") val ownCapabilities: List<OwnCapability>, @Json(name = "call") val call: CallResponse, @Json(name = "credentials") val credentials: Credentials, @Json(name = "stats_options") val statsOptions: StatsOptions, @Json(name = "membership") val membership: MemberResponse? = null)

LayoutSettingsRequest

data class LayoutSettingsRequest( @Json(name = "name") val name: LayoutSettingsRequest.Name, @Json(name = "detect_orientation") val detectOrientation: Boolean? = null, @Json(name = "external_app_url") val externalAppUrl: String? = null, @Json(name = "external_css_url") val externalCssUrl: String? = null, @Json(name = "options") val options: Map<String, Any?>? = null)

LimitsSettingsRequest

data class LimitsSettingsRequest( @Json(name = "max_duration_seconds") val maxDurationSeconds: Int? = null, @Json(name = "max_participants") val maxParticipants: Int? = null)

LimitsSettingsResponse

data class LimitsSettingsResponse( @Json(name = "max_duration_seconds") val maxDurationSeconds: Int? = null, @Json(name = "max_participants") val maxParticipants: Int? = null)

ListDevicesResponse

data class ListDevicesResponse(@Json(name = "duration") val duration: String, @Json(name = "devices") val devices: List<DeviceResponse>)

List devices response

ListRecordingsResponse

data class ListRecordingsResponse(@Json(name = "duration") val duration: String, @Json(name = "recordings") val recordings: List<CallRecording>)

Response for listing recordings

ListTranscriptionsResponse

data class ListTranscriptionsResponse( @Json(name = "duration") val duration: String, @Json(name = "transcriptions") val transcriptions: List<CallTranscription>)

Location

data class Location( @Json(name = "continent_code") val continentCode: String, @Json(name = "country_iso_code") val countryIsoCode: String, @Json(name = "subdivision_iso_code") val subdivisionIsoCode: String)

MediaPubSubHint

data class MediaPubSubHint( @Json(name = "audio_published") val audioPublished: Boolean, @Json(name = "audio_subscribed") val audioSubscribed: Boolean, @Json(name = "video_published") val videoPublished: Boolean, @Json(name = "video_subscribed") val videoSubscribed: Boolean)

MemberRequest

data class MemberRequest( @Json(name = "user_id") val userId: String, @Json(name = "role") val role: String? = null, @Json(name = "custom") val custom: Map<String, Any?>? = null)

MemberRequest is the payload for adding a member to a call.

MemberResponse

data class MemberResponse( @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "updated_at") val updatedAt: OffsetDateTime, @Json(name = "user_id") val userId: String, @Json(name = "custom") val custom: Map<String, Any?> = emptyMap(), @Json(name = "user") val user: UserResponse, @Json(name = "deleted_at") val deletedAt: OffsetDateTime? = null, @Json(name = "role") val role: String? = null)

MemberResponse is the payload for a member of a call.

MuteUsersRequest

data class MuteUsersRequest( @Json(name = "audio") val audio: Boolean? = null, @Json(name = "mute_all_users") val muteAllUsers: Boolean? = null, @Json(name = "screenshare") val screenshare: Boolean? = null, @Json(name = "screenshare_audio") val screenshareAudio: Boolean? = null, @Json(name = "video") val video: Boolean? = null, @Json(name = "user_ids") val userIds: List<String>? = null)

MuteUsersResponse

data class MuteUsersResponse(@Json(name = "duration") val duration: String)

MuteUsersResponse is the response payload for the mute users endpoint.

NetworkMetricsReportResponse

data class NetworkMetricsReportResponse( @Json(name = "average_connection_time") val averageConnectionTime: Float? = null, @Json(name = "average_jitter") val averageJitter: Float? = null, @Json(name = "average_latency") val averageLatency: Float? = null, @Json(name = "average_time_to_reconnect") val averageTimeToReconnect: Float? = null)

NoiseCancellationSettings

data class NoiseCancellationSettings(@Json(name = "mode") val mode: NoiseCancellationSettings.Mode)

OwnCapability

sealed class OwnCapability

OwnCapability Enum

OwnUserResponse

data class OwnUserResponse( @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "id") val id: String, @Json(name = "language") val language: String, @Json(name = "role") val role: String, @Json(name = "updated_at") val updatedAt: OffsetDateTime, @Json(name = "devices") val devices: List<DeviceResponse>, @Json(name = "teams") val teams: List<String>, @Json(name = "custom") val custom: Map<String, Any?> = emptyMap(), @Json(name = "deactivated_at") val deactivatedAt: OffsetDateTime? = null, @Json(name = "deleted_at") val deletedAt: OffsetDateTime? = null, @Json(name = "image") val image: String? = null, @Json(name = "last_active") val lastActive: OffsetDateTime? = null, @Json(name = "name") val name: String? = null, @Json(name = "revoke_tokens_issued_before") val revokeTokensIssuedBefore: OffsetDateTime? = null, @Json(name = "blocked_user_ids") val blockedUserIds: List<String>? = null, @Json(name = "push_preferences") val pushPreferences: PushPreferences? = null)

PermissionRequestEvent

data class PermissionRequestEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "permissions") val permissions: List<String>, @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a user requests access to a feature on a call,

PerSDKUsageReport

data class PerSDKUsageReport(@Json(name = "total") val total: Int, @Json(name = "by_version") val byVersion: Map<String, Int>)

PinRequest

data class PinRequest(@Json(name = "session_id") val sessionId: String, @Json(name = "user_id") val userId: String)

PinRequest is the payload for pinning a message.

PinResponse

data class PinResponse(@Json(name = "duration") val duration: String)

Basic response information

PublishedTrackInfo

data class PublishedTrackInfo( @Json(name = "codec_mime_type") val codecMimeType: String? = null, @Json(name = "duration_seconds") val durationSeconds: Int? = null, @Json(name = "track_type") val trackType: String? = null)

PublisherAggregateStats

data class PublisherAggregateStats( @Json(name = "by_track_type") val byTrackType: Map<String, Count>? = null, @Json(name = "total") val total: Count? = null)

PushPreferences

data class PushPreferences( @Json(name = "call_level") val callLevel: String? = null, @Json(name = "chat_level") val chatLevel: String? = null, @Json(name = "disabled_until") val disabledUntil: OffsetDateTime? = null)

QualityScoreReport

data class QualityScoreReport(@Json(name = "histogram") val histogram: List<ReportByHistogramBucket>)

QualityScoreReportResponse

data class QualityScoreReportResponse(@Json(name = "daily") val daily: List<DailyAggregateQualityScoreReportResponse>)

QueryAggregateCallStatsRequest

data class QueryAggregateCallStatsRequest( @Json(name = "from") val from: String? = null, @Json(name = "to") val to: String? = null, @Json(name = "report_types") val reportTypes: List<String>? = null)

QueryAggregateCallStatsResponse

data class QueryAggregateCallStatsResponse( @Json(name = "duration") val duration: String, @Json(name = "call_duration_report") val callDurationReport: CallDurationReportResponse? = null, @Json(name = "call_participant_count_report") val callParticipantCountReport: CallParticipantCountReportResponse? = null, @Json(name = "calls_per_day_report") val callsPerDayReport: CallsPerDayReportResponse? = null, @Json(name = "network_metrics_report") val networkMetricsReport: NetworkMetricsReportResponse? = null, @Json(name = "quality_score_report") val qualityScoreReport: QualityScoreReportResponse? = null, @Json(name = "sdk_usage_report") val sdkUsageReport: SDKUsageReportResponse? = null, @Json(name = "user_feedback_report") val userFeedbackReport: UserFeedbackReportResponse? = null)

Basic response information

QueryCallMembersRequest

data class QueryCallMembersRequest( @Json(name = "id") val id: String, @Json(name = "type") val type: String, @Json(name = "limit") val limit: Int? = null, @Json(name = "next") val next: String? = null, @Json(name = "prev") val prev: String? = null, @Json(name = "sort") val sort: List<SortParamRequest>? = null, @Json(name = "filter_conditions") val filterConditions: Map<String, Any?>? = null)

QueryCallMembersResponse

data class QueryCallMembersResponse( @Json(name = "duration") val duration: String, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "next") val next: String? = null, @Json(name = "prev") val prev: String? = null)

Basic response information

QueryCallsRequest

data class QueryCallsRequest( @Json(name = "limit") val limit: Int? = null, @Json(name = "next") val next: String? = null, @Json(name = "prev") val prev: String? = null, @Json(name = "watch") val watch: Boolean? = null, @Json(name = "sort") val sort: List<SortParamRequest>? = null, @Json(name = "filter_conditions") val filterConditions: Map<String, Any?>? = null)

QueryCallsResponse

data class QueryCallsResponse( @Json(name = "duration") val duration: String, @Json(name = "calls") val calls: List<CallStateResponseFields>, @Json(name = "next") val next: String? = null, @Json(name = "prev") val prev: String? = null)

QueryCallStatsRequest

data class QueryCallStatsRequest( @Json(name = "limit") val limit: Int? = null, @Json(name = "next") val next: String? = null, @Json(name = "prev") val prev: String? = null, @Json(name = "sort") val sort: List<SortParamRequest>? = null, @Json(name = "filter_conditions") val filterConditions: Map<String, Any?>? = null)

QueryCallStatsResponse

data class QueryCallStatsResponse( @Json(name = "duration") val duration: String, @Json(name = "reports") val reports: List<CallStatsReportSummaryResponse>, @Json(name = "next") val next: String? = null, @Json(name = "prev") val prev: String? = null)

Basic response information

ReactionResponse

data class ReactionResponse( @Json(name = "type") val type: String, @Json(name = "user") val user: UserResponse, @Json(name = "emoji_code") val emojiCode: String? = null, @Json(name = "custom") val custom: Map<String, Any?>? = null)

RecordSettingsRequest

data class RecordSettingsRequest( @Json(name = "mode") val mode: RecordSettingsRequest.Mode, @Json(name = "audio_only") val audioOnly: Boolean? = null, @Json(name = "quality") val quality: RecordSettingsRequest.Quality? = null)

RecordSettingsResponse

data class RecordSettingsResponse( @Json(name = "audio_only") val audioOnly: Boolean, @Json(name = "mode") val mode: String, @Json(name = "quality") val quality: String)

RecordSettings is the payload for recording settings

RejectCallRequest

data class RejectCallRequest(@Json(name = "reason") val reason: String? = null)

RejectCallResponse

data class RejectCallResponse(@Json(name = "duration") val duration: String)

ReportByHistogramBucket

data class ReportByHistogramBucket( @Json(name = "category") val category: String, @Json(name = "count") val count: Int, @Json(name = "sum") val sum: Float, @Json(name = "lower_bound") val lowerBound: Bound? = null, @Json(name = "upper_bound") val upperBound: Bound? = null)

RequestPermissionRequest

data class RequestPermissionRequest(@Json(name = "permissions") val permissions: List<String>)

RequestPermissionResponse

data class RequestPermissionResponse(@Json(name = "duration") val duration: String)

Response

data class Response(@Json(name = "duration") val duration: String)

Basic response information

RingSettingsRequest

data class RingSettingsRequest( @Json(name = "auto_cancel_timeout_ms") val autoCancelTimeoutMs: Int, @Json(name = "incoming_call_timeout_ms") val incomingCallTimeoutMs: Int, @Json(name = "missed_call_timeout_ms") val missedCallTimeoutMs: Int? = null)

RingSettingsResponse

data class RingSettingsResponse( @Json(name = "auto_cancel_timeout_ms") val autoCancelTimeoutMs: Int, @Json(name = "incoming_call_timeout_ms") val incomingCallTimeoutMs: Int, @Json(name = "missed_call_timeout_ms") val missedCallTimeoutMs: Int)

RTMPBroadcastRequest

data class RTMPBroadcastRequest( @Json(name = "name") val name: String, @Json(name = "stream_url") val streamUrl: String, @Json(name = "quality") val quality: RTMPBroadcastRequest.Quality? = null, @Json(name = "stream_key") val streamKey: String? = null, @Json(name = "layout") val layout: LayoutSettingsRequest? = null)

RTMPBroadcastRequest is the payload for starting an RTMP broadcast.

RTMPIngress

data class RTMPIngress(@Json(name = "address") val address: String)

RTMP input settings

RTMPSettingsRequest

data class RTMPSettingsRequest( @Json(name = "enabled") val enabled: Boolean? = null, @Json(name = "quality") val quality: RTMPSettingsRequest.Quality? = null)

RTMPSettingsResponse

data class RTMPSettingsResponse(@Json(name = "enabled") val enabled: Boolean, @Json(name = "quality") val quality: String)

RTMPSettingsResponse is the payload for RTMP settings

ScreensharingSettingsRequest

data class ScreensharingSettingsRequest( @Json(name = "access_request_enabled") val accessRequestEnabled: Boolean? = null, @Json(name = "enabled") val enabled: Boolean? = null, @Json(name = "target_resolution") val targetResolution: TargetResolution? = null)

ScreensharingSettingsResponse

data class ScreensharingSettingsResponse( @Json(name = "access_request_enabled") val accessRequestEnabled: Boolean, @Json(name = "enabled") val enabled: Boolean, @Json(name = "target_resolution") val targetResolution: TargetResolution? = null)

SDKUsageReport

data class SDKUsageReport(@Json(name = "per_sdk_usage") val perSdkUsage: Map<String, PerSDKUsageReport>)

SDKUsageReportResponse

data class SDKUsageReportResponse(@Json(name = "daily") val daily: List<DailyAggregateSDKUsageReportResponse>)

SendCallEventRequest

data class SendCallEventRequest(@Json(name = "custom") val custom: Map<String, Any?>? = null)

Send a call event to the other user

SendCallEventResponse

data class SendCallEventResponse(@Json(name = "duration") val duration: String)

SendReactionRequest

data class SendReactionRequest( @Json(name = "type") val type: String, @Json(name = "emoji_code") val emojiCode: String? = null, @Json(name = "custom") val custom: Map<String, Any?>? = null)

SendReactionResponse

data class SendReactionResponse(@Json(name = "duration") val duration: String, @Json(name = "reaction") val reaction: ReactionResponse)

Basic response information

SessionSettingsRequest

data class SessionSettingsRequest(@Json(name = "inactivity_timeout_seconds") val inactivityTimeoutSeconds: Int)

SessionSettingsResponse

data class SessionSettingsResponse(@Json(name = "inactivity_timeout_seconds") val inactivityTimeoutSeconds: Int)

SFULocationResponse

data class SFULocationResponse( @Json(name = "datacenter") val datacenter: String, @Json(name = "id") val id: String, @Json(name = "coordinates") val coordinates: Coordinates, @Json(name = "location") val location: Location)

SFUResponse

data class SFUResponse( @Json(name = "edge_name") val edgeName: String, @Json(name = "url") val url: String, @Json(name = "ws_endpoint") val wsEndpoint: String)

SortParamRequest

data class SortParamRequest(@Json(name = "direction") val direction: Int? = null, @Json(name = "field") val field: String? = null)

StartClosedCaptionsRequest

data class StartClosedCaptionsRequest( @Json(name = "enable_transcription") val enableTranscription: Boolean? = null, @Json(name = "external_storage") val externalStorage: String? = null, @Json(name = "language") val language: String? = null)

StartClosedCaptionsResponse

data class StartClosedCaptionsResponse(@Json(name = "duration") val duration: String)

StartHLSBroadcastingResponse

data class StartHLSBroadcastingResponse(@Json(name = "duration") val duration: String, @Json(name = "playlist_url") val playlistUrl: String)

StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.

StartRecordingRequest

data class StartRecordingRequest(@Json(name = "recording_external_storage") val recordingExternalStorage: String? = null)

StartRecordingResponse

data class StartRecordingResponse(@Json(name = "duration") val duration: String)

StartRecordingResponse is the response payload for the start recording endpoint.

StartRTMPBroadcastsRequest

data class StartRTMPBroadcastsRequest(@Json(name = "broadcasts") val broadcasts: List<RTMPBroadcastRequest>)

StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.

StartRTMPBroadcastsResponse

data class StartRTMPBroadcastsResponse(@Json(name = "duration") val duration: String)

StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.

StartTranscriptionRequest

data class StartTranscriptionRequest( @Json(name = "enable_closed_captions") val enableClosedCaptions: Boolean? = null, @Json(name = "language") val language: String? = null, @Json(name = "transcription_external_storage") val transcriptionExternalStorage: String? = null)

StartTranscriptionResponse

data class StartTranscriptionResponse(@Json(name = "duration") val duration: String)

StatsOptions

data class StatsOptions(@Json(name = "reporting_interval_ms") val reportingIntervalMs: Int)

StopAllRTMPBroadcastsResponse

data class StopAllRTMPBroadcastsResponse(@Json(name = "duration") val duration: String)

StopClosedCaptionsRequest

data class StopClosedCaptionsRequest(@Json(name = "stop_transcription") val stopTranscription: Boolean? = null)

StopClosedCaptionsResponse

data class StopClosedCaptionsResponse(@Json(name = "duration") val duration: String)

Basic response information

StopHLSBroadcastingResponse

data class StopHLSBroadcastingResponse(@Json(name = "duration") val duration: String)

Basic response information

StopLiveRequest

data class StopLiveRequest( @Json(name = "continue_closed_caption") val continueClosedCaption: Boolean? = null, @Json(name = "continue_hls") val continueHls: Boolean? = null, @Json(name = "continue_recording") val continueRecording: Boolean? = null, @Json(name = "continue_rtmp_broadcasts") val continueRtmpBroadcasts: Boolean? = null, @Json(name = "continue_transcription") val continueTranscription: Boolean? = null)

StopLiveResponse

data class StopLiveResponse(@Json(name = "duration") val duration: String, @Json(name = "call") val call: CallResponse)

StopRecordingResponse

data class StopRecordingResponse(@Json(name = "duration") val duration: String)

Basic response information

StopRTMPBroadcastsResponse

data class StopRTMPBroadcastsResponse(@Json(name = "duration") val duration: String)

Basic response information

StopTranscriptionRequest

data class StopTranscriptionRequest(@Json(name = "stop_closed_captions") val stopClosedCaptions: Boolean? = null)

StopTranscriptionResponse

data class StopTranscriptionResponse(@Json(name = "duration") val duration: String)

Basic response information

Subsession

data class Subsession( @Json(name = "ended_at") val endedAt: Int, @Json(name = "joined_at") val joinedAt: Int, @Json(name = "sfu_id") val sfuId: String, @Json(name = "pub_sub_hint") val pubSubHint: MediaPubSubHint? = null)

TargetResolution

data class TargetResolution( @Json(name = "height") val height: Int, @Json(name = "width") val width: Int, @Json(name = "bitrate") val bitrate: Int? = null)

ThumbnailResponse

data class ThumbnailResponse(@Json(name = "image_url") val imageUrl: String)

ThumbnailsSettingsRequest

data class ThumbnailsSettingsRequest(@Json(name = "enabled") val enabled: Boolean? = null)

ThumbnailsSettingsResponse

data class ThumbnailsSettingsResponse(@Json(name = "enabled") val enabled: Boolean)

TimeStats

data class TimeStats(@Json(name = "average_seconds") val averageSeconds: Float, @Json(name = "max_seconds") val maxSeconds: Float)

TranscriptionSettingsRequest

data class TranscriptionSettingsRequest( @Json(name = "mode") val mode: TranscriptionSettingsRequest.Mode, @Json(name = "closed_caption_mode") val closedCaptionMode: TranscriptionSettingsRequest.ClosedCaptionMode? = null, @Json(name = "language") val language: TranscriptionSettingsRequest.Language? = null)

TranscriptionSettingsResponse

data class TranscriptionSettingsResponse( @Json(name = "closed_caption_mode") val closedCaptionMode: TranscriptionSettingsResponse.ClosedCaptionMode, @Json(name = "language") val language: TranscriptionSettingsResponse.Language, @Json(name = "mode") val mode: TranscriptionSettingsResponse.Mode)

TURNAggregatedStats

data class TURNAggregatedStats(@Json(name = "tcp") val tcp: Count? = null, @Json(name = "total") val total: Count? = null)

UnblockedUserEvent

data class UnblockedUserEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent when a user is unblocked on a call,

UnblockUserRequest

data class UnblockUserRequest(@Json(name = "user_id") val userId: String)

UnblockUserRequest is the payload for unblocking a user.

UnblockUserResponse

data class UnblockUserResponse(@Json(name = "duration") val duration: String)

UnblockUserResponse is the payload for unblocking a user.

UnpinRequest

data class UnpinRequest(@Json(name = "session_id") val sessionId: String, @Json(name = "user_id") val userId: String)

UnpinRequest is the payload for unpinning a message.

UnpinResponse

data class UnpinResponse(@Json(name = "duration") val duration: String)

UnpinResponse is the payload for unpinning a message.

UnsupportedVideoEvent

class UnsupportedVideoEvent(val type: String) : VideoEvent

UnsupportedVideoEventException

class UnsupportedVideoEventException(val type: String) : Exception

UpdateCallMembersRequest

data class UpdateCallMembersRequest( @Json(name = "remove_members") val removeMembers: List<String>? = null, @Json(name = "update_members") val updateMembers: List<MemberRequest>? = null)

Update call members

UpdateCallMembersResponse

data class UpdateCallMembersResponse( @Json(name = "duration") val duration: String, @Json(name = "members") val members: List<MemberResponse>)

Basic response information

UpdateCallRequest

data class UpdateCallRequest( @Json(name = "starts_at") val startsAt: OffsetDateTime? = null, @Json(name = "custom") val custom: Map<String, Any?>? = null, @Json(name = "settings_override") val settingsOverride: CallSettingsRequest? = null)

Request for updating a call

UpdateCallResponse

data class UpdateCallResponse( @Json(name = "duration") val duration: String, @Json(name = "members") val members: List<MemberResponse>, @Json(name = "own_capabilities") val ownCapabilities: List<OwnCapability>, @Json(name = "call") val call: CallResponse, @Json(name = "membership") val membership: MemberResponse? = null)

Response for updating a call

UpdatedCallPermissionsEvent

data class UpdatedCallPermissionsEvent( @Json(name = "call_cid") val callCid: String, @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "own_capabilities") val ownCapabilities: List<OwnCapability>, @Json(name = "user") val user: UserResponse, @Json(name = "type") val type: String) : VideoEvent, WSCallEvent

This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly

UpdateUserPermissionsRequest

data class UpdateUserPermissionsRequest( @Json(name = "user_id") val userId: String, @Json(name = "grant_permissions") val grantPermissions: List<String>? = null, @Json(name = "revoke_permissions") val revokePermissions: List<String>? = null)

UpdateUserPermissionsResponse

data class UpdateUserPermissionsResponse(@Json(name = "duration") val duration: String)

Basic response information

UserFeedbackReport

data class UserFeedbackReport( @Json(name = "unreported_count") val unreportedCount: Int, @Json(name = "count_by_rating") val countByRating: Map<String, Int>)

UserFeedbackReportResponse

data class UserFeedbackReportResponse(@Json(name = "daily") val daily: List<DailyAggregateUserFeedbackReportResponse>)

UserInfoResponse

data class UserInfoResponse( @Json(name = "id") val id: String, @Json(name = "image") val image: String, @Json(name = "name") val name: String, @Json(name = "roles") val roles: List<String>, @Json(name = "custom") val custom: Map<String, Any?> = emptyMap())

UserRequest

data class UserRequest( @Json(name = "id") val id: String, @Json(name = "image") val image: String? = null, @Json(name = "invisible") val invisible: Boolean? = null, @Json(name = "language") val language: String? = null, @Json(name = "name") val name: String? = null, @Json(name = "custom") val custom: Map<String, Any?>? = null)

User request object

UserResponse

data class UserResponse( @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "id") val id: String, @Json(name = "language") val language: String, @Json(name = "role") val role: String, @Json(name = "updated_at") val updatedAt: OffsetDateTime, @Json(name = "blocked_user_ids") val blockedUserIds: List<String>, @Json(name = "teams") val teams: List<String>, @Json(name = "custom") val custom: Map<String, Any?> = emptyMap(), @Json(name = "deactivated_at") val deactivatedAt: OffsetDateTime? = null, @Json(name = "deleted_at") val deletedAt: OffsetDateTime? = null, @Json(name = "image") val image: String? = null, @Json(name = "last_active") val lastActive: OffsetDateTime? = null, @Json(name = "name") val name: String? = null, @Json(name = "revoke_tokens_issued_before") val revokeTokensIssuedBefore: OffsetDateTime? = null)

User response object

UserResponsePrivacyFields

data class UserResponsePrivacyFields( @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "id") val id: String, @Json(name = "language") val language: String, @Json(name = "role") val role: String, @Json(name = "updated_at") val updatedAt: OffsetDateTime, @Json(name = "blocked_user_ids") val blockedUserIds: List<String>, @Json(name = "teams") val teams: List<String>, @Json(name = "custom") val custom: Map<String, Any?> = emptyMap(), @Json(name = "deactivated_at") val deactivatedAt: OffsetDateTime? = null, @Json(name = "deleted_at") val deletedAt: OffsetDateTime? = null, @Json(name = "image") val image: String? = null, @Json(name = "invisible") val invisible: Boolean? = null, @Json(name = "last_active") val lastActive: OffsetDateTime? = null, @Json(name = "name") val name: String? = null, @Json(name = "revoke_tokens_issued_before") val revokeTokensIssuedBefore: OffsetDateTime? = null)

UserSessionStats

data class UserSessionStats( @Json(name = "freeze_duration_seconds") val freezeDurationSeconds: Int, @Json(name = "group") val group: String, @Json(name = "max_freeze_fraction") val maxFreezeFraction: Float, @Json(name = "max_freezes_duration_seconds") val maxFreezesDurationSeconds: Int, @Json(name = "min_event_ts") val minEventTs: Int, @Json(name = "packet_loss_fraction") val packetLossFraction: Float, @Json(name = "publisher_packet_loss_fraction") val publisherPacketLossFraction: Float, @Json(name = "publishing_duration_seconds") val publishingDurationSeconds: Int, @Json(name = "quality_score") val qualityScore: Float, @Json(name = "receiving_duration_seconds") val receivingDurationSeconds: Int, @Json(name = "session_id") val sessionId: String, @Json(name = "total_pixels_in") val totalPixelsIn: Int, @Json(name = "total_pixels_out") val totalPixelsOut: Int, @Json(name = "average_connection_time") val averageConnectionTime: Float? = null, @Json(name = "browser") val browser: String? = null, @Json(name = "browser_version") val browserVersion: String? = null, @Json(name = "current_ip") val currentIp: String? = null, @Json(name = "current_sfu") val currentSfu: String? = null, @Json(name = "device_model") val deviceModel: String? = null, @Json(name = "device_version") val deviceVersion: String? = null, @Json(name = "distance_to_sfu_kilometers") val distanceToSfuKilometers: Float? = null, @Json(name = "max_fir_per_second") val maxFirPerSecond: Float? = null, @Json(name = "max_freezes_per_second") val maxFreezesPerSecond: Float? = null, @Json(name = "max_nack_per_second") val maxNackPerSecond: Float? = null, @Json(name = "max_pli_per_second") val maxPliPerSecond: Float? = null, @Json(name = "os") val os: String? = null, @Json(name = "os_version") val osVersion: String? = null, @Json(name = "publisher_noise_cancellation_seconds") val publisherNoiseCancellationSeconds: Float? = null, @Json(name = "publisher_quality_limitation_fraction") val publisherQualityLimitationFraction: Float? = null, @Json(name = "publishing_audio_codec") val publishingAudioCodec: String? = null, @Json(name = "publishing_video_codec") val publishingVideoCodec: String? = null, @Json(name = "receiving_audio_codec") val receivingAudioCodec: String? = null, @Json(name = "receiving_video_codec") val receivingVideoCodec: String? = null, @Json(name = "sdk") val sdk: String? = null, @Json(name = "sdk_version") val sdkVersion: String? = null, @Json(name = "subscriber_video_quality_throttled_duration_seconds") val subscriberVideoQualityThrottledDurationSeconds: Float? = null, @Json(name = "truncated") val truncated: Boolean? = null, @Json(name = "webrtc_version") val webrtcVersion: String? = null, @Json(name = "published_tracks") val publishedTracks: List<PublishedTrackInfo>? = null, @Json(name = "subsessions") val subsessions: List<Subsession>? = null, @Json(name = "geolocation") val geolocation: GeolocationResult? = null, @Json(name = "jitter") val jitter: TimeStats? = null, @Json(name = "latency") val latency: TimeStats? = null, @Json(name = "max_publishing_video_quality") val maxPublishingVideoQuality: VideoQuality? = null, @Json(name = "max_receiving_video_quality") val maxReceivingVideoQuality: VideoQuality? = null, @Json(name = "pub_sub_hints") val pubSubHints: MediaPubSubHint? = null, @Json(name = "publisher_jitter") val publisherJitter: TimeStats? = null, @Json(name = "publisher_latency") val publisherLatency: TimeStats? = null, @Json(name = "publisher_video_quality_limitation_duration_seconds") val publisherVideoQualityLimitationDurationSeconds: Map<String, Float>? = null, @Json(name = "subscriber_jitter") val subscriberJitter: TimeStats? = null, @Json(name = "subscriber_latency") val subscriberLatency: TimeStats? = null, @Json(name = "timeline") val timeline: CallTimeline? = null)

UserStats

data class UserStats( @Json(name = "min_event_ts") val minEventTs: Int, @Json(name = "session_stats") val sessionStats: List<UserSessionStats>, @Json(name = "info") val info: UserInfoResponse, @Json(name = "rating") val rating: Int? = null)

UserUpdatedEvent

data class UserUpdatedEvent( @Json(name = "created_at") val createdAt: OffsetDateTime, @Json(name = "custom") val custom: Map<String, Any?> = emptyMap(), @Json(name = "user") val user: UserResponsePrivacyFields, @Json(name = "type") val type: String, @Json(name = "received_at") val receivedAt: OffsetDateTime? = null) : VideoEvent

This event is sent when a user gets updated. The event contains information about the updated user.

VideoDimension

data class VideoDimension(@Json(name = "height") val height: Int, @Json(name = "width") val width: Int)

VideoEvent

abstract class VideoEvent

VideoEventAdapter

class VideoEventAdapter : JsonAdapter<VideoEvent>

VideoQuality

data class VideoQuality( @Json(name = "usage_type") val usageType: String? = null, @Json(name = "resolution") val resolution: VideoDimension? = null)

VideoSettingsRequest

data class VideoSettingsRequest( @Json(name = "access_request_enabled") val accessRequestEnabled: Boolean? = null, @Json(name = "camera_default_on") val cameraDefaultOn: Boolean? = null, @Json(name = "camera_facing") val cameraFacing: VideoSettingsRequest.CameraFacing? = null, @Json(name = "enabled") val enabled: Boolean? = null, @Json(name = "target_resolution") val targetResolution: TargetResolution? = null)

VideoSettingsResponse

data class VideoSettingsResponse( @Json(name = "access_request_enabled") val accessRequestEnabled: Boolean, @Json(name = "camera_default_on") val cameraDefaultOn: Boolean, @Json(name = "camera_facing") val cameraFacing: VideoSettingsResponse.CameraFacing, @Json(name = "enabled") val enabled: Boolean, @Json(name = "target_resolution") val targetResolution: TargetResolution)

WSAuthMessage

data class WSAuthMessage( @Json(name = "token") val token: String, @Json(name = "user_details") val userDetails: ConnectUserDetailsRequest, @Json(name = "products") val products: List<String>? = null)

Websocket auth message

WSAuthMessageRequest

data class WSAuthMessageRequest( @Json(name = "token") val token: String, @Json(name = "user_details") val userDetails: ConnectUserDetailsRequest) : VideoEvent

WSCallEvent

sealed interface WSCallEvent

WSClientEvent

sealed interface WSClientEvent