Files
firebase-js-sdk/docs-devsite/ai.multispeakerspeechconfig.md
T
sedanah-mandGitHub e88c1c4126 feat(ai): support text-to-speech capabilities (single & multi-speaker configurations) for non-Live API models (#10145)
* feat(ai): implementmulti-speaker speech config; includes tests

* add changeset, fix typo

* fix: yarn format

* fix changeset

* fix changeset typo

* remove unnecessary tests; fix interface description to match proposal

* Generate documentation

* fix: yarn format & lint fix

* add more descriptive changeset

* Adds tests for speech config to check if its correctly passed through to the API requests for both generateContent and generateContentStream methods

* yarn format

* yarn format

* Refine changeset file description

* Fix typo

* format fix

* update description BaseSpeechConfig

* update descriptions

* format doc

* yarn format

* fix @ typo over MultiSpeakerSpeechConfig

* fix: adjusted description wording for the interfaces; fix: public tags to beta

* fix: formatting using @remarks

* fix: typo

* yarn format

* run yarn docgen:all

* update SpeechConfig to beta

* update speech config to beta

* upd SingleSpeakerSpeechConfig description

* doc generation
2026-07-27 13:40:50 -07:00

2.0 KiB

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

MultiSpeakerSpeechConfig interface

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Configuration for speech synthesis with multiple speakers.

Signature:

export interface MultiSpeakerSpeechConfig extends BaseSpeechConfig 

Extends: BaseSpeechConfig

Properties

Property Type Description
multiSpeakerVoiceConfig MultiSpeakerVoiceConfig (Public Preview) Configuration for multi-speaker setup.
voiceConfig never (Public Preview) Single-speaker voice configuration must not be set when using multiple speakers.

MultiSpeakerSpeechConfig.multiSpeakerVoiceConfig

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Configuration for multi-speaker setup.

Signature:

multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;

MultiSpeakerSpeechConfig.voiceConfig

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Single-speaker voice configuration must not be set when using multiple speakers.

Signature:

voiceConfig?: never;