Terraria.ModLoader.Audio.MusicStreaming Class Reference

Inheritance diagram for Terraria.ModLoader.Audio.MusicStreaming:

Collaboration diagram for Terraria.ModLoader.Audio.MusicStreaming:

Public Member Functions
	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)
Public Member Functions inherited from Terraria.ModLoader.Audio.Music
abstract void	Reset ()

Public Attributes
override bool	IsPaused => instance != null && instance.State == SoundState.Paused
override bool	IsPlaying => instance != null && instance.State != SoundState.Stopped

Protected Member Functions
virtual void	FillBuffer (byte[] buffer)
abstract void	PrepareStream ()

Protected Attributes
AudioChannels	channels
int	sampleRate
Stream	stream

Private Member Functions
void	EnsureLoaded ()
void	SubmitSingle ()

Private Attributes
byte []	buffer
const int	bufferCountPerSubmit = 2
const int	bufferLength = 4096
const int	bufferMin = 4
DynamicSoundEffectInstance	instance
string	path

Additional Inherited Members
Static Public Member Functions inherited from Terraria.ModLoader.Audio.Music
static implicit	operator Music (Cue cue)
Properties inherited from Terraria.ModLoader.Audio.Music
abstract bool	IsPaused [get]
abstract bool	IsPlaying [get]

Detailed Description

Definition at line 41 of file MusicWrappers.cs.

Constructor & Destructor Documentation

MusicStreaming()

Terraria.ModLoader.Audio.MusicStreaming.MusicStreaming

(

string

path

)

Definition at line 62 of file MusicWrappers.cs.

                                           {
            this.path = path;
        }

Member Function Documentation

CheckBuffer()

override void Terraria.ModLoader.Audio.MusicStreaming.CheckBuffer ( )

virtual

Reimplemented from Terraria.ModLoader.Audio.Music.

Definition at line 111 of file MusicWrappers.cs.

                                           {
            if (!IsPlaying || instance.PendingBufferCount >= bufferMin)
                return;

            for (int i = 0; i < bufferCountPerSubmit; i++)
                SubmitSingle();
        }

Dispose()

void Terraria.ModLoader.Audio.MusicStreaming.Dispose

(

)

Definition at line 132 of file MusicWrappers.cs.

                              {
            if (instance != null)
                Stop(AudioStopOptions.Immediate);
        }

EnsureLoaded()

void Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded ( )

private

Definition at line 84 of file MusicWrappers.cs.

References Terraria.ModLoader.ModContent.OpenRead().

                                    {
            if (instance != null)
                return;
            
            stream = ModContent.OpenRead(path, true);
            PrepareStream();

            instance = new DynamicSoundEffectInstance(sampleRate, channels);
            buffer = new byte[bufferLength]; // could use a buffer pool but swapping music isn't likely to thrash the GC too much

            CheckBuffer();
        }

Here is the call graph for this function:

FillBuffer()

virtual void Terraria.ModLoader.Audio.MusicStreaming.FillBuffer ( byte []  buffer )

protectedvirtual

Reimplemented in Terraria.ModLoader.Audio.MusicStreamingOGG.

Definition at line 124 of file MusicWrappers.cs.

                                                         {
            int read = stream.Read(buffer, 0, buffer.Length);
            if (read < buffer.Length) {
                Reset();
                stream.Read(buffer, read, buffer.Length - read);
            }
        }

Pause()

override void Terraria.ModLoader.Audio.MusicStreaming.Pause ( )

virtual

Implements Terraria.ModLoader.Audio.Music.

Play()

override void Terraria.ModLoader.Audio.MusicStreaming.Play ( )

virtual

Implements Terraria.ModLoader.Audio.Music.

Definition at line 70 of file MusicWrappers.cs.

                                    {
            EnsureLoaded();
            instance.Play();
        }

PrepareStream()

abstract void Terraria.ModLoader.Audio.MusicStreaming.PrepareStream ( )

protectedpure virtual

Implemented in Terraria.ModLoader.Audio.MusicStreamingOGG, Terraria.ModLoader.Audio.MusicStreamingMP3, and Terraria.ModLoader.Audio.MusicStreamingWAV.

Resume()

override void Terraria.ModLoader.Audio.MusicStreaming.Resume ( )

virtual

Implements Terraria.ModLoader.Audio.Music.

SetVariable()

override void Terraria.ModLoader.Audio.MusicStreaming.SetVariable ( string  name, float  value  )

virtual

Implements Terraria.ModLoader.Audio.Music.

Definition at line 75 of file MusicWrappers.cs.

                                                                   {
            switch (name) {
                case "Volume": instance.Volume = value; return;
                case "Pitch": instance.Pitch = value; return;
                case "Pan": instance.Pan = value; return;
                default: throw new Exception("Invalid field: '" + name + "'");
            }
        }

Stop()

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

virtual

Implements Terraria.ModLoader.Audio.Music.

Reimplemented in Terraria.ModLoader.Audio.MusicStreamingOGG, and Terraria.ModLoader.Audio.MusicStreamingMP3.

Definition at line 99 of file MusicWrappers.cs.

                                                            {
            instance.Stop();

            instance.Dispose();
            instance = null;

            stream.Dispose();
            stream = null;

            buffer = null;
        }

SubmitSingle()

void Terraria.ModLoader.Audio.MusicStreaming.SubmitSingle ( )

private

Definition at line 119 of file MusicWrappers.cs.

                                    {
            FillBuffer(buffer);
            instance.SubmitBuffer(buffer);
        }

Member Data Documentation

buffer

byte [] Terraria.ModLoader.Audio.MusicStreaming.buffer

private

Definition at line 57 of file MusicWrappers.cs.

bufferCountPerSubmit

const int Terraria.ModLoader.Audio.MusicStreaming.bufferCountPerSubmit = 2

private

Definition at line 48 of file MusicWrappers.cs.

bufferLength

const int Terraria.ModLoader.Audio.MusicStreaming.bufferLength = 4096

private

Definition at line 47 of file MusicWrappers.cs.

bufferMin

const int Terraria.ModLoader.Audio.MusicStreaming.bufferMin = 4

private

Definition at line 51 of file MusicWrappers.cs.

channels

AudioChannels Terraria.ModLoader.Audio.MusicStreaming.channels

protected

Definition at line 60 of file MusicWrappers.cs.

instance

DynamicSoundEffectInstance Terraria.ModLoader.Audio.MusicStreaming.instance

private

Definition at line 55 of file MusicWrappers.cs.

IsPaused

override bool Terraria.ModLoader.Audio.MusicStreaming.IsPaused => instance != null && instance.State == SoundState.Paused

Definition at line 66 of file MusicWrappers.cs.

IsPlaying

override bool Terraria.ModLoader.Audio.MusicStreaming.IsPlaying => instance != null && instance.State != SoundState.Stopped

Definition at line 67 of file MusicWrappers.cs.

path

string Terraria.ModLoader.Audio.MusicStreaming.path

private

Definition at line 53 of file MusicWrappers.cs.

sampleRate

int Terraria.ModLoader.Audio.MusicStreaming.sampleRate

protected

Definition at line 59 of file MusicWrappers.cs.

stream

Stream Terraria.ModLoader.Audio.MusicStreaming.stream

protected

Definition at line 56 of file MusicWrappers.cs.