167 lines
8.3 KiB
HTML
167 lines
8.3 KiB
HTML
|
<!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.13"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>Shaka Packager SDK: shaka::media::FileReader Class 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.13 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
||
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(function() {
|
||
|
|
initMenu('../../',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
</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="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||
|
|
<a href="../../d5/d78/classshaka_1_1media_1_1FileReader-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">shaka::media::FileReader Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Class to read character-by-character from a file.
|
||
|
|
<a href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="../../d4/d0c/text__readers_8h_source.html">text_readers.h</a>></code></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a0ac0fbdee01fe6cc71fdea9fdd8ceabd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a0ac0fbdee01fe6cc71fdea9fdd8ceabd">Next</a> (char *out)</td></tr>
|
||
|
|
<tr class="separator:a0ac0fbdee01fe6cc71fdea9fdd8ceabd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||
|
|
Static Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a7b8d9ee944b8f2816e6d717bd01c6eab"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a7b8d9ee944b8f2816e6d717bd01c6eab">Open</a> (const std::string &filename, std::unique_ptr< <a class="el" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</a> > *out)</td></tr>
|
||
|
|
<tr class="separator:a7b8d9ee944b8f2816e6d717bd01c6eab"><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 to read character-by-character from a file. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="../../d4/d0c/text__readers_8h_source.html#l00023">23</a> of file <a class="el" href="../../d4/d0c/text__readers_8h_source.html">text_readers.h</a>.</p>
|
||
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a0ac0fbdee01fe6cc71fdea9fdd8ceabd"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ac0fbdee01fe6cc71fdea9fdd8ceabd">◆ </a></span>Next()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool shaka::media::FileReader::Next </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">char * </td>
|
||
|
|
<td class="paramname"><em>out</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Read the next character from the file. If there is a next character, |out| will be set and true will be returned. If there is no next character false will be returned. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="../../d8/d51/text__readers_8cc_source.html#l00032">32</a> of file <a class="el" href="../../d8/d51/text__readers_8cc_source.html">text_readers.cc</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a7b8d9ee944b8f2816e6d717bd01c6eab"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b8d9ee944b8f2816e6d717bd01c6eab">◆ </a></span>Open()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::FileReader::Open </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const std::string & </td>
|
||
|
|
<td class="paramname"><em>filename</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</a> > * </td>
|
||
|
|
<td class="paramname"><em>out</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Create a new file reader by opening a file. If the file fails to open (in readonly mode) a non-ok status will be returned. If the file successfully opens, |out| will be set to a new <a class="el" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html" title="Class to read character-by-character from a file. ">FileReader</a> and an ok status will be returned. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="../../d8/d51/text__readers_8cc_source.html#l00015">15</a> of file <a class="el" href="../../d8/d51/text__readers_8cc_source.html">text_readers.cc</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li>packager/media/formats/webvtt/<a class="el" href="../../d4/d0c/text__readers_8h_source.html">text_readers.h</a></li>
|
||
|
|
<li>packager/media/formats/webvtt/<a class="el" href="../../d8/d51/text__readers_8cc_source.html">text_readers.cc</a></li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated on Sat Feb 10 2018 15:36:49 for Shaka Packager SDK by  <a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
||
|
|
</a> 1.8.13
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|