Clarify the video API "setZoom" ratio.

This should ideally be a valid in terms of the reported camera
characteristics.

Test: Docs only change
Bug: 190804553
Change-Id: I35e0148e6e9d90d991b556e5c6db4bbd77ce39a0
This commit is contained in:
Tyler Gunn
2021-06-14 17:24:40 -07:00
parent e5facf4298
commit c603b46215
2 changed files with 8 additions and 4 deletions

View File

@@ -1718,11 +1718,13 @@ public abstract class Connection extends Conferenceable {
public abstract void onSetDeviceOrientation(int rotation);
/**
* Sets camera zoom ratio.
* Sets the camera zoom ratio.
* <p>
* Sent from the {@link InCallService} via {@link InCallService.VideoCall#setZoom(float)}.
*
* @param value The camera zoom ratio.
* @param value The camera zoom ratio; for the current camera, should be a value in the
* range defined by
* {@link android.hardware.camera2.CameraCharacteristics#CONTROL_ZOOM_RATIO_RANGE}.
*/
public abstract void onSetZoom(float value);

View File

@@ -764,11 +764,13 @@ public abstract class InCallService extends Service {
public abstract void setDeviceOrientation(int rotation);
/**
* Sets camera zoom ratio.
* Sets the camera zoom ratio.
* <p>
* Handled by {@link Connection.VideoProvider#onSetZoom(float)}.
*
* @param value The camera zoom ratio.
* @param value The camera zoom ratio; for the current camera, should be a value in the
* range defined by
* {@link android.hardware.camera2.CameraCharacteristics#CONTROL_ZOOM_RATIO_RANGE}.
*/
public abstract void setZoom(float value);