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

StreamVideo

interface StreamVideo : NotificationHandler

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

Types

object Companion

Properties

abstract val context: Context

Represents the default call config when starting a call.

abstract val state: ClientState

abstract val user: User

abstract val userId: String

Functions

abstract fun call(type: String, id: String = ""): Call

Create a call with the given type and id.

abstract fun cleanup()

abstract suspend fun connectAsync(): Deferred<Result<Long>>

connectIfNotAlreadyConnected

abstract suspend fun connectIfNotAlreadyConnected()

abstract suspend fun createDevice(pushDevice: PushDevice): Result<Device>

Create a device that will be used to receive push notifications.

abstract suspend fun deleteDevice(device: Device): Result<Unit>

Remove a device used to receive push notifications.

abstract suspend fun getEdges(): Result<List<EdgeData>>

Returns a list of all the edges available on the network.

abstract fun logOut()

Clears the internal user state, removes push notification devices and clears the call state.

abstract suspend fun queryCalls(filters: Map<String, Any>, sort: List<SortField> = listOf(SortField.Asc(DEFAULT_QUERY_CALLS_SORT)), limit: Int = DEFAULT_QUERY_CALLS_LIMIT, prev: String? = null, next: String? = null, watch: Boolean = false): Result<QueriedCalls>

Queries calls with a given filter predicate and pagination.

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

Queries calls with a given filter predicate and pagination.

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

Subscribe to all events

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

Subscribe for a specific list of events

Inherited functions

getNotificationUpdates

abstract fun getNotificationUpdates(coroutineScope: CoroutineScope, call: Call, localUser: User, onUpdate: (Notification) -> Unit)

Get subsequent updates to notifications. Initially, notifications are posted by one of the other methods, and then this method can be used to re-post them with updated content.

getOngoingCallNotification

abstract fun getOngoingCallNotification(callId: StreamCallId, callDisplayName: String? = null, isOutgoingCall: Boolean = false, remoteParticipantCount: Int = 0): Notification?

getRingingCallNotification

abstract fun getRingingCallNotification(ringingState: RingingState, callId: StreamCallId, callDisplayName: String? = null, shouldHaveContentIntent: Boolean = true): Notification?

getSettingUpCallNotification

abstract fun getSettingUpCallNotification(): Notification?

abstract fun onLiveCall(callId: StreamCallId, callDisplayName: String)

abstract fun onMissedCall(callId: StreamCallId, callDisplayName: String)

abstract fun onNotification(callId: StreamCallId, callDisplayName: String)

onPermissionDenied

abstract fun onPermissionDenied()

onPermissionGranted

abstract fun onPermissionGranted()

onPermissionRationale

abstract fun onPermissionRationale()

onPermissionRequested

abstract fun onPermissionRequested()

abstract fun onRingingCall(callId: StreamCallId, callDisplayName: String)

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