Files
crtr/Assets/Plugins/Cryville.Audio.eng-latn.xml
2023-05-09 11:16:18 +08:00

1128 lines
51 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>Cryville.Audio</name>
</assembly>
<members>
<member name="T:Cryville.Audio.AudioClient">
<summary>
Audio client that manages connection to a <see cref="T:Cryville.Audio.IAudioDevice" />.
</summary>
</member>
<member name="M:Cryville.Audio.AudioClient.Dispose">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.AudioClient.Dispose(System.Boolean)">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
<param name="disposing">Whether the method is being called by user.</param>
</member>
<member name="P:Cryville.Audio.AudioClient.Device">
<summary>
The device of the client.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.DefaultBufferDuration">
<summary>
The default buffer duration of the client in milliseconds.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.MinimumBufferDuration">
<summary>
The minimum buffer duration of the client in milliseconds.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.DefaultFormat">
<summary>
The default wave format of the device.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.Format">
<summary>
The current wave format of the connection.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.BufferSize">
<summary>
The buffer size in bytes.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.MaximumLatency">
<summary>
The maximum latency of the connection in milliseconds.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.Playing">
<summary>
Whether the client is playing.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.Muted">
<summary>
Whether the client is muted.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.Position">
<summary>
The current position of the device stream in seconds.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.BufferPosition">
<summary>
The current position of the buffer in seconds.
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.Source">
<summary>
The audio source.
</summary>
</member>
<member name="M:Cryville.Audio.AudioClient.IsFormatSupported(Cryville.Audio.WaveFormat,System.Nullable{Cryville.Audio.WaveFormat}@,Cryville.Audio.AudioShareMode)">
<summary>
Gets whether <paramref name="format" /> is supported by the device.
</summary>
<param name="format">The specified wave format.</param>
<param name="suggestion">A wave format suggested by the device. <paramref name="format" /> if it is supported. <see langword="null" /> if no format is supported.</param>
<param name="shareMode">The share mode.</param>
<returns>Whether <paramref name="format" /> is supported.</returns>
</member>
<member name="M:Cryville.Audio.AudioClient.Init(Cryville.Audio.WaveFormat,System.Single,Cryville.Audio.AudioShareMode)">
<summary>
Initialize the client.
</summary>
<param name="format">The wave format.</param>
<param name="bufferDuration">The buffer duration of the connection in milliseconds.</param>
<param name="shareMode">The share mode of the connection.</param>
<remarks>Different operations may occur with different API being used. Please also see the documentations of the implementing classes.</remarks>
</member>
<member name="M:Cryville.Audio.AudioClient.Start">
<summary>
Starts the wave data transmission.
</summary>
<remarks>
If <see cref="P:Cryville.Audio.AudioClient.Source" /> is <see langword="null" /> while playing, the output will be silence.
</remarks>
</member>
<member name="M:Cryville.Audio.AudioClient.Pause">
<summary>
Pauses the wave data transmission.
</summary>
<remarks>
This method does not reset <see cref="P:Cryville.Audio.AudioClient.Position" /> and <see cref="P:Cryville.Audio.AudioClient.BufferPosition" />.
</remarks>
</member>
<member name="T:Cryville.Audio.AudioShareMode">
<summary>
The share mode of an audio connection.
</summary>
</member>
<member name="F:Cryville.Audio.AudioShareMode.Shared">
<summary>
The device is shared with other connections, at the cost of a higher latency than <see cref="F:Cryville.Audio.AudioShareMode.Exclusive" />. The output data is mixed by the audio service.
</summary>
</member>
<member name="F:Cryville.Audio.AudioShareMode.Exclusive">
<summary>
The device is exclusive to the current connection, providing a low latency.
</summary>
<remarks>To initialize an exclusive connection, the device must allow exclusive mode and must not be being used in either modes at the moment.</remarks>
</member>
<member name="T:Cryville.Audio.AudioStream">
<summary>
Audio stream.
</summary>
</member>
<member name="P:Cryville.Audio.AudioStream.Format">
<summary>
The wave format.
</summary>
</member>
<member name="P:Cryville.Audio.AudioStream.BufferSize">
<summary>
The buffer size in bytes.
</summary>
</member>
<member name="P:Cryville.Audio.AudioStream.EndOfData">
<summary>
Whether if the stream has reached the end of data.
</summary>
</member>
<member name="M:Cryville.Audio.AudioStream.SetFormat(Cryville.Audio.WaveFormat,System.Int32)">
<summary>
Sets the wave format and the buffer size of this audio stream.
</summary>
<param name="format">The wave format.</param>
<param name="bufferSize">The buffer size in bytes.</param>
<exception cref="T:System.InvalidOperationException">This method has already been called successfully once on the audio stream.</exception>
<exception cref="T:System.NotSupportedException"><paramref name="format" /> is not supported by the audio stream.</exception>
</member>
<member name="M:Cryville.Audio.AudioStream.OnSetFormat">
<summary>
Called when the wave format and the buffer size is determined.
</summary>
</member>
<member name="M:Cryville.Audio.AudioStream.IsFormatSupported(Cryville.Audio.WaveFormat)">
<summary>
Gets whether <paramref name="format" /> is supported by the audio stream.
</summary>
<param name="format">The wave format.</param>
</member>
<member name="M:Cryville.Audio.AudioStream.SeekTime(System.Double,System.IO.SeekOrigin)">
<summary>
Sets the time within the current audio stream.
</summary>
<param name="offset">An offset in seconds relative to the <paramref name="origin" /> parameter.</param>
<param name="origin">A value of type <see cref="T:System.IO.SeekOrigin" /> indicating the reference point used to obtain the new time.</param>
<returns>The new time in seconds within the current audio stream.</returns>
</member>
<member name="M:Cryville.Audio.AudioStream.SetDuration(System.Double)">
<summary>
Sets the duration of the current audio stream.
</summary>
<param name="value">The duration in seconds.</param>
</member>
<member name="P:Cryville.Audio.AudioStream.Duration">
<summary>
The duration in seconds of the audio stream.
</summary>
</member>
<member name="P:Cryville.Audio.AudioStream.Time">
<summary>
The time in seconds within the current audio stream.
</summary>
</member>
<member name="M:Cryville.Audio.AudioStream.SilentBuffer(Cryville.Audio.WaveFormat,System.Byte[],System.Int32,System.Int32)">
<summary>
Fills the buffer with silence.
</summary>
<param name="format">The wave format.</param>
<param name="buffer">The buffer to be filled.</param>
<param name="offset">The offset in bytes from the start of the <paramref name="buffer" /> to start filling.</param>
<param name="count">The length in bytes to be filled.</param>
</member>
<member name="T:Cryville.Audio.DataFlow">
<summary>
The data-flow direction of an audio connection.
</summary>
</member>
<member name="F:Cryville.Audio.DataFlow.Out">
<summary>
Data flows from software to hardware.
</summary>
</member>
<member name="F:Cryville.Audio.DataFlow.In">
<summary>
Data flows from hardware to software.
</summary>
</member>
<member name="F:Cryville.Audio.DataFlow.All">
<summary>
Any data-flow direction.
</summary>
</member>
<member name="T:Cryville.Audio.EngineBuilder">
<summary>
The recommended entry for Cryville.Audio that creates an <see cref="T:Cryville.Audio.IAudioDeviceManager" />.
</summary>
</member>
<member name="F:Cryville.Audio.EngineBuilder.Engines">
<summary>
The list of available engines.
</summary>
</member>
<member name="M:Cryville.Audio.EngineBuilder.Create">
<summary>
Creates a recommended <see cref="T:Cryville.Audio.IAudioDeviceManager" />.
</summary>
<returns>A recommended <see cref="T:Cryville.Audio.IAudioDeviceManager" />. <see langword="null" /> if no engine is supported.</returns>
</member>
<member name="T:Cryville.Audio.IAudioDevice">
<summary>
Audio device.
</summary>
</member>
<member name="P:Cryville.Audio.IAudioDevice.Name">
<summary>
The friendly name of the device.
</summary>
</member>
<member name="P:Cryville.Audio.IAudioDevice.DataFlow">
<summary>
The data-flow direction of the device.
</summary>
</member>
<member name="M:Cryville.Audio.IAudioDevice.Connect">
<summary>
Connects to the device.
</summary>
<returns>An <see cref="T:Cryville.Audio.AudioClient" /> for interaction with the device.</returns>
</member>
<member name="T:Cryville.Audio.IAudioDeviceManager">
<summary>
Audio device manager that manages <see cref="T:Cryville.Audio.IAudioDevice" />.
</summary>
<remarks>
If the <see cref="T:Cryville.Audio.IAudioDeviceManager" /> is not supported, an exception is thrown when trying to create an instance.
</remarks>
</member>
<member name="M:Cryville.Audio.IAudioDeviceManager.GetDevices(Cryville.Audio.DataFlow)">
<summary>
Gets all audio devices for the specified <paramref name="dataFlow" />.
</summary>
<param name="dataFlow">The data-flow direction.</param>
</member>
<member name="M:Cryville.Audio.IAudioDeviceManager.GetDefaultDevice(Cryville.Audio.DataFlow)">
<summary>
Gets the default audio device for the specified <paramref name="dataFlow" />.
</summary>
<param name="dataFlow">The data-flow direction.</param>
</member>
<member name="T:Cryville.Audio.OpenSL.Engine">
<summary>
An <see cref="T:Cryville.Audio.IAudioDeviceManager" /> that interacts with OpenSL ES.
</summary>
</member>
<member name="M:Cryville.Audio.OpenSL.Engine.#ctor">
<summary>
Creates an instance of the <see cref="T:Cryville.Audio.OpenSL.Engine" /> class.
</summary>
</member>
<member name="M:Cryville.Audio.OpenSL.Engine.Finalize">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.Engine.Dispose">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.Engine.Dispose(System.Boolean)">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
<param name="disposing">Whether the method is being called by user.</param>
</member>
<member name="M:Cryville.Audio.OpenSL.Engine.GetDefaultDevice(Cryville.Audio.DataFlow)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.Engine.GetDevices(Cryville.Audio.DataFlow)">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.OpenSL.OutputClient">
<summary>
An <see cref="T:Cryville.Audio.AudioClient" /> that interacts with OpenSL ES.
</summary>
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Finalize">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Dispose(System.Boolean)">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.Device">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.DefaultBufferDuration">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.MinimumBufferDuration">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.DefaultFormat">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.Format">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.BufferSize">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.MaximumLatency">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.Position">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.BufferPosition">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Init(Cryville.Audio.WaveFormat,System.Single,Cryville.Audio.AudioShareMode)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.IsFormatSupported(Cryville.Audio.WaveFormat,System.Nullable{Cryville.Audio.WaveFormat}@,Cryville.Audio.AudioShareMode)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Start">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Pause">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.OpenSL.OutputDevice">
<summary>
An <see cref="T:Cryville.Audio.IAudioDevice" /> that interacts with OpenSL ES.
</summary>
</member>
<member name="M:Cryville.Audio.OpenSL.OutputDevice.Finalize">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputDevice.Dispose">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputDevice.Dispose(System.Boolean)">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
<param name="disposing">Whether the method is being called by user.</param>
</member>
<member name="P:Cryville.Audio.OpenSL.OutputDevice.Name">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputDevice.DataFlow">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputDevice.Connect">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Source.CachedAudioSource">
<summary>
An <see cref="T:Cryville.Audio.AudioStream" /> that caches data for reuse.
</summary>
<remarks>
<para>This stream is not seekable. Use <see cref="M:Cryville.Audio.Source.CachedAudioSource.Rewind" /> to reset its timestamp to zero.</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.#ctor(Cryville.Audio.AudioStream,System.Double)">
<summary>
Creates an instance of the <see cref="T:Cryville.Audio.Source.CachedAudioSource" /> class.
</summary>
<param name="source">The <see cref="T:Cryville.Audio.AudioStream" /> to be cached.</param>
<param name="duration">The duration of the cache in seconds.</param>
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.Clone">
<summary>
Gets a clone of this <see cref="T:Cryville.Audio.Source.CachedAudioSource" /> with the timestamp reset.
</summary>
<returns>A clone of this <see cref="T:Cryville.Audio.Source.CachedAudioSource" /> with the timestamp reset.</returns>
<remarks>
Use with object pool is recommended.
</remarks>
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.Rewind">
<summary>
Resets the timestamp to reuse the instance.
</summary>
<remarks>
Use with object pool is recommended.
</remarks>
</member>
<member name="P:Cryville.Audio.Source.CachedAudioSource.EndOfData">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.CachedAudioSource.Disposed">
<summary>
Whether this audio stream has been disposed.
</summary>
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.Dispose(System.Boolean)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.IsFormatSupported(Cryville.Audio.WaveFormat)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.OnSetFormat">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.Read(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.Seek(System.Int64,System.IO.SeekOrigin)">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.CachedAudioSource.CanRead">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.CachedAudioSource.CanSeek">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.CachedAudioSource.CanWrite">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.CachedAudioSource.Length">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.CachedAudioSource.Position">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.Flush">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.SetLength(System.Int64)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.Write(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Source.FunctionAudioSource">
<summary>
An <see cref="T:Cryville.Audio.AudioStream" /> that generates sound by a given function.
</summary>
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.Channels">
<summary>
The channel count of the output format.
</summary>
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.EndOfData">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.Disposed">
<summary>
Whether this audio stream has been disposed.
</summary>
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.Dispose(System.Boolean)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.IsFormatSupported(Cryville.Audio.WaveFormat)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.OnSetFormat">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.Read(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.Func(System.Double,System.Int32)">
<summary>
The function used to generate wave.
</summary>
<param name="time">The time position.</param>
<param name="channel">The channel index.</param>
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.Seek(System.Int64,System.IO.SeekOrigin)">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.CanRead">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.CanSeek">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.CanWrite">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.Length">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.Position">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.Flush">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.SetLength(System.Int64)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.Write(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Source.LibavFileAudioSource">
<summary>
An <see cref="T:Cryville.Audio.AudioStream" /> that uses Libav to demux and decode audio files.
</summary>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.#ctor(System.String)">
<summary>
Creates an instance of the <see cref="T:Cryville.Audio.Source.LibavFileAudioSource" /> class and loads the specified <paramref name="file" />.
</summary>
<param name="file">The audio file.</param>
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Disposed">
<summary>
Whether this audio stream has been disposed.
</summary>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.Dispose(System.Boolean)">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.EndOfData">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.BestStreamIndex">
<summary>
The index to the best audio stream.
</summary>
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Streams">
<summary>
The collection of indices to all audio streams.
</summary>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.SelectStream">
<summary>
Selects the best stream as the source.
</summary>
<exception cref="T:System.InvalidOperationException">The stream has been selected.</exception>
<remarks>
<para>This method can only be called before <see cref="M:Cryville.Audio.AudioStream.SetFormat(Cryville.Audio.WaveFormat,System.Int32)" /> is called, which is called while setting <see cref="P:Cryville.Audio.AudioClient.Source" />.</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.SelectStream(System.Int32)">
<summary>
Selects a stream as the source.
</summary>
<param name="index">The index of the stream.</param>
<exception cref="T:System.InvalidOperationException">The stream has been selected.</exception>
<remarks>
<para>This method can only be called before <see cref="M:Cryville.Audio.AudioStream.SetFormat(Cryville.Audio.WaveFormat,System.Int32)" /> is called, which is called while setting <see cref="P:Cryville.Audio.AudioClient.Source" />.</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.GetStreamDuration(System.Int32)">
<summary>
Gets the duration of a stream or the file.
</summary>
<param name="streamId">The stream index. The duration of the file is retrieved if <c>-1</c> is specified.</param>
<returns>The duration in seconds.</returns>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.IsFormatSupported(Cryville.Audio.WaveFormat)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.OnSetFormat">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.Read(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.Seek(System.Int64,System.IO.SeekOrigin)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.SeekTime(System.Double,System.IO.SeekOrigin)">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.CanRead">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.CanSeek">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.CanWrite">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Length">
<inheritdoc />
<remarks>
<para>This property may be inaccurate.</para>
</remarks>
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Duration">
<inheritdoc />
<remarks>
<para>This property may be inaccurate.</para>
</remarks>
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Time">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Position">
<inheritdoc />
<remarks>
<para>This property may become inaccurate after <see cref="M:Cryville.Audio.Source.LibavFileAudioSource.Seek(System.Int64,System.IO.SeekOrigin)" /> is called.</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.Flush">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.SetLength(System.Int64)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.Write(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Source.LibavException">
<summary>
The exception that is thrown by Libav.
</summary>
</member>
<member name="M:Cryville.Audio.Source.LibavException.#ctor">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavException.#ctor(System.String)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavException.#ctor(System.String,System.Exception)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Source.SimpleSequencerSource">
<summary>
A simple <see cref="T:Cryville.Audio.AudioStream" /> that mixes sequenced audio sources.
</summary>
<remarks>
<para>To use this class, take the following steps:</para>
<list type="number">
<item>Create an instance of <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" />.</item>
<item>Attach the <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" /> to an <see cref="T:Cryville.Audio.AudioClient" /> by setting <see cref="P:Cryville.Audio.AudioClient.Source" />.</item>
<item>Create a new <see cref="T:Cryville.Audio.Source.SimpleSequencerSession" /> by calling <see cref="M:Cryville.Audio.Source.SimpleSequencerSource.NewSession" />.</item>
<item>Start playback by calling <see cref="M:Cryville.Audio.AudioClient.Start" /> and setting <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.Playing" /> to <see langword="true" />.</item>
</list>
<para><see cref="T:Cryville.Audio.AudioStream" />s can be sequenced to the <see cref="T:Cryville.Audio.Source.SimpleSequencerSession" /> both before and after playback starts. See <see cref="M:Cryville.Audio.Source.SimpleSequencerSession.Sequence(System.Double,Cryville.Audio.AudioStream)" />.</para>
<para>If <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.Playing" /> is set to <see langword="false" />, the output will become silence.</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.#ctor(System.Int32)">
<summary>
Creates an instance of the <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" /> class.
</summary>
<param name="maxPolyphony">Max polyphony of the source. Must be greater than 0. See <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.MaxPolyphony"/>.</param>
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.Disposed">
<summary>
Whether this audio stream has been disposed.
</summary>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.Dispose(System.Boolean)">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.EndOfData">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.OnSetFormat">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.IsFormatSupported(Cryville.Audio.WaveFormat)">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.Playing">
<summary>
Whether if the current session is playing.
</summary>
<remarks>
There is a tiny delay before the playback state actually toggles, which is approximately <see cref="P:Cryville.Audio.AudioClient.BufferPosition" /> substracted by <see cref="P:Cryville.Audio.AudioClient.Position" />.
</remarks>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.Read(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.Seek(System.Int64,System.IO.SeekOrigin)">
<inheritdoc />
<param name="offset">A byte offset relative to the current position.</param>
<param name="origin">Must be <see cref="F:System.IO.SeekOrigin.Current" />.</param>
<remarks>
<para>This stream can only be seeked from the current position, and forward only. Thus, <paramref name="offset" /> must be non-negative, and <paramref name="origin" /> must be <see cref="F:System.IO.SeekOrigin.Current" />.</para>
</remarks>
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.CanRead">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.CanSeek">
<inheritdoc />
<remarks>
<para>This stream can only be seeked from the current position, and forward only. See <see cref="M:Cryville.Audio.Source.SimpleSequencerSource.Seek(System.Int64,System.IO.SeekOrigin)" />.</para>
</remarks>
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.CanWrite">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.Length">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.Position">
<inheritdoc />
<remarks>
<para>Although this stream is seekable, setting this property is not supported and throws <see cref="T:System.NotSupportedException" />. This stream can only be seeked from the current position, and forward only. See <see cref="M:Cryville.Audio.Source.SimpleSequencerSource.Seek(System.Int64,System.IO.SeekOrigin)" />.</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.Flush">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.SetLength(System.Int64)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.Write(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.Polyphony">
<summary>
The number of sources currently playing.
</summary>
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.MaxPolyphony">
<summary>
Max polyphony, the number of sources that can be played at the same time.
</summary>
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.Session">
<summary>
The <see cref="T:Cryville.Audio.Source.SimpleSequencerSession" /> currently playing.
</summary>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.NewSession">
<summary>
Stops the current session and creates a new <see cref="T:Cryville.Audio.Source.SimpleSequencerSession" /> to replace it.
</summary>
<remarks>
An <see cref="T:Cryville.Audio.AudioClient" /> must be attached to this source first.
</remarks>
</member>
<member name="T:Cryville.Audio.Source.SimpleSequencerSession">
<summary>
A session for <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" />.
</summary>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSession.Sequence(System.Double,Cryville.Audio.AudioStream)">
<summary>
Sequences a <paramref name="source" /> at the specified <paramref name="time" />.
</summary>
<param name="time">The time in seconds.</param>
<param name="source">The audio source.</param>
<remarks>
<para>If <paramref name="time" /> is less than the current time, the <paramref name="source" /> will be played immediately.</para>
<para>If the number of audio sources currently playing exceeds <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.MaxPolyphony" />, the <paramref name="source" /> will be discarded.</para>
<para>Audio sources can be sequenced even when the sequencer has been disposed, while it would not have any effect.</para>
</remarks>
</member>
<member name="T:Cryville.Audio.Source.SingleToneAudioSource">
<summary>
An <see cref="T:Cryville.Audio.AudioStream" /> that generates single tone.
</summary>
</member>
<member name="P:Cryville.Audio.Source.SingleToneAudioSource.Type">
<summary>
The tone type.
</summary>
</member>
<member name="P:Cryville.Audio.Source.SingleToneAudioSource.Frequency">
<summary>
The frequency of the wave.
</summary>
</member>
<member name="P:Cryville.Audio.Source.SingleToneAudioSource.Amplitude">
<summary>
The amplitude of the wave.
</summary>
</member>
<member name="M:Cryville.Audio.Source.SingleToneAudioSource.Func(System.Double,System.Int32)">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Source.ToneType">
<summary>
Tone type.
</summary>
</member>
<member name="F:Cryville.Audio.Source.ToneType.Sine">
<summary>
Sine wave.
</summary>
</member>
<member name="F:Cryville.Audio.Source.ToneType.Triangle">
<summary>
Triangle wave.
</summary>
</member>
<member name="F:Cryville.Audio.Source.ToneType.Square">
<summary>
Square wave.
</summary>
</member>
<member name="T:Cryville.Audio.Wasapi.AudioClient">
<summary>
An <see cref="T:Cryville.Audio.AudioClient" /> that interact with Wasapi.
</summary>
</member>
<member name="M:Cryville.Audio.Wasapi.AudioClient.Finalize">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Wasapi.AudioClient.Dispose(System.Boolean)">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.AudioClient.Device">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.AudioClient.DefaultBufferDuration">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.AudioClient.MinimumBufferDuration">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.AudioClient.DefaultFormat">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.AudioClient.Format">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.AudioClient.BufferSize">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.AudioClient.MaximumLatency">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.AudioClient.Position">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.AudioClient.BufferPosition">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Wasapi.AudioClient.IsFormatSupported(Cryville.Audio.WaveFormat,System.Nullable{Cryville.Audio.WaveFormat}@,Cryville.Audio.AudioShareMode)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Wasapi.AudioClient.Init(Cryville.Audio.WaveFormat,System.Single,Cryville.Audio.AudioShareMode)">
<summary>
Initialize the client.
</summary>
<param name="format">The wave format.</param>
<param name="bufferDuration">The buffer duration of the connection. The value is clamped to <see cref="P:Cryville.Audio.Wasapi.AudioClient.MinimumBufferDuration" /> if too small. If <paramref name="shareMode" /> is set to <see cref="F:Cryville.Audio.AudioShareMode.Shared" />, the buffer duration will be determined automatically despite this parameter.</param>
<param name="shareMode">The share mode of the connection.</param>
</member>
<member name="M:Cryville.Audio.Wasapi.AudioClient.Start">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Wasapi.AudioClient.Pause">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Wasapi.MMDevice">
<summary>
An <see cref="T:Cryville.Audio.IAudioDevice" /> that interacts with Wasapi.
</summary>
</member>
<member name="P:Cryville.Audio.Wasapi.MMDevice.Properties">
<summary>
The properties of the device.
</summary>
</member>
<member name="P:Cryville.Audio.Wasapi.MMDevice.Name">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Wasapi.MMDevice.DataFlow">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Wasapi.MMDevice.Connect">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Wasapi.MMDeviceEnumerator">
<summary>
An <see cref="T:Cryville.Audio.IAudioDeviceManager" /> that interact with Wasapi.
</summary>
<remarks>
<c>Cryville.Audio.WasapiWrapper.dll</c> is required.
</remarks>
</member>
<member name="M:Cryville.Audio.Wasapi.MMDeviceEnumerator.#ctor">
<summary>
Creates an instance of the <see cref="T:Cryville.Audio.Wasapi.MMDeviceEnumerator" /> class.
</summary>
</member>
<member name="M:Cryville.Audio.Wasapi.MMDeviceEnumerator.GetDevices(Cryville.Audio.DataFlow)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Wasapi.MMDeviceEnumerator.GetDefaultDevice(Cryville.Audio.DataFlow)">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.WaveFormat">
<summary>
The wave format.
</summary>
</member>
<member name="P:Cryville.Audio.WaveFormat.Channels">
<summary>
The channel count.
</summary>
</member>
<member name="P:Cryville.Audio.WaveFormat.SampleRate">
<summary>
The sample rate (samples per second.)
</summary>
</member>
<member name="P:Cryville.Audio.WaveFormat.SampleFormat">
<summary>
The sample format.
</summary>
</member>
<member name="P:Cryville.Audio.WaveFormat.BitsPerSample">
<summary>
Bit count per sample.
</summary>
</member>
<member name="P:Cryville.Audio.WaveFormat.BytesPerSecond">
<summary>
Bytes per second.
</summary>
</member>
<member name="F:Cryville.Audio.WaveFormat.Default">
<summary>
The default wave format.
</summary>
</member>
<member name="M:Cryville.Audio.WaveFormat.Align(System.Double,System.Boolean)">
<summary>
Gets the aligned buffer size.
</summary>
<param name="size">The prefered buffer size in bytes.</param>
<param name="floored">Whether the result is floored or ceiled.</param>
<returns>The aligned buffer size in bytes.</returns>
</member>
<member name="M:Cryville.Audio.WaveFormat.ToString">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WaveFormat.Equals(Cryville.Audio.WaveFormat)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WaveFormat.Equals(System.Object)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WaveFormat.GetHashCode">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WaveFormat.op_Equality(Cryville.Audio.WaveFormat,Cryville.Audio.WaveFormat)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WaveFormat.op_Inequality(Cryville.Audio.WaveFormat,Cryville.Audio.WaveFormat)">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.SampleFormat">
<summary>
Sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Invalid">
<summary>
Invalid sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.U8">
<summary>
Unsigned 8-bit integer sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.S16">
<summary>
Signed 16-bit integer sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.S24">
<summary>
Signed 24-bit integer sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.S32">
<summary>
Signed 32-bit integer sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.F32">
<summary>
IEEE 754 single precision floating-point sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.F64">
<summary>
IEEE 754 double precision floating-point sample format.
</summary>
</member>
<member name="T:Cryville.Audio.WinMM.WaveOutClient">
<summary>
An <see cref="T:Cryville.Audio.AudioClient" /> that interacts with WinMM.
</summary>
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutClient.Finalize">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutClient.Dispose(System.Boolean)">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
<param name="disposing">Whether the method is being called by user.</param>
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutClient.Device">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutClient.DefaultBufferDuration">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutClient.MinimumBufferDuration">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutClient.DefaultFormat">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutClient.Format">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutClient.BufferSize">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutClient.MaximumLatency">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutClient.Position">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutClient.BufferPosition">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutClient.Init(Cryville.Audio.WaveFormat,System.Single,Cryville.Audio.AudioShareMode)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutClient.IsFormatSupported(Cryville.Audio.WaveFormat,System.Nullable{Cryville.Audio.WaveFormat}@,Cryville.Audio.AudioShareMode)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutClient.Start">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutClient.Pause">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.WinMM.WaveOutDevice">
<summary>
An <see cref="T:Cryville.Audio.IAudioDevice" /> that interacts with WinMM.
</summary>
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutDevice.Dispose">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutDevice.Dispose(System.Boolean)">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
<param name="disposing">Whether the method is being called by user.</param>
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutDevice.Name">
<summary>
The friendly name of the device.
</summary>
<remarks>Due to technical reason, this field is truncated if it has more than 31 characters.</remarks>
</member>
<member name="P:Cryville.Audio.WinMM.WaveOutDevice.DataFlow">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutDevice.Connect">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.WinMM.WaveDeviceManager">
<summary>
An <see cref="T:Cryville.Audio.IAudioDeviceManager" /> that interacts with WinMM.
</summary>
</member>
<member name="M:Cryville.Audio.WinMM.WaveDeviceManager.#ctor">
<summary>
Creates an instance of the <see cref="T:Cryville.Audio.WinMM.WaveDeviceManager" /> class.
</summary>
</member>
<member name="M:Cryville.Audio.WinMM.WaveDeviceManager.Dispose">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveDeviceManager.Dispose(System.Boolean)">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
<param name="disposing">Whether the method is being called by user.</param>
</member>
<member name="M:Cryville.Audio.WinMM.WaveDeviceManager.GetDefaultDevice(Cryville.Audio.DataFlow)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveDeviceManager.GetDevices(Cryville.Audio.DataFlow)">
<inheritdoc />
</member>
</members>
</doc>