Functions

Scol functions definition

Functions

int _CRAudio (mmachine m)
 _CRAudio : This function create a new Audio object
int _DSAudio (mmachine m)
 _DSAudio : This function destroy a Audio Object
int _AudioPlay (mmachine m)
 _AudioPlay : This function play an Audio Object
int _AudioStop (mmachine m)
 _AudioStop : This function stop an Audio Object
int _AudioPause (mmachine m)
 _AudioPause : This function pause an Audio Object
int _AudioSetVolume (mmachine m)
 _AudioSetVolume : This function change the volume of an Audio Object
int _AudioGetVolume (mmachine m)
 _AudioGetVolume : This function return the current volume of an Audio Object
int _AudioIsPlaying (mmachine m)
 _AudioIsPlaying : This function test if an Audio Object is playing
int _AudioPlay3d (mmachine m)
 _AudioPlay3d : This function play an Audio Object with 3d effects
int _AudioSetPosition (mmachine m)
 _AudioSetPosition : This function change the 3D position of an Audio Object
int _AudioGetPosition (mmachine m)
 _AudioGetPosition : This function retrieve the 3D position of an Audio Object
int _AudioSetCone (mmachine m)
 _AudioSetCone : This function change the 3D cone of an Audio Object
int _AudioGetCone (mmachine m)
 _AudioGetCone : This function retrieve the 3D position of an Audio Object
int _AudioSetRolloffFactor (mmachine m)
 _AudioSetRolloffFactor : This function change the attenuation factor used in attenuating the Audio Object over distance
Larger values make it attenuate faster, smaller values make the source carry better.
int _AudioGetRolloffFactor (mmachine m)
 _AudioGetRolloffFactor : This function return the rolloff factor of an Audio Object
int _AudioGetCurrentTime (mmachine m)
 _AudioGetCurrentTime : This function return the current time of an Audio Object
int _AudioGetTotalTime (mmachine m)
 _AudioGetTotalTime : This function return the total time of an Audio Object
int _AudioSetPitch (mmachine m)
 _AudioSetPitch : This function change the pitch of an Audio Object
int _AudioGetPitch (mmachine m)
 _AudioGetPitch : This function return the pitch of an Audio Object
int _AudioSeek (mmachine m)
 _AudioSeek : This function seek the Audio Object to a specified time
int _AudioSetListenerPosition (mmachine m)
 _AudioSetListenerPosition : This function set the global listener position (camera or player position)
int _CBAudioEnd (mmachine m)
 _CBAudioEnd : This function set the Callback for end event of a player content

Detailed Description

Scol functions definition

Function Documentation

int _AudioGetCone ( mmachine  m )

_AudioGetCone : This function retrieve the 3D position of an Audio Object

Prototype: fun [ObjAudio] [I I I]

Parameters:
ObjAudio: the current ObjAudio
Returns:
[I I I] : inner cone, outer cone and outer volume, NIL otherwise

Definition at line 692 of file plugin.cpp.

int _AudioGetCurrentTime ( mmachine  m )

_AudioGetCurrentTime : This function return the current time of an Audio Object

Prototype: fun [ObjAudio] F

Parameters:
ObjAudio: the current ObjAudio
Returns:
F : the current time in second, NIL otherwise

Definition at line 829 of file plugin.cpp.

int _AudioGetPitch ( mmachine  m )

_AudioGetPitch : This function return the pitch of an Audio Object

Prototype: fun [ObjAudio] F

Parameters:
ObjAudio: the current ObjAudio
Returns:
F : the sound pitch, NIL otherwise

Definition at line 953 of file plugin.cpp.

int _AudioGetPosition ( mmachine  m )

_AudioGetPosition : This function retrieve the 3D position of an Audio Object

Prototype: fun [ObjAudio] [[F F F] [F F F]]

Parameters:
ObjAudio: the current ObjAudio
Returns:
[[F F F] [F F F]] : position and direction, NIL otherwise

Definition at line 561 of file plugin.cpp.

int _AudioGetRolloffFactor ( mmachine  m )

_AudioGetRolloffFactor : This function return the rolloff factor of an Audio Object

Prototype: fun [ObjAudio] F

Parameters:
ObjAudio: the current ObjAudio
Returns:
F : rolloff factor, NIL otherwise

Definition at line 789 of file plugin.cpp.

int _AudioGetTotalTime ( mmachine  m )

_AudioGetTotalTime : This function return the total time of an Audio Object

Prototype: fun [ObjAudio] F

Parameters:
ObjAudio: the current ObjAudio
Returns:
F : the total time in second, NIL otherwise

Definition at line 869 of file plugin.cpp.

int _AudioGetVolume ( mmachine  m )

_AudioGetVolume : This function return the current volume of an Audio Object

Prototype: fun [ObjAudio] I

Parameters:
ObjAudio: the current ObjAudio
Returns:
I : current volume, NIL otherwise

Definition at line 360 of file plugin.cpp.

int _AudioIsPlaying ( mmachine  m )

_AudioIsPlaying : This function test if an Audio Object is playing

Prototype: fun [ObjAudio] I

Parameters:
ObjAudio: the current ObjAudio
Returns:
I : 1 if playing state, 0 if not, NIL otherwise

Definition at line 401 of file plugin.cpp.

int _AudioPause ( mmachine  m )

