Skip to content

Voice Service Interface

FunctionC++PythonC#Java
Voice Service Switch---
ASR Switch
TTS Switch
TTS Playback-
Stop TTS Playback
Switch Audio Source---
Switch Dialogue Mode---
Switch Recognition Mode---
Register ASR Callback

EnableVoiceService

Function Prototypes

  • C#: (bool success, string message) EnableVoiceService(bool enable, int id = 301, int timeoutMs = 5000)

Function Description
Enables or disables the voice service.

Parameters

Parameter NameTypeRequired/DefaultDescription
enableboolRequiredtrue: Enable, false: Disable
idintOptional (C#)Request ID
timeoutMsintOptional (C#)Timeout (ms)

Return Value

LanguageReturn TypeDescription
C#(bool, string)Contains success(bool) and message(string)

Code Example

csharp
// C#
var result = robot.EnableVoiceService(true);

EnableAsr

Function Prototypes

  • C#: (bool success, string message) SpeechStartASR(bool enable)
  • C++: CommReply enableAsr(bool enable)
  • Python: async def enable_asr_engine(enable: bool, timeout: float = 30.0) -> Optional[Dict]
  • Java: ServiceOperationResponse SpeechEnableAsr(boolean enable)

Function Description
Enables or disables the Automatic Speech Recognition (ASR) engine.

Parameters

Parameter NameTypeRequired/DefaultDescription
enableboolRequiredtrue: Enable, false: Disable
timeoutfloatOptional (Py)Timeout (seconds)

Return Value

LanguageReturn TypeDescription
C#(bool, string)Contains success(bool) and message(string)
C++CommReplyContains success(bool) and message(string)
PythonDictContains success(bool) and message(string)
JavaServiceOperationResponseContains status and message

Code Example

csharp
// C#
robot.SpeechStartASR(true);
python
# Python
await client.enable_asr_engine(True)
java
// Java
robot.SpeechEnableAsr(true);
cpp
// C++
robot.enableAsr(true);

EnableTts

Function Prototypes

  • C#: (bool success, string message) SpeechInitTTS(bool enable)
  • C++: CommReply enableTts(bool enable)
  • Python: async def enable_tts_engine(enable: bool, timeout: float = 30.0) -> Optional[Dict]
  • Java: ServiceOperationResponse SpeechEnableTts(boolean enable)

Function Description
Enables or disables the Text-To-Speech (TTS) engine.

Parameters

Parameter NameTypeRequired/DefaultDescription
enableboolRequiredtrue: Enable, false: Disable
timeoutfloatOptional (Py)Timeout (seconds)

Return Value

LanguageReturn TypeDescription
C#(bool, string)Contains success(bool) and message(string)
C++CommReplyContains success(bool) and message(string)
PythonDictContains success(bool) and message(string)
JavaServiceOperationResponseContains status and message

Code Example

csharp
// C#
robot.SpeechInitTTS(true);
python
# Python
await client.enable_tts_engine(True)
java
// Java
robot.SpeechEnableTts(true);
cpp
// C++
robot.enableTts(true);

GenerateAudio

Function Prototypes

  • C#: (bool success, string message) SpeechPlayTTS(string text, int sid = 0, float speed = 1.0f)
  • Python: async def generate_audio(text: str, sid: int = 0, speed: float = 1.0, timeout: float = 30.0) -> Optional[Dict]
  • Java: ServiceOperationResponse SpeechGenerateAudio(String text, int sid, float speed, int timeout)

Function Description
Converts text to speech and plays it.

Parameters

Parameter NameTypeRequired/DefaultDescription
textstringRequiredText content to convert
sidint0Speaker ID
speedfloat1.0Speech speed (0.7 ~ 1.3)
timeoutint/float30Timeout

Return Value

LanguageReturn TypeDescription
C#(bool, string)Contains success(bool) and message(string)
PythonDictContains success(bool) and message(string)
JavaServiceOperationResponseContains status and message

Code Example

csharp
// C#
robot.SpeechPlayTTS("Hello, I am Daystar Robot");
python
# Python
await client.generate_audio("Hello, I am Daystar Robot")
java
// Java
robot.SpeechGenerateAudio("Hello, I am Daystar Robot", 0, 1.0f, 30);

StopPlayingTts

Function Prototypes

  • C#: (bool success, string message) SpeechStopTTS()
  • C++: CommReply stopPlayingTts(bool enable)
  • Python: async def stop_playing_tts(timeout: float = 30.0) -> Optional[Dict]
  • Java: ServiceOperationResponse SpeechStopPlayingTts()

Function Description
Stops the currently playing TTS audio.

Parameters

Parameter NameTypeRequired/DefaultDescription
enableboolRequired (C++)Flag (usually true)
timeoutfloatOptional (Py)Timeout

Return Value

LanguageReturn TypeDescription
C#(bool, string)Contains success(bool) and message(string)
C++CommReplyContains success(bool) and message(string)
PythonDictContains success(bool) and message(string)
JavaServiceOperationResponseContains status and message

Code Example

csharp
// C#
robot.SpeechStopTTS();
python
# Python
await client.stop_playing_tts()
java
// Java
robot.SpeechStopPlayingTts();
cpp
// C++
robot.stopPlayingTts(true);

SwitchAudioSource

Function Prototypes

  • C#: (bool success, string message) SwitchAudioSource(int source, int id = 302, int timeoutMs = 5000)

Function Description
Switches the audio input source.

Parameters

Parameter NameTypeRequired/DefaultDescription
sourceintRequired0: Default (Robot), 1: External
timeoutMsintOptionalTimeout (ms)

Return Value

LanguageReturn TypeDescription
C#(bool, string)success, message

Code Example

csharp
// C#
robot.SwitchAudioSource(0);

SetDialogMode

Function Prototypes

  • C#: (bool success, string message) SetDialogMode(int mode, int id = 303, int timeoutMs = 5000)

Function Description
Sets the dialogue mode (Single-turn or Multi-turn).

Parameters

Parameter NameTypeRequired/DefaultDescription
modeintRequired0: Single-turn, 1: Multi-turn
timeoutMsintOptionalTimeout (ms)

Return Value

LanguageReturn TypeDescription
C#(bool, string)success, message

Code Example

csharp
// C#
robot.SetDialogMode(0);

SetVoiceRecognitionMode

Function Prototypes

  • C#: (bool success, string message) SetVoiceRecognitionMode(int mode, int id = 304, int timeoutMs = 5000)

Function Description
Switches the voice recognition mode (Online or Offline).

Parameters

Parameter NameTypeRequired/DefaultDescription
modeintRequired0: Online Mode, 1: Offline Mode
timeoutMsintOptionalTimeout (ms)

Return Value

LanguageReturn TypeDescription
C#(bool, string)success, message

Code Example

csharp
// C#
robot.SetVoiceRecognitionMode(0);

RegisterASRCallback

Function Prototypes

  • C#: bool SpeechRegisterASRResult(Action<object> callback)
  • C++: bool subscribeSpeechAsrResult()
  • Python: async def subscribe_asr_result(callback: Callable[[Dict], None]) -> bool
  • Java: void RegisterSpeechAsrResult(Consumer<SpeechAsrResult> callback)

Function Description
Registers a callback for ASR recognition results.

Parameters

Parameter NameTypeRequired/DefaultDescription
callbackfunctionRequiredASR result callback function

Return Value

LanguageReturn TypeDescription
C#boolWhether subscription was successful
C++boolTrue if subscribed successfully
PythonboolTrue if subscribed successfully
JavavoidNo return value

Code Example

csharp
// C#
robot.SpeechRegisterASRResult(data => {
    // data is the ASR result object
});
python
# Python
# See Python example
java
// Java
robot.RegisterSpeechAsrResult(result -> {
    System.out.println("ASR Text: " + result.text);
});
cpp
// C++
robot.subscribeSpeechAsrResult();