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
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
virtual void	FillBuffer (byte[] buffer)

abstract void	PrepareStream ()

Protected Attributes
AudioChannels	channels

int	sampleRate

Stream	stream

Properties
override bool	IsPaused `[get]`

override bool	IsPlaying `[get]`

Properties inherited from Terraria.ModLoader.Audio.Music
abstract bool	IsPaused `[get]`

abstract bool	IsPlaying `[get]`

Private Member Functions
void	EnsureLoaded ()

void	SubmitSingle ()

Private Attributes
byte[]	buffer

DynamicSoundEffectInstance	instance

string	path

Static Private Attributes
const int	bufferCountPerSubmit = 2

const int	bufferLength = 4096

const int	bufferMin = 4

Additional Inherited Members
Static Public Member Functions inherited from Terraria.ModLoader.Audio.Music
static implicit	operator Music (Cue cue)

Detailed Description

Definition at line 42 of file MusicWrappers.cs.

Constructor & Destructor Documentation

◆ MusicStreaming()

Terraria.ModLoader.Audio.MusicStreaming.MusicStreaming ( string path )

Definition at line 63 of file MusicWrappers.cs.

                                           {
            this.path = path;
        }

References Terraria.ModLoader.Audio.MusicStreaming.path.

Member Function Documentation

◆ CheckBuffer()

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

virtual

Reimplemented from Terraria.ModLoader.Audio.Music.

Definition at line 112 of file MusicWrappers.cs.

                                           {
            if (!IsPlaying || instance.PendingBufferCount >= bufferMin)
                return;
 
            for (int i = 0; i < bufferCountPerSubmit; i++)
                SubmitSingle();
        }

References Terraria.ModLoader.Audio.MusicStreaming.bufferCountPerSubmit, Terraria.ModLoader.Audio.MusicStreaming.bufferMin, Terraria.ModLoader.Audio.MusicStreaming.instance, Terraria.ModLoader.Audio.MusicStreaming.IsPlaying, and Terraria.ModLoader.Audio.MusicStreaming.SubmitSingle().

Referenced by Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Dispose()

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

Definition at line 133 of file MusicWrappers.cs.

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

References Terraria.ModLoader.Audio.MusicStreaming.instance, and Terraria.ModLoader.Audio.MusicStreaming.Stop().

Here is the call graph for this function:

◆ EnsureLoaded()

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

private

Definition at line 85 of file MusicWrappers.cs.

                                    {
            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();
        }

Referenced by Terraria.ModLoader.Audio.MusicStreaming.Play().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillBuffer()

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

protectedvirtual

Reimplemented in Terraria.ModLoader.Audio.MusicStreamingOGG.

Definition at line 125 of file MusicWrappers.cs.

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

References Terraria.ModLoader.Audio.MusicStreaming.buffer, Terraria.ModLoader.Audio.Music.Reset(), and Terraria.ModLoader.Audio.MusicStreaming.stream.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.SubmitSingle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 71 of file MusicWrappers.cs.

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

References Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded(), and Terraria.ModLoader.Audio.MusicStreaming.instance.

Here is the call graph for this function:

◆ PrepareStream()

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

protectedpure virtual

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

Referenced by Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded().

Here is the caller graph for this function:

◆ 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 76 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.MusicStreamingMP3, and Terraria.ModLoader.Audio.MusicStreamingOGG.

Definition at line 100 of file MusicWrappers.cs.

                                                            {
            instance.Stop();
 
            instance.Dispose();
            instance = null;
 
            stream.Dispose();
            stream = null;
 
            buffer = null;
        }

References Terraria.ModLoader.Audio.MusicStreaming.buffer, Terraria.ModLoader.Audio.MusicStreaming.instance, and Terraria.ModLoader.Audio.MusicStreaming.stream.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.Dispose().

Here is the caller graph for this function:

◆ SubmitSingle()

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

private

Definition at line 120 of file MusicWrappers.cs.

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

