Added in API level 23

Summary: Nested Classes | Ctors | Methods | Inherited Methods

InCallService.VideoCall

Kotlin |Java

public static abstract class InCallService.VideoCall
extends Object

java.lang.Object
↳	android.telecom.InCallService.VideoCall

Used to issue commands to the Connection.VideoProvider associated with a Call.

Summary

Nested classes
`class`	`InCallService.VideoCall.Callback` The `InCallService` extends this class to provide a means of receiving callbacks from the `Connection.VideoProvider`.

Public constructors
`VideoCall()`

Public methods
`abstract void`	`registerCallback(InCallService.VideoCall.Callback callback, Handler handler)` Registers a callback to receive commands and state changes for video calls.
`abstract void`	`registerCallback(InCallService.VideoCall.Callback callback)` Registers a callback to receive commands and state changes for video calls.
`abstract void`	`requestCallDataUsage()` Issues a request to the `Connection.VideoProvider` to retrieve the cumulative data usage for the video component of the current call (in bytes).
`abstract void`	`requestCameraCapabilities()` Issues a request to the `Connection.VideoProvider` to retrieve the capabilities of the current camera.
`abstract void`	`sendSessionModifyRequest(VideoProfile requestProfile)` Issues a request to modify the properties of the current video session.
`abstract void`	`sendSessionModifyResponse(VideoProfile responseProfile)` Provides a response to a request to change the current call video session properties.
`abstract void`	`setCamera(String cameraId)` Sets the camera to be used for the outgoing video.
`abstract void`	`setDeviceOrientation(int rotation)` Sets the device orientation, in degrees.
`abstract void`	`setDisplaySurface(Surface surface)` Sets the surface to be used for displaying the video received from the remote device.
`abstract void`	`setPauseImage(Uri uri)` Provides the `Connection.VideoProvider` with the `Uri` of an image to be displayed to the peer device when the video signal is paused.
`abstract void`	`setPreviewSurface(Surface surface)` Sets the surface to be used for displaying a preview of what the user's camera is currently capturing.
`abstract void`	`setZoom(float value)` Sets the camera zoom ratio.
`abstract void`	`unregisterCallback(InCallService.VideoCall.Callback callback)` Clears the video call callback set via `registerCallback(Callback)`.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

VideoCall

public VideoCall ()

Public methods

registerCallback

Added in API level 23

public abstract void registerCallback (InCallService.VideoCall.Callback callback, 
                Handler handler)

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

Parameters
`callback`	`InCallService.VideoCall.Callback`: The video call callback.
`handler`	`Handler`: A handler which commands and status changes will be delivered to.

registerCallback

Added in API level 23

public abstract void registerCallback (InCallService.VideoCall.Callback callback)

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

Parameters
`callback`	`InCallService.VideoCall.Callback`: The video call callback.

requestCallDataUsage

Added in API level 23

public abstract void requestCallDataUsage ()

Issues a request to the Connection.VideoProvider to retrieve the cumulative data usage for the video component of the current call (in bytes). Data usage is reported to the caller via InCallService.VideoCall.Callback.onCallDataUsageChanged(long).

Handled by Connection.VideoProvider#onRequestConnectionDataUsage().

requestCameraCapabilities

Added in API level 23

public abstract void requestCameraCapabilities ()

Issues a request to the Connection.VideoProvider to retrieve the capabilities of the current camera. The current camera is selected using VideoCall#setCamera(String).

Camera capabilities are reported to the caller via InCallService.VideoCall.Callback.onCameraCapabilitiesChanged(VideoProfile.CameraCapabilities).

Handled by Connection.VideoProvider#onRequestCameraCapabilities().

sendSessionModifyRequest

Added in API level 23

public abstract void sendSessionModifyRequest (VideoProfile requestProfile)

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

Example scenarios include: requesting an audio-only call to be upgraded to a bi-directional video call, turning on or off the user's camera, sending a pause signal when the InCallService is no longer the foreground application.

Handled by Connection.VideoProvider#onSendSessionModifyRequest(VideoProfile, VideoProfile).

Parameters
`requestProfile`	`VideoProfile`: The requested call video properties.

sendSessionModifyResponse

Added in API level 23

public abstract void sendSessionModifyResponse (VideoProfile responseProfile)

Provides a response to a request to change the current call video session properties. This should be called in response to a request the InCallService has received via InCallService.VideoCall.Callback.onSessionModifyRequestReceived(VideoProfile).

Handled by Connection.VideoProvider#onSendSessionModifyResponse(VideoProfile).

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

setCamera

Added in API level 23

public abstract void setCamera (String cameraId)

Sets the camera to be used for the outgoing video.

Handled by Connection.VideoProvider#onSetCamera(String).

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

setDeviceOrientation

Added in API level 23

public abstract void setDeviceOrientation (int rotation)

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

Handled by Connection.VideoProvider#onSetDeviceOrientation(int).

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

setDisplaySurface

Added in API level 23

public abstract void setDisplaySurface (Surface surface)

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

Handled by Connection.VideoProvider#onSetDisplaySurface(Surface).

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

setPauseImage

Added in API level 23

public abstract void setPauseImage (Uri uri)

Provides the Connection.VideoProvider with the Uri of an image to be displayed to the peer device when the video signal is paused.

Handled by Connection.VideoProvider#onSetPauseImage(Uri).

Parameters
`uri`	`Uri`: URI of image to display.

setPreviewSurface

Added in API level 23

public abstract void setPreviewSurface (Surface surface)

Sets the surface to be used for displaying a preview of what the user's camera is currently capturing. When video transmission is enabled, this is the video signal which is sent to the remote device.

Handled by Connection.VideoProvider#onSetPreviewSurface(Surface).

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

setZoom

Added in API level 23

public abstract void setZoom (float value)

Sets the camera zoom ratio.

Handled by Connection.VideoProvider#onSetZoom(float).

Parameters
`value`	`float`: The camera zoom ratio; for the current camera, should be a value in the range defined by `CameraCharacteristics.CONTROL_ZOOM_RATIO_RANGE`.

unregisterCallback

Added in API level 23

public abstract void unregisterCallback (InCallService.VideoCall.Callback callback)

Clears the video call callback set via registerCallback(Callback).

Parameters
`callback`	`InCallService.VideoCall.Callback`: The video call callback to clear.

InCallService.VideoCall

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

VideoCall

Public methods

registerCallback

registerCallback

requestCallDataUsage

requestCameraCapabilities

sendSessionModifyRequest

sendSessionModifyResponse

setCamera

setDeviceOrientation

setDisplaySurface

setPauseImage

setPreviewSurface

setZoom

unregisterCallback