Inside Macintosh: Sound /

Chapter 4 - Speech Manager / Speech Manager Reference

Speech Manager Routines / Obtaining Information About Voices

GetIndVoice

You can obtain a voice specification record for a voice by passing an index to the GetIndVoice function.

FUNCTION GetIndVoice (index: Integer; voice: VoiceSpecPtr): OSErr;

index

The index of the voice for which to obtain a voice specification record. This number must range from 1 to the total number of voices, as returned by the CountVoices function.

voice

A pointer to the voice specification record whose fields are to be filled in.

DESCRIPTION

The GetIndVoice function returns, in the voice specification record pointed to by the voice parameter, a specification of the voice whose index is provided in the index parameter. Your application should make no assumptions about the order in which voices are indexed.

WARNING

Your application should not add, remove, or modify a voice and then call the GetIndVoice function with an index value other than 1. To allow the Speech Manager to update its information about voices, your application should always either call the CountVoices function or call the GetIndVoice function with an index value of 1 after adding, removing, or modifying a voice or after a time at which the user might have done so.

If you specify an index value beyond the number of available voices, the GetIndVoice function returns a voiceNotFound error.

SPECIAL CONSIDERATIONS

Because the GetIndVoice function moves memory, you should not call it at interrupt time.

ASSEMBLY-LANGUAGE INFORMATION

The trap macro and routine selector for the GetIndVoice function are

Trap macro	Selector
_SoundDispatch	$030C000C

RESULT CODES

noErr	0	No error
voiceNotFound	-244	Voice resource not found