216 lines
17 KiB
HTML
216 lines
17 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>Bandwidth and Traffic — 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="Managing channels" href="channels.html" />
|
||
<link rel="prev" title="Server information" href="info-server.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 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="list-items.html">List available clients, channels, servers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vserver-manage.html">Create and stop virtual servers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="advanced-create.html">Advanced virtual server creation</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="info.html">Retrieve and store information</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="info-client.html">Client information</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="info-channel.html">Channel information</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="info-server.html">Server information</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Bandwidth and Traffic</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#query-values">Query values</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="channels.html">Managing channels</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="clients.html">Managing clients</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="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="permissions.html">Permission checks</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="security-salt.html">Security salts and hashes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="disable-commands.html">Disabling protocol commands</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="faq.html">FAQ</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Client</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/intro.html">Introduction</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/basic.html">Getting started</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/connections.html">Managing server connections</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/logging.html">Logging</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/audio.html">Client Audio</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/wave-files.html">Playing wave files</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/3dsound.html">3D Sound</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/whisper.html">Whisper lists</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/voice-encryption.html">Channel voice data encryption</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/info.html">Retrieve and store information</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/channels.html">Channel Management</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/client-list.html">List clients</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/client-kick.html">Kicking clients</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/local-mute.html">Muting other clients</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/textmessages.html">Text chat</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/filetransfer.html">Filetransfer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/encryption.html">Custom encryption</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/passwords.html">Custom passwords</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client/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="info.html">Retrieve and store information</a></li>
|
||
<li class="breadcrumb-item active">Bandwidth and Traffic</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="bandwidth-and-traffic">
|
||
<h1>Bandwidth and Traffic<a class="headerlink" href="#bandwidth-and-traffic" title="Link to this heading"></a></h1>
|
||
<p>The server offers information about the currently used bandwidth by the server
|
||
as well as for file transfers.</p>
|
||
<p>The available variables to be queried are specified in the <a class="reference internal" href="../properties.html#c.ConnectionProperties" title="ConnectionProperties"><code class="xref c c-enum docutils literal notranslate"><span class="pre">ConnectionProperties</span></code></a> and <code class="xref c c-enum docutils literal notranslate"><span class="pre">ConnectionPropertiesSDK</span></code> enums.</p>
|
||
<p>However only the following values can be queried server side:
|
||
<a class="reference internal" href="../properties.html#c.ConnectionProperties.CONNECTION_PACKETS_SENT_TOTAL" title="CONNECTION_PACKETS_SENT_TOTAL"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CONNECTION_PACKETS_SENT_TOTAL</span></code></a>
|
||
<a class="reference internal" href="../properties.html#c.ConnectionProperties.CONNECTION_BYTES_SENT_TOTAL" title="CONNECTION_BYTES_SENT_TOTAL"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CONNECTION_BYTES_SENT_TOTAL</span></code></a>
|
||
<a class="reference internal" href="../properties.html#c.ConnectionProperties.CONNECTION_PACKETS_RECEIVED_TOTAL" title="CONNECTION_PACKETS_RECEIVED_TOTAL"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CONNECTION_PACKETS_RECEIVED_TOTAL</span></code></a>
|
||
<a class="reference internal" href="../properties.html#c.ConnectionProperties.CONNECTION_BYTES_RECEIVED_TOTAL" title="CONNECTION_BYTES_RECEIVED_TOTAL"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CONNECTION_BYTES_RECEIVED_TOTAL</span></code></a>
|
||
<a class="reference internal" href="../properties.html#c.ConnectionProperties.CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL" title="CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL</span></code></a>
|
||
<a class="reference internal" href="../properties.html#c.ConnectionProperties.CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL" title="CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL</span></code></a>
|
||
<a class="reference internal" href="../properties.html#c.ConnectionProperties.CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL" title="CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL</span></code></a>
|
||
<a class="reference internal" href="../properties.html#c.ConnectionProperties.CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL" title="CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL"><code class="xref c c-enumerator docutils literal notranslate"><span class="pre">CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL</span></code></a></p>
|
||
<section id="query-values">
|
||
<h2>Query values<a class="headerlink" href="#query-values" title="Link to this heading"></a></h2>
|
||
<p>To query these values use the following functions based on the type of information you want to receive:</p>
|
||
<dl class="c function">
|
||
<dt class="sig sig-object c">
|
||
<span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ts3server_getVirtualServerConnectionVariableAsDouble</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverID</span></span>, <span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="../properties.html#c.ConnectionProperties" title="ConnectionProperties"><span class="n"><span class="pre">ConnectionProperties</span></span></a><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result</span></span><span class="sig-paren">)</span><br /></dt>
|
||
<dd><p>get value of server connection properties as double </p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>serverID</strong> – which server to get connection properties of </p></li>
|
||
<li><p><strong>flag</strong> – specifies which value to get. One of the values from the <a class="reference internal" href="../properties.html#public__definitions_8h_1a050954dff4a89322d463770f688b1f65"><span class="std std-ref">ConnectionProperties</span></a> enum </p></li>
|
||
<li><p><strong>result</strong> – address of a variable to receive the value of the connection property. </p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>An Error code from the <a class="reference internal" href="../errors.html#public__errors_8h_1a0bcf1e0a5e32989890f6e85064327f7b"><span class="std std-ref">Ts3ErrorType</span></a> enum indicating either success or the failure reason </p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="c function">
|
||
<dt class="sig sig-object c">
|
||
<span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ts3server_getVirtualServerConnectionVariableAsUInt64</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverID</span></span>, <span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="../properties.html#c.ConnectionProperties" title="ConnectionProperties"><span class="n"><span class="pre">ConnectionProperties</span></span></a><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result</span></span><span class="sig-paren">)</span><br /></dt>
|
||
<dd><p>get value of server connection properties as unsigned integer. </p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>serverID</strong> – which server to get connection properties of </p></li>
|
||
<li><p><strong>flag</strong> – specifies which property to get the value of. One of the values from the <a class="reference internal" href="../properties.html#public__definitions_8h_1a050954dff4a89322d463770f688b1f65"><span class="std std-ref">ConnectionProperties</span></a> enum </p></li>
|
||
<li><p><strong>result</strong> – address of a variable to receive the value of the connection property </p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>An Error code from the <a class="reference internal" href="../errors.html#public__errors_8h_1a0bcf1e0a5e32989890f6e85064327f7b"><span class="std std-ref">Ts3ErrorType</span></a> enum indicating either success or the failure reason </p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="info-server.html" class="btn btn-neutral float-left" title="Server information" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="channels.html" class="btn btn-neutral float-right" title="Managing channels" 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> |