SoundList Class Reference

Public Member Functions
bool	isNULL ()
SoundItem	AddSound (str filename)
None	RemoveSound (SoundItem &soundItem)
int	GetCount ()
SoundItem	GetSoundItem (int index)

Detailed Description

common editor interface sound list

Member Function Documentation

AddSound()

SoundItem SoundList::AddSound

(

str

filename

)

add a sound to the list

Parameters

filename

file 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

GetCount()

int SoundList::GetCount

(

)

get the number of sound list entries in the list

Returns

the number of sound list entries in the list

Precondition

!isNULL()

GetSoundItem()

SoundItem SoundList::GetSoundItem

(

int

index

)

get a sound list entry from the list

Parameters

index

zero 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()

isNULL()

bool SoundList::isNULL

(

)

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

RemoveSound()

None SoundList::RemoveSound

(

SoundItem &

soundItem

)

remove a sound from the list

Parameters

soundItem

sound to remove

Precondition

!isNULL(), !soundItem.isNULL(), sound item is in this list

---

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

• SoundList.i