mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
576 lines
25 KiB
HTML
576 lines
25 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>Class SodiumEncryptStream
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class SodiumEncryptStream
|
|
">
|
|
<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.Audio.Streams.SodiumEncryptStream">
|
|
|
|
|
|
<h1 id="Discord_Audio_Streams_SodiumEncryptStream" data-uid="Discord.Audio.Streams.SodiumEncryptStream" class="text-break">Class SodiumEncryptStream
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Encrypts an RTP frame using libsodium.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">System.MarshalByRefObject</span></div>
|
|
<div class="level2"><span class="xref">System.IO.Stream</span></div>
|
|
<div class="level3"><a class="xref" href="Discord.Audio.AudioStream.html">AudioStream</a></div>
|
|
<div class="level4"><a class="xref" href="Discord.Audio.AudioOutStream.html">AudioOutStream</a></div>
|
|
<div class="level5"><span class="xref">SodiumEncryptStream</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">System.IDisposable</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioOutStream.html#Discord_Audio_AudioOutStream_CanWrite">AudioOutStream.CanWrite</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioOutStream.html#Discord_Audio_AudioOutStream_Read_System_Byte___System_Int32_System_Int32_">AudioOutStream.Read(Byte[], Int32, Int32)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioOutStream.html#Discord_Audio_AudioOutStream_SetLength_System_Int64_">AudioOutStream.SetLength(Int64)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioOutStream.html#Discord_Audio_AudioOutStream_Seek_System_Int64_System_IO_SeekOrigin_">AudioOutStream.Seek(Int64, SeekOrigin)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_CanRead">AudioStream.CanRead</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_CanSeek">AudioStream.CanSeek</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_Write_System_Byte___System_Int32_System_Int32_">AudioStream.Write(Byte[], Int32, Int32)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_Flush">AudioStream.Flush()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_Clear">AudioStream.Clear()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_Length">AudioStream.Length</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_Position">AudioStream.Position</a>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.Null</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.CopyToAsync(System.IO.Stream)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.CopyToAsync(System.IO.Stream, System.Int32)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.CopyToAsync(System.IO.Stream, System.Int32, System.Threading.CancellationToken)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.CopyTo(System.IO.Stream)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.CopyTo(System.IO.Stream, System.Int32)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.Close()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.Dispose()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.Dispose(System.Boolean)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.FlushAsync()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.CreateWaitHandle()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.BeginRead(System.Byte[], System.Int32, System.Int32, System.AsyncCallback, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.EndRead(System.IAsyncResult)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.ReadAsync(System.Byte[], System.Int32, System.Int32)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.ReadAsync(System.Byte[], System.Int32, System.Int32, System.Threading.CancellationToken)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.BeginWrite(System.Byte[], System.Int32, System.Int32, System.AsyncCallback, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.EndWrite(System.IAsyncResult)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.WriteAsync(System.Byte[], System.Int32, System.Int32)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.ReadByte()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.WriteByte(System.Byte)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.Synchronized(System.IO.Stream)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.ObjectInvariant()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.CanTimeout</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.ReadTimeout</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IO.Stream.WriteTimeout</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.MarshalByRefObject.MemberwiseClone(System.Boolean)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.MarshalByRefObject.GetLifetimeService()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.MarshalByRefObject.InitializeLifetimeService()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.MarshalByRefObject.CreateObjRef(System.Type)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Discord.Audio.Streams.html">Discord.Audio.Streams</a></h6>
|
|
<h6><strong>Assembly</strong>: Discord.Net.WebSocket.dll</h6>
|
|
<h5 id="Discord_Audio_Streams_SodiumEncryptStream_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class SodiumEncryptStream : AudioOutStream, IDisposable</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</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_Audio_Streams_SodiumEncryptStream__ctor_Discord_Audio_AudioStream_Discord_Audio_IAudioClient_.md&value=---%0Auid%3A%20Discord.Audio.Streams.SodiumEncryptStream.%23ctor(Discord.Audio.AudioStream%2CDiscord.Audio.IAudioClient)%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.WebSocket/Audio/Streams/SodiumEncryptStream.cs/#L19">View Source</a>
|
|
</span>
|
|
<a id="Discord_Audio_Streams_SodiumEncryptStream__ctor_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.#ctor*"></a>
|
|
<h4 id="Discord_Audio_Streams_SodiumEncryptStream__ctor_Discord_Audio_AudioStream_Discord_Audio_IAudioClient_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.#ctor(Discord.Audio.AudioStream,Discord.Audio.IAudioClient)">SodiumEncryptStream(AudioStream, IAudioClient)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SodiumEncryptStream(AudioStream next, IAudioClient client)</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><a class="xref" href="Discord.Audio.AudioStream.html">AudioStream</a></td>
|
|
<td><span class="parametername">next</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.Audio.IAudioClient.html">IAudioClient</a></td>
|
|
<td><span class="parametername">client</span></td>
|
|
<td></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_Audio_Streams_SodiumEncryptStream_ClearAsync_System_Threading_CancellationToken_.md&value=---%0Auid%3A%20Discord.Audio.Streams.SodiumEncryptStream.ClearAsync(System.Threading.CancellationToken)%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.WebSocket/Audio/Streams/SodiumEncryptStream.cs/#L59">View Source</a>
|
|
</span>
|
|
<a id="Discord_Audio_Streams_SodiumEncryptStream_ClearAsync_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.ClearAsync*"></a>
|
|
<h4 id="Discord_Audio_Streams_SodiumEncryptStream_ClearAsync_System_Threading_CancellationToken_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.ClearAsync(System.Threading.CancellationToken)">ClearAsync(CancellationToken)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override Task ClearAsync(CancellationToken cancelToken)</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.Threading.CancellationToken</span></td>
|
|
<td><span class="parametername">cancelToken</span></td>
|
|
<td></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></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_ClearAsync_System_Threading_CancellationToken_">AudioStream.ClearAsync(CancellationToken)</a></div>
|
|
<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_Audio_Streams_SodiumEncryptStream_FlushAsync_System_Threading_CancellationToken_.md&value=---%0Auid%3A%20Discord.Audio.Streams.SodiumEncryptStream.FlushAsync(System.Threading.CancellationToken)%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.WebSocket/Audio/Streams/SodiumEncryptStream.cs/#L55">View Source</a>
|
|
</span>
|
|
<a id="Discord_Audio_Streams_SodiumEncryptStream_FlushAsync_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.FlushAsync*"></a>
|
|
<h4 id="Discord_Audio_Streams_SodiumEncryptStream_FlushAsync_System_Threading_CancellationToken_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.FlushAsync(System.Threading.CancellationToken)">FlushAsync(CancellationToken)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override Task FlushAsync(CancellationToken cancelToken)</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.Threading.CancellationToken</span></td>
|
|
<td><span class="parametername">cancelToken</span></td>
|
|
<td></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></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.IO.Stream.FlushAsync(System.Threading.CancellationToken)</span></div>
|
|
<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_Audio_Streams_SodiumEncryptStream_WriteAsync_System_Byte___System_Int32_System_Int32_System_Threading_CancellationToken_.md&value=---%0Auid%3A%20Discord.Audio.Streams.SodiumEncryptStream.WriteAsync(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32%2CSystem.Threading.CancellationToken)%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.WebSocket/Audio/Streams/SodiumEncryptStream.cs/#L39">View Source</a>
|
|
</span>
|
|
<a id="Discord_Audio_Streams_SodiumEncryptStream_WriteAsync_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.WriteAsync*"></a>
|
|
<h4 id="Discord_Audio_Streams_SodiumEncryptStream_WriteAsync_System_Byte___System_Int32_System_Int32_System_Threading_CancellationToken_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">WriteAsync(Byte[], Int32, Int32, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancelToken)</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.Byte</span>[]</td>
|
|
<td><span class="parametername">buffer</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">offset</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">count</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.CancellationToken</span></td>
|
|
<td><span class="parametername">cancelToken</span></td>
|
|
<td></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></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.IO.Stream.WriteAsync(System.Byte[], System.Int32, System.Int32, System.Threading.CancellationToken)</span></div>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.InvalidOperationException</span></td>
|
|
<td><p>Received payload without an RTP header.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.OperationCanceledException</span></td>
|
|
<td><p>The token has had cancellation requested.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.ObjectDisposedException</span></td>
|
|
<td><p>The associated <span class="xref">System.Threading.CancellationTokenSource</span> has been disposed.</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_Audio_Streams_SodiumEncryptStream_WriteHeader_System_UInt16_System_UInt32_System_Boolean_.md&value=---%0Auid%3A%20Discord.Audio.Streams.SodiumEncryptStream.WriteHeader(System.UInt16%2CSystem.UInt32%2CSystem.Boolean)%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.WebSocket/Audio/Streams/SodiumEncryptStream.cs/#L27">View Source</a>
|
|
</span>
|
|
<a id="Discord_Audio_Streams_SodiumEncryptStream_WriteHeader_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.WriteHeader*"></a>
|
|
<h4 id="Discord_Audio_Streams_SodiumEncryptStream_WriteHeader_System_UInt16_System_UInt32_System_Boolean_" data-uid="Discord.Audio.Streams.SodiumEncryptStream.WriteHeader(System.UInt16,System.UInt32,System.Boolean)">WriteHeader(UInt16, UInt32, Boolean)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override void WriteHeader(ushort seq, uint timestamp, bool missed)</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.UInt16</span></td>
|
|
<td><span class="parametername">seq</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.UInt32</span></td>
|
|
<td><span class="parametername">timestamp</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">missed</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_WriteHeader_System_UInt16_System_UInt32_System_Boolean_">AudioStream.WriteHeader(UInt16, UInt32, Boolean)</a></div>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.InvalidOperationException</span></td>
|
|
<td><p>Header received with no payload.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">System.IDisposable</span>
|
|
</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_Audio_Streams_SodiumEncryptStream.md&value=---%0Auid%3A%20Discord.Audio.Streams.SodiumEncryptStream%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.WebSocket/Audio/Streams/SodiumEncryptStream.cs/#L10" 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>
|