loliball/media
1
0
Fork 0
mirror of https://github.com/androidx/media.git synced 2025-05-07 07:30:22 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Reformat some javadoc on Cue

Browse Source 
PiperOrigin-RevId: 285964228
This commit is contained in:
ibaker 2019-12-17 13:56:33 +00:00 committed by Oliver Woodman
parent dfc15733d2
commit a035c2e20a
1 changed files with 29 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
library/core/src/main/java/com/google/android/exoplayer2/text/Cue.java
View File

@ -142,23 +142,37 @@ public final class Cue {
* <p>{@link #LINE_TYPE_FRACTION} indicates that {@link #line} is a fractional position within the
* viewport.
*
* <p>{@link #LINE_TYPE_NUMBER} indicates that {@link #line} is a line number, where the size of
* each line is taken to be the size of the first line of the cue. When {@link #line} is greater
* than or equal to 0 lines count from the start of the viewport, with 0 indicating zero offset
* from the start edge. When {@link #line} is negative lines count from the end of the viewport,
* with -1 indicating zero offset from the end edge. For horizontal text the line spacing is the
* height of the first line of the cue, and the start and end of the viewport are the top and
* bottom respectively.
* <ul>
* <li>{@link #LINE_TYPE_FRACTION} indicates that {@link #line} is a fractional position within
* the viewport.
* <li>
* <ul>
* <li>{@link #LINE_TYPE_NUMBER} indicates that {@link #line} is a line number, where the
* size of each line is taken to be the size of the first line of the cue.
* <li>When {@link #line} is greater than or equal to 0 lines count from the start of the
* viewport, with 0 indicating zero offset from the start edge. When {@link #line} is
* negative lines count from the end of the viewport, with -1 indicating zero offset
* from the end edge.
* <li>For horizontal text the line spacing is the height of the first line of the cue,
* and the start and end of the viewport are the top and bottom respectively.
* </ul>
* </ul>
*
* <p>Note that it's particularly important to consider the effect of {@link #lineAnchor} when
* using {@link #LINE_TYPE_NUMBER}. {@code (line == 0 && lineAnchor == ANCHOR_TYPE_START)}
* positions a (potentially multi-line) cue at the very top of the viewport. {@code (line == -1 &&
* lineAnchor == ANCHOR_TYPE_END)} positions a (potentially multi-line) cue at the very bottom of
* the viewport. {@code (line == 0 && lineAnchor == ANCHOR_TYPE_END)} and {@code (line == -1 &&
* lineAnchor == ANCHOR_TYPE_START)} position cues entirely outside of the viewport. {@code (line
* == 1 && lineAnchor == ANCHOR_TYPE_END)} positions a cue so that only the last line is visible
* at the top of the viewport. {@code (line == -2 && lineAnchor == ANCHOR_TYPE_START)} position a
* cue so that only its first line is visible at the bottom of the viewport.
* using {@link #LINE_TYPE_NUMBER}.
*
* <ul>
* <li>{@code (line == 0 && lineAnchor == ANCHOR_TYPE_START)} positions a (potentially
* multi-line) cue at the very start of the viewport.
* <li>{@code (line == -1 && lineAnchor == ANCHOR_TYPE_END)} positions a (potentially
* multi-line) cue at the very end of the viewport.
* <li>{@code (line == 0 && lineAnchor == ANCHOR_TYPE_END)} and {@code (line == -1 && lineAnchor
* == ANCHOR_TYPE_START)} position cues entirely outside of the viewport.
* <li>{@code (line == 1 && lineAnchor == ANCHOR_TYPE_END)} positions a cue so that only the
* last line is visible at the start of the viewport.
* <li>{@code (line == -2 && lineAnchor == ANCHOR_TYPE_START)} position a cue so that only its
* first line is visible at the end of the viewport.
* </ul>
*/
public final @LineType int lineType;