Modules | Files | Inheritance Tree | Inheritance Graph | Name Index
module GNOME::Speech::Recognition
interface SpeakerManager
Files: GNOME_Speech.idl
GNOME-Speech-Recognition-SpeakerManager-inheritance GNOME-Speech-SpeechObject.html Bonobo-Unknown.html
Operations Summary:
 voiddeleteSpeaker(in SpeakerProfile speaker) raises
ControlComponentgetControlComponent()
SpeakerProfilegetCurrentSpeaker()
SpeakerProfileArraylistKnownSpeakers()
SpeakerProfilenewSpeakerProfile(in SpeakerProfile profile) raises
SpeakerProfilereadVendorSpeakerProfile(in InputStream inStream) raises
 voidrevertCurrentSpeaker()
 voidsaveCurrentSpeakerProfile()
 voidsetCurrentSpeaker(in SpeakerProfile speaker) raises
 voidwriteVendorSpeakerProfile(in OutputStream outStream, in SpeakerProfile speaker) raises

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

Operation Details:
 void deleteSpeaker(in SpeakerProfile speaker) raises (IllegalArgumentException)

Delete a SpeakerProfile. If the deleted speaker is the current speaker, the current speaker is set to null.

Parameters:
speaker - the speaker to delete.


ControlComponent getControlComponent()

Obtain a component that provides the engine's user interface for managing speaker data and training. If this Recognizer has no default control panel, the return value is null and the application is responsible for providing an appropriate control panel.

Note: because the interface is provided by the recognizer, it may allow the management of properties that are not otherwise accessible through the standard API.

Return:
a component that provides the engine's user interface for managing speaker data and training.


SpeakerProfile getCurrentSpeaker()

Get the current SpeakerProfile. Returns null if there is no current speaker.

Return:
the current SpeakerProfile.


SpeakerProfileArray listKnownSpeakers()

List the SpeakerProfiles known to this Recognizer. Returns null if there is no known speaker.

Return:
a list of the SpeakerProfiles known to this Recognizer.


SpeakerProfile newSpeakerProfile(in SpeakerProfile profile) raises (IllegalArgumentException)

Create a new SpeakerProfile for this Recognizer. The SpeakerProfile object returned by this method is different from the object passed to the method. The input profile contains the new id, name and variant. The returned object is a reference to a recognizer-internal profile with those settings but with all the additional recognizer-specific information associated with a profile.

This method does not change the current speaker.

If the input profile's identifier or user name is not specified (is null), the recognizer should assign a unique temporary identifier. The application should request that the user update the id.

If the input profile is null, the recognizer should assign a temporary id and user name. The application should query the user for details.

Parameters:
profile - the speaker profile.
Return:
a new SpeakerProfile for this Recognizer.


SpeakerProfile readVendorSpeakerProfile(in InputStream inStream) raises (VendorDataException, IOException)

Read a SpeakerProfile from a stream and return a reference to it. This method loads data that may have been stored previously with the writeVendorSpeakerProfile method.

If the speaker profile contained in the input stream already exists, the recognizer should create a modified name. An application should inform the user of the name that is loaded and consider giving them an option to modify it.

Since speaker profiles are stored in vendor-specific formats, they can only be loaded into a recognizer that understands that format - typically a recognizer from the same provider.

Note: The speaker profile is potentially large (up to several MBytes).

Parameters:
inStream - the InputStream to read the speaker profile off.
Return:
a reference to a SpeakerProfile.
See Also:
writeVendorSpeakerProfile


 void revertCurrentSpeaker()

Restore the speaker profile for the current speaker to the last saved version. If the speaker profile has not been saved during the session, the restored version will be the version loaded at the start of the session.

Because of the large potential size of the speaker profile, this may be a slow operation.

See Also:
saveCurrentSpeakerProfile
readVendorSpeakerProfile


 void saveCurrentSpeakerProfile()

Save the speaker profile for the current speaker. The speaker profile is stored internally by the recognizer and should be available for future sessions.

Because of the large potential size of the speaker profile, this may be a slow operation.

See Also:
revertCurrentSpeaker
writeVendorSpeakerProfile


 void setCurrentSpeaker(in SpeakerProfile speaker) raises (IllegalArgumentException)

Set the current SpeakerProfile. The SpeakerProfile object should be one of the objects returned by the listKnownSpeakers method.

Because a SpeakerProfile may store preferred user settings for the RecognizerProperties, those properties may change as a result of this call.

Parameters:
speaker - the new SpeakerProfile.


 void writeVendorSpeakerProfile(in OutputStream outStream, in SpeakerProfile speaker) raises (IOException)

Write the speaker profile of the named speaker to a stream. This method allows speaker data to be stored and to be transferred between machines.

The speaker profile is stored in a vendor-specific format, so it can only be loaded into a recognizer that understands that format - typically a recognizer from the same provider. Speaker profiles are loaded with the readVendorSpeakerProfile method.

Note: The speaker profile is potentially large (up to several MBytes).

Parameters:
outStream - the OutputStream to write to.
speaker - the speaker profile.
See Also:
readVendorSpeakerProfile