VideoProvider

Kotlin |Java

class VideoProvider

kotlin.Any
↳	android.telecom.RemoteConnection.VideoProvider

RemoteConnection.VideoProvider associated with a RemoteConnection. Used to receive video related events and control the video associated with a RemoteConnection.

Summary

Nested classes
abstract	`Callback` Callback class used by the `RemoteConnection.VideoProvider` to relay events from the `Connection.VideoProvider`.

Public methods
open Unit	`registerCallback(l: RemoteConnection.VideoProvider.Callback!)` Registers a callback to receive commands and state changes for video calls.
open Unit	`requestCallDataUsage()` Issues a request to retrieve the data usage (in bytes) of the video portion of the `RemoteConnection` for the `RemoteConnection.VideoProvider`.
open Unit	`requestCameraCapabilities()` Issues a request to retrieve the capabilities of the current camera for the `RemoteConnection.VideoProvider`.
open Unit	`sendSessionModifyRequest(fromProfile: VideoProfile!, toProfile: VideoProfile!)` Issues a request to modify the properties of the current video session for the `RemoteConnection.VideoProvider`.
open Unit	`sendSessionModifyResponse(responseProfile: VideoProfile!)` Provides a response to a request to change the current call video session properties for the `RemoteConnection.VideoProvider`.
open Unit	`setCamera(cameraId: String!)` Sets the camera to be used for the outgoing video for the `RemoteConnection.VideoProvider`.
open Unit	`setDeviceOrientation(rotation: Int)` Sets the device orientation, in degrees, for the `RemoteConnection.VideoProvider`.
open Unit	`setDisplaySurface(surface: Surface!)` Sets the surface to be used for displaying the video received from the remote device for the `RemoteConnection.VideoProvider`.
open Unit	`setPauseImage(uri: Uri!)` Sets the `Uri` of an image to be displayed to the peer device when the video signal is paused, for the `RemoteConnection.VideoProvider`.
open Unit	`setPreviewSurface(surface: Surface!)` Sets the surface to be used for displaying a preview of what the user's camera is currently capturing for the `RemoteConnection.VideoProvider`.
open Unit	`setZoom(value: Float)` Sets camera zoom ratio for the `RemoteConnection.VideoProvider`.
open Unit	`unregisterCallback(l: RemoteConnection.VideoProvider.Callback!)` Clears the video call callback set via `registerCallback`.

Public methods

registerCallback

Added in API level 23

open fun registerCallback(l: RemoteConnection.VideoProvider.Callback!): Unit

Registers a callback to receive commands and state changes for video calls.

Parameters
`l`	RemoteConnection.VideoProvider.Callback!: The video call callback.

requestCallDataUsage

Added in API level 23

open fun requestCallDataUsage(): Unit

Issues a request to retrieve the data usage (in bytes) of the video portion of the RemoteConnection for the RemoteConnection.VideoProvider.

See Also

android.telecom.Connection.VideoProvider#onRequestConnectionDataUsage()

requestCameraCapabilities

Added in API level 23

open fun requestCameraCapabilities(): Unit

Issues a request to retrieve the capabilities of the current camera for the RemoteConnection.VideoProvider.

See Also

android.telecom.Connection.VideoProvider#onRequestCameraCapabilities()

sendSessionModifyRequest

Added in API level 23

open fun sendSessionModifyRequest(
    fromProfile: VideoProfile!, 
    toProfile: VideoProfile!
): Unit

Issues a request to modify the properties of the current video session for the RemoteConnection.VideoProvider.

Parameters
`fromProfile`	VideoProfile!: The video profile prior to the request.
`toProfile`	VideoProfile!: The video profile with the requested changes made.

See Also

android.telecom.Connection.VideoProvider#onSendSessionModifyRequest(VideoProfile, VideoProfile)

sendSessionModifyResponse

Added in API level 23

open fun sendSessionModifyResponse(responseProfile: VideoProfile!): Unit

Provides a response to a request to change the current call video session properties for the RemoteConnection.VideoProvider.

Parameters
`responseProfile`	VideoProfile!: The response call video properties.

See Also

android.telecom.Connection.VideoProvider#onSendSessionModifyResponse(VideoProfile)

setCamera

Added in API level 23

open fun setCamera(cameraId: String!): Unit

Sets the camera to be used for the outgoing video for the RemoteConnection.VideoProvider.

Parameters
`cameraId`	String!: The id of the camera (use ids as reported by `CameraManager.getCameraIdList()`).

See Also

android.telecom.Connection.VideoProvider#onSetCamera(String)

setDeviceOrientation

Added in API level 23

open fun setDeviceOrientation(rotation: Int): Unit

Sets the device orientation, in degrees, for the RemoteConnection.VideoProvider. Assumes that a standard portrait orientation of the device is 0 degrees.

Parameters
`rotation`	Int: The device orientation, in degrees.

See Also

android.telecom.Connection.VideoProvider#onSetDeviceOrientation(int)

setDisplaySurface

Added in API level 23

open fun setDisplaySurface(surface: Surface!): Unit

Sets the surface to be used for displaying the video received from the remote device for the RemoteConnection.VideoProvider.

Parameters
`surface`	Surface!: The `Surface`.

See Also

android.telecom.Connection.VideoProvider#onSetDisplaySurface(Surface)

setPauseImage

Added in API level 23

open fun setPauseImage(uri: Uri!): Unit

Sets the Uri of an image to be displayed to the peer device when the video signal is paused, for the RemoteConnection.VideoProvider.

See Also

android.telecom.Connection.VideoProvider#onSetPauseImage(Uri)

setPreviewSurface

Added in API level 23

open fun setPreviewSurface(surface: Surface!): Unit

Sets the surface to be used for displaying a preview of what the user's camera is currently capturing for the RemoteConnection.VideoProvider.

Parameters
`surface`	Surface!: The `Surface`.

See Also

android.telecom.Connection.VideoProvider#onSetPreviewSurface(Surface)

setZoom

Added in API level 23

open fun setZoom(value: Float): Unit

Sets camera zoom ratio for the RemoteConnection.VideoProvider.

Parameters
`value`	Float: The camera zoom ratio.

See Also

android.telecom.Connection.VideoProvider#onSetZoom(float)

unregisterCallback

Added in API level 23

open fun unregisterCallback(l: RemoteConnection.VideoProvider.Callback!): Unit

Clears the video call callback set via registerCallback.

Parameters
`l`	RemoteConnection.VideoProvider.Callback!: The video call callback to clear.