<all_full_node>

In a voice recognition session (see <voice_rec>), the node to advance to if the server is receiving its maximum number of streams allowed and won't currently accept any new connections.

In a voice recognition session, the server component will be limited to receiving a maximum number of simultaneous streams because of available resources.

Child of: <voice_rec>

Parent of: Nothing

Example:

<all_full_node>voice_rec_full</all_full_node>

<dynamic_grammar>

Allows the definition of individual terms, with return values, to recognize voice prompts in a voice recognition session (see <voice_rec>).

Each term must be separated from its return value by a colon; each set of terms and return values must be separated by a comma.

Optional and alternate terms may be defined as follows:

[[the] color|colour] red|crimson:red

In the above example, each of the following terms will return "red":

the color red

the colour red

the color crimson

the colour crimson

color red

colour red

color crimson

colour crimson

red

crimson

In addition, the expression $GARBAGE may be used to match on and discard any extraneous terms:

[[the] color|colour] red|crimson $GARBAGE:red

In the above example, the following input:

the color red is my favorite color

will return:

red

The return value is placed in the long_poll_value variable in the long polling session that captures the voice input (see <long_poll connect="">).

Multiple <dynamic_grammar> tags may be used within a single <voice_rec> tag.

Child of: <voice_rec>

Parent of: Nothing

Example:

<dynamic_grammar>PTN_1:RET_VAL_1, PTN_2:RET_VAL_2</dynamic_grammar>

<error_node>

The node to advance to if there is a connection error or timeout in <get_info commid=""> or a long polling or voice recognition session (see <long_poll connect=""> and <voice_rec>), or if a file defined within <preload> tags is not found.

Flash has a built-in connection timeout of approximately five seconds, so the application will proceed to the error node if this timeout is reached. This timeout cannot be overridden.

If no error node is specified and the connection times out, the user will receive a generic "connection failed" message from Flash.

Child of: <get_info commid="">, <long_poll connect="">, <preload>, <voice_rec>

Parent of: Nothing

Example:

<error_node>voice_rec_error</error_node>

<grammar>

A comma-delimited set of terms to be used to recognize voice prompts in a voice recognition session (see <voice_rec>).

Multiple <grammar> tags may be used within a single <voice_rec> tag.

Child of: <voice_rec>

Parent of: Nothing

Example:

<grammar>yesorno, largeorsmall</grammar>

<mic_accept_node>

The node to advance to if the user clicks the button to accept voice recognition from a <voice_rec_authprompt> tag.

The accept button is automatically generated by Flash to ensure that the microphone is being used with the user's consent.

Child of: <voice_rec_authprompt>

Parent of: Nothing

See also: <voice_rec>

Example:

<mic_accept_node>user_accepted_voice_rec</mic_accept_node>

<mic_delayed>

When set to YES, delays the beginning of a voice recognition session until it is started explicitly using <voice_rec_start/>. Otherwise, the session will begin in the <next_node> defined within the <voice_rec> tag.

Accepted values are YES or NO.

Default value: NO

Child of: <voice_rec>

Parent of: Nothing

See also: <voice_rec_start/>

Example:

<mic_delayed>YES</mic_delayed>

<mic_deny_node>

The node to advance to if the user clicks the button to deny a voice recognition session (see <voice_rec>).

The deny button is automatically generated by Flash to ensure that the microphone is being used with the user's consent.

Child of: <voice_rec>, <voice_rec_authprompt>

Parent of: Nothing

Example:

<mic_deny_node>user_denied_voice_rec</mic_deny_node>

<recording_stop silence_level="" silence_count="" auto_stop="">

Executes the enclosed code when the application determines that voice input during a voice recognition session has ended.

The value specified in silence_level is the volume level threshold at which the tag will be executed. The default value is 10.

The value specified in silence_count is the number of samples in a row that must measure at or below the silence level for the tag to be executed. The default value is 10.

If auto_stop is set to YES, the voice recognition session will end upon execution of the tag. The default value is YES. auto_stop is only available if the value in the <type> tag within <voice_rec> is BATCH or CHUNKS.

Child of: <voice_rec>

