forked from MPEGGroup/isobmff
-
Notifications
You must be signed in to change notification settings - Fork 0
/
group___user_data.html
529 lines (502 loc) · 30.3 KB
/
group___user_data.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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ISOBMFF: User data functions</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>
<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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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">ISOBMFF
</div>
<div id="projectbrief">ISO Base Media File Format Reference Software Documentation</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
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.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group___user_data.html',''); initResizable(); });
/* @license-end */
</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">User data functions</div> </div>
</div><!--header-->
<div class="contents">
<p>These functions allow you to access and manipulate track and movie user data.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga81308c573a254a6f033bc5aa426d5495"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga81308c573a254a6f033bc5aa426d5495">MP4GetMovieUserData</a> (<a class="el" href="group___types.html#gaf761332ad0ff61ca75dbe01c68787e6f">MP4Movie</a> theMovie, <a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> *outUserData)</td></tr>
<tr class="memdesc:ga81308c573a254a6f033bc5aa426d5495"><td class="mdescLeft"> </td><td class="mdescRight">Get the movie level user data 'udta'. <a href="group___user_data.html#ga81308c573a254a6f033bc5aa426d5495">More...</a><br /></td></tr>
<tr class="separator:ga81308c573a254a6f033bc5aa426d5495"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2e98c3aef64e89fd70503e7c2bba7933"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga2e98c3aef64e89fd70503e7c2bba7933">MP4GetTrackUserData</a> (<a class="el" href="group___types.html#ga9dc1f38be42a4f54442ddb8783d435fc">MP4Track</a> theTrack, <a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> *outUserData)</td></tr>
<tr class="memdesc:ga2e98c3aef64e89fd70503e7c2bba7933"><td class="mdescLeft"> </td><td class="mdescRight">Get the track level user data 'udta'. <a href="group___user_data.html#ga2e98c3aef64e89fd70503e7c2bba7933">More...</a><br /></td></tr>
<tr class="separator:ga2e98c3aef64e89fd70503e7c2bba7933"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3096fea1e6e8dee1d22442c19415ff91"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga3096fea1e6e8dee1d22442c19415ff91">MP4AddUserData</a> (<a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> theUserData, <a class="el" href="group___types.html#gaa530307d8785f9bd3375ea070c06ce05">MP4Handle</a> dataH, u32 userDataType, u32 *outIndex)</td></tr>
<tr class="memdesc:ga3096fea1e6e8dee1d22442c19415ff91"><td class="mdescLeft"> </td><td class="mdescRight">Adds an entry to the user data list. <a href="group___user_data.html#ga3096fea1e6e8dee1d22442c19415ff91">More...</a><br /></td></tr>
<tr class="separator:ga3096fea1e6e8dee1d22442c19415ff91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga907b92a16dbe1d73a099612ce3e2b2b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga907b92a16dbe1d73a099612ce3e2b2b4">MP4GetIndUserDataType</a> (<a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> theUserData, u32 typeIndex, u32 *outType)</td></tr>
<tr class="memdesc:ga907b92a16dbe1d73a099612ce3e2b2b4"><td class="mdescLeft"> </td><td class="mdescRight">Queries an indexed type of user data in the user data list. <a href="group___user_data.html#ga907b92a16dbe1d73a099612ce3e2b2b4">More...</a><br /></td></tr>
<tr class="separator:ga907b92a16dbe1d73a099612ce3e2b2b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga50522bb3e3297ee06c1767932d1fc640"><td class="memItemLeft" align="right" valign="top"><a id="ga50522bb3e3297ee06c1767932d1fc640"></a>
<a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga50522bb3e3297ee06c1767932d1fc640">MP4GetUserDataEntryCount</a> (<a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> theUserData, u32 userDataType, u32 *outCount)</td></tr>
<tr class="memdesc:ga50522bb3e3297ee06c1767932d1fc640"><td class="mdescLeft"> </td><td class="mdescRight">Returns the count of user data atoms of the specified type. <br /></td></tr>
<tr class="separator:ga50522bb3e3297ee06c1767932d1fc640"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga62bcb84e083bfa0e74cafed13912927f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga62bcb84e083bfa0e74cafed13912927f">MP4GetUserDataItem</a> (<a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> theUserData, <a class="el" href="group___types.html#gaa530307d8785f9bd3375ea070c06ce05">MP4Handle</a> dataH, u32 userDataType, u32 itemIndex)</td></tr>
<tr class="memdesc:ga62bcb84e083bfa0e74cafed13912927f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the contents of the requested user data item. <a href="group___user_data.html#ga62bcb84e083bfa0e74cafed13912927f">More...</a><br /></td></tr>
<tr class="separator:ga62bcb84e083bfa0e74cafed13912927f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga19b34175458e1f9c621fe58eaba938b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga19b34175458e1f9c621fe58eaba938b0">MP4GetAtomFromUserData</a> (<a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> theUserData, <a class="el" href="struct_m_p4_generic_atom_record.html">MP4GenericAtom</a> *outAtom, u32 userDataType, u32 itemIndex)</td></tr>
<tr class="memdesc:ga19b34175458e1f9c621fe58eaba938b0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the contents of the requested user data item. <a href="group___user_data.html#ga19b34175458e1f9c621fe58eaba938b0">More...</a><br /></td></tr>
<tr class="separator:ga19b34175458e1f9c621fe58eaba938b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7f080bc09103301762ce200c345b2ada"><td class="memItemLeft" align="right" valign="top"><a id="ga7f080bc09103301762ce200c345b2ada"></a>
<a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga7f080bc09103301762ce200c345b2ada">MP4GetUserDataTypeCount</a> (<a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> theUserData, u32 *outCount)</td></tr>
<tr class="memdesc:ga7f080bc09103301762ce200c345b2ada"><td class="mdescLeft"> </td><td class="mdescRight">Returns the count of user data types. <br /></td></tr>
<tr class="separator:ga7f080bc09103301762ce200c345b2ada"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6c5a3a6dcff8725a364ab514b73dbf6f"><td class="memItemLeft" align="right" valign="top"><a id="ga6c5a3a6dcff8725a364ab514b73dbf6f"></a>
<a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga6c5a3a6dcff8725a364ab514b73dbf6f">MP4DeleteUserDataItem</a> (<a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> theUserData, u32 userDataType, u32 itemIndex)</td></tr>
<tr class="memdesc:ga6c5a3a6dcff8725a364ab514b73dbf6f"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a user-data item, by index. <br /></td></tr>
<tr class="separator:ga6c5a3a6dcff8725a364ab514b73dbf6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab21c6432759bb6559e84ae0a9b983328"><td class="memItemLeft" align="right" valign="top"><a id="gab21c6432759bb6559e84ae0a9b983328"></a>
<a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#gab21c6432759bb6559e84ae0a9b983328">MP4NewUserData</a> (<a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> *outUserData)</td></tr>
<tr class="memdesc:gab21c6432759bb6559e84ae0a9b983328"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new user data list. <br /></td></tr>
<tr class="separator:gab21c6432759bb6559e84ae0a9b983328"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3860d7c5e45a292a830f1a3cb599a476"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga3860d7c5e45a292a830f1a3cb599a476">MP4NewForeignAtom</a> (<a class="el" href="struct_m_p4_generic_atom_record.html">MP4GenericAtom</a> *outAtom, u32 atomType, <a class="el" href="group___types.html#gaa530307d8785f9bd3375ea070c06ce05">MP4Handle</a> atomPayload)</td></tr>
<tr class="memdesc:ga3860d7c5e45a292a830f1a3cb599a476"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new custom atom object. <a href="group___user_data.html#ga3860d7c5e45a292a830f1a3cb599a476">More...</a><br /></td></tr>
<tr class="separator:ga3860d7c5e45a292a830f1a3cb599a476"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0d408fbd7fcf33598c2572f23acc5f35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga0d408fbd7fcf33598c2572f23acc5f35">MP4NewUUIDAtom</a> (<a class="el" href="struct_m_p4_generic_atom_record.html">MP4GenericAtom</a> *outAtom, u8 the_uuid[16], <a class="el" href="group___types.html#gaa530307d8785f9bd3375ea070c06ce05">MP4Handle</a> atomPayload)</td></tr>
<tr class="memdesc:ga0d408fbd7fcf33598c2572f23acc5f35"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new custom atom object with UUID type. <a href="group___user_data.html#ga0d408fbd7fcf33598c2572f23acc5f35">More...</a><br /></td></tr>
<tr class="separator:ga0d408fbd7fcf33598c2572f23acc5f35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9782c53734673dfd74320371defdf809"><td class="memItemLeft" align="right" valign="top"><a id="ga9782c53734673dfd74320371defdf809"></a>
<a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___user_data.html#ga9782c53734673dfd74320371defdf809">MP4GetForeignAtom</a> (<a class="el" href="struct_m_p4_generic_atom_record.html">MP4GenericAtom</a> atom, u32 *atomType, u8 the_uuid[16], <a class="el" href="group___types.html#gaa530307d8785f9bd3375ea070c06ce05">MP4Handle</a> atomPayload)</td></tr>
<tr class="memdesc:ga9782c53734673dfd74320371defdf809"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type and contents of the given foreign atom, and, if it is a UUID atom, its UUID also. <br /></td></tr>
<tr class="separator:ga9782c53734673dfd74320371defdf809"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>These functions allow you to access and manipulate track and movie user data. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga3096fea1e6e8dee1d22442c19415ff91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3096fea1e6e8dee1d22442c19415ff91">◆ </a></span>MP4AddUserData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> MP4AddUserData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> </td>
<td class="paramname"><em>theUserData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___types.html#gaa530307d8785f9bd3375ea070c06ce05">MP4Handle</a> </td>
<td class="paramname"><em>dataH</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 </td>
<td class="paramname"><em>userDataType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 * </td>
<td class="paramname"><em>outIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an entry to the user data list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">theUserData</td><td>The user data list you are modifying </td></tr>
<tr><td class="paramname">dataH</td><td>An ISOHandle containing the data you are adding </td></tr>
<tr><td class="paramname">userDataType</td><td>The atom type that will identify this data </td></tr>
<tr><td class="paramname">outIndex</td><td>Returns the index (of entries of userDataType) that corresponds to this entry. You will need this to retrieve this particular entry. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga19b34175458e1f9c621fe58eaba938b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga19b34175458e1f9c621fe58eaba938b0">◆ </a></span>MP4GetAtomFromUserData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> MP4GetAtomFromUserData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> </td>
<td class="paramname"><em>theUserData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_m_p4_generic_atom_record.html">MP4GenericAtom</a> * </td>
<td class="paramname"><em>outAtom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 </td>
<td class="paramname"><em>userDataType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 </td>
<td class="paramname"><em>itemIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the contents of the requested user data item. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">theUserData</td><td>The user data list you are querying </td></tr>
<tr><td class="paramname">outAtom</td><td>A generic atom, which will contain the requested atom </td></tr>
<tr><td class="paramname">userDataType</td><td>The type of user data </td></tr>
<tr><td class="paramname">itemIndex</td><td>The index for the atom type you are querying. This should be one based </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga907b92a16dbe1d73a099612ce3e2b2b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga907b92a16dbe1d73a099612ce3e2b2b4">◆ </a></span>MP4GetIndUserDataType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> MP4GetIndUserDataType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> </td>
<td class="paramname"><em>theUserData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 </td>
<td class="paramname"><em>typeIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 * </td>
<td class="paramname"><em>outType</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries an indexed type of user data in the user data list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">theUserData</td><td>The user data list you are querying </td></tr>
<tr><td class="paramname">typeIndex</td><td>The index for the atom type you are querying. This should be one based. </td></tr>
<tr><td class="paramname">outType</td><td>Returns the atom type corresponding to the given index. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga81308c573a254a6f033bc5aa426d5495"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga81308c573a254a6f033bc5aa426d5495">◆ </a></span>MP4GetMovieUserData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> MP4GetMovieUserData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___types.html#gaf761332ad0ff61ca75dbe01c68787e6f">MP4Movie</a> </td>
<td class="paramname"><em>theMovie</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> * </td>
<td class="paramname"><em>outUserData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the movie level user data 'udta'. </p>
<dl class="section note"><dt>Note</dt><dd>If no 'udta' is found, the default one is created in theMovie and returned.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">theMovie</td><td>input movie object </td></tr>
<tr><td class="paramname">outUserData</td><td>output pointer to user data </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>MP4Err error code </dd></dl>
</div>
</div>
<a id="ga2e98c3aef64e89fd70503e7c2bba7933"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2e98c3aef64e89fd70503e7c2bba7933">◆ </a></span>MP4GetTrackUserData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> MP4GetTrackUserData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___types.html#ga9dc1f38be42a4f54442ddb8783d435fc">MP4Track</a> </td>
<td class="paramname"><em>theTrack</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> * </td>
<td class="paramname"><em>outUserData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the track level user data 'udta'. </p>
<dl class="section note"><dt>Note</dt><dd>If no 'udta' is found, the default one is created in theTrack and returned.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">theTrack</td><td>input track object </td></tr>
<tr><td class="paramname">outUserData</td><td>output pointer to user data </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>MP4Err error code </dd></dl>
</div>
</div>
<a id="ga62bcb84e083bfa0e74cafed13912927f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga62bcb84e083bfa0e74cafed13912927f">◆ </a></span>MP4GetUserDataItem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> MP4GetUserDataItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___types.html#ga0002d7a3a08a2feb0518d9a2e1c6328e">MP4UserData</a> </td>
<td class="paramname"><em>theUserData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___types.html#gaa530307d8785f9bd3375ea070c06ce05">MP4Handle</a> </td>
<td class="paramname"><em>dataH</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 </td>
<td class="paramname"><em>userDataType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 </td>
<td class="paramname"><em>itemIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the contents of the requested user data item. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">theUserData</td><td>The user data list you are querying </td></tr>
<tr><td class="paramname">dataH</td><td>A handle to contain the returned data </td></tr>
<tr><td class="paramname">userDataType</td><td>The type of user data </td></tr>
<tr><td class="paramname">itemIndex</td><td>The index for the atom type you are querying. This should be one based </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3860d7c5e45a292a830f1a3cb599a476"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3860d7c5e45a292a830f1a3cb599a476">◆ </a></span>MP4NewForeignAtom()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> MP4NewForeignAtom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_m_p4_generic_atom_record.html">MP4GenericAtom</a> * </td>
<td class="paramname"><em>outAtom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 </td>
<td class="paramname"><em>atomType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___types.html#gaa530307d8785f9bd3375ea070c06ce05">MP4Handle</a> </td>
<td class="paramname"><em>atomPayload</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new custom atom object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outAtom</td><td>output new atom object </td></tr>
<tr><td class="paramname">atomType</td><td>atom type fourcc </td></tr>
<tr><td class="paramname">atomPayload</td><td>atom payload data handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>MP4Err error code </dd></dl>
</div>
</div>
<a id="ga0d408fbd7fcf33598c2572f23acc5f35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0d408fbd7fcf33598c2572f23acc5f35">◆ </a></span>MP4NewUUIDAtom()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___types.html#ga5906075464bd2961deda1ba298e3fea5">MP4Err</a> MP4NewUUIDAtom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_m_p4_generic_atom_record.html">MP4GenericAtom</a> * </td>
<td class="paramname"><em>outAtom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8 </td>
<td class="paramname"><em>the_uuid</em>[16], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___types.html#gaa530307d8785f9bd3375ea070c06ce05">MP4Handle</a> </td>
<td class="paramname"><em>atomPayload</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new custom atom object with UUID type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outAtom</td><td>output new atom object </td></tr>
<tr><td class="paramname">the_uuid</td><td>atom UUID </td></tr>
<tr><td class="paramname">atomPayload</td><td>atom payload data handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>MP4Err error code </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>