Interface StreamVideo
-
- All Implemented Interfaces:
-
io.getstream.android.push.permissions.NotificationPermissionHandler,io.getstream.video.android.core.notifications.NotificationHandler
@Stable() public interface StreamVideo implements NotificationHandler
The main interface to control the Video calls. StreamVideoImpl implements this interface.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classStreamVideo.Companion
-
Method Summary
Modifier and Type Method Description abstract Callcall(String type, String id)Create a call with the given type and id. abstract Result<QueriedCalls>queryCalls(Map<String, Object> filters, List<SortField> sort, Integer limit, String prev, String next, Boolean watch)Queries calls with a given filter predicate and pagination. abstract Result<QueriedMembers>queryMembers(String type, String id, Map<String, Object> filter, List<SortField> sort, String prev, String next, Integer limit)Queries calls with a given filter predicate and pagination. abstract EventSubscriptionsubscribeFor(Class<out VideoEvent> eventTypes, VideoEventListener<VideoEvent> listener)Subscribe for a specific list of events abstract EventSubscriptionsubscribe(VideoEventListener<VideoEvent> listener)Subscribe to all events abstract Result<Device>createDevice(PushDevice pushDevice)Create a device that will be used to receive push notifications. abstract Result<Unit>deleteDevice(Device device)Remove a device used to receive push notifications. abstract Result<List<EdgeData>>getEdges()Returns a list of all the edges available on the network. abstract Deferred<Result<Long>>connectAsync()abstract UnitlogOut()Clears the internal user state, removes push notification devices and clears the call state. abstract Unitcleanup()abstract UnitconnectIfNotAlreadyConnected()abstract ContextgetContext()Represents the default call config when starting a call. abstract UsergetUser()abstract StringgetUserId()abstract ClientStategetState()-
Methods inherited from class io.getstream.video.android.core.notifications.NotificationHandler
getOngoingCallNotification, getRingingCallNotification, onLiveCall, onMissedCall, onNotification, onRingingCall -
Methods inherited from class io.getstream.android.push.permissions.NotificationPermissionHandler
onPermissionDenied, onPermissionGranted, onPermissionRationale, onPermissionRequested -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
queryCalls
abstract Result<QueriedCalls> queryCalls(Map<String, Object> filters, List<SortField> sort, Integer limit, String prev, String next, Boolean watch)
Queries calls with a given filter predicate and pagination.
- Parameters:
limit-maximum number of items in response
prev-paging support. Set null for first page. Otherwise set the value from last page response.
next-paging support. Set null for first page. Otherwise set the value from last page response.
- Returns:
Result containing the QueriedCalls.
-
queryMembers
abstract Result<QueriedMembers> queryMembers(String type, String id, Map<String, Object> filter, List<SortField> sort, String prev, String next, Integer limit)
Queries calls with a given filter predicate and pagination.
- Parameters:
prev-paging support. Set null for first page. Otherwise set the value from last page response.
next-paging support. Set null for first page. Otherwise set the value from last page response.
limit-maximum number of items in response
-
subscribeFor
abstract EventSubscription subscribeFor(Class<out VideoEvent> eventTypes, VideoEventListener<VideoEvent> listener)
Subscribe for a specific list of events
-
subscribe
abstract EventSubscription subscribe(VideoEventListener<VideoEvent> listener)
Subscribe to all events
-
createDevice
abstract Result<Device> createDevice(PushDevice pushDevice)
Create a device that will be used to receive push notifications.
- Parameters:
pushDevice- The PushDevice obtained from the selected push provider.- Returns:
Result containing the Device.
-
deleteDevice
abstract Result<Unit> deleteDevice(Device device)
Remove a device used to receive push notifications.
- Parameters:
device- The Device, previously provided by createDevice.- Returns:
Result if the operation was successful or not.
-
getEdges
abstract Result<List<EdgeData>> getEdges()
Returns a list of all the edges available on the network.
-
connectAsync
abstract Deferred<Result<Long>> connectAsync()
-
logOut
abstract Unit logOut()
Clears the internal user state, removes push notification devices and clears the call state.
-
connectIfNotAlreadyConnected
abstract Unit connectIfNotAlreadyConnected()
-
getContext
abstract Context getContext()
Represents the default call config when starting a call.
-
getState
abstract ClientState getState()
-
-
-
-