Modules | Files | Inheritance Tree | Inheritance Graph | Name Index
module GNOME::Speech::Recognition
interface ResultToken
Files: GNOME_Speech.idl
GNOME-Speech-Recognition-ResultToken-inheritance GNOME-Speech-SpeechObject.html Bonobo-Unknown.html
Operations Summary:
 longgetCapitalizationHint()
 ResultgetResult()
 longgetSpacingHint()
 stringgetSpokenText()
 long longgetStartTime()
 long longgetEndTime()
 stringgetWrittenText()

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

Operation Details:
 long getCapitalizationHint()

Get the capitalization hint. (See description above). Values are: CAP_AS_IS (the default), CAP_FIRST, UPPERCASE, LOWERCASE. Tokens from a RuleGrammar result always return CAP_AS_IS.


 Result getResult()

Return a reference to the result that contains this token.

Return:
a reference to the result that contains this token.


 long getSpacingHint()

Get the spacing hints. (See description above). The value equals SEPARATE (the default) if the token should be presented with surrounding spaces. Otherwise any or all of the following flags can be true: ATTACH_FOLLOWING, ATTACH_PREVIOUS, ATTACH_GROUP. Tokens from a RuleGrammar result always return SEPARATE.

Return:
the spacing hints.


 string getSpokenText()

Get the spoken text of a token. In dictation, the spoken form is typically used when displaying unfinalized tokens. The difference between spoken and written forms is discussed above.

Return:
the spoken text of a token.


 long long getStartTime()

Get the approximate start time for the token. The value is matched against the current system time (in milliseconds).

The start time of a token is always greater than or equal to the the end time of a preceding token. The values will be different if the tokens are separated by a pause.

Returns -1 if timing information is not available. Not all recognizers provide timing information. Timing information is not usually available for unfinalized or finalized tokens in a Result that is not yet finalized. Even if timing information is available for the best-guess tokens, it might not be available for alternative tokens.

Return:
the approximate start time for the token.


 long long getEndTime()

Get the approximate end time for the token. The value is matched against the current system time (in milliseconds).

The end time of a token is always less than or equal to the the end time of a preceding token. The values will be different if the tokens are separated by a pause.

Returns -1 if timing information is not available. Not all recognizers provide timing information. Timing information is not usually available for unfinalized or finalized tokens in a Result that is not yet finalized. Even if timing information is available for the best-guess tokens, it might not be available for alternative tokens.

Return:
the approximate end time for the token.


 string getWrittenText()

Get the written form of a spoken token. Spoken and written forms are discussed above.