| Python Script Engine 8.3 GL Studio Editor Python Script API

Public Member Functions | List of all members
SoundList Class Reference

## Public Member Functions
bool | isNULL ()
SoundItem | AddSound (String filename)
void | RemoveSound (SoundItem &soundItem)
unsigned int | GetCount ()
SoundItem | GetSoundItem (unsigned int index)

## Detailed Description

common editor interface sound list

## Member Function Documentation

## ◆ AddSound()

SoundItem SoundList::AddSound | ( | String | 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()

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

void 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