SynthesisTask

public struct SynthesisTask : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Timestamp for the time the synthesis task was started.

    Declaration

    Swift

    public let creationTime: TimeStamp?

  • Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

    Declaration

    Swift

    public let engine: Engine?

  • Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

    Declaration

    Swift

    public let languageCode: LanguageCode?

  • List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

    Declaration

    Swift

    public let lexiconNames: [String]?

  • The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

    Declaration

    Swift

    public let outputFormat: OutputFormat?

  • Pathway for the output speech file.

    Declaration

    Swift

    public let outputUri: String?

  • Number of billable characters synthesized.

    Declaration

    Swift

    public let requestCharacters: Int?

  • The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are “8000”, “16000”, “22050”, and “24000”. The default value for standard voices is “22050”. The default value for neural voices is “24000”. Valid values for pcm are “8000” and “16000” The default value is “16000”.

    Declaration

    Swift

    public let sampleRate: String?

  • ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

    Declaration

    Swift

    public let snsTopicArn: String?

  • The type of speech marks returned for the input text.

    Declaration

    Swift

    public let speechMarkTypes: [SpeechMarkType]?

  • The Amazon Polly generated identifier for a speech synthesis task.

    Declaration

    Swift

    public let taskId: String?

  • Current status of the individual speech synthesis task.

    Declaration

    Swift

    public let taskStatus: TaskStatus?

  • Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

    Declaration

    Swift

    public let taskStatusReason: String?

  • Specifies whether the input text is plain text or SSML. The default value is plain text.

    Declaration

    Swift

    public let textType: TextType?

  • Voice ID to use for the synthesis.

    Declaration

    Swift

    public let voiceId: VoiceId?

  • Undocumented

    Declaration

    Swift

    public init(creationTime: TimeStamp? = nil, engine: Engine? = nil, languageCode: LanguageCode? = nil, lexiconNames: [String]? = nil, outputFormat: OutputFormat? = nil, outputUri: String? = nil, requestCharacters: Int? = nil, sampleRate: String? = nil, snsTopicArn: String? = nil, speechMarkTypes: [SpeechMarkType]? = nil, taskId: String? = nil, taskStatus: TaskStatus? = nil, taskStatusReason: String? = nil, textType: TextType? = nil, voiceId: VoiceId? = nil)