Reference documentation and code samples for the Cloud Text-to-Speech V1 API class Google::Cloud::TextToSpeech::V1::StreamingSynthesisInput.
Input to be synthesized.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#markup
defmarkup()->::String
Returns
(::String) — Markup for HD voices specifically. This field may not be used with any
other voices.
Note: The following fields are mutually exclusive: markup, text. If a field in that set is populated, all other fields in the set will automatically be cleared.
#markup=
defmarkup=(value)->::String
Parameter
value (::String) — Markup for HD voices specifically. This field may not be used with any
other voices.
Note: The following fields are mutually exclusive: markup, text. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — Markup for HD voices specifically. This field may not be used with any
other voices.
Note: The following fields are mutually exclusive: markup, text. If a field in that set is populated, all other fields in the set will automatically be cleared.
#prompt
defprompt()->::String
Returns
(::String) — This is system instruction supported only for controllable voice models.
#prompt=
defprompt=(value)->::String
Parameter
value (::String) — This is system instruction supported only for controllable voice models.
Returns
(::String) — This is system instruction supported only for controllable voice models.
#text
deftext()->::String
Returns
(::String) — The raw text to be synthesized. It is recommended that each input
contains complete, terminating sentences, which results in better prosody
in the output audio.
Note: The following fields are mutually exclusive: text, markup. If a field in that set is populated, all other fields in the set will automatically be cleared.
#text=
deftext=(value)->::String
Parameter
value (::String) — The raw text to be synthesized. It is recommended that each input
contains complete, terminating sentences, which results in better prosody
in the output audio.
Note: The following fields are mutually exclusive: text, markup. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — The raw text to be synthesized. It is recommended that each input
contains complete, terminating sentences, which results in better prosody
in the output audio.
Note: The following fields are mutually exclusive: text, markup. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Text-to-Speech V1 API - Class Google::Cloud::TextToSpeech::V1::StreamingSynthesisInput (v1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/ruby/docs/reference/google-cloud-text_to_speech-v1/latest/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [1.8.1](/ruby/docs/reference/google-cloud-text_to_speech-v1/1.8.1/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [1.7.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/1.7.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [1.6.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/1.6.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [1.5.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/1.5.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [1.4.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/1.4.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [1.3.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/1.3.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [1.2.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/1.2.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [1.1.1](/ruby/docs/reference/google-cloud-text_to_speech-v1/1.1.1/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [1.0.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/1.0.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [0.13.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/0.13.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [0.12.2](/ruby/docs/reference/google-cloud-text_to_speech-v1/0.12.2/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [0.11.1](/ruby/docs/reference/google-cloud-text_to_speech-v1/0.11.1/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [0.10.1](/ruby/docs/reference/google-cloud-text_to_speech-v1/0.10.1/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [0.9.1](/ruby/docs/reference/google-cloud-text_to_speech-v1/0.9.1/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [0.8.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/0.8.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [0.7.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/0.7.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [0.6.0](/ruby/docs/reference/google-cloud-text_to_speech-v1/0.6.0/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput)\n- [0.5.2](/ruby/docs/reference/google-cloud-text_to_speech-v1/0.5.2/Google-Cloud-TextToSpeech-V1-StreamingSynthesisInput) \nReference documentation and code samples for the Cloud Text-to-Speech V1 API class Google::Cloud::TextToSpeech::V1::StreamingSynthesisInput.\n\nInput to be synthesized. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #markup\n\n def markup() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Markup for HD voices specifically. This field may not be used with any other voices.\n\n Note: The following fields are mutually exclusive: `markup`, `text`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #markup=\n\n def markup=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Markup for HD voices specifically. This field may not be used with any other voices.\n\n\nNote: The following fields are mutually exclusive: `markup`, `text`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- Markup for HD voices specifically. This field may not be used with any other voices.\n\n Note: The following fields are mutually exclusive: `markup`, `text`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #text\n\n def text() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The raw text to be synthesized. It is recommended that each input contains complete, terminating sentences, which results in better prosody in the output audio.\n\n Note: The following fields are mutually exclusive: `text`, `markup`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #text=\n\n def text=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The raw text to be synthesized. It is recommended that each input contains complete, terminating sentences, which results in better prosody in the output audio.\n\n\nNote: The following fields are mutually exclusive: `text`, `markup`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- The raw text to be synthesized. It is recommended that each input contains complete, terminating sentences, which results in better prosody in the output audio.\n\n Note: The following fields are mutually exclusive: `text`, `markup`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]