This repository has been archived on 2020-05-10. You can view files and clone it, but cannot push or open issues or pull requests.
mastodon-cpp/docs/attachment_8hpp_source.html

83 lines
26 KiB
HTML
Raw Normal View History

2018-06-07 19:28:24 +02:00
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mastodon-cpp: src/easy/entities/attachment.hpp Source File</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mastodon-cpp
&#160;<span id="projectnumber">0.15.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9d328871126a6a5820f3cd5c0c41741e.html">easy</a></li><li class="navelem"><a class="el" href="dir_e526f556af6ddef7955f0f6556f0f4d0.html">entities</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">attachment.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* This file is part of mastodon-cpp.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright © 2018 tastytea &lt;tastytea@tastytea.de&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * </span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * the Free Software Foundation, version 3.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * GNU General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef MASTODON_CPP_EASY_ATTACHMENT_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define MASTODON_CPP_EASY_ATTACHMENT_HPP</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;chrono&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;array&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// If we are compiling mastodon-cpp, use another include path</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#ifdef MASTODON_CPP</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor"> #include &quot;mastodon-cpp.hpp&quot;</span></div><div class="line"><a
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_acedd9aff78d53e9a39f9d607c2c76995"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#acedd9aff78d53e9a39f9d607c2c76995">Mastodon::Easy::Attachment::bitrate</a></div><div class="ttdeci">const uint_fast64_t bitrate() const</div><div class="ttdoc">Returns the bitrate of a video. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:42</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a717733a977a324b985b6bc1e1e94604b"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a717733a977a324b985b6bc1e1e94604b">Mastodon::Easy::Attachment::preview_url</a></div><div class="ttdeci">const string preview_url() const</div><div class="ttdoc">Returns the URL of the preview image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:109</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_af5110850dc29432011d909120f8751e9"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#af5110850dc29432011d909120f8751e9">Mastodon::Easy::Attachment::Attachment</a></div><div class="ttdeci">Attachment()</div><div class="ttdoc">Constructs an empty Attachment object. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:28</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a8ec922662124429305a86bb18492137f"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a8ec922662124429305a86bb18492137f">Mastodon::Easy::Attachment::description</a></div><div class="ttdeci">const string description() const</div><div class="ttdoc">Returns the image description. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:47</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html">Mastodon::Easy::Attachment</a></div><div class="ttdoc">Class to hold attachments. </div><div class="ttdef"><b>Definition:</b> attachment.hpp:42</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_acd13353d3baa1a5abf6319e6838dc366"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#acd13353d3baa1a5abf6319e6838dc366">Mastodon::Easy::Attachment::height</a></div><div class="ttdeci">const uint_fast64_t height() const</div><div class="ttdoc">Returns the height of the original image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:94</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_ad76c03c405604aa742fd2eb9ebf3fda8"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#ad76c03c405604aa742fd2eb9ebf3fda8">Mastodon::Easy::Attachment::width_small</a></div><div class="ttdeci">const uint_fast64_t width_small() const</div><div class="ttdoc">Returns the width of the preview image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:160</div></div>
<div class="ttc" id="classMastodon_1_1Easy_html_a1c6e6d9643e6739f7b9126a307b45bc1"><div class="ttname"><a href="classMastodon_1_1Easy.html#a1c6e6d9643e6739f7b9126a307b45bc1">Mastodon::Easy::attachment_type</a></div><div class="ttdeci">attachment_type</div><div class="ttdoc">Describes the attachment type. </div><div class="ttdef"><b>Definition:</b> easy.hpp:73</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a2c5bebd015bdca07ea04c34ceffca7d0"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a2c5bebd015bdca07ea04c34ceffca7d0">Mastodon::Easy::Attachment::text_url</a></div><div class="ttdeci">const string text_url() const</div><div class="ttdoc">Returns shorter URL for the image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:129</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a5925c7d1d83ab88eb4f05682eaf6f915"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a5925c7d1d83ab88eb4f05682eaf6f915">Mastodon::Easy::Attachment::size_small</a></div><div class="ttdeci">const string size_small() const</div><div class="ttdoc">Returns the size of the preview image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:124</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_ae9e55036ebf53b5d50a51d9e5e77214f"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#ae9e55036ebf53b5d50a51d9e5e77214f">Mastodon::Easy::Attachment::url</a></div><div class="ttdeci">const string url() const</div><div class="ttdoc">Returns URL of the locally hosted version of the image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:150</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a6807d0c48c33af160d5cf28888a9dff1"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a6807d0c48c33af160d5cf28888a9dff1">Mastodon::Easy::Attachment::remote_url</a></div><div class="ttdeci">const string remote_url() const</div><div class="ttdoc">Returns the remote URL of the original image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:114</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a48225d6543022f938978deebb5a0c7d8"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a48225d6543022f938978deebb5a0c7d8">Mastodon::Easy::Attachment::duration</a></div><div class="ttdeci">const std::chrono::duration&lt; double &gt; duration() const</div><div class="ttdoc">Returns the duration of a video in seconds. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:52</div></div>
<div class="ttc" id="namespaceMastodon_html"><div class="ttname"><a href="namespaceMastodon.html">Mastodon</a></div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:51</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_adef6f629a2ad41fe0e26f0da464936ff"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#adef6f629a2ad41fe0e26f0da464936ff">Mastodon::Easy::Attachment::aspect_small</a></div><div class="ttdeci">const double aspect_small() const</div><div class="ttdoc">Aspect of preview image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:37</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html">Mastodon::Easy::Entity</a></div><div class="ttdoc">Base class for all entities. </div><div class="ttdef"><b>Definition:</b> easy.hpp:225</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_ae821d32dbf632d98057da644633fe224"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#ae821d32dbf632d98057da644633fe224">Mastodon::Easy::Attachment::width</a></div><div class="ttdeci">const uint_fast64_t width() const</div><div class="ttdoc">Returns the width of the original image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:155</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a046d20fd13f5583d9878671cea34674f"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a046d20fd13f5583d9878671cea34674f">Mastodon::Easy::Attachment::size</a></div><div class="ttdeci">const string size() const</div><div class="ttdoc">Returns the size of the original image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:119</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a398d2609d4a0e2204277a80f4e740b12"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a398d2609d4a0e2204277a80f4e740b12">Mastodon::Easy::Attachment::height_small</a></div><div class="ttdeci">const uint_fast64_t height_small() const</div><div class="ttdoc">Returns the height of the preview image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:99</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a68510772d007056a2a9ffe6be6f30714"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a68510772d007056a2a9ffe6be6f30714">Mastodon::Easy::Attachment::id</a></div><div class="ttdeci">const uint_fast64_t id() const</div><div class="ttdoc">Returns the ID of the attachment. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:104</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a7241281e76bf9fb7db2364fab258b101"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a7241281e76bf9fb7db2364fab258b101">Mastodon::Easy::Attachment::focus</a></div><div class="ttdeci">const std::array&lt; double, 2 &gt; focus() const</div><div class="ttdoc">Returns the focus point (x, y) </div><div class="ttdef"><b>Definition:</b> attachment.cpp:59</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a6593f066700a4714e118b159bcffd314"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a6593f066700a4714e118b159bcffd314">Mastodon::Easy::Attachment::aspect</a></div><div class="ttdeci">const double aspect() const</div><div class="ttdoc">Aspect of original image. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:32</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Attachment_html_a3a5765cc2e6ae88c9495ee41113e5877"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Attachment.html#a3a5765cc2e6ae88c9495ee41113e5877">Mastodon::Easy::Attachment::framerate</a></div><div class="ttdeci">const double framerate() const</div><div class="ttdoc">Returns the framerate of a video in frames per second. </div><div class="ttdef"><b>Definition:</b> attachment.cpp:75</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>