<!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.3.1"/>
<title>libmusicbrainz5: libmusicbrainz5</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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">libmusicbrainz5
 <span id="projectnumber">5.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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="headertitle">
<div class="title">libmusicbrainz5 </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This is the documentation for libmusicbrainz5, a library for retrieving data from the <a href="http://musicbrainz.org" target="_blank">MusicBrainz</a> service. The main entry point to the library is the <a class="el" href="class_music_brainz5_1_1_c_query.html" title="Main object for generating queries to MusicBrainz.">MusicBrainz5::CQuery</a> object.</p>
<p>For details of the C interface, see the documentation for the file <a class="el" href="mb5__c_8h.html">mb5_c.h</a>.</p>
<p>Please report any issues with this library at <a href="http://tickets.musicbrainz.org/" target="_blank">http://tickets.musicbrainz.org/</a>.</p>
<dl class="section user"><dt>Compiling and Linking</dt><dd></dd></dl>
<p>This package provides a pkg-config script that returns the necessary compiler and linker flags, as well as the version number. To build a small sample program one would use:</p>
<dl class="section user"><dt></dt><dd><code>g++ -o test_app test_app.cpp <code>pkg-config libmusicbrainz5 --cflags --libs</code></code></dd></dl>
<p>If you don't want/can't use pkg-config and you are using the C API, make sure you link in the C++ standard library:</p>
<dl class="section user"><dt></dt><dd><code>gcc -o test_app test_app.c -lmusicbrainz5 -lm -lstdc++</code></dd></dl>
<dl class="section user"><dt>Example:</dt><dd></dd></dl>
<p>A brief example showing how to lookup a list of releases matching a disc id</p>
<div class="fragment"><div class="line"><a class="code" href="class_music_brainz5_1_1_c_query.html" title="Main object for generating queries to MusicBrainz.">MusicBrainz5::CQuery</a> Query(<span class="stringliteral">"cdlookupexample-1.0"</span>);</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">try</span></div>
<div class="line">{</div>
<div class="line"> <a class="code" href="class_music_brainz5_1_1_c_metadata.html">MusicBrainz5::CMetadata</a> Metadata=Query.Query(<span class="stringliteral">"discid"</span>,DiscID);</div>
<div class="line"> <span class="keywordflow">if</span> (Metadata.<a class="code" href="class_music_brainz5_1_1_c_metadata.html#a6cb422122305360dfec7267ab283fdd7">Disc</a>() && Metadata.<a class="code" href="class_music_brainz5_1_1_c_metadata.html#a6cb422122305360dfec7267ab283fdd7">Disc</a>()-><a class="code" href="class_music_brainz5_1_1_c_disc.html#aa7d59bac0de896edf3a2e2359cb8737c">ReleaseList</a>())</div>
<div class="line"> {</div>
<div class="line"> <a class="code" href="class_music_brainz5_1_1_c_list_impl.html">MusicBrainz5::CReleaseList</a> *ReleaseList=Metadata.<a class="code" href="class_music_brainz5_1_1_c_metadata.html#a6cb422122305360dfec7267ab283fdd7">Disc</a>()-><a class="code" href="class_music_brainz5_1_1_c_disc.html#aa7d59bac0de896edf3a2e2359cb8737c">ReleaseList</a>();</div>
<div class="line"></div>
<div class="line"> std::cout << <span class="stringliteral">"Found "</span> << ReleaseList-><a class="code" href="class_music_brainz5_1_1_c_list.html#a7a9c55de72b875857a3c3f86b93c2306">NumItems</a>() << <span class="stringliteral">" release(s)"</span> << std::endl;</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> count=0;count<ReleaseList-><a class="code" href="class_music_brainz5_1_1_c_list.html#a7a9c55de72b875857a3c3f86b93c2306">NumItems</a>();count++)</div>
<div class="line"> {</div>
<div class="line"> <a class="code" href="class_music_brainz5_1_1_c_release.html">MusicBrainz5::CRelease</a> *Release=ReleaseList-><a class="code" href="class_music_brainz5_1_1_c_list_impl.html#af946873b26af6e900f9dd1ed3003b9e8">Item</a>(count);</div>
<div class="line"></div>
<div class="line"> std::cout << <span class="stringliteral">"Basic release: "</span> << std::endl << *Release << std::endl;</div>
<div class="line"></div>
<div class="line"> <span class="comment">//The releases returned from LookupDiscID don't contain full information</span></div>
<div class="line"></div>
<div class="line"> <a class="code" href="class_music_brainz5_1_1_c_query.html#a836013cd0d3870936e0a95fed7434968">MusicBrainz5::CQuery::tParamMap</a> Params;</div>
<div class="line"> Params[<span class="stringliteral">"inc"</span>]=<span class="stringliteral">"artists labels recordings release-groups url-rels discids artist-credits"</span>;</div>
<div class="line"></div>
<div class="line"> Metadata=Query.Query(<span class="stringliteral">"release"</span>,Release.<a class="code" href="class_music_brainz5_1_1_c_release.html#a67ae557ff57a423b3854e7b094602a6f">ID</a>(),<span class="stringliteral">""</span>,Params);</div>
<div class="line"> <span class="keywordflow">if</span> (Metadata.<a class="code" href="class_music_brainz5_1_1_c_metadata.html#a539bf18f13e066f1a995e337ccbf6918">Release</a>())</div>
<div class="line"> {</div>
<div class="line"> <a class="code" href="class_music_brainz5_1_1_c_release.html">MusicBrainz5::CRelease</a> *FullRelease=Metadata.<a class="code" href="class_music_brainz5_1_1_c_metadata.html#a539bf18f13e066f1a995e337ccbf6918">Release</a>();</div>
<div class="line"></div>
<div class="line"> std::cout << *FullRelease << std::endl;</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">catch</span> (<a class="code" href="class_music_brainz5_1_1_c_connection_error.html" title="Exception thrown when an error occurs connecting to web service.">MusicBrainz5::CConnectionError</a>& Error)</div>
<div class="line">{</div>
<div class="line"> std::cout << <span class="stringliteral">"Connection Exception: '"</span> << Error.<a class="code" href="class_music_brainz5_1_1_c_exception_base.html#a8f22cc985a00bd7a4e01403c2f9e4ed0">what</a>() << <span class="stringliteral">"'"</span> << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastResult: "</span> << Query.LastResult() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastHTTPCode: "</span> << Query.LastHTTPCode() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastErrorMessage: "</span> << Query.LastErrorMessage() << std::endl;</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">catch</span> (<a class="code" href="class_music_brainz5_1_1_c_timeout_error.html" title="Exception thrown when a connection to the web service times out.">MusicBrainz5::CTimeoutError</a>& Error)</div>
<div class="line">{</div>
<div class="line"> std::cout << <span class="stringliteral">"Timeout Exception: '"</span> << Error.<a class="code" href="class_music_brainz5_1_1_c_exception_base.html#a8f22cc985a00bd7a4e01403c2f9e4ed0">what</a>() << <span class="stringliteral">"'"</span> << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastResult: "</span> << Query.LastResult() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastHTTPCode: "</span> << Query.LastHTTPCode() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastErrorMessage: "</span> << Query.LastErrorMessage() << std::endl;</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">catch</span> (<a class="code" href="class_music_brainz5_1_1_c_authentication_error.html" title="Exception thrown when an authentication error occurs.">MusicBrainz5::CAuthenticationError</a>& Error)</div>
<div class="line">{</div>
<div class="line"> std::cout << <span class="stringliteral">"Authentication Exception: '"</span> << Error.<a class="code" href="class_music_brainz5_1_1_c_exception_base.html#a8f22cc985a00bd7a4e01403c2f9e4ed0">what</a>() << <span class="stringliteral">"'"</span> << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastResult: "</span> << Query.LastResult() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastHTTPCode: "</span> << Query.LastHTTPCode() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastErrorMessage: "</span> << Query.LastErrorMessage() << std::endl;</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">catch</span> (<a class="code" href="class_music_brainz5_1_1_c_fetch_error.html" title="Exception thrown when an error occurs fetching data.">MusicBrainz5::CFetchError</a>& Error)</div>
<div class="line">{</div>
<div class="line"> std::cout << <span class="stringliteral">"Fetch Exception: '"</span> << Error.<a class="code" href="class_music_brainz5_1_1_c_exception_base.html#a8f22cc985a00bd7a4e01403c2f9e4ed0">what</a>() << <span class="stringliteral">"'"</span> << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastResult: "</span> << Query.LastResult() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastHTTPCode: "</span> << Query.LastHTTPCode() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastErrorMessage: "</span> << Query.LastErrorMessage() << std::endl;</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">catch</span> (<a class="code" href="class_music_brainz5_1_1_c_request_error.html" title="Exception thrown when an invalid request is made.">MusicBrainz5::CRequestError</a>& Error)</div>
<div class="line">{</div>
<div class="line"> std::cout << <span class="stringliteral">"Request Exception: '"</span> << Error.<a class="code" href="class_music_brainz5_1_1_c_exception_base.html#a8f22cc985a00bd7a4e01403c2f9e4ed0">what</a>() << <span class="stringliteral">"'"</span> << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastResult: "</span> << Query.LastResult() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastHTTPCode: "</span> << Query.LastHTTPCode() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastErrorMessage: "</span> << Query.LastErrorMessage() << std::endl;</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">catch</span> (<a class="code" href="class_music_brainz5_1_1_c_resource_not_found_error.html" title="Exception thrown when the requested resource is not found.">MusicBrainz5::CResourceNotFoundError</a>& Error)</div>
<div class="line">{</div>
<div class="line"> std::cout << <span class="stringliteral">"ResourceNotFound Exception: '"</span> << Error.<a class="code" href="class_music_brainz5_1_1_c_exception_base.html#a8f22cc985a00bd7a4e01403c2f9e4ed0">what</a>() << <span class="stringliteral">"'"</span> << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastResult: "</span> << Query.LastResult() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastHTTPCode: "</span> << Query.LastHTTPCode() << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"LastErrorMessage: "</span> << Query.LastErrorMessage() << std::endl;</div>
<div class="line">}</div>
</div><!-- fragment --> </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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3.1 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
2bc07dd2a491db6e791943fd077198d6
>
files
>
524
