stream-video-android-core/io.getstream.video.android.core.model

Package-level declarations

Types

data class AudioTrack(val streamId: String, val audio: AudioTrack) : MediaTrack

data class CallData(val blockedUsersIds: List<String>, val call: CallInfo, val members: List<CallUser>, val ownMembership: CallUser?)

CallDetails

@Stable

data class CallDetails(val memberUserIds: List<String>, val members: Map<String, CallUser>, val ownCapabilities: List<OwnCapability>) : Serializable

CallEgress

@Stable

data class CallEgress(val broadcastEgress: String, val recordEgress: String)

CallEventType

@Stable

enum CallEventType : Enum<CallEventType>

Represents the type of events we can send around calls.

CallInfo

@Stable

data class CallInfo(val cid: String, val type: String, val id: String, val createdByUserId: String, val broadcastingEnabled: Boolean, val recordingEnabled: Boolean, val createdAt: Date?, val updatedAt: Date?, val custom: Map<String, Any?>) : Serializable

CallMember

@Stable

data class CallMember(val callCid: String, val role: String, val userId: String, val createdAt: Date?, val updatedAt: Date?) : Serializable

CallRecordingData

@Stable

data class CallRecordingData(val fileName: String, val url: String, val start: Long, val end: Long)

Represents a single call recording with its metadata.

CallStatus

@Stable

sealed interface CallStatus

CallUser

@Stable

data class CallUser(val id: String, val name: String? = null, val role: String? = null, val imageUrl: String? = null, val teams: List<String>? = null, val state: CallUserState?, val createdAt: Date?, val updatedAt: Date?) : Serializable

CallUserState

@Stable

data class CallUserState(val trackIdPrefix: String, val online: Boolean, val audio: Boolean, val video: Boolean)

EdgeData

@Stable

data class EdgeData(val id: String, val latencyTestUrl: String, val latitude: Float, val longitude: Float, val green: Int, val yellow: Int, val red: Int)

Represents the information about an Edge center in our network.

IceCandidate

@Stable

@Serializable

data class IceCandidate(sdpMid: String, sdpMLineIndex: Int, candidate: String, usernameFragment: String?)

IceServer

@Stable

data class IceServer(val urls: List<String>, val username: String, val password: String) : Serializable

Ingress

@Stable

data class Ingress(var rtmp: RTMP)

MediaTrack

@Stable

sealed class MediaTrack

Member

@Stable

data class Member(val createdAt: OffsetDateTime, val custom: Map<String, Any?>, val updatedAt: OffsetDateTime, val user: User, val userId: String, val deletedAt: OffsetDateTime? = null, val role: String? = null)

MuteUsersData

@Stable

data class MuteUsersData(val users: List<String>? = null, val muteAllUsers: Boolean? = null, val audio: Boolean? = null, val screenShare: Boolean? = null, val video: Boolean? = null)

Represents the data used to request user's tracks to be muted.

NetworkQuality

@Stable

sealed class NetworkQuality

Represents the network connection quality of a video call.

PreferredVideoResolution

data class PreferredVideoResolution(val width: Int, val height: Int)

QueriedCalls

@Stable

data class QueriedCalls(val calls: List<CallData>, val next: String?, val prev: String?)

QueriedMembers

@Stable

data class QueriedMembers(val members: List<Member>, val next: String?, val prev: String?)

Reaction

@Stable

data class Reaction(val id: String, val response: ReactionResponse, val createdAt: Long, var isConsumed: Boolean = false)

ReactionData

@Stable

data class ReactionData(val type: String, val user: User, val emoji: String?, val custom: Map<String, Any?>?)

Represents the information about a successfully sent reaction.

ReactionState

@Stable

sealed interface ReactionState

RejectReason

sealed class RejectReason

RTMP

@Stable

data class RTMP(var address: String, var streamKey: String)

ScreenSharingSession

@Stable

data class ScreenSharingSession(val participant: ParticipantState)

Contains a track with the screen sharing content and the participant that's sharing the screen.

SortData

@Stable

data class SortData(val direction: Int = DEFAULT_SORT_DIRECTION, val sortField: String)

Represents the data required to apply a sorting method to queries.

SortField

@Stable

sealed class SortField

StreamPeerType

@Stable

enum StreamPeerType : Enum<StreamPeerType>

The type of peer connections, either a PUBLISHER that sends data to the call or a SUBSCRIBER that receives and decodes the data from the server.

UpdateUserPermissionsData

@Stable

data class UpdateUserPermissionsData(val userId: String, val grantedPermissions: List<String>? = null, val revokedPermissions: List<String>? = null)

Represents the data used to request user permission updates.

VideoTrack

@Stable

data class VideoTrack(val streamId: String, val video: VideoTrack) : MediaTrack

VisibilityOnScreenState

enum VisibilityOnScreenState : Enum<VisibilityOnScreenState>

Participant visibility on the screen.

Inherited functions

merge

infix fun CallUser.merge(that: CallUser?): CallUser

Merges that into this CallUser to absorb as much data as possible from both instances.

infix fun CallUserState?.merge(that: CallUserState?): CallUserState?

Merges that into this CallUserState to absorb as much data as possible from both instances.

infix fun Map<String, CallUser>.merge(that: CallUser): Map<String, CallUser>

Merges that into this map.

infix fun Map<String, CallUser>.merge(that: Map<String, CallUser>): Map<String, CallUser>

Merges CallUser maps to absorb as many non-null and non-empty data from both collections.

toPeerType

fun StreamPeerType.toPeerType(): <Error class: unknown class>

toRequest

fun MuteUsersData.toRequest(): MuteUsersRequest

fun SortData.toRequest(): SortParam

fun UpdateUserPermissionsData.toRequest(): UpdateUserPermissionsRequest

Maps the data to the request for the BE.

fun SortField.toRequest(): SortParam