Table of Contents

Class BufferedWriteStream

Namespace
Kook.Audio.Streams
Assembly
Kook.Net.WebSocket.dll

表示一个定时缓冲的音频写入流,用于将定时缓冲的音频数据写入到下一个音频流中。

public class BufferedWriteStream : AudioOutStream, IAsyncDisposable, IDisposable
Inheritance
BufferedWriteStream
Implements
Inherited Members

Methods

ClearAsync(CancellationToken)

清空该流.

public override Task ClearAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

用于取消该异步操作的取消令牌。

Returns

Task

一个清空操作的异步任务。

Remarks

此操作会导致丢失所有缓冲的数据。

Dispose(bool)

Releases the unmanaged resources used by the Stream and optionally releases the managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

FlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

public override Task FlushAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous flush operation.

Exceptions

ObjectDisposedException

The stream has been disposed.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

WriteAsync(byte[], int, int, CancellationToken)

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)

Parameters

buffer byte[]

The buffer to write data from.

offset int

The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count int

The maximum number of bytes to write.

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

ArgumentException

The sum of offset and count is larger than the buffer length.

NotSupportedException

The stream does not support writing.

ObjectDisposedException

The stream has been disposed.

InvalidOperationException

The stream is currently in use by a previous write operation.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

WriteHeader(ushort, uint, bool)

向流中写入一个头部信息。

public override void WriteHeader(ushort seq, uint timestamp, bool missed)

Parameters

seq ushort

头部的序列号。

timestamp uint

头部的时间戳。

missed bool

头部是否用于标识丢失的数据包。

Exceptions

InvalidOperationException

该流不接收头部信息。