Discard unused docs.
This commit is contained in:
@@ -1,137 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cryville.Audio.Source.Libav</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cryville.Audio.Source.Libav.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.Libav.LibavFileAudioSource.#ctor(System.String)">
|
||||
<summary>
|
||||
Creates an instance of the <see cref="T:Cryville.Audio.Source.Libav.LibavFileAudioSource" /> class and loads the specified <paramref name="file" />.
|
||||
</summary>
|
||||
<param name="file">The audio file.</param>
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.Disposed">
|
||||
<summary>
|
||||
Whether this audio stream has been disposed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavFileAudioSource.Dispose(System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.EndOfData">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.BestStreamIndex">
|
||||
<summary>
|
||||
The index to the best audio stream.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.Streams">
|
||||
<summary>
|
||||
The collection of indices to all audio streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.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.Libav.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.Libav.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.Libav.LibavFileAudioSource.IsFormatSupported(Cryville.Audio.WaveFormat)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavFileAudioSource.OnSetFormat">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavFileAudioSource.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavFileAudioSource.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavFileAudioSource.SeekTime(System.Double,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.CanRead">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.CanSeek">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.CanWrite">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.Length">
|
||||
<inheritdoc />
|
||||
<remarks>
|
||||
<para>This property may be inaccurate.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.Duration">
|
||||
<inheritdoc />
|
||||
<remarks>
|
||||
<para>This property may be inaccurate.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.Time">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.Source.Libav.LibavFileAudioSource.Position">
|
||||
<inheritdoc />
|
||||
<remarks>
|
||||
<para>This property may become inaccurate after <see cref="M:Cryville.Audio.Source.Libav.LibavFileAudioSource.Seek(System.Int64,System.IO.SeekOrigin)" /> is called.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavFileAudioSource.Flush">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavFileAudioSource.SetLength(System.Int64)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavFileAudioSource.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Cryville.Audio.Source.Libav.LibavException">
|
||||
<summary>
|
||||
The exception that is thrown by Libav.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavException.#ctor">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavException.#ctor(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavException.#ctor(System.String,System.Exception)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.Source.Libav.LibavException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,7 +0,0 @@
|
||||
fileFormatVersion: 2
|
||||
guid: efcc1363031f00e48bcf23b46c092deb
|
||||
TextScriptImporter:
|
||||
externalObjects: {}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -1,715 +0,0 @@
|
||||
<?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.Format">
|
||||
<summary>
|
||||
The current wave format of the connection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.AudioClient.BufferSize">
|
||||
<summary>
|
||||
The buffer size in frames.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.AudioClient.MaximumLatency">
|
||||
<summary>
|
||||
The maximum latency of the connection in milliseconds.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>May be zero if the API does not provide this value.</para>
|
||||
</remarks>
|
||||
</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.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 frames.
|
||||
</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 frames.</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.None">
|
||||
<summary>
|
||||
None.
|
||||
</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 <see cref="T:Cryville.Audio.IAudioDeviceManager" /> in the <see cref="F:Cryville.Audio.EngineBuilder.Engines" /> list.
|
||||
</summary>
|
||||
<returns>The first <see cref="T:Cryville.Audio.IAudioDeviceManager" /> that can be successfully created. <see langword="null" /> if no engine is supported.</returns>
|
||||
<remarks>
|
||||
<para>Add engines to <see cref="F:Cryville.Audio.EngineBuilder.Engines" /> before calling this method.</para>
|
||||
</remarks>
|
||||
</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="P:Cryville.Audio.IAudioDevice.BurstSize">
|
||||
<summary>
|
||||
The burst size of the device in frames.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.IAudioDevice.MinimumBufferSize">
|
||||
<summary>
|
||||
The minimum buffer size of the device in frames.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.IAudioDevice.DefaultBufferSize">
|
||||
<summary>
|
||||
The default buffer size of the device in frames.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Audio.IAudioDevice.DefaultFormat">
|
||||
<summary>
|
||||
The default wave format of the device for shared-mode streams.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>For exclusive-mode streams, call <see cref="M:Cryville.Audio.IAudioDevice.IsFormatSupported(Cryville.Audio.WaveFormat,System.Nullable{Cryville.Audio.WaveFormat}@,Cryville.Audio.AudioShareMode)" /> to determine an eligible format.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Cryville.Audio.IAudioDevice.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.IAudioDevice.Connect(Cryville.Audio.WaveFormat,System.Int32,Cryville.Audio.AudioShareMode)">
|
||||
<summary>
|
||||
Connects to the device.
|
||||
</summary>
|
||||
<param name="format">The wave format.</param>
|
||||
<param name="bufferSize">The buffer size of the connection in frames.</param>
|
||||
<param name="shareMode">The share mode of the connection.</param>
|
||||
<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.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.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.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 channel per second, i.e. frames 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.FrameSize">
|
||||
<summary>
|
||||
Bytes per frame.
|
||||
</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>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,7 +0,0 @@
|
||||
fileFormatVersion: 2
|
||||
guid: d492df7f0ed32114ab66518c24c65a52
|
||||
TextScriptImporter:
|
||||
externalObjects: {}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -1,559 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cryville.Input</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cryville.Input.InputEvent">
|
||||
<summary>
|
||||
Input event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputEvent.Identifier">
|
||||
<summary>
|
||||
The input identifier.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputEvent.From">
|
||||
<summary>
|
||||
The input frame last received.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputEvent.To">
|
||||
<summary>
|
||||
The new input frame received.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputEvent.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Cryville.Input.InputFrameHandler">
|
||||
<summary>
|
||||
Represents the method that will handle the <see cref="E:Cryville.Input.InputHandler.OnInput" /> event.
|
||||
</summary>
|
||||
<param name="identifier">The input identifier of <paramref name="frame" />.</param>
|
||||
<param name="frame">The new input frame.</param>
|
||||
</member>
|
||||
<member name="T:Cryville.Input.InputBatchHandler">
|
||||
<summary>
|
||||
Represents the method that will handle the <see cref="E:Cryville.Input.InputHandler.OnBatch" /> event.
|
||||
</summary>
|
||||
<param name="handler">The input handler.</param>
|
||||
<param name="time">The timestamp of the batch in seconds.</param>
|
||||
</member>
|
||||
<member name="T:Cryville.Input.InputHandler">
|
||||
<summary>
|
||||
Input handler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="E:Cryville.Input.InputHandler.OnInput">
|
||||
<summary>
|
||||
Occurs when a new input frame is sent.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>There is no guarantee that frames are sent in the time order.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="E:Cryville.Input.InputHandler.OnBatch">
|
||||
<summary>
|
||||
Occurs when an input batch is finished sending.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>This event occurs when the device can guarantee that all the active identifiers have sent all their frames before the given timestamp. There may be input frames with later timestamps sent before this event occurs. If an input identifier does not appears between two subsequent <see cref="E:Cryville.Input.InputHandler.OnBatch" /> events, then there is no update on it.</para>
|
||||
<para>However, there is no guarantee that this event will occur when no input identifier is active.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputHandler.Finalize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputHandler.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputHandler.Activate">
|
||||
<summary>
|
||||
Activates the input handler and starts receiving new input frames.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputHandler.Deactivate">
|
||||
<summary>
|
||||
Deactivates the input handler and stops receiving new input frames.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputHandler.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||||
</summary>
|
||||
<param name="disposing">Whether disposing or finalizing.</param>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputHandler.IsNullable">
|
||||
<summary>
|
||||
Whether null input frames may be sent by the input handler.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>See <see cref="P:Cryville.Input.InputFrame.IsNull" /> for more information.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputHandler.Dimension">
|
||||
<summary>
|
||||
The dimension of the vectors sent by the input handler.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>Dimension must be an integer from 0 (inclusive) to 4 (inclusive.) The components of the <see cref="T:Cryville.Input.InputVector" /> whose indices are beyond the dimension should be set to 0.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputHandler.ReferenceCue">
|
||||
<summary>
|
||||
The reference cue for the vectors sent by the input handler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputHandler.GetTypeName(System.Int32)">
|
||||
<summary>
|
||||
Gets the friendly name of the specified type.
|
||||
</summary>
|
||||
<param name="type">The type.</param>
|
||||
<returns>The friendly name of the specified type.</returns>
|
||||
<remarks>
|
||||
<para>See <see cref="P:Cryville.Input.InputSource.Type"/> for more information.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputHandler.GetCurrentTimestamp">
|
||||
<summary>
|
||||
Gets the current timestamp of the input handler.
|
||||
</summary>
|
||||
<returns>The current timestamp of the input handler in seconds.</returns>
|
||||
<remarks>
|
||||
<para>The timestamp returned by this method is obtained from the same source as the <see cref="P:Cryville.Input.InputFrame.Time" /> of the frame the handler sends whenever possible. However, there is no guarantee that, when calling this method, all the frames whose <see cref="P:Cryville.Input.InputFrame.Time" /> is less than the timestamp returned by this method have been sent.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputHandler.Feed(System.Int32,System.Int32,Cryville.Input.InputFrame)">
|
||||
<summary>
|
||||
Sends a new input frame.
|
||||
</summary>
|
||||
<param name="type">The type of the input frame.</param>
|
||||
<param name="id">The ID of the input frame.</param>
|
||||
<param name="frame">The input frame.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputHandler.Batch(System.Double)">
|
||||
<summary>
|
||||
Marks the end of an input batch.
|
||||
</summary>
|
||||
<param name="time">The timestamp of the input batch in seconds.</param>
|
||||
<remarks>
|
||||
<para>See <see cref="E:Cryville.Input.InputHandler.OnBatch" /> for more information.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Cryville.Input.InputIdentifier">
|
||||
<summary>
|
||||
Input identifier.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputIdentifier.Source">
|
||||
<summary>
|
||||
The input source.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputIdentifier.Id">
|
||||
<summary>
|
||||
The input ID.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>This property is used to distinguish different inputs on the input source. For example, a touch screen that supports simultaneous touches may assign a unique ID to each finger.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputIdentifier.Equals(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputIdentifier.Equals(Cryville.Input.InputIdentifier)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputIdentifier.GetHashCode">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputIdentifier.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputIdentifier.op_Equality(Cryville.Input.InputIdentifier,Cryville.Input.InputIdentifier)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputIdentifier.op_Inequality(Cryville.Input.InputIdentifier,Cryville.Input.InputIdentifier)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Cryville.Input.InputManager">
|
||||
<summary>
|
||||
Input manager.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cryville.Input.InputManager.HandlerRegistries">
|
||||
<summary>
|
||||
A set of handler types to be initialized.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputManager.#ctor">
|
||||
<summary>
|
||||
Creates an instance of the <see cref="T:Cryville.Input.InputManager" /> class and tries to initialize all the handlers in <see cref="F:Cryville.Input.InputManager.HandlerRegistries" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputManager.GetHandlerByTypeName(System.String)">
|
||||
<summary>
|
||||
Gets the handler with the specified type name.
|
||||
</summary>
|
||||
<param name="typeName">The type name.</param>
|
||||
<returns>The handler with the specified type name. <see langword="null" /> if not found or not initialized.</returns>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputManager.EnumerateHandlers(System.Action{Cryville.Input.InputHandler})">
|
||||
<summary>
|
||||
Enumerates all initialized handlers and passes each of them into a callback function.
|
||||
</summary>
|
||||
<param name="cb">The callback function.</param>
|
||||
</member>
|
||||
<member name="T:Cryville.Input.InputSource">
|
||||
<summary>
|
||||
Input source.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputSource.Handler">
|
||||
<summary>
|
||||
The input handler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputSource.Type">
|
||||
<summary>
|
||||
The type of the input source as an identifier of a component of the input handler.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>This property is used to distinguish different components of the input handler. For example, each key on the keyboard is assigned a unique type number. Use <see cref="M:Cryville.Input.InputHandler.GetTypeName(System.Int32)" /> to get a friendly name of a specific type.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputSource.Equals(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputSource.Equals(Cryville.Input.InputSource)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputSource.GetHashCode">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputSource.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputSource.op_Equality(Cryville.Input.InputSource,Cryville.Input.InputSource)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputSource.op_Inequality(Cryville.Input.InputSource,Cryville.Input.InputSource)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Cryville.Input.InputFrame">
|
||||
<summary>
|
||||
Input frame.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputFrame.Time">
|
||||
<summary>
|
||||
The timestamp in seconds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputFrame.IsNull">
|
||||
<summary>
|
||||
Whether the vector is null.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>An input frame with this property set to <see langword="true" /> marks the end of life of an input ID (see <see cref="P:Cryville.Input.InputIdentifier.Id" />.) This usually occurs when, for example, the button of the device is released.</para>
|
||||
<para>When this property is set to <see langword="true" />, all the components of <see cref="P:Cryville.Input.InputFrame.Vector" /> is meaningless and should be set to 0.</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputFrame.Vector">
|
||||
<summary>
|
||||
The input vector.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputFrame.#ctor(System.Double)">
|
||||
<summary>
|
||||
Creates an instance of the <see cref="T:Cryville.Input.InputFrame" /> struct with <see cref="P:Cryville.Input.InputFrame.IsNull" /> set to <see langword="true" />.
|
||||
</summary>
|
||||
<param name="time">The timestamp in seconds.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputFrame.#ctor(System.Double,Cryville.Input.InputVector)">
|
||||
<summary>
|
||||
Creates an instance of the <see cref="T:Cryville.Input.InputFrame" /> struct.
|
||||
</summary>
|
||||
<param name="time">The timestamp in seconds.</param>
|
||||
<param name="vector">The input vector.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputFrame.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Cryville.Input.InputVector">
|
||||
<summary>
|
||||
Input vector.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputVector.X">
|
||||
<summary>
|
||||
The first component of the vector.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputVector.Y">
|
||||
<summary>
|
||||
The second component of the vector.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputVector.Z">
|
||||
<summary>
|
||||
The third component of the vector.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.InputVector.W">
|
||||
<summary>
|
||||
The fourth component of the vector.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputVector.#ctor(System.Single)">
|
||||
<summary>
|
||||
Creates an instance of the <see cref="T:Cryville.Input.InputVector" /> struct of one dimension.
|
||||
</summary>
|
||||
<param name="x">The first component of the vector.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputVector.#ctor(System.Single,System.Single)">
|
||||
<summary>
|
||||
Creates an instance of the <see cref="T:Cryville.Input.InputVector" /> struct of two dimensions.
|
||||
</summary>
|
||||
<param name="x">The first component of the vector.</param>
|
||||
<param name="y">The second component of the vector.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputVector.#ctor(System.Single,System.Single,System.Single)">
|
||||
<summary>
|
||||
Creates an instance of the <see cref="T:Cryville.Input.InputVector" /> struct of three dimensions.
|
||||
</summary>
|
||||
<param name="x">The first component of the vector.</param>
|
||||
<param name="y">The second component of the vector.</param>
|
||||
<param name="z">The third component of the vector.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputVector.#ctor(System.Single,System.Single,System.Single,System.Single)">
|
||||
<summary>
|
||||
Creates an instance of the <see cref="T:Cryville.Input.InputVector" /> struct of four dimensions.
|
||||
</summary>
|
||||
<param name="x">The first component of the vector.</param>
|
||||
<param name="y">The second component of the vector.</param>
|
||||
<param name="z">The third component of the vector.</param>
|
||||
<param name="w">The fourth component of the vector.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputVector.op_Addition(Cryville.Input.InputVector,Cryville.Input.InputVector)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputVector.op_Subtraction(Cryville.Input.InputVector,Cryville.Input.InputVector)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputVector.op_Multiply(System.Single,Cryville.Input.InputVector)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputVector.op_UnaryNegation(Cryville.Input.InputVector)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.InputVector.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Cryville.Input.ReferenceCue">
|
||||
<summary>
|
||||
Provides cues about the frame of reference.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.ReferenceCue.PhysicalDimension">
|
||||
<summary>
|
||||
The physical dimension.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.ReferenceCue.RelativeUnit">
|
||||
<summary>
|
||||
The additional relative unit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.ReferenceCue.Flags">
|
||||
<summary>
|
||||
The reference flags.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.ReferenceCue.Origin">
|
||||
<summary>
|
||||
The origin.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.ReferenceCue.Pivot">
|
||||
<summary>
|
||||
The pivot.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.ReferenceCue.Transform(Cryville.Input.InputFrame)">
|
||||
<summary>
|
||||
Transforms a frame into the reference by applying the offset specified by <see cref="P:Cryville.Input.ReferenceCue.Origin" />.
|
||||
</summary>
|
||||
<param name="frame">The input frame.</param>
|
||||
<returns>The transformed input frame.</returns>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.ReferenceCue.InverseTransform(Cryville.Input.InputFrame)">
|
||||
<summary>
|
||||
Transforms a frame out of the reference by removing the offset specified by <see cref="P:Cryville.Input.ReferenceCue.Origin" />.
|
||||
</summary>
|
||||
<param name="frame">The input frame.</param>
|
||||
<returns>The transformed input frame.</returns>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.ReferenceCue.Transform(Cryville.Input.InputFrame,Cryville.Input.InputVector)">
|
||||
<summary>
|
||||
Transforms a frame into the reference by applying the offset specified by <see cref="P:Cryville.Input.ReferenceCue.Origin" /> and <see cref="P:Cryville.Input.ReferenceCue.Pivot" />.
|
||||
</summary>
|
||||
<param name="frame">The input frame.</param>
|
||||
<param name="universe">The universe size.</param>
|
||||
<returns>The transformed input frame.</returns>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.ReferenceCue.InverseTransform(Cryville.Input.InputFrame,Cryville.Input.InputVector)">
|
||||
<summary>
|
||||
Transforms a frame out of the reference by removing the offset specified by <see cref="P:Cryville.Input.ReferenceCue.Origin" /> and <see cref="P:Cryville.Input.ReferenceCue.Pivot" />.
|
||||
</summary>
|
||||
<param name="frame">The input frame.</param>
|
||||
<param name="universe">The universe size.</param>
|
||||
<returns>The transformed input frame.</returns>
|
||||
</member>
|
||||
<member name="T:Cryville.Input.PhysicalDimension">
|
||||
<summary>
|
||||
Physical dimension.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.PhysicalDimension.Time">
|
||||
<summary>
|
||||
The dimensions of time.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.PhysicalDimension.Length">
|
||||
<summary>
|
||||
The dimensions of length.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.PhysicalDimension.Mass">
|
||||
<summary>
|
||||
The dimensions of mass.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.PhysicalDimension.ElectricCurrent">
|
||||
<summary>
|
||||
The dimensions of electric current.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.PhysicalDimension.ThermodynamicTemperature">
|
||||
<summary>
|
||||
The dimensions of thermodynamic temperature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.PhysicalDimension.AmountOfSubstance">
|
||||
<summary>
|
||||
The dimensions of amount of substance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Cryville.Input.PhysicalDimension.LuminousIntensity">
|
||||
<summary>
|
||||
The dimensions of luminous intensity.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.PhysicalDimension.Equals(Cryville.Input.PhysicalDimension)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.PhysicalDimension.Equals(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.PhysicalDimension.GetHashCode">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.PhysicalDimension.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.PhysicalDimension.op_Equality(Cryville.Input.PhysicalDimension,Cryville.Input.PhysicalDimension)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cryville.Input.PhysicalDimension.op_Inequality(Cryville.Input.PhysicalDimension,Cryville.Input.PhysicalDimension)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Cryville.Input.RelativeUnit">
|
||||
<summary>
|
||||
Relative unit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cryville.Input.RelativeUnit.None">
|
||||
<summary>
|
||||
None.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cryville.Input.RelativeUnit.Pixel">
|
||||
<summary>
|
||||
Pixel.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cryville.Input.ReferenceFlag">
|
||||
<summary>
|
||||
Reference flag.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cryville.Input.ReferenceFlag.None">
|
||||
<summary>
|
||||
None.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cryville.Input.ReferenceFlag.FlipX">
|
||||
<summary>
|
||||
The X axis is flipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cryville.Input.ReferenceFlag.FlipY">
|
||||
<summary>
|
||||
The Y axis is flipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cryville.Input.ReferenceFlag.FlipZ">
|
||||
<summary>
|
||||
The Z axis is flipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cryville.Input.ReferenceFlag.FlipW">
|
||||
<summary>
|
||||
The W axis is flipped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cryville.Input.SimpleInputConsumer">
|
||||
<summary>
|
||||
A simple input consumer that receives input frames.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.SimpleInputConsumer.#ctor(Cryville.Input.InputManager)">
|
||||
<summary>
|
||||
Creates an instance of the <see cref="T:Cryville.Input.SimpleInputConsumer" /> class.
|
||||
</summary>
|
||||
<param name="manager">The input manager.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.SimpleInputConsumer.Activate">
|
||||
<summary>
|
||||
Activates all the input handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.SimpleInputConsumer.Deactivate">
|
||||
<summary>
|
||||
Deactivates all the input handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.SimpleInputConsumer.OnInput(Cryville.Input.InputIdentifier,Cryville.Input.InputFrame)">
|
||||
<summary>
|
||||
Called when a new input frame is received.
|
||||
</summary>
|
||||
<param name="identifier">The input identifier.</param>
|
||||
<param name="frame">The new input frame.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.SimpleInputConsumer.EnumerateEvents(System.Action{Cryville.Input.InputEvent})">
|
||||
<summary>
|
||||
Enumerates all the input events in the queue, passes each of them into the given callback function, and then flushes the queue.
|
||||
</summary>
|
||||
<param name="cb">The callback function.</param>
|
||||
</member>
|
||||
<member name="M:Cryville.Input.SimpleInputConsumer.EnumerateActiveIdentifiers(System.Action{Cryville.Input.InputIdentifier,Cryville.Input.InputFrame})">
|
||||
<summary>
|
||||
Enumerates all the active identifiers and passes each of them into the given callback function with its current frame.
|
||||
</summary>
|
||||
<param name="cb">The callback function.</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,7 +0,0 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 26d2baa850dc4bb4db5489359d92b61b
|
||||
TextScriptImporter:
|
||||
externalObjects: {}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
Reference in New Issue
Block a user