SharpDX.Toolkit.Audio

The assembly provides support for loading audio files through the and playing them.

Base class for reading audio content.

The audio asset type.

Reads the content and performs any common precondition checks.

The content manager. The content reader parameters. The loaded audio content object. Is thrown when is null. Is thrown when is not Is thrown when doesn't contain an service.

Derived class must implement this method to perform the actual asset reading.

The associated audio manager. The content reader parameters containing the asset data stream. The loaded asset.

implementation for audio content readers.

Creates an appropiate content reader for the provided type.

The content type. The content reader instance that can read content, or null if content type is not supported.

An Audio exception.

Initializes a new instance of the class.

The message describing the exception.

Initializes a new instance of the class.

The message describing the exception. The exception that caused this exception. formatting arguments

This manages the XAudio2 audio graph, device, and mastering voice. This manager also allows loading of using the

Result of a device not found.

ERROR_NOT_FOUND

Initializes a new instance of the class.

The game.

Disables the master volume limiter.

Disables the reverb effect.

Enables the master volume limiter.

Enables the reverb effect.

Enables the reverb filter.

Enables the spatial audio effect.

The speed of the sound in the medium. Should be greater than or equal to 1.175494351e-38F.

Enables the spatial audio effect with the default speed of sound equal to .

Initializes XAudio2 and MasteringVoice. And registers itself as an

Is thrown when the IContentManager is not an instance of . Is thrown when the instance could not be initialized (either due to unsupported features or missing audio-device).

Sets the mastering limiter parameters.

Speed at which the limiter stops affecting audio once it drops below the limiter's threshold. Threshold of the limiter. Is thrown when this instance was already disposed. Is thrown when either or are outside of allowed ranges (/ and / respectively).

Sets the Reverb effect parameters.

The reverb effect parameters. /// Is thrown when this instance was already disposed.

Sets the Reverb effect parameters from an existing preset.

The existing Reverb preset.

Calculate 3D Audio parameters.

The 3D audio listener definition. The 3D audio emitter definition. The 3D audio calculate flags. The DSP settings.

Adds a disposable audio asset to the list of the objects to dispose.

To dispose.

Gets a value indicating whether mastering limiter is enabled.

Gets a value indicating whether reverb effect is enabled.

Gets a value indicating whether reverb filter is enabled.

Gets a value indicating whether spatial audio is enabled.

Sets and gets the volume of the Mastering voice.

Gets the device associated with the current instance.

Gets the pool of associated with the current instance.

Gets a reference to the associated with the current instance.

Gets the associated with the current instance (for reverb effect).

Gets the speaker configuration.

Helper class that provides methods to manipulate bit fields.

Gets the bit values from the provided source at the

The source from where to read the bits. The lenghts of the range to read. The offset of the bits to read. The read bits.

Fills the provided destination with the bits read from the specified source.

The bits source. The leght of the bit range. The offset of the bit range. The destination to write the bits.

A base class for a pool of items.

The item type that will be managed by the pool.

Tries to either reuse an existing item or to create a new one.

Indicates whether to track the new item as active or not. The created or recycled item. Is thrown when there is no available item to recycle and new one cannot be created.

Clears this pool from all active and free items.

Returns an used item for recycling.

The item to return for recycling.

Tries to acquire a free item or create a new one.

Indicates whether to track the new item as active or not. The acquired item or default(TItem) if the operation did not succeed. true if the operation succeeded, false - otherwise.

Allows derived classes to execute additional logic when an item is cleared from this pool.

Derived classes must implement this method to determine if an item is active or not.

The item to determine if it is active. true if the item is active, false - otherwise.

Derived classes must implement this method to allow creation of a new item.

Indicates whether to track the new item as active or not. The created item. true if creation succeeded, false - otherwise.

Tries to recycle an item. The default implementation doesn't do anything.

Indicates whether to track the new item as active or not. The item to recycle. true if recycling succeeded, false - otherwise. The default implementation always returns true.

Recomputes the lists of active and free items.

Default reverb presets.

Represents a loaded sound resource.

Initializes a new instance of the class.

The associated audio manager instance. The name of the current instance. The format of the current instance. The buffer containing audio data. The information regaring decoded packets.

Creates a new instance of the class from the specified file path.

The audio manager associated to the created instance. The path to the file from which to create the effect. The created effect.

Creates a new instance of the class from the spefified data stream.

The audio manager associated to the created instance. The stream containing the data from which to create the effect. The name of the effect (optional). The created effect.

Creates a from the current sound effect.

Releases all unmanaged resources used by the current instance.

Plays the current sound effect instance.

The volume of the sound. The pitch of the sound. The pan of the sound. true if the effect was successfuly queued for playback, false - otherwise. Is thrown if the current instance was already disposed.

Plays the current sound effect instance with default volume, pitch and pan parameters.

Handles the disposal event of a child .

The child instance that is being disposed.

Adds the specified instance to the children list.

The instance to add to children list.

Gets the wave samples duration.

Wave samples duration or 0 (zero) if the format encoding is not known.

Gets or sets the distance scaling ratio. Default is 1f.

Is thrown when there is an attempt to set the value less than zero.

Gets or sets the Doppler effect scale ratio. Default is 1f.

Is thrown when there is an attempt to set the value less than zero.

Gets the instance associated to this effect.

Gets the duration of this effect.

Gets a value indicating whether the current instance is disposed.

Gets the name of the current instance.

Gets the audio buffer of this instance.

Gets the information about decoded packets of this instance.

Gets the wave format of this instance.

Gets the audio buffer of the looped version of this instance.

Gets the voice pool used by this instance.

