Modules | Files | Inheritance Tree | Inheritance Graph | Name Index
module GNOME::Speech::Recognition
interface RecognizerModeDesc
Files: GNOME_Speech.idl
GNOME-Speech-Recognition-RecognizerModeDesc-inheritance GNOME-Speech-EngineModeDesc.html GNOME-Speech-SpeechObject.html Bonobo-Unknown.html
Operations Summary:
 voidinitWithLocaleAndDictationSupported(in string locale, in Tristate dictationGrammarSupported)
 voidinitWithNameAndStateAndDictationSupported(in string engineName, in string modeName, in string locale, in Tristate running, in Tristate dictationGrammarSupported, in SpeakerProfileArray profiles)
 voidaddSpeakerProfile(in SpeakerProfile profile)
SpeakerProfileArraygetSpeakerProfiles() raises
SpeakerProfileArraygetSpeakerProfilesImpl()
 TristateisDictationGrammarSupported()
 voidsetDictationGrammarSupported(in Tristate dictationGrammarSupported)
 voidsetSpeakerProfiles(in SpeakerProfileArray speakers)

Operations Inherited from EngineModeDesc
initWithLocale, initWithNameAndState, equals, getEngineName, getLocale, getModeName, getRunning, match, setEngineName, setLocale, setModeName, setRunning

Operations Inherited from Bonobo::Unknown
ref, unref, queryInterface

Operation Details:
 void initWithLocaleAndDictationSupported(in string locale, in Tristate dictationGrammarSupported)

Initialize a RecognizerModeDesc given a locale and the dictation flag. The speaker profiles array and other features are all null.

Parameters:
locale - the language locale.
dictationGrammarSupported - indicates whether dictation is supported.


 void initWithNameAndStateAndDictationSupported(in string engineName, in string modeName, in string locale, in Tristate running, in Tristate dictationGrammarSupported, in SpeakerProfileArray profiles)

Initialize a fully-specified descriptor.

Parameters:
engineName - the recognizer's engine name.
modeName - the recognizer's mode name.
locale - the language locale.
running - indicates if this engine is running.
dictationGrammarSupported - indicates whether dictation is supported.
profiles - array of the recognizer's speaker profiles.


 void addSpeakerProfile(in SpeakerProfile profile)

Add a speaker profile to the SpeakerProfile array.

Parameters:
profile - the speaker profile to add.


SpeakerProfileArray getSpeakerProfiles() raises (SecurityException)

Returns the list of speaker profiles known to this mode of this recognition engine. Returns null if speaker training is not supported (SpeakerManager not implemented). Returns zero-length array if speaker training is supported but no speaker profiles have been constructed yet.

The list of speaker profiles is the same as returned by the the listKnownSpeakers method of SpeakerManager if this engine is running.

Return:
the list of speaker profiles known to this mode of this recognition engine.
See Also:
SpeakerManager#listKnownSpeakers


SpeakerProfileArray getSpeakerProfilesImpl()

Version of getSpeakerProfiles that performs the operation. This method can be overridden in sub-classes. However, application can only call the getSpeakerProfiles method which does a security check.

Return:
the list of speaker profiles known to this mode of this recognition engine.
See Also:
getSpeakerProfiles


 Tristate isDictationGrammarSupported()

Test whether this engine mode provides a DictationGrammar. The value may be TRUE, FALSE or null. A null value means "don't care".

Return:
an indication of whether this engine mode provides a DictationGrammar.


 void setDictationGrammarSupported(in Tristate dictationGrammarSupported)

Set the dictationGrammarSupported parameter. The value may be TRUE, FALSE or null. A null value means "don't care".

Parameters:
dictationGrammarSupported - indicates whether dictation is supported.


 void setSpeakerProfiles(in SpeakerProfileArray speakers)

Set the list of speaker profiles. May be null.

Parameters:
speakers - array of the recognizer's speaker profiles.