DART_Actors::AudioActor Class Reference

Actor that represents omnidirectional sounds in the application. More...

List of all members.

Public Member Functions
	new (me)
	getPropertyDescriptionList (aScript)
	beginSprite (me)
	enterFrame (me)
	StartActor (me, myCastMember)
	StopActor (me, myCastMember)
	DeleteActor (me)
	PauseActor (me, param1)
	UnPauseActor (me, param1)
	ChangeClockRate (me, rateMultiplier)
	ChangeClockPosition (me)
	GoToCurrentSegment (me)
	GoToPreviousSegment (me)
	GoToNextSegment (me)
	GoToSegment (me, newSegment)
	restartAudio (me)
Private Attributes
	pActorCast
	The audio that should be used for this actor.
	pActorCastMember
	the sound file
	pSoundChannel
	used by the wav files
	pSoundLoop
	Number of times the audio actor should repeat.
	actor_begin_time
	the time that this audioactor started
	Audio_Start_Time
	time in milliseconds start (works after a pause too)
	ActorDone
	TRUE when this actor is done, meaning the stop time has been reached.
	AudioSprite
	the sprite that contains the audio clip
	AudioChannel
	the channel the video actor audio is on
	started
	TRUE if the actor is started.
	paused
	TRUE if actor is paused.
	numLoops
	Number of times this audio has already looped.
	myCastMember
	current cast member getting played
	AudioType
	indicates whether this audio actor consists of Quicktime, or a collection of wavs that
	mySoundChannel
	used by the wav files
	pSoundVolume
	sound level at the initialization of the actor
	volumeBeforeMute
	volume before mutting audio

---

Detailed Description

Actor that represents omnidirectional sounds in the application.

Quicktime or WAV files can be used. Standard Actor methods are available such as start, stop, pause, unpause. The playback is controlled by the DART Clock

Properties:

• pActorCast -- The cast that contains the sound file(s) you wish to play.
• pActorCastMember -- The sound file you wish to play.
• pSoundChannel -- When using wav files, the sound channel (1-8) this actor will use.
• pSoundVolume -- The desired volume of the sound (0-255).
• pSoundLoop -- Number of times to loop the sound when started (-1 is used for infinite).

Copyright 2004, Georgia Tech Research Corporation, Atlanta, Georgia 30332-0415 All Rights Reserved (See LICENSE cast member for full license information)

---

Member Function Documentation

DART_Actors::AudioActor::beginSprite (  me   )

DART_Actors::AudioActor::ChangeClockPosition (  me   )

DART_Actors::AudioActor::ChangeClockRate (  me  , rateMultiplier  )

DART_Actors::AudioActor::DeleteActor (  me   )

DART_Actors::AudioActor::enterFrame (  me   )

DART_Actors::AudioActor::getPropertyDescriptionList (  aScript   )

DART_Actors::AudioActor::GoToCurrentSegment (  me   )

DART_Actors::AudioActor::GoToNextSegment (  me   )

DART_Actors::AudioActor::GoToPreviousSegment (  me   )

DART_Actors::AudioActor::GoToSegment (  me  , newSegment  )

DART_Actors::AudioActor::new (  me   )

DART_Actors::AudioActor::PauseActor (  me  , param1  )

DART_Actors::AudioActor::restartAudio (  me   )

DART_Actors::AudioActor::StartActor (  me  , myCastMember  )

DART_Actors::AudioActor::StopActor (  me  , myCastMember  )

DART_Actors::AudioActor::UnPauseActor (  me  , param1  )

---

Member Data Documentation

DART_Actors::AudioActor::actor_begin_time [private]

the time that this audioactor started

DART_Actors::AudioActor::ActorDone [private]

TRUE when this actor is done, meaning the stop time has been reached.

DART_Actors::AudioActor::Audio_Start_Time [private]

time in milliseconds start (works after a pause too)

DART_Actors::AudioActor::AudioChannel [private]

the channel the video actor audio is on

DART_Actors::AudioActor::AudioSprite [private]

the sprite that contains the audio clip

DART_Actors::AudioActor::AudioType [private]

indicates whether this audio actor consists of Quicktime, or a collection of wavs that

DART_Actors::AudioActor::myCastMember [private]

current cast member getting played

DART_Actors::AudioActor::mySoundChannel [private]

used by the wav files User specifies which channel to use

DART_Actors::AudioActor::numLoops [private]

Number of times this audio has already looped.

DART_Actors::AudioActor::pActorCast [private]

The audio that should be used for this actor.

DART_Actors::AudioActor::pActorCastMember [private]

the sound file

DART_Actors::AudioActor::paused [private]

TRUE if actor is paused.

DART_Actors::AudioActor::pSoundChannel [private]

used by the wav files User specifies which channel to use 1-10

DART_Actors::AudioActor::pSoundLoop [private]

Number of times the audio actor should repeat.

DART_Actors::AudioActor::pSoundVolume [private]

sound level at the initialization of the actor

DART_Actors::AudioActor::started [private]

TRUE if the actor is started.

DART_Actors::AudioActor::volumeBeforeMute [private]

volume before mutting audio

---