Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shaka-packager/docs/dd/d5e/structshaka_1_1media_1_1Tex...

198 lines
12 KiB
HTML
Raw Permalink Blame History

<!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::TextSettings 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&amp;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&amp;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="../../dd/d5e/structshaka_1_1media_1_1TextSettings.html">TextSettings</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../db/db6/structshaka_1_1media_1_1TextSettings-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::TextSettings 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:a002ea8c52d9ab966f6f8a2616a21da46"><td class="memItemLeft" align="right" valign="top">base::Optional&lt; <a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d5e/structshaka_1_1media_1_1TextSettings.html#a002ea8c52d9ab966f6f8a2616a21da46">line</a></td></tr>
<tr class="separator:a002ea8c52d9ab966f6f8a2616a21da46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63c91deef5b34b528e7f03e61cebe873"><td class="memItemLeft" align="right" valign="top">base::Optional&lt; <a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d5e/structshaka_1_1media_1_1TextSettings.html#a63c91deef5b34b528e7f03e61cebe873">position</a></td></tr>
<tr class="separator:a63c91deef5b34b528e7f03e61cebe873"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ec6b15406e4877a59cefe00e0c00dcf"><td class="memItemLeft" align="right" valign="top">base::Optional&lt; <a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d5e/structshaka_1_1media_1_1TextSettings.html#a9ec6b15406e4877a59cefe00e0c00dcf">width</a></td></tr>
<tr class="separator:a9ec6b15406e4877a59cefe00e0c00dcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8876f7e978d8b59641947b19d75e532f"><td class="memItemLeft" align="right" valign="top">base::Optional&lt; <a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d5e/structshaka_1_1media_1_1TextSettings.html#a8876f7e978d8b59641947b19d75e532f">height</a></td></tr>
<tr class="separator:a8876f7e978d8b59641947b19d75e532f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e1043e8268bc0c1c515d77c7b099d10"><td class="memItemLeft" align="right" valign="top"><a id="a2e1043e8268bc0c1c515d77c7b099d10"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d5e/structshaka_1_1media_1_1TextSettings.html#a2e1043e8268bc0c1c515d77c7b099d10">region</a></td></tr>
<tr class="memdesc:a2e1043e8268bc0c1c515d77c7b099d10"><td class="mdescLeft">&#160;</td><td class="mdescRight">The region to draw the cue in. <br /></td></tr>
<tr class="separator:a2e1043e8268bc0c1c515d77c7b099d10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94dca124ccd2902b0e7466c37d05567e"><td class="memItemLeft" align="right" valign="top">WritingDirection&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d5e/structshaka_1_1media_1_1TextSettings.html#a94dca124ccd2902b0e7466c37d05567e">writing_direction</a> = WritingDirection::kHorizontal</td></tr>
<tr class="separator:a94dca124ccd2902b0e7466c37d05567e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d13993b1682b88332a6ea07aaca5a58"><td class="memItemLeft" align="right" valign="top"><a id="a1d13993b1682b88332a6ea07aaca5a58"></a>
TextAlignment&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d5e/structshaka_1_1media_1_1TextSettings.html#a1d13993b1682b88332a6ea07aaca5a58">text_alignment</a> = TextAlignment::kCenter</td></tr>
<tr class="memdesc:a1d13993b1682b88332a6ea07aaca5a58"><td class="mdescLeft">&#160;</td><td class="mdescRight">How to align the text within the cue box. <br /></td></tr>
<tr class="separator:a1d13993b1682b88332a6ea07aaca5a58"><td class="memSeparator" colspan="2">&#160;</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="../../d0/d1a/text__sample_8h_source.html#l00055">55</a> of file <a class="el" href="../../d0/d1a/text__sample_8h_source.html">text_sample.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a8876f7e978d8b59641947b19d75e532f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8876f7e978d8b59641947b19d75e532f">&#9670;&nbsp;</a></span>height</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">base::Optional&lt;<a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a>&gt; shaka::media::TextSettings::height</td>
</tr>
</table>
</div><div class="memdoc">
<p>For horizontal cues, this is the height of the area to draw cues. For vertical cues, this is the width. Percent units are relative to the window. </p>
<p class="definition">Definition at line <a class="el" href="../../d0/d1a/text__sample_8h_source.html#l00069">69</a> of file <a class="el" href="../../d0/d1a/text__sample_8h_source.html">text_sample.h</a>.</p>
</div>
</div>
<a id="a002ea8c52d9ab966f6f8a2616a21da46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a002ea8c52d9ab966f6f8a2616a21da46">&#9670;&nbsp;</a></span>line</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">base::Optional&lt;<a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a>&gt; shaka::media::TextSettings::line</td>
</tr>
</table>
</div><div class="memdoc">
<p>The line offset of the cue. For horizontal cues, this is the vertical offset. Percent units are relative to the window. </p>
<p class="definition">Definition at line <a class="el" href="../../d0/d1a/text__sample_8h_source.html#l00058">58</a> of file <a class="el" href="../../d0/d1a/text__sample_8h_source.html">text_sample.h</a>.</p>
</div>
</div>
<a id="a63c91deef5b34b528e7f03e61cebe873"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63c91deef5b34b528e7f03e61cebe873">&#9670;&nbsp;</a></span>position</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">base::Optional&lt;<a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a>&gt; shaka::media::TextSettings::position</td>
</tr>
</table>
</div><div class="memdoc">
<p>The position offset of the cue. For horizontal cues, this is the horizontal offset. Percent units are relative to the window. </p>
<p class="definition">Definition at line <a class="el" href="../../d0/d1a/text__sample_8h_source.html#l00061">61</a> of file <a class="el" href="../../d0/d1a/text__sample_8h_source.html">text_sample.h</a>.</p>
</div>
</div>
<a id="a9ec6b15406e4877a59cefe00e0c00dcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ec6b15406e4877a59cefe00e0c00dcf">&#9670;&nbsp;</a></span>width</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">base::Optional&lt;<a class="el" href="../../d8/d99/structshaka_1_1media_1_1TextNumber.html">TextNumber</a>&gt; shaka::media::TextSettings::width</td>
</tr>
</table>
</div><div class="memdoc">
<p>For horizontal cues, this is the width of the area to draw cues. For vertical cues, this is the height. Percent units are relative to the window. </p>
<p class="definition">Definition at line <a class="el" href="../../d0/d1a/text__sample_8h_source.html#l00065">65</a> of file <a class="el" href="../../d0/d1a/text__sample_8h_source.html">text_sample.h</a>.</p>
</div>
</div>
<a id="a94dca124ccd2902b0e7466c37d05567e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94dca124ccd2902b0e7466c37d05567e">&#9670;&nbsp;</a></span>writing_direction</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WritingDirection shaka::media::TextSettings::writing_direction = WritingDirection::kHorizontal</td>
</tr>
</table>
</div><div class="memdoc">
<p>The direction to draw text. This is also used to determine how cues are positioned within the region. </p>
<p class="definition">Definition at line <a class="el" href="../../d0/d1a/text__sample_8h_source.html#l00076">76</a> of file <a class="el" href="../../d0/d1a/text__sample_8h_source.html">text_sample.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="../../d0/d1a/text__sample_8h_source.html">text_sample.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink