diff options
| author | 2021-06-14 17:24:40 -0700 | |
|---|---|---|
| committer | 2021-06-14 17:24:40 -0700 | |
| commit | c603b462152fd8a8d6291c1a58d2b41e052eb854 (patch) | |
| tree | f3814d498eb74b912cebccd68068764af6c61f52 | |
| parent | e5facf4298ff7c9c00f30920387dc46c5985bd31 (diff) | |
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
| -rw-r--r-- | telecomm/java/android/telecom/Connection.java | 6 | ||||
| -rw-r--r-- | telecomm/java/android/telecom/InCallService.java | 6 |
2 files changed, 8 insertions, 4 deletions
diff --git a/telecomm/java/android/telecom/Connection.java b/telecomm/java/android/telecom/Connection.java index ae5db3dfd4e4..52d560cbf733 100644 --- a/telecomm/java/android/telecom/Connection.java +++ b/telecomm/java/android/telecom/Connection.java @@ -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); diff --git a/telecomm/java/android/telecom/InCallService.java b/telecomm/java/android/telecom/InCallService.java index 0ff288b1ac63..5e3d26a5179d 100644 --- a/telecomm/java/android/telecom/InCallService.java +++ b/telecomm/java/android/telecom/InCallService.java @@ -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); |