Barotrauma Client Doc
Barotrauma.Sounds.SoundChannel Class Reference
Inheritance diagram for Barotrauma.Sounds.SoundChannel:

Public Member Functions

 SoundChannel (Sound sound, float gain, Vector3? position, float freqMult, float near, float far, string category, bool muffle=false)
 
override string ToString ()
 
void FadeOutAndDispose ()
 
void Dispose ()
 
void UpdateStream ()
 

Public Attributes

float frequencyMultiplier
 

Properties

Vector3? Position [get, set]
 
float Near [get, set]
 
float Far [get, set]
 
float Gain [get, set]
 
bool? Looping [get, set]
 
float FrequencyMultiplier [get, set]
 
bool FilledByNetwork [get]
 
bool? Muffled [get, set]
 
float???? CurrentAmplitude [get]
 
string Category [get, set]
 
Sound Sound [get]
 
int ALSourceIndex = -1 [get]
 
bool IsStream [get]
 
int StreamSeekPos [get, set]
 
long MaxStreamSeekPos [get]
 
bool IsPlaying [get]
 
bool FadingOutAndDisposing [get]
 

Detailed Description

Definition at line 81 of file SoundChannel.cs.

Constructor & Destructor Documentation

◆ SoundChannel()

Barotrauma.Sounds.SoundChannel.SoundChannel ( Sound  sound,
float  gain,
Vector3?  position,
float  freqMult,
float  near,
float  far,
string  category,
bool  muffle = false 
)

Definition at line 481 of file SoundChannel.cs.

Member Function Documentation

◆ Dispose()

void Barotrauma.Sounds.SoundChannel.Dispose ( )

Definition at line 627 of file SoundChannel.cs.

◆ FadeOutAndDispose()

void Barotrauma.Sounds.SoundChannel.FadeOutAndDispose ( )

Definition at line 621 of file SoundChannel.cs.

◆ ToString()

override string Barotrauma.Sounds.SoundChannel.ToString ( )

Definition at line 611 of file SoundChannel.cs.

◆ UpdateStream()

void Barotrauma.Sounds.SoundChannel.UpdateStream ( )

Definition at line 708 of file SoundChannel.cs.

Member Data Documentation

◆ frequencyMultiplier

float Barotrauma.Sounds.SoundChannel.frequencyMultiplier

Definition at line 265 of file SoundChannel.cs.

Property Documentation

◆ ALSourceIndex

int Barotrauma.Sounds.SoundChannel.ALSourceIndex = -1
get

Definition at line 415 of file SoundChannel.cs.

◆ Category

string Barotrauma.Sounds.SoundChannel.Category
getset

Definition at line 399 of file SoundChannel.cs.

◆ CurrentAmplitude

float???? Barotrauma.Sounds.SoundChannel.CurrentAmplitude
get

Definition at line 366 of file SoundChannel.cs.

◆ FadingOutAndDisposing

bool Barotrauma.Sounds.SoundChannel.FadingOutAndDisposing
get

Definition at line 616 of file SoundChannel.cs.

◆ Far

float Barotrauma.Sounds.SoundChannel.Far
getset

Definition at line 194 of file SoundChannel.cs.

◆ FilledByNetwork

bool Barotrauma.Sounds.SoundChannel.FilledByNetwork
get

Definition at line 293 of file SoundChannel.cs.

◆ FrequencyMultiplier

float Barotrauma.Sounds.SoundChannel.FrequencyMultiplier
getset

Definition at line 266 of file SoundChannel.cs.

◆ Gain

float Barotrauma.Sounds.SoundChannel.Gain
getset

Definition at line 215 of file SoundChannel.cs.

◆ IsPlaying

bool Barotrauma.Sounds.SoundChannel.IsPlaying
get

Definition at line 461 of file SoundChannel.cs.

◆ IsStream

bool Barotrauma.Sounds.SoundChannel.IsStream
get

Definition at line 421 of file SoundChannel.cs.

◆ Looping

bool? Barotrauma.Sounds.SoundChannel.Looping
getset

Definition at line 242 of file SoundChannel.cs.

◆ MaxStreamSeekPos

long Barotrauma.Sounds.SoundChannel.MaxStreamSeekPos
get

Definition at line 447 of file SoundChannel.cs.

◆ Muffled

bool? Barotrauma.Sounds.SoundChannel.Muffled
getset

Definition at line 302 of file SoundChannel.cs.

◆ Near

float Barotrauma.Sounds.SoundChannel.Near
getset

Definition at line 172 of file SoundChannel.cs.

◆ Position

Vector3? Barotrauma.Sounds.SoundChannel.Position
getset

Definition at line 89 of file SoundChannel.cs.

◆ Sound

Sound Barotrauma.Sounds.SoundChannel.Sound
get

Definition at line 409 of file SoundChannel.cs.

◆ StreamSeekPos

int Barotrauma.Sounds.SoundChannel.StreamSeekPos
getset

Definition at line 434 of file SoundChannel.cs.