HolyLib Wiki

Home / IGModAudioChannel

IGModAudioChannel

IGModAudioChannel

Metatable function Description
__tostring Returns a formated string of the IGModAudioChannel -> IGModAudioChannel [file name/url]
__gc Internally deletes the IGModAudioChannel turning it invalid

Methods

IGModAudioChannel:Destroy()
Destroys the audio channel.
IGModAudioChannel:FFT( table output, number fft )
Computes the DFT of the sound channel.
What even is that.
IGModAudioChannel:Get3DCone()
Not implemented / throws a error when used.
IGModAudioChannel:Get3DEnabled()
Not implemented / throws a error when used.
IGModAudioChannel:Get3DFadeDistance()
Not implemented / throws a error when used.
number IGModAudioChannel:GetAverageBitRate( )
Returns the average bit rate.
number IGModAudioChannel:GetBitsPerSample( )
Returns the bits per sample.
number IGModAudioChannel:GetBufferedTime( )
Returns the buffered time of the channel. If it's playing a file, it will just return the length of it.
number IGModAudioChannel:GetChannelPan( )
Returns the channel pan.
string IGModAudioChannel:GetFileName( )
Returns the filename or URL the channel is playing.
number, number IGModAudioChannel:GetLevel( )
Returns the level of the channel. First value is left, second is right.
number IGModAudioChannel:GetPlaybackRate( )
Returns the playback rate of the channel.
IGModAudioChannel:GetPos()
Not implemented / throws a error when used.
number IGModAudioChannel:GetSampleRate( )
Returns the samplerate of the channel.
number IGModAudioChannel:GetState( )
Returns the state of the channel.
table IGModAudioChannel:GetTable( )
Returns the lua table used by newindex and index
string IGModAudioChannel:GetTags( )
Returns the tag of the channel.
number IGModAudioChannel:GetTime( )
Returns the time of the channel.
boolean IGModAudioChannel:Is3D( )
Returns true if the channel is a 3D one.
boolean IGModAudioChannel:IsBlockStreamed( )
Returns true if the sound is received in chunks.
boolean IGModAudioChannel:IsLooping( )
Returns true if the channel will loop.
boolean IGModAudioChannel:IsOnline( )
Returns true if were playing a URL.
boolean IGModAudioChannel:IsValid( )
Returns true if the channel is valid.
IGModAudioChannel:Pause()
Pauses the channel.
IGModAudioChannel:Play()
Plays the channel.
IGModAudioChannel:Restart()
Restarts the channel.
IGModAudioChannel:Set3DCone()
Not implemented / throws a error when used.
IGModAudioChannel:Set3DEnabled()
Not implemented / throws a error when used.
IGModAudioChannel:Set3DFadeDistance()
Not implemented / throws a error when used.
IGModAudioChannel:SetChannelPan( number pan )
Sets the channel pan.
IGModAudioChannel:SetLooping( boolean looping )
Sets looping for the channel.
IGModAudioChannel:SetPos()
Not implemented / throws a error when used.
IGModAudioChannel:SetTime( number time )
Sets the time of the channel.
IGModAudioChannel:SetVolume( number playbackRate )
Sets the volume of the channel. It's serverside... how does volume even play a role
IGModAudioChannel:Stop()
Stops the channel.