Transformer: Clarify setResolution javadoc.

This class may be removed soon, but in the meantime clarify this method's
javadoc summary fragment to make it marginally clearer that this only affects
the "displayed" height instead of the "encoded" height.

PiperOrigin-RevId: 501582219
This commit is contained in:
huangdarwin 2023-01-12 17:10:22 +00:00 committed by Rohit Singh
parent 3c4b4729da
commit d300b37a55

View File

@ -215,7 +215,7 @@ public final class TransformationRequest {
}
/**
* Sets the output resolution using the output height.
* Sets the output resolution using the output height of the displayed video.
*
* <p>Output width of the displayed video will scale to preserve the video's aspect ratio after
* other transformations.
@ -226,6 +226,10 @@ public final class TransformationRequest {
* {@linkplain #setScale(float,float) scaling} or @linkplain #setRotationDegrees(float)
* rotation} are requested.
*
* <p>Note that the output encoded video's dimensions may be swapped from the displayed video's
* dimensions, if the displayed video's height > width. This is to improve compatibility among
* different device encoders.
*
* @param outputHeight The output height of the displayed video, in pixels.
* @return This builder.
*/