public sealed class SynthesisInput : IMessage<SynthesisInput>, IEquatable<SynthesisInput>, IDeepCloneable<SynthesisInput>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Text-to-Speech v1beta1 API class SynthesisInput.
Contains text input to be synthesized. Either text or ssml must be
supplied. Supplying both or neither returns
[google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. The
input size is limited to 5000 bytes.
Implements
IMessageSynthesisInput, IEquatableSynthesisInput, IDeepCloneableSynthesisInput, IBufferMessage, IMessageNamespace
Google.Cloud.TextToSpeech.V1Beta1Assembly
Google.Cloud.TextToSpeech.V1Beta1.dll
Constructors
SynthesisInput()
public SynthesisInput()SynthesisInput(SynthesisInput)
public SynthesisInput(SynthesisInput other)| Parameter | |
|---|---|
| Name | Description |
other |
SynthesisInput |
Properties
CustomPronunciations
public CustomPronunciations CustomPronunciations { get; set; }Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations.
The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported.
In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag.
| Property Value | |
|---|---|
| Type | Description |
CustomPronunciations |
|
HasMarkup
public bool HasMarkup { get; }Gets whether the "markup" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasPrompt
public bool HasPrompt { get; }Gets whether the "prompt" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSsml
public bool HasSsml { get; }Gets whether the "ssml" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasText
public bool HasText { get; }Gets whether the "text" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
InputSourceCase
public SynthesisInput.InputSourceOneofCase InputSourceCase { get; }| Property Value | |
|---|---|
| Type | Description |
SynthesisInputInputSourceOneofCase |
|
Markup
public string Markup { get; set; }Markup for HD voices specifically. This field may not be used with any other voices.
| Property Value | |
|---|---|
| Type | Description |
string |
|
MultiSpeakerMarkup
public MultiSpeakerMarkup MultiSpeakerMarkup { get; set; }The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis.
| Property Value | |
|---|---|
| Type | Description |
MultiSpeakerMarkup |
|
Prompt
public string Prompt { get; set; }This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Ssml
public string Ssml { get; set; }The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For more information, see SSML.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Text
public string Text { get; set; }The raw text to be synthesized.
| Property Value | |
|---|---|
| Type | Description |
string |
|