Parent of: Any child of <node name="">

See also: <type>

Example:

<voice_rec>

            ...

            <recording_stop silence_level="10" silence_count="10" auto_stop="YES">

                        ...

            </recording_stop>

</voice_rec>

<recording_start start_level="">

Executes the enclosed code when the application first detects voice input during a voice recognition session.

The value specified in start_level is the volume level threshold at which the tag will be executed. The default value is 15.

Child of: <voice_rec>

Parent of: Any child of <node name="">

Example:

<voice_rec>

            ...

            <recording_start start_level="15">

                        ...

            </recording_start>

</voice_rec>

<server>

The IP address of the server to connect to in a voice recognition session.

Child of: <voice_rec>

Parent of: Nothing

Example:

<server>12.34.56.78</server>

<timeout>

In a voice recognition session, the length of time in seconds for which the application will recognize voice input from the user (see <voice_rec>). Also used to explicitly clear an existing timeout that was set with <timeout seconds="" node=""/>.

Default value: 5 (when used within <voice_rec>)

Child of: <node name="">, <voice_rec>

Parent of: Nothing

See also: <timeout seconds="" node=""/>

Examples:

<timeout>12</timeout>

<timeout>CLEAR</timeout>

<voice_rec>

Allows the recognition of user voice input through the browser.

Voice recognition must be used in conjunction with long polling (see <long_poll connect="">) in order to capture the voice input and evaluate the result.

Note that the <next_node> specified in <voice_rec> is the node during which the actual recognition will take place. Therefore, the <timeout> specified in <voice_rec> will occur relative to the start of the <next_node>, not the node in which <voice_rec> is defined. However, if <mic_delayed> is set to YES, the recognition and timeout will not begin until the recognition is explicitly started using <voice_rec_start/>.

Once a <voice_rec> tag has been used, the variable max_level is available. max_level is the highest volume out of 100 that the user's voice input reached. Input that scores too high may result in distortion; input that scores too low may be too soft to be recognized. Note that if you try to use max_level before using <voice_rec>, an unknown variable error will occur.

Child of: <click>, <mouse_click>, <mouse_down>, <mouse_move>, <mouse_out>, <mouse_over>, <node name="">, <press>, <release>

Parent of: <timeout>, <server>, <grammar>, <dynamic_grammar>, <next_node>, <error_node>, <all_full_node>, <mic_deny_node>, <mic_delayed>, <recording_start start_level="15">

See also: <long_poll connect="">

Examples:

<voice_rec>

            <timeout>12</timeout>

            <server>http://12.34.56.78</server>

            <grammar>yesorno, largeorsmall</grammar>

            <dynamic_grammar>PTN_1:RET_1, PTN_2:RET_2</dynamic_grammar>
            <next_node>voice_recognition_on</next_node>
            <error_node>voice_rec_error</error_node>
            <all_full_node>voice_rec_full</all_full_node>
            <mic_deny_node>voice_rec_denied</mic_deny_node>
            <mic_delayed>NO</mic_delayed>
            <recording_start start_level="15">
                        ...
            </recording_start>

</voice_rec>

To stop a voice recognition session independently of <timeout>:

<voice_rec>STOP</voice_rec>

To stop a voice recognition session and close the connection without receiving a return value from the long polling session, use CANCEL as follows:

<voice_rec>CANCEL</voice_rec>

<voice_rec_authprompt>

Pops up the Flash authorization request for use of the computer's microphone for a future <voice_rec> interaction.

Use this in a node previous to a node with <voice_rec> in order to obtain mic authorization ahead of time.

Child of: <node name="">

Parent of: <mic_accept_node>, <mic_deny_node>

See also: <voice_rec>

Example:

<voice_rec_authprompt>
         <mic_accept_node>mic_accepted</mic_accept_node>
         <mic_deny_node>mic_denied</mic_deny_node>
</voice_rec_authprompt>

<voice_rec_start/>

Begins a previously defined voice recognition session that has been delayed using <mic_delayed>.

Child of: <node name="">

Parent of: Nothing

See also: <mic_delayed>, <voice_rec>

Example:

<voice_rec_start/>