-
Notifications
You must be signed in to change notification settings - Fork 2
/
encoded_video.html
281 lines (249 loc) · 28.2 KB
/
encoded_video.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Encoded Video — C++ SDK 2.6.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Audio" href="audio.html" />
<link rel="prev" title="Raw Video" href="raw_video.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home">
C++ SDK
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other/getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other/run_time_deps.html">Run Time Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other/supported_platforms.html">Supported Platforms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../coresdk.html">Core API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../media_io.html">Media IO API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../media_io.html#injection">Injection</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../media_io.html#recording">Recording</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="raw_video.html">Raw Video</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Encoded Video</a></li>
<li class="toctree-l3"><a class="reference internal" href="audio.html">Audio</a></li>
<li class="toctree-l3"><a class="reference internal" href="events.html">Media Recording Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="example.html">Example Recorder Implementation</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../plugins.html">Plugins</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">C++ SDK</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../media_io.html">Media IO API</a></li>
<li class="breadcrumb-item active">Encoded Video</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/api/recording/encoded_video.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="encoded-video">
<span id="api-record-encoded"></span><h1>Encoded Video<a class="headerlink" href="#encoded-video" title="Permalink to this heading"></a></h1>
<p>#include <dolbyio/comms/media_engine/media_engine.h></p>
<p>The interface for handling encoded video frames. Application must set listeners which override both of the virtual functions. The
<a class="reference internal" href="#_CPPv4N7dolbyio5comms18video_sink_encoded20handle_frame_encodedERKNSt6stringENSt10unique_ptrI19encoded_video_frameEE" title="dolbyio::comms::video_sink_encoded::handle_frame_encoded"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">handle_frame_encoded</span></code></a> function is called after the RTP data is depacktized and an encoded frame
is constructed. This function will be executed on the Webrtc DecodingQueue thread created for the track to which the encoded frames belong. The Encoded Video Sink must be provided to the SDK using the
<code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">Set</span> <span class="pre">Encoded</span> <span class="pre">Sink</span></code> function.</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms18video_sink_encodedE">
<span id="_CPPv3N7dolbyio5comms18video_sink_encodedE"></span><span id="_CPPv2N7dolbyio5comms18video_sink_encodedE"></span><span id="dolbyio::comms::video_sink_encoded"></span><span class="target" id="classdolbyio_1_1comms_1_1video__sink__encoded"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">video_sink_encoded</span></span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms18video_sink_encodedE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The interface for receiving the encoded video frames. </p>
<p>Subclassed by <a class="reference internal" href="../sdk/recorder.html#classdolbyio_1_1comms_1_1plugin_1_1recorder"><span class="std std-ref">dolbyio::comms::plugin::recorder</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-types">Public Types</p>
<dl class="cpp enum-class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms18video_sink_encoded14decoder_configE">
<span id="_CPPv3N7dolbyio5comms18video_sink_encoded14decoder_configE"></span><span id="_CPPv2N7dolbyio5comms18video_sink_encoded14decoder_configE"></span><span class="target" id="classdolbyio_1_1comms_1_1video__sink__encoded_1a1a12ed730277e07bdeb6b19b7d522c09"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">decoder_config</span></span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms18video_sink_encoded14decoder_configE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The desired configuration of the decoder passing frames to this encoded sink. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms18video_sink_encoded14decoder_config13full_decodingE">
<span id="_CPPv3N7dolbyio5comms18video_sink_encoded14decoder_config13full_decodingE"></span><span id="_CPPv2N7dolbyio5comms18video_sink_encoded14decoder_config13full_decodingE"></span><span class="target" id="classdolbyio_1_1comms_1_1video__sink__encoded_1a1a12ed730277e07bdeb6b19b7d522c09a59f0b5afe649ae9eaf8350d0af9ddb71"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">full_decoding</span></span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms18video_sink_encoded14decoder_config13full_decodingE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The decoder will decode every single frame. In this case applications can connect both a <a class="reference internal" href="../sdk/video.html#classdolbyio_1_1comms_1_1video__sink"><span class="std std-ref">video_sink</span></a> and a <a class="reference internal" href="#classdolbyio_1_1comms_1_1video__sink__encoded"><span class="std std-ref">video_sink_encoded</span></a> to recieve video streams. This allows them to both dump video to file and render it on screen for instance. </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms18video_sink_encoded14decoder_config18optimized_decodingE">
<span id="_CPPv3N7dolbyio5comms18video_sink_encoded14decoder_config18optimized_decodingE"></span><span id="_CPPv2N7dolbyio5comms18video_sink_encoded14decoder_config18optimized_decodingE"></span><span class="target" id="classdolbyio_1_1comms_1_1video__sink__encoded_1a1a12ed730277e07bdeb6b19b7d522c09a8d29e67aba1633407df2512468460548"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">optimized_decoding</span></span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms18video_sink_encoded14decoder_config18optimized_decodingE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The decoder will only decode the first frame. In this case applications will not receive any decoded video frames if they set a <a class="reference internal" href="../sdk/video.html#classdolbyio_1_1comms_1_1video__sink"><span class="std std-ref">video_sink</span></a>. This decoder configuration greatly optimized CPU load by not decoding every frame but is useful for applications which only want to dump encoded video to file. </p>
</dd></dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms18video_sink_encoded22configure_encoded_sinkERKNSt6stringERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms18video_sink_encoded22configure_encoded_sinkERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms18video_sink_encoded22configure_encoded_sinkERKNSt6stringERKNSt6stringE"></span><span id="dolbyio::comms::video_sink_encoded::configure_encoded_sink__ssCR.ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1video__sink__encoded_1ab07e55e44d6ceb471762465af0fa9b40"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N7dolbyio5comms18video_sink_encoded14decoder_configE" title="dolbyio::comms::video_sink_encoded::decoder_config"><span class="n"><span class="pre">decoder_config</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">configure_encoded_sink</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">codec</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">track_id</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms18video_sink_encoded22configure_encoded_sinkERKNSt6stringERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The callback that is invoked when a new video track is available. The callback allows setting the corresponding codec for the video track. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>codec</strong> – The codec of the video track. </p></li>
<li><p><strong>track_id</strong> – The ID of the video track.</p></li>
</ul>
</dd>
<dt class="field-even">Return values<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>true</strong> – The sink would like to use optimized decoding, meaning that all incoming video frames are discarded and not decoded after being passed to the handle_frame_encoded function. </p></li>
<li><p><strong>false</strong> – The sink would like to use full decoding, meaning that all the incoming frames are decoded. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms18video_sink_encoded21decoder_configurationEv">
<span id="_CPPv3NK7dolbyio5comms18video_sink_encoded21decoder_configurationEv"></span><span id="_CPPv2NK7dolbyio5comms18video_sink_encoded21decoder_configurationEv"></span><span id="dolbyio::comms::video_sink_encoded::decoder_configurationC"></span><span class="target" id="classdolbyio_1_1comms_1_1video__sink__encoded_1a4b3c08a7622d867e3c4c0bd26c0da330"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N7dolbyio5comms18video_sink_encoded14decoder_configE" title="dolbyio::comms::video_sink_encoded::decoder_config"><span class="n"><span class="pre">decoder_config</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">decoder_configuration</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms18video_sink_encoded21decoder_configurationEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The callback that is invoked to check the set decoder configuration. This allows the SDK to check if optimized decoding has been configured, if optimized decoding is set then the decoder will only decode the first frame. This means that applications can only connect an encoded video sink. When using full_decoding an application can connect a <a class="reference internal" href="../sdk/video.html#classdolbyio_1_1comms_1_1video__sink"><span class="std std-ref">video_sink</span></a> and an <a class="reference internal" href="#classdolbyio_1_1comms_1_1video__sink__encoded"><span class="std std-ref">video_sink_encoded</span></a> so it can render video frames and also dump them to file for instance. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The desired decoder configuration for the Encoded Video Sink. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms18video_sink_encoded20handle_frame_encodedERKNSt6stringENSt10unique_ptrI19encoded_video_frameEE">
<span id="_CPPv3N7dolbyio5comms18video_sink_encoded20handle_frame_encodedERKNSt6stringENSt10unique_ptrI19encoded_video_frameEE"></span><span id="_CPPv2N7dolbyio5comms18video_sink_encoded20handle_frame_encodedERKNSt6stringENSt10unique_ptrI19encoded_video_frameEE"></span><span id="dolbyio::comms::video_sink_encoded::handle_frame_encoded__ssCR.std::unique_ptr:encoded_video_frame:"></span><span class="target" id="classdolbyio_1_1comms_1_1video__sink__encoded_1a0d33ded11ce3737c8b4b48d44a4f1942"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">handle_frame_encoded</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">track_id</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms19encoded_video_frameE" title="dolbyio::comms::encoded_video_frame"><span class="n"><span class="pre">encoded_video_frame</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">frame</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms18video_sink_encoded20handle_frame_encodedERKNSt6stringENSt10unique_ptrI19encoded_video_frameEE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The callback that is invoked when a new encoded video frame is ready to be processed. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>track_id</strong> – The ID of the video track. </p></li>
<li><p><strong>frame</strong> – The encoded video frame. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms19encoded_video_frameE">
<span id="_CPPv3N7dolbyio5comms19encoded_video_frameE"></span><span id="_CPPv2N7dolbyio5comms19encoded_video_frameE"></span><span id="dolbyio::comms::encoded_video_frame"></span><span class="target" id="classdolbyio_1_1comms_1_1encoded__video__frame"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">encoded_video_frame</span></span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms19encoded_video_frameE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The interface that wraps encoded video frames received from the conference. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms19encoded_video_frameD0Ev">
<span id="_CPPv3N7dolbyio5comms19encoded_video_frameD0Ev"></span><span id="_CPPv2N7dolbyio5comms19encoded_video_frameD0Ev"></span><span id="dolbyio::comms::encoded_video_frame::~encoded_video_frame"></span><span class="target" id="classdolbyio_1_1comms_1_1encoded__video__frame_1a0b835a39d0a89199e2c2d3707e893b2a"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">~encoded_video_frame</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">default</span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms19encoded_video_frameD0Ev" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms19encoded_video_frame4dataEv">
<span id="_CPPv3NK7dolbyio5comms19encoded_video_frame4dataEv"></span><span id="_CPPv2NK7dolbyio5comms19encoded_video_frame4dataEv"></span><span id="dolbyio::comms::encoded_video_frame::dataC"></span><span class="target" id="classdolbyio_1_1comms_1_1encoded__video__frame_1acb7cfb056b114a0b4221ae2e9eb88d71"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">data</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms19encoded_video_frame4dataEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Returns the binary data containing the frame payload. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The non-null pointer to the payload data. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms19encoded_video_frame4sizeEv">
<span id="_CPPv3NK7dolbyio5comms19encoded_video_frame4sizeEv"></span><span id="_CPPv2NK7dolbyio5comms19encoded_video_frame4sizeEv"></span><span id="dolbyio::comms::encoded_video_frame::sizeC"></span><span class="target" id="classdolbyio_1_1comms_1_1encoded__video__frame_1ae4c30c02c644259d4975375d3b8e7977"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">size</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms19encoded_video_frame4sizeEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Returns the size of the payload. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The size of the payload in bytes. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms19encoded_video_frame5widthEv">
<span id="_CPPv3NK7dolbyio5comms19encoded_video_frame5widthEv"></span><span id="_CPPv2NK7dolbyio5comms19encoded_video_frame5widthEv"></span><span id="dolbyio::comms::encoded_video_frame::widthC"></span><span class="target" id="classdolbyio_1_1comms_1_1encoded__video__frame_1abc1bd1845ced5e0d2116ac88510470a2"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">width</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms19encoded_video_frame5widthEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Gets the width of the frame. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The width of the frame. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms19encoded_video_frame6heightEv">
<span id="_CPPv3NK7dolbyio5comms19encoded_video_frame6heightEv"></span><span id="_CPPv2NK7dolbyio5comms19encoded_video_frame6heightEv"></span><span id="dolbyio::comms::encoded_video_frame::heightC"></span><span class="target" id="classdolbyio_1_1comms_1_1encoded__video__frame_1afc615b0367447cf5a66e90943f8931a2"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">height</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms19encoded_video_frame6heightEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Gets the height of the video frame. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The height of the frame. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms19encoded_video_frame11is_keyframeEv">
<span id="_CPPv3NK7dolbyio5comms19encoded_video_frame11is_keyframeEv"></span><span id="_CPPv2NK7dolbyio5comms19encoded_video_frame11is_keyframeEv"></span><span id="dolbyio::comms::encoded_video_frame::is_keyframeC"></span><span class="target" id="classdolbyio_1_1comms_1_1encoded__video__frame_1aaaf5611e3a940e20ee96351b18beed50"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">is_keyframe</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms19encoded_video_frame11is_keyframeEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Checks if the frame is a key frame. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>true if keyframe, false otherwise. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<p>See <a class="reference internal" href="example.html#recording-example"><span class="std std-ref">Example Recorder Implementation</span></a> for a template for child recording class for all possible media.</p>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="raw_video.html" class="btn btn-neutral float-left" title="Raw Video" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="audio.html" class="btn btn-neutral float-right" title="Audio" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright Dolby Laboratories.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>