mirror of
https://github.com/androidx/media.git
synced 2025-05-17 12:39:52 +08:00
Expand Cue.line and Cue.position javadoc to cover vertical text
PiperOrigin-RevId: 304164078
This commit is contained in:
parent
76358d983f
commit
8cb7907e71
@ -145,11 +145,19 @@ public final class Cue {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The position of the {@link #lineAnchor} of the cue box within the viewport in the direction
|
* The position of the {@link #lineAnchor} of the cue box within the viewport in the direction
|
||||||
* orthogonal to the writing direction, or {@link #DIMEN_UNSET}. When set, the interpretation of
|
* orthogonal to the writing direction (determined by {@link #verticalType}), or {@link
|
||||||
* the value depends on the value of {@link #lineType}.
|
* #DIMEN_UNSET}. When set, the interpretation of the value depends on the value of {@link
|
||||||
* <p>
|
* #lineType}.
|
||||||
* For horizontal text and {@link #lineType} equal to {@link #LINE_TYPE_FRACTION}, this is the
|
*
|
||||||
* fractional vertical position relative to the top of the viewport.
|
* <p>The measurement direction depends on {@link #verticalType}:
|
||||||
|
*
|
||||||
|
* <ul>
|
||||||
|
* <li>For {@link #TYPE_UNSET} (i.e. horizontal), this is the vertical position relative to the
|
||||||
|
* top of the viewport.
|
||||||
|
* <li>For {@link #VERTICAL_TYPE_LR} and {@link #VERTICAL_TYPE_RL} (i.e. vertical), this is the
|
||||||
|
* horizontal position relative to the left of the viewport. Note that positioning is
|
||||||
|
* relative to the left of the viewport even in the case of vertical-growing-left text.
|
||||||
|
* </ul>
|
||||||
*/
|
*/
|
||||||
public final float line;
|
public final float line;
|
||||||
|
|
||||||
@ -202,10 +210,16 @@ public final class Cue {
|
|||||||
/**
|
/**
|
||||||
* The fractional position of the {@link #positionAnchor} of the cue box within the viewport in
|
* The fractional position of the {@link #positionAnchor} of the cue box within the viewport in
|
||||||
* the direction orthogonal to {@link #line}, or {@link #DIMEN_UNSET}.
|
* the direction orthogonal to {@link #line}, or {@link #DIMEN_UNSET}.
|
||||||
* <p>
|
*
|
||||||
* For horizontal text, this is the horizontal position relative to the left of the viewport. Note
|
* <p>The measurement direction depends on {@link #verticalType}.
|
||||||
* that positioning is relative to the left of the viewport even in the case of right-to-left
|
*
|
||||||
* text.
|
* <ul>
|
||||||
|
* <li>For {@link #TYPE_UNSET} (i.e. horizontal), this is the horizontal position relative to
|
||||||
|
* the left of the viewport. Note that positioning is relative to the left of the viewport
|
||||||
|
* even in the case of right-to-left text.
|
||||||
|
* <li>For {@link #VERTICAL_TYPE_LR} and {@link #VERTICAL_TYPE_RL} (i.e. vertical), this is the
|
||||||
|
* vertical position relative to the top of the viewport.
|
||||||
|
* </ul>
|
||||||
*/
|
*/
|
||||||
public final float position;
|
public final float position;
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user