Android APIs
public static abstract class

InCallService.VideoCall

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

Class Overview

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
InCallService.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 camera zoom ratio.
abstract void unregisterCallback(InCallService.VideoCall.Callback callback)
Clears the video call callback set via registerCallback(InCallService.VideoCall.Callback).
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public InCallService.VideoCall ()

Added in API level 23

Public Methods

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

Added in API level 23

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

Parameters
callback The video call callback.
handler A handler which commands and status changes will be delivered to.

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

Added in API level 23

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

Parameters
callback The video call callback.

public abstract void requestCallDataUsage ()

Added in API level 23

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 onCallDataUsageChanged(long).

Handled by onRequestConnectionDataUsage().

public abstract void requestCameraCapabilities ()

Added in API level 23

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

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

Handled by onRequestCameraCapabilities().

public abstract void sendSessionModifyRequest (VideoProfile requestProfile)

Added in API level 23

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 onSendSessionModifyRequest(VideoProfile, VideoProfile).

Parameters
requestProfile The requested call video properties.

public abstract void sendSessionModifyResponse (VideoProfile responseProfile)

Added in API level 23

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 onSessionModifyRequestReceived(VideoProfile).

Handled by onSendSessionModifyResponse(VideoProfile).

Parameters
responseProfile The response call video properties.

public abstract void setCamera (String cameraId)

Added in API level 23

Sets the camera to be used for the outgoing video.

Handled by onSetCamera(String).

Parameters
cameraId The id of the camera (use ids as reported by getCameraIdList()).

public abstract void setDeviceOrientation (int rotation)

Added in API level 23

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

Handled by onSetDeviceOrientation(int).

Parameters
rotation The device orientation, in degrees.

public abstract void setDisplaySurface (Surface surface)

Added in API level 23

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

Handled by onSetDisplaySurface(Surface).

Parameters
surface The Surface.

public abstract void setPauseImage (Uri uri)

Added in API level 23

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 onSetPauseImage(Uri).

Parameters
uri URI of image to display.

public abstract void setPreviewSurface (Surface surface)

Added in API level 23

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 onSetPreviewSurface(Surface).

Parameters
surface The Surface.

public abstract void setZoom (float value)

Added in API level 23

Sets camera zoom ratio.

Handled by onSetZoom(float).

Parameters
value The camera zoom ratio.

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

Added in API level 23

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

Parameters
callback The video call callback to clear.