Carbon


GetSpeechInfo

Header: SpeechSynthesis.h Carbon status: Supported

Obtains information about a designated speech channel.

OSErr GetSpeechInfo (
    SpeechChannel chan, 
    OSType selector, 
    void *speechInfo
);
Parameter descriptions
chan

The speech channel about which information is being requested.

selector

A speech information selector that indicates the type of information being requested.

For a complete list of speech information selectors, see “Speech Information Constants”. This list indicates how your application should set the speechInfo parameter for each selector and indicates which selectors might cause memory to be moved or purged.

speechInfo

A pointer whose meaning depends on the speech information selector specified in the selector parameter.

function result

A result code.

DISCUSSION

The GetSpeechInfo function returns, in the data structure pointed to by the speechInfo parameter, the type of information requested by the selector parameter as it applies to the speech channel specified in the chan parameter.

The format of the data structure specified by the speechInfo parameter depends on the selector you choose. For example, a selector might require that your application allocate a block of memory of a certain size and pass a pointer to that block. Another selector might require that speechInfo be set to the address of a handle variable. In this case, the GetSpeechInfo function would allocate a relocatable block of memory and change the handle variable specified to reference the block.

SPECIAL CONSIDERATIONS

You can call the GetSpeechInfo function at interrupt time only if the speech information selector specified in the selector parameter does not move or purge memory.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)