<!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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: IDeviceFactory Interface Reference</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="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>
<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">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classIDeviceFactory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">IDeviceFactory Interface Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classIDeviceFactory.html" title="The IDeviceFactory interface opens an output device.">IDeviceFactory</a> interface opens an output device.
<a href="classIDeviceFactory.html#details">More...</a></p>
<p><code>#include <<a class="el" href="IDeviceFactory_8h_source.html">IDeviceFactory.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aea3fdbc8caaa18e85fbf37d846adc1bb"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIDevice.html">IDevice</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDeviceFactory.html#aea3fdbc8caaa18e85fbf37d846adc1bb">openDevice</a> ()=0</td></tr>
<tr class="memdesc:aea3fdbc8caaa18e85fbf37d846adc1bb"><td class="mdescLeft"> </td><td class="mdescRight">Opens an audio device for playback. <a href="#aea3fdbc8caaa18e85fbf37d846adc1bb">More...</a><br /></td></tr>
<tr class="separator:aea3fdbc8caaa18e85fbf37d846adc1bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfd38805cd31137183cf74707726a28a"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDeviceFactory.html#abfd38805cd31137183cf74707726a28a">getPriority</a> ()=0</td></tr>
<tr class="memdesc:abfd38805cd31137183cf74707726a28a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the priority of the device to be the default device for a system. <a href="#abfd38805cd31137183cf74707726a28a">More...</a><br /></td></tr>
<tr class="separator:abfd38805cd31137183cf74707726a28a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadd884a6d4667208d7caab6a78d37589"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDeviceFactory.html#aadd884a6d4667208d7caab6a78d37589">setSpecs</a> (<a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> specs)=0</td></tr>
<tr class="memdesc:aadd884a6d4667208d7caab6a78d37589"><td class="mdescLeft"> </td><td class="mdescRight">Sets the wanted device specifications for opening the device. <a href="#aadd884a6d4667208d7caab6a78d37589">More...</a><br /></td></tr>
<tr class="separator:aadd884a6d4667208d7caab6a78d37589"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afca07fae74165082e820fdcae5401f80"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDeviceFactory.html#afca07fae74165082e820fdcae5401f80">setBufferSize</a> (int buffersize)=0</td></tr>
<tr class="memdesc:afca07fae74165082e820fdcae5401f80"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size for the internal playback buffers. <a href="#afca07fae74165082e820fdcae5401f80">More...</a><br /></td></tr>
<tr class="separator:afca07fae74165082e820fdcae5401f80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acee66153322897c56cde81925cfce951"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDeviceFactory.html#acee66153322897c56cde81925cfce951">setName</a> (std::string name)=0</td></tr>
<tr class="memdesc:acee66153322897c56cde81925cfce951"><td class="mdescLeft"> </td><td class="mdescRight">Sets a name for the device. <a href="#acee66153322897c56cde81925cfce951">More...</a><br /></td></tr>
<tr class="separator:acee66153322897c56cde81925cfce951"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classIDeviceFactory.html" title="The IDeviceFactory interface opens an output device.">IDeviceFactory</a> interface opens an output device. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abfd38805cd31137183cf74707726a28a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfd38805cd31137183cf74707726a28a">◆ </a></span>getPriority()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int IDeviceFactory::getPriority </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the priority of the device to be the default device for a system. </p>
<p>The higher the priority the more likely it is for this device to be used as the default device. </p><dl class="section return"><dt>Returns</dt><dd>Priority to be the default device. </dd></dl>
</div>
</div>
<a id="aea3fdbc8caaa18e85fbf37d846adc1bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea3fdbc8caaa18e85fbf37d846adc1bb">◆ </a></span>openDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::shared_ptr<<a class="el" href="classIDevice.html">IDevice</a>> IDeviceFactory::openDevice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens an audio device for playback. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classException.html" title="The Exception class is the general exception base class.">Exception</a></td><td>Thrown if the audio device cannot be opened. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afca07fae74165082e820fdcae5401f80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afca07fae74165082e820fdcae5401f80">◆ </a></span>setBufferSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void IDeviceFactory::setBufferSize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>buffersize</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the size for the internal playback buffers. </p>
<p>The bigger the buffersize, the less likely clicks happen, but the latency increases too. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffersize</td><td>The size of the internal buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acee66153322897c56cde81925cfce951"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acee66153322897c56cde81925cfce951">◆ </a></span>setName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void IDeviceFactory::setName </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a name for the device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The internal name for the device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aadd884a6d4667208d7caab6a78d37589"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadd884a6d4667208d7caab6a78d37589">◆ </a></span>setSpecs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void IDeviceFactory::setSpecs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> </td>
<td class="paramname"><em>specs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the wanted device specifications for opening the device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">specs</td><td>The wanted audio specification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>devices/<a class="el" href="IDeviceFactory_8h_source.html">IDeviceFactory.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
1037
