Speaker Class Reference

Inherits SpeakerInterface.

Public Member Functions
	Speaker ()
	~Speaker ()
virtual void	destroy (void)
virtual void	say (Speech *speech, Int priority, Int timeout, Int interrupt)
	Submits speech to play.
virtual void	say (Char *speechName, Int priority, Int timeout, Int interrupt)
virtual void	setPriority (Int priority)
	Set speaker's priority level.
virtual void	setDelay (Int delay)
	Set speaker's delay between speeches( in milliseconds)
virtual void	setBuffering (Int buffer_time)
	Set speaker's amount of buffer (in milliseconds)
virtual Int	getPriority (void)
	Get speaker's priority level.
virtual Int	getDelay (void)
	Get speaker's delay between speeches( in milliseconds)
virtual Int	getBuffering (void)
	Get speaker's amount of buffer (in milliseconds)
virtual void	pause (void)
	pause speaker
virtual void	resume (void)
	resume speaking
virtual void	stop (void)
	stop speaking (flushes queue)
virtual void	cancel (Speech *speech)
	cancel pending line of dialog
virtual Bool	hasSaid (Speech *speech)
	is line of dialog no longer pending
virtual Bool	isGoingToSay (Speech *speech)
	check in line of dialog is pending
virtual Bool	isTalking (void)
	is speaker talking
virtual Speech *	saying (void)
	returns currently spoken speech
virtual void	update (void)
	Service speaker.
void	init (char *name, Int priority, Int btime, Int delay)
	initialized speaker for use
void	deinit (void)
void	setManager (SpeechManager *manager)
SpeechItem *	firstItem (TimeStamp now=0)
SpeechItem *	nextItem (SpeechItem *item, TimeStamp now=0)
SpeechItem *	findItem (Speech *speech)
void	flush (void)

Detailed Description

Definition at line 141 of file GameSpeech.cpp.

Constructor & Destructor Documentation

Speaker()

Speaker::Speaker

(

)

Definition at line 1100 of file GameSpeech.cpp.

~Speaker()

Speaker::~Speaker

(

)

Definition at line 1114 of file GameSpeech.cpp.

Member Function Documentation

cancel()

void Speaker::cancel ( Speech * speech )

virtual

cancel pending line of dialog

Definition at line 1579 of file GameSpeech.cpp.

deinit()

void Speaker::deinit

(

void

)

Definition at line 1144 of file GameSpeech.cpp.

destroy()

void Speaker::destroy ( void )

virtual

Delete and free speaker

Definition at line 1260 of file GameSpeech.cpp.

findItem()

SpeechItem * Speaker::findItem

(

Speech *

speech

)

Definition at line 1223 of file GameSpeech.cpp.

firstItem()

SpeechItem * Speaker::firstItem

(

TimeStamp

now = 0

)

Definition at line 1160 of file GameSpeech.cpp.

flush()

void Speaker::flush

(

void

)

Definition at line 1245 of file GameSpeech.cpp.

getBuffering()

Int Speaker::getBuffering ( void )

virtual

Get speaker's amount of buffer (in milliseconds)

Definition at line 1469 of file GameSpeech.cpp.

getDelay()

Int Speaker::getDelay ( void )

virtual

Get speaker's delay between speeches( in milliseconds)

Definition at line 1451 of file GameSpeech.cpp.

getPriority()

Int Speaker::getPriority ( void )

virtual

Get speaker's priority level.

Definition at line 1433 of file GameSpeech.cpp.

hasSaid()

Bool Speaker::hasSaid ( Speech * speech )

virtual

is line of dialog no longer pending

Definition at line 1595 of file GameSpeech.cpp.

init()

void Speaker::init	(	char *	name,
		Int	priority,
		Int	btime,
		Int	delay )

initialized speaker for use

Definition at line 1123 of file GameSpeech.cpp.

isGoingToSay()

Bool Speaker::isGoingToSay ( Speech * speech )

virtual

check in line of dialog is pending

Definition at line 1604 of file GameSpeech.cpp.

isTalking()

Bool Speaker::isTalking ( void )

virtual

is speaker talking

Definition at line 1613 of file GameSpeech.cpp.

nextItem()

SpeechItem * Speaker::nextItem	(	SpeechItem *	item,
		TimeStamp	now = 0 )

Definition at line 1189 of file GameSpeech.cpp.

pause()

void Speaker::pause ( void )

virtual

pause speaker

Definition at line 1479 of file GameSpeech.cpp.

resume()

void Speaker::resume ( void )

virtual

resume speaking

Definition at line 1514 of file GameSpeech.cpp.

say() [1/2]

void Speaker::say ( Char * speechName, Int priority, Int timeout, Int interrupt )

virtual

Definition at line 1273 of file GameSpeech.cpp.

say() [2/2]

void Speaker::say ( Speech * speech, Int priority, Int timeout, Int interrupt )

virtual

Submits speech to play.

Definition at line 1283 of file GameSpeech.cpp.

saying()

Speech * Speaker::saying ( void )

virtual

returns currently spoken speech

Definition at line 1622 of file GameSpeech.cpp.

setBuffering()

void Speaker::setBuffering ( Int buffer_time )

virtual

Set speaker's amount of buffer (in milliseconds)

Definition at line 1460 of file GameSpeech.cpp.

setDelay()

void Speaker::setDelay ( Int delay )

virtual

Set speaker's delay between speeches( in milliseconds)

Definition at line 1442 of file GameSpeech.cpp.

setManager()

void Speaker::setManager ( SpeechManager * manager )

inline

Definition at line 194 of file GameSpeech.cpp.

setPriority()

void Speaker::setPriority ( Int priority )

virtual

Set speaker's priority level.

Definition at line 1414 of file GameSpeech.cpp.

stop()

void Speaker::stop ( void )

virtual

stop speaking (flushes queue)

Definition at line 1553 of file GameSpeech.cpp.

update()

void Speaker::update ( void )

virtual

Service speaker.

Todo

write an INI compatible dialog player

Definition at line 1348 of file GameSpeech.cpp.

---

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

• Code/GameEngine/Source/Common/Audio/GameSpeech.cpp