TtsOracleSpeechSettings¶

class oci.ai_speech.models.TtsOracleSpeechSettings(**kwargs)¶

Bases: object

Settings to use for generating speech with a model from ORACLE family.

Attributes

`OUTPUT_FORMAT_JSON`	A constant which can be used with the output_format property of a TtsOracleSpeechSettings.
`OUTPUT_FORMAT_MP3`	A constant which can be used with the output_format property of a TtsOracleSpeechSettings.
`OUTPUT_FORMAT_OGG`	A constant which can be used with the output_format property of a TtsOracleSpeechSettings.
`OUTPUT_FORMAT_PCM`	A constant which can be used with the output_format property of a TtsOracleSpeechSettings.
`SPEECH_MARK_TYPES_SENTENCE`	A constant which can be used with the speech_mark_types property of a TtsOracleSpeechSettings.
`SPEECH_MARK_TYPES_WORD`	A constant which can be used with the speech_mark_types property of a TtsOracleSpeechSettings.
`TEXT_TYPE_SSML`	A constant which can be used with the text_type property of a TtsOracleSpeechSettings.
`TEXT_TYPE_TEXT`	A constant which can be used with the text_type property of a TtsOracleSpeechSettings.
`output_format`	Gets the output_format of this TtsOracleSpeechSettings.
`sample_rate_in_hz`	Gets the sample_rate_in_hz of this TtsOracleSpeechSettings.
`speech_mark_types`	Gets the speech_mark_types of this TtsOracleSpeechSettings.
`text_type`	Gets the text_type of this TtsOracleSpeechSettings.

Methods

__init__(**kwargs) Initializes a new TtsOracleSpeechSettings object with values from keyword arguments.

OUTPUT_FORMAT_JSON = 'JSON'¶: A constant which can be used with the output_format property of a TtsOracleSpeechSettings. This constant has a value of “JSON”

OUTPUT_FORMAT_MP3 = 'MP3'¶: A constant which can be used with the output_format property of a TtsOracleSpeechSettings. This constant has a value of “MP3”

OUTPUT_FORMAT_OGG = 'OGG'¶: A constant which can be used with the output_format property of a TtsOracleSpeechSettings. This constant has a value of “OGG”

OUTPUT_FORMAT_PCM = 'PCM'¶: A constant which can be used with the output_format property of a TtsOracleSpeechSettings. This constant has a value of “PCM”

SPEECH_MARK_TYPES_SENTENCE = 'SENTENCE'¶: A constant which can be used with the speech_mark_types property of a TtsOracleSpeechSettings. This constant has a value of “SENTENCE”

SPEECH_MARK_TYPES_WORD = 'WORD'¶: A constant which can be used with the speech_mark_types property of a TtsOracleSpeechSettings. This constant has a value of “WORD”

TEXT_TYPE_SSML = 'SSML'¶: A constant which can be used with the text_type property of a TtsOracleSpeechSettings. This constant has a value of “SSML”

TEXT_TYPE_TEXT = 'TEXT'¶: A constant which can be used with the text_type property of a TtsOracleSpeechSettings. This constant has a value of “TEXT”

__init__(**kwargs)¶

Initializes a new TtsOracleSpeechSettings object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

text_type (str) – The value to assign to the text_type property of this TtsOracleSpeechSettings. Allowed values for this property are: “TEXT”, “SSML”
sample_rate_in_hz (int) – The value to assign to the sample_rate_in_hz property of this TtsOracleSpeechSettings.
output_format (str) – The value to assign to the output_format property of this TtsOracleSpeechSettings. Allowed values for this property are: “MP3”, “OGG”, “PCM”, “JSON”
speech_mark_types (list[str]) – The value to assign to the speech_mark_types property of this TtsOracleSpeechSettings. Allowed values for items in this list are: “SENTENCE”, “WORD”

output_format¶

Gets the output_format of this TtsOracleSpeechSettings. The format of audio in which the user wants the audio to be in. The supported output formats are: - MP3 - OGG - PCM - JSON

Allowed values for this property are: “MP3”, “OGG”, “PCM”, “JSON”

Returns:	The output_format of this TtsOracleSpeechSettings.
Return type:	str

sample_rate_in_hz¶

Gets the sample_rate_in_hz of this TtsOracleSpeechSettings. The sample rate of the generated audio. By default, the audio will be generated with speaker voice sample rate.

Returns:	The sample_rate_in_hz of this TtsOracleSpeechSettings.
Return type:	int

speech_mark_types¶

Gets the speech_mark_types of this TtsOracleSpeechSettings. The kind of time stamp markings the user wants for the audio. This property should be provided if outputFormat is json, otherwise it will be ignored. null value (i.e. no value is not specified) indicates no speech marking. The supported speech mark types are: - SENTENCE - WORD

Allowed values for items in this list are: “SENTENCE”, “WORD”

Returns:	The speech_mark_types of this TtsOracleSpeechSettings.
Return type:	list[str]

text_type¶

Gets the text_type of this TtsOracleSpeechSettings. The format in which the input text has been supplied i.e., Text or SSML. The supported text types are: - TEXT - SSML

Allowed values for this property are: “TEXT”, “SSML”

Returns:	The text_type of this TtsOracleSpeechSettings.
Return type:	str