diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_audio.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_audio.html | 280 |
1 files changed, 280 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_audio.html b/docs/class_tg_bot_1_1_audio.html new file mode 100644 index 0000000..a70737d --- /dev/null +++ b/docs/class_tg_bot_1_1_audio.html @@ -0,0 +1,280 @@ +<!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.11"/> +<title>tgbot-cpp: TgBot::Audio 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</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> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</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">tgbot-cpp + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.11 --> +<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="modules.html"><span>Modules</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> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('class_tg_bot_1_1_audio.html','');}); +</script> +<div id="doc-content"> +<!-- 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 class="header"> + <div class="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="class_tg_bot_1_1_audio-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::Audio Class Reference<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>This object represents an audio file (voice note). + <a href="class_tg_bot_1_1_audio.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_audio_8h_source.html">Audio.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a09651872832ece3b22c7505a2cfc0034"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_audio.html">Audio</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_audio.html#a09651872832ece3b22c7505a2cfc0034">Ptr</a></td></tr> +<tr class="separator:a09651872832ece3b22c7505a2cfc0034"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:accecab325a61cce4c4260923d21e2726"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_audio.html#accecab325a61cce4c4260923d21e2726">fileId</a></td></tr> +<tr class="memdesc:accecab325a61cce4c4260923d21e2726"><td class="mdescLeft"> </td><td class="mdescRight">Unique identifier for this file. <a href="#accecab325a61cce4c4260923d21e2726">More...</a><br /></td></tr> +<tr class="separator:accecab325a61cce4c4260923d21e2726"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a91867bc1857d43021c352781c8b1764d"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_audio.html#a91867bc1857d43021c352781c8b1764d">duration</a></td></tr> +<tr class="memdesc:a91867bc1857d43021c352781c8b1764d"><td class="mdescLeft"> </td><td class="mdescRight">Duration of the audio in seconds as defined by sender. <a href="#a91867bc1857d43021c352781c8b1764d">More...</a><br /></td></tr> +<tr class="separator:a91867bc1857d43021c352781c8b1764d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac91ee59f6137da2da2f7c8ad6d1e9119"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_audio.html#ac91ee59f6137da2da2f7c8ad6d1e9119">performer</a></td></tr> +<tr class="memdesc:ac91ee59f6137da2da2f7c8ad6d1e9119"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Performer of the audio as defined by sender or by audio tags. <a href="#ac91ee59f6137da2da2f7c8ad6d1e9119">More...</a><br /></td></tr> +<tr class="separator:ac91ee59f6137da2da2f7c8ad6d1e9119"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a93a600b9821a425e31e51fdee027e1b4"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_audio.html#a93a600b9821a425e31e51fdee027e1b4">title</a></td></tr> +<tr class="memdesc:a93a600b9821a425e31e51fdee027e1b4"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Title of the audio as defined by sender or by audio tags. <a href="#a93a600b9821a425e31e51fdee027e1b4">More...</a><br /></td></tr> +<tr class="separator:a93a600b9821a425e31e51fdee027e1b4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0657e6fec492919e086084ab07bcf7ae"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_audio.html#a0657e6fec492919e086084ab07bcf7ae">mimeType</a></td></tr> +<tr class="memdesc:a0657e6fec492919e086084ab07bcf7ae"><td class="mdescLeft"> </td><td class="mdescRight">Optional. MIME type of the file as defined by sender. <a href="#a0657e6fec492919e086084ab07bcf7ae">More...</a><br /></td></tr> +<tr class="separator:a0657e6fec492919e086084ab07bcf7ae"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae874fb9f864741e2df69287c57fbd035"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_audio.html#ae874fb9f864741e2df69287c57fbd035">fileSize</a></td></tr> +<tr class="memdesc:ae874fb9f864741e2df69287c57fbd035"><td class="mdescLeft"> </td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_file.html" title="This object represents a file ready to be downloaded. ">File</a> size. <a href="#ae874fb9f864741e2df69287c57fbd035">More...</a><br /></td></tr> +<tr class="separator:ae874fb9f864741e2df69287c57fbd035"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This object represents an audio file (voice note). </p> + +<p>Definition at line <a class="el" href="_audio_8h_source.html#l00036">36</a> of file <a class="el" href="_audio_8h_source.html">Audio.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a class="anchor" id="a09651872832ece3b22c7505a2cfc0034"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef std::shared_ptr<<a class="el" href="class_tg_bot_1_1_audio.html">Audio</a>> <a class="el" href="class_tg_bot_1_1_audio.html#a09651872832ece3b22c7505a2cfc0034">TgBot::Audio::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_audio_8h_source.html#l00039">39</a> of file <a class="el" href="_audio_8h_source.html">Audio.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a91867bc1857d43021c352781c8b1764d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::Audio::duration</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Duration of the audio in seconds as defined by sender. </p> + +<p>Definition at line <a class="el" href="_audio_8h_source.html#l00049">49</a> of file <a class="el" href="_audio_8h_source.html">Audio.h</a>.</p> + +</div> +</div> +<a class="anchor" id="accecab325a61cce4c4260923d21e2726"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Audio::fileId</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Unique identifier for this file. </p> + +<p>Definition at line <a class="el" href="_audio_8h_source.html#l00044">44</a> of file <a class="el" href="_audio_8h_source.html">Audio.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ae874fb9f864741e2df69287c57fbd035"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::Audio::fileSize</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. <a class="el" href="class_tg_bot_1_1_file.html" title="This object represents a file ready to be downloaded. ">File</a> size. </p> + +<p>Definition at line <a class="el" href="_audio_8h_source.html#l00071">71</a> of file <a class="el" href="_audio_8h_source.html">Audio.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a0657e6fec492919e086084ab07bcf7ae"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Audio::mimeType</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. MIME type of the file as defined by sender. </p> + +<p>Definition at line <a class="el" href="_audio_8h_source.html#l00066">66</a> of file <a class="el" href="_audio_8h_source.html">Audio.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ac91ee59f6137da2da2f7c8ad6d1e9119"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Audio::performer</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. Performer of the audio as defined by sender or by audio tags. </p> + +<p>Definition at line <a class="el" href="_audio_8h_source.html#l00055">55</a> of file <a class="el" href="_audio_8h_source.html">Audio.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a93a600b9821a425e31e51fdee027e1b4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Audio::title</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. Title of the audio as defined by sender or by audio tags. </p> + +<p>Definition at line <a class="el" href="_audio_8h_source.html#l00061">61</a> of file <a class="el" href="_audio_8h_source.html">Audio.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/tgbot/types/<a class="el" href="_audio_8h_source.html">Audio.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="class_tg_bot_1_1_audio.html">Audio</a></li> + <li class="footer">Generated on Fri Jun 22 2018 22:14:16 for tgbot-cpp by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li> + </ul> +</div> +</body> +</html> |