Pop_Slime/crtr
1
0
Fork 0
Code Issues 6 Pull Requests Projects 1 Releases Activity

Update Cryville.Audio.

Browse Source
This commit is contained in:
PopSlime
2023-03-30 10:37:08 +08:00
parent c685e634d5
commit 578e10bbd7
5 changed files with 815 additions and 395 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Assets/Cryville/Crtr/Game.cs
View File

@@ -74,9 +74,6 @@ namespace Cryville.Crtr {
ffmpeg.RootPath = "";
#else
#error No FFmpeg search path.
#endif
#if UNITY_ANDROID
Cryville.Audio.OpenSL.OutputClient.CallbackFunction = audioCallback;
#endif
while (true) {
try {
@@ -147,13 +144,6 @@ namespace Cryville.Crtr {
Logger.Log("main", 1, "Game", "Initialized");
}
#if UNITY_ANDROID
[MonoPInvokeCallback(typeof(OpenSL.Native.slBufferQueueCallback))]
static void audioCallback(IntPtr caller, IntPtr context) {
Cryville.Audio.OpenSL.OutputClient.Callback(caller, context);
}
#endif
static bool _shutdown;
public static void Shutdown() {
if (_shutdown) return;
@@ -161,8 +151,8 @@ namespace Cryville.Crtr {
Logger.Log("main", 1, "Game", "Shutting down");
try {
AudioSequencer.Dispose();
AudioClient.Dispose();
AudioSequencer.Dispose();
AudioManager.Dispose();
}
catch (Exception ex) {

BIN
Assets/Plugins/Cryville.Audio.dll
View File

Binary file not shown.

444
Assets/Plugins/Cryville.Audio.eng-latn.xml
View File

@@ -58,6 +58,11 @@
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.
@@ -123,6 +128,79 @@
</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.
@@ -232,9 +310,6 @@
<summary>
An <see cref="T:Cryville.Audio.AudioClient" /> that interacts with OpenSL ES.
</summary>
<remarks>
See <see cref="P:Cryville.Audio.OpenSL.OutputClient.CallbackFunction" /> if AOT is used.
</remarks>
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Finalize">
<inheritdoc />
@@ -269,21 +344,6 @@
<member name="P:Cryville.Audio.OpenSL.OutputClient.BufferPosition">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.CallbackFunction">
<summary>
The buffer queue callback function.
</summary>
<remarks>
<para>In the case where AOT is used, override this so it points to a proper function, which calls <see cref="M:Cryville.Audio.OpenSL.OutputClient.Callback(System.IntPtr,System.IntPtr)" />, as the following code snippet:</para>
<code>
[MonoPInvokeCallback(typeof(slBufferQueueCallback))]
static void AOTCallback(IntPtr caller, IntPtr context) {
OutputClient.Callback(caller, context);
}
</code>
<para>You should not override this function in other cases.</para>
</remarks>
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Init(Cryville.Audio.WaveFormat,System.Single,Cryville.Audio.AudioShareMode)">
<inheritdoc />
</member>
@@ -296,11 +356,6 @@
<member name="M:Cryville.Audio.OpenSL.OutputClient.Start">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Callback(System.IntPtr,System.IntPtr)">
<summary>
See <see cref="P:Cryville.Audio.OpenSL.OutputClient.CallbackFunction" />.
</summary>
</member>
<member name="T:Cryville.Audio.OpenSL.OutputDevice">
<summary>
An <see cref="T:Cryville.Audio.IAudioDevice" /> that interacts with OpenSL ES.
@@ -327,95 +382,19 @@
<member name="M:Cryville.Audio.OpenSL.OutputDevice.Connect">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Source.AudioSource">
<summary>
Audio source that provides wave data.
</summary>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.Dispose">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.AudioSource.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.Source.AudioSource.Muted">
<summary>
Whether the audio source is muted.
</summary>
</member>
<member name="P:Cryville.Audio.Source.AudioSource.Format">
<summary>
The output wave format.
</summary>
</member>
<member name="P:Cryville.Audio.Source.AudioSource.BufferSize">
<summary>
The buffer size in bytes.
</summary>
</member>
<member name="P:Cryville.Audio.Source.AudioSource.EndOfData">
<summary>
Whether if the source has reached the end of data.
</summary>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.OnSetFormat">
<summary>
Called when the wave format is set and the buffer size is determined.
</summary>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.IsFormatSupported(Cryville.Audio.WaveFormat)">
<summary>
Gets whether <paramref name="format" /> is supported by the audio source.
</summary>
<param name="format">The wave format.</param>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<summary>
Fills the buffer with wave data requested by <see cref="T:Cryville.Audio.AudioClient" />.
</summary>
<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="length">The length in bytes to be filled.</param>
<remarks>
To optimize performance, the caller must ensure <paramref name="buffer" /> is not <see langword="null" /> and <paramref name="length" /> is not greater than the length of <paramref name="buffer" />.
</remarks>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.SilentBuffer(System.Byte[],System.Int32,System.Int32)">
<summary>
Fills the buffer with silence.
</summary>
<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="length">The length in bytes to be filled.</param>
<remarks>
To optimize performance, the caller must ensure <paramref name="buffer" /> is not <see langword="null" /> and <paramref name="length" /> is not greater than the length of <paramref name="buffer" />.
</remarks>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.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="length">The length in bytes to be filled.</param>
<remarks>
To optimize performance, the caller must ensure <paramref name="buffer" /> is not <see langword="null" /> and <paramref name="length" /> is not greater than the length of <paramref name="buffer" />.
</remarks>
</member>
<member name="T:Cryville.Audio.Source.CachedAudioSource">
<summary>
An <see cref="T:Cryville.Audio.Source.AudioSource" /> that caches data for reuse.
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.Source.AudioSource,System.Double)">
<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.Source.AudioSource" /> to be cached.</param>
<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">
@@ -438,6 +417,11 @@
<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>
@@ -447,12 +431,39 @@
<member name="M:Cryville.Audio.Source.CachedAudioSource.OnSetFormat">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<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.Source.AudioSource" /> that generates sound by a given function.
An <see cref="T:Cryville.Audio.AudioStream" /> that generates sound by a given function.
</summary>
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.Channels">
@@ -460,16 +471,24 @@
The channel count of the output format.
</summary>
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.Dispose(System.Boolean)">
<member name="P:Cryville.Audio.Source.FunctionAudioSource.EndOfData">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.EndOfData">
<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.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<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)">
@@ -479,13 +498,37 @@
<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.Source.AudioSource" /> that uses Libav to demux and decode audio files.
An <see cref="T:Cryville.Audio.AudioStream" /> that uses Libav to demux and decode audio files.
</summary>
<remarks>
You must select a stream using <see cref="M:Cryville.Audio.Source.LibavFileAudioSource.SelectStream" /> or <see cref="M:Cryville.Audio.Source.LibavFileAudioSource.SelectStream(System.Int32)" /> before playback.
</remarks>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.#ctor(System.String)">
<summary>
@@ -493,6 +536,11 @@
</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>
@@ -513,32 +561,102 @@
<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.GetDuration(System.Int32)">
<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.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.Read(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.IsFormatSupported(Cryville.Audio.WaveFormat)">
<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.Source.AudioSource" /> that mixes sequenced audio sources.
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>
@@ -548,7 +666,7 @@
<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>You can sequence <see cref="T:Cryville.Audio.Source.AudioSource" />s 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.Source.AudioSource)" />.</para>
<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>
@@ -558,6 +676,11 @@
</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>
@@ -578,7 +701,45 @@
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.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<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">
@@ -609,7 +770,7 @@
A session for <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" />.
</summary>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSession.Sequence(System.Double,Cryville.Audio.Source.AudioSource)">
<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>
@@ -618,11 +779,12 @@
<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.Source.AudioSource" /> that generates single tone.
An <see cref="T:Cryville.Audio.AudioStream" /> that generates single tone.
</summary>
</member>
<member name="P:Cryville.Audio.Source.SingleToneAudioSource.Type">
@@ -791,47 +953,68 @@
The default wave format.
</summary>
</member>
<member name="M:Cryville.Audio.WaveFormat.Align(System.Double)">
<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.Unsigned8">
<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.Signed16">
<member name="F:Cryville.Audio.SampleFormat.S16">
<summary>
Signed 16-bit integer sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Signed24">
<member name="F:Cryville.Audio.SampleFormat.S24">
<summary>
Signed 24-bit integer sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Signed32">
<member name="F:Cryville.Audio.SampleFormat.S32">
<summary>
Signed 32-bit integer sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Binary32">
<member name="F:Cryville.Audio.SampleFormat.F32">
<summary>
IEEE 754 single precision floating-point sample format.
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Binary64">
<member name="F:Cryville.Audio.SampleFormat.F64">
<summary>
IEEE 754 double precision floating-point sample format.
</summary>
@@ -841,6 +1024,9 @@
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.

544
Assets/Plugins/Cryville.Audio.xml
View File

@@ -58,6 +58,11 @@
客户端是否正在播放。
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.Muted">
<summary>
客户端是否被静音。
</summary>
</member>
<member name="P:Cryville.Audio.AudioClient.Position">
<summary>
设备流的当前位置（秒）。
@@ -78,9 +83,13 @@
获取设备是否支持 <paramref name="format" />。
</summary>
<param name="format">指定的波形格式。</param>
<param name="suggestion">设备建议的波形格式。如果设备支持 <paramref name="format" /> 则直接返回该参数。如果设备不支持任何格式则返回 <see langword="null" />。</param>
<param name="suggestion">
设备建议的波形格式。如果设备支持 <paramref name="format" /> 则直接返回该参数。如果设备不支持任何格式则返回 <see langword="null" />。
</param>
<param name="shareMode">共享模式。</param>
<returns>设备是否支持 <paramref name="format" />。</returns>
<returns>
设备是否支持 <paramref name="format" />。
</returns>
</member>
<member name="M:Cryville.Audio.AudioClient.Init(Cryville.Audio.WaveFormat,System.Single,Cryville.Audio.AudioShareMode)">
<summary>
@@ -123,6 +132,87 @@
</summary>
<remarks>初始化独占模式下的连接需要设备支持，且该设备当前未被占用。</remarks>
</member>
<member name="T:Cryville.Audio.AudioStream">
<summary>
音频流。
</summary>
</member>
<member name="P:Cryville.Audio.AudioStream.Format">
<summary>
波形格式。
</summary>
</member>
<member name="P:Cryville.Audio.AudioStream.BufferSize">
<summary>
缓存大小（字节）。
</summary>
</member>
<member name="P:Cryville.Audio.AudioStream.EndOfData">
<summary>
音频流是否到达了数据末尾。
</summary>
</member>
<member name="M:Cryville.Audio.AudioStream.SetFormat(Cryville.Audio.WaveFormat,System.Int32)">
<summary>
设置音频流的波形格式和缓存大小。
</summary>
<param name="format">波形格式。</param>
<param name="bufferSize">缓存大小（字节）。</param>
<exception cref="T:System.InvalidOperationException">该方法在当前音频流上已被成功调用过一次。</exception>
<exception cref="T:System.NotSupportedException">
音频流不支持 <paramref name="format" />。
</exception>
</member>
<member name="M:Cryville.Audio.AudioStream.OnSetFormat">
<summary>
当波形格式和缓存大小被设置时被调用。
</summary>
</member>
<member name="M:Cryville.Audio.AudioStream.IsFormatSupported(Cryville.Audio.WaveFormat)">
<summary>
获取音频流是否支持 <paramref name="format" />。
</summary>
<param name="format">波形格式。</param>
</member>
<member name="M:Cryville.Audio.AudioStream.SeekTime(System.Double,System.IO.SeekOrigin)">
<summary>
设置当前音频流的时间。
</summary>
<param name="offset">
相对于 <paramref name="origin" /> 参数的偏移（秒）。
</param>
<param name="origin">
<see cref="T:System.IO.SeekOrigin" /> 类型的一个值，指定用于获取新时间的参考点。
</param>
<returns>当前音频流的新时间（秒）。</returns>
</member>
<member name="M:Cryville.Audio.AudioStream.SetDuration(System.Double)">
<summary>
设置当前音频流的时长。
</summary>
<param name="value">时长（秒）。</param>
</member>
<member name="P:Cryville.Audio.AudioStream.Duration">
<summary>
音频流的时长（秒）。
</summary>
</member>
<member name="P:Cryville.Audio.AudioStream.Time">
<summary>
当前音频流的时间（秒）。
</summary>
</member>
<member name="M:Cryville.Audio.AudioStream.SilentBuffer(Cryville.Audio.WaveFormat,System.Byte[],System.Int32,System.Int32)">
<summary>
将静音填充到缓存。
</summary>
<param name="format">波形格式。</param>
<param name="buffer">被填充的缓存。</param>
<param name="offset">
<paramref name="buffer" /> 中开始填充处的索引（字节）。
</param>
<param name="count">需要填充的长度（字节）。</param>
</member>
<member name="T:Cryville.Audio.DataFlow">
<summary>
音频连接的数据流向。
@@ -157,7 +247,9 @@
<summary>
创建一个推荐的 <see cref="T:Cryville.Audio.IAudioDeviceManager" />。
</summary>
<returns>一个推荐的 <see cref="T:Cryville.Audio.IAudioDeviceManager" />。如果没有支持的引擎则返回 <see langword="null" />。</returns>
<returns>
一个推荐的 <see cref="T:Cryville.Audio.IAudioDeviceManager" />。如果没有支持的引擎则返回 <see langword="null" />。
</returns>
</member>
<member name="T:Cryville.Audio.IAudioDevice">
<summary>
@@ -178,7 +270,9 @@
<summary>
连接到设备。
</summary>
<returns>一个用于与设备交互的 <see cref="T:Cryville.Audio.AudioClient" />。</returns>
<returns>
一个用于与设备交互的 <see cref="T:Cryville.Audio.AudioClient" />。
</returns>
</member>
<member name="T:Cryville.Audio.IAudioDeviceManager">
<summary>
@@ -232,9 +326,6 @@
<summary>
一个与 OpenSL ES 交互的 <see cref="T:Cryville.Audio.AudioClient" />。
</summary>
<remarks>
如果使用了 AOT，参见 <see cref="P:Cryville.Audio.OpenSL.OutputClient.CallbackFunction" />。
</remarks>
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Finalize">
<inheritdoc />
@@ -269,21 +360,6 @@
<member name="P:Cryville.Audio.OpenSL.OutputClient.BufferPosition">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.OpenSL.OutputClient.CallbackFunction">
<summary>
缓存队列回调函数。
</summary>
<remarks>
<para>在使用了 AOT 的情况下，应当用一个支持 AOT 的函数覆盖该属性。覆盖的函数应当调用 <see cref="M:Cryville.Audio.OpenSL.OutputClient.Callback(System.IntPtr,System.IntPtr)" />，如下面这个代码片段所示：</para>
<code>
[MonoPInvokeCallback(typeof(slBufferQueueCallback))]
static void AOTCallback(IntPtr caller, IntPtr context) {
OutputClient.Callback(caller, context);
}
</code>
<para>其它情况下，不应当覆盖默认回调函数。</para>
</remarks>
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Init(Cryville.Audio.WaveFormat,System.Single,Cryville.Audio.AudioShareMode)">
<inheritdoc />
</member>
@@ -296,11 +372,6 @@
<member name="M:Cryville.Audio.OpenSL.OutputClient.Start">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.OpenSL.OutputClient.Callback(System.IntPtr,System.IntPtr)">
<summary>
See <see cref="P:Cryville.Audio.OpenSL.OutputClient.CallbackFunction" />.
</summary>
</member>
<member name="T:Cryville.Audio.OpenSL.OutputDevice">
<summary>
一个与 OpenSL ES 交互的 <see cref="T:Cryville.Audio.IAudioDevice" />。
@@ -327,102 +398,32 @@
<member name="M:Cryville.Audio.OpenSL.OutputDevice.Connect">
<inheritdoc />
</member>
<member name="T:Cryville.Audio.Source.AudioSource">
<summary>
提供波形数据的音频源。
</summary>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.Dispose">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.AudioSource.Dispose(System.Boolean)">
<summary>
执行与释放或重置非托管资源关联的应用程序定义的任务。
</summary>
<param name="disposing">该方法是否由用户调用。</param>
</member>
<member name="P:Cryville.Audio.Source.AudioSource.Muted">
<summary>
音频源是否被静音。
</summary>
</member>
<member name="P:Cryville.Audio.Source.AudioSource.Format">
<summary>
输出波形格式。
</summary>
</member>
<member name="P:Cryville.Audio.Source.AudioSource.BufferSize">
<summary>
缓存大小（字节）。
</summary>
</member>
<member name="P:Cryville.Audio.Source.AudioSource.EndOfData">
<summary>
音频源是否到达了数据末尾。
</summary>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.OnSetFormat">
<summary>
当波形格式和缓存大小被设置时被调用。
</summary>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.IsFormatSupported(Cryville.Audio.WaveFormat)">
<summary>
获取音频源是否支持 <paramref name="format" />。
</summary>
<param name="format">波形格式。</param>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<summary>
将 <see cref="T:Cryville.Audio.AudioClient" /> 请求的波形数据填充到缓存。
</summary>
<param name="buffer">被填充的缓存。</param>
<param name="offset"><paramref name="buffer" /> 中开始填充处的索引（字节）。</param>
<param name="length">需要填充的长度（字节）。</param>
<remarks>
出于性能优化，调用者必须确保 <paramref name="buffer" /> 不为 <see langword="null" /> 且 <paramref name="length" /> 不大于 <paramref name="buffer" /> 的长度。
</remarks>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.SilentBuffer(System.Byte[],System.Int32,System.Int32)">
<summary>
将静音填充到缓存。
</summary>
<param name="buffer">被填充的缓存。</param>
<param name="offset"><paramref name="buffer" /> 中开始填充处的索引（字节）。</param>
<param name="length">需要填充的长度（字节）。</param>
<remarks>
出于性能优化，调用者必须确保 <paramref name="buffer" /> 不为 <see langword="null" /> 且 <paramref name="length" /> 不大于 <paramref name="buffer" /> 的长度。
</remarks>
</member>
<member name="M:Cryville.Audio.Source.AudioSource.SilentBuffer(Cryville.Audio.WaveFormat,System.Byte[],System.Int32,System.Int32)">
<summary>
将静音填充到缓存。
</summary>
<param name="format">波形格式。</param>
<param name="buffer">被填充的缓存。</param>
<param name="offset"><paramref name="buffer" /> 中开始填充处的索引（字节）。</param>
<param name="length">需要填充的长度（字节）。</param>
<remarks>
出于性能优化，调用者必须确保 <paramref name="buffer" /> 不为 <see langword="null" /> 且 <paramref name="length" /> 不大于 <paramref name="buffer" /> 的长度。
</remarks>
</member>
<member name="T:Cryville.Audio.Source.CachedAudioSource">
<summary>
一个缓存数据并对其进行复用的 <see cref="T:Cryville.Audio.Source.AudioSource" />。
一个缓存数据并对其进行复用的 <see cref="T:Cryville.Audio.AudioStream" />。
</summary>
<remarks>
<para>
该流不支持定位。可以通过调用 <see cref="M:Cryville.Audio.Source.CachedAudioSource.Rewind" /> 重置其时间戳。
</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.#ctor(Cryville.Audio.Source.AudioSource,System.Double)">
<member name="M:Cryville.Audio.Source.CachedAudioSource.#ctor(Cryville.Audio.AudioStream,System.Double)">
<summary>
创建一个 <see cref="T:Cryville.Audio.Source.CachedAudioSource" /> 类的实例。
</summary>
<param name="source">被缓存的 <see cref="T:Cryville.Audio.Source.AudioSource" />。</param>
<param name="source">
被缓存的 <see cref="T:Cryville.Audio.AudioStream" />。
</param>
<param name="duration">缓存长度（秒）。</param>
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.Clone">
<summary>
获取一个时间戳归零的该 <see cref="T:Cryville.Audio.Source.CachedAudioSource" /> 的副本。
</summary>
<returns>一个时间戳归零的该 <see cref="T:Cryville.Audio.Source.CachedAudioSource" /> 的副本。</returns>
<returns>
一个时间戳归零的该 <see cref="T:Cryville.Audio.Source.CachedAudioSource" /> 的副本。
</returns>
<remarks>
推荐配合对象池使用。
</remarks>
@@ -438,6 +439,11 @@
<member name="P:Cryville.Audio.Source.CachedAudioSource.EndOfData">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.CachedAudioSource.Disposed">
<summary>
该音频流是否已被释放。
</summary>
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.Dispose(System.Boolean)">
<inheritdoc />
</member>
@@ -447,12 +453,39 @@
<member name="M:Cryville.Audio.Source.CachedAudioSource.OnSetFormat">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.CachedAudioSource.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<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>
一个以给定函数生成波形数据的 <see cref="T:Cryville.Audio.Source.AudioSource" />。
一个以给定函数生成波形数据的 <see cref="T:Cryville.Audio.AudioStream" />。
</summary>
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.Channels">
@@ -460,16 +493,24 @@
输出波形格式的声道数。
</summary>
</member>
<member name="M:Cryville.Audio.Source.FunctionAudioSource.Dispose(System.Boolean)">
<member name="P:Cryville.Audio.Source.FunctionAudioSource.EndOfData">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.FunctionAudioSource.EndOfData">
<member name="P:Cryville.Audio.Source.FunctionAudioSource.Disposed">
<summary>
该音频流是否已被释放。
</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.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<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)">
@@ -479,13 +520,37 @@
<param name="time">时间（秒）。</param>
<param name="channel">声道索引。</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>
一个使用 Libav 解流并解码音频文件的 <see cref="T:Cryville.Audio.Source.AudioSource" />。
一个使用 Libav 解流并解码音频文件的 <see cref="T:Cryville.Audio.AudioStream" />。
</summary>
<remarks>
播放前必须调用 <see cref="M:Cryville.Audio.Source.LibavFileAudioSource.SelectStream" /> 或 <see cref="M:Cryville.Audio.Source.LibavFileAudioSource.SelectStream(System.Int32)" /> 以选择一个音频流。
</remarks>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.#ctor(System.String)">
<summary>
@@ -493,6 +558,11 @@
</summary>
<param name="file">音频文件。</param>
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Disposed">
<summary>
该音频流是否已被释放。
</summary>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.Dispose(System.Boolean)">
<inheritdoc />
</member>
@@ -513,50 +583,147 @@
<summary>
选择最佳音频流作为音频源。
</summary>
<exception cref="T:System.InvalidOperationException">已选择音频流。</exception>
<remarks>
<para>
该方法只能在 <see cref="M:Cryville.Audio.AudioStream.SetFormat(Cryville.Audio.WaveFormat,System.Int32)" /> 被调用前调用，后者会在设置 <see cref="P:Cryville.Audio.AudioClient.Source" /> 时被调用。
</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.SelectStream(System.Int32)">
<summary>
选择一个音频流作为音频源。
</summary>
<param name="index">音频流的索引。</param>
<exception cref="T:System.InvalidOperationException">已选择音频流。</exception>
<remarks>
<para>
该方法只能在 <see cref="M:Cryville.Audio.AudioStream.SetFormat(Cryville.Audio.WaveFormat,System.Int32)" /> 被调用前调用，后者会在设置 <see cref="P:Cryville.Audio.AudioClient.Source" /> 时被调用。
</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.GetDuration(System.Int32)">
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.GetStreamDuration(System.Int32)">
<summary>
获取一个流或当前文件的长度。
获取一个流或当前文件的时长。
</summary>
<param name="streamId">流索引。如果指定 <c>-1</c> 则返回文件的长度。</param>
<returns>长度（秒）。</returns>
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.OnSetFormat">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.Source.LibavFileAudioSource.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<inheritdoc />
<param name="streamId">
流索引。如果指定 <c>-1</c> 则返回文件的时长。
</param>
<returns>时长（秒）。</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>该属性可能不准确。</para>
</remarks>
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Duration">
<inheritdoc />
<remarks>
<para>该属性可能不准确。</para>
</remarks>
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Time">
<inheritdoc />
</member>
<member name="P:Cryville.Audio.Source.LibavFileAudioSource.Position">
<inheritdoc />
<remarks>
<para>
该属性在调用 <see cref="M:Cryville.Audio.Source.LibavFileAudioSource.Seek(System.Int64,System.IO.SeekOrigin)" /> 后可能不准确。
</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>
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>
一个对序列中的音频源进行混音的简单 <see cref="T:Cryville.Audio.Source.AudioSource" />。
一个对序列中的音频源进行混音的简单 <see cref="T:Cryville.Audio.AudioStream" />。
</summary>
<remarks>
<para>使用该类可参照以下步骤：</para>
<list type="number">
<item>创建一个 <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" /> 类的实例。</item>
<item>通过设置 <see cref="P:Cryville.Audio.AudioClient.Source" /> 将 <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" /> 绑定到一个 <see cref="T:Cryville.Audio.AudioClient" />。</item>
<item>调用 <see cref="M:Cryville.Audio.Source.SimpleSequencerSource.NewSession" /> 创建一个新的 <see cref="T:Cryville.Audio.Source.SimpleSequencerSession" />。</item>
<item>调用 <see cref="M:Cryville.Audio.AudioClient.Start" /> 并将 <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.Playing" /> 设为 <see langword="true" /> 开始播放。</item>
<item>
创建一个 <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" /> 类的实例。
</item>
<item>
通过设置 <see cref="P:Cryville.Audio.AudioClient.Source" /> 将 <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" /> 绑定到一个 <see cref="T:Cryville.Audio.AudioClient" />。
</item>
<item>
调用 <see cref="M:Cryville.Audio.Source.SimpleSequencerSource.NewSession" /> 创建一个新的 <see cref="T:Cryville.Audio.Source.SimpleSequencerSession" />。
</item>
<item>
调用 <see cref="M:Cryville.Audio.AudioClient.Start" /> 并将 <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.Playing" /> 设为 <see langword="true" /> 开始播放。
</item>
</list>
<para>播放开始前后都可以将 <see cref="T:Cryville.Audio.Source.AudioSource" /> 序列至 <see cref="T:Cryville.Audio.Source.SimpleSequencerSession" />。参见 <see cref="M:Cryville.Audio.Source.SimpleSequencerSession.Sequence(System.Double,Cryville.Audio.Source.AudioSource)" />。</para>
<para>如果 <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.Playing" /> 被设为 <see langword="false" />，输出将变为静音。</para>
<para>
播放开始前后都可以将 <see cref="T:Cryville.Audio.AudioStream" /> 序列至 <see cref="T:Cryville.Audio.Source.SimpleSequencerSession" />。参见 <see cref="M:Cryville.Audio.Source.SimpleSequencerSession.Sequence(System.Double,Cryville.Audio.AudioStream)" />。
</para>
<para>
如果 <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.Playing" /> 被设为 <see langword="false" />，输出将变为静音。
</para>
</remarks>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.#ctor(System.Int32)">
<summary>
创建一个 <see cref="T:Cryville.Audio.Source.SimpleSequencerSource" /> 类的实例。
</summary>
<param name="maxPolyphony">序列器的最大复音数。必须大于 0。参见 <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.MaxPolyphony"/>。</param>
<param name="maxPolyphony">
序列器的最大复音数。必须大于 0。参见 <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.MaxPolyphony"/>。
</param>
</member>
<member name="P:Cryville.Audio.Source.SimpleSequencerSource.Disposed">
<summary>
该音频流是否已被释放。
</summary>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.Dispose(System.Boolean)">
<inheritdoc />
@@ -578,7 +745,53 @@
播放状态切换时有一个小延迟，大约是 <see cref="P:Cryville.Audio.AudioClient.BufferPosition" /> 减去 <see cref="P:Cryville.Audio.AudioClient.Position" />。
</remarks>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSource.FillBuffer(System.Byte[],System.Int32,System.Int32)">
<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">相对于当前位置的偏移。</param>
<param name="origin">
必须为 <see cref="F:System.IO.SeekOrigin.Current" />。
</param>
<remarks>
<para>
该流只能从当前位置开始向后定位，因此，<paramref name="offset" /> 必须为非负数，且 <paramref name="origin" /> 必须为 <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>
该流只能从当前位置开始向后定位。参见 <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>
虽然该流支持定位，但是不支持设置该属性，否则会抛出 <see cref="T:System.NotSupportedException" />。该流只能从当前位置开始向后定位。参见 <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">
@@ -609,20 +822,25 @@
<see cref="T:Cryville.Audio.Source.SimpleSequencerSource" /> 的会话。
</summary>
</member>
<member name="M:Cryville.Audio.Source.SimpleSequencerSession.Sequence(System.Double,Cryville.Audio.Source.AudioSource)">
<member name="M:Cryville.Audio.Source.SimpleSequencerSession.Sequence(System.Double,Cryville.Audio.AudioStream)">
<summary>
将 <paramref name="source" /> 序列至指定的 <paramref name="time" />。
</summary>
<param name="time">时间（秒）。</param>
<param name="source">音频源。</param>
<remarks>
<para>如果 <paramref name="time" /> 小于当前时间，<paramref name="source" /> 将被立刻播放。</para>
<para>如果正在播放的音频源数量超过了 <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.MaxPolyphony" />，<paramref name="source" /> 将被丢弃。</para>
<para>
如果 <paramref name="time" /> 小于当前时间，<paramref name="source" /> 将被立刻播放。
</para>
<para>
如果正在播放的音频源数量超过了 <see cref="P:Cryville.Audio.Source.SimpleSequencerSource.MaxPolyphony" />，<paramref name="source" /> 将被丢弃。
</para>
<para>即使序列器被释放了，仍然可以序列音频源，虽然不会有任何效果。</para>
</remarks>
</member>
<member name="T:Cryville.Audio.Source.SingleToneAudioSource">
<summary>
一个生成单调声调的 <see cref="T:Cryville.Audio.Source.AudioSource" />。
一个生成单调声调的 <see cref="T:Cryville.Audio.AudioStream" />。
</summary>
</member>
<member name="P:Cryville.Audio.Source.SingleToneAudioSource.Type">
@@ -709,7 +927,9 @@
初始化客户端。
</summary>
<param name="format">波形格式。</param>
<param name="bufferDuration">连接的缓存时长（毫秒）。如果该值太小，则其将被限制到 <see cref="P:Cryville.Audio.Wasapi.AudioClient.MinimumBufferDuration" />。如果 <paramref name="shareMode" /> 为 <see cref="F:Cryville.Audio.AudioShareMode.Shared" />，缓存时长将自动决定，且该参数无效。</param>
<param name="bufferDuration">
连接的缓存时长（毫秒）。如果该值太小，则其将被限制到 <see cref="P:Cryville.Audio.Wasapi.AudioClient.MinimumBufferDuration" />。如果 <paramref name="shareMode" /> 为 <see cref="F:Cryville.Audio.AudioShareMode.Shared" />，缓存时长将自动决定，且该参数无效。
</param>
<param name="shareMode">连接的共享模式。</param>
</member>
<member name="M:Cryville.Audio.Wasapi.AudioClient.Start">
@@ -791,47 +1011,68 @@
默认波形格式。
</summary>
</member>
<member name="M:Cryville.Audio.WaveFormat.Align(System.Double)">
<member name="M:Cryville.Audio.WaveFormat.Align(System.Double,System.Boolean)">
<summary>
获取对齐的缓存大小。
</summary>
<param name="size">需要的缓存大小（字节）。</param>
<param name="floored">结果被向下还是向上取整。</param>
<returns>对齐的缓存大小（字节）。</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>
样本格式。
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Unsigned8">
<member name="F:Cryville.Audio.SampleFormat.Invalid">
<summary>
无效样本格式。
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.U8">
<summary>
无符号 8 位整型样本格式。
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Signed16">
<member name="F:Cryville.Audio.SampleFormat.S16">
<summary>
有符号 16 位整型样本格式。
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Signed24">
<member name="F:Cryville.Audio.SampleFormat.S24">
<summary>
有符号 24 位整型样本格式。
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Signed32">
<member name="F:Cryville.Audio.SampleFormat.S32">
<summary>
有符号 32 位整型样本格式。
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Binary32">
<member name="F:Cryville.Audio.SampleFormat.F32">
<summary>
IEEE 754 单精度浮点型样本格式。
</summary>
</member>
<member name="F:Cryville.Audio.SampleFormat.Binary64">
<member name="F:Cryville.Audio.SampleFormat.F64">
<summary>
IEEE 754 双精度浮点型样本格式。
</summary>
@@ -841,6 +1082,9 @@
一个与 WinMM 交互的 <see cref="T:Cryville.Audio.AudioClient" />。
</summary>
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutClient.Finalize">
<inheritdoc />
</member>
<member name="M:Cryville.Audio.WinMM.WaveOutClient.Dispose(System.Boolean)">
<summary>
执行与释放或重置非托管资源关联的应用程序定义的任务。

BIN
Assets/Plugins/Windows/Cryville.Audio.WasapiWrapper.dll
View File

Binary file not shown.