Terraria.ModLoader.Audio.MusicStreamingMP3 Class Reference

Inheritance diagram for Terraria.ModLoader.Audio.MusicStreamingMP3:

Collaboration diagram for Terraria.ModLoader.Audio.MusicStreamingMP3:

Public Member Functions
	MusicStreamingMP3 (string path)
override void	Reset ()
override void	Stop (AudioStopOptions options)
Public Member Functions inherited from Terraria.ModLoader.Audio.MusicStreaming
	MusicStreaming (string path)
override void	CheckBuffer ()
void	Dispose ()
override void	Pause ()
override void	Play ()
override void	Resume ()
override void	SetVariable (string name, float value)
override void	Stop (AudioStopOptions options)
virtual void	CheckBuffer ()
abstract void	Pause ()
abstract void	Play ()
abstract void	Reset ()
abstract void	Resume ()
abstract void	SetVariable (string name, float value)
abstract void	Stop (AudioStopOptions options)

Protected Member Functions
override void	PrepareStream ()
Protected Member Functions inherited from Terraria.ModLoader.Audio.MusicStreaming
virtual void	FillBuffer (byte[] buffer)
abstract void	PrepareStream ()

Private Attributes
Stream	underlying

Additional Inherited Members
Static Public Member Functions inherited from Terraria.ModLoader.Audio.Music
static implicit	operator Music (Cue cue)
Protected Attributes inherited from Terraria.ModLoader.Audio.MusicStreaming
AudioChannels	channels
int	sampleRate
Stream	stream
Properties inherited from Terraria.ModLoader.Audio.MusicStreaming
override bool	IsPaused [get]
override bool	IsPlaying [get]
Properties inherited from Terraria.ModLoader.Audio.Music
abstract bool	IsPaused [get]
abstract bool	IsPlaying [get]

Detailed Description

Definition at line 181 of file MusicWrappers.cs.

Constructor & Destructor Documentation

MusicStreamingMP3()

Terraria.ModLoader.Audio.MusicStreamingMP3.MusicStreamingMP3

(

string

path

)

Definition at line 185 of file MusicWrappers.cs.

: base(path) {}

Member Function Documentation

PrepareStream()

override void Terraria.ModLoader.Audio.MusicStreamingMP3.PrepareStream ( )

protectedvirtual

Implements Terraria.ModLoader.Audio.MusicStreaming.

Definition at line 187 of file MusicWrappers.cs.

                                                {
            underlying = stream;
 
            var mp3Stream = new MP3Stream(stream);
            sampleRate = mp3Stream.Frequency;
            channels = (AudioChannels)mp3Stream.ChannelCount;
            stream = mp3Stream;
        }

References Terraria.ModLoader.Audio.MusicStreaming.channels, Terraria.ModLoader.Audio.MusicStreaming.sampleRate, Terraria.ModLoader.Audio.MusicStreaming.stream, and Terraria.ModLoader.Audio.MusicStreamingMP3.underlying.

Reset()

override void Terraria.ModLoader.Audio.MusicStreamingMP3.Reset ( )

virtual

Implements Terraria.ModLoader.Audio.Music.

Definition at line 201 of file MusicWrappers.cs.

                                     {
            if (stream != null) {
                underlying.Position = 0;
                //mp3 is not designed to loop and creates static if you just reset the stream due to fourier encoding carryover
                //if you're really smart, you can make a looping version and PR it
                stream = new MP3Stream(underlying);
            }
        }

References Terraria.ModLoader.Audio.MusicStreaming.stream, and Terraria.ModLoader.Audio.MusicStreamingMP3.underlying.

Stop()

override void Terraria.ModLoader.Audio.MusicStreamingMP3.Stop ( AudioStopOptions  options )

virtual

Reimplemented from Terraria.ModLoader.Audio.MusicStreaming.

Definition at line 196 of file MusicWrappers.cs.

                                                            {
            base.Stop(options);
            underlying = null;
        }

References Terraria.ModLoader.Audio.MusicStreamingMP3.underlying.

Member Data Documentation

underlying

Stream Terraria.ModLoader.Audio.MusicStreamingMP3.underlying

private

Definition at line 183 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreamingMP3.PrepareStream(), Terraria.ModLoader.Audio.MusicStreamingMP3.Reset(), and Terraria.ModLoader.Audio.MusicStreamingMP3.Stop().