322 lines
32 KiB
HTML
322 lines
32 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>Creating a new channel — 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="Moving a channel" href="channel-move.html" />
|
||
<link rel="prev" title="List channels" href="channel-list.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
TeamSpeak SDK
|
||
<img src="../_static/logo.png" class="logo" alt="Logo"/>
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../errors.html">TeamSpeak Error Codes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../properties.html">Property Enums</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../enumerations.html">Structures & Enumerations</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../client_api.html">TeamSpeak Client Functions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server_api.html">TeamSpeak Server Functions</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Server</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/intro.html">Introduction</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/basic.html">Getting started</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/list-items.html">List available clients, channels, servers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/vserver-manage.html">Create and stop virtual servers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/advanced-create.html">Advanced virtual server creation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/info.html">Retrieve and store information</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/channels.html">Managing channels</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/clients.html">Managing clients</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/whisper.html">Whisper lists</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/encryption.html">Custom encryption</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/passwords.html">Custom passwords</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/permissions.html">Permission checks</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/security-salt.html">Security salts and hashes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/disable-commands.html">Disabling protocol commands</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/filetransfer.html">Filetransfer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../server/faq.html">FAQ</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Client</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="basic.html">Getting started</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="connections.html">Managing server connections</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="logging.html">Logging</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="audio.html">Client Audio</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="wave-files.html">Playing wave files</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="3dsound.html">3D Sound</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="whisper.html">Whisper lists</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="voice-encryption.html">Channel voice data encryption</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="info.html">Retrieve and store information</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="channels.html">Channel Management</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="channel-list.html">List channels</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="info-channel.html">Channel information</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Creating a new channel</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#request-creation">Request creation</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#c.ts3client_flushChannelCreation"><code class="docutils literal notranslate"><span class="pre">ts3client_flushChannelCreation()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#callback">Callback</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="channel-move.html">Moving a channel</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="channel-sort.html">Channel sorting</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="channel-delete.html">Deleting a channel</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="channel-join.html">Joining a channel</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="channel-subscribe.html">Channel subscriptions</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="client-list.html">List clients</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="client-kick.html">Kicking clients</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="local-mute.html">Muting other clients</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="textmessages.html">Text chat</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="filetransfer.html">Filetransfer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="encryption.html">Custom encryption</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="passwords.html">Custom passwords</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">TeamSpeak SDK</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="channels.html">Channel Management</a></li>
|
||
<li class="breadcrumb-item active">Creating a new channel</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="creating-a-new-channel">
|
||
<h1>Creating a new channel<a class="headerlink" href="#creating-a-new-channel" title="Link to this heading"></a></h1>
|
||
<p>To create a channel, set the desired channel variables using one of
|
||
the following functions, passing 0 to the channel id parameter:</p>
|
||
<dl class="c function">
|
||
<dt class="sig sig-object c">
|
||
<span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">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">
|
||
<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">
|
||
<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>
|
||
|
||
<section id="request-creation">
|
||
<h2>Request creation<a class="headerlink" href="#request-creation" title="Link to this heading"></a></h2>
|
||
<p>To request the server to actually create the channel call</p>
|
||
<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><a class="headerlink" href="#c.ts3client_flushChannelCreation" title="Link to this definition"></a><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>
|
||
|
||
</section>
|
||
<section id="callback">
|
||
<h2>Callback<a class="headerlink" href="#callback" title="Link to this heading"></a></h2>
|
||
<p>If the channel was successfully created the following callback will be called</p>
|
||
<dl class="c struct">
|
||
<dt class="sig sig-object c">
|
||
<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><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">
|
||
<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>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="example">
|
||
<h2>Example<a class="headerlink" href="#example" title="Link to this heading"></a></h2>
|
||
<p>Example code to create a channel:</p>
|
||
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="cp">#define CHECK_ERROR(x) if ((error = x) != ERROR_ok) { goto on_error; }</span>
|
||
<span class="linenos"> 2</span>
|
||
<span class="linenos"> 3</span><span class="kt">int</span><span class="w"> </span><span class="nf">createChannel</span><span class="p">(</span><span class="n">uint64</span><span class="w"> </span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="n">uint64</span><span class="w"> </span><span class="n">parentChannelID</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">topic</span><span class="p">,</span>
|
||
<span class="linenos"> 4</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">description</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">password</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">codec</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">codecQuality</span><span class="p">,</span>
|
||
<span class="linenos"> 5</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">maxClients</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">familyMaxClients</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">order</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">perm</span><span class="p">,</span>
|
||
<span class="linenos"> 6</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">semiperm</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="k">default</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="linenos"> 7</span><span class="w"> </span><span class="kt">unsigned</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">error</span><span class="p">;</span>
|
||
<span class="linenos"> 8</span>
|
||
<span class="linenos"> 9</span><span class="w"> </span><span class="cm">/* Set channel data, pass 0 as channel ID */</span>
|
||
<span class="linenos">10</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsString</span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_NAME</span><span class="p">,</span><span class="w"> </span><span class="n">name</span><span class="p">));</span>
|
||
<span class="linenos">11</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsString</span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_TOPIC</span><span class="p">,</span><span class="w"> </span><span class="n">topic</span><span class="p">));</span>
|
||
<span class="linenos">12</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsString</span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_DESCRIPTION</span><span class="p">,</span><span class="w"> </span><span class="n">desc</span><span class="p">));</span>
|
||
<span class="linenos">13</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsString</span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_PASSWORD</span><span class="p">,</span><span class="w"> </span><span class="n">password</span><span class="p">));</span>
|
||
<span class="linenos">14</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsInt</span><span class="w"> </span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_CODEC</span><span class="p">,</span><span class="w"> </span><span class="n">codec</span><span class="p">));</span>
|
||
<span class="linenos">15</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsInt</span><span class="w"> </span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_CODEC_QUALITY</span><span class="p">,</span><span class="w"> </span><span class="n">codecQuality</span><span class="p">));</span>
|
||
<span class="linenos">16</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsInt</span><span class="w"> </span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_MAXCLIENTS</span><span class="p">,</span><span class="w"> </span><span class="n">maxClients</span><span class="p">));</span>
|
||
<span class="linenos">17</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsInt</span><span class="w"> </span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_MAXFAMILYCLIENTS</span><span class="p">,</span><span class="w"> </span><span class="n">familyMaxClients</span><span class="p">));</span>
|
||
<span class="linenos">18</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsUInt64</span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_ORDER</span><span class="p">,</span><span class="w"> </span><span class="n">order</span><span class="p">));</span>
|
||
<span class="linenos">19</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsInt</span><span class="w"> </span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_FLAG_PERMANENT</span><span class="p">,</span><span class="w"> </span><span class="n">perm</span><span class="p">));</span>
|
||
<span class="linenos">20</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsInt</span><span class="w"> </span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_FLAG_SEMI_PERMANENT</span><span class="p">,</span><span class="w"> </span><span class="n">semiperm</span><span class="p">));</span>
|
||
<span class="linenos">21</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_setChannelVariableAsInt</span><span class="w"> </span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">CHANNEL_FLAG_DEFAULT</span><span class="p">,</span><span class="w"> </span><span class="k">default</span><span class="p">));</span>
|
||
<span class="linenos">22</span>
|
||
<span class="linenos">23</span><span class="w"> </span><span class="cm">/* Flush changes to server */</span>
|
||
<span class="linenos">24</span><span class="w"> </span><span class="n">CHECK_ERROR</span><span class="p">(</span><span class="n">ts3client_flushChannelCreation</span><span class="p">(</span><span class="n">scHandlerID</span><span class="p">,</span><span class="w"> </span><span class="n">parentChannelID</span><span class="p">));</span>
|
||
<span class="linenos">25</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"> </span><span class="cm">/* Success */</span>
|
||
<span class="linenos">26</span>
|
||
<span class="linenos">27</span><span class="nl">on_error</span><span class="p">:</span>
|
||
<span class="linenos">28</span><span class="w"> </span><span class="n">printf</span><span class="p">(</span><span class="s">"Error creating channel: %d</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span><span class="w"> </span><span class="n">error</span><span class="p">);</span>
|
||
<span class="linenos">29</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span><span class="w"> </span><span class="cm">/* Failure */</span>
|
||
<span class="linenos">30</span><span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="channel-list.html" class="btn btn-neutral float-left" title="List channels" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="channel-move.html" class="btn btn-neutral float-right" title="Moving a channel" 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> |