SoundItem Class Reference

Public Member Functions
str	GetFilename ()
None	Play ()

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.

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

Member Function Documentation

GetFilename()

str SoundItem::GetFilename

(

)

get the filename associated with this item

Returns

the filename associated with this item

Precondition

!isNULL()

Play()

None SoundItem::Play

(

)

Play the sound.

---

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

• SoundItem.i