TtsClient

java.lang.Object
- ohos.ai.tts.TtsClient

```
public class TtsClient
extends Object
```
Provides methods for invoking the text to speech (TTS) engine service.
The methods include speakText(java.lang.String,java.lang.String), speakLongText(java.lang.String,java.lang.String), and stopSpeak().

从以下版本开始:

3

字段概要

字段
限定符和类型	字段	说明
`static int`	`METHOD_CREATE`	Identifies the `create(ohos.app.Context,ohos.ai.tts.TtsListener)` method.
`static int`	`METHOD_DESTROY`	Identifies the `destroy()` method.
`static int`	`METHOD_RELEASE`	Identifies the `release()` method.
`static int`	`METHOD_SPEAK_LONG_TEXT`	Identifies the `speakLongText(java.lang.String,java.lang.String)` method.
`static int`	`METHOD_SPEAK_TEXT`	Identifies the `speakText(java.lang.String,java.lang.String)` method.
`static int`	`METHOD_STOP_SPEAK`	Identifies the `stopSpeak()` method.
`static String`	`PAC_MAP_KEY_METHOD_ID`	Indicates the key of the input parameter `PacMap` for the `TtsListener#onEvent(int, PacMap)` method.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`void`	`create(Context context, TtsListener ttsListener)`	Creates a TTS client.
`void`	`destroy()`	Destroys the TTS client.
`static TtsClient`	`getInstance()`	Returns a singleton instance of `TtsClient`.
`Optional<String>`	`getVersion()`	Obtains the version of TTS software development kit (SDK).
`boolean`	`init(TtsParams ttsParams)`	Initializes the TTS client.
`boolean`	`isSpeaking()`	Checks whether TTS speaking is in progress.
`void`	`release()`	Releases the TTS engine in use.
`boolean`	`setAudioType(AudioManager.AudioVolumeType audioType)`	Sets the audio stream type.
`boolean`	`setParams(TtsParams ttsParams)`	Sets TTS parameters.
`void`	`speakLongText(String longText, String utteranceId)`	Synthesizes long text into audio and starts speaking.
`void`	`speakText(String text, String utteranceId)`	Synthesizes text into audio and starts speaking.
`void`	`stopSpeak()`	Stops TTS speaking.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - METHOD_CREATE
```
public static final int METHOD_CREATE
```
    Identifies the create(ohos.app.Context,ohos.ai.tts.TtsListener) method.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - METHOD_DESTROY
```
public static final int METHOD_DESTROY
```
    Identifies the destroy() method.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - METHOD_RELEASE
```
public static final int METHOD_RELEASE
```
    Identifies the release() method.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - METHOD_SPEAK_LONG_TEXT
```
public static final int METHOD_SPEAK_LONG_TEXT
```
    Identifies the speakLongText(java.lang.String,java.lang.String) method.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - METHOD_SPEAK_TEXT
```
public static final int METHOD_SPEAK_TEXT
```
    Identifies the speakText(java.lang.String,java.lang.String) method.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - METHOD_STOP_SPEAK
```
public static final int METHOD_STOP_SPEAK
```
    Identifies the stopSpeak() method.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - PAC_MAP_KEY_METHOD_ID
```
public static final String PAC_MAP_KEY_METHOD_ID
```
    Indicates the key of the input parameter PacMap for the TtsListener#onEvent(int, PacMap) method.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getInstance
```
public static TtsClient getInstance()
```
    Returns a singleton instance of TtsClient.
    If there is a TtsClient object, this method will return it to the caller. If there is no TtsClient object, this method will create one and return it to the caller.
    
    返回:
    
    Returns the singleton instance of TtsClient.
    
    从以下版本开始:
    
    3
  - create
```
public void create(Context context,
                   TtsListener ttsListener)
```
    Creates a TTS client.
    You can obtain the creation result (success or failure) from TtsListener#onEvent(int, PacMap).
    
    参数:
    
    context - Indicates the application context. This parameter cannot be null.
    
    ttsListener - Indicates the listener for observing the TTS callback process and result. You are not advised to set this parameter to null because the null value will cause a failure to obtain the execution status of methods in this class.
    
    从以下版本开始:
    
    3
  - release
```
public void release()
```
    Releases the TTS engine in use.
    Calling this method will set the initialization status to false and stop the ongoing speaking task. Therefore, you are advised to use this method before calling init(ohos.ai.tts.TtsParams).
    
    从以下版本开始:
    
    3
  - init
```
public boolean init(TtsParams ttsParams)
```
    Initializes the TTS client.
    You can set the device ID, device type, speaking speed, volume, pitch, and timbre in the input parameter ttsParams. Among them, the device ID is mandatory. If it is not set, the initialization will fail.
    参数:
    ttsParams - Indicates initialization parameters, including the following fields:
    
    Device ID: length from 1 to 64 (all spaces are not allowed to form a device ID).
    
    Device type: an integer ranging from 0 (default value) to 4. 0 represents a mobile phone,1 for a speaker, 2 for a web-based device,3 for a tablet, and 4 for a large screen.
    Speaking speed: an integer ranging from 0 to 15, with 5 as the default value
    Volume: an integer ranging from 0 to 15, with 11 as the default valuePitch: an integer ranging from 0 to 15, with 5 as the default value
    Timbre: 0 for SPEAKER_XIAOYI and 1 for SPEAKER_YOYO, with 0 as the default value
    
    If the value for any of these fields is incorrect, the TTS engine will fail to be initialized.
    返回:
    
    Returns true if the initialization is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setParams
```
public boolean setParams(TtsParams ttsParams)
```
    Sets TTS parameters.
    You can use this method to modify the speaking volume, pitch, speed, and timbre in ttsParams. You are advised to use this method after you have called init(ohos.ai.tts.TtsParams).
    
    参数:
    
    ttsParams - Indicates TTS parameters (speaking volume, pitch, speed, and timbre, each ranging from 0 to 15).
    If any of these parameters is invalid, the parameter settings will fail; if other parameters (device ID and device type) are passed to this method without verification, the parameters will not be used even if the settings are successful. Instead, the TTS engine will use the parameters (device ID and device type) in the init(ohos.ai.tts.TtsParams) method.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setAudioType
```
public boolean setAudioType(AudioManager.AudioVolumeType audioType)
```
    Sets the audio stream type.
    You can call this method before enabling audio speaking.
    参数:
    audioType - Indicates the audio stream type. Currently, the following types are supported:
    
    AudioManager.AudioVolumeType.STREAM_MUSIC (default value)
    
    AudioManager.AudioVolumeType.STREAM_VOICE_CALL
    
    AudioManager.AudioVolumeType.STREAM_SYSTEM
    
    AudioManager.AudioVolumeType.STREAM_RING
    
    AudioManager.AudioVolumeType.STREAM_NOTIFICATION
    
    AudioManager.AudioVolumeType.STREAM_ALARM
    
    AudioManager.AudioVolumeType.STREAM_DTMF
    
    AudioManager.AudioVolumeType.STREAM_TTS
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - speakText
```
public void speakText(String text,
                      String utteranceId)
```
    Synthesizes text into audio and starts speaking.
    
    参数:
    
    text - Indicates the text to speak. The maximum text length is 512. If the length exceeds 512 or the text is empty, an error occurs and is passed in TtsListener#onError(String, String) to the caller.
    
    utteranceId - Uniquely identifies a speaking request. If this parameter is null or an empty string, the TTS engine randomly generates a value for this parameter.
    
    从以下版本开始:
    
    3
  - speakLongText
```
public void speakLongText(String longText,
                          String utteranceId)
```
    Synthesizes long text into audio and starts speaking.
    This method is an enhancement of speakText(java.lang.String,java.lang.String).
    
    参数:
    
    longText - Indicates the long text to speak. The maximum length for long text is 100000. If the length exceeds 100000 or the text is empty, an error occurs and is passed in TtsListener#onError(String, String) to the caller.
    
    utteranceId - Uniquely identifies a speaking request. If this parameter is null or an empty string, the TTS engine randomly generates a value for this parameter.
    
    从以下版本开始:
    
    3
  - isSpeaking
```
public boolean isSpeaking()
```
    Checks whether TTS speaking is in progress.
    
    返回:
    
    Returns true if TTS speaking is in progress; returns false otherwise.
    
    从以下版本开始:
    
    3
  - stopSpeak
```
public void stopSpeak()
```
    Stops TTS speaking.
    If a TTS task stopped by this method is restarted, speaking starts from the beginning instead of where the previous speaking stopped.
    
    从以下版本开始:
    
    3
  - getVersion
```
public Optional<String> getVersion()
```
    Obtains the version of TTS software development kit (SDK).
    
    返回:
    
    Returns the SDK version number encapsulated by Optional. You can call the get method in Optional to obtain the SDK version number represented by a string.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    Optional
  - destroy
```
public void destroy()
```
    Destroys the TTS client.
    You must use this method after all ongoing TTS tasks are complete.
    
    从以下版本开始:
    
    3

类 TtsClient

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

METHOD_CREATE

METHOD_DESTROY

METHOD_RELEASE

METHOD_SPEAK_LONG_TEXT

METHOD_SPEAK_TEXT

METHOD_STOP_SPEAK

PAC_MAP_KEY_METHOD_ID

方法详细资料

getInstance

create

release

init

setParams

setAudioType

speakText

speakLongText

isSpeaking

stopSpeak

getVersion

destroy