An implementation for content.

Provides a single playing, paused, or stopped instance of a sound.

Creates a new instance of the class.

The source effect whose instance needs to be created. The source voice to play the created instance. A value indicating whether this instance is not monitored after it is being send to playback.

Applies the 3D effect to the current sound effect instance.

The listener position. The listener velocity. The emitter position. The emitter velocity.

Applies the 3D effect to the current sound effect instance.

The listener world matrix. The listener velocity. The emitter world matrix. The emitter velocity.

Disposes the current instance and releases all associated unmanaged resources.

Pauses the playback of the current instance.

Is thrown if the current instance was already disposed.

Plays the current instance. If it is already playing - the call is ignored.

Is thrown if the current instance was already disposed.

Resets the current instance.

Resumes playback of the current instance.

Is thrown if the current instance was already disposed.

Stops the playback of the current instance.

Is thrown if the current instance was already disposed.

Stops the playback of the current instance indicating whether the stop should occur immediately of at the end of the sound.

A value indicating whether the playback should be stopped immediately or at the end of the sound. Is thrown if the current instance was already disposed.

Handles the event of disposal of the parent .

Resets the current instance to be reused in an instance pool.

The new parent sound effect. The new source voice. The new value.

Returns this SoundEffectInstance to the SoundEffect InstancePool. You should not continue to call other functions on this object.

Gets the base sound effect.

Gets a value indicating whether this instance is diposed.

Gets a value indicating whether this instance is looped.

Gets or sets the pan value of the sound effect.

The value is clamped to (-1f, 1f) range. Is thrown if the current instance was already disposed.

Gets or sets the pitch value of the sound effect.

The value is clamped to (-1f, 1f) range. Is thrown if the current instance was already disposed.

Gets the state of the current sound effect instance.

Gets or sets the volume of the current sound effect instance.

The value is clamped to (0f, 1f) range. Is thrown if the current instance was already disposed.

Gets a value indicating whether this instance is not monitored after submitting it for playback.

Gets the current audio buffer.

Pool of used to maintain fire and forget instances.

Initializes a new instance of the class.

The associated audio manager instance.

Disposes the current instance and releases all associated unmanaged resources.

Gets the for the specified wave format.

The wave format of the requested source voice pool. The source voice pool for the provided wave format.

Tries to acquire an existing or to create a new instance of the class.

The parenet sound effect. A value indicating whether the instance doesn't need to be monitored for playback. The acquired instance. true if operation succeeded, false - otherwise.

Removes the specified pool from "unshared" list.

The pool to remove.

Returns the speicfied SoundEffectInstance to the instance pool

SFXInstance to return to instance pool

Creates a key based on wave format.

The wave format from which the key should be created. The created key.

Gets a value indicating whether this instance was already disposed.

Gets the associated audio manager intance.

Pool of .

Initializes a new instance of the class.

The associated sound effect instance pool. The wave format of this pool. A value indicating whether the initialized instance is shared or not.

Disposes the current instance and releases all associated unmanaged resources.

Removes from instance pool and disposes the current instance if it is not shared.

Gets a value indicating whether the current instance was already disposed.

The state of a sound effect instance.

The sound is being played.

The sound playback is paused.

The sound playback is stopped.

Represents a wave bank that were read from a stream.

Initializes a new instance of the class and loads the wave data from the provided stream.

The associated audio manager. The stream from which to read the wave data. Is thrown when either or are null.

Initializes a new wave bank from the file located at the provided file path.

The associated audio manager. The path to the wave bank file. The wave bank initialized from provided file.

Initializes a new wave bank from the provided stream.

The associated audio manager. The stream containing wave bank data. The wave bank initialized from provided stream.

Creates a new sound effect instance from the sound effect at the specified index in this wave bank instance.

The index of the sound effect in the current instance. The sound effect instance initialized from the sound effect at specified index. Is thrown if the current instance was already disposed. Is thrown when is lesser than zero or greather than or equal to the effects count.

Creates a new sound effect instance from the sound effect with the specified name in this wave bank instance.

The name of the sound effect in the current instance. The sound effect instance initialized from sound effect with the specified name. Is thrown if the current instance was already disposed. Is thrown when is null or empty. Is thrown when the sound effect with the specified is not found.

Disposes the current instance and releases all associated unmanaged resources.

Plays the sound effect at specified index with provided parameters.

The sound effect index. The volume of the sound effect instance. The pitch of the sound effect instance. The pan of the sound effect instance. true if the sound effect instance was scheduled successfuly for playback, false - otherwise. Is thrown if the current instance was already disposed. Is thrown when is lesser than zero or greather than or equal to the effects count.

Plays the sound effect at specified index.

The sound effect index. true if the sound effect instance was scheduled successfuly for playback, false - otherwise. Is thrown if the current instance was already disposed. Is thrown when is lesser than zero or greather than or equal to the effects count.

Plays the sound effect with the specified name with provided parameters.

The sound effect name. The volume of the sound effect instance. The pitch of the sound effect instance. The pan of the sound effect instance. true if the sound effect instance was scheduled successfuly for playback, false - otherwise. Is thrown if the current instance was already disposed. Is thrown when the sound effect with the specified is not found.

Plays the sound effect with the specified name.

The sound effect name. true if the sound effect instance was scheduled successfuly for playback, false - otherwise. Is thrown if the current instance was already disposed. Is thrown when the sound effect with the specified is not found.

Gets the number of sound effects stored in the current instance.

Gets a value indicating whether the current instance is disposed.

An implementation for content.

Helper class that reads instances from binary data.

Initializes a new instance of the .

The stream containing wave bank data.