Gondwana.Audio.NAudio.NAudioAudioBackend Class Reference

Windows desktop audio backend implemented with NAudio. More...

Inheritance diagram for Gondwana.Audio.NAudio.NAudioAudioBackend:

Public Member Functions
IAudioPlaybackHandle	CreateFromBytes (string key, byte[] data, string fileNameOrExtension, float volume, float pan, float playbackSpeed)
	Creates an IAudioPlaybackHandle from the provided raw audio bytes. The data is opened via the NAudioReaderRegistry which may create a temporary file. The returned playback handle is responsible for disposing the underlying reader when finished.
IAudioPlaybackHandle	CreateFromUri (string key, string uri, float volume, float pan, float playbackSpeed)
	Creates an IAudioPlaybackHandle from a URI.

Properties
static NAudioAudioBackend	Instance = new() [get]
	Gets the singleton instance of the NAudioAudioBackend.
string	Name [get]
	Gets the display name of this audio backend.

Detailed Description

Windows desktop audio backend implemented with NAudio.

Definition at line 4 of file NAudioAudioBackend.cs.

Member Function Documentation

CreateFromBytes()

IAudioPlaybackHandle Gondwana.Audio.NAudio.NAudioAudioBackend.CreateFromBytes	(	string	key,
		byte[]	data,
		string	fileNameOrExtension,
		float	volume,
		float	pan,
		float	playbackSpeed )

Creates an IAudioPlaybackHandle from the provided raw audio bytes. The data is opened via the NAudioReaderRegistry which may create a temporary file. The returned playback handle is responsible for disposing the underlying reader when finished.

Parameters

key	Logical key for the audio resource (used for logging).
data	Raw audio data to load.
fileNameOrExtension	A hint containing the original file name or extension to aid format detection.
volume	Initial playback volume in the range [0,1].
pan	Initial stereo pan in the range [-1,1].
playbackSpeed	Initial playback speed multiplier (clamped to supported range).

Returns

An IAudioPlaybackHandle instance that controls playback for the loaded audio resource.

Implements Gondwana.Audio.IAudioBackend.

Definition at line 30 of file NAudioAudioBackend.cs.

CreateFromUri()

IAudioPlaybackHandle Gondwana.Audio.NAudio.NAudioAudioBackend.CreateFromUri	(	string	key,
		string	uri,
		float	volume,
		float	pan,
		float	playbackSpeed )

Creates an IAudioPlaybackHandle from a URI.

Parameters

key	Logical key for the audio resource (used for logging).
uri	The URI to load audio from.
volume	Initial playback volume in the range [0,1].
pan	Initial stereo pan in the range [-1,1].
playbackSpeed	Initial playback speed multiplier.

Returns

An IAudioPlaybackHandle for the requested resource.

Exceptions

NotSupportedException

Always thrown. URI-based playback is not supported by this backend.

Implements Gondwana.Audio.IAudioBackend.

Property Documentation

Instance

NAudioAudioBackend Gondwana.Audio.NAudio.NAudioAudioBackend.Instance = new()

staticget

Gets the singleton instance of the NAudioAudioBackend.

Definition at line 11 of file NAudioAudioBackend.cs.

Name

string Gondwana.Audio.NAudio.NAudioAudioBackend.Name

get

Gets the display name of this audio backend.

Implements Gondwana.Audio.IAudioBackend.

Definition at line 16 of file NAudioAudioBackend.cs.