Interface nsISynthVoiceRegistryType

Hierarchy

Properties

voiceCount

Methods

AddRef QueryInterface Release addVoice getVoice getVoiceLang getVoiceName isDefaultVoice isLocalVoice notifyVoicesChanged removeVoice setDefaultVoice

Properties

Readonly voiceCount

voiceCount: uint32_t

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

addVoice

  • Register a speech synthesis voice.

    Parameters

    • aService: nsISpeechService

      the service that provides this voice.

    • aUri: string

      a unique identifier for this voice.

    • aName: string

      human-readable name for this voice.

    • aLang: string

      a BCP 47 language tag.

    • aLocalService: boolean

      true if service does not require network.

    • aQueuesUtterances: boolean

      true if voice only speaks one utterance at a time

    Returns void

getVoice

  • Parameters

    • aIndex: uint32_t

    Returns string

getVoiceLang

  • Parameters

    • aUri: string

    Returns string

getVoiceName

  • Parameters

    • aUri: string

    Returns string

isDefaultVoice

  • Parameters

    • aUri: string

    Returns bool

isLocalVoice

  • Parameters

    • aUri: string

    Returns bool

notifyVoicesChanged

  • Notify content of voice availability changes. This allows content to be notified of voice catalog changes in real time.

    Returns void

removeVoice

  • Remove a speech synthesis voice.

    Parameters

    • aService: nsISpeechService

      the service that was used to add the voice.

    • aUri: string

      a unique identifier of an existing voice.

    Returns void

setDefaultVoice

  • Set a voice as default.

    Parameters

    • aUri: string

      a unique identifier of an existing voice.

    • aIsDefault: boolean

      true if this voice should be toggled as default.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc