ApiApp().GetVoiceOutput

Returns the first (FIFO) string in the voice output object.

Description

If the voice output has been enabled (default), via the application, this method fetches the first string from the voice output stack. Either the application or a script may poll and fetch voice output via this method. Note that the application, not the core, is responsible for handling the fetch and subsequent operations on such output.

Example Usage (C#)


string voice = _core.ApiApp().GetVoiceOutput();

Parameters

None.

Returns

The string value representing the voice output, null is returned if disabled or empty.

See Also

  • ApiApp().GetTextOutput
  • ApiApp().GetDiagOutput
  • ApiApp().DisableVoiceOutput
  • ApiApp().SetVoiceOutput
  • ApiApp().ClearVoiceOutput

ApiApp() Functions