sjs/media
1
0
Fork 0
mirror of https://github.com/samsonjs/media.git synced 2026-03-27 09:45:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
media/docs/doc/reference/com/google/android/exoplayer2/text/Cue.html
andrewlewis 517e590967 Move docs to correct folder for GitHub Pages
2021-04-21 11:00:57 +01:00

1182 lines
65 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head><!-- start favicons snippet, use https://realfavicongenerator.net/ --><link rel="apple-touch-icon" sizes="180x180" href="/assets/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png"><link rel="manifest" href="/assets/site.webmanifest"><link rel="mask-icon" href="/assets/safari-pinned-tab.svg" color="#fc4d50"><link rel="shortcut icon" href="/assets/favicon.ico"><meta name="msapplication-TileColor" content="#ffc40d"><meta name="msapplication-config" content="/assets/browserconfig.xml"><meta name="theme-color" content="#ffffff"><!-- end favicons snippet -->
<title>Cue (ExoPlayer library)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-1.10.2.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Cue (ExoPlayer library)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/google/android/exoplayer2/text/CaptionStyleCompat.EdgeType.html" title="annotation in com.google.android.exoplayer2.text"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/android/exoplayer2/text/Cue.html" target="_top">Frames</a></li>
<li><a href="Cue.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="../../../../../com/google/android/exoplayer2/text/package-summary.html">com.google.android.exoplayer2.text</a></div>
<h2 title="Class Cue" class="title">Class Cue</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://developer.android.com/reference/java/lang/Object.html" title="class or interface in java.lang" class="externalLink" target="_top">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.google.android.exoplayer2.text.Cue</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">Cue</span>
extends <a href="https://developer.android.com/reference/java/lang/Object.html" title="class or interface in java.lang" class="externalLink" target="_top">Object</a></pre>
<div class="block">Contains information about a specific cue, including textual content and formatting data.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text">Cue.AnchorType</a></span></code></th>
<td class="colLast">
<div class="block">The type of anchor, which may be unset.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text">Cue.Builder</a></span></code></th>
<td class="colLast">
<div class="block">A builder for <a href="../../../../../com/google/android/exoplayer2/text/Cue.html" title="class in com.google.android.exoplayer2.text"><code>Cue</code></a> objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.LineType.html" title="annotation in com.google.android.exoplayer2.text">Cue.LineType</a></span></code></th>
<td class="colLast">
<div class="block">The type of line, which may be unset.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.TextSizeType.html" title="annotation in com.google.android.exoplayer2.text">Cue.TextSizeType</a></span></code></th>
<td class="colLast">
<div class="block">The type of default text size for this cue, which may be unset.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.VerticalType.html" title="annotation in com.google.android.exoplayer2.text">Cue.VerticalType</a></span></code></th>
<td class="colLast">
<div class="block">The type of vertical layout for this cue, which may be unset (i.e.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_END">ANCHOR_TYPE_END</a></span></code></th>
<td class="colLast">
<div class="block">Anchors the right (for horizontal positions) or bottom (for vertical positions) edge of the cue
box.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_MIDDLE">ANCHOR_TYPE_MIDDLE</a></span></code></th>
<td class="colLast">
<div class="block">Anchors the middle of the cue box.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_START">ANCHOR_TYPE_START</a></span></code></th>
<td class="colLast">
<div class="block">Anchors the left (for horizontal positions) or top (for vertical positions) edge of the cue
box.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://developer.android.com/reference/android/graphics/Bitmap.html" title="class or interface in android.graphics" class="externalLink" target="_top">Bitmap</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#bitmap">bitmap</a></span></code></th>
<td class="colLast">
<div class="block">The cue image, or null if this is a text cue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#bitmapHeight">bitmapHeight</a></span></code></th>
<td class="colLast">
<div class="block">The bitmap height as a fraction of the of the viewport size, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a> if the
bitmap should be displayed at its natural height given the bitmap dimensions and the specified
<a href="../../../../../com/google/android/exoplayer2/text/Cue.html#size"><code>size</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET">DIMEN_UNSET</a></span></code></th>
<td class="colLast">
<div class="block">An unset position, width or size.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../com/google/android/exoplayer2/text/Cue.html" title="class in com.google.android.exoplayer2.text">Cue</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#EMPTY">EMPTY</a></span></code></th>
<td class="colLast">
<div class="block">The empty cue.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line">line</a></span></code></th>
<td class="colLast">
<div class="block">The position of the cue box within the viewport in the direction orthogonal to the writing
direction (determined by <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#verticalType"><code>verticalType</code></a>), or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#LINE_TYPE_FRACTION">LINE_TYPE_FRACTION</a></span></code></th>
<td class="colLast">
<div class="block">Value for <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a> when <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> is a fractional position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#LINE_TYPE_NUMBER">LINE_TYPE_NUMBER</a></span></code></th>
<td class="colLast">
<div class="block">Value for <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a> when <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> is a line number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineAnchor">lineAnchor</a></span></code></th>
<td class="colLast">
<div class="block">The cue box anchor positioned by <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> when <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a> is <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#LINE_TYPE_FRACTION"><code>LINE_TYPE_FRACTION</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType">lineType</a></span></code></th>
<td class="colLast">
<div class="block">The type of the <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#position">position</a></span></code></th>
<td class="colLast">
<div class="block">The fractional position of the <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#positionAnchor"><code>positionAnchor</code></a> of the cue box within the viewport in
the direction orthogonal to <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a>, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#positionAnchor">positionAnchor</a></span></code></th>
<td class="colLast">
<div class="block">The cue box anchor positioned by <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#position"><code>position</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#shearDegrees">shearDegrees</a></span></code></th>
<td class="colLast">
<div class="block">The shear angle in degrees to be applied to this Cue, expressed in graphics coordinates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#size">size</a></span></code></th>
<td class="colLast">
<div class="block">The size of the cue box in the writing direction specified as a fraction of the viewport size
in that direction, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#text">text</a></span></code></th>
<td class="colLast">
<div class="block">The cue text, or null if this is an image cue.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TEXT_SIZE_TYPE_ABSOLUTE">TEXT_SIZE_TYPE_ABSOLUTE</a></span></code></th>
<td class="colLast">
<div class="block">Text size is measured in number of pixels.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TEXT_SIZE_TYPE_FRACTIONAL">TEXT_SIZE_TYPE_FRACTIONAL</a></span></code></th>
<td class="colLast">
<div class="block">Text size is measured as a fraction of the viewport size minus the view padding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING">TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING</a></span></code></th>
<td class="colLast">
<div class="block">Text size is measured as a fraction of the viewport size, ignoring the view padding</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://developer.android.com/reference/android/text/Layout.Alignment.html" title="class or interface in android.text" class="externalLink" target="_top">Layout.Alignment</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#textAlignment">textAlignment</a></span></code></th>
<td class="colLast">
<div class="block">The alignment of the cue text within the cue box, or null if the alignment is undefined.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#textSize">textSize</a></span></code></th>
<td class="colLast">
<div class="block">The default text size for this cue's text, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a> if this cue has no default
text size.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#textSizeType">textSizeType</a></span></code></th>
<td class="colLast">
<div class="block">The default text size type for this cue's text, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET"><code>TYPE_UNSET</code></a> if this cue has no
default text size.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET">TYPE_UNSET</a></span></code></th>
<td class="colLast">
<div class="block">An unset anchor, line, text size or vertical type value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#VERTICAL_TYPE_LR">VERTICAL_TYPE_LR</a></span></code></th>
<td class="colLast">
<div class="block">Vertical left-to-right (e.g.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#VERTICAL_TYPE_RL">VERTICAL_TYPE_RL</a></span></code></th>
<td class="colLast">
<div class="block">Vertical right-to-left (e.g.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#verticalType">verticalType</a></span></code></th>
<td class="colLast">
<div class="block">The vertical formatting of this Cue, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET"><code>TYPE_UNSET</code></a> if the cue has no vertical setting
(and so should be horizontal).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#windowColor">windowColor</a></span></code></th>
<td class="colLast">
<div class="block">The fill color of the window.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#windowColorSet">windowColorSet</a></span></code></th>
<td class="colLast">
<div class="block">Specifies whether or not the <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#windowColor"><code>windowColor</code></a> property is set.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#Cue-java.lang.CharSequence-">Cue</a></span>&#8203;(<a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a>&nbsp;text)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a>.</div>
</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#Cue-java.lang.CharSequence-android.text.Layout.Alignment-float-int-int-float-int-float-">Cue</a></span>&#8203;(<a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a>&nbsp;text,
<a href="https://developer.android.com/reference/android/text/Layout.Alignment.html" title="class or interface in android.text" class="externalLink" target="_top">Layout.Alignment</a>&nbsp;textAlignment,
float&nbsp;line,
int&nbsp;lineType,
int&nbsp;lineAnchor,
float&nbsp;position,
int&nbsp;positionAnchor,
float&nbsp;size)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a>.</div>
</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#Cue-java.lang.CharSequence-android.text.Layout.Alignment-float-int-int-float-int-float-boolean-int-">Cue</a></span>&#8203;(<a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a>&nbsp;text,
<a href="https://developer.android.com/reference/android/text/Layout.Alignment.html" title="class or interface in android.text" class="externalLink" target="_top">Layout.Alignment</a>&nbsp;textAlignment,
float&nbsp;line,
int&nbsp;lineType,
int&nbsp;lineAnchor,
float&nbsp;position,
int&nbsp;positionAnchor,
float&nbsp;size,
boolean&nbsp;windowColorSet,
int&nbsp;windowColor)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a>.</div>
</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#Cue-java.lang.CharSequence-android.text.Layout.Alignment-float-int-int-float-int-float-int-float-">Cue</a></span>&#8203;(<a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a>&nbsp;text,
<a href="https://developer.android.com/reference/android/text/Layout.Alignment.html" title="class or interface in android.text" class="externalLink" target="_top">Layout.Alignment</a>&nbsp;textAlignment,
float&nbsp;line,
int&nbsp;lineType,
int&nbsp;lineAnchor,
float&nbsp;position,
int&nbsp;positionAnchor,
float&nbsp;size,
int&nbsp;textSizeType,
float&nbsp;textSize)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a>.</div>
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text">Cue.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#buildUpon--">buildUpon</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a new <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a> initialized with the same values as this Cue.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://developer.android.com/reference/java/lang/Object.html" title="class or interface in java.lang" class="externalLink" target="_top">Object</a></h3>
<code><a href="https://developer.android.com/reference/java/lang/Object.html#clone--" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang" class="externalLink" target="_top">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="EMPTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EMPTY</h4>
<pre>public static final&nbsp;<a href="../../../../../com/google/android/exoplayer2/text/Cue.html" title="class in com.google.android.exoplayer2.text">Cue</a> EMPTY</pre>
<div class="block">The empty cue.</div>
</li>
</ul>
<a name="DIMEN_UNSET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DIMEN_UNSET</h4>
<pre>public static final&nbsp;float DIMEN_UNSET</pre>
<div class="block">An unset position, width or size.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.DIMEN_UNSET">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TYPE_UNSET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_UNSET</h4>
<pre>public static final&nbsp;int TYPE_UNSET</pre>
<div class="block">An unset anchor, line, text size or vertical type value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.TYPE_UNSET">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ANCHOR_TYPE_START">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ANCHOR_TYPE_START</h4>
<pre>public static final&nbsp;int ANCHOR_TYPE_START</pre>
<div class="block">Anchors the left (for horizontal positions) or top (for vertical positions) edge of the cue
box.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.ANCHOR_TYPE_START">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ANCHOR_TYPE_MIDDLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ANCHOR_TYPE_MIDDLE</h4>
<pre>public static final&nbsp;int ANCHOR_TYPE_MIDDLE</pre>
<div class="block">Anchors the middle of the cue box.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.ANCHOR_TYPE_MIDDLE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ANCHOR_TYPE_END">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ANCHOR_TYPE_END</h4>
<pre>public static final&nbsp;int ANCHOR_TYPE_END</pre>
<div class="block">Anchors the right (for horizontal positions) or bottom (for vertical positions) edge of the cue
box.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.ANCHOR_TYPE_END">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LINE_TYPE_FRACTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINE_TYPE_FRACTION</h4>
<pre>public static final&nbsp;int LINE_TYPE_FRACTION</pre>
<div class="block">Value for <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a> when <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> is a fractional position.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.LINE_TYPE_FRACTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LINE_TYPE_NUMBER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINE_TYPE_NUMBER</h4>
<pre>public static final&nbsp;int LINE_TYPE_NUMBER</pre>
<div class="block">Value for <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a> when <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> is a line number.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.LINE_TYPE_NUMBER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TEXT_SIZE_TYPE_FRACTIONAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEXT_SIZE_TYPE_FRACTIONAL</h4>
<pre>public static final&nbsp;int TEXT_SIZE_TYPE_FRACTIONAL</pre>
<div class="block">Text size is measured as a fraction of the viewport size minus the view padding.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.TEXT_SIZE_TYPE_FRACTIONAL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING</h4>
<pre>public static final&nbsp;int TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING</pre>
<div class="block">Text size is measured as a fraction of the viewport size, ignoring the view padding</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TEXT_SIZE_TYPE_ABSOLUTE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEXT_SIZE_TYPE_ABSOLUTE</h4>
<pre>public static final&nbsp;int TEXT_SIZE_TYPE_ABSOLUTE</pre>
<div class="block">Text size is measured in number of pixels.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.TEXT_SIZE_TYPE_ABSOLUTE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VERTICAL_TYPE_RL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VERTICAL_TYPE_RL</h4>
<pre>public static final&nbsp;int VERTICAL_TYPE_RL</pre>
<div class="block">Vertical right-to-left (e.g. for Japanese).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.VERTICAL_TYPE_RL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VERTICAL_TYPE_LR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VERTICAL_TYPE_LR</h4>
<pre>public static final&nbsp;int VERTICAL_TYPE_LR</pre>
<div class="block">Vertical left-to-right (e.g. for Mongolian).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.text.Cue.VERTICAL_TYPE_LR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="text">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>text</h4>
<pre>@Nullable
public final&nbsp;<a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a> text</pre>
<div class="block">The cue text, or null if this is an image cue. Note the <a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top"><code>CharSequence</code></a> may be decorated
with styling spans.</div>
</li>
</ul>
<a name="textAlignment">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>textAlignment</h4>
<pre>@Nullable
public final&nbsp;<a href="https://developer.android.com/reference/android/text/Layout.Alignment.html" title="class or interface in android.text" class="externalLink" target="_top">Layout.Alignment</a> textAlignment</pre>
<div class="block">The alignment of the cue text within the cue box, or null if the alignment is undefined.</div>
</li>
</ul>
<a name="bitmap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bitmap</h4>
<pre>@Nullable
public final&nbsp;<a href="https://developer.android.com/reference/android/graphics/Bitmap.html" title="class or interface in android.graphics" class="externalLink" target="_top">Bitmap</a> bitmap</pre>
<div class="block">The cue image, or null if this is a text cue.</div>
</li>
</ul>
<a name="line">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>line</h4>
<pre>public final&nbsp;float line</pre>
<div class="block">The position of the cue box within the viewport in the direction orthogonal to the writing
direction (determined by <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#verticalType"><code>verticalType</code></a>), or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a>. When set, the
interpretation of the value depends on the value of <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a>.
<p>The measurement direction depends on <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#verticalType"><code>verticalType</code></a>:
<ul>
<li>For <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET"><code>TYPE_UNSET</code></a> (i.e. horizontal), this is the vertical position relative to the
top of the viewport.
<li>For <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#VERTICAL_TYPE_LR"><code>VERTICAL_TYPE_LR</code></a> this is the horizontal position relative to the left of the
viewport.
<li>For <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#VERTICAL_TYPE_RL"><code>VERTICAL_TYPE_RL</code></a> this is the horizontal position relative to the right of
the viewport.
</ul></div>
</li>
</ul>
<a name="lineType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lineType</h4>
<pre><a href="../../../../../com/google/android/exoplayer2/text/Cue.LineType.html" title="annotation in com.google.android.exoplayer2.text">@LineType</a>
public final&nbsp;int lineType</pre>
<div class="block">The type of the <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> value.
<ul>
<li><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#LINE_TYPE_FRACTION"><code>LINE_TYPE_FRACTION</code></a> indicates that <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> is a fractional position within
the viewport (measured to the part of the cue box determined by <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineAnchor"><code>lineAnchor</code></a>).
<li><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#LINE_TYPE_NUMBER"><code>LINE_TYPE_NUMBER</code></a> indicates that <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> is a viewport line number. The
viewport is divided into lines (each equal in size to the first line of the cue box). The
cue box is positioned to align with the viewport lines as follows:
<ul>
<li><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineAnchor"><code>lineAnchor</code></a>) is ignored.
<li>When <code>line</code> is greater than or equal to 0 the first line in the cue box is
aligned with a viewport line, with 0 meaning the first line of the viewport.
<li>When <code>line</code> is negative the last line in the cue box is aligned with a
viewport line, with -1 meaning the last line of the viewport.
<li>For horizontal text the start and end of the viewport are the top and bottom
respectively.
</ul>
</ul></div>
</li>
</ul>
<a name="lineAnchor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lineAnchor</h4>
<pre><a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text">@AnchorType</a>
public final&nbsp;int lineAnchor</pre>
<div class="block">The cue box anchor positioned by <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a> when <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a> is <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#LINE_TYPE_FRACTION"><code>LINE_TYPE_FRACTION</code></a>.
<p>One of:
<ul>
<li><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_START"><code>ANCHOR_TYPE_START</code></a>
<li><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_MIDDLE"><code>ANCHOR_TYPE_MIDDLE</code></a>
<li><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_END"><code>ANCHOR_TYPE_END</code></a>
<li><a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET"><code>TYPE_UNSET</code></a>
</ul>
<p>For the normal case of horizontal text, <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_START"><code>ANCHOR_TYPE_START</code></a>, <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_MIDDLE"><code>ANCHOR_TYPE_MIDDLE</code></a> and <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_END"><code>ANCHOR_TYPE_END</code></a> correspond to the top, middle and bottom of
the cue box respectively.</div>
</li>
</ul>
<a name="position">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre>public final&nbsp;float position</pre>
<div class="block">The fractional position of the <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#positionAnchor"><code>positionAnchor</code></a> of the cue box within the viewport in
the direction orthogonal to <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a>, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a>.
<p>The measurement direction depends on <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#verticalType"><code>verticalType</code></a>.
<ul>
<li>For <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET"><code>TYPE_UNSET</code></a> (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 <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#VERTICAL_TYPE_LR"><code>VERTICAL_TYPE_LR</code></a> and <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#VERTICAL_TYPE_RL"><code>VERTICAL_TYPE_RL</code></a> (i.e. vertical), this is the
vertical position relative to the top of the viewport.
</ul></div>
</li>
</ul>
<a name="positionAnchor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>positionAnchor</h4>
<pre><a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text">@AnchorType</a>
public final&nbsp;int positionAnchor</pre>
<div class="block">The cue box anchor positioned by <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#position"><code>position</code></a>. One of <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_START"><code>ANCHOR_TYPE_START</code></a>, <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_MIDDLE"><code>ANCHOR_TYPE_MIDDLE</code></a>, <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_END"><code>ANCHOR_TYPE_END</code></a> and <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET"><code>TYPE_UNSET</code></a>.
<p>For the normal case of horizontal text, <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_START"><code>ANCHOR_TYPE_START</code></a>, <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_MIDDLE"><code>ANCHOR_TYPE_MIDDLE</code></a> and <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#ANCHOR_TYPE_END"><code>ANCHOR_TYPE_END</code></a> correspond to the left, middle and right of
the cue box respectively.</div>
</li>
</ul>
<a name="size">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public final&nbsp;float size</pre>
<div class="block">The size of the cue box in the writing direction specified as a fraction of the viewport size
in that direction, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a>.</div>
</li>
</ul>
<a name="bitmapHeight">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bitmapHeight</h4>
<pre>public final&nbsp;float bitmapHeight</pre>
<div class="block">The bitmap height as a fraction of the of the viewport size, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a> if the
bitmap should be displayed at its natural height given the bitmap dimensions and the specified
<a href="../../../../../com/google/android/exoplayer2/text/Cue.html#size"><code>size</code></a>.</div>
</li>
</ul>
<a name="windowColorSet">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>windowColorSet</h4>
<pre>public final&nbsp;boolean windowColorSet</pre>
<div class="block">Specifies whether or not the <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#windowColor"><code>windowColor</code></a> property is set.</div>
</li>
</ul>
<a name="windowColor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>windowColor</h4>
<pre>public final&nbsp;int windowColor</pre>
<div class="block">The fill color of the window.</div>
</li>
</ul>
<a name="textSizeType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>textSizeType</h4>
<pre><a href="../../../../../com/google/android/exoplayer2/text/Cue.TextSizeType.html" title="annotation in com.google.android.exoplayer2.text">@TextSizeType</a>
public final&nbsp;int textSizeType</pre>
<div class="block">The default text size type for this cue's text, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET"><code>TYPE_UNSET</code></a> if this cue has no
default text size.</div>
</li>
</ul>
<a name="textSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>textSize</h4>
<pre>public final&nbsp;float textSize</pre>
<div class="block">The default text size for this cue's text, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a> if this cue has no default
text size.</div>
</li>
</ul>
<a name="verticalType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verticalType</h4>
<pre><a href="../../../../../com/google/android/exoplayer2/text/Cue.VerticalType.html" title="annotation in com.google.android.exoplayer2.text">@VerticalType</a>
public final&nbsp;int verticalType</pre>
<div class="block">The vertical formatting of this Cue, or <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET"><code>TYPE_UNSET</code></a> if the cue has no vertical setting
(and so should be horizontal).</div>
</li>
</ul>
<a name="shearDegrees">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>shearDegrees</h4>
<pre>public final&nbsp;float shearDegrees</pre>
<div class="block">The shear angle in degrees to be applied to this Cue, expressed in graphics coordinates. This
results in a skew transform for the block along the inline progression axis.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Cue-java.lang.CharSequence-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Cue</h4>
<pre><a href="https://developer.android.com/reference/java/lang/Deprecated.html" title="class or interface in java.lang" class="externalLink" target="_top">@Deprecated</a>
public&nbsp;Cue&#8203;(<a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a>&nbsp;text)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a>.</div>
</div>
<div class="block">Creates a text cue whose <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#textAlignment"><code>textAlignment</code></a> is null, whose type parameters are set to
<a href="../../../../../com/google/android/exoplayer2/text/Cue.html#TYPE_UNSET"><code>TYPE_UNSET</code></a> and whose dimension parameters are set to <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#DIMEN_UNSET"><code>DIMEN_UNSET</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#text"><code>text</code></a>.</dd>
</dl>
</li>
</ul>
<a name="Cue-java.lang.CharSequence-android.text.Layout.Alignment-float-int-int-float-int-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Cue</h4>
<pre><a href="https://developer.android.com/reference/java/lang/Deprecated.html" title="class or interface in java.lang" class="externalLink" target="_top">@Deprecated</a>
public&nbsp;Cue&#8203;(<a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a>&nbsp;text,
@Nullable
<a href="https://developer.android.com/reference/android/text/Layout.Alignment.html" title="class or interface in android.text" class="externalLink" target="_top">Layout.Alignment</a>&nbsp;textAlignment,
float&nbsp;line,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.LineType.html" title="annotation in com.google.android.exoplayer2.text">@LineType</a>
int&nbsp;lineType,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text">@AnchorType</a>
int&nbsp;lineAnchor,
float&nbsp;position,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text">@AnchorType</a>
int&nbsp;positionAnchor,
float&nbsp;size)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a>.</div>
</div>
<div class="block">Creates a text cue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#text"><code>text</code></a>.</dd>
<dd><code>textAlignment</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#textAlignment"><code>textAlignment</code></a>.</dd>
<dd><code>line</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a>.</dd>
<dd><code>lineType</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a>.</dd>
<dd><code>lineAnchor</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineAnchor"><code>lineAnchor</code></a>.</dd>
<dd><code>position</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#position"><code>position</code></a>.</dd>
<dd><code>positionAnchor</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#positionAnchor"><code>positionAnchor</code></a>.</dd>
<dd><code>size</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#size"><code>size</code></a>.</dd>
</dl>
</li>
</ul>
<a name="Cue-java.lang.CharSequence-android.text.Layout.Alignment-float-int-int-float-int-float-int-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Cue</h4>
<pre><a href="https://developer.android.com/reference/java/lang/Deprecated.html" title="class or interface in java.lang" class="externalLink" target="_top">@Deprecated</a>
public&nbsp;Cue&#8203;(<a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a>&nbsp;text,
@Nullable
<a href="https://developer.android.com/reference/android/text/Layout.Alignment.html" title="class or interface in android.text" class="externalLink" target="_top">Layout.Alignment</a>&nbsp;textAlignment,
float&nbsp;line,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.LineType.html" title="annotation in com.google.android.exoplayer2.text">@LineType</a>
int&nbsp;lineType,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text">@AnchorType</a>
int&nbsp;lineAnchor,
float&nbsp;position,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text">@AnchorType</a>
int&nbsp;positionAnchor,
float&nbsp;size,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.TextSizeType.html" title="annotation in com.google.android.exoplayer2.text">@TextSizeType</a>
int&nbsp;textSizeType,
float&nbsp;textSize)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a>.</div>
</div>
<div class="block">Creates a text cue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#text"><code>text</code></a>.</dd>
<dd><code>textAlignment</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#textAlignment"><code>textAlignment</code></a>.</dd>
<dd><code>line</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a>.</dd>
<dd><code>lineType</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a>.</dd>
<dd><code>lineAnchor</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineAnchor"><code>lineAnchor</code></a>.</dd>
<dd><code>position</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#position"><code>position</code></a>.</dd>
<dd><code>positionAnchor</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#positionAnchor"><code>positionAnchor</code></a>.</dd>
<dd><code>size</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#size"><code>size</code></a>.</dd>
<dd><code>textSizeType</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#textSizeType"><code>textSizeType</code></a>.</dd>
<dd><code>textSize</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#textSize"><code>textSize</code></a>.</dd>
</dl>
</li>
</ul>
<a name="Cue-java.lang.CharSequence-android.text.Layout.Alignment-float-int-int-float-int-float-boolean-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Cue</h4>
<pre><a href="https://developer.android.com/reference/java/lang/Deprecated.html" title="class or interface in java.lang" class="externalLink" target="_top">@Deprecated</a>
public&nbsp;Cue&#8203;(<a href="https://developer.android.com/reference/java/lang/CharSequence.html" title="class or interface in java.lang" class="externalLink" target="_top">CharSequence</a>&nbsp;text,
@Nullable
<a href="https://developer.android.com/reference/android/text/Layout.Alignment.html" title="class or interface in android.text" class="externalLink" target="_top">Layout.Alignment</a>&nbsp;textAlignment,
float&nbsp;line,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.LineType.html" title="annotation in com.google.android.exoplayer2.text">@LineType</a>
int&nbsp;lineType,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text">@AnchorType</a>
int&nbsp;lineAnchor,
float&nbsp;position,
<a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text">@AnchorType</a>
int&nbsp;positionAnchor,
float&nbsp;size,
boolean&nbsp;windowColorSet,
int&nbsp;windowColor)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a>.</div>
</div>
<div class="block">Creates a text cue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#text"><code>text</code></a>.</dd>
<dd><code>textAlignment</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#textAlignment"><code>textAlignment</code></a>.</dd>
<dd><code>line</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#line"><code>line</code></a>.</dd>
<dd><code>lineType</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineType"><code>lineType</code></a>.</dd>
<dd><code>lineAnchor</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#lineAnchor"><code>lineAnchor</code></a>.</dd>
<dd><code>position</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#position"><code>position</code></a>.</dd>
<dd><code>positionAnchor</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#positionAnchor"><code>positionAnchor</code></a>.</dd>
<dd><code>size</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#size"><code>size</code></a>.</dd>
<dd><code>windowColorSet</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#windowColorSet"><code>windowColorSet</code></a>.</dd>
<dd><code>windowColor</code> - See <a href="../../../../../com/google/android/exoplayer2/text/Cue.html#windowColor"><code>windowColor</code></a>.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="buildUpon--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>buildUpon</h4>
<pre>public&nbsp;<a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text">Cue.Builder</a>&nbsp;buildUpon()</pre>
<div class="block">Returns a new <a href="../../../../../com/google/android/exoplayer2/text/Cue.Builder.html" title="class in com.google.android.exoplayer2.text"><code>Cue.Builder</code></a> initialized with the same values as this Cue.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/google/android/exoplayer2/text/CaptionStyleCompat.EdgeType.html" title="annotation in com.google.android.exoplayer2.text"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/google/android/exoplayer2/text/Cue.AnchorType.html" title="annotation in com.google.android.exoplayer2.text"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/android/exoplayer2/text/Cue.html" target="_top">Frames</a></li>
<li><a href="Cue.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in a new issue View git blame Copy permalink