InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISoundActionData Class Referenceabstract

#include <ISoundActionData.h>

Inheritance diagram for ISoundActionData:
IBehaviorDataIPMUnknown

Public Types

enum  Operation {
  kPlay = 0, kStop, kPause, kResume,
  kStopAll
}
 
- Public Types inherited from IBehaviorData
enum  { kDefaultIID = IID_IBEHAVIORDATA }
 

Public Member Functions

virtual void SetOperation (const Operation &inOperation)=0
 
virtual Operation GetOperation () const =0
 
virtual void SetSound (const UID &inSound)=0
 
virtual UID GetSound () const =0
 
virtual void SetVolume (const PMReal &inVolume)=0
 
virtual PMReal GetVolume () const =0
 
virtual void SetSynchronous (bool16 inSynchronous)=0
 
virtual bool16 GetSynchronous () const =0
 
virtual void SetRepeat (bool16 inRepeat)=0
 
virtual bool16 GetRepeat () const =0
 
- Public Member Functions inherited from IBehaviorData
virtual int32 GetAction () const =0
 
virtual PMString GetName () const =0
 
virtual UID GetOwner () const =0
 
virtual void SetOwner (const UID &owner)=0
 
virtual bool16 IsEnabled () const =0
 
virtual bool16 Enable (const bool16 &enable=kTrue)=0
 
bool16 IsDisabled () const
 
bool16 Disable ()
 
virtual void Copy (IPMUnknown *srcData)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Data interface for Sound Behavior

Member Function Documentation

virtual Operation ISoundActionData::GetOperation () const
pure virtual

Get play operation (kPlay, kStop, kPause, kResume, or kStopAll)

virtual bool16 ISoundActionData::GetRepeat () const
pure virtual

Get whether to Repeat sound indefinitely. /Repeat in sound action dict

virtual UID ISoundActionData::GetSound () const
pure virtual

Get UID of sound page item to use for action.

virtual bool16 ISoundActionData::GetSynchronous () const
pure virtual

Get whether to play sound syncronously (wait until sound is done before proceeding with other actions). /Synchronous in sound action dict

virtual PMReal ISoundActionData::GetVolume () const
pure virtual

Get Volume to play sound 0.0 to 1.0 (1.0 is full volume, 0.0 is silent). /Volume in sound action dict

virtual void ISoundActionData::SetOperation (const Operation & inOperation)
pure virtual

Set play operation (kPlay, kStop, kPause, kResume, or kStopAll)

virtual void ISoundActionData::SetRepeat (bool16 inRepeat)
pure virtual

Set whether to Repeat sound indefinitely. /Repeat in sound action dict

virtual void ISoundActionData::SetSound (const UIDinSound)
pure virtual

Set UID of sound page item to use for action.

virtual void ISoundActionData::SetSynchronous (bool16 inSynchronous)
pure virtual

Set whether to play sound syncronously (wait until sound is done before proceeding with other actions). /Synchronous in sound action dict

virtual void ISoundActionData::SetVolume (const PMRealinVolume)
pure virtual

Set Volume to play sound 0.0 to 1.0 (1.0 is full volume, 0.0 is silent). /Volume in sound action dict