You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::TranscribeService::Types::StartTranscriptionJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb

Overview

Note:

When making an API call, you may pass StartTranscriptionJobRequest data as a hash:

{
  transcription_job_name: "TranscriptionJobName", # required
  language_code: "en-US", # required, accepts en-US, es-US
  media_sample_rate_hertz: 1,
  media_format: "mp3", # required, accepts mp3, mp4, wav, flac
  media: { # required
    media_file_uri: "Uri",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#language_codeString

The language code for the language used in the input media file.

Returns:

  • (String)


165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 165

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media)
  include Aws::Structure
end

#mediaTypes::Media

An object that describes the input media for a transcription job.

Returns:



165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 165

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media)
  include Aws::Structure
end

#media_formatString

The format of the input media file.

Returns:

  • (String)


165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 165

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media)
  include Aws::Structure
end

#media_sample_rate_hertzInteger

The sample rate, in Hertz, of the audio track in the input media file.

Returns:

  • (Integer)


165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 165

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media)
  include Aws::Structure
end

#transcription_job_nameString

The name of the job. The name must be unique within an AWS account.

Returns:

  • (String)


165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 165

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media)
  include Aws::Structure
end