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

Public Member Functions

String GetFilename (void)
 
void Play (void)
 

Detailed Description

Common editor interface sound item.

If the SoundItem instance is null, or has been deleted from the document's sound list , it will return 'False' in comparison checks.

1 # Python:
2 soundList = document.GetSoundList() # Retrieving the document's sound list
3 soundItem = soundList.GetSoundItem( 0 ) # Getting a SoundItem from the sound list
4 if soundItem: # True if the SoundItem exists
5  pass
6 soundList.RemoveSound( soundItem )
7 if soundItem: # False, since the SoundItem was removed from the document's sound list
8  pass

Member Function Documentation

String SoundItem::GetFilename ( void  )

get the filename associated with this item

Returns
the filename associated with this item
Precondition
!isNULL()
void SoundItem::Play ( void  )

Play the sound.


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