Inside Macintosh: Sound /

Chapter 4 - Speech Manager / Speech Manager Reference

Speech Manager Routines / Starting, Stopping, and Pausing Speech

PauseSpeechAt

You can use the PauseSpeechAt function to pause speech on a speech channel.

FUNCTION PauseSpeechAt (chan: SpeechChannel; whereToStop: LongInt)
                        : OSErr;

chan

The speech channel on which speech is to be paused.

whereToStop

A constant indicating when speech processing should be paused. Pass the constant kImmediate to pause immediately, even in the middle of a word. Pass kEndOfWord or kEndOfSentence to pause speech at the end of the current word or sentence, respectively.

DESCRIPTION

The PauseSpeechAt function makes speech production pause at a specified point in the text. PauseSpeechAt returns immediately, although speech output will continue until the specified point.

You can determine whether your application has paused speech output on a speech channel by obtaining a speech status information record through the GetSpeechInfo function. While a speech channel is paused, the speech status information record indicates that outputBusy and outputPaused are both TRUE.

If the end of the input text buffer is reached before the specified pause point, speech output pauses at the end of the buffer.

The PauseSpeechAt function differs from the StopSpeech and StopSpeechAt functions in that a subsequent call to ContinueSpeech, described next, causes the contents of the current text buffer to continue being spoken.

WARNING

If you plan to continue speech synthesis from a paused speech channel, the text buffer being processed must remain available at all times and must not move while the channel is in a paused state.

SPECIAL CONSIDERATIONS

Because the PauseSpeechAt function might move or purge memory, you should not call it at interrupt time.

ASSEMBLY-LANGUAGE INFORMATION

The trap macro and routine selector for the PauseSpeechAt function are

Trap macro	Selector
_SoundDispatch	$0434000C

RESULT CODES

noErr	0	No error
invalidComponentID	-3000	Speech channel is uninitialized or bad