311 lines
19 KiB
HTML
311 lines
19 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::Status 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="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="../../d0/d80/classshaka_1_1media_1_1Status-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">shaka::media::Status Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<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:abb1d7be8e22d23adff199fdf1a5c8639"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb1d7be8e22d23adff199fdf1a5c8639"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html#abb1d7be8e22d23adff199fdf1a5c8639">Status</a> ()</td></tr>
|
|
<tr class="memdesc:abb1d7be8e22d23adff199fdf1a5c8639"><td class="mdescLeft"> </td><td class="mdescRight">Creates a "successful" status. <br/></td></tr>
|
|
<tr class="separator:abb1d7be8e22d23adff199fdf1a5c8639"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a676879d7464117a9d29281f7fa25b005"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html#a676879d7464117a9d29281f7fa25b005">Status</a> (error::Code error_code, const std::string &error_message)</td></tr>
|
|
<tr class="separator:a676879d7464117a9d29281f7fa25b005"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26903fbb0ee18f6b8d7cd441e922b644"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html#a26903fbb0ee18f6b8d7cd441e922b644">SetError</a> (error::Code error_code, const std::string &error_message)</td></tr>
|
|
<tr class="separator:a26903fbb0ee18f6b8d7cd441e922b644"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74d29f349b4673d2eef69a47f5152fe4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html#a74d29f349b4673d2eef69a47f5152fe4">Update</a> (const <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> &new_status)</td></tr>
|
|
<tr class="separator:a74d29f349b4673d2eef69a47f5152fe4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3abb4bb8075e30af97b671017e6c18ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3abb4bb8075e30af97b671017e6c18ca"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html#a3abb4bb8075e30af97b671017e6c18ca">Clear</a> ()</td></tr>
|
|
<tr class="memdesc:a3abb4bb8075e30af97b671017e6c18ca"><td class="mdescLeft"> </td><td class="mdescRight">Clear this status object to contain the OK code and no error message. <br/></td></tr>
|
|
<tr class="separator:a3abb4bb8075e30af97b671017e6c18ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab27678cdd8279673221f7bc5031783b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab27678cdd8279673221f7bc5031783b0"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ok</b> () const </td></tr>
|
|
<tr class="separator:ab27678cdd8279673221f7bc5031783b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12be79e01f5f47ded221cb1e4945295c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12be79e01f5f47ded221cb1e4945295c"></a>
|
|
error::Code </td><td class="memItemRight" valign="bottom"><b>error_code</b> () const </td></tr>
|
|
<tr class="separator:a12be79e01f5f47ded221cb1e4945295c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabbcd41dd252394e539c8082389a90da"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabbcd41dd252394e539c8082389a90da"></a>
|
|
const std::string & </td><td class="memItemRight" valign="bottom"><b>error_message</b> () const </td></tr>
|
|
<tr class="separator:aabbcd41dd252394e539c8082389a90da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c2f1565645c8d23d3d00e9bddf120f2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c2f1565645c8d23d3d00e9bddf120f2"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> &x) const </td></tr>
|
|
<tr class="separator:a6c2f1565645c8d23d3d00e9bddf120f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7713f31ad70a59baa18615440b5a574f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7713f31ad70a59baa18615440b5a574f"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> &x) const </td></tr>
|
|
<tr class="separator:a7713f31ad70a59baa18615440b5a574f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a94b3ef32cf301bbb258c44ca180eba"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html#a2a94b3ef32cf301bbb258c44ca180eba">Matches</a> (const <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> &x) const </td></tr>
|
|
<tr class="separator:a2a94b3ef32cf301bbb258c44ca180eba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5d67e71539ca2f3589d3b2d4dc9ad60"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html#ac5d67e71539ca2f3589d3b2d4dc9ad60">ToString</a> () const </td></tr>
|
|
<tr class="separator:ac5d67e71539ca2f3589d3b2d4dc9ad60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6b23307d2269d10a6c51ca0da8f6555"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6b23307d2269d10a6c51ca0da8f6555"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Swap</b> (<a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> *other)</td></tr>
|
|
<tr class="separator:af6b23307d2269d10a6c51ca0da8f6555"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Some pre-defined Status objects.</div></td></tr>
|
|
<tr class="memitem:af006497c21d50a1b43d7869e5fe1cbd9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af006497c21d50a1b43d7869e5fe1cbd9"></a>
|
|
static const <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>OK</b> = <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a>(error::OK, "")</td></tr>
|
|
<tr class="separator:af006497c21d50a1b43d7869e5fe1cbd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a641edfbcf20753c69bbbc357e03e84ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a641edfbcf20753c69bbbc357e03e84ef"></a>
|
|
static const <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>UNKNOWN</b> = <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a>(error::UNKNOWN, "")</td></tr>
|
|
<tr class="separator:a641edfbcf20753c69bbbc357e03e84ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p>Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00085">85</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a676879d7464117a9d29281f7fa25b005"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">shaka::media::Status::Status </td>
|
|
<td>(</td>
|
|
<td class="paramtype">error::Code </td>
|
|
<td class="paramname"><em>error_code</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>error_message</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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Create a status with the specified code, and error message. If "error_code == error::OK", error_message is ignored and a <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> object identical to Status::OK is constructed. </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00093">93</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a2a94b3ef32cf301bbb258c44ca180eba"></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::Status::Matches </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> & </td>
|
|
<td class="paramname"><em>x</em></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>true iff this has the same error_code as "x", i.e., the two <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> objects are identical except possibly for the error message. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00150">150</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a26903fbb0ee18f6b8d7cd441e922b644"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void shaka::media::Status::SetError </td>
|
|
<td>(</td>
|
|
<td class="paramtype">error::Code </td>
|
|
<td class="paramname"><em>error_code</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>error_message</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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Store the specified error in this <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> object. If "error_code == error::OK", error_message is ignored and a <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> object identical to Status::OK is constructed. </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00110">110</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac5d67e71539ca2f3589d3b2d4dc9ad60"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string shaka::media::Status::ToString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>A combination of the error code name and message. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../da/dc3/status_8cc_source.html#l00068">68</a> of file <a class="el" href="../../da/dc3/status_8cc_source.html">status.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a74d29f349b4673d2eef69a47f5152fe4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void shaka::media::Status::Update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> & </td>
|
|
<td class="paramname"><em>new_status</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If "ok()", stores "new_status" into *this. If "!ok()", preserves the current "error_code()/error_message()",</p>
|
|
<p>Convenient way of keeping track of the first error encountered. Instead of: if (overall_status.ok()) overall_status = new_status Use: overall_status.Update(new_status); </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00127">127</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>media/base/<a class="el" href="../../d1/d13/status_8h_source.html">status.h</a></li>
|
|
<li>media/base/<a class="el" href="../../da/dc3/status_8cc_source.html">status.cc</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Mar 23 2017 23:54:13 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>
|