Completed_Channel
Syntax: _Completed_Channel()
Purpose: Gets the channel number where an audio file finished playing.
Completed_Event
Syntax: _Completed_Event()
Purpose: Verifies if an audio file completed playback normally or was manually stopped.
Completed_Sound
Syntax: _Completed_Sound()
Purpose: Gets the sound handler (an object reference) of the audio file that finished playing.
Get_Available_Channel
Syntax: _Get_Available_Channel()
Purpose: Gets the number of a currently available audio channel.
Get_Free_Channels
Syntax: _Get_Free_Channels()
Purpose: Gets the number of free audio channels currently available.
Get_PreLoaded_Duration
Syntax: _Get_PreLoaded_Duration(Sound_Handler)
Purpose: Gets the duration (in milliseconds) of a preloaded audio file.
Get_PreLoaded_Volume
Syntax: _Get_PreLoaded_Volume(ChannelNumber)
Purpose: Gets the volume of a preloaded sound playing on the specified channel. Channel number 0 retrieves the master volume.
Get_Total_Channels
Syntax: _Get_Total_Channels()
Purpose: Gets the total number of audio channels supported by the device.
Get_Unreserved_Free_Channels
Syntax: _Get_Unreserved_Free_Channels()
Purpose: Gets the number of unreserved audio channels that are currently free.
Get_Unreserved_Used_Channels
Syntax: _Get_Unreserved_Used_Channels()
Purpose: Gets the number of unreserved audio channels that are currently in use.
Get_Used_Channels
Syntax: _Get_Used_Channels()
Purpose: Gets the number of audio channels that are currently in use.
Is_Channel_In_Use
Syntax: _Is_Channel_In_Use(ChannelNumber)
Purpose:
Returns true
if the specified channel is playing or paused, or false
if it's currently unused.
Is_PreLoaded_Paused
Syntax: _Is_PreLoaded_Paused(ChannelNumber)
Purpose:
Returns true
if the sound on the specified channel is paused, or false
otherwise.
Is_PreLoaded_Playing
Syntax: _Is_PreLoaded_Playing(ChannelNumber)
Purpose:
Returns true
if the sound on the specified channel is playing, or false
otherwise.
Play_Sound
Syntax: _Play_Sound(AudioFileName, function_to_run_when_it_completes)
Purpose: Plays an audio file and executes a function upon completion.
File
Access Note:
Be aware of limitations when accessing files within resource folders
($R_
)
on Android. Avoid accessing files in $R_
subfolders on Android to prevent potential errors.
PreLoaded_Dispose
Syntax: _PreLoaded_Dispose(Sound_Handler)
Purpose: Releases the memory occupied by a preloaded or streaming audio file.
PreLoaded_Fade
Syntax: _PreLoaded_Fade(ChannelNumber, time_to_fade, target_volume)
Purpose: Applies a fade effect to the sound playing on the specified channel.
PreLoaded_Pause
Syntax: _PreLoaded_Pause(ChannelNumber)
Purpose: Pauses the sound loaded in a specific channel. Channel number 0 pauses all channels.
PreLoaded_Play
Syntax: _PreLoaded_Play(Sound_Handler, loops_value, duration_value, fadein_value, function_onComplete)
Purpose: Plays a preloaded sound and returns the channel number where it is playing.
PreLoaded_Play_In_Channel
Syntax: _PreLoaded_Play_In_Channel(Sound_Handler, Channel_Number, loops_value, duration_value, fadein_value, function_onComplete)
Purpose: Plays a preloaded sound in a specified channel and returns the channel number.
PreLoaded_Resume
Syntax: _PreLoaded_Resume(ChannelNumber)
Purpose: Resumes the sound loaded in a specific channel. Channel number 0 resumes all channels.
PreLoaded_Rewind
Syntax: _PreLoaded_Rewind(ChannelNumber)
Purpose: Rewinds the sound playing on the specified channel. Channel number 0 rewinds all channels.
PreLoaded_Seek
Syntax: _PreLoaded_Seek(Channel_Number, mSecs_Position)
Purpose: Moves the playback position of a preloaded sound to a specific time (in milliseconds).
PreLoaded_Sound_Long
Syntax: _PreLoaded_Sound_Long(AudioFileName)
Purpose: Loads a long audio file into memory and returns its sound handler.
File
Access Note:
Be aware of limitations when accessing files within resource folders
($R_
)
on Android.
PreLoaded_Sound_Short
Syntax: _PreLoaded_Sound_Short(AudioFileName)
Purpose: Loads a short audio file into memory and returns its sound handler.
File Access Note: Be aware of limitations [as above]
PreLoaded_Stop
Syntax: _PreLoaded_Stop(ChannelNumber)
Purpose: Stops the sound loaded in a specific channel. Channel number 0 stops all channels.
PreLoaded_Volume
Syntax: _PreLoaded_Volume(ChannelNumber, Volume)
Purpose: Sets the volume for a sound playing on the specified channel. Channel number 0 sets the master volume.
Reproducir_Sonido
Syntax: _Reproducir_Sonido(AudioFileName, function_to_run_when_it_completes)
Purpose: Plays an audio file and executes a function upon completion.
Reserve_Channels
Syntax: _Reserve_Channels(number_Of_Channels_To_Reserve)
Purpose: Reserves a specified number of audio channels.
Start_Recording
Syntax: _Start_Recording(AudioFileName)
Purpose: Records audio and saves it to a file.
Stop_Recording
Syntax: _Stop_Recording(Audio_Handle_Manager)
Purpose: Stops the current audio recording.
Stop_Sound
Syntax: _Stop_Sound()
Purpose:
Stops the audio file started with the last PlaySound
execution.