Function

CopySpeechProperty

Gets the value associated with the specified property of a speech channel.

Declaration

OSErr CopySpeechProperty(SpeechChannel chan, CFStringRef property, CFTypeRef  _Nullable *object);

Parameters

chan

The speech channel with which the specified property is associated.

property

A speech-channel property about which information is being requested. See Speech-Channel Properties for information on the properties you can specify.

object

On return, a pointer to a Core Foundation object that holds the value of the specified property. The type of the object depends on the specific property passed in. For some properties, the value of object can be NULL. When the returned object is a CFDictionary object, you can use CFDictionary functions, such as CFDictionaryGetValue, to retrieve the values associated with the keys that are associated with the specified property.

Return Value

A result code. See Result Codes.

Discussion

The CopySpeechProperty function is the Core Foundation-based equivalent of the GetSpeechInfo function.

See Also

Obtaining Information About Speech and Speech Channels

GetSpeechInfo

Gets information about a designated speech channel.

Deprecated
GetSpeechPitch

Gets a speech channel’s current speech pitch.

GetSpeechRate

Gets a speech channel’s current speech rate.

SpeechBusy

Determines whether any channels of speech are currently synthesizing speech.

SpeechBusySystemWide

Determines if any speech is currently being synthesized in your application or elsewhere on the computer.

SpeechManagerVersion

Determines the current version of the Speech Synthesis Manager installed in the system.