Interface nsISpeechTaskType

A task is associated with a single utterance. It is provided by the browser to the service in the speak() method.

Hierarchy

Methods

AddRef QueryInterface Release dispatchBoundary dispatchEnd dispatchError dispatchMark dispatchPause dispatchResume dispatchStart setup

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

dispatchBoundary

  • Dispatch boundary event.

    Parameters

    • aName: string

      name of boundary, 'word' or 'sentence'

    • aElapsedTime: number

      time in seconds since speech has started.

    • aCharIndex: number

      offset of spoken characters.

    • aCharLength: number

      length of text in boundary event to be spoken.

    Returns void

dispatchEnd

  • Dispatch end event.

    Parameters

    • aElapsedTime: number

      time in seconds since speech has started.

    • aCharIndex: number

      offset of spoken characters.

    Returns void

dispatchError

  • Dispatch error event.

    Parameters

    • aElapsedTime: number

      time in seconds since speech has started.

    • aCharIndex: number

      offset of spoken characters.

    Returns void

dispatchMark

  • Dispatch mark event.

    Parameters

    • aName: string

      mark identifier.

    • aElapsedTime: number

      time in seconds since speech has started.

    • aCharIndex: number

      offset of spoken characters.

    Returns void

dispatchPause

  • Dispatch pause event.

    Parameters

    • aElapsedTime: number

      time in seconds since speech has started.

    • aCharIndex: number

      offset of spoken characters.

    Returns void

dispatchResume

  • Dispatch resume event.

    Parameters

    • aElapsedTime: number

      time in seconds since speech has started.

    • aCharIndex: number

      offset of spoken characters.

    Returns void

dispatchStart

  • Dispatch start event.

    Returns void

setup

  • Prepare browser for speech.

    Parameters

    • aCallback: nsISpeechTaskCallback

      callback object for mid-speech operations.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc