Notice for App Developers

To use these methods, the speech module must be installed in the native app:

Hierarchy

  • Speech

Methods

  • Check permissions status for speech recognition

    Example:

     
    const modules = await Eitri.modules()
    if(!modules.speech){
    return // speech module is unavailable, disable interfaces related to speech recognition
    }
    const speechStatus = await Eitri.speech.checkPermission()
    console.log(speechStatus)

    /* Example output from this console.log:
    {
    status: "DENIED",
    }
    */

    🚨 Android only: If executed before the first permission request, the default response is SpeechPermissionOutput#BLOCKED.

    Compatibility Control

    Returns Promise<SpeechPermissionOutput>

  • Request permission for speech recognition

    Example:

    const modules = await Eitri.modules()
    if(!modules.speech){
    return // speech module is unavailable, disable interfaces related to speech recognition
    }
    const speechStatus = await Eitri.speech.requestPermission()
    console.log(speechStatus)

    /* Example output from this console.log:
    {
    status: "GRANTED",
    }
    */

    Compatibility Control

    Returns Promise<SpeechPermissionOutput>

  • Start speech recognition

    Example:

    try {
    const modules = await Eitri.modules()
    if(!modules.speech){
    return // speech module is unavailable, disable interfaces related to speech recognition
    }
    const permission = await Eitri.speech.checkPermission()

    if (permission.status === "GRANTED") {
    const result = await Eitri.speech.startSpeechRecognition({
    language: "en-US"
    })
    console.log(result.text)
    // Output: "Hello, world"
    return
    }

    // Handle permission denied or blocked
    if (permission.status === "DENIED") {
    const granted = await Eitri.speech.requestPermission()
    if (granted.status === "GRANTED") {
    const result = await Eitri.speech.startSpeechRecognition()
    console.log(result)
    }
    }

    } catch (e) {
    console.log(e)
    // handle errors and notify user
    }

    Compatibility Control

    Parameters

    Returns Promise<SpeechRecognitionOutput>

  • Stop speech recognition

    Example:

    const modules = await Eitri.modules()
    if (!modules.speech){
    return // speech module is unavailable, disable interfaces related to speech recognition
    }
    await Eitri.speech.stopSpeechRecognition()

    Compatibility Control

    Returns Promise<void>

Generated using TypeDoc