820 lines
44 KiB
HTML
820 lines
44 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.6"/>
|
|
<title>DASH Media Packaging SDK: shaka::media::File 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/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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">DASH Media Packaging SDK
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="../../index.html"><span>Main Page</span></a></li>
|
|
<li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="../../files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="../../search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="../../annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="../../classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="../../hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="../../functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></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="../../d3/d61/classshaka_1_1media_1_1File.html">File</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="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="../../d9/d3a/classshaka_1_1media_1_1File-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">shaka::media::File Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Define an abstract file interface.
|
|
<a href="../../d3/d61/classshaka_1_1media_1_1File.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="../../d2/d4d/file_8h_source.html">file.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for shaka::media::File:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="../../d3/d61/classshaka_1_1media_1_1File.png" usemap="#shaka::media::File_map" alt=""/>
|
|
<map id="shaka::media::File_map" name="shaka::media::File_map">
|
|
<area href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html" title="Implement LocalFile which deals with local storage. " alt="shaka::media::LocalFile" shape="rect" coords="0,56,175,80"/>
|
|
<area href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html" alt="shaka::media::MemoryFile" shape="rect" coords="185,56,360,80"/>
|
|
<area href="../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html" title="Declaration of class which implements a thread-safe circular buffer. " alt="shaka::media::ThreadedIoFile" shape="rect" coords="370,56,545,80"/>
|
|
<area href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html" title="Implements UdpFile, which receives UDP unicast and multicast streams. " alt="shaka::media::UdpFile" shape="rect" coords="555,56,730,80"/>
|
|
</map>
|
|
</div></div>
|
|
<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:a2bfb0c180840356933652a795527b5c8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a2bfb0c180840356933652a795527b5c8">Close</a> ()=0</td></tr>
|
|
<tr class="separator:a2bfb0c180840356933652a795527b5c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed0c0793fd8751330583314a4d3012b9"><td class="memItemLeft" align="right" valign="top">virtual int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#aed0c0793fd8751330583314a4d3012b9">Read</a> (void *buffer, uint64_t length)=0</td></tr>
|
|
<tr class="separator:aed0c0793fd8751330583314a4d3012b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3149670c0d085e71f0aa085ee87fdda5"><td class="memItemLeft" align="right" valign="top">virtual int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a3149670c0d085e71f0aa085ee87fdda5">Write</a> (const void *buffer, uint64_t length)=0</td></tr>
|
|
<tr class="separator:a3149670c0d085e71f0aa085ee87fdda5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adffa2c3d12ae0a579704cf1f5b3bf8ab"><td class="memItemLeft" align="right" valign="top">virtual int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#adffa2c3d12ae0a579704cf1f5b3bf8ab">Size</a> ()=0</td></tr>
|
|
<tr class="separator:adffa2c3d12ae0a579704cf1f5b3bf8ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba73e887fbfe2de3a679c679ddf03f4b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#aba73e887fbfe2de3a679c679ddf03f4b">Flush</a> ()=0</td></tr>
|
|
<tr class="separator:aba73e887fbfe2de3a679c679ddf03f4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3baaa3207abaeb6af1a8239ee866b5d3"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a3baaa3207abaeb6af1a8239ee866b5d3">Seek</a> (uint64_t position)=0</td></tr>
|
|
<tr class="separator:a3baaa3207abaeb6af1a8239ee866b5d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57dd80258b1989f85d99c154ba377db8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a57dd80258b1989f85d99c154ba377db8">Tell</a> (uint64_t *position)=0</td></tr>
|
|
<tr class="separator:a57dd80258b1989f85d99c154ba377db8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe158b9e7b1e073956a16c55a8fcf5f4"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a> () const </td></tr>
|
|
<tr class="separator:abe158b9e7b1e073956a16c55a8fcf5f4"><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:a921efa1c8f7978e3b5aac33d648b0250"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a921efa1c8f7978e3b5aac33d648b0250">Open</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>, const char *mode)</td></tr>
|
|
<tr class="separator:a921efa1c8f7978e3b5aac33d648b0250"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1e9fc834093c8b35c0f8c1957974fda"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#ad1e9fc834093c8b35c0f8c1957974fda">OpenWithNoBuffering</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>, const char *mode)</td></tr>
|
|
<tr class="separator:ad1e9fc834093c8b35c0f8c1957974fda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92cdfd68e6384dfcc14c78b20c98368e"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a92cdfd68e6384dfcc14c78b20c98368e">Delete</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>)</td></tr>
|
|
<tr class="separator:a92cdfd68e6384dfcc14c78b20c98368e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6981994874ee5832e3394744fd51fd79"><td class="memItemLeft" align="right" valign="top">static int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a6981994874ee5832e3394744fd51fd79">GetFileSize</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>)</td></tr>
|
|
<tr class="separator:a6981994874ee5832e3394744fd51fd79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a622dbc8abacebb40b816aa0174ba7c60"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a622dbc8abacebb40b816aa0174ba7c60">ReadFileToString</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>, std::string *contents)</td></tr>
|
|
<tr class="separator:a622dbc8abacebb40b816aa0174ba7c60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afacdff207ba8359eaa029d8b1414c641"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#afacdff207ba8359eaa029d8b1414c641">Copy</a> (const char *from_file_name, const char *to_file_name)</td></tr>
|
|
<tr class="separator:afacdff207ba8359eaa029d8b1414c641"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c218b7f815bae0f48800b385ddce67e"><td class="memItemLeft" align="right" valign="top">static int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a1c218b7f815bae0f48800b385ddce67e">CopyFile</a> (<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *source, <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *destination)</td></tr>
|
|
<tr class="separator:a1c218b7f815bae0f48800b385ddce67e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f5ebcd3bdebb7fb02a7a7adf378b344"><td class="memItemLeft" align="right" valign="top">static int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a9f5ebcd3bdebb7fb02a7a7adf378b344">CopyFile</a> (<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *source, <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *destination, int64_t max_copy)</td></tr>
|
|
<tr class="separator:a9f5ebcd3bdebb7fb02a7a7adf378b344"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a476502e5ab3eaed4427fd3b8468211ce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a476502e5ab3eaed4427fd3b8468211ce"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>File</b> (const std::string &<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>)</td></tr>
|
|
<tr class="separator:a476502e5ab3eaed4427fd3b8468211ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb5c0673c6d8120d636385a1ad3b3f71"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#aeb5c0673c6d8120d636385a1ad3b3f71">~File</a> ()</td></tr>
|
|
<tr class="separator:aeb5c0673c6d8120d636385a1ad3b3f71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad6b77e734bb22d077ece029c9e735a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad6b77e734bb22d077ece029c9e735a4"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#aad6b77e734bb22d077ece029c9e735a4">Open</a> ()=0</td></tr>
|
|
<tr class="memdesc:aad6b77e734bb22d077ece029c9e735a4"><td class="mdescLeft"> </td><td class="mdescRight">Internal open. Should not be used directly. <br/></td></tr>
|
|
<tr class="separator:aad6b77e734bb22d077ece029c9e735a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a9bc31f0290fe6edb8a0e3f9b61825325"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bc31f0290fe6edb8a0e3f9b61825325"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>ThreadedIoFile</b></td></tr>
|
|
<tr class="separator:a9bc31f0290fe6edb8a0e3f9b61825325"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Define an abstract file interface. </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../d2/d4d/file_8h_source.html#l00024">24</a> of file <a class="el" href="../../d2/d4d/file_8h_source.html">file.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="aeb5c0673c6d8120d636385a1ad3b3f71"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual shaka::media::File::~File </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Do <em>not</em> call the destructor directly (with the "delete" keyword) nor use std::unique_ptr; instead use <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a2bfb0c180840356933652a795527b5c8">Close()</a>. </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../d2/d4d/file_8h_source.html#l00132">132</a> of file <a class="el" href="../../d2/d4d/file_8h_source.html">file.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a2bfb0c180840356933652a795527b5c8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool shaka::media::File::Close </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#aba73e887fbfe2de3a679c679ddf03f4b">Flush()</a> and de-allocate resources associated with this file, and delete this <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html" title="Define an abstract file interface. ">File</a> object. THIS IS THE ONE TRUE WAY TO DEALLOCATE THIS OBJECT. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success. For writable files, returning false MAY INDICATE DATA LOSS. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a4a85d185a7eaa1abc857540ef703ab9a">shaka::media::ThreadedIoFile</a>, <a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#aeff24fee715763b5a62edd0d3b3c114e">shaka::media::UdpFile</a>, <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html#a8bc11d5bf5ee05904620ab3816c6eaf4">shaka::media::LocalFile</a>, and <a class="el" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#ae6008d3d8401bd9eb561165e142afc6b">shaka::media::MemoryFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afacdff207ba8359eaa029d8b1414c641"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool shaka::media::File::Copy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>from_file_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>to_file_name</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>Copies files. This is not good for copying huge files. Although not recommended, it is safe to have source file and destination file name be the same. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">from_file_name</td><td>is the source file name. </td></tr>
|
|
<tr><td class="paramname">to_file_name</td><td>is the destination file name. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d5/dfc/file_8cc_source.html#l00203">203</a> of file <a class="el" href="../../d5/dfc/file_8cc_source.html">file.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1c218b7f815bae0f48800b385ddce67e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t shaka::media::File::CopyFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> * </td>
|
|
<td class="paramname"><em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> * </td>
|
|
<td class="paramname"><em>destination</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>Copies the contents from source to destination. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">source</td><td>The file to copy from. </td></tr>
|
|
<tr><td class="paramname">destination</td><td>The file to copy to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written, or a value < 0 on error. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d5/dfc/file_8cc_source.html#l00232">232</a> of file <a class="el" href="../../d5/dfc/file_8cc_source.html">file.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9f5ebcd3bdebb7fb02a7a7adf378b344"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t shaka::media::File::CopyFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> * </td>
|
|
<td class="paramname"><em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> * </td>
|
|
<td class="paramname"><em>destination</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int64_t </td>
|
|
<td class="paramname"><em>max_copy</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>Copies the contents from source to destination. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">source</td><td>The file to copy from. </td></tr>
|
|
<tr><td class="paramname">destination</td><td>The file to copy to. </td></tr>
|
|
<tr><td class="paramname">max_copy</td><td>The maximum number of bytes to copy; < 0 to copy to EOF. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written, or a value < 0 on error. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d5/dfc/file_8cc_source.html#l00236">236</a> of file <a class="el" href="../../d5/dfc/file_8cc_source.html">file.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a92cdfd68e6384dfcc14c78b20c98368e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool shaka::media::File::Delete </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_name</em></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>Delete the specified file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_name</td><td>contains the path of the file to be deleted. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d5/dfc/file_8cc_source.html#l00163">163</a> of file <a class="el" href="../../d5/dfc/file_8cc_source.html">file.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abe158b9e7b1e073956a16c55a8fcf5f4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string& shaka::media::File::file_name </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The file name. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d2/d4d/file_8h_source.html#l00091">91</a> of file <a class="el" href="../../d2/d4d/file_8h_source.html">file.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aba73e887fbfe2de3a679c679ddf03f4b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool shaka::media::File::Flush </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Flush the file so that recently written data will survive an application crash (but not necessarily an OS crash). For instance, in <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html" title="Implement LocalFile which deals with local storage. ">LocalFile</a> the data is flushed into the OS but not necessarily to disk. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a4c8d46b1a16fba8bf4267c0a11fa856e">shaka::media::ThreadedIoFile</a>, <a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a66276fd0b6a7effe314ccd63e223d149">shaka::media::UdpFile</a>, <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html#ad09f01654ef3109b66e3fb5dd9730516">shaka::media::LocalFile</a>, and <a class="el" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#abc1d0dc10b8ad719b92959c72c394b64">shaka::media::MemoryFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6981994874ee5832e3394744fd51fd79"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t shaka::media::File::GetFileSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_name</em></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">
|
|
<dl class="section return"><dt>Returns</dt><dd>The size of a file in bytes on success, a value < 0 otherwise. The file will be opened and closed in the process. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d5/dfc/file_8cc_source.html#l00176">176</a> of file <a class="el" href="../../d5/dfc/file_8cc_source.html">file.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a921efa1c8f7978e3b5aac33d648b0250"></a>
|
|
<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="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> * shaka::media::File::Open </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>mode</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>Open the specified file. This is a file factory method, it opens a proper file automatically based on prefix, e.g. "file://" for <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html" title="Implement LocalFile which deals with local storage. ">LocalFile</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_name</td><td>contains the name of the file to be accessed. </td></tr>
|
|
<tr><td class="paramname">mode</td><td>contains file access mode. Implementation dependent. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html" title="Define an abstract file interface. ">File</a> pointer on success, false otherwise. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d5/dfc/file_8cc_source.html#l00141">141</a> of file <a class="el" href="../../d5/dfc/file_8cc_source.html">file.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad1e9fc834093c8b35c0f8c1957974fda"></a>
|
|
<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="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> * shaka::media::File::OpenWithNoBuffering </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>mode</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>Open the specified file in direct-access mode (no buffering). This is a file factory method, it opens a proper file automatically based on prefix, e.g. "file://" for <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html" title="Implement LocalFile which deals with local storage. ">LocalFile</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_name</td><td>contains the name of the file to be accessed. </td></tr>
|
|
<tr><td class="paramname">mode</td><td>contains file access mode. Implementation dependent. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html" title="Define an abstract file interface. ">File</a> pointer on success, false otherwise. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d5/dfc/file_8cc_source.html#l00152">152</a> of file <a class="el" href="../../d5/dfc/file_8cc_source.html">file.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aed0c0793fd8751330583314a4d3012b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int64_t shaka::media::File::Read </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>length</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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Read data and return it in buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>points to a block of memory with a size of at least <em>length</em> bytes. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">length</td><td>indicates number of bytes to be read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes read, or a value < 0 on error. Zero on end-of-file, or if 'length' is zero. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a5bd05e37779441004cd7ba0c33de1ad6">shaka::media::ThreadedIoFile</a>, <a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a9e6387d6c23e6cfd7a91ed432fe3e81c">shaka::media::UdpFile</a>, <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html#a65a1abae386202a08deb5bfa8aeef7c1">shaka::media::LocalFile</a>, and <a class="el" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#aac5f63ba0bb136eac2260a034edc10cf">shaka::media::MemoryFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a622dbc8abacebb40b816aa0174ba7c60"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool shaka::media::File::ReadFileToString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::string * </td>
|
|
<td class="paramname"><em>contents</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>Read the file into string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_name</td><td>is the file to be read. It should be a valid file. </td></tr>
|
|
<tr><td class="paramname">contents[out]</td><td>points to the output string. Should not be NULL. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d5/dfc/file_8cc_source.html#l00185">185</a> of file <a class="el" href="../../d5/dfc/file_8cc_source.html">file.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3baaa3207abaeb6af1a8239ee866b5d3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool shaka::media::File::Seek </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>position</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Seek to the specifield position in the file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">position</td><td>is the position to seek to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a4a30faf9c8e8b367bcfebb7b642d73e7">shaka::media::ThreadedIoFile</a>, <a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a78fa34d29e01054536a19eaac7ed51c4">shaka::media::UdpFile</a>, <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html#a6cb6e6bf3a47fbcda6d759ff4f551939">shaka::media::LocalFile</a>, and <a class="el" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#af99f8c96589175e9a2f386e6a2ed4f35">shaka::media::MemoryFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adffa2c3d12ae0a579704cf1f5b3bf8ab"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int64_t shaka::media::File::Size </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>Size of the file in bytes. A return value less than zero indicates a problem getting the size. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#ac8c1f49d9e7ff55b1484129240c065f3">shaka::media::ThreadedIoFile</a>, <a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a852424c6982850686f0419e84e222708">shaka::media::UdpFile</a>, <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html#a4cc3427bb01a0989de7711b2a004a099">shaka::media::LocalFile</a>, and <a class="el" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#ad52955a976c16b910dde372fe33b7b0d">shaka::media::MemoryFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a57dd80258b1989f85d99c154ba377db8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool shaka::media::File::Tell </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint64_t * </td>
|
|
<td class="paramname"><em>position</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the current file position. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">position</td><td>is a pointer to contain the current file position upon successful return. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on succcess, false otherwise. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a23949d75527c8de9f02e749c7744f11e">shaka::media::ThreadedIoFile</a>, <a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#affb3b5c69847e5f40671e65a7110358c">shaka::media::UdpFile</a>, <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html#ad8dd99ee399830616cd23869ed35d768">shaka::media::LocalFile</a>, and <a class="el" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a0346e0c4f961c06041efeaf43aee8f03">shaka::media::MemoryFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3149670c0d085e71f0aa085ee87fdda5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int64_t shaka::media::File::Write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>length</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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Write block of data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buffer</td><td>points to a block of memory with at least <em>length</em> bytes. </td></tr>
|
|
<tr><td class="paramname">length</td><td>indicates number of bytes to write. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written, or a value < 0 on error. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#aa14502dd48c1c64329283f5f1340f60f">shaka::media::ThreadedIoFile</a>, <a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a7039c2dbc214f755a9eaaab4d3e10cb9">shaka::media::UdpFile</a>, <a class="el" href="../../d9/de6/classshaka_1_1media_1_1LocalFile.html#ac23125695f0cfe77adee36df9650da8b">shaka::media::LocalFile</a>, and <a class="el" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a429e316e7bf529acb3586df1cd02be64">shaka::media::MemoryFile</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>media/file/<a class="el" href="../../d2/d4d/file_8h_source.html">file.h</a></li>
|
|
<li>media/file/<a class="el" href="../../d5/dfc/file_8cc_source.html">file.cc</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Mar 30 2017 21:39:11 for DASH Media Packaging SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|