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

Package-level declarations

Types

Call

@Stable

class Call(client: StreamVideo, val type: String, val id: String, val user: User)

The call class gives you access to all call level API calls

CallActions

interface CallActions

Interface for call actions that can be performed on a participant.

CallHealthMonitor

class CallHealthMonitor(val call: Call, val callScope: CoroutineScope, val onIceRecoveryFailed: () -> Unit)

Monitors

CallState

@Stable

class CallState(client: StreamVideo, call: Call, user: User, val scope: CoroutineScope)

The CallState class keeps all state for a call It's available on every call object

CallStats

class CallStats(val call: Call, val callScope: CoroutineScope)

CallStatsReport

data class CallStatsReport(val publisher: RtcStatsReport?, val subscriber: RtcStatsReport?, val local: LocalStats?, val stateStats: CallStats)

CameraDeviceWrapped

data class CameraDeviceWrapped(val id: String, val characteristics: CameraCharacteristics?, val supportedFormats: MutableList<CameraEnumerationAndroid.CaptureFormat>?, val maxResolution: Int, val direction: CameraDirection?)

CameraDirection

sealed class CameraDirection

CameraManager

class CameraManager(val mediaManager: MediaManagerImpl, val eglBaseContext: EglBase.Context, val cameraCharacteristicsValidator: CameraCharacteristicsValidator, defaultCameraDirection: CameraDirection = CameraDirection.Front)

The CameraManager class makes it easy to manage the camera for your video call

ClientState

@Stable

class ClientState(client: StreamVideo)

ConnectionState

@Stable

sealed interface ConnectionState

CreateCallOptions

data class CreateCallOptions(val memberIds: List<String>? = null, val members: List<MemberRequest>? = null, val custom: Map<String, Any>? = null, val settings: CallSettingsRequest? = null, val startsAt: OffsetDateTime? = null, val team: String? = null)

DeviceStatus

sealed class DeviceStatus

EventSubscription

class EventSubscription(val listener: VideoEventListener<VideoEvent>, val filter: (VideoEvent) -> Boolean? = null)

GEO

sealed class GEO

LocalStats

data class LocalStats(val resolution: CameraEnumerationAndroid.CaptureFormat?, val availableResolutions: List<CameraEnumerationAndroid.CaptureFormat>?, val maxResolution: CameraEnumerationAndroid.CaptureFormat?, val sfu: String, val os: String, val sdkVersion: String, val deviceModel: String)

MediaManagerImpl

class MediaManagerImpl(val context: Context, val call: Call, val scope: CoroutineScope, val eglBaseContext: EglBase.Context, val audioUsage: Int = defaultAudioUsage, val audioUsageProvider: () -> Int = { audioUsage })

Wrap all the audio/video interactions This makes it easier to test our codebase

MediaStatsInfo

data class MediaStatsInfo(val qualityLimit: String?, val jitter: Double?, val width: Long?, val height: Long?, val fps: Double?, val deviceLatency: Double?)

MemberState

@Immutable

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

MicrophoneManager

class MicrophoneManager(val mediaManager: MediaManagerImpl, val audioUsage: Int, val audioUsageProvider: () -> Int)

The Microphone manager makes it easy to use your microphone in a call

ParticipantState

@Stable

data class ParticipantState(var sessionId: String = "", scope: CoroutineScope, callActions: CallActions, initialUserId: String, val source: <Error class: unknown class> = ParticipantSource.PARTICIPANT_SOURCE_WEBRTC_UNSPECIFIED, var trackLookupPrefix: String = "")

Represents the state of a participant in a call.

PeerConnectionStats

class PeerConnectionStats(scope: CoroutineScope)

RealtimeConnection

@Stable

sealed interface RealtimeConnection

RingingState

@Stable

sealed interface RingingState

ScreenShareManager

class ScreenShareManager(val mediaManager: MediaManagerImpl, val eglBaseContext: EglBase.Context)

SpeakerManager

class SpeakerManager(val mediaManager: MediaManagerImpl, val microphoneManager: MicrophoneManager, val initialVolume: Int? = null)

StreamVideo

@Stable

interface StreamVideo : NotificationHandler

The main interface to control the Video calls. StreamVideoClient implements this interface.

StreamVideoBuilder

class StreamVideoBuilder @JvmOverloads constructor(context: Context, apiKey: ApiKey, geo: GEO = GEO.GlobalEdgeNetwork, user: User = User.anonymous(), token: UserToken = "", legacyTokenProvider: suspend (error: Throwable?) -> String? = null, tokenProvider: TokenProvider = legacyTokenProvider?.let { legacy -> object : TokenProvider { override suspend fun loadToken(): String = legacy.invoke(null) } } ?: ConstantTokenProvider(token), loggingLevel: LoggingLevel = LoggingLevel(), notificationConfig: NotificationConfig = NotificationConfig(), ringNotification: (call: Call) -> Notification?? = null, connectionTimeoutInMs: Long = 10000, ensureSingleInstance: Boolean = true, videoDomain: String = "video.stream-io-api.com", runForegroundServiceForCalls: Boolean = true, callServiceConfig: CallServiceConfig? = null, callServiceConfigRegistry: CallServiceConfigRegistry? = null, localSfuAddress: String? = null, sounds: Sounds = defaultResourcesRingingConfig(context).toSounds(), vibrationConfig: RingingCallVibrationConfig = disableVibrationConfig(), crashOnMissingPermission: Boolean = false, permissionCheck: StreamPermissionCheck = DefaultStreamPermissionCheck(), audioUsage: Int = defaultAudioUsage, appName: String? = null, audioProcessing: ManagedAudioProcessingFactory? = null, leaveAfterDisconnectSeconds: Long = 30, callUpdatesAfterLeave: Boolean = false, enableStatsReporting: Boolean = true, enableStereoForSubscriber: Boolean = true)

The StreamVideoBuilder is used to create a new instance of the StreamVideo client. This is the most essential class to connect to the Stream server and initialize everything you need to implement audio/video calls.

StreamVideoConfig

interface StreamVideoConfig

StreamVideoConfigDefault

object StreamVideoConfigDefault : StreamVideoConfig

Properties

sfuReconnectTimeoutMillis

const val sfuReconnectTimeoutMillis: Int

How long do we keep trying to make a full-reconnect (once the SFU signalling WS went down)

Inherited functions

subscribeFor

inline fun <T : VideoEvent> StreamVideo.subscribeFor(listener: VideoEventListener<T>): EventSubscription

Extension function that makes it easy to use on kotlin, but keeps Java usable as well

toJson

fun CallStatsReport.toJson(peerType: StreamPeerType): String

trySetEnabled

fun MediaStreamTrack.trySetEnabled(enabled: Boolean)