249 lines
14 KiB
HTML
249 lines
14 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="../">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Audio codecs — TeamSpeak SDK documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
|
|
|
|
|
|
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="../_static/documentation_options.js?v=7f41d439"></script>
|
|
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="../_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="Encoder options" href="encoder.html" />
|
|
<link rel="prev" title="Closing devices" href="audio-close.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="../index.html" class="icon icon-home">
|
|
TeamSpeak SDK
|
|
<img src="../_static/logo.png" class="logo" alt="Logo"/>
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../errors.html">TeamSpeak Error Codes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../properties.html">Property Enums</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enumerations.html">Structures & Enumerations</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../client_api.html">TeamSpeak Client Functions</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server_api.html">TeamSpeak Server Functions</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Server</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/intro.html">Introduction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/basic.html">Getting started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/list-items.html">List available clients, channels, servers</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/vserver-manage.html">Create and stop virtual servers</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/advanced-create.html">Advanced virtual server creation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/info.html">Retrieve and store information</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/channels.html">Managing channels</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/clients.html">Managing clients</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/whisper.html">Whisper lists</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/encryption.html">Custom encryption</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/passwords.html">Custom passwords</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/permissions.html">Permission checks</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/security-salt.html">Security salts and hashes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/disable-commands.html">Disabling protocol commands</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/filetransfer.html">Filetransfer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../server/faq.html">FAQ</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Client</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="basic.html">Getting started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="connections.html">Managing server connections</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="logging.html">Logging</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="audio.html">Client Audio</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="audio-list-device-mode.html">List available modes and devices</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="audio-init.html">Initializing devices</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="audio-get-current.html">Query current mode and device</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="audio-custom-device.html">Using custom devices</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="audio-activate.html">Activating the capture device</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="audio-close.html">Closing devices</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">Audio codecs</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="encoder.html">Encoder options</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="preprocessor.html">Preprocessor options</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="playback-options.html">Playback options</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="audio-buffer-access.html">Accessing the voice buffer</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="audio-localtest.html">Local Test mode</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="wave-files.html">Playing wave files</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="3dsound.html">3D Sound</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="whisper.html">Whisper lists</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="voice-encryption.html">Channel voice data encryption</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="info.html">Retrieve and store information</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="channels.html">Channel Management</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="client-list.html">List clients</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="client-kick.html">Kicking clients</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="local-mute.html">Muting other clients</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="textmessages.html">Text chat</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="filetransfer.html">Filetransfer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="encryption.html">Custom encryption</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="passwords.html">Custom passwords</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../index.html">TeamSpeak SDK</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item"><a href="audio.html">Client Audio</a></li>
|
|
<li class="breadcrumb-item active">Audio codecs</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="audio-codecs">
|
|
<h1>Audio codecs<a class="headerlink" href="#audio-codecs" title="Link to this heading"></a></h1>
|
|
<p>TeamSpeak 3 supports the following sampling rates:</p>
|
|
<ul class="simple">
|
|
<li><p>Opus Voice (Mono, 48khz)</p></li>
|
|
<li><p>Opus Music (Stereo, 48khz)</p></li>
|
|
</ul>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Opus Voice is recommended for voice transmission.</p>
|
|
</div>
|
|
<p>Bandwidth usage generally depends on the used codec and the
|
|
<a class="reference internal" href="encoder.html#encoder"><span class="std std-ref">encoders</span></a> quality setting.</p>
|
|
<p>Estimated bitrates (bps) for codecs per quality:</p>
|
|
<table class="docutils align-default">
|
|
<thead>
|
|
<tr class="row-odd"><th class="head"><p>Quality</p></th>
|
|
<th class="head"><p>Opus Voice</p></th>
|
|
<th class="head"><p>Opus Music</p></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="row-even"><td><p>0</p></td>
|
|
<td><p>4,096</p></td>
|
|
<td><p>7,200</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p>1</p></td>
|
|
<td><p>8,192</p></td>
|
|
<td><p>14,400</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p>2</p></td>
|
|
<td><p>12,288</p></td>
|
|
<td><p>21,600</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p>3</p></td>
|
|
<td><p>16,384</p></td>
|
|
<td><p>28,800</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p>4</p></td>
|
|
<td><p>20,480</p></td>
|
|
<td><p>36,000</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p>5</p></td>
|
|
<td><p>24,576</p></td>
|
|
<td><p>43,200</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p>6</p></td>
|
|
<td><p>28,672</p></td>
|
|
<td><p>50,400</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p>7</p></td>
|
|
<td><p>32,768</p></td>
|
|
<td><p>57,600</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p>8</p></td>
|
|
<td><p>36,864</p></td>
|
|
<td><p>64,800</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p>9</p></td>
|
|
<td><p>40,960</p></td>
|
|
<td><p>72,000</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p>10</p></td>
|
|
<td><p>45,056</p></td>
|
|
<td><p>79,200</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Change the quality to find a good middle between voice quality and
|
|
bandwidth usage. Overall the Opus codec delivers the best quality for
|
|
the bandwidth.</p>
|
|
<p>Users need to use the same codec when talking to each other.
|
|
Different channels on the same TeamSpeak 3 server can use different
|
|
codecs. The channel codec should be customizable by the users to allow
|
|
for flexibility concerning bandwidth vs. quality concerns.</p>
|
|
<p>The codec can be set or changed for a given channel using the function
|
|
<a class="reference internal" href="channel-create.html#c.ts3client_setChannelVariableAsInt" title="ts3client_setChannelVariableAsInt"><code class="xref c c-func docutils literal notranslate"><span class="pre">ts3client_setChannelVariableAsInt()</span></code></a> by passing <a class="reference internal" href="../properties.html#c.ChannelProperties.CHANNEL_CODEC" title="ChannelProperties.CHANNEL_CODEC"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CHANNEL_CODEC</span></code></a>
|
|
for the properties flag</p>
|
|
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">ts3client_setChannelVariableAsInt</span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="n">channelID</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_CODEC</span><span class="p">,</span><span class="w"> </span><span class="n">codec</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Available values for <a class="reference internal" href="../properties.html#c.ChannelProperties.CHANNEL_CODEC" title="ChannelProperties.CHANNEL_CODEC"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CHANNEL_CODEC</span></code></a> are defined in the <a class="reference internal" href="../enumerations.html#c.CodecType" title="CodecType"><code class="xref c c-enum docutils literal notranslate"><span class="pre">CodecType</span></code></a> enum.</p>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="audio-close.html" class="btn btn-neutral float-left" title="Closing devices" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="encoder.html" class="btn btn-neutral float-right" title="Encoder options" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2020, TeamSpeak Systems GmbH.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |