Agents 1.4.0
Edge AI Agents SDK
Loading...
Searching...
No Matches
agents::VoicePipeline Class Reference

VoicePipeline class for push-to-talk speech-to-text. More...

#include <stt_pipeline.h>

Public Member Functions

 VoicePipeline (const VoiceConfig &cfg, const VoiceCallbacks &cb)
 Construct a new Voice Pipeline object.
 ~VoicePipeline ()
 Destroy the Voice Pipeline object.
bool start ()
 Start the voice pipeline.
void stop ()
 Stop the voice pipeline.
void beginPTT ()
 Begin push-to-talk session.
void endPTT ()
 End push-to-talk session.
bool is_running () const
 Check if the pipeline is running.

Detailed Description

VoicePipeline class for push-to-talk speech-to-text.

Constructor & Destructor Documentation

◆ VoicePipeline()

agents::VoicePipeline::VoicePipeline ( const VoiceConfig & cfg,
const VoiceCallbacks & cb )
inline

Construct a new Voice Pipeline object.

Parameters
cfgvoice configuration
cbcallbacks for voice events

Member Function Documentation

◆ is_running()

bool agents::VoicePipeline::is_running ( ) const
inline

Check if the pipeline is running.

Returns
true if running otherwise false

◆ start()

bool agents::VoicePipeline::start ( )

Start the voice pipeline.

Returns
true if started successfully otherwise false