tModLoader v2022.09
A mod to make and play Terraria mods
Terraria.Audio.ASoundEffectBasedAudioTrack Class Referenceabstract

Inherits Terraria.Audio.IAudioTrack, and IDisposable.

Inherited by Terraria.Audio.MP3AudioTrack, Terraria.Audio.OGGAudioTrack, and Terraria.Audio.WAVAudioTrack.

Public Member Functions

abstract void Dispose ()
 
void Pause ()
 
void Play ()
 
void Resume ()
 
abstract void Reuse ()
 
void SetVariable (string variableName, float value)
 
void Stop (AudioStopOptions options)
 
void Update ()
 
void Pause ()
 
void Play ()
 
void Resume ()
 
void Reuse ()
 
void SetVariable (string variableName, float value)
 
void Stop (AudioStopOptions options)
 
void Update ()
 

Protected Member Functions

void CreateSoundEffect (int sampleRate, AudioChannels channels)
 
void PrepareBuffer ()
 
virtual void PrepareToPlay ()
 
virtual void ReadAheadPutAChunkIntoTheBuffer ()
 
void ResetBuffer ()
 

Protected Attributes

byte[] _bufferToSubmit = new byte[4096]
 
DynamicSoundEffectInstance _soundEffectInstance
 
float[] _temporaryBuffer = new float[2048]
 

Static Protected Attributes

const int bufferCountPerSubmit = 2
 
const int bufferLength = 4096
 
const int buffersToCoverFor = 8
 

Properties

bool IsPaused [get]
 
bool IsPlaying [get]
 
bool IsStopped [get]
 
- Properties inherited from Terraria.Audio.IAudioTrack
bool IsPaused [get]
 
bool IsPlaying [get]
 
bool IsStopped [get]
 

Member Function Documentation

◆ Pause()

void Terraria.Audio.ASoundEffectBasedAudioTrack.Pause ( )

◆ Play()

void Terraria.Audio.ASoundEffectBasedAudioTrack.Play ( )

◆ Resume()

void Terraria.Audio.ASoundEffectBasedAudioTrack.Resume ( )

◆ Reuse()

abstract void Terraria.Audio.ASoundEffectBasedAudioTrack.Reuse ( )
pure virtual

◆ SetVariable()

void Terraria.Audio.ASoundEffectBasedAudioTrack.SetVariable ( string  variableName,
float  value 
)

◆ Stop()

void Terraria.Audio.ASoundEffectBasedAudioTrack.Stop ( AudioStopOptions  options)

◆ Update()

void Terraria.Audio.ASoundEffectBasedAudioTrack.Update ( )

Property Documentation

◆ IsPaused

bool Terraria.Audio.ASoundEffectBasedAudioTrack.IsPaused
get

◆ IsPlaying

bool Terraria.Audio.ASoundEffectBasedAudioTrack.IsPlaying
get

◆ IsStopped

bool Terraria.Audio.ASoundEffectBasedAudioTrack.IsStopped
get