<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.5"/>
<title>libquicktime: Writing text</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="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 style="padding-left: 0.5em;">
<div id="projectname">libquicktime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Writing text<div class="ingroups"><a class="el" href="group__text.html">Text</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Encode text.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacf15d3be9cdc4e5b2964d61eec156aa7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text__encode.html#gacf15d3be9cdc4e5b2964d61eec156aa7">lqt_add_text_track</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int timescale)</td></tr>
<tr class="memdesc:gacf15d3be9cdc4e5b2964d61eec156aa7"><td class="mdescLeft"> </td><td class="mdescRight">Add a text track. <a href="#gacf15d3be9cdc4e5b2964d61eec156aa7">More...</a><br/></td></tr>
<tr class="separator:gacf15d3be9cdc4e5b2964d61eec156aa7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga48fb317d6ac069da8aac5ff90039bf6a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text__encode.html#ga48fb317d6ac069da8aac5ff90039bf6a">lqt_set_text_language</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int track, const char *language)</td></tr>
<tr class="memdesc:ga48fb317d6ac069da8aac5ff90039bf6a"><td class="mdescLeft"> </td><td class="mdescRight">Set the language for a text track. <a href="#ga48fb317d6ac069da8aac5ff90039bf6a">More...</a><br/></td></tr>
<tr class="separator:ga48fb317d6ac069da8aac5ff90039bf6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga22b8ed13abf766dc3ff528409d2f43b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text__encode.html#ga22b8ed13abf766dc3ff528409d2f43b4">lqt_set_chapter_track</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int track)</td></tr>
<tr class="memdesc:ga22b8ed13abf766dc3ff528409d2f43b4"><td class="mdescLeft"> </td><td class="mdescRight">Make a text track a chapter track. <a href="#ga22b8ed13abf766dc3ff528409d2f43b4">More...</a><br/></td></tr>
<tr class="separator:ga22b8ed13abf766dc3ff528409d2f43b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga629f575ef3e5f633beab3e3ade84850d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text__encode.html#ga629f575ef3e5f633beab3e3ade84850d">lqt_set_text_box</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int track, uint16_t top, uint16_t left, uint16_t bottom, uint16_t right)</td></tr>
<tr class="memdesc:ga629f575ef3e5f633beab3e3ade84850d"><td class="mdescLeft"> </td><td class="mdescRight">Set the text box of a text track. <a href="#ga629f575ef3e5f633beab3e3ade84850d">More...</a><br/></td></tr>
<tr class="separator:ga629f575ef3e5f633beab3e3ade84850d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8c8e5159ef113c2b89b955080d41dfe1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text__encode.html#ga8c8e5159ef113c2b89b955080d41dfe1">lqt_set_text_fg_color</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int track, uint16_t r, uint16_t g, uint16_t b, uint16_t a)</td></tr>
<tr class="memdesc:ga8c8e5159ef113c2b89b955080d41dfe1"><td class="mdescLeft"> </td><td class="mdescRight">Set the foreground color of a text track. <a href="#ga8c8e5159ef113c2b89b955080d41dfe1">More...</a><br/></td></tr>
<tr class="separator:ga8c8e5159ef113c2b89b955080d41dfe1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae1fafac7b632513544c298abf4890cce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text__encode.html#gae1fafac7b632513544c298abf4890cce">lqt_set_text_bg_color</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int track, uint16_t r, uint16_t g, uint16_t b, uint16_t a)</td></tr>
<tr class="memdesc:gae1fafac7b632513544c298abf4890cce"><td class="mdescLeft"> </td><td class="mdescRight">Set the background color of a text track. <a href="#gae1fafac7b632513544c298abf4890cce">More...</a><br/></td></tr>
<tr class="separator:gae1fafac7b632513544c298abf4890cce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad399707ef885b3643f9bbee2890f0946"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text__encode.html#gad399707ef885b3643f9bbee2890f0946">lqt_write_text</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int track, const char *text, int64_t duration)</td></tr>
<tr class="memdesc:gad399707ef885b3643f9bbee2890f0946"><td class="mdescLeft"> </td><td class="mdescRight">Write a text sample. <a href="#gad399707ef885b3643f9bbee2890f0946">More...</a><br/></td></tr>
<tr class="separator:gad399707ef885b3643f9bbee2890f0946"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7be11a6392f8c323faae2215d11f9ad9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text__encode.html#ga7be11a6392f8c323faae2215d11f9ad9">lqt_set_text_pts_offset</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int track, int64_t offset)</td></tr>
<tr class="memdesc:ga7be11a6392f8c323faae2215d11f9ad9"><td class="mdescLeft"> </td><td class="mdescRight">Set an video pts offset. <a href="#ga7be11a6392f8c323faae2215d11f9ad9">More...</a><br/></td></tr>
<tr class="separator:ga7be11a6392f8c323faae2215d11f9ad9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Encode text. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gacf15d3be9cdc4e5b2964d61eec156aa7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lqt_add_text_track </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>timescale</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a text track. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">timescale</td><td>The timescale, in which timestamps will be given. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga48fb317d6ac069da8aac5ff90039bf6a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lqt_set_text_language </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>language</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the language for a text track. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">track</td><td>Track index (starting with 0) </td></tr>
<tr><td class="paramname">language</td><td>ISO-639 Language code</td></tr>
</table>
</dd>
</dl>
<p>The language code is a 3-character code, English is "eng", Japanese is "jpn". </p>
</div>
</div>
<a class="anchor" id="ga22b8ed13abf766dc3ff528409d2f43b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lqt_set_chapter_track </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make a text track a chapter track. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">track</td><td>Track index (starting with 0)</td></tr>
</table>
</dd>
</dl>
<p>By default, text tracks are subtitles. By calling this function, you tell libquicktime, that the text track should be a chapter track. </p>
</div>
</div>
<a class="anchor" id="ga629f575ef3e5f633beab3e3ade84850d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lqt_set_text_box </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>top</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>bottom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>right</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the text box of a text track. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">track</td><td>Track index (starting with 0) </td></tr>
<tr><td class="paramname">top</td><td>Top border </td></tr>
<tr><td class="paramname">left</td><td>Left border </td></tr>
<tr><td class="paramname">bottom</td><td>Bottom border </td></tr>
<tr><td class="paramname">right</td><td>Right border </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8c8e5159ef113c2b89b955080d41dfe1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lqt_set_text_fg_color </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>a</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the foreground color of a text track. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">track</td><td>Track index (starting with 0) </td></tr>
<tr><td class="paramname">r</td><td>Red </td></tr>
<tr><td class="paramname">g</td><td>Green </td></tr>
<tr><td class="paramname">b</td><td>Blue </td></tr>
<tr><td class="paramname">a</td><td>Alpha</td></tr>
</table>
</dd>
</dl>
<p>Color values are between 0x0000 and 0xffff. The alpha value is only used for mp4. </p>
</div>
</div>
<a class="anchor" id="gae1fafac7b632513544c298abf4890cce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lqt_set_text_bg_color </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>a</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the background color of a text track. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">track</td><td>Track index (starting with 0) </td></tr>
<tr><td class="paramname">r</td><td>Red </td></tr>
<tr><td class="paramname">g</td><td>Green </td></tr>
<tr><td class="paramname">b</td><td>Blue </td></tr>
<tr><td class="paramname">a</td><td>Alpha</td></tr>
</table>
</dd>
</dl>
<p>Color values are between 0x0000 and 0xffff. The alpha value is only used for mp4. For Quicktime, the text box is set to transparent if the alpha value is below 0x8000. </p>
</div>
</div>
<a class="anchor" id="gad399707ef885b3643f9bbee2890f0946"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lqt_write_text </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"><em>duration</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a text sample. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">track</td><td>Track index (starting with 0) </td></tr>
<tr><td class="paramname">text</td><td>A null-terminated UTF-8 string </td></tr>
<tr><td class="paramname">duration</td><td>The duration associated with this sample </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if a the text sample could be written to the file, nonzero else </dd></dl>
</div>
</div>
<a class="anchor" id="ga7be11a6392f8c323faae2215d11f9ad9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lqt_set_text_pts_offset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set an video pts offset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">track</td><td>Track index (starting with 0) </td></tr>
<tr><td class="paramname">offset</td><td>PTS offset of the subtitles (in timescale units) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Aug 24 2013 16:07:02 for libquicktime by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
