Show / Hide Table of Contents

Class VoiceSummary

Details related to the voice available for the given language code and voice type.

Inheritance
object
VoiceSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.AispeechService.Models
Assembly: OCI.DotNetSDK.Aispeech.dll
Syntax
public class VoiceSummary

Properties

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A small description of the voice like its language and voice type.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly display name of the language for the user.

Remarks

Required

Gender

Declaration
[Required(ErrorMessage = "Gender is required.")]
[JsonProperty(PropertyName = "gender")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VoiceSummary.GenderEnum? Gender { get; set; }
Property Value
Type Description
VoiceSummary.GenderEnum?

Gender of the speaker.

Remarks

Required

IsDefaultVoice

Declaration
[JsonProperty(PropertyName = "isDefaultVoice")]
public bool? IsDefaultVoice { get; set; }
Property Value
Type Description
bool?

Whether this voice id is default voice used for inference.

LanguageCode

Declaration
[JsonProperty(PropertyName = "languageCode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VoiceSummary.LanguageCodeEnum? LanguageCode { get; set; }
Property Value
Type Description
VoiceSummary.LanguageCodeEnum?

An abbreviated notation of region to which the language and accent of the speaker belongs to.

LanguageDescription

Declaration
[JsonProperty(PropertyName = "languageDescription")]
public string LanguageDescription { get; set; }
Property Value
Type Description
string

A description of region to which the language and accent of the speaker belongs to.

SampleRateInHertz

Declaration
[Required(ErrorMessage = "SampleRateInHertz is required.")]
[JsonProperty(PropertyName = "sampleRateInHertz")]
public int? SampleRateInHertz { get; set; }
Property Value
Type Description
int?

The sample rate of the speaker in Hertz.

Remarks

Required

SupportedModels

Declaration
[JsonProperty(PropertyName = "supportedModels")]
public List<string> SupportedModels { get; set; }
Property Value
Type Description
List<string>

Models the particular speaker is aligned to.

VoiceId

Declaration
[Required(ErrorMessage = "VoiceId is required.")]
[JsonProperty(PropertyName = "voiceId")]
public string VoiceId { get; set; }
Property Value
Type Description
string

Unique Id of the voice.

Remarks

Required

WordsPerMinute

Declaration
[Required(ErrorMessage = "WordsPerMinute is required.")]
[JsonProperty(PropertyName = "wordsPerMinute")]
public int? WordsPerMinute { get; set; }
Property Value
Type Description
int?

The number of words the speaker can narrate per minute. It signifies the speed of the speech produced by the speaker.

Remarks

Required

In this article
Back to top