ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 10:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Discord.Audio.AudioOutStream.html
goat 2584122e4e regenerate docs
2020-03-11 21:54:11 +09:00

524 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class AudioOutStream
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class AudioOutStream
">
<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.AudioOutStream">
<h1 id="Discord_Audio_AudioOutStream" data-uid="Discord.Audio.AudioOutStream" class="text-break">Class AudioOutStream
</h1>
<div class="markdown level0 summary"></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"><span class="xref">AudioOutStream</span></div>
<div class="level5"><a class="xref" href="Discord.Audio.Streams.BufferedWriteStream.html">BufferedWriteStream</a></div>
<div class="level5"><a class="xref" href="Discord.Audio.Streams.OpusDecodeStream.html">OpusDecodeStream</a></div>
<div class="level5"><a class="xref" href="Discord.Audio.Streams.OpusEncodeStream.html">OpusEncodeStream</a></div>
<div class="level5"><a class="xref" href="Discord.Audio.Streams.OutputStream.html">OutputStream</a></div>
<div class="level5"><a class="xref" href="Discord.Audio.Streams.RTPReadStream.html">RTPReadStream</a></div>
<div class="level5"><a class="xref" href="Discord.Audio.Streams.RTPWriteStream.html">RTPWriteStream</a></div>
<div class="level5"><a class="xref" href="Discord.Audio.Streams.SodiumDecryptStream.html">SodiumDecryptStream</a></div>
<div class="level5"><a class="xref" href="Discord.Audio.Streams.SodiumEncryptStream.html">SodiumEncryptStream</a></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.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_WriteHeader_System_UInt16_System_UInt32_System_Boolean_">AudioStream.WriteHeader(UInt16, UInt32, Boolean)</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_ClearAsync_System_Threading_CancellationToken_">AudioStream.ClearAsync(CancellationToken)</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.FlushAsync(System.Threading.CancellationToken)</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.WriteAsync(System.Byte[], System.Int32, System.Int32, System.Threading.CancellationToken)</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.html">Discord.Audio</a></h6>
<h6><strong>Assembly</strong>: Discord.Net.Core.dll</h6>
<h5 id="Discord_Audio_AudioOutStream_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class AudioOutStream : AudioStream, IDisposable</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_Audio_AudioOutStream_CanWrite.md&amp;value=---%0Auid%3A%20Discord.Audio.AudioOutStream.CanWrite%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/Audio/AudioOutStream.cs/#L8">View Source</a>
</span>
<a id="Discord_Audio_AudioOutStream_CanWrite_" data-uid="Discord.Audio.AudioOutStream.CanWrite*"></a>
<h4 id="Discord_Audio_AudioOutStream_CanWrite" data-uid="Discord.Audio.AudioOutStream.CanWrite">CanWrite</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 bool CanWrite { 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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_CanWrite">AudioStream.CanWrite</a></div>
<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_AudioOutStream_Read_System_Byte___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Discord.Audio.AudioOutStream.Read(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32)%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/Audio/AudioOutStream.cs/#L12">View Source</a>
</span>
<a id="Discord_Audio_AudioOutStream_Read_" data-uid="Discord.Audio.AudioOutStream.Read*"></a>
<h4 id="Discord_Audio_AudioOutStream_Read_System_Byte___System_Int32_System_Int32_" data-uid="Discord.Audio.AudioOutStream.Read(System.Byte[],System.Int32,System.Int32)">Read(Byte[], Int32, Int32)</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 int Read(byte[] buffer, int offset, int count)</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>
</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_Read_System_Byte___System_Int32_System_Int32_">AudioStream.Read(Byte[], Int32, Int32)</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.NotSupportedException</span></td>
<td><p>Reading this stream is not supported.</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_AudioOutStream_Seek_System_Int64_System_IO_SeekOrigin_.md&amp;value=---%0Auid%3A%20Discord.Audio.AudioOutStream.Seek(System.Int64%2CSystem.IO.SeekOrigin)%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/Audio/AudioOutStream.cs/#L20">View Source</a>
</span>
<a id="Discord_Audio_AudioOutStream_Seek_" data-uid="Discord.Audio.AudioOutStream.Seek*"></a>
<h4 id="Discord_Audio_AudioOutStream_Seek_System_Int64_System_IO_SeekOrigin_" data-uid="Discord.Audio.AudioOutStream.Seek(System.Int64,System.IO.SeekOrigin)">Seek(Int64, SeekOrigin)</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 long Seek(long offset, SeekOrigin origin)</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.Int64</span></td>
<td><span class="parametername">offset</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IO.SeekOrigin</span></td>
<td><span class="parametername">origin</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.Int64</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_Seek_System_Int64_System_IO_SeekOrigin_">AudioStream.Seek(Int64, SeekOrigin)</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.NotSupportedException</span></td>
<td><p>Seeking this stream is not supported..</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_AudioOutStream_SetLength_System_Int64_.md&amp;value=---%0Auid%3A%20Discord.Audio.AudioOutStream.SetLength(System.Int64)%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/Audio/AudioOutStream.cs/#L16">View Source</a>
</span>
<a id="Discord_Audio_AudioOutStream_SetLength_" data-uid="Discord.Audio.AudioOutStream.SetLength*"></a>
<h4 id="Discord_Audio_AudioOutStream_SetLength_System_Int64_" data-uid="Discord.Audio.AudioOutStream.SetLength(System.Int64)">SetLength(Int64)</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 SetLength(long value)</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.Int64</span></td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.Audio.AudioStream.html#Discord_Audio_AudioStream_SetLength_System_Int64_">AudioStream.SetLength(Int64)</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.NotSupportedException</span></td>
<td><p>Setting the length to this stream is not supported.</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_AudioOutStream.md&amp;value=---%0Auid%3A%20Discord.Audio.AudioOutStream%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/Audio/AudioOutStream.cs/#L6" 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>
Reference in a new issue View git blame Copy permalink