166 lines
11 KiB
HTML
166 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Shaka Packager SDK: shaka::media::TextRegion Struct Reference</title>
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../jquery.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../search/searchdata.js"></script>
|
|
<script type="text/javascript" src="../../search/search.js"></script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Shaka Packager SDK
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('../../',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><b>media</b></li><li class="navelem"><a class="el" href="../../d4/d60/structshaka_1_1media_1_1TextRegion.html">TextRegion</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="../../d3/d7d/structshaka_1_1media_1_1TextRegion-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">shaka::media::TextRegion Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:aaa1f0ff704a50c7b6e45b47c2f43b123"><td class="memItemLeft" align="right" valign="top"><a id="aaa1f0ff704a50c7b6e45b47c2f43b123"></a>
|
|
<a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d60/structshaka_1_1media_1_1TextRegion.html#aaa1f0ff704a50c7b6e45b47c2f43b123">width</a> {100, TextUnitType::kPercent}</td></tr>
|
|
<tr class="memdesc:aaa1f0ff704a50c7b6e45b47c2f43b123"><td class="mdescLeft"> </td><td class="mdescRight">The width of the region; percent units are relative to the window. <br /></td></tr>
|
|
<tr class="separator:aaa1f0ff704a50c7b6e45b47c2f43b123"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af64ab49246f086cf620e555e2582fdbc"><td class="memItemLeft" align="right" valign="top"><a id="af64ab49246f086cf620e555e2582fdbc"></a>
|
|
<a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d60/structshaka_1_1media_1_1TextRegion.html#af64ab49246f086cf620e555e2582fdbc">height</a> {100, TextUnitType::kPercent}</td></tr>
|
|
<tr class="memdesc:af64ab49246f086cf620e555e2582fdbc"><td class="mdescLeft"> </td><td class="mdescRight">The height of the region; percent units are relative to the window. <br /></td></tr>
|
|
<tr class="separator:af64ab49246f086cf620e555e2582fdbc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4552d1ca8127535c9041222e548a20f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d60/structshaka_1_1media_1_1TextRegion.html#a4552d1ca8127535c9041222e548a20f6">window_anchor_x</a> {0, TextUnitType::kPercent}</td></tr>
|
|
<tr class="separator:a4552d1ca8127535c9041222e548a20f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17e8fc77efd12eee6c317d28dea6b77a"><td class="memItemLeft" align="right" valign="top"><a id="a17e8fc77efd12eee6c317d28dea6b77a"></a>
|
|
<a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> </td><td class="memItemRight" valign="bottom"><b>window_anchor_y</b> {0, TextUnitType::kPercent}</td></tr>
|
|
<tr class="separator:a17e8fc77efd12eee6c317d28dea6b77a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a063364e900e64c4be3e5e563c7c67649"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d60/structshaka_1_1media_1_1TextRegion.html#a063364e900e64c4be3e5e563c7c67649">region_anchor_x</a> {0, TextUnitType::kPercent}</td></tr>
|
|
<tr class="separator:a063364e900e64c4be3e5e563c7c67649"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a810170a9b9c05b427712d2f5e00c7a3c"><td class="memItemLeft" align="right" valign="top"><a id="a810170a9b9c05b427712d2f5e00c7a3c"></a>
|
|
<a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> </td><td class="memItemRight" valign="bottom"><b>region_anchor_y</b> {0, TextUnitType::kPercent}</td></tr>
|
|
<tr class="separator:a810170a9b9c05b427712d2f5e00c7a3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebbc17097e3959a5aa9eb96c58a7a513"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d60/structshaka_1_1media_1_1TextRegion.html#aebbc17097e3959a5aa9eb96c58a7a513">scroll</a> = false</td></tr>
|
|
<tr class="separator:aebbc17097e3959a5aa9eb96c58a7a513"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p class="definition">Definition at line <a class="el" href="../../da/d2a/text__stream__info_8h_source.html#l00019">19</a> of file <a class="el" href="../../da/d2a/text__stream__info_8h_source.html">text_stream_info.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a063364e900e64c4be3e5e563c7c67649"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a063364e900e64c4be3e5e563c7c67649">◆ </a></span>region_anchor_x</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> shaka::media::TextRegion::region_anchor_x {0, TextUnitType::kPercent}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The x and y coordinates of the anchor point within the region. Percent units are relative to the region size. For example: if this is (100, 100), then the bottom right of the region should be placed at the window anchor point. See <a href="https://www.w3.org/TR/webvtt1/#regions">https://www.w3.org/TR/webvtt1/#regions</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../da/d2a/text__stream__info_8h_source.html#l00035">35</a> of file <a class="el" href="../../da/d2a/text__stream__info_8h_source.html">text_stream_info.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aebbc17097e3959a5aa9eb96c58a7a513"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebbc17097e3959a5aa9eb96c58a7a513">◆ </a></span>scroll</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool shaka::media::TextRegion::scroll = false</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If true, cues are scrolled up when adding new cues; if false, cues are added above existing cues or replace existing ones. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../da/d2a/text__stream__info_8h_source.html#l00040">40</a> of file <a class="el" href="../../da/d2a/text__stream__info_8h_source.html">text_stream_info.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4552d1ca8127535c9041222e548a20f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4552d1ca8127535c9041222e548a20f6">◆ </a></span>window_anchor_x</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> shaka::media::TextRegion::window_anchor_x {0, TextUnitType::kPercent}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The x and y coordinates of the anchor point within the window. Percent units are relative to the window. In WebVTT this is called the "viewport region anchor". </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../da/d2a/text__stream__info_8h_source.html#l00028">28</a> of file <a class="el" href="../../da/d2a/text__stream__info_8h_source.html">text_stream_info.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>packager/media/base/<a class="el" href="../../da/d2a/text__stream__info_8h_source.html">text_stream_info.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Jun 22 2021 00:16:06 for Shaka Packager SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|