» Back To Index

The <play_list> node

Function

The play_list node makes it possible to manage a collection of audio tracks and to play them (a little like the playLists Winamp).

General syntax

<play_list
	name=""
	active="TRUE"
	loop="TRUE"
	display_current_audio_track_name="FALSE" >
	
	<add_track
		name="" 
		start_script="" 
		per_frame_script="" />

</play_list>

---

element play_list

play_list is the xml tag that defines a play_list node.

Attributes:

• name - [STR127] - name of the node. This name will make it possible to refer this node throughout the XML script.
  
• active - [BOOLEAN] - enables or disables the play list - default value: TRUE
  
• loop - [BOOLEAN] - enables or disables the loop mode. If this mode is set to TRUE, the audio track list file is continuously played. If this mode is set to FALSE, the list of the audio tracks is played only once - default value: TRUE
  
• display_current_audio_track_name - [BOOLEAN] - displays (TRUE) or hides (FALSE) the name of the audio track being played - default value: FALSE

Example:

<audio name="bluishbg" 
filename="mp3/tbl/bluishbg.xm"  
looping="FALSE" play="FALSE" />

<audio name="valentines" 
filename="mp3/etak/valentines.mp3" 
looping="FALSE" play="TRUE" />

<audio name="over2bg" 
filename="mp3/tbl/over2bg.xm" 
looping="FALSE" play="FALSE" />

<play_list name="myPlayList" 
    loop="TRUE" active="TRUE" 
	display_current_audio_track_name="TRUE" >
	<add_track name="over2bg" 
	    start_script="scripts/over2bg_start.lua" 
		per_frame_script="scripts/over2bg_per_frame.lua"/>
	<add_track name="valentines" 
	start_script="scripts/valentines_start.lua" 
	per_frame_script="scripts/valentines_per_frame.lua"/>
	<add_track name="bluishbg" 
	start_script="scripts/bluishbg_start.lua" 
	per_frame_script="scripts/bluishbg_per_frame.lua"/>
</play_list>

---

element add_track

add_track allows to add an audio track to the play list. Each audio track can be accompanied by two scripts: one will be executed when activating the audio track and the other will be executed at each audio track frame reading.

Attributes:

• name - [STR127] - name of the audio track to add in the play list. This name must be the same as the audio node one declared in the XML code.
• start_script - [STR255] - name of the script file to execute once at the starting of the audio track reading.
• per_frame_script - [STR255] - name of the script file to execute each frame while playing the audio track.