_AudioPause : This function pause an Audio Object

Prototype: fun [ObjAudio] I

Parameters:
ObjAudio: the current ObjAudio
Returns:
I : 0 if success, NIL otherwise

Definition at line 276 of file plugin.cpp.

int _AudioPlay ( mmachine  m )

_AudioPlay : This function play an Audio Object

Prototype: fun [ObjAudio I] I

Parameters:
ObjAudio: the current ObjAudio
I: 1 for loop, 0 otherwise
Returns:
I : 0 if success, NIL otherwise

Definition at line 193 of file plugin.cpp.

int _AudioPlay3d ( mmachine  m )

_AudioPlay3d : This function play an Audio Object with 3d effects

Prototype: fun [ObjAudio I] I

Parameters:
ObjAudio: the current ObjAudio
F: attenuation, default 1.0
I: 1 for loop, 0 otherwise
Returns:
I : 0 if success, NIL otherwise

Definition at line 446 of file plugin.cpp.

int _AudioSeek ( mmachine  m )

_AudioSeek : This function seek the Audio Object to a specified time

Prototype: fun [ObjAudio F I] I

Parameters:
ObjAudio: the current ObjAudio
F: time to seek (default 0.0)
I: 1 to seek from the current position, 0 to seek from the start position of the sound (default 0)
Returns:
I : 0 if success, NIL otherwise

Definition at line 994 of file plugin.cpp.

int _AudioSetCone ( mmachine  m )

_AudioSetCone : This function change the 3D cone of an Audio Object

Prototype: fun [ObjAudio I I I] I

Parameters:
ObjAudio: the current ObjAudio
I: inner cone angle 0 to 360
I: outer cone angle 0 to 360
I: sound volume in outer cone (default : 0)
Returns:
I : 0 if success, NIL otherwise

Definition at line 637 of file plugin.cpp.

int _AudioSetListenerPosition ( mmachine  m )

_AudioSetListenerPosition : This function set the global listener position (camera or player position)

Prototype: fun [[F F F] [F F F]] I

Parameters:
[FF F] : position
[FF F] : direction
Returns:
I : 0 if success, nil otherwise

Definition at line 1047 of file plugin.cpp.

int _AudioSetPitch ( mmachine  m )

_AudioSetPitch : This function change the pitch of an Audio Object

Prototype: fun [ObjAudio F] I

Parameters:
ObjAudio: the current ObjAudio
F: new pitch (between 0 to infinit, default is 1.0)
Returns:
I : 0 if success, NIL otherwise

Definition at line 909 of file plugin.cpp.

int _AudioSetPosition ( mmachine  m )

_AudioSetPosition : This function change the 3D position of an Audio Object

Prototype: fun [ObjAudio [F F F] [F F F]] I

Parameters:
ObjAudio: the current ObjAudio
[FF F] : position
[FF F] : direction
Returns:
I : 0 if success, NIL otherwise

Definition at line 497 of file plugin.cpp.

int _AudioSetRolloffFactor ( mmachine  m )

_AudioSetRolloffFactor : This function change the attenuation factor used in attenuating the Audio Object over distance
Larger values make it attenuate faster, smaller values make the source carry better.

Prototype: fun [ObjAudio F] I

Parameters:
ObjAudio: the current ObjAudio
F: new rolloff factor (between 0 to infinit, default is 1.0)
Returns:
I : 0 if success, NIL otherwise

Definition at line 745 of file plugin.cpp.

int _AudioSetVolume ( mmachine  m )

_AudioSetVolume : This function change the volume of an Audio Object

Prototype: fun [ObjAudio I] I

Parameters:
ObjAudio: the current ObjAudio
I: new volume (default 100)
Returns:
I : 0 if success, NIL otherwise

Definition at line 316 of file plugin.cpp.

int _AudioStop ( mmachine  m )

_AudioStop : This function stop an Audio Object

Prototype: fun [ObjAudio] I

Parameters:
ObjAudio: the current ObjAudio
Returns:
I : 0 if success, NIL otherwise

Definition at line 237 of file plugin.cpp.

int _CBAudioEnd ( mmachine  m )

_CBAudioEnd : This function set the Callback for end event of a player content

Prototype: fun [ObjAudio fun [ObjAudio u0] u1 u0] ObjAudio

Parameters:
ObjAudio: the current ObjAudio
fun[ObjAudio u0] : SCOL CallBack function to call
u1: user parameter
u0: user parameter
Returns:
I : ObjAudio if success

Definition at line 1102 of file plugin.cpp.

int _CRAudio ( mmachine  m )

_CRAudio : This function create a new Audio object

Prototype: fun [Chn S P I] ObjAudio

Parameters:
Chn: the current channel
S: the name of the sound instance
P: the file to load
I: 1 for stream, 0 otherwise
Returns:
ObjAudio : The Audio Object or NIL if creation fail

Definition at line 91 of file plugin.cpp.

int _DSAudio ( mmachine  m )

_DSAudio : This function destroy a Audio Object

Prototype: fun [ObjAudio] I

Parameters:
ObjAudio: the current ObjAudio
Returns:
I : 0 if success, NIL otherwise

Definition at line 161 of file plugin.cpp.

Generated on Wed May 4 2011 20:13:29 for Audio Scol plugin by  doxygen 1.7.2