Options
All
  • Public
  • Public/Protected
  • All
Menu

Used by ITtsSynthesizer implementations to report its playback state.

Hierarchy

  • ITtsSynthesizerContext

Index

Methods

onTtsSynthesizerReady

  • onTtsSynthesizerReady(): void
  • Tells the SyncMediaPlayer that the synthesizer is ready for playback. MUST Call this method after calling onTtsSynthesizerWaiting() or the SyncMediaPlayer will keep waiting for the synthesizer to be ready.

    The synthesizer is considered ready by default.

    Returns void

onTtsSynthesizerWaiting

  • onTtsSynthesizerWaiting(): void
  • Call this method when the synthesizer is not ready for playback. For example when loading voices.

    MUST call onTtsSynthesizerReady() after calling waiting or the SyncMediaPlayer will keep waiting for the synthesizer to be ready.

    The synthesizer is considered ready by default.

    Returns void

onUtteranceBoundary

  • onUtteranceBoundary(utteranceId: number, startOffset: number, length: number): void
  • Call this whenever the speech synthesizer reaches a word boundary.

    Parameters

    • utteranceId: number

      The id of the utterance.

    • startOffset: number

      The offset into the utterance text pointing at the start of the next word to be spoken.

    • length: number

      The number of characters from the startOffset. Null if the length is not known.

    Returns void

onUtteranceEnd

  • onUtteranceEnd(utteranceId: number): void
  • Call this method when a utterance reaches its end.

    Parameters

    • utteranceId: number

    Returns void

onUtteranceError

  • onUtteranceError(utteranceId: number, error: unknown): void
  • Call this method when an error occurs that prevents the utterance from being spoken.

    Parameters

    • utteranceId: number
    • error: unknown

    Returns void

onUtterancePaused

  • onUtterancePaused(utteranceId: number): void
  • Call this method when the utterance is paused, due to some other reason than ITtsSynthesizer.pause() or ITtsSynthesizer.clearAndPause() being called, such as if the speech is paused by the underlying TTS service.

    The caller should be ready to retry resuming playback again when play() is called.

    Parameters

    • utteranceId: number

    Returns void

Generated using TypeDoc