<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:46 CET 2013 -->
<title>AudioDevice (libgdx API)
</title>
<meta name="date" content="2013-11-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AudioDevice (libgdx API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.
</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/AudioDevice.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>
libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class
</li>
<li><a href="../../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/audio/AudioDevice.html" target="_top">Frames
</a></li>
<li><a href="AudioDevice.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.badlogic.gdx.audio
</div>
<h2 title="Interface AudioDevice" class="title">Interface AudioDevice
</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:
</dt>
<dd><a href="../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable
</a></dd>
</dl>
<hr>
<br>
<pre>public interface
<span class="strong">AudioDevice
</span>
extends
<a href="../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable
</a></pre>
<div class="block">Encapsulates an audio device in 44.1khz mono or stereo mode. Use the
<a href="../../../../com/badlogic/gdx/audio/AudioDevice.html#writeSamples(float[], int, int)"><code>writeSamples(float[], int, int)
</code></a> and
<a href="../../../../com/badlogic/gdx/audio/AudioDevice.html#writeSamples(short[], int, int)"><code>writeSamples(short[], int, int)
</code></a> methods to write float or 16-bit signed short PCM data directly to the audio device.
Stereo samples are interleaved in the order left channel sample, right channel sample. The
<a href="../../../../com/badlogic/gdx/audio/AudioDevice.html#dispose()"><code>dispose()
</code></a> method must be
called when this AudioDevice is no longer needed.
</div>
<dl><dt><span class="strong">Author:
</span></dt>
<dd>badlogicgames@gmail.com
</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Method and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/AudioDevice.html#dispose()">dispose
</a></strong>()
</code>
<div class="block">Frees all resources associated with this AudioDevice.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/AudioDevice.html#getLatency()">getLatency
</a></strong>()
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/AudioDevice.html#isMono()">isMono
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/AudioDevice.html#setVolume(float)">setVolume
</a></strong>(float
volume)
</code>
<div class="block">Sets the volume in the range [0,1].
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/AudioDevice.html#writeSamples(float[], int, int)">writeSamples
</a></strong>(float[]
samples,
int
offset,
int
numSamples)
</code>
<div class="block">Writes the array of float PCM samples to the audio device and blocks until they have been processed.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/AudioDevice.html#writeSamples(short[], int, int)">writeSamples
</a></strong>(short[]
samples,
int
offset,
int
numSamples)
</code>
<div class="block">Writes the array of 16-bit signed PCM samples to the audio device and blocks until they have been processed.
</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="isMono()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMono
</h4>
<pre>boolean
isMono()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>whether this AudioDevice is in mono or stereo mode.
</dd></dl>
</li>
</ul>
<a name="writeSamples(short[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeSamples
</h4>
<pre>void
writeSamples(short[]
samples,
int
offset,
int
numSamples)
</pre>
<div class="block">Writes the array of 16-bit signed PCM samples to the audio device and blocks until they have been processed.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>samples
</code> - The samples.
</dd><dd><code>offset
</code> - The offset into the samples array
</dd><dd><code>numSamples
</code> - the number of samples to write to the device
</dd></dl>
</li>
</ul>
<a name="writeSamples(float[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeSamples
</h4>
<pre>void
writeSamples(float[]
samples,
int
offset,
int
numSamples)
</pre>
<div class="block">Writes the array of float PCM samples to the audio device and blocks until they have been processed.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>samples
</code> - The samples.
</dd><dd><code>offset
</code> - The offset into the samples array
</dd><dd><code>numSamples
</code> - the number of samples to write to the device
</dd></dl>
</li>
</ul>
<a name="getLatency()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLatency
</h4>
<pre>int
getLatency()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the latency in samples.
</dd></dl>
</li>
</ul>
<a name="dispose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispose
</h4>
<pre>void
dispose()
</pre>
<div class="block">Frees all resources associated with this AudioDevice. Needs to be called when the device is no longer needed.
</div>
<dl>
<dt><strong>Specified by:
</strong></dt>
<dd><code><a href="../../../../com/badlogic/gdx/utils/Disposable.html#dispose()">dispose
</a></code> in interface
<code><a href="../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable
</a></code></dd>
</dl>
</li>
</ul>
<a name="setVolume(float)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setVolume
</h4>
<pre>void
setVolume(float
volume)
</pre>
<div class="block">Sets the volume in the range [0,1].
</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/AudioDevice.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>libgdx API
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class
</li>
<li><a href="../../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/audio/AudioDevice.html" target="_top">Frames
</a></li>
<li><a href="AudioDevice.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
<div style="font-size:9pt"><i>
Copyright
© 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</small></p>
</body>
</html>