furnace/extern/flac/doc/api/group__flacpp__metadata__level0.html
2025-10-22 16:16:07 -05:00

383 lines
19 KiB
HTML

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FLAC: FLAC++/metadata.h: metadata level 0 interface</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 id="projectrow">
<td id="projectalign">
<div id="projectname">FLAC<span id="projectnumber">&#160;1.5.0</span>
</div>
<div id="projectbrief">Free Lossless Audio Codec</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">FLAC++/metadata.h: metadata level 0 interface<div class="ingroups"><a class="el" href="group__flacpp.html">FLAC C++ API</a> &raquo; <a class="el" href="group__flacpp__metadata.html">FLAC++/metadata.h: metadata interfaces</a> &raquo; <a class="el" href="group__flacpp__metadata__object.html">FLAC++/metadata.h: metadata object classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__flacpp__metadata__level1" id="r_group__flacpp__metadata__level1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level1.html">FLAC++/metadata.h: metadata level 1 interface</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8fa8da652f33edeb4dabb4ce39fda04b" id="r_ga8fa8da652f33edeb4dabb4ce39fda04b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level0.html#ga8fa8da652f33edeb4dabb4ce39fda04b">FLAC::Metadata::get_streaminfo</a> (const char *filename, <a class="el" href="classFLAC_1_1Metadata_1_1StreamInfo.html">StreamInfo</a> &amp;streaminfo)</td></tr>
<tr class="separator:ga8fa8da652f33edeb4dabb4ce39fda04b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga533a71ba745ca03068523a4a45fb0329" id="r_ga533a71ba745ca03068523a4a45fb0329"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level0.html#ga533a71ba745ca03068523a4a45fb0329">FLAC::Metadata::get_tags</a> (const char *filename, <a class="el" href="classFLAC_1_1Metadata_1_1VorbisComment.html">VorbisComment</a> *&amp;tags)</td></tr>
<tr class="separator:ga533a71ba745ca03068523a4a45fb0329"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga85166e6206f3d5635684de4257f2b00e" id="r_ga85166e6206f3d5635684de4257f2b00e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level0.html#ga85166e6206f3d5635684de4257f2b00e">FLAC::Metadata::get_tags</a> (const char *filename, <a class="el" href="classFLAC_1_1Metadata_1_1VorbisComment.html">VorbisComment</a> &amp;tags)</td></tr>
<tr class="separator:ga85166e6206f3d5635684de4257f2b00e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4fad03d91f22d78acf35dd2f35df9ac7" id="r_ga4fad03d91f22d78acf35dd2f35df9ac7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level0.html#ga4fad03d91f22d78acf35dd2f35df9ac7">FLAC::Metadata::get_cuesheet</a> (const char *filename, <a class="el" href="classFLAC_1_1Metadata_1_1CueSheet.html">CueSheet</a> *&amp;cuesheet)</td></tr>
<tr class="separator:ga4fad03d91f22d78acf35dd2f35df9ac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea8f05f89e36af143d73b4280f05cc0e" id="r_gaea8f05f89e36af143d73b4280f05cc0e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level0.html#gaea8f05f89e36af143d73b4280f05cc0e">FLAC::Metadata::get_cuesheet</a> (const char *filename, <a class="el" href="classFLAC_1_1Metadata_1_1CueSheet.html">CueSheet</a> &amp;cuesheet)</td></tr>
<tr class="separator:gaea8f05f89e36af143d73b4280f05cc0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa44df95da4d3abc459fdc526a0d54a55" id="r_gaa44df95da4d3abc459fdc526a0d54a55"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level0.html#gaa44df95da4d3abc459fdc526a0d54a55">FLAC::Metadata::get_picture</a> (const char *filename, <a class="el" href="classFLAC_1_1Metadata_1_1Picture.html">Picture</a> *&amp;picture, <a class="el" href="group__flac__format.html#gaf6d3e836cee023e0b8d897f1fdc9825d">::FLAC__StreamMetadata_Picture_Type</a> type, const char *mime_type, const FLAC__byte *description, uint32_t max_width, uint32_t max_height, uint32_t max_depth, uint32_t max_colors)</td></tr>
<tr class="separator:gaa44df95da4d3abc459fdc526a0d54a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa6aea22f1ebeb671db19b73277babdea" id="r_gaa6aea22f1ebeb671db19b73277babdea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level0.html#gaa6aea22f1ebeb671db19b73277babdea">FLAC::Metadata::get_picture</a> (const char *filename, <a class="el" href="classFLAC_1_1Metadata_1_1Picture.html">Picture</a> &amp;picture, <a class="el" href="group__flac__format.html#gaf6d3e836cee023e0b8d897f1fdc9825d">::FLAC__StreamMetadata_Picture_Type</a> type, const char *mime_type, const FLAC__byte *description, uint32_t max_width, uint32_t max_height, uint32_t max_depth, uint32_t max_colors)</td></tr>
<tr class="separator:gaa6aea22f1ebeb671db19b73277babdea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Level 0 metadata iterators. </p>
<p>See the <a class="el" href="group__flac__metadata__level0.html">C layer equivalent </a> for more. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8fa8da652f33edeb4dabb4ce39fda04b" name="ga8fa8da652f33edeb4dabb4ce39fda04b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8fa8da652f33edeb4dabb4ce39fda04b">&#9670;&#160;</a></span>get_streaminfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FLAC::Metadata::get_streaminfo </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFLAC_1_1Metadata_1_1StreamInfo.html">StreamInfo</a> &amp;&#160;</td>
<td class="paramname"><em>streaminfo</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="group__flac__metadata__level0.html#ga804b42d9da714199b4b383ce51078d51">FLAC__metadata_get_streaminfo()</a>. </p>
</div>
</div>
<a id="ga533a71ba745ca03068523a4a45fb0329" name="ga533a71ba745ca03068523a4a45fb0329"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga533a71ba745ca03068523a4a45fb0329">&#9670;&#160;</a></span>get_tags() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FLAC::Metadata::get_tags </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFLAC_1_1Metadata_1_1VorbisComment.html">VorbisComment</a> *&amp;&#160;</td>
<td class="paramname"><em>tags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="group__flac__metadata__level0.html#ga1626af09cd39d4fa37d5b46ebe3790fd">FLAC__metadata_get_tags()</a>. </p>
</div>
</div>
<a id="ga85166e6206f3d5635684de4257f2b00e" name="ga85166e6206f3d5635684de4257f2b00e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85166e6206f3d5635684de4257f2b00e">&#9670;&#160;</a></span>get_tags() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FLAC::Metadata::get_tags </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFLAC_1_1Metadata_1_1VorbisComment.html">VorbisComment</a> &amp;&#160;</td>
<td class="paramname"><em>tags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="group__flac__metadata__level0.html#ga1626af09cd39d4fa37d5b46ebe3790fd">FLAC__metadata_get_tags()</a>. </p>
</div>
</div>
<a id="ga4fad03d91f22d78acf35dd2f35df9ac7" name="ga4fad03d91f22d78acf35dd2f35df9ac7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4fad03d91f22d78acf35dd2f35df9ac7">&#9670;&#160;</a></span>get_cuesheet() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FLAC::Metadata::get_cuesheet </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFLAC_1_1Metadata_1_1CueSheet.html">CueSheet</a> *&amp;&#160;</td>
<td class="paramname"><em>cuesheet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="group__flac__metadata__level0.html#ga0f47949dca514506718276205a4fae0b">FLAC__metadata_get_cuesheet()</a>. </p>
</div>
</div>
<a id="gaea8f05f89e36af143d73b4280f05cc0e" name="gaea8f05f89e36af143d73b4280f05cc0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaea8f05f89e36af143d73b4280f05cc0e">&#9670;&#160;</a></span>get_cuesheet() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FLAC::Metadata::get_cuesheet </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFLAC_1_1Metadata_1_1CueSheet.html">CueSheet</a> &amp;&#160;</td>
<td class="paramname"><em>cuesheet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="group__flac__metadata__level0.html#ga0f47949dca514506718276205a4fae0b">FLAC__metadata_get_cuesheet()</a>. </p>
</div>
</div>
<a id="gaa44df95da4d3abc459fdc526a0d54a55" name="gaa44df95da4d3abc459fdc526a0d54a55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa44df95da4d3abc459fdc526a0d54a55">&#9670;&#160;</a></span>get_picture() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FLAC::Metadata::get_picture </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFLAC_1_1Metadata_1_1Picture.html">Picture</a> *&amp;&#160;</td>
<td class="paramname"><em>picture</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__format.html#gaf6d3e836cee023e0b8d897f1fdc9825d">::FLAC__StreamMetadata_Picture_Type</a>&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>mime_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const FLAC__byte *&#160;</td>
<td class="paramname"><em>description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>max_width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>max_height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>max_depth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>max_colors</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="group__flac__metadata__level0.html#gab9f69e48c5a33cacb924d13986bfb852">FLAC__metadata_get_picture()</a>. </p>
</div>
</div>
<a id="gaa6aea22f1ebeb671db19b73277babdea" name="gaa6aea22f1ebeb671db19b73277babdea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa6aea22f1ebeb671db19b73277babdea">&#9670;&#160;</a></span>get_picture() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FLAC::Metadata::get_picture </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFLAC_1_1Metadata_1_1Picture.html">Picture</a> &amp;&#160;</td>
<td class="paramname"><em>picture</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__format.html#gaf6d3e836cee023e0b8d897f1fdc9825d">::FLAC__StreamMetadata_Picture_Type</a>&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>mime_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const FLAC__byte *&#160;</td>
<td class="paramname"><em>description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>max_width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>max_height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>max_depth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>max_colors</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="group__flac__metadata__level0.html#gab9f69e48c5a33cacb924d13986bfb852">FLAC__metadata_get_picture()</a>. </p>
</div>
</div>
</div><!-- contents -->
<hr size="1"/>
Copyright (c) 2000-2009 Josh Coalson
Copyright (c) 2011-2025 Xiph.Org Foundation
<!-- Copyright (c) 2000-2009 Josh Coalson -->
<!-- Copyright (c) 2011-2025 Xiph.Org Foundation -->
<!-- Permission is granted to copy, distribute and/or modify this document -->
<!-- under the terms of the GNU Free Documentation License, Version 1.3 -->
<!-- or any later version published by the Free Software Foundation; -->
<!-- with no invariant sections. -->
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
</body>
</html>