Python Script Engine  1.0
GL Studio Editor Python Script API
SoundList Class Reference

Public Member Functions

bool isNULL (void)
 
SoundItem AddSound (String filename)
 
void RemoveSound (SoundItem &soundItem)
 
unsigned int GetCount (void)
 
SoundItem GetSoundItem (unsigned int index)
 

Detailed Description

common editor interface sound list

Member Function Documentation

SoundItem SoundList::AddSound ( String  filename)

add a sound to the list

Parameters
filenamefile path and name of sound to add (can be relative or absolute)
Returns
the sound list entry for the added sound
Precondition
!isNULL(), file exists
unsigned int SoundList::GetCount ( void  )

get the number of sound list entries in the list

Returns
the number of sound list entries in the list
Precondition
!isNULL()
SoundItem SoundList::GetSoundItem ( unsigned int  index)

get a sound list entry from the list

Parameters
indexzero based sound list index
Returns
sound list entry, NOTE the return entry may be an empty entry in which case SoundItem.isNULL() will return true
Precondition
!isNULL(), index < GetCount()
bool SoundList::isNULL ( void  )

determine if wrapped sound list does not exist

Returns
True if this object represents a NULL sound list
Deprecated:
Refer to the Truth Value Checking page
void SoundList::RemoveSound ( SoundItem soundItem)

remove a sound from the list

Parameters
soundItemsound to remove
Precondition
!isNULL(), !soundItem.isNULL(), sound item is in this list

The documentation for this class was generated from the following file: