你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SpeechSynthesizer class

包:

microsoft-cognitiveservices-speech-sdk

定义用于文本转语音的类 SpeechSynthesizer。 在版本 1.16.0 中更新

Extends

Synthesizer

构造函数

SpeechSynthesizer(SpeechConfig, AudioConfig)

SpeechSynthesizer 构造函数。

属性

authorizationToken	获取用于与服务通信的授权令牌。
autoDetectSourceLanguage	指示是否启用了自动检测源语言
bookmarkReached	为在版本 1.16.0 中添加的书签到达事件定义事件处理程序
internalData
properties	为此合成器定义的属性及其值的集合。
SynthesisCanceled	为合成取消的事件定义事件处理程序。
synthesisCompleted	定义用于合成已完成事件的事件处理程序。
synthesisStarted	定义合成启动事件的事件处理程序。
synthesizing	定义用于合成事件的事件处理程序。
visemeReceived	为版本 1.16.0 中添加的 viseme 接收事件定义事件处理程序
wordBoundary	为字边界事件定义事件处理程序

方法

close(() => void, (error: string) => void)	释放关联的资源。
FromConfig(SpeechConfig, AutoDetectSourceLanguageConfig, AudioConfig)	SpeechSynthesizer 构造函数。
getVoicesAsync(string)	获取可用的合成语音列表。 该任务返回合成语音结果。
speakSsmlAsync(string, (e: SpeechSynthesisResult) => void, (e: string) => void, PathLike | AudioOutputStream | PushAudioOutputStreamCallback)	在 SSML 上执行语音合成。 任务返回合成结果。
speakTextAsync(string, (e: SpeechSynthesisResult) => void, (e: string) => void, PathLike | AudioOutputStream | PushAudioOutputStreamCallback)	对纯文本执行语音合成。 任务返回合成结果。

继承的方法

buildSsml(string)
dispose(boolean)	此方法执行资源的清理。 布尔参数释放指示在释放) 为 true 时，是从 Dispose (调用方法，还是从终结器 (如果释放为 false) 调用方法。 派生类应重写此方法，以便根据需要释放资源。

构造函数详细信息

SpeechSynthesizer(SpeechConfig, AudioConfig)

SpeechSynthesizer 构造函数。

new SpeechSynthesizer(speechConfig: SpeechConfig, audioConfig?: AudioConfig)

参数

speechConfig

SpeechConfig

此合成器的初始属性集。

audioConfig

AudioConfig

与合成器关联的可选音频配置。

属性详细信息

authorizationToken

获取用于与服务通信的授权令牌。

string authorizationToken

属性值

string

授权令牌。

autoDetectSourceLanguage

指示是否启用了自动检测源语言

boolean autoDetectSourceLanguage

属性值

boolean

如果启用了自动检测源语言，则为

bookmarkReached

为在版本 1.16.0 中添加的书签到达事件定义事件处理程序

public bookmarkReached: (sender: SpeechSynthesizer, event: SpeechSynthesisBookmarkEventArgs) => void

属性值

(sender: SpeechSynthesizer, event: SpeechSynthesisBookmarkEventArgs) => void

internalData

object internalData

属性值

object

properties

为此合成器定义的属性及其值的集合。

PropertyCollection properties

属性值

PropertyCollection

为此 SpeechSynthesizer 定义的属性及其值的集合。

SynthesisCanceled

为合成取消的事件定义事件处理程序。

public SynthesisCanceled: (sender: SpeechSynthesizer, event: SpeechSynthesisEventArgs) => void

属性值

(sender: SpeechSynthesizer, event: SpeechSynthesisEventArgs) => void

synthesisCompleted

定义用于合成已完成事件的事件处理程序。

public synthesisCompleted: (sender: SpeechSynthesizer, event: SpeechSynthesisEventArgs) => void

属性值

(sender: SpeechSynthesizer, event: SpeechSynthesisEventArgs) => void

synthesisStarted

定义合成启动事件的事件处理程序。

public synthesisStarted: (sender: SpeechSynthesizer, event: SpeechSynthesisEventArgs) => void

属性值

(sender: SpeechSynthesizer, event: SpeechSynthesisEventArgs) => void

synthesizing

定义用于合成事件的事件处理程序。

public synthesizing: (sender: SpeechSynthesizer, event: SpeechSynthesisEventArgs) => void

属性值

(sender: SpeechSynthesizer, event: SpeechSynthesisEventArgs) => void

visemeReceived

为版本 1.16.0 中添加的 viseme 接收事件定义事件处理程序

public visemeReceived: (sender: SpeechSynthesizer, event: SpeechSynthesisVisemeEventArgs) => void

属性值

(sender: SpeechSynthesizer, event: SpeechSynthesisVisemeEventArgs) => void

wordBoundary

为字边界事件定义事件处理程序

public wordBoundary: (sender: SpeechSynthesizer, event: SpeechSynthesisWordBoundaryEventArgs) => void

属性值

(sender: SpeechSynthesizer, event: SpeechSynthesisWordBoundaryEventArgs) => void

方法详细信息

close(() => void, (error: string) => void)

释放关联的资源。

function close(cb?: () => void, err?: (error: string) => void)

参数

cb

() => void

err

(error: string) => void

FromConfig(SpeechConfig, AutoDetectSourceLanguageConfig, AudioConfig)

SpeechSynthesizer 构造函数。

static function FromConfig(speechConfig: SpeechConfig, autoDetectSourceLanguageConfig: AutoDetectSourceLanguageConfig, audioConfig?: AudioConfig): SpeechSynthesizer

参数

speechConfig

SpeechConfig

此合成器的初始属性集

autoDetectSourceLanguageConfig

AutoDetectSourceLanguageConfig

与合成器关联的源语言检测配置

audioConfig

AudioConfig

与合成器关联的可选音频配置

返回

SpeechSynthesizer

getVoicesAsync(string)

获取可用的合成语音列表。 该任务返回合成语音结果。

function getVoicesAsync(locale?: string): Promise<SynthesisVoicesResult>

参数

locale

string

BCP-47 格式语音的区域设置;如果留空，则获取所有可用语音。

返回

Promise<SynthesisVoicesResult>

• SynthesisVoicesResult 的承诺。

speakSsmlAsync(string, (e: SpeechSynthesisResult) => void, (e: string) => void, PathLike | AudioOutputStream | PushAudioOutputStreamCallback)

在 SSML 上执行语音合成。 任务返回合成结果。

function speakSsmlAsync(ssml: string, cb?: (e: SpeechSynthesisResult) => void, err?: (e: string) => void, stream?: PathLike | AudioOutputStream | PushAudioOutputStreamCallback)

参数

ssml

string

要合成的 SSML。

cb

(e: SpeechSynthesisResult) => void

接收 SpeechSynthesisResult 的回调。

err

(e: string) => void

发生错误时调用的回调。

stream

PathLike | AudioOutputStream | PushAudioOutputStreamCallback

用于接收合成音频的 AudioOutputStream。

speakTextAsync(string, (e: SpeechSynthesisResult) => void, (e: string) => void, PathLike | AudioOutputStream | PushAudioOutputStreamCallback)

对纯文本执行语音合成。 任务返回合成结果。

function speakTextAsync(text: string, cb?: (e: SpeechSynthesisResult) => void, err?: (e: string) => void, stream?: PathLike | AudioOutputStream | PushAudioOutputStreamCallback)

参数

text

string

要合成的文本。

cb

(e: SpeechSynthesisResult) => void

接收 SpeechSynthesisResult 的回调。

err

(e: string) => void

发生错误时调用的回调。

stream

PathLike | AudioOutputStream | PushAudioOutputStreamCallback

用于接收合成音频的 AudioOutputStream。

继承的方法详细信息

buildSsml(string)

function buildSsml(text: string): string

参数

text

string

返回

string

继承自Synthesizer.buildSsml

dispose(boolean)

此方法执行资源的清理。 布尔参数释放指示在释放) 为 true 时，是从 Dispose (调用方法，还是从终结器 (如果释放为 false) 调用方法。 派生类应重写此方法，以便根据需要释放资源。

function dispose(disposing: boolean): Promise<void>

参数

disposing

boolean

请求处置的标志。

返回

Promise<void>

继承自Synthesizer.dispose