PDG engine v0.9.5
 All Classes Namespaces Functions Variables Groups Pages
Classes | Variables
Sound

Things used for audio (sound and music) More...

Collaboration diagram for Sound:

Classes

class  Sound
 handles both short sounds and music (GUI Only) More...
 
struct  pdg::SoundEvent
 a sound completed or is looping (GUI Only) More...
 
class  SoundManager
 used for application wide sound settings and options (GUI Only) More...
 

Variables

const soundEvent_DonePlaying = 0
 sound event type for completion of a sound
 
const soundEvent_FailedToPlay = 2
 sound event type for a sound error
 
const soundEvent_Looping = 1
 sound event type for a sound finishing and starting over
 

Detailed Description

Things used for audio (sound and music)


Class Documentation

struct pdg::SoundEvent

a sound completed or is looping (GUI Only)

Generated by the SoundManager whenever a sound finishes playing (soundEvent_DonePlaying), or reaches the end and loops (soundEvent_Looping). If there is an error

For keyboard data entry, use eventType_KeyPress.

{ 
    emitter: {},       // the emitter that generated this event
    eventType: 14,     // the event type (eventType_SoundEvent)
    eventCode: 1,      // the sound event code (one of: soundEvent_DonePlaying, soundEvent_Looping, or soundEvent_FailedToPlay) 
    sound: {}          // the Sound object that caused the event
} 
See Also
eventType_SoundEvent
soundEvent_DonePlaying
soundEvent_Looping
soundEvent_FailedToPlay
Sound

Variable Documentation

soundEvent_DonePlaying = 0

sound event type for completion of a sound

soundEvent_FailedToPlay = 2

sound event type for a sound error

soundEvent_Looping = 1

sound event type for a sound finishing and starting over

User Comments