References Terraria.ModLoader.Audio.MusicStreaming.buffer, Terraria.ModLoader.Audio.MusicStreaming.FillBuffer(), and Terraria.ModLoader.Audio.MusicStreaming.instance.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.CheckBuffer().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ buffer

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

private

Definition at line 58 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreamingOGG.Convert(), Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded(), Terraria.ModLoader.Audio.MusicStreaming.FillBuffer(), Terraria.ModLoader.Audio.MusicStreamingOGG.FillBuffer(), Terraria.ModLoader.Audio.MusicStreaming.Stop(), and Terraria.ModLoader.Audio.MusicStreaming.SubmitSingle().

◆ bufferCountPerSubmit

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

staticprivate

Definition at line 49 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.CheckBuffer().

◆ bufferLength

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

staticprivate

Definition at line 48 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded().

◆ bufferMin

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

staticprivate

Definition at line 52 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.CheckBuffer().

◆ channels

AudioChannels Terraria.ModLoader.Audio.MusicStreaming.channels

protected

Definition at line 61 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded(), Terraria.ModLoader.Audio.MusicStreamingWAV.PrepareStream(), Terraria.ModLoader.Audio.MusicStreamingMP3.PrepareStream(), and Terraria.ModLoader.Audio.MusicStreamingOGG.PrepareStream().

◆ instance

DynamicSoundEffectInstance Terraria.ModLoader.Audio.MusicStreaming.instance

private

Definition at line 56 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.CheckBuffer(), Terraria.ModLoader.Audio.MusicStreaming.Dispose(), Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded(), Terraria.ModLoader.Audio.MusicStreaming.Play(), Terraria.ModLoader.Audio.MusicStreaming.Stop(), and Terraria.ModLoader.Audio.MusicStreaming.SubmitSingle().

◆ path

string Terraria.ModLoader.Audio.MusicStreaming.path

private

Definition at line 54 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.MusicStreaming(), and Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded().

◆ sampleRate

int Terraria.ModLoader.Audio.MusicStreaming.sampleRate

protected

Definition at line 60 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded(), Terraria.ModLoader.Audio.MusicStreamingWAV.PrepareStream(), Terraria.ModLoader.Audio.MusicStreamingMP3.PrepareStream(), and Terraria.ModLoader.Audio.MusicStreamingOGG.PrepareStream().

◆ stream

Stream Terraria.ModLoader.Audio.MusicStreaming.stream

protected

Definition at line 57 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.EnsureLoaded(), Terraria.ModLoader.Audio.MusicStreaming.FillBuffer(), Terraria.ModLoader.Audio.MusicStreamingWAV.PrepareStream(), Terraria.ModLoader.Audio.MusicStreamingMP3.PrepareStream(), Terraria.ModLoader.Audio.MusicStreamingOGG.PrepareStream(), Terraria.ModLoader.Audio.MusicStreamingWAV.Reset(), Terraria.ModLoader.Audio.MusicStreamingMP3.Reset(), and Terraria.ModLoader.Audio.MusicStreaming.Stop().

Property Documentation

◆ IsPaused

override bool Terraria.ModLoader.Audio.MusicStreaming.IsPaused

get

Definition at line 67 of file MusicWrappers.cs.

◆ IsPlaying

override bool Terraria.ModLoader.Audio.MusicStreaming.IsPlaying

get

Definition at line 68 of file MusicWrappers.cs.

Referenced by Terraria.ModLoader.Audio.MusicStreaming.CheckBuffer().

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MusicStreaming()

Member Function Documentation

◆ CheckBuffer()

◆ Dispose()

◆ EnsureLoaded()

◆ FillBuffer()

◆ Pause()

◆ Play()

◆ PrepareStream()

◆ Resume()

◆ SetVariable()

◆ Stop()

◆ SubmitSingle()

Member Data Documentation

◆ buffer

◆ bufferCountPerSubmit

◆ bufferLength

◆ bufferMin

◆ channels

◆ instance

◆ path

◆ sampleRate

◆ stream

Property Documentation

◆ IsPaused

◆ IsPlaying