4557 lines
545 KiB
HTML
4557 lines
545 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>TeamSpeak Client Functions — 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="TeamSpeak Server Functions" href="server_api.html" />
|
|||
|
|
<link rel="prev" title="Structures & Enumerations" href="enumerations.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 class="current">
|
|||
|
|
<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 current"><a class="current reference internal" href="#">TeamSpeak Client Functions</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_freeMemory"><code class="docutils literal notranslate"><span class="pre">ts3client_freeMemory()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_initClientLib"><code class="docutils literal notranslate"><span class="pre">ts3client_initClientLib()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_destroyClientLib"><code class="docutils literal notranslate"><span class="pre">ts3client_destroyClientLib()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getClientLibVersion"><code class="docutils literal notranslate"><span class="pre">ts3client_getClientLibVersion()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getClientLibVersionNumber"><code class="docutils literal notranslate"><span class="pre">ts3client_getClientLibVersionNumber()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_spawnNewServerConnectionHandler"><code class="docutils literal notranslate"><span class="pre">ts3client_spawnNewServerConnectionHandler()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_destroyServerConnectionHandler"><code class="docutils literal notranslate"><span class="pre">ts3client_destroyServerConnectionHandler()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_createIdentity"><code class="docutils literal notranslate"><span class="pre">ts3client_createIdentity()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_identityStringToUniqueIdentifier"><code class="docutils literal notranslate"><span class="pre">ts3client_identityStringToUniqueIdentifier()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getPlaybackDeviceList"><code class="docutils literal notranslate"><span class="pre">ts3client_getPlaybackDeviceList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getCaptureDeviceList"><code class="docutils literal notranslate"><span class="pre">ts3client_getCaptureDeviceList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getPlaybackModeList"><code class="docutils literal notranslate"><span class="pre">ts3client_getPlaybackModeList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getCaptureModeList"><code class="docutils literal notranslate"><span class="pre">ts3client_getCaptureModeList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getDefaultPlaybackDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_getDefaultPlaybackDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getDefaultCaptureDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_getDefaultCaptureDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getDefaultPlayBackMode"><code class="docutils literal notranslate"><span class="pre">ts3client_getDefaultPlayBackMode()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getDefaultCaptureMode"><code class="docutils literal notranslate"><span class="pre">ts3client_getDefaultCaptureMode()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_openPlaybackDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_openPlaybackDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_openCaptureDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_openCaptureDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setAECReferenceDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_setAECReferenceDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getCurrentPlaybackDeviceName"><code class="docutils literal notranslate"><span class="pre">ts3client_getCurrentPlaybackDeviceName()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getCurrentPlayBackMode"><code class="docutils literal notranslate"><span class="pre">ts3client_getCurrentPlayBackMode()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getCurrentCaptureDeviceName"><code class="docutils literal notranslate"><span class="pre">ts3client_getCurrentCaptureDeviceName()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getCurrentCaptureMode"><code class="docutils literal notranslate"><span class="pre">ts3client_getCurrentCaptureMode()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_initiateGracefulPlaybackShutdown"><code class="docutils literal notranslate"><span class="pre">ts3client_initiateGracefulPlaybackShutdown()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_closePlaybackDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_closePlaybackDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_closeCaptureDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_closeCaptureDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_activateCaptureDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_activateCaptureDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_playWaveFile"><code class="docutils literal notranslate"><span class="pre">ts3client_playWaveFile()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_playWaveFileHandle"><code class="docutils literal notranslate"><span class="pre">ts3client_playWaveFileHandle()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_pauseWaveFileHandle"><code class="docutils literal notranslate"><span class="pre">ts3client_pauseWaveFileHandle()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_closeWaveFileHandle"><code class="docutils literal notranslate"><span class="pre">ts3client_closeWaveFileHandle()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_createAudioPlaybackHandle"><code class="docutils literal notranslate"><span class="pre">ts3client_createAudioPlaybackHandle()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_pauseAudioPlaybackHandle"><code class="docutils literal notranslate"><span class="pre">ts3client_pauseAudioPlaybackHandle()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_closeAudioPlaybackHandle"><code class="docutils literal notranslate"><span class="pre">ts3client_closeAudioPlaybackHandle()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_enqueueAudioPlaybackHandle"><code class="docutils literal notranslate"><span class="pre">ts3client_enqueueAudioPlaybackHandle()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_registerCustomDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_registerCustomDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_unregisterCustomDevice"><code class="docutils literal notranslate"><span class="pre">ts3client_unregisterCustomDevice()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_processCustomCaptureData"><code class="docutils literal notranslate"><span class="pre">ts3client_processCustomCaptureData()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_acquireCustomPlaybackData"><code class="docutils literal notranslate"><span class="pre">ts3client_acquireCustomPlaybackData()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setLocalTestMode"><code class="docutils literal notranslate"><span class="pre">ts3client_setLocalTestMode()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_startVoiceRecording"><code class="docutils literal notranslate"><span class="pre">ts3client_startVoiceRecording()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_stopVoiceRecording"><code class="docutils literal notranslate"><span class="pre">ts3client_stopVoiceRecording()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_allowWhispersFrom"><code class="docutils literal notranslate"><span class="pre">ts3client_allowWhispersFrom()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_removeFromAllowedWhispersFrom"><code class="docutils literal notranslate"><span class="pre">ts3client_removeFromAllowedWhispersFrom()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getWhisperReceiveWhitelist"><code class="docutils literal notranslate"><span class="pre">ts3client_getWhisperReceiveWhitelist()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_isWhisperReceiveWhitelisted"><code class="docutils literal notranslate"><span class="pre">ts3client_isWhisperReceiveWhitelisted()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setWhisperReceiveWhitelist"><code class="docutils literal notranslate"><span class="pre">ts3client_setWhisperReceiveWhitelist()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_systemset3DListenerAttributes"><code class="docutils literal notranslate"><span class="pre">ts3client_systemset3DListenerAttributes()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_set3DWaveAttributes"><code class="docutils literal notranslate"><span class="pre">ts3client_set3DWaveAttributes()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_systemset3DSettings"><code class="docutils literal notranslate"><span class="pre">ts3client_systemset3DSettings()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_channelset3DAttributes"><code class="docutils literal notranslate"><span class="pre">ts3client_channelset3DAttributes()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getPreProcessorInfoValueFloat"><code class="docutils literal notranslate"><span class="pre">ts3client_getPreProcessorInfoValueFloat()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getPreProcessorConfigValue"><code class="docutils literal notranslate"><span class="pre">ts3client_getPreProcessorConfigValue()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setPreProcessorConfigValue"><code class="docutils literal notranslate"><span class="pre">ts3client_setPreProcessorConfigValue()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setKeyPressedDuringChunk"><code class="docutils literal notranslate"><span class="pre">ts3client_setKeyPressedDuringChunk()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getGlobalConfigValueAsInt"><code class="docutils literal notranslate"><span class="pre">ts3client_getGlobalConfigValueAsInt()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setGlobalConfigValue"><code class="docutils literal notranslate"><span class="pre">ts3client_setGlobalConfigValue()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getEncodeConfigValue"><code class="docutils literal notranslate"><span class="pre">ts3client_getEncodeConfigValue()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getPlaybackConfigValueAsFloat"><code class="docutils literal notranslate"><span class="pre">ts3client_getPlaybackConfigValueAsFloat()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setPlaybackConfigValue"><code class="docutils literal notranslate"><span class="pre">ts3client_setPlaybackConfigValue()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setClientVolumeModifier"><code class="docutils literal notranslate"><span class="pre">ts3client_setClientVolumeModifier()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_logMessage"><code class="docutils literal notranslate"><span class="pre">ts3client_logMessage()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setLogVerbosity"><code class="docutils literal notranslate"><span class="pre">ts3client_setLogVerbosity()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getErrorMessage"><code class="docutils literal notranslate"><span class="pre">ts3client_getErrorMessage()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_startConnection"><code class="docutils literal notranslate"><span class="pre">ts3client_startConnection()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_startConnectionWithChannelID"><code class="docutils literal notranslate"><span class="pre">ts3client_startConnectionWithChannelID()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_stopConnection"><code class="docutils literal notranslate"><span class="pre">ts3client_stopConnection()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestClientMove"><code class="docutils literal notranslate"><span class="pre">ts3client_requestClientMove()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestClientVariables"><code class="docutils literal notranslate"><span class="pre">ts3client_requestClientVariables()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestClientKickFromChannel"><code class="docutils literal notranslate"><span class="pre">ts3client_requestClientKickFromChannel()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestClientKickFromServer"><code class="docutils literal notranslate"><span class="pre">ts3client_requestClientKickFromServer()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestChannelDelete"><code class="docutils literal notranslate"><span class="pre">ts3client_requestChannelDelete()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestChannelMove"><code class="docutils literal notranslate"><span class="pre">ts3client_requestChannelMove()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestSendPrivateTextMsg"><code class="docutils literal notranslate"><span class="pre">ts3client_requestSendPrivateTextMsg()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestSendChannelTextMsg"><code class="docutils literal notranslate"><span class="pre">ts3client_requestSendChannelTextMsg()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestDeleteChannelTextMsg"><code class="docutils literal notranslate"><span class="pre">ts3client_requestDeleteChannelTextMsg()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestSendServerTextMsg"><code class="docutils literal notranslate"><span class="pre">ts3client_requestSendServerTextMsg()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestChat"><code class="docutils literal notranslate"><span class="pre">ts3client_requestChat()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestConnectionInfo"><code class="docutils literal notranslate"><span class="pre">ts3client_requestConnectionInfo()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestClientSetWhisperList"><code class="docutils literal notranslate"><span class="pre">ts3client_requestClientSetWhisperList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestChannelSubscribe"><code class="docutils literal notranslate"><span class="pre">ts3client_requestChannelSubscribe()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestChannelSubscribeAll"><code class="docutils literal notranslate"><span class="pre">ts3client_requestChannelSubscribeAll()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestChannelUnsubscribe"><code class="docutils literal notranslate"><span class="pre">ts3client_requestChannelUnsubscribe()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestChannelUnsubscribeAll"><code class="docutils literal notranslate"><span class="pre">ts3client_requestChannelUnsubscribeAll()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestChannelDescription"><code class="docutils literal notranslate"><span class="pre">ts3client_requestChannelDescription()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestMuteClients"><code class="docutils literal notranslate"><span class="pre">ts3client_requestMuteClients()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestUnmuteClients"><code class="docutils literal notranslate"><span class="pre">ts3client_requestUnmuteClients()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestClientIDs"><code class="docutils literal notranslate"><span class="pre">ts3client_requestClientIDs()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getClientID"><code class="docutils literal notranslate"><span class="pre">ts3client_getClientID()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getConnectionStatus"><code class="docutils literal notranslate"><span class="pre">ts3client_getConnectionStatus()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getConnectionVariableAsUInt64"><code class="docutils literal notranslate"><span class="pre">ts3client_getConnectionVariableAsUInt64()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getConnectionVariableAsDouble"><code class="docutils literal notranslate"><span class="pre">ts3client_getConnectionVariableAsDouble()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getConnectionVariableAsString"><code class="docutils literal notranslate"><span class="pre">ts3client_getConnectionVariableAsString()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_cleanUpConnectionInfo"><code class="docutils literal notranslate"><span class="pre">ts3client_cleanUpConnectionInfo()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestServerConnectionInfo"><code class="docutils literal notranslate"><span class="pre">ts3client_requestServerConnectionInfo()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getServerConnectionVariableAsUInt64"><code class="docutils literal notranslate"><span class="pre">ts3client_getServerConnectionVariableAsUInt64()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getServerConnectionVariableAsFloat"><code class="docutils literal notranslate"><span class="pre">ts3client_getServerConnectionVariableAsFloat()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getClientSelfVariableAsInt"><code class="docutils literal notranslate"><span class="pre">ts3client_getClientSelfVariableAsInt()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getClientSelfVariableAsString"><code class="docutils literal notranslate"><span class="pre">ts3client_getClientSelfVariableAsString()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setClientSelfVariableAsInt"><code class="docutils literal notranslate"><span class="pre">ts3client_setClientSelfVariableAsInt()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setClientSelfVariableAsString"><code class="docutils literal notranslate"><span class="pre">ts3client_setClientSelfVariableAsString()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_flushClientSelfUpdates"><code class="docutils literal notranslate"><span class="pre">ts3client_flushClientSelfUpdates()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getClientVariableAsInt"><code class="docutils literal notranslate"><span class="pre">ts3client_getClientVariableAsInt()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getClientVariableAsUInt64"><code class="docutils literal notranslate"><span class="pre">ts3client_getClientVariableAsUInt64()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getClientVariableAsString"><code class="docutils literal notranslate"><span class="pre">ts3client_getClientVariableAsString()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getClientList"><code class="docutils literal notranslate"><span class="pre">ts3client_getClientList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getChannelOfClient"><code class="docutils literal notranslate"><span class="pre">ts3client_getChannelOfClient()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getChannelVariableAsInt"><code class="docutils literal notranslate"><span class="pre">ts3client_getChannelVariableAsInt()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getChannelVariableAsUInt64"><code class="docutils literal notranslate"><span class="pre">ts3client_getChannelVariableAsUInt64()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getChannelVariableAsString"><code class="docutils literal notranslate"><span class="pre">ts3client_getChannelVariableAsString()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getChannelIDFromChannelNames"><code class="docutils literal notranslate"><span class="pre">ts3client_getChannelIDFromChannelNames()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setChannelVariableAsInt"><code class="docutils literal notranslate"><span class="pre">ts3client_setChannelVariableAsInt()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setChannelVariableAsUInt64"><code class="docutils literal notranslate"><span class="pre">ts3client_setChannelVariableAsUInt64()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setChannelVariableAsString"><code class="docutils literal notranslate"><span class="pre">ts3client_setChannelVariableAsString()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_flushChannelUpdates"><code class="docutils literal notranslate"><span class="pre">ts3client_flushChannelUpdates()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_flushChannelCreation"><code class="docutils literal notranslate"><span class="pre">ts3client_flushChannelCreation()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getChannelList"><code class="docutils literal notranslate"><span class="pre">ts3client_getChannelList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getChannelClientList"><code class="docutils literal notranslate"><span class="pre">ts3client_getChannelClientList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getParentChannelOfChannel"><code class="docutils literal notranslate"><span class="pre">ts3client_getParentChannelOfChannel()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getChannelEmptySecs"><code class="docutils literal notranslate"><span class="pre">ts3client_getChannelEmptySecs()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getServerConnectionHandlerList"><code class="docutils literal notranslate"><span class="pre">ts3client_getServerConnectionHandlerList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getServerVariableAsInt"><code class="docutils literal notranslate"><span class="pre">ts3client_getServerVariableAsInt()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getServerVariableAsUInt64"><code class="docutils literal notranslate"><span class="pre">ts3client_getServerVariableAsUInt64()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getServerVariableAsString"><code class="docutils literal notranslate"><span class="pre">ts3client_getServerVariableAsString()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestServerVariables"><code class="docutils literal notranslate"><span class="pre">ts3client_requestServerVariables()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getTransferFileName"><code class="docutils literal notranslate"><span class="pre">ts3client_getTransferFileName()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getTransferFilePath"><code class="docutils literal notranslate"><span class="pre">ts3client_getTransferFilePath()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getTransferFileRemotePath"><code class="docutils literal notranslate"><span class="pre">ts3client_getTransferFileRemotePath()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getTransferFileSize"><code class="docutils literal notranslate"><span class="pre">ts3client_getTransferFileSize()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getTransferFileSizeDone"><code class="docutils literal notranslate"><span class="pre">ts3client_getTransferFileSizeDone()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_isTransferSender"><code class="docutils literal notranslate"><span class="pre">ts3client_isTransferSender()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getTransferStatus"><code class="docutils literal notranslate"><span class="pre">ts3client_getTransferStatus()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getCurrentTransferSpeed"><code class="docutils literal notranslate"><span class="pre">ts3client_getCurrentTransferSpeed()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getAverageTransferSpeed"><code class="docutils literal notranslate"><span class="pre">ts3client_getAverageTransferSpeed()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getTransferRunTime"><code class="docutils literal notranslate"><span class="pre">ts3client_getTransferRunTime()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_sendFile"><code class="docutils literal notranslate"><span class="pre">ts3client_sendFile()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestFile"><code class="docutils literal notranslate"><span class="pre">ts3client_requestFile()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_haltTransfer"><code class="docutils literal notranslate"><span class="pre">ts3client_haltTransfer()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestFileList"><code class="docutils literal notranslate"><span class="pre">ts3client_requestFileList()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestFileInfo"><code class="docutils literal notranslate"><span class="pre">ts3client_requestFileInfo()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestDeleteFile"><code class="docutils literal notranslate"><span class="pre">ts3client_requestDeleteFile()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestCreateDirectory"><code class="docutils literal notranslate"><span class="pre">ts3client_requestCreateDirectory()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_requestRenameFile"><code class="docutils literal notranslate"><span class="pre">ts3client_requestRenameFile()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_s3ft_getPresignedUrls"><code class="docutils literal notranslate"><span class="pre">ts3client_s3ft_getPresignedUrls()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_s3ft_deleteFile"><code class="docutils literal notranslate"><span class="pre">ts3client_s3ft_deleteFile()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_s3ft_renameFile"><code class="docutils literal notranslate"><span class="pre">ts3client_s3ft_renameFile()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_s3ft_listFiles"><code class="docutils literal notranslate"><span class="pre">ts3client_s3ft_listFiles()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_s3ft_uploadDoneNotification"><code class="docutils literal notranslate"><span class="pre">ts3client_s3ft_uploadDoneNotification()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_s3ft_getUploadUrl"><code class="docutils literal notranslate"><span class="pre">ts3client_s3ft_getUploadUrl()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_s3ft_getDownloadUrl"><code class="docutils literal notranslate"><span class="pre">ts3client_s3ft_getDownloadUrl()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getInstanceSpeedLimitUp"><code class="docutils literal notranslate"><span class="pre">ts3client_getInstanceSpeedLimitUp()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getInstanceSpeedLimitDown"><code class="docutils literal notranslate"><span class="pre">ts3client_getInstanceSpeedLimitDown()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getServerConnectionHandlerSpeedLimitUp"><code class="docutils literal notranslate"><span class="pre">ts3client_getServerConnectionHandlerSpeedLimitUp()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getServerConnectionHandlerSpeedLimitDown"><code class="docutils literal notranslate"><span class="pre">ts3client_getServerConnectionHandlerSpeedLimitDown()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getTransferSpeedLimit"><code class="docutils literal notranslate"><span class="pre">ts3client_getTransferSpeedLimit()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setInstanceSpeedLimitUp"><code class="docutils literal notranslate"><span class="pre">ts3client_setInstanceSpeedLimitUp()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setInstanceSpeedLimitDown"><code class="docutils literal notranslate"><span class="pre">ts3client_setInstanceSpeedLimitDown()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setServerConnectionHandlerSpeedLimitUp"><code class="docutils literal notranslate"><span class="pre">ts3client_setServerConnectionHandlerSpeedLimitUp()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setServerConnectionHandlerSpeedLimitDown"><code class="docutils literal notranslate"><span class="pre">ts3client_setServerConnectionHandlerSpeedLimitDown()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_setTransferSpeedLimit"><code class="docutils literal notranslate"><span class="pre">ts3client_setTransferSpeedLimit()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ts3client_getServerLegacyUUID"><code class="docutils literal notranslate"><span class="pre">ts3client_getServerLegacyUUID()</span></code></a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#c.ClientUIFunctions"><code class="docutils literal notranslate"><span class="pre">ClientUIFunctions</span></code></a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onMessage"><code class="docutils literal notranslate"><span class="pre">onMessage</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onConnectStatusChangeEvent"><code class="docutils literal notranslate"><span class="pre">onConnectStatusChangeEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onServerProtocolVersionEvent"><code class="docutils literal notranslate"><span class="pre">onServerProtocolVersionEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onNewChannelEvent"><code class="docutils literal notranslate"><span class="pre">onNewChannelEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onNewChannelCreatedEvent"><code class="docutils literal notranslate"><span class="pre">onNewChannelCreatedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onDelChannelEvent"><code class="docutils literal notranslate"><span class="pre">onDelChannelEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onChannelMoveEvent"><code class="docutils literal notranslate"><span class="pre">onChannelMoveEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onUpdateChannelEvent"><code class="docutils literal notranslate"><span class="pre">onUpdateChannelEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onUpdateChannelEditedEvent"><code class="docutils literal notranslate"><span class="pre">onUpdateChannelEditedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onUpdateClientEvent"><code class="docutils literal notranslate"><span class="pre">onUpdateClientEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onClientMoveEvent"><code class="docutils literal notranslate"><span class="pre">onClientMoveEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onClientMoveSubscriptionEvent"><code class="docutils literal notranslate"><span class="pre">onClientMoveSubscriptionEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onClientMoveTimeoutEvent"><code class="docutils literal notranslate"><span class="pre">onClientMoveTimeoutEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onClientMoveMovedEvent"><code class="docutils literal notranslate"><span class="pre">onClientMoveMovedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onClientKickFromChannelEvent"><code class="docutils literal notranslate"><span class="pre">onClientKickFromChannelEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onClientKickFromServerEvent"><code class="docutils literal notranslate"><span class="pre">onClientKickFromServerEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onClientIDsEvent"><code class="docutils literal notranslate"><span class="pre">onClientIDsEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onClientIDsFinishedEvent"><code class="docutils literal notranslate"><span class="pre">onClientIDsFinishedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onServerEditedEvent"><code class="docutils literal notranslate"><span class="pre">onServerEditedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onServerUpdatedEvent"><code class="docutils literal notranslate"><span class="pre">onServerUpdatedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onServerErrorEvent"><code class="docutils literal notranslate"><span class="pre">onServerErrorEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onServerStopEvent"><code class="docutils literal notranslate"><span class="pre">onServerStopEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onTextMessageEvent"><code class="docutils literal notranslate"><span class="pre">onTextMessageEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onTalkStatusChangeEvent"><code class="docutils literal notranslate"><span class="pre">onTalkStatusChangeEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onIgnoredWhisperEvent"><code class="docutils literal notranslate"><span class="pre">onIgnoredWhisperEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onConnectionInfoEvent"><code class="docutils literal notranslate"><span class="pre">onConnectionInfoEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onServerConnectionInfoEvent"><code class="docutils literal notranslate"><span class="pre">onServerConnectionInfoEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onChannelSubscribeEvent"><code class="docutils literal notranslate"><span class="pre">onChannelSubscribeEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onChannelSubscribeFinishedEvent"><code class="docutils literal notranslate"><span class="pre">onChannelSubscribeFinishedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onChannelUnsubscribeEvent"><code class="docutils literal notranslate"><span class="pre">onChannelUnsubscribeEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onChannelUnsubscribeFinishedEvent"><code class="docutils literal notranslate"><span class="pre">onChannelUnsubscribeFinishedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onChannelDescriptionUpdateEvent"><code class="docutils literal notranslate"><span class="pre">onChannelDescriptionUpdateEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onChannelPasswordChangedEvent"><code class="docutils literal notranslate"><span class="pre">onChannelPasswordChangedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onPlaybackShutdownCompleteEvent"><code class="docutils literal notranslate"><span class="pre">onPlaybackShutdownCompleteEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onSoundDeviceListChangedEvent"><code class="docutils literal notranslate"><span class="pre">onSoundDeviceListChangedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onEditPlaybackVoiceDataEvent"><code class="docutils literal notranslate"><span class="pre">onEditPlaybackVoiceDataEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onEditPostProcessVoiceDataEvent"><code class="docutils literal notranslate"><span class="pre">onEditPostProcessVoiceDataEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onEditMixedPlaybackVoiceDataEvent"><code class="docutils literal notranslate"><span class="pre">onEditMixedPlaybackVoiceDataEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onEditCapturedVoiceDataPreprocessEvent"><code class="docutils literal notranslate"><span class="pre">onEditCapturedVoiceDataPreprocessEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onEditCapturedVoiceDataEvent"><code class="docutils literal notranslate"><span class="pre">onEditCapturedVoiceDataEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onCustom3dRolloffCalculationClientEvent"><code class="docutils literal notranslate"><span class="pre">onCustom3dRolloffCalculationClientEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onCustom3dRolloffCalculationWaveEvent"><code class="docutils literal notranslate"><span class="pre">onCustom3dRolloffCalculationWaveEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onUserLoggingMessageEvent"><code class="docutils literal notranslate"><span class="pre">onUserLoggingMessageEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onCustomPacketEncryptEvent"><code class="docutils literal notranslate"><span class="pre">onCustomPacketEncryptEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onCustomPacketDecryptEvent"><code class="docutils literal notranslate"><span class="pre">onCustomPacketDecryptEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onCheckServerUniqueIdentifierEvent"><code class="docutils literal notranslate"><span class="pre">onCheckServerUniqueIdentifierEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onClientPasswordEncrypt"><code class="docutils literal notranslate"><span class="pre">onClientPasswordEncrypt</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onFileTransferStatusEvent"><code class="docutils literal notranslate"><span class="pre">onFileTransferStatusEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onFileListEvent"><code class="docutils literal notranslate"><span class="pre">onFileListEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onFileListFinishedEvent"><code class="docutils literal notranslate"><span class="pre">onFileListFinishedEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onFileInfoEvent"><code class="docutils literal notranslate"><span class="pre">onFileInfoEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onChatLoginTokenEvent"><code class="docutils literal notranslate"><span class="pre">onChatLoginTokenEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onAuthenticationTokenEvent"><code class="docutils literal notranslate"><span class="pre">onAuthenticationTokenEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onScreenshareSessionEvent"><code class="docutils literal notranslate"><span class="pre">onScreenshareSessionEvent</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onJsonReply"><code class="docutils literal notranslate"><span class="pre">onJsonReply</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onSendCallToMatrix"><code class="docutils literal notranslate"><span class="pre">onSendCallToMatrix</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onProtoResponse"><code class="docutils literal notranslate"><span class="pre">onProtoResponse</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#c.ClientUIFunctions.onProtoEvent"><code class="docutils literal notranslate"><span class="pre">onProtoEvent</span></code></a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</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>
|
|||
|
|
<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 active">TeamSpeak Client Functions</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="teamspeak-client-functions">
|
|||
|
|
<h1>TeamSpeak Client Functions<a class="headerlink" href="#teamspeak-client-functions" title="Link to this heading"></a></h1>
|
|||
|
|
<div class="breathe-sectiondef docutils container">
|
|||
|
|
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
|
|||
|
|
<dl class="c function">
|
|||
|
|
<dt class="sig sig-object c" id="c.ts3client_freeMemory">
|
|||
|
|
<span class="target" id="clientlib_8h_1a783cbda7046acfc0173c669821702619"></span><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">ts3client_freeMemory</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pointer</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_freeMemory" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Releases memory allocated by the client library. </p>
|
|||
|
|
<p>For every function that has output parameters which take pointers to memory (e.g. char**) the client library will allocate sufficient memory for you, however you need to take care of releasing the memory by passing the variable to this function.</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>pointer</strong> – pointer to memory allocated by the client library </p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c function">
|
|||
|
|
<dt class="sig sig-object c" id="c.ts3client_initClientLib">
|
|||
|
|
<span class="target" id="clientlib_8h_1ad0184863f627de56107b7706020982f1"></span><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">ts3client_initClientLib</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="client/3dsound.html#c.ClientUIFunctions" title="ClientUIFunctions"><span class="n"><span class="pre">ClientUIFunctions</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">functionPointers</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="n"><span class="pre">ClientUIFunctionsRare</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">functionRarePointers</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">usedLogTypes</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">logFileFolder</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">resourcesFolder</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>initializes the client library and defines callback functions </p>
|
|||
|
|
<p>This is the first function you need to call, before this all calls to the client library will fail. In this call you will also set the functions you would like to have called when certain changes happen on the client side as well as on connected servers.</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>functionPointers</strong> – defines which functions in your code are to be called on specific events. Zero initialize it and assign the desired function to call to the respective members of the struct </p></li>
|
|||
|
|
<li><p><strong>functionRarePointers</strong> – similar to the functionPointers parameter. These are not available in the SDK, so SDK users should pass a nullptr here. </p></li>
|
|||
|
|
<li><p><strong>usedLogTypes</strong> – a combination of values from the <a class="reference internal" href="enumerations.html#logtypes_8h_1a0e4c244f5254ca12ffeadcaf83e225b4"><span class="std std-ref">LogTypes</span></a> enum. Specifies which type(s) of logging you would like to use. </p></li>
|
|||
|
|
<li><p><strong>logFileFolder</strong> – path in which to create log files </p></li>
|
|||
|
|
<li><p><strong>resourcesFolder</strong> – path to the directory in which the soundbackends folder is located. Required to be able to load the sound backends and process audio. </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" id="c.ts3client_destroyClientLib">
|
|||
|
|
<span class="target" id="clientlib_8h_1ac196aa5fba17c2da16ca4d0a4c036977"></span><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">ts3client_destroyClientLib</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>destroys the client library. Must not be called from within a callback. </p>
|
|||
|
|
<p>This is the last function to call, after calling this function you will no longer be able to use client library functions.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><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" id="c.ts3client_getClientLibVersion">
|
|||
|
|
<span class="target" id="clientlib_8h_1a0a9179fa6aecc738e9642fcd6390d374"></span><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">ts3client_getClientLibVersion</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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 the version string of the client library. </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>result</strong> – Pointer to a char* variable that the client library will allocate memory for. If the return value is ERROR_ok the memory was allocated and the variable pointed to will contain the client library version. You need to free the variable pointed to by using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getClientLibVersionNumber">
|
|||
|
|
<span class="target" id="clientlib_8h_1ae87a6337d8a296cf63cd243d6b3426a6"></span><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">ts3client_getClientLibVersionNumber</span></span></span><span class="sig-paren">(</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 the version number of the client library. </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>result</strong> – Pointer to a variable to store the client library version number into </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" id="c.ts3client_spawnNewServerConnectionHandler">
|
|||
|
|
<span class="target" id="clientlib_8h_1a6da55ee2076c2c5e8e73af1e5a9b1cbf"></span><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">ts3client_spawnNewServerConnectionHandler</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">port</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>Creates a new server connection handler to connect to servers. </p>
|
|||
|
|
<p>A connection handler is what handles and identifies server connections to the client library. There can be many of these at the same time and every single one of them can be connected to any server. The client library identifies them by the id placed in the result param. When you receive callbacks, or need to change things, on a specific server you will also specify which server you would like to use by providing the corresponding serverConnectionHandlerId to the client library function.</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>port</strong> – the local port to use. Specify 0 to use an ephemeral port. </p></li>
|
|||
|
|
<li><p><strong>result</strong> – Address of a variable to store the id of the connection handler in. Use this to reference the connection handler in future calls to client lib functions. </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" id="c.ts3client_destroyServerConnectionHandler">
|
|||
|
|
<span class="target" id="clientlib_8h_1aaf250e4ca6d1faa0e7469e493acb7a26"></span><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">ts3client_destroyServerConnectionHandler</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">serverConnectionHandlerID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Destroys a connection handler. </p>
|
|||
|
|
<p>After destruction the connection handler is invalid and cannot be used any longer. Must not be called from within a callback!</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>serverConnectionHandlerID</strong> – which connection handler to destroy </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" id="c.ts3client_createIdentity">
|
|||
|
|
<span class="target" id="clientlib_8h_1a6189c75702e4829fe509d718ccb5dfa7"></span><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">ts3client_createIdentity</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>Create a new identity to use for connecting to a server. </p>
|
|||
|
|
<p>Identities identify a client to the server. The identity should be stored and reused for sessions by the same user.</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>result</strong> – Address of a variable to store the identity in. Memory is allocated by the client lib and caller must free it using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_identityStringToUniqueIdentifier">
|
|||
|
|
<span class="target" id="clientlib_8h_1a89e41a1d20fe351d7cee66654e7cb289"></span><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">ts3client_identityStringToUniqueIdentifier</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">identityString</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_identityStringToUniqueIdentifier" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Get the unique client identifier from an identity. </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>identityString</strong> – The identity to produce the unique identifier for, as created by ts3client_createIdentity </p></li>
|
|||
|
|
<li><p><strong>result</strong> – Pointer to a variable to store the unique client identifier in. Memory is allocated by the client lib and caller must free it using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getPlaybackDeviceList">
|
|||
|
|
<span class="target" id="clientlib_8h_1a30403c62cf44a6ec5b047cb0bc55421f"></span><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">ts3client_getPlaybackDeviceList</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">modeID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></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>Retrieve available playback devices as reported by the operating system. </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>modeID</strong> – a string indicating a valid playback mode as retrieved by ts3client_getPlaybackModeList or ts3client_getDefaultPlaybackMode </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable that receives a NULL terminated array like <code class="docutils literal notranslate"><span class="pre">{{char*</span> <span class="pre">deviceName,</span> <span class="pre">char*</span> <span class="pre">deviceId,</span> <span class="pre">char*</span> <span class="pre">interfaceName</span> <span class="pre">char*</span> <span class="pre">description,</span> <span class="pre">char*</span> <span class="pre">fromFactor}</span> <span class="pre">...,</span> <span class="pre">NULL}</span></code> on windows, <code class="docutils literal notranslate"><span class="pre">{{char*</span> <span class="pre">deviceName,</span> <span class="pre">char*</span> <span class="pre">deviceId},</span> <span class="pre">...,</span> <span class="pre">NULL}</span></code> on other platforms. Memory is allocated by the client lib and caller must free individual strings, array members and the array itself using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getCaptureDeviceList">
|
|||
|
|
<span class="target" id="clientlib_8h_1a6b4372879d6d45c5bba3f46e2329e8a3"></span><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">ts3client_getCaptureDeviceList</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">modeID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></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>Retrieve available recording devices as reported by the operating system. </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>modeID</strong> – a string indicating a valid capture mode as retrieved by ts3client_getCaptureModeList or ts3client_getDefaultCaptureMode </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable that receives a NULL terminated array like `{{char* deviceName, char* deviceId, char* interfaceName char* description, char* fromFactor} …, NULL}<code class="docutils literal notranslate"><span class="pre">on</span> <span class="pre">windows,</span></code>{{char* deviceName, char* deviceId}, …, NULL}` on other platforms. Memory is allocated by the client lib and caller must free individual strings and the array itself using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getPlaybackModeList">
|
|||
|
|
<span class="target" id="clientlib_8h_1a9f9bfb5ed20220a15be6ce0e3d402395"></span><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">ts3client_getPlaybackModeList</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></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>Retrieve available playback modes. </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>result</strong> – address of a variable that receives a NULL terminated array of utf8 encoded c strings of available playback modes. Memory is allocated by the client lib and caller must free individual strings and the array itself using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getCaptureModeList">
|
|||
|
|
<span class="target" id="clientlib_8h_1a80712a74cde0cb73e2e30c0654994120"></span><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">ts3client_getCaptureModeList</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></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>Retrieve available capture modes. </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>result</strong> – address of a variable that receives a NULL terminated array of utf8 encoded c strings of available capture modes. Memory is allocated by the client lib and caller must free individual strings and the array itself using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getDefaultPlaybackDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1a6f3ff3577b71654832fa1e5a843ff8b1"></span><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">ts3client_getDefaultPlaybackDevice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">modeID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></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 the current operating system defined default playback device for the indicated mode. </p>
|
|||
|
|
<p>The operating system may define different devices for different modes.</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>modeID</strong> – a string indicating a valid playback mode as retrieved by <a class="reference internal" href="#clientlib_8h_1a9f9bfb5ed20220a15be6ce0e3d402395"><span class="std std-ref">ts3client_getPlaybackModeList</span></a> or <a class="reference internal" href="#clientlib_8h_1a062eef0dd3259a8af7f750fe5dd3bed0"><span class="std std-ref">ts3client_getDefaultPlayBackMode</span></a></p></li>
|
|||
|
|
<li><p><strong>result</strong> – Address of a variable that receives a NULL terminated array of two c strings like <code class="docutils literal notranslate"><span class="pre">{char*</span> <span class="pre">deviceName,</span> <span class="pre">char*</span> <span class="pre">deviceID,</span> <span class="pre">NULL}</span></code> Memory is allocated by the client lib and caller must free individual strings and the array itself using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getDefaultCaptureDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1a84e76960d5fce4c522d6c0895658fc02"></span><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">ts3client_getDefaultCaptureDevice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">modeID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></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 the current operating system defined default capture device for the indicated mode. </p>
|
|||
|
|
<p>The operating system may define different devices for different modes.</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>modeID</strong> – a string indicating a valid capture mode as retrieved by <a class="reference internal" href="#clientlib_8h_1a80712a74cde0cb73e2e30c0654994120"><span class="std std-ref">ts3client_getCaptureModeList</span></a> or <a class="reference internal" href="#clientlib_8h_1a79856dbbe99235a441a569af2449d526"><span class="std std-ref">ts3client_getDefaultCaptureMode</span></a></p></li>
|
|||
|
|
<li><p><strong>result</strong> – Address of a variable that receives a NULL terminated array of two c strings like <code class="docutils literal notranslate"><span class="pre">{char*</span> <span class="pre">deviceName,</span> <span class="pre">char*</span> <span class="pre">deviceID,</span> <span class="pre">NULL}</span></code> Memory is allocated by the client lib and both the array and its individual members must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getDefaultPlayBackMode">
|
|||
|
|
<span class="target" id="clientlib_8h_1a062eef0dd3259a8af7f750fe5dd3bed0"></span><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">ts3client_getDefaultPlayBackMode</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>Retrieve the current default playback mode. </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>result</strong> – Address of a char array to receive the c string indicating the default mode. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getDefaultCaptureMode">
|
|||
|
|
<span class="target" id="clientlib_8h_1a79856dbbe99235a441a569af2449d526"></span><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">ts3client_getDefaultCaptureMode</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>Retrieve the current default capture mode. </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>result</strong> – Address of a char array to receive a c string indicating the default mode. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_openPlaybackDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1a62a146d4a644dbf7dfdda6c4bcd6c63a"></span><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">ts3client_openPlaybackDevice</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">modeID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">playbackDevice</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>initializes a playback device for a connection handler </p>
|
|||
|
|
<p>Call this function to start audio playback of TeamSpeak audio on a connection</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>serverConnectionHandlerID</strong> – the connection handler on which to initialize the specified device </p></li>
|
|||
|
|
<li><p><strong>modeID</strong> – utf8 encoded c-string containing the mode to open the device in. Pass an empty string to use the default mode. See <a class="reference internal" href="#clientlib_8h_1a9f9bfb5ed20220a15be6ce0e3d402395"><span class="std std-ref">ts3client_getPlaybackModeList</span></a> and <a class="reference internal" href="#clientlib_8h_1a062eef0dd3259a8af7f750fe5dd3bed0"><span class="std std-ref">ts3client_getDefaultPlayBackMode</span></a> for a list of valid modes. </p></li>
|
|||
|
|
<li><p><strong>playbackDevice</strong> – utf8 encoded c-string containing the device name of the device to open. Pass an empty string to use the default device. See <a class="reference internal" href="#clientlib_8h_1a30403c62cf44a6ec5b047cb0bc55421f"><span class="std std-ref">ts3client_getPlaybackDeviceList</span></a> and <a class="reference internal" href="#clientlib_8h_1a6f3ff3577b71654832fa1e5a843ff8b1"><span class="std std-ref">ts3client_getDefaultPlaybackDevice</span></a> for valid devices. </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" id="c.ts3client_openCaptureDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1ab2eb1f16c2d56ffd3de35b3af544c20d"></span><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">ts3client_openCaptureDevice</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">modeID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">captureDevice</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>initializes a capture device for a connection handler </p>
|
|||
|
|
<p>Call this function to start consuming audio from the specified device and send it to the server</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>serverConnectionHandlerID</strong> – the connection handler on which to open the capture device </p></li>
|
|||
|
|
<li><p><strong>modeID</strong> – utf8 encoded c-string containing the mode in which to open the device. Pass an empty string to use the default mode. See <a class="reference internal" href="#clientlib_8h_1a80712a74cde0cb73e2e30c0654994120"><span class="std std-ref">ts3client_getCaptureModeList</span></a> and <a class="reference internal" href="#clientlib_8h_1a79856dbbe99235a441a569af2449d526"><span class="std std-ref">ts3client_getDefaultCaptureMode</span></a> for a list of valid modes. </p></li>
|
|||
|
|
<li><p><strong>captureDevice</strong> – utf8 encoded c-string containing the device name of the device to open. Pass an empty string to use the default device. See <a class="reference internal" href="#clientlib_8h_1a6b4372879d6d45c5bba3f46e2329e8a3"><span class="std std-ref">ts3client_getCaptureDeviceList</span></a> and <a class="reference internal" href="#clientlib_8h_1a84e76960d5fce4c522d6c0895658fc02"><span class="std std-ref">ts3client_getDefaultCaptureDevice</span></a> for a list or valid devices. </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" id="c.ts3client_setAECReferenceDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1accfa9a48da1804776fc042fe16b18210"></span><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">ts3client_setAECReferenceDevice</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">modeID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">renderDeviceID</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_setAECReferenceDevice" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>set an explicit render device whose output should serve as the AEC reference signal </p>
|
|||
|
|
<p>By default the SDK pairs AEC with the same mode/device used for playback on the connection, which only works when capture and playback share a backend mode. Use this function when playback is routed through a custom device (e.g. a game engine’s audio mixer) but echo cancellation should still operate against the audio that is actually rendered to the user’s speakers. The named device must be a native render endpoint (no custom-mode devices); on platforms whose backend supports system-level loopback (Windows WASAPI, Linux PulseAudio) this is the device whose loopback capture is fed to the echo canceller.</p>
|
|||
|
|
<p>Call after <a class="reference internal" href="#clientlib_8h_1ab2eb1f16c2d56ffd3de35b3af544c20d"><span class="std std-ref">ts3client_openCaptureDevice</span></a> and <a class="reference internal" href="#clientlib_8h_1a62a146d4a644dbf7dfdda6c4bcd6c63a"><span class="std std-ref">ts3client_openPlaybackDevice</span></a> on the connection. The reference association is reapplied automatically when AEC is toggled or the capture device is reactivated. Pass empty strings for modeID and renderDeviceID to clear an explicit reference and fall back to the default mode-match behaviour.</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>serverConnectionHandlerID</strong> – the connection handler whose AEC reference to set </p></li>
|
|||
|
|
<li><p><strong>modeID</strong> – utf8 encoded c-string of the backend mode that owns the reference device (e.g. “windowsaudiosession”, “pulseaudio”) </p></li>
|
|||
|
|
<li><p><strong>renderDeviceID</strong> – utf8 encoded c-string of the render device whose output should be used as AEC reference. Pass an empty string to use the connection’s currently-open playback device. </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. Returns ERROR_not_implemented on platforms whose backend cannot loopback-capture an arbitrary render device (currently macOS). </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c function">
|
|||
|
|
<dt class="sig sig-object c" id="c.ts3client_getCurrentPlaybackDeviceName">
|
|||
|
|
<span class="target" id="clientlib_8h_1af7369aa477b655ba3afc186c014c1f60"></span><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">ts3client_getCurrentPlaybackDeviceName</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">serverConnectionHandlerID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">isDefault</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>retrieve the device name that is currently used to play audio on a server </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>serverConnectionHandlerID</strong> – the connection handler to retrieve the active playback device on </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable receiving a c string of the device name currently in use. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></p></li>
|
|||
|
|
<li><p><strong>isDefault</strong> – address of a variable receiving whether the device in use is the default device. Pass NULL if you don’t need the information </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" id="c.ts3client_getCurrentPlayBackMode">
|
|||
|
|
<span class="target" id="clientlib_8h_1a8dd6e9582002fdca48e74f36048def62"></span><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">ts3client_getCurrentPlayBackMode</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">serverConnectionHandlerID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>retrieve the mode the current playback device on a server is using </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>serverConnectionHandlerID</strong> – the connection handler to retrieve the playback mode on </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable receiving a c string of the playback mode currently in use. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getCurrentCaptureDeviceName">
|
|||
|
|
<span class="target" id="clientlib_8h_1a53126ee36733024a2371f7f592933fce"></span><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">ts3client_getCurrentCaptureDeviceName</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">serverConnectionHandlerID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">isDefault</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>retrieve the device name that is currently used to capture audio on a server </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>serverConnectionHandlerID</strong> – the connection handler to retrieve the active capture device on </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable receiving a c string of the device name currently in use. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></p></li>
|
|||
|
|
<li><p><strong>isDefault</strong> – address of a variable receiving whether the device in use is the default device. Pass NULL if you don’t need the information </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" id="c.ts3client_getCurrentCaptureMode">
|
|||
|
|
<span class="target" id="clientlib_8h_1aa3a78d2795bb313ca2d3dfead7bf68e2"></span><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">ts3client_getCurrentCaptureMode</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">serverConnectionHandlerID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>retrieve the mode the current capture device on a server is using </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>serverConnectionHandlerID</strong> – the connection handler to retrieve the capture mode on </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable receiving a c string of the capture mode currently in use. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_initiateGracefulPlaybackShutdown">
|
|||
|
|
<span class="target" id="clientlib_8h_1af31abf44b6c6db339ef41351f31d8da2"></span><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">ts3client_initiateGracefulPlaybackShutdown</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">serverConnectionHandlerID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Close the playback device after all currently playing sounds are done playing. </p>
|
|||
|
|
<p>A more user friendly way of closing a playback device. The client lib will monitor and ensure that any sounds that have already started playing have completely played before closing the device. New sounds are not allowed to be played after calling this function. This function will return right away, regardless of whether the device has been closed already or not.</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>serverConnectionHandlerID</strong> – the connection handler on which to shut down the playback device </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" id="c.ts3client_closePlaybackDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1aee37dae1b01c6d849745bb1c35087dfa"></span><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">ts3client_closePlaybackDevice</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">serverConnectionHandlerID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Immediately close the current playback device on a connection handler. </p>
|
|||
|
|
<p>This will instantly shut down the device. Any sounds currently playing will be interrupted.</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>serverConnectionHandlerID</strong> – the connection handler on which to shut down the playback device </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" id="c.ts3client_closeCaptureDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1a25e6167263ee758386720110862f8b72"></span><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">ts3client_closeCaptureDevice</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">serverConnectionHandlerID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Immediately close the current capture device on a connection handler. </p>
|
|||
|
|
<p>This will instantly shut down the device.</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>serverConnectionHandlerID</strong> – the connection handler on which to shut down the capture device </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" id="c.ts3client_activateCaptureDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1a9ccd015e8aa5851a0613a81cf6f1ef2a"></span><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">ts3client_activateCaptureDevice</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">serverConnectionHandlerID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Activate a previously opened capture device on a server connection. </p>
|
|||
|
|
<p>Only one server connection can receive audio from its capture device at any given time. This function will set the server connection handler that is going to receive the audio from the capture device opened on that connection.</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>serverConnectionHandlerID</strong> – the connection handler on which to shut down the playback device </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" id="c.ts3client_playWaveFile">
|
|||
|
|
<span class="target" id="clientlib_8h_1ac01e282e0177d957e2a44af56bf3d88f"></span><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">ts3client_playWaveFile</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">path</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Play a local wave file on the playback device of the connection handler. </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>serverConnectionHandlerID</strong> – the connection handler on which to play the file. Effectively sets the playback device. </p></li>
|
|||
|
|
<li><p><strong>path</strong> – the full path of the wave file on the local file system </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" id="c.ts3client_playWaveFileHandle">
|
|||
|
|
<span class="target" id="clientlib_8h_1a96d9a7a84409b0ecf06851399029b4dc"></span><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">ts3client_playWaveFileHandle</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">path</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">loop</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">waveHandle</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Play a local wave file on the playback device of the connection handler. </p>
|
|||
|
|
<p>This is a more advanced version of ts3client_playWaveFile as it gives you a handle which can be used to stop, pause, resume or even loop the wave file.</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>serverConnectionHandlerID</strong> – the connection handler on which to play the file. Effectively sets the playback device. </p></li>
|
|||
|
|
<li><p><strong>path</strong> – the full path of the wave file on the local file system </p></li>
|
|||
|
|
<li><p><strong>loop</strong> – Boolean value defining whether or not to loop the wave file until the handle is paused or stopped </p></li>
|
|||
|
|
<li><p><strong>waveHandle</strong> – address of a variable to receive the handle. Use the handle to stop, pause or resume the wave playback. </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" id="c.ts3client_pauseWaveFileHandle">
|
|||
|
|
<span class="target" id="clientlib_8h_1aed62db4241f9246a60d37c5f55cf87b2"></span><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">ts3client_pauseWaveFileHandle</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">waveHandle</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">pause</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Pauses or resumes playback of a wave file handle retrieved by ts3client_playWaveFileHandle. </p>
|
|||
|
|
<p>Audio will be stopped at whatever location it is currently at and resumed from its paused location.</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>serverConnectionHandlerID</strong> – the connection handler on which the file is playing. </p></li>
|
|||
|
|
<li><p><strong>waveHandle</strong> – a wave handle on the specified connection handler as retrieved by ts3client_playWaveFileHandle </p></li>
|
|||
|
|
<li><p><strong>pause</strong> – Boolean value defining whether to pause or resume the waveHandle </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" id="c.ts3client_closeWaveFileHandle">
|
|||
|
|
<span class="target" id="clientlib_8h_1a088b31276f43a5fb1c2726c207287e00"></span><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">ts3client_closeWaveFileHandle</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">waveHandle</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Stops playback of, closes the wave file and invalidates the handle retrieved by ts3client_playWaveFileHandle. </p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1a96d9a7a84409b0ecf06851399029b4dc"><span class="std std-ref">ts3client_playWaveFileHandle</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler on which the file is playing. </p></li>
|
|||
|
|
<li><p><strong>waveHandle</strong> – a wave handle on the specified connection handler as retrieved by ts3client_playWaveFileHandle </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" id="c.ts3client_createAudioPlaybackHandle">
|
|||
|
|
<span class="target" id="clientlib_8h_1a8b6d62173289e74a6c8d70441aa3f0db"></span><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">ts3client_createAudioPlaybackHandle</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">scHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">handle</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_createAudioPlaybackHandle" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c function">
|
|||
|
|
<dt class="sig sig-object c" id="c.ts3client_pauseAudioPlaybackHandle">
|
|||
|
|
<span class="target" id="clientlib_8h_1a43b7a9cb8187c67a6af4a210db5be20c"></span><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">ts3client_pauseAudioPlaybackHandle</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">scHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">handle</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">pause</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_pauseAudioPlaybackHandle" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c function">
|
|||
|
|
<dt class="sig sig-object c" id="c.ts3client_closeAudioPlaybackHandle">
|
|||
|
|
<span class="target" id="clientlib_8h_1a5399219bbca652884ec441dec89d2d57"></span><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">ts3client_closeAudioPlaybackHandle</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">scHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">handle</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_closeAudioPlaybackHandle" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c function">
|
|||
|
|
<dt class="sig sig-object c" id="c.ts3client_enqueueAudioPlaybackHandle">
|
|||
|
|
<span class="target" id="clientlib_8h_1a1cdbaafd79c75e05aae798ab0a71b0d3"></span><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">ts3client_enqueueAudioPlaybackHandle</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">scHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">handle</span></span>, <span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">buffer_size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_enqueueAudioPlaybackHandle" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c function">
|
|||
|
|
<dt class="sig sig-object c" id="c.ts3client_registerCustomDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1a4dcc01743a5de17b4fd608c31022aeee"></span><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">ts3client_registerCustomDevice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">deviceID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">deviceDisplayName</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">capFrequency</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">capChannels</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">playFrequency</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">playChannels</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>create a new software device to be used for playback and/or capture. </p>
|
|||
|
|
<p>This allows you to create custom devices for implementing your own audio capture or playback. For capture devices you will need to regularly provide audio data via the <a class="reference internal" href="#clientlib_8h_1a35ce002bc468262d7324890b874a70a3"><span class="std std-ref">ts3client_processCustomCaptureData</span></a> function. For playback devices you will need to regularly aquire audio data via the <a class="reference internal" href="#clientlib_8h_1a45db2c1d27988dd0b740a6c76756f4e3"><span class="std std-ref">ts3client_acquireCustomPlaybackData</span></a> function.</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>deviceID</strong> – a unique string by which you will refer to this audio device when opening devices ore removing it. </p></li>
|
|||
|
|
<li><p><strong>deviceDisplayName</strong> – custom display string for your device. Not required to be unique, you can freely choose this. </p></li>
|
|||
|
|
<li><p><strong>capFrequency</strong> – The frequency of the capture device. Determines the frequency the audio you’re passing in to <a class="reference internal" href="#clientlib_8h_1a35ce002bc468262d7324890b874a70a3"><span class="std std-ref">ts3client_processCustomCaptureData</span></a> is expected to be in when using this device. </p></li>
|
|||
|
|
<li><p><strong>capChannels</strong> – The amount of channels the audio source on this device has. Determines the number of audio channels the data you’re passing to <a class="reference internal" href="#clientlib_8h_1a35ce002bc468262d7324890b874a70a3"><span class="std std-ref">ts3client_processCustomCaptureData</span></a> is expected to have when using this device. </p></li>
|
|||
|
|
<li><p><strong>playFrequency</strong> – Determines which frequency the audio you’re getting out of <a class="reference internal" href="#clientlib_8h_1a45db2c1d27988dd0b740a6c76756f4e3"><span class="std std-ref">ts3client_acquireCustomPlaybackData</span></a> has when using this device. </p></li>
|
|||
|
|
<li><p><strong>playChannels</strong> – Determines the number of audio channels of the audio you’re getting out of <a class="reference internal" href="#clientlib_8h_1a45db2c1d27988dd0b740a6c76756f4e3"><span class="std std-ref">ts3client_acquireCustomPlaybackData</span></a> has when using this device. </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" id="c.ts3client_unregisterCustomDevice">
|
|||
|
|
<span class="target" id="clientlib_8h_1ac06efa6d683ed8bb8f12c3fd84b41300"></span><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">ts3client_unregisterCustomDevice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">deviceID</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_unregisterCustomDevice" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Removes a custom audio device previously registered. </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>deviceID</strong> – the deviceID of the custom device to remove. Must be a deviceID previously passed to a <a class="reference internal" href="#clientlib_8h_1a4dcc01743a5de17b4fd608c31022aeee"><span class="std std-ref">ts3client_registerCustomDevice</span></a> call. </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" id="c.ts3client_processCustomCaptureData">
|
|||
|
|
<span class="target" id="clientlib_8h_1a35ce002bc468262d7324890b874a70a3"></span><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">ts3client_processCustomCaptureData</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">deviceName</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">short</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">samples</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Provide audio data for a registered custom device. </p>
|
|||
|
|
<p>When using custom devices, you’re expected to call this function regularly to provide your audio data to the client lib for processing and sending it to the server. The audio will be sent to the connection handler that currently has the specified custom device active (if any). The client lib will read captureChannels * samples * sizeof(short) bytes of data from the buffer.</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>deviceName</strong> – the deviceID for which you’re providing audio data. Must be a deviceID previously passed to a <a class="reference internal" href="#clientlib_8h_1a4dcc01743a5de17b4fd608c31022aeee"><span class="std std-ref">ts3client_registerCustomDevice</span></a> call. </p></li>
|
|||
|
|
<li><p><strong>buffer</strong> – pointer to the beginning of the raw audio data for the device. Caller must ensure that enough data is present in the buffer (samples * channel count of the audio device). </p></li>
|
|||
|
|
<li><p><strong>samples</strong> – the number of audio frames in the buffer </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" id="c.ts3client_acquireCustomPlaybackData">
|
|||
|
|
<span class="target" id="clientlib_8h_1a45db2c1d27988dd0b740a6c76756f4e3"></span><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">ts3client_acquireCustomPlaybackData</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">deviceName</span></span>, <span class="kt"><span class="pre">short</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">samples</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Retrieve playback data for the specified device from the client lib. </p>
|
|||
|
|
<p>When using custom playback devices you’re expected to call this function regularly.</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>deviceName</strong> – the deviceID from which to retrieve audio data. Must be a deviceID previously passed to a <a class="reference internal" href="#clientlib_8h_1a4dcc01743a5de17b4fd608c31022aeee"><span class="std std-ref">ts3client_registerCustomDevice</span></a> call. </p></li>
|
|||
|
|
<li><p><strong>buffer</strong> – address in which to write the sound data that is pending playback. Caller must allocate sufficient memory (samples * channels of the audio device). </p></li>
|
|||
|
|
<li><p><strong>samples</strong> – how many audio frames to retrieve. </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. May return ERROR_sound_no_data meaning no sound is currently played on the device. No data has been written to the buffer. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c function">
|
|||
|
|
<dt class="sig sig-object c" id="c.ts3client_setLocalTestMode">
|
|||
|
|
<span class="target" id="clientlib_8h_1ab427a987538d79e1d3cc3011da7f562a"></span><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">ts3client_setLocalTestMode</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">serverConnectionHandlerID</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">status</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Route captured audio directly to the playback device rather than through the network. </p>
|
|||
|
|
<p>Enable or disable local test mode. Enabling will no longer send audio data to the server, instead it will be routed directly to the playback device. This allows a user to receive direct feedback from their own audio transmission, allowing easier adjustments to audio settings.</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>serverConnectionHandlerID</strong> – the connection handler on which to enable or disable test mode. Determines the audio devices used. </p></li>
|
|||
|
|
<li><p><strong>status</strong> – Boolean value either enabling test mode or disabling it. </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" id="c.ts3client_startVoiceRecording">
|
|||
|
|
<span class="target" id="clientlib_8h_1a45792bbec9de981428546d79d3227a4f"></span><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">ts3client_startVoiceRecording</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">serverConnectionHandlerID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Flags the client as recording received audio transmissions. </p>
|
|||
|
|
<p>This does NOT cause any recording to take place, it merely informs other clients that this client is actually recording the conversation.</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>serverConnectionHandlerID</strong> – the connection handler on which to flag this client for recording. </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" id="c.ts3client_stopVoiceRecording">
|
|||
|
|
<span class="target" id="clientlib_8h_1a060347a25dc2fc4246965d7b3a93cc87"></span><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">ts3client_stopVoiceRecording</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">serverConnectionHandlerID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Flags the client as no longer recording audio transmissions. </p>
|
|||
|
|
<p>Unsets the flag set by ts3client_startVoiceRecording causing other clients to no longer mark this client as recording the conversation.</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>serverConnectionHandlerID</strong> – the connection handler on which to unset the recording flag for this client. </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" id="c.ts3client_allowWhispersFrom">
|
|||
|
|
<span class="target" id="clientlib_8h_1a681bc51ec1c7bbf31e3efb4b37f1a6af"></span><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">ts3client_allowWhispersFrom</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Allow another client to whisper us. </p>
|
|||
|
|
<p>Adds the specified other client on the server to whisper us. Prior to this call whispers from other clients are ignored and no audio data will be made available from whispers. Can be undone using <a class="reference internal" href="#clientlib_8h_1ad095a69c33ca536673246d76a0d71a61"><span class="std std-ref">ts3client_removeFromAllowedWhispersFrom</span></a></p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1aa84d9f65091a53aef532b8ee773e403c"><span class="std std-ref">ts3client_setWhisperReceiveWhitelist</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
<div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1ad095a69c33ca536673246d76a0d71a61"><span class="std std-ref">ts3client_removeFromAllowedWhispersFrom</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler for the server on which the client specified by clID is located. </p></li>
|
|||
|
|
<li><p><strong>clID</strong> – the client id of another client which we want to receive whispers from. </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" id="c.ts3client_removeFromAllowedWhispersFrom">
|
|||
|
|
<span class="target" id="clientlib_8h_1ad095a69c33ca536673246d76a0d71a61"></span><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">ts3client_removeFromAllowedWhispersFrom</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Removes a client from the allowed whisper list. </p>
|
|||
|
|
<p>Removes the specified other client on the server from the allowed whisperer list. After this call no more audio is made available when receiving whispers from the specified client. The opposite of <a class="reference internal" href="#clientlib_8h_1a681bc51ec1c7bbf31e3efb4b37f1a6af"><span class="std std-ref">ts3client_allowWhispersFrom</span></a></p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1aa84d9f65091a53aef532b8ee773e403c"><span class="std std-ref">ts3client_setWhisperReceiveWhitelist</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
<div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1a681bc51ec1c7bbf31e3efb4b37f1a6af"><span class="std std-ref">ts3client_allowWhispersFrom</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler for the server on which the client specified by clID is located. </p></li>
|
|||
|
|
<li><p><strong>clID</strong> – the client id of another client which we do not want to receive whispers from anymore. </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" id="c.ts3client_getWhisperReceiveWhitelist">
|
|||
|
|
<span class="target" id="clientlib_8h_1a252d8392b6b561b27063bdb8dfc45c64"></span><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">ts3client_getWhisperReceiveWhitelist</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_getWhisperReceiveWhitelist" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Retrieve the list of clients we allow to whisper us. </p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1aa84d9f65091a53aef532b8ee773e403c"><span class="std std-ref">ts3client_setWhisperReceiveWhitelist</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="simple">
|
|||
|
|
<dt><strong>Since</strong></dt><dd><p>3.0.9.0 </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler for which to retrieve the list of clients. </p></li>
|
|||
|
|
<li><p><strong>result</strong> – Address of an array of anyID which receives the list of clients we are allowing whispers from. Memory is allocated by the client lib and caller must free the array using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_isWhisperReceiveWhitelisted">
|
|||
|
|
<span class="target" id="clientlib_8h_1a78e824f9bdfb316603c363bacec6d6f8"></span><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">ts3client_isWhisperReceiveWhitelisted</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="kt"><span class="pre">int</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><a class="headerlink" href="#c.ts3client_isWhisperReceiveWhitelisted" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Check if we allow receiving whispers from a client. </p>
|
|||
|
|
<p><dl class="simple">
|
|||
|
|
<dt><strong>Since</strong></dt><dd><p>3.0.9.0 </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler for the server on which the client specified by clID is located. </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the client id of the client to check. </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the boolean status on whether or not we allow whisper from the specified client. </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" id="c.ts3client_setWhisperReceiveWhitelist">
|
|||
|
|
<span class="target" id="clientlib_8h_1aa84d9f65091a53aef532b8ee773e403c"></span><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">ts3client_setWhisperReceiveWhitelist</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">clientIDs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_setWhisperReceiveWhitelist" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Set the list of clients we allow to whisper us. </p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1a252d8392b6b561b27063bdb8dfc45c64"><span class="std std-ref">ts3client_getWhisperReceiveWhitelist</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
<div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1a681bc51ec1c7bbf31e3efb4b37f1a6af"><span class="std std-ref">ts3client_allowWhispersFrom</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="simple">
|
|||
|
|
<dt><strong>Since</strong></dt><dd><p>3.0.9.0 </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler on which to set the list of clients. </p></li>
|
|||
|
|
<li><p><strong>clientIDs</strong> – NULL terminated array of client ids that we want to allow receiving whispers from. </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" id="c.ts3client_systemset3DListenerAttributes">
|
|||
|
|
<span class="target" id="clientlib_8h_1a8a3db60f838442faf48232d7fbbe162b"></span><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">ts3client_systemset3DListenerAttributes</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="client/3dsound.html#c.TS3_VECTOR" title="TS3_VECTOR"><span class="n"><span class="pre">TS3_VECTOR</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">position</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="client/3dsound.html#c.TS3_VECTOR" title="TS3_VECTOR"><span class="n"><span class="pre">TS3_VECTOR</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">forward</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="client/3dsound.html#c.TS3_VECTOR" title="TS3_VECTOR"><span class="n"><span class="pre">TS3_VECTOR</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">up</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Set position, orientation and velocity of own client in 3D space. </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>serverConnectionHandlerID</strong> – the connection handler for which to set the specified 3D settings. </p></li>
|
|||
|
|
<li><p><strong>position</strong> – 3D position of own client, pass NULL to ignore. </p></li>
|
|||
|
|
<li><p><strong>forward</strong> – Forward orientation. Vector must be of unit length and perpendicular to the up vector. Pass NULL to ignore. </p></li>
|
|||
|
|
<li><p><strong>up</strong> – Upward orientation. Vector must be of unit length and perpendicular to the forward vector. Pass NULL to ignore. </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" id="c.ts3client_set3DWaveAttributes">
|
|||
|
|
<span class="target" id="clientlib_8h_1a9dfe22f57146f0c78fc15018a9f69978"></span><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">ts3client_set3DWaveAttributes</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">waveHandle</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="client/3dsound.html#c.TS3_VECTOR" title="TS3_VECTOR"><span class="n"><span class="pre">TS3_VECTOR</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">position</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Set the 3D position of a wave handle as retrieved by ts3client_playWaveFileHandle. </p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1a96d9a7a84409b0ecf06851399029b4dc"><span class="std std-ref">ts3client_playWaveFileHandle</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler of the wave handle </p></li>
|
|||
|
|
<li><p><strong>waveHandle</strong> – a valid wave Handle as retrieved by ts3client_openWaveFileHandle. Specifies the sound file for which to adjust the position </p></li>
|
|||
|
|
<li><p><strong>position</strong> – the position the wave file should be played from </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" id="c.ts3client_systemset3DSettings">
|
|||
|
|
<span class="target" id="clientlib_8h_1a450dee00eb6a3615b81230e410a23fee"></span><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">ts3client_systemset3DSettings</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">serverConnectionHandlerID</span></span>, <span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="n"><span class="pre">distanceFactor</span></span>, <span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="n"><span class="pre">rolloffScale</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Change 3D sound attenuation and distance settings. </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>serverConnectionHandlerID</strong> – the connection handler for which to adjust the settings. </p></li>
|
|||
|
|
<li><p><strong>distanceFactor</strong> – relative distance factor in meters. Default is 1.0. Use to adjust the distance between two TS3_VECTOR. Distance on x axis in meters = (a.x - b.x) * distanceFactor </p></li>
|
|||
|
|
<li><p><strong>rolloffScale</strong> – Defines how fast sound volume will attenuate with distance. A higher value will cause sound to be toned down faster with increasing distance. </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" id="c.ts3client_channelset3DAttributes">
|
|||
|
|
<span class="target" id="clientlib_8h_1a524d8474f26228d3f7b840496389ea97"></span><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">ts3client_channelset3DAttributes</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="client/3dsound.html#c.TS3_VECTOR" title="TS3_VECTOR"><span class="n"><span class="pre">TS3_VECTOR</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">position</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Adjusts other clients position in 3D space. </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>serverConnectionHandlerID</strong> – the connection handler for the server on which the client specified by clID is located. </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the client id of the other client we want to adjust the position of. </p></li>
|
|||
|
|
<li><p><strong>position</strong> – the desired position in 3D space of the other client </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" id="c.ts3client_getPreProcessorInfoValueFloat">
|
|||
|
|
<span class="target" id="clientlib_8h_1a40b3c881ba0bb700fb65cd96707f94b5"></span><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">ts3client_getPreProcessorInfoValueFloat</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ident</span></span>, <span class="kt"><span class="pre">float</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>Retrieve floating point preprocessor configuration values. </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>serverConnectionHandlerID</strong> – the connection handler for which to retrieve the value </p></li>
|
|||
|
|
<li><p><strong>ident</strong> – the name of the preprocessor value to retrieve </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the specified configuration value </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" id="c.ts3client_getPreProcessorConfigValue">
|
|||
|
|
<span class="target" id="clientlib_8h_1a344a87e895b1d9356c99a984563dcaac"></span><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">ts3client_getPreProcessorConfigValue</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ident</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>Retrieve preprocessor configuration values. </p>
|
|||
|
|
<p>Preprocessor settings are bound to a capture device. You must open a capture device on the specified connection handler before calling this function.</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>serverConnectionHandlerID</strong> – the connection handler for which to retrieve the configuration value </p></li>
|
|||
|
|
<li><p><strong>ident</strong> – the name of the preprocessor configuration to retrieve </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive a c string with the value of the specified preprocessor configuration. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_setPreProcessorConfigValue">
|
|||
|
|
<span class="target" id="clientlib_8h_1a462344b2cfa27c71698803e533bd3b20"></span><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">ts3client_setPreProcessorConfigValue</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ident</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Set preprocessor configuration values. </p>
|
|||
|
|
<p>Preprocessor settings are bound to a capture device. You must open a capture device on the specified connection handler before calling this function.</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>serverConnectionHandlerID</strong> – the connection handler for which to retrieve the configuration value </p></li>
|
|||
|
|
<li><p><strong>ident</strong> – the name of the preprocessor configuration to retrieve </p></li>
|
|||
|
|
<li><p><strong>value</strong> – the new value to set </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" id="c.ts3client_setKeyPressedDuringChunk">
|
|||
|
|
<span class="target" id="clientlib_8h_1a5ee7a0f197a16834d00bce34f776a85a"></span><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">ts3client_setKeyPressedDuringChunk</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_setKeyPressedDuringChunk" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Indicates to the client that a key press has occurred and that it should run the typing attenuation algoritm. </p>
|
|||
|
|
<p>This will hint to the client lib that the typing attenuation code should be applied to the currently processed chunk of audio data. Effectively sets a flag in the client lib to run the code for the currently processed chunk of audio data. The client will reset this flag after the current audio chunk has been completed.</p>
|
|||
|
|
<p><dl class="simple">
|
|||
|
|
<dt><strong>Since</strong></dt><dd><p>3.0.9.0 </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><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" id="c.ts3client_getGlobalConfigValueAsInt">
|
|||
|
|
<span class="target" id="clientlib_8h_1a6daa5d77073408ec425b1bab44c89e79"></span><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">ts3client_getGlobalConfigValueAsInt</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ident</span></span>, <span class="kt"><span class="pre">int</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><a class="headerlink" href="#c.ts3client_getGlobalConfigValueAsInt" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Gets global client configuration values. </p>
|
|||
|
|
<p>ident can have the following values: input_deactivation_delay_ms: Number of milliseconds to continue transmitting after PTT key was released. input_deactivation_delay_active: Whether the above described delay is active or not.</p>
|
|||
|
|
<p><dl class="simple">
|
|||
|
|
<dt><strong>Since</strong></dt><dd><p>3.0.9.0 </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</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>ident</strong> – the name of the global configuration option to retrieve </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the configuration value </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" id="c.ts3client_setGlobalConfigValue">
|
|||
|
|
<span class="target" id="clientlib_8h_1a74e4339b44381da3e2073e3c2c03724b"></span><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">ts3client_setGlobalConfigValue</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ident</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_setGlobalConfigValue" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Allows changing global client configuration values. </p>
|
|||
|
|
<p>ident can have the following values: input_deactivation_delay_ms: Number of milliseconds to continue transmitting after PTT key was released. input_deactivation_delay_active: Whether the above described delay is active or not.</p>
|
|||
|
|
<p><dl class="simple">
|
|||
|
|
<dt><strong>Since</strong></dt><dd><p>3.0.9.0 </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</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>ident</strong> – the name of the global configuration option to set </p></li>
|
|||
|
|
<li><p><strong>value</strong> – the new value for the configuration option </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" id="c.ts3client_getEncodeConfigValue">
|
|||
|
|
<span class="target" id="clientlib_8h_1af4c72386448cba846c651c5f17deda4e"></span><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">ts3client_getEncodeConfigValue</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ident</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>Retrieve voice encoder information. </p>
|
|||
|
|
<p>Encoder options are bound to a capture device. You must open a capture device on the specified connection handler prior to calling this function. bitrate will return the estimated bitrate of audio without any overhead. name will return the used codec name. quality will return the codec quality setting, a value between 0 and 10 inclusive.</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>serverConnectionHandlerID</strong> – the connection handler to query the encoder information for. </p></li>
|
|||
|
|
<li><p><strong>ident</strong> – the configuration value to query. Valid values are name, quality and bitrate </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive an utf8 encoded c string with the value of the option queried. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getPlaybackConfigValueAsFloat">
|
|||
|
|
<span class="target" id="clientlib_8h_1aeca0b2963a89235b87b9ae19d02a54e3"></span><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">ts3client_getPlaybackConfigValueAsFloat</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ident</span></span>, <span class="kt"><span class="pre">float</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>Retrieve floating point playback configuration settings. </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>serverConnectionHandlerID</strong> – the connection handler to query the playback setting for. </p></li>
|
|||
|
|
<li><p><strong>ident</strong> – the name of the configuration setting to retrieve. Valid values are volume_modifier and volume_factor_wave </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the current value of the queried setting </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" id="c.ts3client_setPlaybackConfigValue">
|
|||
|
|
<span class="target" id="clientlib_8h_1a2b8809d3a7ec9aed7fcf893faab2f5b5"></span><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">ts3client_setPlaybackConfigValue</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ident</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Set playback configuration settings. </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>serverConnectionHandlerID</strong> – the connection handler to set the playback setting on. </p></li>
|
|||
|
|
<li><p><strong>ident</strong> – the name of the configuration setting to set. Valid values are volume_modifier and volume_factor_wave </p></li>
|
|||
|
|
<li><p><strong>value</strong> – the new value to set as an utf8 encoded c string. Appropriate conversion takes place within the client lib. </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" id="c.ts3client_setClientVolumeModifier">
|
|||
|
|
<span class="target" id="clientlib_8h_1a02d9d655e7d0d52ea5bc743dc24497ce"></span><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">ts3client_setClientVolumeModifier</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Adjust playback volume of an individual client. </p>
|
|||
|
|
<p>Allows adjustment of single clients in addition to the global playback volume_modifier configuration option. Individual client volume adjustments are temporary and only valid as long as the client is visible. Once the target client leaves to an unsubscribed channel or disconnects from the server, this setting is discarded. If desired, the adjustment needs to be made again after the client reconnects or becomes visible again.</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>serverConnectionHandlerID</strong> – the connection handler for the server on which the client is located </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the id of the client to adjust the volume for. </p></li>
|
|||
|
|
<li><p><strong>value</strong> – the volume modifier to apply to the client. </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" id="c.ts3client_logMessage">
|
|||
|
|
<span class="target" id="clientlib_8h_1a485310a518bc03007c64774fa86047b5"></span><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">ts3client_logMessage</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">logMessage</span></span>, <span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="n"><span class="pre">LogLevel</span></span><span class="w"> </span><span class="n"><span class="pre">severity</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channel</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">logID</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Log a message to the client log. </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>logMessage</strong> – utf8 encoded c string of the message to log </p></li>
|
|||
|
|
<li><p><strong>severity</strong> – the seriousness of the message logged </p></li>
|
|||
|
|
<li><p><strong>channel</strong> – arbitrary utf8 encoded c string used to group messages. Pass empty string if unused. </p></li>
|
|||
|
|
<li><p><strong>logID</strong> – a connection handler on which to log the message. Pass 0 if unused. </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" id="c.ts3client_setLogVerbosity">
|
|||
|
|
<span class="target" id="clientlib_8h_1aba6d9ee77f38250356576ca32ae7c79f"></span><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">ts3client_setLogVerbosity</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="n"><span class="pre">LogLevel</span></span><span class="w"> </span><span class="n"><span class="pre">logVerbosity</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>When using custom logging define the severity of log messages above which to call the onUserLoggingMessageEvent for. </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>logVerbosity</strong> – the verbosity above which to call the logging callback for. </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" id="c.ts3client_getErrorMessage">
|
|||
|
|
<span class="target" id="clientlib_8h_1ac2eca4e1ef2b6b18d0c09fb8cea597b0"></span><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">ts3client_getErrorMessage</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">errorCode</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">error</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Retrieve human readable description for an error code. </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>errorCode</strong> – the error code from the <a class="reference internal" href="errors.html#public__errors_8h_1a0bcf1e0a5e32989890f6e85064327f7b"><span class="std std-ref">Ts3ErrorType</span></a> enum to retrieve the description for </p></li>
|
|||
|
|
<li><p><strong>error</strong> – address of a variable to receive a c string with the error description. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_startConnection">
|
|||
|
|
<span class="target" id="clientlib_8h_1adfbe2bbf01269057c6deb2b41f4ffe70"></span><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">ts3client_startConnection</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">identity</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ip</span></span>, <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="n"><span class="pre">port</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">nickname</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">defaultChannelArray</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">defaultChannelPassword</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">serverPassword</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>initiates a connection to a TeamSpeak server. </p>
|
|||
|
|
<p>When using a hostname instead of an IP address, this function will block until the client lib resolved the host name.</p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1af2cb8d2c19b5ea36fe2d4445cbd7488e"><span class="std std-ref">ts3client_startConnectionWithChannelID</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler to connect on, as created by ts3client_spawnNewServerConnectionHandler </p></li>
|
|||
|
|
<li><p><strong>identity</strong> – an identity string, as created by ts3client_createIdentity </p></li>
|
|||
|
|
<li><p><strong>ip</strong> – the server address to connect to. Can be a hostname or an IPv4 or IPv6 address </p></li>
|
|||
|
|
<li><p><strong>port</strong> – UDP port on which the TeamSpeak server is listening </p></li>
|
|||
|
|
<li><p><strong>nickname</strong> – a utf8 encoded c string used to display this client to other clients on the server. Not guaranteed to be the final name. </p></li>
|
|||
|
|
<li><p><strong>defaultChannelArray</strong> – An array describing the path to a channel to join after connect. Pass NULL when not used </p></li>
|
|||
|
|
<li><p><strong>defaultChannelPassword</strong> – The password for the channel in defaultChannelArray. Pass empty string if unused </p></li>
|
|||
|
|
<li><p><strong>serverPassword</strong> – server password. Pass empty string if the server does not have a password set </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" id="c.ts3client_startConnectionWithChannelID">
|
|||
|
|
<span class="target" id="clientlib_8h_1af2cb8d2c19b5ea36fe2d4445cbd7488e"></span><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">ts3client_startConnectionWithChannelID</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">identity</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ip</span></span>, <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="n"><span class="pre">port</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">nickname</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">defaultChannelId</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">defaultChannelPassword</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">serverPassword</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>initiates a connection to a TeamSpeak server. </p>
|
|||
|
|
<p>When using a hostname instead of an IP address, this function will block until the client lib resolved the host name.</p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1adfbe2bbf01269057c6deb2b41f4ffe70"><span class="std std-ref">ts3client_startConnection</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler to connect on, as created by ts3client_spawnNewServerConnectionHandler </p></li>
|
|||
|
|
<li><p><strong>identity</strong> – an identity string, as created by ts3client_createIdentity </p></li>
|
|||
|
|
<li><p><strong>ip</strong> – the server address to connect to. Can be a hostname or an IPv4 or IPv6 address </p></li>
|
|||
|
|
<li><p><strong>port</strong> – UDP port on which the TeamSpeak server is listening </p></li>
|
|||
|
|
<li><p><strong>nickname</strong> – a utf8 encoded c string used to display this client to other clients on the server. Not guaranteed to be the final name. </p></li>
|
|||
|
|
<li><p><strong>defaultChannelId</strong> – The channel id of the channel to join on connect. Pass 0 to join server default channel </p></li>
|
|||
|
|
<li><p><strong>defaultChannelPassword</strong> – The password for the channel in defaultChannelId. Pass empty string if unused </p></li>
|
|||
|
|
<li><p><strong>serverPassword</strong> – server password. Pass empty string if the server does not have a password set </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" id="c.ts3client_stopConnection">
|
|||
|
|
<span class="target" id="clientlib_8h_1ab657263bebdeb5f2b25f1086d256a817"></span><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">ts3client_stopConnection</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">quitMessage</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Disconnect from a TeamSpeak server. </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>serverConnectionHandlerID</strong> – the connection handler to disconnect on </p></li>
|
|||
|
|
<li><p><strong>quitMessage</strong> – an optional utf8 encoded message to display to other clients. Pass empty string if unused. </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" id="c.ts3client_requestClientMove">
|
|||
|
|
<span class="target" id="clientlib_8h_1a109cc857bb5e35cce2bb9247be610acc"></span><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">ts3client_requestClientMove</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">clientIDArray</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">password</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Attempt to move one or more clients to a different channel. </p>
|
|||
|
|
<p>The move is requested from the server. See the onServerErrorEvent callback to know whether the move was successful or not.</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>serverConnectionHandlerID</strong> – the connection handler of which the channel and client are located </p></li>
|
|||
|
|
<li><p><strong>clientIDArray</strong> – NULL terminated array of client ids to move </p></li>
|
|||
|
|
<li><p><strong>newChannelID</strong> – the target channel id to move the clients to </p></li>
|
|||
|
|
<li><p><strong>password</strong> – the password for the channel. Pass an empty string if the channel has no password. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestClientVariables">
|
|||
|
|
<span class="target" id="clientlib_8h_1ab53d33b3474b18c761b47d4f56c5614c"></span><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">ts3client_requestClientVariables</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Ask the server to provide additional request only variables for a client. </p>
|
|||
|
|
<p>You will receive an onUpdateClientEvent callback when the data is available to you.</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>serverConnectionHandlerID</strong> – the connection handler on which the client is located </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the client for which to receive the client variables </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestClientKickFromChannel">
|
|||
|
|
<span class="target" id="clientlib_8h_1a3bbd70f5d4f401cccb1b0b78d3057f26"></span><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">ts3client_requestClientKickFromChannel</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">clientIDArray</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">kickReason</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Request client(s) to be kicked from their current channel. </p>
|
|||
|
|
<p>Kicking a client is essentially a glorified move to the server default channel with a message displayed to everyone. You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which the client is located </p></li>
|
|||
|
|
<li><p><strong>clientIDArray</strong> – a NULL terminated array of client Ids to kick from their current channel. </p></li>
|
|||
|
|
<li><p><strong>kickReason</strong> – an explanatory message to display as the reason for everyone. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestClientKickFromServer">
|
|||
|
|
<span class="target" id="clientlib_8h_1a092069c07a33e9691c1051bdc090ddc4"></span><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">ts3client_requestClientKickFromServer</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">clientIDArray</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">kickReason</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Request client(s) to be kicked from the server. </p>
|
|||
|
|
<p>The clients will be disconnected and shown the reason. Reason is also displayed to everyone else on the server. You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which the client is located </p></li>
|
|||
|
|
<li><p><strong>clientIDArray</strong> – a NULL terminated array of client Ids to kick from their current channel. </p></li>
|
|||
|
|
<li><p><strong>kickReason</strong> – an explanatory message to display as the reason for everyone. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestChannelDelete">
|
|||
|
|
<span class="target" id="clientlib_8h_1a6f105807ab40453d889e7f5f92091070"></span><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">ts3client_requestChannelDelete</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">force</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Request a channel to be deleted. </p>
|
|||
|
|
<p>Whether or not this was successful can be determined through the associated onServerErrorEvent callback.</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>serverConnectionHandlerID</strong> – the connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel id to delete </p></li>
|
|||
|
|
<li><p><strong>force</strong> – boolean value on whether to kick clients out and delete any sub channels before deleting the channel. 1 = kick everyone, then delete sub channels and finally the requested channel; 0 = fail if there are clients in the channel or the channel has sub channels. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestChannelMove">
|
|||
|
|
<span class="target" id="clientlib_8h_1a3982214cfc670ce33e6fc6007fc59e9e"></span><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">ts3client_requestChannelMove</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelParentID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelOrder</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Move a channel in a tree or to a different parent channel. </p>
|
|||
|
|
<p>You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel id to move or change the parent of </p></li>
|
|||
|
|
<li><p><strong>newChannelParentID</strong> – the channel id of the channel to be the new parent channel </p></li>
|
|||
|
|
<li><p><strong>newChannelOrder</strong> – the channel id of the channel below which the channel is to be sorted </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestSendPrivateTextMsg">
|
|||
|
|
<span class="target" id="clientlib_8h_1a6b154f1e39da262d20eb76a4bf2fed28"></span><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">ts3client_requestSendPrivateTextMsg</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">message</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">targetClientID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Send a private chat message to a client. </p>
|
|||
|
|
<p>You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which to send the message </p></li>
|
|||
|
|
<li><p><strong>message</strong> – a utf8 encoded c string with the text to send </p></li>
|
|||
|
|
<li><p><strong>targetClientID</strong> – the client id of the client to send the message to </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestSendChannelTextMsg">
|
|||
|
|
<span class="target" id="clientlib_8h_1a6427ad0679c330c72a95de9de75a0bef"></span><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">ts3client_requestSendChannelTextMsg</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">message</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">targetChannelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Send a text message to your current channel. </p>
|
|||
|
|
<p>You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which to send the message </p></li>
|
|||
|
|
<li><p><strong>message</strong> – a utf8 encoded c string with the text to send </p></li>
|
|||
|
|
<li><p><strong>targetChannelID</strong> – the channel to send the message to. IGNORED. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestDeleteChannelTextMsg">
|
|||
|
|
<span class="target" id="clientlib_8h_1aa0553dc3d06617c0012ac22c1dfdf2ed"></span><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">ts3client_requestDeleteChannelTextMsg</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">roomAlias</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">messageIds</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">messageCount</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_requestDeleteChannelTextMsg" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Request to delete one or more messages from an attached matrix room. </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>serverConnectionHandlerID</strong> – the connection handler on which to delete the message </p></li>
|
|||
|
|
<li><p><strong>roomAlias</strong> – a utf8 encoded c string with the room alias of the channel to delete the message in </p></li>
|
|||
|
|
<li><p><strong>messageIds</strong> – an array of utf8 encoded c strings containing the message ids to delete. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestSendServerTextMsg">
|
|||
|
|
<span class="target" id="clientlib_8h_1a05cf602a7dae9cb4d51d6be9b406d006"></span><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">ts3client_requestSendServerTextMsg</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">message</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Send a text message to the server chat. </p>
|
|||
|
|
<p>You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which to send the message </p></li>
|
|||
|
|
<li><p><strong>message</strong> – a utf8 encoded c string with the text to send </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestChat">
|
|||
|
|
<span class="target" id="clientlib_8h_1a2d612e941f255e411f22896cf14da170"></span><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">ts3client_requestChat</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">type</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">targetClientID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_requestChat" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Request opening a new new-style chat room to the target user. </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>serverConnectionHandlerID</strong> – the connection handler on which to open the chat </p></li>
|
|||
|
|
<li><p><strong>type</strong> – Chat type, currently supported values. “private” </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestConnectionInfo">
|
|||
|
|
<span class="target" id="clientlib_8h_1a70dbf9fbdae6bb1c85da531a57a85273"></span><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">ts3client_requestConnectionInfo</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_requestConnectionInfo" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Request connection variables for a client (e.g. bandwidth usage, ping). </p>
|
|||
|
|
<p>You will receive a onConnectionInfoEvent callback once the information is available.</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>serverConnectionHandlerID</strong> – the connection handler on which the client resides </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – which client to request the connection information for </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestClientSetWhisperList">
|
|||
|
|
<span class="target" id="clientlib_8h_1a7807f45dcc513e6ad4b692234eac3106"></span><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">ts3client_requestClientSetWhisperList</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </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">targetChannelIDArray</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">targetClientIDArray</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Sets the client to which to transmit voice. Stops standard channel voice transmission. </p>
|
|||
|
|
<p>The client will still receive voice from their current channel, however their voice will not be transmitted to their current channel anymore. If this call is successful (check onServerErrorEvent) then voice of the specified client will be transmitted to all specified channels and all the specified clients. Pass 0 to both target parameter arrays to restore default behavior of transmitting voice to current channel. You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which to set the whisper list </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the client to set the whisper list for. Set to 0 or your own client ID to set your own whisper list. </p></li>
|
|||
|
|
<li><p><strong>targetChannelIDArray</strong> – a zero terminated array of channel ids to transmit voice to. </p></li>
|
|||
|
|
<li><p><strong>targetClientIDArray</strong> – a zero terminated array of client ids to transmit voice to. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestChannelSubscribe">
|
|||
|
|
<span class="target" id="clientlib_8h_1a4112ce5054bd24860eb7432bcbf93ef8"></span><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">ts3client_requestChannelSubscribe</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </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">channelIDArray</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Request live updates to specific channels, being able to see clients in the channel. </p>
|
|||
|
|
<p>If you intend to subscribe to all channels on the server, use ts3client_requestChannelSubscribeAll function instead. You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which to subscribe to the specified channels </p></li>
|
|||
|
|
<li><p><strong>channelIDArray</strong> – a zero terminated array of channel ids to subscribe to </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestChannelSubscribeAll">
|
|||
|
|
<span class="target" id="clientlib_8h_1a53c21e89801a0719e2679952cca3f92f"></span><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">ts3client_requestChannelSubscribeAll</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Request live updates from all channels, being able to see clients in the channels. </p>
|
|||
|
|
<p>If you only want to subscribe to a specific subset of channels, use ts3client_requestChannelSubscribe funtion instead. You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which to subscribe to all channels </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestChannelUnsubscribe">
|
|||
|
|
<span class="target" id="clientlib_8h_1a398f15065f712dc54270ce5079c1ab79"></span><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">ts3client_requestChannelUnsubscribe</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </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">channelIDArray</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Remove subscription from channels. No longer receiving updates to clients in the channels. </p>
|
|||
|
|
<p>You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which to unsubscribe from the specified channels </p></li>
|
|||
|
|
<li><p><strong>channelIDArray</strong> – a zero terminated array of channel ids to unsubscribe from </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestChannelUnsubscribeAll">
|
|||
|
|
<span class="target" id="clientlib_8h_1af65e419ba6524b37aa301ce740505fc3"></span><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">ts3client_requestChannelUnsubscribeAll</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Remove subscription from all channels. No longer receiving updates to clients outside of own channel. </p>
|
|||
|
|
<p>The current channel will always be subscribed and you will always receive updates about clients in the current channel. You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which to unsubscribe from all channels </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestChannelDescription">
|
|||
|
|
<span class="target" id="clientlib_8h_1a806652361900fb894016df2c14bddc6d"></span><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">ts3client_requestChannelDescription</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_requestChannelDescription" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>retrieve the channel description of the specified channel. </p>
|
|||
|
|
<p>After calling this function you will receive an onUpdateChannelEvent callback at which point the description is available to be queried using ts3client_getChannelVariableAsString. You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the id of the channel to retrieve the description for </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestMuteClients">
|
|||
|
|
<span class="target" id="clientlib_8h_1ade0273ae2c32822ad5e7758cef59a52c"></span><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">ts3client_requestMuteClients</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">clientIDArray</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Mute clients locally, the server will not be sending audio data for the specified clients anymore. </p>
|
|||
|
|
<p>You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1a8adff3f1fd6023a850aeb9dd84bdbe18"><span class="std std-ref">ts3client_requestUnmuteClients</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler on which to mute the clients </p></li>
|
|||
|
|
<li><p><strong>clientIDArray</strong> – a zero terminated array of client ids to mute </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestUnmuteClients">
|
|||
|
|
<span class="target" id="clientlib_8h_1a8adff3f1fd6023a850aeb9dd84bdbe18"></span><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">ts3client_requestUnmuteClients</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">clientIDArray</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Unmute clients locally. Server will start sending audio packets for the specified clients again. </p>
|
|||
|
|
<p>You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1ade0273ae2c32822ad5e7758cef59a52c"><span class="std std-ref">ts3client_requestMuteClients</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</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>serverConnectionHandlerID</strong> – the connection handler on which to unmute the clients </p></li>
|
|||
|
|
<li><p><strong>clientIDArray</strong> – a zero terminated array of client ids to unmute </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestClientIDs">
|
|||
|
|
<span class="target" id="clientlib_8h_1ada9d3d15c10761730e08ac6d8e5c14ed"></span><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">ts3client_requestClientIDs</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">clientUniqueIdentifier</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_requestClientIDs" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>retrieve the current client ids of all clients connected using the specified unique identifier </p>
|
|||
|
|
<p>You will receive a onClientIDsEvent callback for every client connected with the identity specified by the clientUniqueIdentifier. Once all client ids for the specified identity have been indicated, you will receive a onClientIDsFinishedEvent callback. You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – the connection handler on which to retrieve the client ids for </p></li>
|
|||
|
|
<li><p><strong>clientUniqueIdentifier</strong> – a c string with a unique identifier to retreive the client ids for. This is the public part of the identity </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_getClientID">
|
|||
|
|
<span class="target" id="clientlib_8h_1af1569d127b35981dbcbe5cde99e13ae0"></span><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">ts3client_getClientID</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</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 your own client id on a server </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>serverConnectionHandlerID</strong> – the connection handler on which to retrieve your own client id </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive your client id on success </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" id="c.ts3client_getConnectionStatus">
|
|||
|
|
<span class="target" id="clientlib_8h_1a5ce146788e0d253d26e3be882ee71865"></span><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">ts3client_getConnectionStatus</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">serverConnectionHandlerID</span></span>, <span class="kt"><span class="pre">int</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><a class="headerlink" href="#c.ts3client_getConnectionStatus" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>check the current status of the connection </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>serverConnectionHandlerID</strong> – the connection handler for which to receive the connection status </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the current connect status. One of the values from the ConnectStatus enum </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" id="c.ts3client_getConnectionVariableAsUInt64">
|
|||
|
|
<span class="target" id="clientlib_8h_1aaee1be13c232266f90960dbec42266df"></span><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">ts3client_getConnectionVariableAsUInt64</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="n"><span class="pre">size_t</span></span><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><a class="headerlink" href="#c.ts3client_getConnectionVariableAsUInt64" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Get value for connection based variable of a client as unsigned 64 bit integer. </p>
|
|||
|
|
<p>Not all variables are available as unsigned 64 bit integer. Some are only available as string or 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>serverConnectionHandlerID</strong> – the connection handler on which to get the value </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the client for which to retrieve the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which value to receive. One of the values from the ConnectionProperties enum </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the variable on success. </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" id="c.ts3client_getConnectionVariableAsDouble">
|
|||
|
|
<span class="target" id="clientlib_8h_1ae11bf5df23439b828d4d2d1f92e05223"></span><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">ts3client_getConnectionVariableAsDouble</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="n"><span class="pre">size_t</span></span><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><a class="headerlink" href="#c.ts3client_getConnectionVariableAsDouble" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Get value for connection based variable of a client as double. </p>
|
|||
|
|
<p>Not all variables are available as double. Some are only available as string or unsigned 64 bit integers.</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>serverConnectionHandlerID</strong> – the connection handler on which to get the value </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the client for which to retrieve the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which value to receive. One of the values from the ConnectionProperties enum </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the variable on success. </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" id="c.ts3client_getConnectionVariableAsString">
|
|||
|
|
<span class="target" id="clientlib_8h_1a89515bce1a13f6fbaa0e3309a0616c41"></span><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">ts3client_getConnectionVariableAsString</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_getConnectionVariableAsString" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Get value for connection based variable of a client as string. </p>
|
|||
|
|
<p>Not all variables are available as string. Some are only available as unsigned 64 bit integer or 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>serverConnectionHandlerID</strong> – the connection handler on which to get the value </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the client for which to retrieve the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which value to receive. One of the values from the ConnectionProperties enum </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the variable on success. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_cleanUpConnectionInfo">
|
|||
|
|
<span class="target" id="clientlib_8h_1a178458b56bccdb8943de2e818ae1fd82"></span><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">ts3client_cleanUpConnectionInfo</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_cleanUpConnectionInfo" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>TODO. </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>serverConnectionHandlerID</strong> – connection handler to clean up on </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the client to clean up </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" id="c.ts3client_requestServerConnectionInfo">
|
|||
|
|
<span class="target" id="clientlib_8h_1a20a6cc2a8dba1a0faf5f031a27ad4102"></span><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">ts3client_requestServerConnectionInfo</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_requestServerConnectionInfo" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Make server connection variables available for retrieval. </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>serverConnectionHandlerID</strong> – the connection handler for which to make connection variables available </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_getServerConnectionVariableAsUInt64">
|
|||
|
|
<span class="target" id="clientlib_8h_1a2d5914cfd04a244fa1cdfbb8524dce33"></span><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">ts3client_getServerConnectionVariableAsUInt64</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">size_t</span></span><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><a class="headerlink" href="#c.ts3client_getServerConnectionVariableAsUInt64" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Retrieve value of a server connection variable as unsigned 64 bit integer. </p>
|
|||
|
|
<p>Not all variables are available as unsigned 64 bit integer. Some are only available float.</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>serverConnectionHandlerID</strong> – the connection handler on which to retrieve the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which variable to receive. One of the values from the ConnectionProperties enum </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the value on success. </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" id="c.ts3client_getServerConnectionVariableAsFloat">
|
|||
|
|
<span class="target" id="clientlib_8h_1af4adb2a7d162e3abff67a0f5f2fd49e9"></span><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">ts3client_getServerConnectionVariableAsFloat</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">float</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><a class="headerlink" href="#c.ts3client_getServerConnectionVariableAsFloat" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Retrieve value of a server connection variable as float. </p>
|
|||
|
|
<p>Not all variables are available as float. Some are only available as unsigned 64 bit 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>serverConnectionHandlerID</strong> – the connection handler on which to retrieve the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which variable to receive. One of the values from the ConnectionProperties enum </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the value on success. </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" id="c.ts3client_getClientSelfVariableAsInt">
|
|||
|
|
<span class="target" id="clientlib_8h_1afe6761c115938485b904d8d28baebec4"></span><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">ts3client_getClientSelfVariableAsInt</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">int</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>Retrieve value of a variable of your own client as an integer. </p>
|
|||
|
|
<p>Not all variables are available as integer. Some are only available as string. NOTE: Not all variables are available using this function, some are only available using ts3client_getClientVariableAsInt</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>serverConnectionHandlerID</strong> – connection handler on which to retrieve information </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which variable to receive. One of the values from the ClientProperties enum </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the value on success </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" id="c.ts3client_getClientSelfVariableAsString">
|
|||
|
|
<span class="target" id="clientlib_8h_1aee7323348b4103785cfa86f7219e21f2"></span><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">ts3client_getClientSelfVariableAsString</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>Retrieve value of a variable of your own client as string. </p>
|
|||
|
|
<p>Not all variables are available as integer. Some are only available as integer. NOTE: Not all variables are available using this function, some are only available using ts3client_getClientVariableAsString</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>serverConnectionHandlerID</strong> – connection handler on which to retrieve information </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which variable to receive. One of the values from the ClientProperties or ClientPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the value on success. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_setClientSelfVariableAsInt">
|
|||
|
|
<span class="target" id="clientlib_8h_1ae74d626a2ab941d5908c42adda8617ba"></span><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">ts3client_setClientSelfVariableAsInt</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Change the value of an integer variable on your own client. </p>
|
|||
|
|
<p>After having changed all variables desired, call ts3client_flushClientSelfUpdates to publish the changes to the server Not all variables can be changed, many are read only.</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>serverConnectionHandlerID</strong> – the connection handler on which to set the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which variable to change. One of the values from the ClientProperties or ClientPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>value</strong> – the new value to set </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" id="c.ts3client_setClientSelfVariableAsString">
|
|||
|
|
<span class="target" id="clientlib_8h_1a414b3cd49dd610a6a06983f1aadd43f8"></span><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">ts3client_setClientSelfVariableAsString</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Change the value of a string variable on your own client. </p>
|
|||
|
|
<p>After having changed all variables desired, call ts3client_flushClientSelfUpdates to publish the changes to the server Not all variables can be changed, many are read only.</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>serverConnectionHandlerID</strong> – the connection handler on which to set the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which variable to change. One of the values from the ClientProperties or ClientPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>value</strong> – the new value to set </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" id="c.ts3client_flushClientSelfUpdates">
|
|||
|
|
<span class="target" id="clientlib_8h_1a0b1df0ce1258156fd25275f86d3fc79d"></span><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">ts3client_flushClientSelfUpdates</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Send changes to the local client to the server. </p>
|
|||
|
|
<p>Publish changes previously set using <a class="reference internal" href="#clientlib_8h_1ae74d626a2ab941d5908c42adda8617ba"><span class="std std-ref">ts3client_setClientSelfVariableAsInt</span></a> and <a class="reference internal" href="#clientlib_8h_1a414b3cd49dd610a6a06983f1aadd43f8"><span class="std std-ref">ts3client_setClientSelfVariableAsString</span></a> on the connection handler.</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>serverConnectionHandlerID</strong> – connection handler on which to publish changes </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_getClientVariableAsInt">
|
|||
|
|
<span class="target" id="clientlib_8h_1a4aeabaee56cb7b95a02de861747c5dd1"></span><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">ts3client_getClientVariableAsInt</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">int</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>Retrieve the value of a variable from a client as integer. </p>
|
|||
|
|
<p>Not all variables are available as integer. Some are only available as string or unsigned 64bit 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>serverConnectionHandlerID</strong> – connection handler on which the client is located </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – for which client to retrieve the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which variable to receive. One of the values from the ClientProperties or ClientPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the value on success </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" id="c.ts3client_getClientVariableAsUInt64">
|
|||
|
|
<span class="target" id="clientlib_8h_1a2d57c95da046fd9a5d212cdef8fcfcaf"></span><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">ts3client_getClientVariableAsUInt64</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="n"><span class="pre">size_t</span></span><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>Retrieve the value of a variable from a client as unsigned 64bit integer. </p>
|
|||
|
|
<p>Not all variables are available as integer. Some are only available as string or 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>serverConnectionHandlerID</strong> – connection handler on which the client is located </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – for which client to retrieve the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which variable to receive. One of the values from the ClientProperties or ClientPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the value on success </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" id="c.ts3client_getClientVariableAsString">
|
|||
|
|
<span class="target" id="clientlib_8h_1a6ebd2bc5ae4eabf1a7fd2024736d25e7"></span><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">ts3client_getClientVariableAsString</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>Retrieve the value of a variable from a client as string. </p>
|
|||
|
|
<p>Not all variables are available as integer. Some are only available as integer or unsigned 64bit 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>serverConnectionHandlerID</strong> – connection handler on which the client is located </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – for which client to retrieve the value </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which variable to receive. One of the values from the ClientProperties or ClientPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the value on success. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getClientList">
|
|||
|
|
<span class="target" id="clientlib_8h_1afed00f68ac5c3e17d04d0632ce11440d"></span><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">ts3client_getClientList</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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 a list of all clients in subscribed channels on the server. </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>serverConnectionHandlerID</strong> – connection handler on which to retrieve the client list </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive a null terminated array of client ids like {10, 30, …, 0} Memory is allocated by the client lib and caller must free the array using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getChannelOfClient">
|
|||
|
|
<span class="target" id="clientlib_8h_1a68b44141f497000353c54b657a3c72a7"></span><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">ts3client_getChannelOfClient</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</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 id of the current channel the specified client is in. </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>serverConnectionHandlerID</strong> – connection handler on which the client is located </p></li>
|
|||
|
|
<li><p><strong>clientID</strong> – the client to receive the current channel for </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the channel id of the specified client </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" id="c.ts3client_getChannelVariableAsInt">
|
|||
|
|
<span class="target" id="clientlib_8h_1a49d61fa9468bbf64b192ea3234a3e62b"></span><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">ts3client_getChannelVariableAsInt</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">int</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>Retrieve the value of a channel property as integer. </p>
|
|||
|
|
<p>Not all properties are available as integer. Some are only available as string or unsigned 64 bit 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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel of which to retrieve the property </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which property to retrieve. One of the values from the ChannelProperties or ChannelPropertiesRare enum </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the result on success </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" id="c.ts3client_getChannelVariableAsUInt64">
|
|||
|
|
<span class="target" id="clientlib_8h_1a83316b81bae8fe47fd45ad71f00b61c9"></span><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">ts3client_getChannelVariableAsUInt64</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="n"><span class="pre">size_t</span></span><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>Retrieve the value of a channel property as unsigned 64 bit integer. </p>
|
|||
|
|
<p>Not all properties are available as string. Some are only available as integer or string.</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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel of which to retrieve the property </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which property to retrieve. One of the values from the ChannelProperties or ChannelPropertiesRare enum </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the result on success </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" id="c.ts3client_getChannelVariableAsString">
|
|||
|
|
<span class="target" id="clientlib_8h_1ad17ec9e1cb9b9a848fdd46ae1a0bc5c1"></span><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">ts3client_getChannelVariableAsString</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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>Retrieve the value of a channel property as string. </p>
|
|||
|
|
<p>Not all properties are available as string. Some are only available as integer or unsigned 64 bit 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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel of which to retrieve the property </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which property to retrieve. One of the values from the ChannelProperties or ChannelPropertiesRare enum </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the result on success. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getChannelIDFromChannelNames">
|
|||
|
|
<span class="target" id="clientlib_8h_1a9f6c718b67049637297e512961d7d9ad"></span><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">ts3client_getChannelIDFromChannelNames</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">serverConnectionHandlerID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelNameArray</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 the channel id for the given channel path. </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>serverConnectionHandlerID</strong> – connection handler on which to find the channel </p></li>
|
|||
|
|
<li><p><strong>channelNameArray</strong> – zero terminated array of c strings describing the channel path. Like {“Main channel”, “sub channel”, null} </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the channel id on success </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" id="c.ts3client_setChannelVariableAsInt">
|
|||
|
|
<span class="target" id="clientlib_8h_1a9ac69253da16b12c09d7358d0e290bcd"></span><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">ts3client_setChannelVariableAsInt</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>set a new value for an integer channel property </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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – id of the channel to set the property for </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which property to set. One of the values from the ChannelProperties or ChannelPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>value</strong> – the new value to set </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" id="c.ts3client_setChannelVariableAsUInt64">
|
|||
|
|
<span class="target" id="clientlib_8h_1a789495d2647efa45cf9e90e9c70a2022"></span><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">ts3client_setChannelVariableAsUInt64</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="n"><span class="pre">size_t</span></span><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="n"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>set a new value for an unsigned 64 bit channel property </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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – id of the channel to set the property for </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which property to set. One of the values from the ChannelProperties or ChannelPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>value</strong> – the new value to set </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" id="c.ts3client_setChannelVariableAsString">
|
|||
|
|
<span class="target" id="clientlib_8h_1a382634656b0d759a6857faf3b15c57a7"></span><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">ts3client_setChannelVariableAsString</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>set a new value for a string channel property </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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – id of the channel to set the property for </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which property to set. One of the values from the ChannelProperties or ChannelPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>value</strong> – the new value to set </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" id="c.ts3client_flushChannelUpdates">
|
|||
|
|
<span class="target" id="clientlib_8h_1a0129b5b9b242d360b2fff9e26556ad22"></span><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">ts3client_flushChannelUpdates</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Inform server of changes to channel properties. </p>
|
|||
|
|
<p>After all desired changes have been done using <a class="reference internal" href="#clientlib_8h_1a9ac69253da16b12c09d7358d0e290bcd"><span class="std std-ref">ts3client_setChannelVariableAsInt</span></a>, <a class="reference internal" href="#clientlib_8h_1a789495d2647efa45cf9e90e9c70a2022"><span class="std std-ref">ts3client_setChannelVariableAsUInt64</span></a> or <a class="reference internal" href="#clientlib_8h_1a382634656b0d759a6857faf3b15c57a7"><span class="std std-ref">ts3client_setChannelVariableAsString</span></a> call this function to send the changes to the server and publish them to other clients. Prior to calling this function the channel property changes will not have any effect.</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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – id of the channel to publish updates for </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_flushChannelCreation">
|
|||
|
|
<span class="target" id="clientlib_8h_1ad72e4b93b7537a89858f2991d6f83cbd"></span><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">ts3client_flushChannelCreation</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelParentID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Create the channel on the server. </p>
|
|||
|
|
<p>After setting all the desired properties on the channel, call this function to actually create the channel on the server</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>serverConnectionHandlerID</strong> – connection handler on which to create the channel </p></li>
|
|||
|
|
<li><p><strong>channelParentID</strong> – id of the channel this channel should be a sub channel of. Pass 0 to create a root channel. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_getChannelList">
|
|||
|
|
<span class="target" id="clientlib_8h_1abf6057dacf15f4915bbec72b0609d93b"></span><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">ts3client_getChannelList</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">serverConnectionHandlerID</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="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 a list of all channels currently on the server. </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>serverConnectionHandlerID</strong> – connection handler on which to retrieve the channels </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive a zero terminated array of channel ids, like {1, 4023, 49, 8534, …, 0} Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getChannelClientList">
|
|||
|
|
<span class="target" id="clientlib_8h_1a2b32da0c35ef0870a6f9dec71a9fbcee"></span><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">ts3client_getChannelClientList</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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 a list of all clients in the specified channel. </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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel of which to retrieve the current clients </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive a zero terminated array of client ids, like {2, 50, 4, …, 0} Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getParentChannelOfChannel">
|
|||
|
|
<span class="target" id="clientlib_8h_1a917586dfc49af5c87b6d6707af75ad1a"></span><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">ts3client_getParentChannelOfChannel</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</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 the id of the parent channel of the specified channel. </p>
|
|||
|
|
<p>If the channel specified by channelID is a root channel, the result will be 0.</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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – id of the channel to retrieve the parent of </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the parent channel id. </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" id="c.ts3client_getChannelEmptySecs">
|
|||
|
|
<span class="target" id="clientlib_8h_1a5e7f69b8e0194751bc5b1767aeb51862"></span><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">ts3client_getChannelEmptySecs</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="kt"><span class="pre">int</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 time in seconds since last client left the specified channel </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>serverConnectionHandlerID</strong> – connection handler on which the channel is located </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – id of the channel to get the </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the result on success </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" id="c.ts3client_getServerConnectionHandlerList">
|
|||
|
|
<span class="target" id="clientlib_8h_1a7352d99bd5ab72d9419b6a29a66f7096"></span><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">ts3client_getServerConnectionHandlerList</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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 a list of all connection handlers </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>result</strong> – address of a variable to receive a zero terminated array of connection handlers, like {1, 5, …, 0} Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getServerVariableAsInt">
|
|||
|
|
<span class="target" id="clientlib_8h_1a7420850064771a301e8dba953c1a3250"></span><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">ts3client_getServerVariableAsInt</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">int</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 the value of an integer server property. </p>
|
|||
|
|
<p>Not all properties are available as integer. Some are only available as string or unsigned 64 bit 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>serverConnectionHandlerID</strong> – specifies the server on which to retrieve the property </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which property to retrieve. One of the values from the VirtualServerProperties or VirtualServerPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the property value on success. </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" id="c.ts3client_getServerVariableAsUInt64">
|
|||
|
|
<span class="target" id="clientlib_8h_1aeac5be66807c57199e4559e0471b22ad"></span><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">ts3client_getServerVariableAsUInt64</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">size_t</span></span><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 the value of an unsigned 64 bit integer server property. </p>
|
|||
|
|
<p>Not all properties are available as unsigned 64 bit integer. Some are only available as string or 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>serverConnectionHandlerID</strong> – specifies the server on which to retrieve the property </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which property to retrieve. One of the values from the VirtualServerProperties or VirtualServerPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the property value on success. </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" id="c.ts3client_getServerVariableAsString">
|
|||
|
|
<span class="target" id="clientlib_8h_1a3001af81cebd8ac0256bdc89e5a7272f"></span><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">ts3client_getServerVariableAsString</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">flag</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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 the value of a string server property. </p>
|
|||
|
|
<p>Not all properties are available as string. Some are only available as integer or unsigned 64 bit 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>serverConnectionHandlerID</strong> – specifies the server on which to retrieve the property </p></li>
|
|||
|
|
<li><p><strong>flag</strong> – specifies which property to retrieve. One of the values from the VirtualServerProperties or VirtualServerPropertiesRare enums </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the property value on success. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_requestServerVariables">
|
|||
|
|
<span class="target" id="clientlib_8h_1a1bcd5739aac4310b5f50c602f2f01fa8"></span><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">ts3client_requestServerVariables</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">serverConnectionHandlerID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Make request only server variables available locally. </p>
|
|||
|
|
<p>You will receive an onServerUpdateEvent once the request only properties are available. Prior to the callback being called the variables are not available, and querying them will yield undefined results.</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>serverConnectionHandlerID</strong> – connection handler on which to request the variables </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_getTransferFileName">
|
|||
|
|
<span class="target" id="clientlib_8h_1af67a00dd893310925e1c244dd18e1719"></span><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">ts3client_getTransferFileName</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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 the local file name for a file transfer </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>transferID</strong> – identifies the file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive an utf8 encoded c string on success. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getTransferFilePath">
|
|||
|
|
<span class="target" id="clientlib_8h_1a79efbe6aaf7cc2405b7eb679f4e18567"></span><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">ts3client_getTransferFilePath</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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 the local path of a file transfer </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>transferID</strong> – identifies the file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive an utf8 encoded c string on success. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getTransferFileRemotePath">
|
|||
|
|
<span class="target" id="clientlib_8h_1aebc1d92f22cc42ec1fca0e07f56a02c8"></span><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">ts3client_getTransferFileRemotePath</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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 the server path of the file transfer </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>transferID</strong> – identifies which file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive an utf8 encoded c string on success. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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" id="c.ts3client_getTransferFileSize">
|
|||
|
|
<span class="target" id="clientlib_8h_1a1bd86d14f15f0927fdc5bd02014350b7"></span><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">ts3client_getTransferFileSize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</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 the total size in bytes of a file transfer. </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>transferID</strong> – specifies which file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the file size </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" id="c.ts3client_getTransferFileSizeDone">
|
|||
|
|
<span class="target" id="clientlib_8h_1a2bfcb1f38fe2ec03e2763e76f00e2e40"></span><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">ts3client_getTransferFileSizeDone</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</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 the amount of bytes already transferred. </p>
|
|||
|
|
<p>0 <= result <= ts3client_getTransferFileSize for the same transferID.</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>transferID</strong> – specifies the file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the result on success </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" id="c.ts3client_isTransferSender">
|
|||
|
|
<span class="target" id="clientlib_8h_1aa4b43c043ff601ee174079cc1287cb4a"></span><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">ts3client_isTransferSender</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span>, <span class="kt"><span class="pre">int</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>determine if the file transfer is an upload or download </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>transferID</strong> – specifies the file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the result on success. 1 = upload, 0 = download </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" id="c.ts3client_getTransferStatus">
|
|||
|
|
<span class="target" id="clientlib_8h_1a9e3c19eabcbd69c287a06bf6c4f3b76a"></span><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">ts3client_getTransferStatus</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span>, <span class="kt"><span class="pre">int</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>determine the current status of the transfer in question </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>transferID</strong> – specifies the file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the status on success. One of the values from the FileTransferState enum. </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" id="c.ts3client_getCurrentTransferSpeed">
|
|||
|
|
<span class="target" id="clientlib_8h_1a78f9ba0b3a43c9879fc117b024a45256"></span><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">ts3client_getCurrentTransferSpeed</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span>, <span class="kt"><span class="pre">float</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 the current approximate speed (in bytes/sec) of a file transfer </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>transferID</strong> – specifies the file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the transfer speed in bytes per second, averaged across the past 5 seconds. </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" id="c.ts3client_getAverageTransferSpeed">
|
|||
|
|
<span class="target" id="clientlib_8h_1ab7083ffd0d0739b6cd11108e6a00df67"></span><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">ts3client_getAverageTransferSpeed</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span>, <span class="kt"><span class="pre">float</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 the average transfer speed (in bytes/sec) of a file transfer since it started </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>transferID</strong> – specifies the file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the approximate speed in bytes per second, averaged across its lifetime. </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" id="c.ts3client_getTransferRunTime">
|
|||
|
|
<span class="target" id="clientlib_8h_1a61d4d03a5dfe713048c7652ee57b28df"></span><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">ts3client_getTransferRunTime</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</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 the time (in seconds) a file transfer has been active </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>transferID</strong> – specifies the file transfer to query </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the time in seconds the transfer was active. </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" id="c.ts3client_sendFile">
|
|||
|
|
<span class="target" id="clientlib_8h_1aa1a520555357d4d5898e9c2d940a1780"></span><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">ts3client_sendFile</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">file</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">overwrite</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">resume</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">sourceDirectory</span></span>, <span class="n"><span class="pre">anyID</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="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Initiate a file upload to the server. </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>serverConnectionHandlerID</strong> – connection handler to which to upload a file </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – channel to which to upload the file </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – password of the channel specified in channelID. Pass an empty string if the channel does not have a password. </p></li>
|
|||
|
|
<li><p><strong>file</strong> – the name of file to upload on the local file system. </p></li>
|
|||
|
|
<li><p><strong>overwrite</strong> – boolean flag, whether to overwrite the file on the server. If 0 the transfer will fail if the file already exists on the server. </p></li>
|
|||
|
|
<li><p><strong>resume</strong> – boolean flag, set to 1 to resume a previously aborted or halted transfer. If 1 will append to the file on the server. </p></li>
|
|||
|
|
<li><p><strong>sourceDirectory</strong> – the absolute path in which the file resides on the local file system. </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable in which to store the transferID on success. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestFile">
|
|||
|
|
<span class="target" id="clientlib_8h_1a265fe02dadcd06d4002142d7cbbd3c2d"></span><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">ts3client_requestFile</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">file</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">overwrite</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">resume</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">destinationDirectory</span></span>, <span class="n"><span class="pre">anyID</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="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Initiate a file download from the server. </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>serverConnectionHandlerID</strong> – connection handler from which to download the file </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – channel in which the file to download is located </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – password of the channel specified in channelID. Pass an empty string if the channel does not have a password. </p></li>
|
|||
|
|
<li><p><strong>file</strong> – the name of the file on the server file system. See ts3client_getFileList to receive a list of files. </p></li>
|
|||
|
|
<li><p><strong>overwrite</strong> – boolean flag, whether to overwrite the local file if it already exists. If set to 0 transfer will fail if local file already exists unless resume is 1. Mutually exclusive to resume. </p></li>
|
|||
|
|
<li><p><strong>resume</strong> – boolean flag, whether to append to the local file. If set to 1 the contents of the download will be appended to the local file. Mutually exclusive with overwrite. </p></li>
|
|||
|
|
<li><p><strong>destinationDirectory</strong> – absolute path to the directory in which to store the file. </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the transfer id, used to identity this request in callbacks and other calls regarding the status of this transfer </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_haltTransfer">
|
|||
|
|
<span class="target" id="clientlib_8h_1a69ce3a18f467228cc9ffbd4b99e39527"></span><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">ts3client_haltTransfer</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">deleteUnfinishedFile</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>Cancel a file transfer. </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>serverConnectionHandlerID</strong> – connection handler on which the file transfer is happening </p></li>
|
|||
|
|
<li><p><strong>transferID</strong> – specifies the file transfer to cancel </p></li>
|
|||
|
|
<li><p><strong>deleteUnfinishedFile</strong> – boolean flag, whether to delete the partially transmitted file from the file system. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestFileList">
|
|||
|
|
<span class="target" id="clientlib_8h_1a2f4af115935ecae757bdbcb8443de7db"></span><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">ts3client_requestFileList</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">path</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>retrieve a list of files in a directory. </p>
|
|||
|
|
<p>This function is NOT recursive. Only directories and files in the directory specified by path will be listed. You will receive a onFileListEvent callback for every file or directory after this function was successful. Once all files and directories were sent you will receive a onFileListFinishedEvent callback.</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>serverConnectionHandlerID</strong> – the connection handler on which to request files </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel from which to list the files </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – the password of the specified channel. Pass an empty string if the channel has no password. </p></li>
|
|||
|
|
<li><p><strong>path</strong> – the path in the specified channel from which to list the files. Pass “/” to list the files in the root channel. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestFileInfo">
|
|||
|
|
<span class="target" id="clientlib_8h_1ae8c0b60065102c7010517b09769692af"></span><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">ts3client_requestFileInfo</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">file</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>retrieve information about a specific file. </p>
|
|||
|
|
<p>You will receive an onFileInfoEvent callback after this function was successful.</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>serverConnectionHandlerID</strong> – connection handler on which to request the file information. </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel in which the file is located </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – the password of the specified channel. Pass an empty string if the channel has no password. </p></li>
|
|||
|
|
<li><p><strong>file</strong> – absolute path to the file to query information of. Must begin with “/”. </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestDeleteFile">
|
|||
|
|
<span class="target" id="clientlib_8h_1ad51a44944e06592bea370599ba282f44"></span><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">ts3client_requestDeleteFile</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">file</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>delete one or more files from a channel. </p>
|
|||
|
|
<p>You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – connection handler on which to delete the file </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel in which the file is located </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – the password of the specified channel. Pass an empty string if the channel has no password. </p></li>
|
|||
|
|
<li><p><strong>file</strong> – a zero terminated array of absolute paths to the files to delete. Each path must begin with “/”. Like {“/file.txt”, “/dir/subdir/test.txt”, …, 0} </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestCreateDirectory">
|
|||
|
|
<span class="target" id="clientlib_8h_1af5c0dbb932a7f25b11d19602a4f70cf7"></span><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">ts3client_requestCreateDirectory</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">directoryPath</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>create a directory in a channel for file organization </p>
|
|||
|
|
<p>Note: This will NOT recursively create directories. If you need recursive creation call this function again after the intended parent directory has been created. You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – connection handler on which the channel is located. </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – the channel in which the file is located </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – the password of the specified channel. Pass an empty string if the channel has no password. </p></li>
|
|||
|
|
<li><p><strong>directoryPath</strong> – absolute path of the directory to create. Must start with “/” e.g. “/existing/newDirName” </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_requestRenameFile">
|
|||
|
|
<span class="target" id="clientlib_8h_1ab13be97ad87ab9b10c38f75d5ad74c41"></span><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">ts3client_requestRenameFile</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">fromChannelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fromChannelPW</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">toChannelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">toChannelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">oldFile</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">newFile</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>move or rename a file on the server. </p>
|
|||
|
|
<p>You will receive an onServerErrorEvent with the passed returnCode indicating whether or not the operation was successful.</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>serverConnectionHandlerID</strong> – connection handler on which to move/rename the file </p></li>
|
|||
|
|
<li><p><strong>fromChannelID</strong> – channel the file is currently located in </p></li>
|
|||
|
|
<li><p><strong>fromChannelPW</strong> – password of the specified channel. Pass an empty string if the channel has no password. </p></li>
|
|||
|
|
<li><p><strong>toChannelID</strong> – channel id to which to move the file to. Pass the same value as fromChannelID to keep the file in the same channel. </p></li>
|
|||
|
|
<li><p><strong>toChannelPW</strong> – password of the target channel. Pass an empty string if the channel has no password. </p></li>
|
|||
|
|
<li><p><strong>oldFile</strong> – current absolute path of the file in the channel. Must start with “/”. </p></li>
|
|||
|
|
<li><p><strong>newFile</strong> – new absolute path of the file in the target channel. Must start with “/”. e.g. “/subdirectory/filename.txt” </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_s3ft_getPresignedUrls">
|
|||
|
|
<span class="target" id="clientlib_8h_1a02e16abf45e6828233a6dcb1c247c48e"></span><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">ts3client_s3ft_getPresignedUrls</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">scHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">objectKeys</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">verbs</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">contentLengths</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">numObjects</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_s3ft_getPresignedUrls" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Requests pre-signed URLs for S3 file operations</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>scHandlerID</strong> – server connection handler ID </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – channel ID </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – channel password (can be NULL) </p></li>
|
|||
|
|
<li><p><strong>objectKeys</strong> – array of object keys to request URLs for </p></li>
|
|||
|
|
<li><p><strong>verbs</strong> – array of HTTP verbs corresponding to each object key </p></li>
|
|||
|
|
<li><p><strong>contentLengths</strong> – array of content lengths for upload operations </p></li>
|
|||
|
|
<li><p><strong>numObjects</strong> – number of objects in the arrays </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_s3ft_deleteFile">
|
|||
|
|
<span class="target" id="clientlib_8h_1ad08aa48464061adff02f63161beb595e"></span><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">ts3client_s3ft_deleteFile</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">scHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">objectKey</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_s3ft_deleteFile" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Deletes a file from an S3 bucket</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>scHandlerID</strong> – server connection handler ID </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – channel ID </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – channel password (can be NULL) </p></li>
|
|||
|
|
<li><p><strong>objectKey</strong> – object key to delete </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_s3ft_renameFile">
|
|||
|
|
<span class="target" id="clientlib_8h_1a5b337b86009bac420e1739ef19769f4c"></span><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">ts3client_s3ft_renameFile</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">scHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">oldObjectKey</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">newObjectKey</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_s3ft_renameFile" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Renames a file in an S3 bucket</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>scHandlerID</strong> – server connection handler ID </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – channel ID </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – channel password (can be NULL) </p></li>
|
|||
|
|
<li><p><strong>oldObjectKey</strong> – original object key </p></li>
|
|||
|
|
<li><p><strong>newObjectKey</strong> – new object key </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_s3ft_listFiles">
|
|||
|
|
<span class="target" id="clientlib_8h_1aaffb6c55f08a703dc2802b5756ffb6ad"></span><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">ts3client_s3ft_listFiles</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">scHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_s3ft_listFiles" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Lists files in an S3 bucket associated with a channel</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>scHandlerID</strong> – server connection handler ID </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – channel ID </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – channel password (can be NULL) </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_s3ft_uploadDoneNotification">
|
|||
|
|
<span class="target" id="clientlib_8h_1a090116f41ad48f2720129adffa0e30ba"></span><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">ts3client_s3ft_uploadDoneNotification</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">scHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_s3ft_uploadDoneNotification" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Notifies the server that an S3 upload has completed</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>scHandlerID</strong> – server connection handler ID </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – channel ID </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_s3ft_getUploadUrl">
|
|||
|
|
<span class="target" id="clientlib_8h_1a8756be282f49740c8f404a19b965004b"></span><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">ts3client_s3ft_getUploadUrl</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">scHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">objectKey</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">contentLength</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_s3ft_getUploadUrl" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Helper function to get pre-signed URL for a single S3 object upload</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>scHandlerID</strong> – server connection handler ID </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – channel ID </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – channel password (can be NULL) </p></li>
|
|||
|
|
<li><p><strong>objectKey</strong> – object key to upload </p></li>
|
|||
|
|
<li><p><strong>contentLength</strong> – size of the file to upload </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_s3ft_getDownloadUrl">
|
|||
|
|
<span class="target" id="clientlib_8h_1a0e5851a478e53f5e5969f554cbaeb753"></span><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">ts3client_s3ft_getDownloadUrl</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">scHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelPW</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">objectKey</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_s3ft_getDownloadUrl" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Helper function to get pre-signed URL for a single S3 object download</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>scHandlerID</strong> – server connection handler ID </p></li>
|
|||
|
|
<li><p><strong>channelID</strong> – channel ID </p></li>
|
|||
|
|
<li><p><strong>channelPW</strong> – channel password (can be NULL) </p></li>
|
|||
|
|
<li><p><strong>objectKey</strong> – object key to download </p></li>
|
|||
|
|
<li><p><strong>returnCode</strong> – a c string to identify this request in callbacks. Pass an empty string if unused. </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" id="c.ts3client_getInstanceSpeedLimitUp">
|
|||
|
|
<span class="target" id="clientlib_8h_1a00c34479efe37c71ce94e0efca2506c2"></span><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">ts3client_getInstanceSpeedLimitUp</span></span></span><span class="sig-paren">(</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">limit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>get the configured maximum upload speed of the server instance. </p>
|
|||
|
|
<p>The limit is temporary and valid only until ts3client_destroyClientLib is called.</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>limit</strong> – address of a variable to receive the limit in bytes per second. </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" id="c.ts3client_getInstanceSpeedLimitDown">
|
|||
|
|
<span class="target" id="clientlib_8h_1a3cb82fd787802606d825602df1788304"></span><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">ts3client_getInstanceSpeedLimitDown</span></span></span><span class="sig-paren">(</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">limit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>get the configured maximum download speed of the server instance. </p>
|
|||
|
|
<p>The limit is temporary and valid only until ts3client_destroyClientLib is called.</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>limit</strong> – address of a variable to receive the limit in bytes per second. </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" id="c.ts3client_getServerConnectionHandlerSpeedLimitUp">
|
|||
|
|
<span class="target" id="clientlib_8h_1ae3511d6c8d98e4314ba9fc066ac85d13"></span><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">ts3client_getServerConnectionHandlerSpeedLimitUp</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">serverConnectionHandlerID</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">limit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>get the configured maximum upload speed for the virtual server. </p>
|
|||
|
|
<p>Upload speeds on this server will not exceed min(instance limit, virtual server limit) bytes per second. The limit is temporary and valid only for the lifetime of the connection handler.</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>serverConnectionHandlerID</strong> – connection handler to query the value on. </p></li>
|
|||
|
|
<li><p><strong>limit</strong> – address of a variable to receive the limit in bytes per second. </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" id="c.ts3client_getServerConnectionHandlerSpeedLimitDown">
|
|||
|
|
<span class="target" id="clientlib_8h_1ac4e57c81f98586adf33617c7e7142ade"></span><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">ts3client_getServerConnectionHandlerSpeedLimitDown</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">serverConnectionHandlerID</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">limit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>get the configured maximum download speed for the virtual server. </p>
|
|||
|
|
<p>Download speeds on this server will not exceed min(instance limit, virtual server limit) bytes per second. The limit is temporary and valid only for the lifetime of the connection handler.</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>serverConnectionHandlerID</strong> – connection handler to query the value on. </p></li>
|
|||
|
|
<li><p><strong>limit</strong> – address of a variable to receive the limit in bytes per second. </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" id="c.ts3client_getTransferSpeedLimit">
|
|||
|
|
<span class="target" id="clientlib_8h_1a812aa07c0f95d2ff8da4ae28fb4645e8"></span><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">ts3client_getTransferSpeedLimit</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</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">limit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>get the speed limit for a specific file transfer. </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>transferID</strong> – specifies which transfer to query. </p></li>
|
|||
|
|
<li><p><strong>limit</strong> – address of a variable to receive the transfer limit in bytes per second. </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" id="c.ts3client_setInstanceSpeedLimitUp">
|
|||
|
|
<span class="target" id="clientlib_8h_1a0cfb20e915c713a9897168bc7e7b1321"></span><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">ts3client_setInstanceSpeedLimitUp</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">newLimit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>set the instance wide upload speed limit for file transfer. </p>
|
|||
|
|
<p>All concurrent file transfers combined will not exceed min(instance limit, virtual server limit) bytes per second. The limit is temporary and valid only for the lifetime of the connection handler.</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>newLimit</strong> – maximum upload speed in bytes per second. Must be >= 5120. </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" id="c.ts3client_setInstanceSpeedLimitDown">
|
|||
|
|
<span class="target" id="clientlib_8h_1a4f11f5d313023706116f1f32d91241f0"></span><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">ts3client_setInstanceSpeedLimitDown</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">newLimit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>set the instance wide download speed limit for file transfer. </p>
|
|||
|
|
<p>All concurrent file transfers combined will not exceed min(instance limit, virtual server limit) bytes per second. The limit is temporary and valid only for the lifetime of the connection handler.</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>newLimit</strong> – maximum download speed in bytes per second. Must be >= 5120. </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" id="c.ts3client_setServerConnectionHandlerSpeedLimitUp">
|
|||
|
|
<span class="target" id="clientlib_8h_1af25cbfe783759b29235bd31451b3c692"></span><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">ts3client_setServerConnectionHandlerSpeedLimitUp</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newLimit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>set the virtual server upload speed limit for file transfer. </p>
|
|||
|
|
<p>All concurrent file transfers combined will not exceed min(instance limit, virtual server limit) bytes per second. The limit is temporary and valid only for the lifetime of the connection handler.</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>serverConnectionHandlerID</strong> – connection handler on which to set the limit. </p></li>
|
|||
|
|
<li><p><strong>newLimit</strong> – maximum upload speed in bytes per second. Must be >= 5120. </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" id="c.ts3client_setServerConnectionHandlerSpeedLimitDown">
|
|||
|
|
<span class="target" id="clientlib_8h_1a690fd698ecc585501156e233456a2ac6"></span><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">ts3client_setServerConnectionHandlerSpeedLimitDown</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">serverConnectionHandlerID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newLimit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>set the virtual server download speed limit for file transfer. </p>
|
|||
|
|
<p>All concurrent file transfers combined will not exceed min(instance limit, virtual server limit) bytes per second. The limit is temporary and valid only for the lifetime of the connection handler.</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>serverConnectionHandlerID</strong> – connection handler on which to set the limit. </p></li>
|
|||
|
|
<li><p><strong>newLimit</strong> – maximum download speed in bytes per second. Must be >= 5120. </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" id="c.ts3client_setTransferSpeedLimit">
|
|||
|
|
<span class="target" id="clientlib_8h_1a0ecc635448f1d9289624bdb6d361632a"></span><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">ts3client_setTransferSpeedLimit</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span>, <span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newLimit</span></span><span class="sig-paren">)</span><br /></dt>
|
|||
|
|
<dd><p>set the transfer limit for an individual file transfer. </p>
|
|||
|
|
<p>The maximum transfer speed will be min(instance limit, virtual server limit, transfer limit). Whether the limit is upload or download depends on what kind of transfer the specified transfer is.</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>transferID</strong> – the transfer to set the limit for </p></li>
|
|||
|
|
<li><p><strong>newLimit</strong> – the new maximum speed in bytes per second. Must be >= 5120. </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" id="c.ts3client_getServerLegacyUUID">
|
|||
|
|
<span class="target" id="clientlib_8h_1ace0e6802907c12d86a67462555bf4105"></span><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">ts3client_getServerLegacyUUID</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">serverConnectionHandlerID</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ts3client_getServerLegacyUUID" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>get the legacy UUID (SHA1) of the virtual server. </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>serverConnectionHandlerID</strong> – specifies the server on which to retrieve the property </p></li>
|
|||
|
|
<li><p><strong>result</strong> – address of a variable to receive the legacy uuid value on success. Memory is allocated by the client lib and must be freed by caller using <a class="reference internal" href="#clientlib_8h_1a783cbda7046acfc0173c669821702619"><span class="std std-ref">ts3client_freeMemory</span></a></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>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<dl class="c struct">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ClientUIFunctions</span></span></span><br /></dt>
|
|||
|
|
<dd><div class="docutils container">
|
|||
|
|
<em>#include <clientlib.h></em></div>
|
|||
|
|
<p>Defines available callbacks that you can receive. </p>
|
|||
|
|
<p>Set the members of this struct to a function to call when the specific event happens. </p>
|
|||
|
|
<div class="breathe-sectiondef docutils container">
|
|||
|
|
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onMessage">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a5518ba8ce27027201ec2567f9371116d"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onMessage</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onMessage" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>JSON events. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param msg<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>A stringified JSON object. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onConnectStatusChangeEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ae6f16e02fe3cf874a9d05221b8b7abcf"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onConnectStatusChangeEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">newStatus</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><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="n"><span class="pre">errorNumber</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when the status of a connection changes </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the status has changed </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param newStatus<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the current status of the connection. One of the values from the ConnectStatus enum </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param errorNumber<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>if the state change was caused by an error this is set to one of the values from the <a class="reference internal" href="errors.html#public__errors_8h_1a0bcf1e0a5e32989890f6e85064327f7b"><span class="std std-ref">Ts3ErrorType</span></a> enum </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onServerProtocolVersionEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a892811cb8b90f6817e1724f0211ba728"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onServerProtocolVersionEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">protocolVersion</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onServerProtocolVersionEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onNewChannelEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ab9ae29bc64887945038fd0442775dc05"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onNewChannelEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelParentID</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onNewChannelEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called when a channel was received. </p>
|
|||
|
|
<p>Will be called once for every channel during connection initialization. Tells you which channels exist.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the id of the channel </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param channelParentID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the id of the parent channel. 0 if the channel is a root channel. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onNewChannelCreatedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a183dff15b5ccea0944cdfc3a22fa9d28"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onNewChannelCreatedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelParentID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">invokerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerUniqueIdentifier</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a new channel was created </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the id of the new channel </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param channelParentID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the id of the parent channel for the newly created channel. 0 if the channel is a root channel. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onDelChannelEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ab8d4a2af4d25f989c071d1befeadd91c"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onDelChannelEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">invokerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerUniqueIdentifier</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a channel is deleted </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the id of the channel that is deleted. This channel is gone already when this is called. It’s not possible to get any information about this channel anymore. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param invokerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>client id of the client that deleted the channel. 0 if deleted by the server. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param invokerName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the display name of the client that caused deletion </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param invokerUnqiueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the unique identifier of the client that caused deletion </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onChannelMoveEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a28aa8def2d4058785f4023e92af9d290"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onChannelMoveEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelParentID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">invokerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerUniqueIdentifier</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a channel is moved to a different location on the server </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the id of the channel being moved </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param newChannelParentID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the id of the new parent channel </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param invokerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>client if of the client that moved the channel. 0 if caused by server. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param invokerName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the display name of the client that moved the channel </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param invokerUniqueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the unique identifier of the client that moved the channel </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onUpdateChannelEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ab58588ce50116ec2f61a77c6b4f5864c"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onUpdateChannelEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when new data for a channel was received from the server </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the channel that new information was received for </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onUpdateChannelEditedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1aa48a31df845cea29f89f58d6bf09214d"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onUpdateChannelEditedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">invokerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerUniqueIdentifier</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a channel was edited on the server </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the id of the channel that was edited </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param invokerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>client id that edited the channel. 0 if done by the server </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param invokerName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the display name of the client editing the channel </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param invokerUniqueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the uid of the client that edited the channel </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onUpdateClientEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ac0ee3ff69e42a2714779a303eb524fc2"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onUpdateClientEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">invokerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">invokerUniqueIdentifier</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called whenever a change for a client is received from the server. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>specifies the client for which variables have changed or are now available </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param invokerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the source client that caused the update </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param invokerName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the display name of the client causing the update </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param invokerUniqueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the public identity of the client causing the update </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onClientMoveEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1abbb22b0b1f7e4b232c9d8ad0c5cdcfb0"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onClientMoveEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">oldChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">moveMessage</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a client moves to a different channel, disconnects, connects, gets kicked or banned. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client changing channels </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param oldChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>id of the previous channel of the client. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param newChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the current channel of the client. Can be 0, if the client disconnected / got kicked / banned. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onClientMoveSubscriptionEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a0b65e7d4516695a4ad9275eba3b9a54b"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onClientMoveSubscriptionEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">oldChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after subscribing to or unsubscribing from a channel. Called once for every client that is in the (un)subscribed channel at this time. </p>
|
|||
|
|
<p>Informs you about newly visible clients after subscribing to a channel. Informs about clients that we will no longer receive information about.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param oldChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>id of the channel that the client was in last time we saw the client. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param newChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the channel the client is currently in. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param visibility<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>whether we can see the client or not. One of the values from the Visibility enum. Allows to distinguish whether this callback was called after a subscribe or unsubscribe. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onClientMoveTimeoutEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a39d1503e3b058b7da82e26f0a198cd6d"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onClientMoveTimeoutEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">oldChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">timeoutMessage</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onClientMoveTimeoutEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called when a client loses connection and times out. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that lost connection </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param oldChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>channel the client used to be in </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param newChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>always 0 </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param visibility<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>whether we can see the client. One of the values from the Visibility enum. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param timeoutMessage<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>uft8 encoded c string containing the reason message. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onClientMoveMovedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ab768390650fe133836764a3a2db17d4a"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onClientMoveMovedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">oldChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">moverID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">moverName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">moverUniqueIdentifier</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">moveMessage</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a client was moved by the server or another client </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the client that was moved </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param oldChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>id of the previous channel the client used to be in </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param newChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the current channel the client was moved to </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param visibility<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>whether we can see the client. One of the values from the Visibility enum. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param moverID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that moved the client </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param moverName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the display name of the client that caused the move </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param moverUniqueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the identifier of the client that caused the move </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param moveMessage<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the reason message </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onClientKickFromChannelEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ac5c07c173dd771379a089931427574d6"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onClientKickFromChannelEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">oldChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">kickerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">kickerName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">kickerUniqueIdentifier</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">kickMessage</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a client is kicked from their channel </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that was kicked </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param oldChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>id of the previous channel the client used to be in </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param newChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the current channel the client was kicked to. This is the id of the server default channel. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param visibility<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>whether we can see the client. One of the values from the Visibility enum. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param kickerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that kicked the client. 0 if the server kicked the client. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param kickerName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the display name of the client initiating the kick </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param kickerUniqueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the identifier of the client initiating the kick </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param kickMessage<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the provided reason for the kick </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onClientKickFromServerEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a029c8a1e8a622de0e69266c3d2c8a412"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onClientKickFromServerEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">oldChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">newChannelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">kickerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">kickerName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">kickerUniqueIdentifier</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">kickMessage</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a client was kicked from the server </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that was kicked </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param oldChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>id of the previous channel the client used to be in </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param newChannelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>always 0 </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param visibility<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>whether we can see the client. One of the values from the Visibility enum. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param kickerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that kicked the client. 0 if the server kicked the client. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param kickerName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the display name of the client initiating the kick </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param kickerUniqueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the identifier of the client initiating the kick </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param kickMessage<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the provided reason for the kick </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onClientIDsEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a2f9f9307be4cc511c825b8dbf41e925f"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onClientIDsEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">uniqueClientIdentifier</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">clientName</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onClientIDsEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called for every connection using the identity after a call to ts3client_requestClientIDs. </p>
|
|||
|
|
<p>This is called multiple times for each identity queried. Once </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param uniqueClientIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the public identity queried and used by the client </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the id assigned to this client </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the display name of this client </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onClientIDsFinishedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1af83935c9ee5469d93a13778bf9764d61"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onClientIDsFinishedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onClientIDsFinishedEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called after onClientIDsEvent was called for every client using the queried identity. </p>
|
|||
|
|
<p>Once this callback is called, you know of all clients on the server that use the identity.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onServerEditedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ae1809606530a591c43e3d1e5a7c22eca"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onServerEditedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">editerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">editerName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">editerUniqueIdentifier</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when the server was edited </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param editerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that edited the server </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param editerName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the display name of the client editing the server </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param editerUniqueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the public identity of the client </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onServerUpdatedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a9f3d3c0659af46093efae23152d9b467"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onServerUpdatedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called whenever updates about changed server properties are received from the server. </p>
|
|||
|
|
<p>Happens after a call to ts3client_requestServerVariables but can also be called sporadically.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the updated variables are available </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onServerErrorEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a12de813e71c49095a8d623a1ee42f26e"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onServerErrorEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">errorMessage</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><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="n"><span class="pre">error</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">extraMessage</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after an action was performed by us. Tells whether the action was successful or which error occurred. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param errorMessage<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string describing the error </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param error<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the error code the action finished with. One of the values from the <a class="reference internal" href="errors.html#public__errors_8h_1a0bcf1e0a5e32989890f6e85064327f7b"><span class="std std-ref">Ts3ErrorType</span></a> enum. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param returnCode<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>a c string identifying the action that caused this error. This is the same string given as returnCode to function calls that request an action on the server </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param extraMessage<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing additional information if available. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onServerStopEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a846996cb7f21ccd81fab0c78e5dc5a8a"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onServerStopEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">shutdownMessage</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when the server was stopped </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param shutdownMessage<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the provided reason for the shutdown </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onTextMessageEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a93697463d5ec22ee972e05bbd2d8c63a"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onTextMessageEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">targetMode</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">toID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">fromID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fromName</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fromUniqueIdentifier</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a text message was received </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param targetMode<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>identifies the type of the message. One of the values from the TextMessageTargetMode enum. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param toID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the id of the recipient. Depends on the value of targetMode. a channel id for channel chat, own client id for private messages, 0 for server messages </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param fromID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that sent the message </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param fromName<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the display name of the client sending the message </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param fromUniqueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the public identity of the sending client </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param message<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the actual message </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onTalkStatusChangeEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1adb2f67e17f23cf85c84ddfefa6de0bae"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onTalkStatusChangeEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">isReceivedWhisper</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onTalkStatusChangeEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called when a client starts or stops talking. </p>
|
|||
|
|
<p>This event is only received for clients in our own channel and clients that whisper us</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param status<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Whether the client is talking or not. One of the values from the TalkStatus enum. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the client the event was called for </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onIgnoredWhisperEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a327585b9856429ff2547cc1c4994f48d"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onIgnoredWhisperEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when someone whispers us that is not on the list of clients we accept whispers from. </p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1a681bc51ec1c7bbf31e3efb4b37f1a6af"><span class="std std-ref">ts3client_allowWhispersFrom</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
<div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1aa84d9f65091a53aef532b8ee773e403c"><span class="std std-ref">ts3client_setWhisperReceiveWhitelist</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that tried to whisper us </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onConnectionInfoEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a92476b533650286dcd92e33da599eb51"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onConnectionInfoEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onConnectionInfoEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called when updated connection properties for a client are available. </p>
|
|||
|
|
<p>This happens after a call to ts3client_requestConnectionInfo</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client that updated properties are available for </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onServerConnectionInfoEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a4c1c4f1f04beb0ef96b15b402311ac89"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onServerConnectionInfoEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onServerConnectionInfoEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called after a call ts3client_requestServerConnectionInfo when the connection information for the server are available. </p>
|
|||
|
|
<p>Information can now be queried using ts3client_getServerConnectionVariableAsFloat and ts3client_getServerConnectionVariableAsUInt64</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onChannelSubscribeEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a6b29e56d741ffb65da34add0b309d53f"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onChannelSubscribeEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a channel was successfully subscribed by us </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the channel we subscribed to </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onChannelSubscribeFinishedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1adf328eb4cf974b4007299e74301e808c"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onChannelSubscribeFinishedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after all channels we attempted to subscribe to are subscribed. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onChannelUnsubscribeEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a67a1eb8d73fc1fe7ac37d93b8d117db7"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onChannelUnsubscribeEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after we unsubscribed from a channel </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the channel we unsubscribed from. Will no longer receive updates about clients in this channel. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onChannelUnsubscribeFinishedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1af9c475a4d76c15ddb5884c66e6d5f072"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onChannelUnsubscribeFinishedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after all channels we attempted to unsubscribe from are unsubscribed </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onChannelDescriptionUpdateEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a8214c95b35783a1ff344418bb875d40e"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onChannelDescriptionUpdateEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when the channel description of a channel has changed. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the channel for which the description has changed </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onChannelPasswordChangedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a6b5be2971471c385caa74bf5839e1aa0"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onChannelPasswordChangedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a channel password was changed. Can be used to invalidate cached passwords previously stored for the channel. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the channel the password was changed on </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onPlaybackShutdownCompleteEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1aeab7ce68012c93ed84d1b766218abd5c"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onPlaybackShutdownCompleteEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called once the playback device was closed on a connection </p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1af31abf44b6c6db339ef41351f31d8da2"><span class="std std-ref">ts3client_initiateGracefulPlaybackShutdown</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
<div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1aee37dae1b01c6d849745bb1c35087dfa"><span class="std std-ref">ts3client_closePlaybackDevice</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onSoundDeviceListChangedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ac61464b64ff1595cc9d300f202d47aa3"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onSoundDeviceListChangedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">modeID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">playOrCap</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onSoundDeviceListChangedEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called when the available devices changed </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param modeID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string describing the mode of the device </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param playOrCap<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>indicates whether the device is a capture or playback device </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onEditPlaybackVoiceDataEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a6818c9909cdf12d04625c25e295d0582"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onEditPlaybackVoiceDataEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">short</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">samples</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">sampleCount</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">channels</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called before any effects are applied, allows access to individual client raw audio data </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the source client for the audio </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param samples<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>buffer of audio data for the client as 16 bit signed at 48kHz </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param sampleCount<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>how many audio frames are available in the buffer </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param channels<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>number of audio channels in the audio data </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onEditPostProcessVoiceDataEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1abe00bd070cd65d5397d39f5c44c4b237"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onEditPostProcessVoiceDataEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">short</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">samples</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">sampleCount</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">channels</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><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="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelSpeakerArray</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><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="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelFillMask</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called before audio data is mixed together into a single audio stream for playback, but after effects (3D positioning for example) have been applied. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the source client for the audio </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param samples<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>buffer of audio data for the client as 16 bit signed at 48kHz </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param sampleCount<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>how many audio frames are available in the buffer </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param channels<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>number of audio channels in the audio data </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelSpeakerArray<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Array with an entry for each channel in the buffer, defining the speaker each channel represents. see SPEAKER_* defines in public_definitions.h</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param channelFillMask<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>a bit mask of SPEAKER_* that defines which of the channels in the buffer have audio data. Be sure to set the corresponding flag when adding audio to previously empty channels in the buffer. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onEditMixedPlaybackVoiceDataEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a9af7469235c27fe153d431c2c152404b"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onEditMixedPlaybackVoiceDataEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">short</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">samples</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">sampleCount</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">channels</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><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="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelSpeakerArray</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><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="p"><span class="pre">*</span></span><span class="n"><span class="pre">channelFillMask</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after mixing individual client audio together but before sending it to playback device. </p>
|
|||
|
|
<p>Last chance to access/modify audio data before it gets sent to the playback device.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param samples<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>buffer of audio data as 16 bit signed at 48kHz </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param sampleCount<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>how many audio frames are available in the buffer </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channels<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>how many audio channels are available in the buffer </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param channelSpeakerArray<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Array with an entry for each channel in the buffer, defining the speaker each channel represents. See SPEAKER_* defines in public_definitions.h</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelFillMask<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>a bit mask of SPEAKER_* that defines which of the channels in the buffer have audio data. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onEditCapturedVoiceDataPreprocessEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a0268f751b3b64d641990464d874c66c2"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onEditCapturedVoiceDataPreprocessEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">short</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">samples</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">sampleCount</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">channels</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after audio data was aquired from the capture device, without any pre processing applied. Allows access to raw audio data. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param samples<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>buffer of audio data </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param sampleCount<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>how many audio frames are available in the buffer </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channels<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>how many audio channels are available in the buffer </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param flags<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>allows to mute the audio stream, set LSB to 1 to mute the audio. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onEditCapturedVoiceDataEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a7271d685ce7afc4bdbb7b027018f873d"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onEditCapturedVoiceDataEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">short</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">samples</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">sampleCount</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">channels</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">edited</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after pre processing has been applied to recorded voice data, before it is sent to the server. </p>
|
|||
|
|
<p>This allows access to or modification of captured data from the recording device.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param samples<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>buffer of audio data as 16 bit signed at 48kHz </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param sampleCount<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>how many audio frames are available in the buffer </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channels<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>how many audio channels are available in the buffer </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param edited<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>bitMask indicating whether you modified the buffer. Set LSB to 1 if you modified the buffer. Bit 2 indicates whether or not this buffer will be sent to the server. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onCustom3dRolloffCalculationClientEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1aab6087c8bb36f089b1a54c2739a2d077"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onCustom3dRolloffCalculationClientEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">clientID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="n"><span class="pre">distance</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">volume</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called to calculate the volume attenuation for the distance in 3D positioning of clients </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param clientID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>id of the client for which the position is calculated </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param distance<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the distance from own client to the client </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param volume<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the volume calculated by the client lib. Can be modified in the callback. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onCustom3dRolloffCalculationWaveEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a707954288a87dbd7b880e5b6421bbc06"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onCustom3dRolloffCalculationWaveEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">waveHandle</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="n"><span class="pre">distance</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">volume</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called to calculate the volume attenuation for the distance in 3D positioning of wave files </p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1a96d9a7a84409b0ecf06851399029b4dc"><span class="std std-ref">ts3client_playWaveFileHandle</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param waveHandle<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>identifies the wave file to calculate the volume for. A handle previously created with <a class="reference internal" href="#clientlib_8h_1a96d9a7a84409b0ecf06851399029b4dc"><span class="std std-ref">ts3client_playWaveFileHandle</span></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param distance<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the distance from own client to the source of the wave file </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param volume<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the volume of the wave file calculated by the client lib. Can be modified in the callback. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onUserLoggingMessageEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1ad38d82ac2ec8c2ff2dedbce3c597a5ea"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onUserLoggingMessageEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">logmessage</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">logLevel</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">logChannel</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">logID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">logTime</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">completeLogString</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called for every log message if the client lib was initialized with user logging </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param logmessage<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the text to log </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param logLevel<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>indicates severity of the message. One of the values from the LogLevel enum </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param logChannel<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the category this message is logged under </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param logID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the connection handler this message was logged on </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param completeLogString<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the complete log message containing all other parameters for convenience </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onCustomPacketEncryptEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a228d171cdf30cf528dc9571297969acc"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onCustomPacketEncryptEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">dataToSend</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><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="p"><span class="pre">*</span></span><span class="n"><span class="pre">sizeOfData</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called for every packet to be sent to the server. Used to implement custom cryptography. </p>
|
|||
|
|
<p>Only implement if you need custom encryption of network traffic. Replaces default encryption. If implemented Encryption and Decryption must be implemented the same way on both server and client.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param dataToSend<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>pointer to a byte array of data to be encrypted. Must not be freed. Write encrypted data to array. Replace array pointer with pointer to own buffer if you need more space. Need to take care of freeing your own memory yourself. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param sizeOfData<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>pointer to the size of the data array. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onCustomPacketDecryptEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a1ad893c157f12612d8883031e8244fad"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onCustomPacketDecryptEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">dataReceived</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><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="p"><span class="pre">*</span></span><span class="n"><span class="pre">dataReceivedSize</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called for every packet received from the server. Used to implement custom cryptography. </p>
|
|||
|
|
<p>Only implement if you need custom encryption of network traffic. Replaces default encryption. If implemented Encryption and Decryption must be implemented the same way on both server and client.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param dataReceived<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>pointer to byte array of data to decrypt. Must not be freed. Write decrypted data to the array if large enough. Replace array pointer with pointer to own buffer if decrypted data exceeds the array size. Must take care to free own memory. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param sizeOfData<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>pointer to the size of the data array. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onCheckServerUniqueIdentifierEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a1d32d0bfc4e31c06873509899510c76a"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onCheckServerUniqueIdentifierEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ServerUniqueIdentifier</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cancelConnect</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onCheckServerUniqueIdentifierEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called during the connection initialization, allows to check whether the server identifier is the one you expect. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param ServerUniqueIdentifier<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the server identifier of the server connecting to </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param cancelConnect<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>allows to cancel the connection. Set variable pointed to to 1 to abort the connection. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onClientPasswordEncrypt">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1aa4901db4fdcb6e0cd0d53941f2ccd696"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onClientPasswordEncrypt</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">plaintext</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encryptedText</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">encryptedTextByteSize</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when a channel password is set. </p>
|
|||
|
|
<p>Can be used to implement custom password checks against external sources (e.g. LDAP).</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param plaintext<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>utf8 encoded c string containing the plaintext password as entered by the user </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param encryptedText<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>output parameter. Fill with the encrypted password / password hash. Must be an utf8 encoded c string (zero terminated). Must not be larger than the size specified by the encryptedTextByteSize parameter. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param encryptedTextByteSize<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the maximum amount of bytes (including trailing zero byte) that may be written to encryptedText parameter </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onFileTransferStatusEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a70e59de070974419ee79af05848332bb"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onFileTransferStatusEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">anyID</span></span><span class="w"> </span><span class="n"><span class="pre">transferID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><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="n"><span class="pre">status</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">statusMessage</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">remotefileSize</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called when file transfers finish or terminate with an error </p>
|
|||
|
|
<p><div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1aa1a520555357d4d5898e9c2d940a1780"><span class="std std-ref">ts3client_sendFile</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
<div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<p><a class="reference internal" href="#clientlib_8h_1a265fe02dadcd06d4002142d7cbbd3c2d"><span class="std std-ref">ts3client_requestFile</span></a></p>
|
|||
|
|
</div>
|
|||
|
|
</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param transferID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>identifies the file transfer the callback was called for. As created by <a class="reference internal" href="#clientlib_8h_1a265fe02dadcd06d4002142d7cbbd3c2d"><span class="std std-ref">ts3client_requestFile</span></a> or <a class="reference internal" href="#clientlib_8h_1aa1a520555357d4d5898e9c2d940a1780"><span class="std std-ref">ts3client_sendFile</span></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param status<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>indicates success status or error reason. One of the values from the <a class="reference internal" href="errors.html#public__errors_8h_1a0bcf1e0a5e32989890f6e85064327f7b"><span class="std std-ref">Ts3ErrorType</span></a> enum. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param statusMessage<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing a human readable description of the status message </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param remotefileSize<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>size of the file in bytes at the source of the transfer. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies the connection the transfer was started on </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onFileListEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1afebe1bb225427b05d46d4198aa276fc9"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onFileListEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">size</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">incompletesize</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">returnCode</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called as an answer to ts3client_requestFileList. Called once for every file in the requested path, providing file information. </p>
|
|||
|
|
<p>Followed by a onFileList_FinishedEvent callback after this callback was called for the last file in the requested path.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the channel in which the file is located </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param path<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the folder in which this file or directory is located </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param name<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the name of the file or directory this event is called for </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param size<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>file size in bytes. 0 if this event describes a directory </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param datetime<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>unix timestamp of when this file was last modified </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>whether the entry described is a directory or a file. One of the values from the FileTransferType enum. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param incompleteSize<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>number of bytes that have already been transmitted. If not equal to size then this file is still being transmitted or the transfer was aborted. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param returnCode<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>allows to identify which call to ts3client_requestFileList caused this event to be fired. Same as given to the ts3client_requestFileList call. Can be NULL </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onFileListFinishedEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a9e9a3b4689f1f4ccb08decaede87933c"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onFileListFinishedEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after onFileListEvent was called for all directories / files in a given path. </p>
|
|||
|
|
<p>This signifies that you now know of all files and directories in the path requested.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the channel for which the file list is now complete </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param path<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>the path within the channel that files and directories were requested for. </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onFileInfoEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a22d0f95d60064d4f68d22e1478e9294e"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onFileInfoEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">channelID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">size</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span><span class="p"><span class="pre">)</span></span><br /></dt>
|
|||
|
|
<dd><p>called after a call to ts3client_requestFileInfo providing the requested information about a file. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param channelID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the channel in which the file resides </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param name<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>utf8 encoded c string containing the absolute path within the channel, including the file / directory name. </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param size<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>the size of the file in bytes </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param datetime<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>unix timestamp for the last time the file was modified </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onChatLoginTokenEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a03d03a6f7a2679cb5ba464bd25dd20a1"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onChatLoginTokenEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onChatLoginTokenEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called after a call to ts3client_getChatLoginToken providing the requested login token for the chat server associated with this teamspeak server </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param token<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>The requested chat login token </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onAuthenticationTokenEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a8fd5db9ff937f9e27f56b9c66cf3df69"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onAuthenticationTokenEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">serverConnectionHandlerID</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onAuthenticationTokenEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>called after a call to ts3client_getAuthenticationToken providing the requested authentication token for the virtual server </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param serverConnectionHandlerID<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>specifies on which connection the callback was called </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param token<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>THe requested authentication token </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onScreenshareSessionEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1abbb173dc7614c76c19f38d6ba9c6e890"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onScreenshareSessionEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint64</span></span><span class="w"> </span><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">event_name</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onScreenshareSessionEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>invoked when some ui-relevant event happened in a screenshare session, with it’s according payload in json </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param id<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>stringified uint64 id of the peer connection </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param payload<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>stringified json payload </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onJsonReply">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a600697202f220c29ef54cf88e41afa26"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onJsonReply</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">json</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">return_code</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onJsonReply" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>invoked by an asynchronous request from ts3client_postMessage </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param stringified<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>json of the reply </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param return_code<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>a c string identifying the action that caused this event. This is the same string given as return_code to function calls that request an action </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onSendCallToMatrix">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a0cab20ca9f0107186b4ddecef619a873"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onSendCallToMatrix</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><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="n"><span class="pre">ts_chat_id</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">json</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">return_code</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onSendCallToMatrix" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Invoked when a JSON Command should be sent to the matrix module. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param stringified<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>json of the event </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param return_code<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>a c string identifying the event. A return_code is waiting to be resolved by ts3client_onMatrixMessage </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onProtoResponse">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1aa6815f3eb260f3634051b3449d0f4323"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onProtoResponse</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">size</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">return_code</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onProtoResponse" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Called when a proto command response is ready. </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param data<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Serialized ClientCommandResponse protobuf bytes </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param size<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Size in bytes </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Param return_code<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>The return_code passed to ts3client_postProtoCommand </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="c var">
|
|||
|
|
<dt class="sig sig-object c" id="c.ClientUIFunctions.onProtoEvent">
|
|||
|
|
<span class="target" id="struct_client_u_i_functions_1a33720653b013943128f404a6e0cd087d"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">onProtoEvent</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">size</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#c.ClientUIFunctions.onProtoEvent" title="Link to this definition"></a><br /></dt>
|
|||
|
|
<dd><p>Called when a proto event occurs (server events filtered by ACCESS_SDK). </p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Param data<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Serialized ServerEvent protobuf bytes </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Param size<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Size in bytes </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|||
|
|
<a href="enumerations.html" class="btn btn-neutral float-left" title="Structures & Enumerations" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
|
<a href="server_api.html" class="btn btn-neutral float-right" title="TeamSpeak Server Functions" 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>
|