Header menu logo Nu

AudioPlayer Type

The audio player. Represents the audio subsystem of Nu generally.

Instance members

Instance member Description

this.CleanUp

Full Usage: this.CleanUp

Modifiers: abstract

Handle audio clean up by stopping all playback and freeing all loaded audio assets.

this.ClearMessages

Full Usage: this.ClearMessages

Modifiers: abstract

Clear all of the audio messages that have been enqueued.

this.EnqueueMessage

Full Usage: this.EnqueueMessage

Parameters:
Modifiers: abstract

Enqueue a message from an external source.

message : AudioMessage

this.MasterAudioVolume

Full Usage: this.MasterAudioVolume

Modifiers: abstract

The master audio volume.

this.MasterSongVolume

Full Usage: this.MasterSongVolume

Modifiers: abstract

The master song volume.

this.MasterSoundVolume

Full Usage: this.MasterSoundVolume

Modifiers: abstract

The master sound volume.

this.Play

Full Usage: this.Play

Parameters:
Modifiers: abstract

'Play' the audio system. Must be called once per frame.

messages : List<AudioMessage>

this.PopMessages

Full Usage: this.PopMessages

Returns: List<AudioMessage>
Modifiers: abstract

Pop all of the audio messages that have been enqueued.

Returns: List<AudioMessage>

this.SongFadingIn

Full Usage: this.SongFadingIn

Returns: bool
Modifiers: abstract

Whether a song is currently playing and fading in.

Returns: bool

this.SongFadingOut

Full Usage: this.SongFadingOut

Returns: bool
Modifiers: abstract

Whether a song is currently playing and fading out.

Returns: bool

this.SongOpt

Full Usage: this.SongOpt

Returns: SongDescriptor option
Modifiers: abstract

Get the current optionally-playing song.

Returns: SongDescriptor option

this.SongPosition

Full Usage: this.SongPosition

Returns: double
Modifiers: abstract

Get the current song's position or 0.0 if one isn't playing.

Returns: double

this.SongVolume

Full Usage: this.SongVolume

Returns: single
Modifiers: abstract

Get the current song's volume or 0.0f if one isn't playing.

Returns: single

Type something to start searching.