Module tts

Convert text to speech and send to a device

Functions

TTS.waitForCompletion (subscriptionId, deviceUrl)
Wait for text to speech to complete

Parameters:

  • subscriptionId string
  • deviceUrl string
TTS.playFileAsync (deviceUrl, filename)
Play a file on a device - returning immediately. The file must be in the same format as the device URL

Parameters:

  • deviceUrl string
  • filename string

Returns:

    string subscriptionId

See also:

TTS.playFile (deviceUrl, filename)
Play a file

Parameters:

  • deviceUrl string
  • filename string
TTS.playMessageAsync (deviceUrl, locale, message, data)
Play a message on a device

Parameters:

  • deviceUrl string
  • locale string the language to play the message
  • message string the message to play - this can be a template if data is provided
  • data table | nil data to use to interpolate into the message

See also:

TTS.playMessage (deviceUrl, locale, message, data)
Play a message on a device

Parameters:

  • deviceUrl string
  • locale string the language to play the message
  • message string the message to play - this can be a template if data is provided
  • data table | nil data to use to interpolate into the message
generated by LDoc 1.5.0 Last updated 2025-06-05 18:17:56