mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
331 lines
17 KiB
HTML
331 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Interface IVoiceChannel
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Interface IVoiceChannel
|
|
">
|
|
<meta name="generator" content="docfx 2.50.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Discord.IVoiceChannel">
|
|
|
|
|
|
<h1 id="Discord_IVoiceChannel" data-uid="Discord.IVoiceChannel" class="text-break">Interface IVoiceChannel
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Represents a generic voice channel in a guild.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="Discord.INestedChannel.html#Discord_INestedChannel_CategoryId">INestedChannel.CategoryId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.INestedChannel.html#Discord_INestedChannel_GetCategoryAsync_Discord_CacheMode_Discord_RequestOptions_">INestedChannel.GetCategoryAsync(CacheMode, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.INestedChannel.html#Discord_INestedChannel_SyncPermissionsAsync_Discord_RequestOptions_">INestedChannel.SyncPermissionsAsync(RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.INestedChannel.html#Discord_INestedChannel_CreateInviteAsync_System_Nullable_System_Int32__System_Nullable_System_Int32__System_Boolean_System_Boolean_Discord_RequestOptions_">INestedChannel.CreateInviteAsync(Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.INestedChannel.html#Discord_INestedChannel_GetInvitesAsync_Discord_RequestOptions_">INestedChannel.GetInvitesAsync(RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_Position">IGuildChannel.Position</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_Guild">IGuildChannel.Guild</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_GuildId">IGuildChannel.GuildId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_PermissionOverwrites">IGuildChannel.PermissionOverwrites</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_ModifyAsync_System_Action_Discord_GuildChannelProperties__Discord_RequestOptions_">IGuildChannel.ModifyAsync(Action<GuildChannelProperties>, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_GetPermissionOverwrite_Discord_IRole_">IGuildChannel.GetPermissionOverwrite(IRole)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_GetPermissionOverwrite_Discord_IUser_">IGuildChannel.GetPermissionOverwrite(IUser)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IRole_Discord_RequestOptions_">IGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IUser_Discord_RequestOptions_">IGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IRole_Discord_OverwritePermissions_Discord_RequestOptions_">IGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IUser_Discord_OverwritePermissions_Discord_RequestOptions_">IGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions_">IGuildChannel.GetUsersAsync(CacheMode, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IGuildChannel.html#Discord_IGuildChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_">IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IDeletable.html#Discord_IDeletable_DeleteAsync_Discord_RequestOptions_">IDeletable.DeleteAsync(RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IAudioChannel.html#Discord_IAudioChannel_ConnectAsync_System_Boolean_System_Boolean_System_Boolean_">IAudioChannel.ConnectAsync(Boolean, Boolean, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IAudioChannel.html#Discord_IAudioChannel_DisconnectAsync">IAudioChannel.DisconnectAsync()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IChannel.html#Discord_IChannel_Name">IChannel.Name</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.ISnowflakeEntity.html#Discord_ISnowflakeEntity_CreatedAt">ISnowflakeEntity.CreatedAt</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IEntity-1.html#Discord_IEntity_1_Id">IEntity<UInt64>.Id</a>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Discord.html">Discord</a></h6>
|
|
<h6><strong>Assembly</strong>: Discord.Net.Core.dll</h6>
|
|
<h5 id="Discord_IVoiceChannel_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public interface IVoiceChannel : INestedChannel, IGuildChannel, IDeletable, IAudioChannel, IChannel, ISnowflakeEntity, IEntity<ulong></code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_IVoiceChannel_Bitrate.md&value=---%0Auid%3A%20Discord.IVoiceChannel.Bitrate%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs/#L18">View Source</a>
|
|
</span>
|
|
<a id="Discord_IVoiceChannel_Bitrate_" data-uid="Discord.IVoiceChannel.Bitrate*"></a>
|
|
<h4 id="Discord_IVoiceChannel_Bitrate" data-uid="Discord.IVoiceChannel.Bitrate">Bitrate</h4>
|
|
<div class="markdown level1 summary"><p>Gets the bit-rate that the clients in this voice channel are requested to use.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">int Bitrate { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><p>An <span class="xref">System.Int32</span> representing the bit-rate (bps) that this voice channel defines and requests the
|
|
client(s) to use.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_IVoiceChannel_UserLimit.md&value=---%0Auid%3A%20Discord.IVoiceChannel.UserLimit%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs/#L26">View Source</a>
|
|
</span>
|
|
<a id="Discord_IVoiceChannel_UserLimit_" data-uid="Discord.IVoiceChannel.UserLimit*"></a>
|
|
<h4 id="Discord_IVoiceChannel_UserLimit" data-uid="Discord.IVoiceChannel.UserLimit">UserLimit</h4>
|
|
<div class="markdown level1 summary"><p>Gets the max number of users allowed to be connected to this channel at once.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">int? UserLimit { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
|
<td><p>An <span class="xref">System.Int32</span> representing the maximum number of users that are allowed to be connected to this
|
|
channel at once; <code>null</code> if a limit is not set.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_IVoiceChannel_ModifyAsync_System_Action_Discord_VoiceChannelProperties__Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.IVoiceChannel.ModifyAsync(System.Action%7BDiscord.VoiceChannelProperties%7D%2CDiscord.RequestOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs/#L37">View Source</a>
|
|
</span>
|
|
<a id="Discord_IVoiceChannel_ModifyAsync_" data-uid="Discord.IVoiceChannel.ModifyAsync*"></a>
|
|
<h4 id="Discord_IVoiceChannel_ModifyAsync_System_Action_Discord_VoiceChannelProperties__Discord_RequestOptions_" data-uid="Discord.IVoiceChannel.ModifyAsync(System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">ModifyAsync(Action<VoiceChannelProperties>, RequestOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Modifies this voice channel.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">Task ModifyAsync(Action<VoiceChannelProperties> func, RequestOptions options = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.VoiceChannelProperties.html">VoiceChannelProperties</a>></td>
|
|
<td><span class="parametername">func</span></td>
|
|
<td><p>The properties to modify the channel with.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td><p>The options to be used when sending the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td><p>A task that represents the asynchronous modification operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_IVoiceChannel_ModifyAsync_System_Action_Discord_VoiceChannelProperties__Discord_RequestOptions__seealso">See Also</h5>
|
|
<div class="seealso">
|
|
<div><a class="xref" href="Discord.VoiceChannelProperties.html">VoiceChannelProperties</a></div>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_IVoiceChannel.md&value=---%0Auid%3A%20Discord.IVoiceChannel%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs/#L9" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|