AWSTranscribeTranscriptionJob

Objective-C

@interface AWSTranscribeTranscriptionJob

Swift

class AWSTranscribeTranscriptionJob

Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

  • A timestamp that shows when the job completed.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable completionTime;

    Swift

    var completionTime: Date? { get set }
  • An object that describes content redaction settings for the transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeContentRedaction *_Nullable contentRedaction;

    Swift

    var contentRedaction: AWSTranscribeContentRedaction? { get set }
  • A timestamp that shows when the job was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable creationTime;

    Swift

    var creationTime: Date? { get set }
  • If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

    The FailureReason field can contain one of the following values:

    • Unsupported media format - The media format specified in the MediaFormat field of the request isn’t valid. See the description of the MediaFormat field for a list of valid values.

    • The media format provided does not match the detected media format - The media format of the audio file doesn’t match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match.

    • Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn’t valid. The sample rate must be between 8,000 and 48,000 Hertz.

    • The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn’t match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

    • Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.

    • Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable failureReason;

    Swift

    var failureReason: String? { get set }
  • A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable identifiedLanguageScore;

    Swift

    var identifiedLanguageScore: NSNumber? { get set }
  • A value that shows if automatic language identification was enabled for a transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable identifyLanguage;

    Swift

    var identifyLanguage: NSNumber? { get set }
  • Provides information about how a transcription job is executed.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeJobExecutionSettings *_Nullable jobExecutionSettings;

    Swift

    var jobExecutionSettings: AWSTranscribeJobExecutionSettings? { get set }
  • The language code for the input speech.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeLanguageCode languageCode;

    Swift

    var languageCode: AWSTranscribeLanguageCode { get set }
  • Language-specific settings that can be specified when language identification is enabled for your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, AWSTranscribeLanguageIdSettings *> *_Nullable languageIdSettings;

    Swift

    var languageIdSettings: [String : AWSTranscribeLanguageIdSettings]? { get set }
  • An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable languageOptions;

    Swift

    var languageOptions: [String]? { get set }
  • An object that describes the input media for the transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeMedia *_Nullable media;

    Swift

    var media: AWSTranscribeMedia? { get set }
  • The format of the input media file.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeMediaFormat mediaFormat;

    Swift

    var mediaFormat: AWSTranscribeMediaFormat { get set }
  • The sample rate, in Hertz (Hz), of the audio track in the input media file.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable mediaSampleRateHertz;

    Swift

    var mediaSampleRateHertz: NSNumber? { get set }
  • An object containing the details of your custom language model.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeModelSettings *_Nullable modelSettings;

    Swift

    var modelSettings: AWSTranscribeModelSettings? { get set }
  • Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeSettings *_Nullable settings;

    Swift

    var settings: AWSTranscribeSettings? { get set }
  • A timestamp that shows when the job started processing.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startTime;

    Swift

    var startTime: Date? { get set }
  • Generate subtitles for your batch transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeSubtitlesOutput *_Nullable subtitles;

    Swift

    var subtitles: AWSTranscribeSubtitlesOutput? { get set }
  • A key:value pair assigned to a given transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSTranscribeTag *> *_Nullable tags;

    Swift

    var tags: [AWSTranscribeTag]? { get set }
  • An object that describes the output of the transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeTranscript *_Nullable transcript;

    Swift

    var transcript: AWSTranscribeTranscript? { get set }
  • The name of the transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable transcriptionJobName;

    Swift

    var transcriptionJobName: String? { get set }
  • The status of the transcription job.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeTranscriptionJobStatus transcriptionJobStatus;

    Swift

    var transcriptionJobStatus: AWSTranscribeTranscriptionJobStatus { get set }