Consolidate method names involving "Frame Rate"
Relnote: "Consolidate the names of all frame rate methods into using 'FrameRate'. Correct the javadoc mistake in `VideoCapture#getTargetFrameRate()`"
Bug: 274817354
Test: N/A
Change-Id: I8330476ec33c05ba85ef10fb127e4fc592bb716d
diff --git a/camera/camera-camera2-pipe-integration/src/main/java/androidx/camera/camera2/pipe/integration/adapter/CameraInfoAdapter.kt b/camera/camera-camera2-pipe-integration/src/main/java/androidx/camera/camera2/pipe/integration/adapter/CameraInfoAdapter.kt
index 048c265..93d90b9 100644
--- a/camera/camera-camera2-pipe-integration/src/main/java/androidx/camera/camera2/pipe/integration/adapter/CameraInfoAdapter.kt
+++ b/camera/camera-camera2-pipe-integration/src/main/java/androidx/camera/camera2/pipe/integration/adapter/CameraInfoAdapter.kt
@@ -171,7 +171,7 @@
override fun isFocusMeteringSupported(action: FocusMeteringAction) =
focusMeteringControl.isFocusMeteringSupported(action)
- override fun getSupportedFpsRanges(): List<Range<Int>> {
+ override fun getSupportedFrameRateRanges(): List<Range<Int>> {
return cameraProperties
.metadata[CameraCharacteristics.CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES]?.toList()
?: listOf()
diff --git a/camera/camera-camera2-pipe-integration/src/test/java/androidx/camera/camera2/pipe/integration/adapter/CameraInfoAdapterTest.kt b/camera/camera-camera2-pipe-integration/src/test/java/androidx/camera/camera2/pipe/integration/adapter/CameraInfoAdapterTest.kt
index c649c6a..4c6fefe 100644
--- a/camera/camera-camera2-pipe-integration/src/test/java/androidx/camera/camera2/pipe/integration/adapter/CameraInfoAdapterTest.kt
+++ b/camera/camera-camera2-pipe-integration/src/test/java/androidx/camera/camera2/pipe/integration/adapter/CameraInfoAdapterTest.kt
@@ -69,7 +69,7 @@
@Test
fun getSupportedFpsRanges() {
// Act.
- val ranges: List<Range<Int>> = cameraInfoAdapter.supportedFpsRanges
+ val ranges: List<Range<Int>> = cameraInfoAdapter.supportedFrameRateRanges
// Assert.
assertThat(ranges).containsExactly(
diff --git a/camera/camera-camera2-pipe-integration/src/test/java/androidx/camera/camera2/pipe/integration/interop/Camera2CameraInfoTest.kt b/camera/camera-camera2-pipe-integration/src/test/java/androidx/camera/camera2/pipe/integration/interop/Camera2CameraInfoTest.kt
index 1ffe0a0..d5105e2 100644
--- a/camera/camera-camera2-pipe-integration/src/test/java/androidx/camera/camera2/pipe/integration/interop/Camera2CameraInfoTest.kt
+++ b/camera/camera-camera2-pipe-integration/src/test/java/androidx/camera/camera2/pipe/integration/interop/Camera2CameraInfoTest.kt
@@ -155,7 +155,7 @@
throw NotImplementedError("Not used in testing")
}
- override fun getSupportedFpsRanges(): MutableList<Range<Int>> {
+ override fun getSupportedFrameRateRanges(): MutableList<Range<Int>> {
throw NotImplementedError("Not used in testing")
}
diff --git a/camera/camera-camera2/src/main/java/androidx/camera/camera2/internal/Camera2CameraInfoImpl.java b/camera/camera-camera2/src/main/java/androidx/camera/camera2/internal/Camera2CameraInfoImpl.java
index d53901a..6b3a5932 100644
--- a/camera/camera-camera2/src/main/java/androidx/camera/camera2/internal/Camera2CameraInfoImpl.java
+++ b/camera/camera-camera2/src/main/java/androidx/camera/camera2/internal/Camera2CameraInfoImpl.java
@@ -493,7 +493,7 @@
@NonNull
@Override
- public List<Range<Integer>> getSupportedFpsRanges() {
+ public List<Range<Integer>> getSupportedFrameRateRanges() {
Range<Integer>[] availableTargetFpsRanges =
mCameraCharacteristicsCompat.get(
CameraCharacteristics.CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES);
diff --git a/camera/camera-camera2/src/main/java/androidx/camera/camera2/internal/SupportedSurfaceCombination.java b/camera/camera-camera2/src/main/java/androidx/camera/camera2/internal/SupportedSurfaceCombination.java
index 5616653..33403aa 100644
--- a/camera/camera-camera2/src/main/java/androidx/camera/camera2/internal/SupportedSurfaceCombination.java
+++ b/camera/camera-camera2/src/main/java/androidx/camera/camera2/internal/SupportedSurfaceCombination.java
@@ -534,7 +534,7 @@
for (Integer index : useCasesPriorityOrder) {
targetFramerateForConfig =
getUpdatedTargetFramerate(
- newUseCaseConfigs.get(index).getTargetFramerate(null),
+ newUseCaseConfigs.get(index).getTargetFrameRate(null),
targetFramerateForConfig);
}
diff --git a/camera/camera-camera2/src/test/java/androidx/camera/camera2/internal/Camera2CameraInfoImplTest.java b/camera/camera-camera2/src/test/java/androidx/camera/camera2/internal/Camera2CameraInfoImplTest.java
index 235acef..669bd43 100644
--- a/camera/camera-camera2/src/test/java/androidx/camera/camera2/internal/Camera2CameraInfoImplTest.java
+++ b/camera/camera-camera2/src/test/java/androidx/camera/camera2/internal/Camera2CameraInfoImplTest.java
@@ -666,8 +666,8 @@
final Camera2CameraInfoImpl cameraInfo2 = new Camera2CameraInfoImpl(CAMERA2_ID,
mCameraManagerCompat);
- List<Range<Integer>> resultFpsRanges0 = cameraInfo0.getSupportedFpsRanges();
- List<Range<Integer>> resultFpsRanges2 = cameraInfo2.getSupportedFpsRanges();
+ List<Range<Integer>> resultFpsRanges0 = cameraInfo0.getSupportedFrameRateRanges();
+ List<Range<Integer>> resultFpsRanges2 = cameraInfo2.getSupportedFrameRateRanges();
assertThat(resultFpsRanges0).containsExactly((Object[]) CAMERA0_AE_FPS_RANGES);
assertThat(resultFpsRanges2).containsExactly((Object[]) CAMERA2_AE_FPS_RANGES);
@@ -681,7 +681,7 @@
final Camera2CameraInfoImpl cameraInfo1 = new Camera2CameraInfoImpl(CAMERA1_ID,
mCameraManagerCompat);
- List<Range<Integer>> resultFpsRanges1 = cameraInfo1.getSupportedFpsRanges();
+ List<Range<Integer>> resultFpsRanges1 = cameraInfo1.getSupportedFrameRateRanges();
assertThat(resultFpsRanges1).isEmpty();
}
diff --git a/camera/camera-core/src/main/java/androidx/camera/core/UseCase.java b/camera/camera-core/src/main/java/androidx/camera/core/UseCase.java
index 0aa20f0..e966604 100644
--- a/camera/camera-core/src/main/java/androidx/camera/core/UseCase.java
+++ b/camera/camera-core/src/main/java/androidx/camera/core/UseCase.java
@@ -361,8 +361,8 @@
*/
@NonNull
@RestrictTo(Scope.LIBRARY_GROUP)
- protected Range<Integer> getTargetFramerateInternal() {
- return mCurrentConfig.getTargetFramerate(FRAME_RATE_RANGE_UNSPECIFIED);
+ protected Range<Integer> getTargetFrameRateInternal() {
+ return mCurrentConfig.getTargetFrameRate(FRAME_RATE_RANGE_UNSPECIFIED);
}
/**
diff --git a/camera/camera-core/src/main/java/androidx/camera/core/impl/CameraInfoInternal.java b/camera/camera-core/src/main/java/androidx/camera/core/impl/CameraInfoInternal.java
index 84beaf0..16ffabc 100644
--- a/camera/camera-core/src/main/java/androidx/camera/core/impl/CameraInfoInternal.java
+++ b/camera/camera-core/src/main/java/androidx/camera/core/impl/CameraInfoInternal.java
@@ -69,15 +69,15 @@
Quirks getCameraQuirks();
/**
- * Returns a list of the FPS ranges supported by this device's AE algorithm.
+ * Returns a list of the frame rate ranges supported by this device's AE algorithm.
*
- * <p>These are the FPS ranges that the AE algorithm on the device can support. There is no
- * guarantee that these ranges will work for every size surface or combination of use cases.
+ * <p>These are the frame rate ranges that the AE algorithm on the device can support. There is
+ * no guarantee that these ranges will work for every size surface or combination of use cases.
*
- * @return The list of FPS ranges supported by the device's AE algorithm
+ * @return The list of frame rate ranges supported by the device's AE algorithm
*/
@NonNull
- List<Range<Integer>> getSupportedFpsRanges();
+ List<Range<Integer>> getSupportedFrameRateRanges();
/** Returns the {@link EncoderProfilesProvider} associated with this camera. */
@NonNull
diff --git a/camera/camera-core/src/main/java/androidx/camera/core/impl/UseCaseConfig.java b/camera/camera-core/src/main/java/androidx/camera/core/impl/UseCaseConfig.java
index 5638803..43d3f9e 100644
--- a/camera/camera-core/src/main/java/androidx/camera/core/impl/UseCaseConfig.java
+++ b/camera/camera-core/src/main/java/androidx/camera/core/impl/UseCaseConfig.java
@@ -276,7 +276,7 @@
* this configuration
*/
@Nullable
- default Range<Integer> getTargetFramerate(@Nullable Range<Integer> valueIfMissing) {
+ default Range<Integer> getTargetFrameRate(@Nullable Range<Integer> valueIfMissing) {
return retrieveOption(OPTION_TARGET_FRAME_RATE, valueIfMissing);
}
@@ -287,7 +287,7 @@
* @throws IllegalArgumentException if the option does not exist in this configuration.
*/
@NonNull
- default Range<Integer> getTargetFramerate() {
+ default Range<Integer> getTargetFrameRate() {
return retrieveOption(OPTION_TARGET_FRAME_RATE);
}
diff --git a/camera/camera-core/src/main/java/androidx/camera/core/internal/CameraUseCaseAdapter.java b/camera/camera-core/src/main/java/androidx/camera/core/internal/CameraUseCaseAdapter.java
index 82e13d9..7e4a9a5 100644
--- a/camera/camera-core/src/main/java/androidx/camera/core/internal/CameraUseCaseAdapter.java
+++ b/camera/camera-core/src/main/java/androidx/camera/core/internal/CameraUseCaseAdapter.java
@@ -592,7 +592,7 @@
useCase.getAttachedSurfaceResolution());
existingSurfaces.add(AttachedSurfaceInfo.create(surfaceConfig,
useCase.getImageFormat(), useCase.getAttachedSurfaceResolution(),
- useCase.getCurrentConfig().getTargetFramerate(null)));
+ useCase.getCurrentConfig().getTargetFrameRate(null)));
suggestedStreamSpecs.put(useCase, useCase.getAttachedStreamSpec());
}
diff --git a/camera/camera-core/src/test/java/androidx/camera/core/impl/UseCaseConfigTest.kt b/camera/camera-core/src/test/java/androidx/camera/core/impl/UseCaseConfigTest.kt
index e16a21e..778fbfc 100644
--- a/camera/camera-core/src/test/java/androidx/camera/core/impl/UseCaseConfigTest.kt
+++ b/camera/camera-core/src/test/java/androidx/camera/core/impl/UseCaseConfigTest.kt
@@ -36,7 +36,7 @@
val useCaseBuilder = FakeUseCaseConfig.Builder()
val range = Range(10, 20)
useCaseBuilder.mutableConfig.insertOption(UseCaseConfig.OPTION_TARGET_FRAME_RATE, range)
- Truth.assertThat(useCaseBuilder.useCaseConfig.targetFramerate).isEqualTo(range)
+ Truth.assertThat(useCaseBuilder.useCaseConfig.targetFrameRate).isEqualTo(range)
}
@Test
diff --git a/camera/camera-testing/src/main/java/androidx/camera/testing/fakes/FakeCameraInfoInternal.java b/camera/camera-testing/src/main/java/androidx/camera/testing/fakes/FakeCameraInfoInternal.java
index 41abf57..2780a97 100644
--- a/camera/camera-testing/src/main/java/androidx/camera/testing/fakes/FakeCameraInfoInternal.java
+++ b/camera/camera-testing/src/main/java/androidx/camera/testing/fakes/FakeCameraInfoInternal.java
@@ -239,7 +239,7 @@
@NonNull
@Override
- public List<Range<Integer>> getSupportedFpsRanges() {
+ public List<Range<Integer>> getSupportedFrameRateRanges() {
return FAKE_FPS_RANGES;
}
diff --git a/camera/camera-testing/src/test/java/androidx/camera/testing/fakes/FakeCameraInfoTest.java b/camera/camera-testing/src/test/java/androidx/camera/testing/fakes/FakeCameraInfoTest.java
index 7855897..f232a73 100644
--- a/camera/camera-testing/src/test/java/androidx/camera/testing/fakes/FakeCameraInfoTest.java
+++ b/camera/camera-testing/src/test/java/androidx/camera/testing/fakes/FakeCameraInfoTest.java
@@ -76,7 +76,7 @@
@Test
public void canRetrieveSupportedFpsRanges() {
- assertThat(mFakeCameraInfo.getSupportedFpsRanges()).isNotEmpty();
+ assertThat(mFakeCameraInfo.getSupportedFrameRateRanges()).isNotEmpty();
}
diff --git a/camera/camera-video/api/current.txt b/camera/camera-video/api/current.txt
index 48dccc9..7611bce 100644
--- a/camera/camera-video/api/current.txt
+++ b/camera/camera-video/api/current.txt
@@ -136,7 +136,7 @@
@RequiresApi(21) public final class VideoCapture<T extends androidx.camera.video.VideoOutput> extends androidx.camera.core.UseCase {
method public int getMirrorMode();
method public T getOutput();
- method public android.util.Range<java.lang.Integer!> getTargetFramerate();
+ method public android.util.Range<java.lang.Integer!> getTargetFrameRate();
method public int getTargetRotation();
method public void setTargetRotation(int);
method public void setTargetRotationDegrees(int);
@@ -147,7 +147,7 @@
ctor public VideoCapture.Builder(T);
method public androidx.camera.video.VideoCapture<T!> build();
method public androidx.camera.video.VideoCapture.Builder<T!> setMirrorMode(int);
- method public androidx.camera.video.VideoCapture.Builder<T!> setTargetFramerate(android.util.Range<java.lang.Integer!>);
+ method public androidx.camera.video.VideoCapture.Builder<T!> setTargetFrameRate(android.util.Range<java.lang.Integer!>);
method public androidx.camera.video.VideoCapture.Builder<T!> setTargetRotation(int);
}
diff --git a/camera/camera-video/api/public_plus_experimental_current.txt b/camera/camera-video/api/public_plus_experimental_current.txt
index 48dccc9..7611bce 100644
--- a/camera/camera-video/api/public_plus_experimental_current.txt
+++ b/camera/camera-video/api/public_plus_experimental_current.txt
@@ -136,7 +136,7 @@
@RequiresApi(21) public final class VideoCapture<T extends androidx.camera.video.VideoOutput> extends androidx.camera.core.UseCase {
method public int getMirrorMode();
method public T getOutput();
- method public android.util.Range<java.lang.Integer!> getTargetFramerate();
+ method public android.util.Range<java.lang.Integer!> getTargetFrameRate();
method public int getTargetRotation();
method public void setTargetRotation(int);
method public void setTargetRotationDegrees(int);
@@ -147,7 +147,7 @@
ctor public VideoCapture.Builder(T);
method public androidx.camera.video.VideoCapture<T!> build();
method public androidx.camera.video.VideoCapture.Builder<T!> setMirrorMode(int);
- method public androidx.camera.video.VideoCapture.Builder<T!> setTargetFramerate(android.util.Range<java.lang.Integer!>);
+ method public androidx.camera.video.VideoCapture.Builder<T!> setTargetFrameRate(android.util.Range<java.lang.Integer!>);
method public androidx.camera.video.VideoCapture.Builder<T!> setTargetRotation(int);
}
diff --git a/camera/camera-video/api/restricted_current.txt b/camera/camera-video/api/restricted_current.txt
index 48dccc9..7611bce 100644
--- a/camera/camera-video/api/restricted_current.txt
+++ b/camera/camera-video/api/restricted_current.txt
@@ -136,7 +136,7 @@
@RequiresApi(21) public final class VideoCapture<T extends androidx.camera.video.VideoOutput> extends androidx.camera.core.UseCase {
method public int getMirrorMode();
method public T getOutput();
- method public android.util.Range<java.lang.Integer!> getTargetFramerate();
+ method public android.util.Range<java.lang.Integer!> getTargetFrameRate();
method public int getTargetRotation();
method public void setTargetRotation(int);
method public void setTargetRotationDegrees(int);
@@ -147,7 +147,7 @@
ctor public VideoCapture.Builder(T);
method public androidx.camera.video.VideoCapture<T!> build();
method public androidx.camera.video.VideoCapture.Builder<T!> setMirrorMode(int);
- method public androidx.camera.video.VideoCapture.Builder<T!> setTargetFramerate(android.util.Range<java.lang.Integer!>);
+ method public androidx.camera.video.VideoCapture.Builder<T!> setTargetFrameRate(android.util.Range<java.lang.Integer!>);
method public androidx.camera.video.VideoCapture.Builder<T!> setTargetRotation(int);
}
diff --git a/camera/camera-video/src/main/java/androidx/camera/video/VideoCapture.java b/camera/camera-video/src/main/java/androidx/camera/video/VideoCapture.java
index 8954562..007e45d 100644
--- a/camera/camera-video/src/main/java/androidx/camera/video/VideoCapture.java
+++ b/camera/camera-video/src/main/java/androidx/camera/video/VideoCapture.java
@@ -255,18 +255,19 @@
}
/**
- * Returns the target frame rate range for the associated VideoCapture use case.
+ * Returns the target frame rate range, in frames per second, for the associated VideoCapture
+ * use case.
*
- * <p>The rotation can be set prior to constructing a VideoCapture using
- * {@link VideoCapture.Builder#setTargetFramerate(Range)}
+ * <p>The target frame rate can be set prior to constructing a VideoCapture using
+ * {@link VideoCapture.Builder#setTargetFrameRate(Range)}
* If not set, the target frame rate defaults to the value of
* {@link StreamSpec#FRAME_RATE_RANGE_UNSPECIFIED}
*
- * @return The rotation of the intended target.
+ * @return The target frame rate of the intended target.
*/
@NonNull
- public Range<Integer> getTargetFramerate() {
- return getTargetFramerateInternal();
+ public Range<Integer> getTargetFrameRate() {
+ return getTargetFrameRateInternal();
}
/**
@@ -572,7 +573,7 @@
// than what is requested in the config. For now we use the default range of (30, 30)
// for behavioral consistency.
Range<Integer> targetFpsRange = requireNonNull(
- config.getTargetFramerate(Defaults.DEFAULT_FPS_RANGE));
+ config.getTargetFrameRate(Defaults.DEFAULT_FPS_RANGE));
MediaSpec mediaSpec = requireNonNull(getMediaSpec());
LegacyVideoCapabilities videoCapabilities = LegacyVideoCapabilities.from(
camera.getCameraInfo());
@@ -1637,7 +1638,8 @@
}
/**
- * Sets the target frame rate range for the associated VideoCapture use case.
+ * Sets the target frame rate range in frames per second for the associated VideoCapture
+ * use case.
*
* <p>This target will be used as a part of the heuristics for the algorithm that determines
* the final frame rate range and resolution of all concurrently bound use cases.
@@ -1648,7 +1650,7 @@
* @param targetFrameRate the target frame rate range.
*/
@NonNull
- public Builder<T> setTargetFramerate(@NonNull Range<Integer> targetFrameRate) {
+ public Builder<T> setTargetFrameRate(@NonNull Range<Integer> targetFrameRate) {
getMutableConfig().insertOption(OPTION_TARGET_FRAME_RATE, targetFrameRate);
return this;
}
