ApiApp().ClearVoiceOutput

Clears the voice output FIFO stack.

Description

This method clears out the voice output FIFO stack. Either an API call from the application or a call from a script may be used to invoke this method as a housecleaning tool, in order to clear out any unused or otherwise undesirable voice output messages.

Example Usage (C#)


bool cleared = _core.ApiApp().ClearVoiceOutput();

Parameters

None.

Returns

The boolean success or failure of the operation. If the FIFO stack was already empty, then false is returned.

See Also

  • ApiApp().ClearTextOutput
  • ApiApp().ClearDiagOutput
  • ApiApp().DisableVoiceOutput
  • ApiApp().SetVoiceOutput
  • ApiApp().GetVoiceOutput

ApiApp() Functions