elastictranscoder.d.ts (147596B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class ElasticTranscoder extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: ElasticTranscoder.Types.ClientConfiguration) 13 config: Config & ElasticTranscoder.Types.ClientConfiguration; 14 /** 15 * The CancelJob operation cancels an unfinished job. You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline. 16 */ 17 cancelJob(params: ElasticTranscoder.Types.CancelJobRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.CancelJobResponse) => void): Request<ElasticTranscoder.Types.CancelJobResponse, AWSError>; 18 /** 19 * The CancelJob operation cancels an unfinished job. You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline. 20 */ 21 cancelJob(callback?: (err: AWSError, data: ElasticTranscoder.Types.CancelJobResponse) => void): Request<ElasticTranscoder.Types.CancelJobResponse, AWSError>; 22 /** 23 * When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console). 24 */ 25 createJob(params: ElasticTranscoder.Types.CreateJobRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.CreateJobResponse) => void): Request<ElasticTranscoder.Types.CreateJobResponse, AWSError>; 26 /** 27 * When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console). 28 */ 29 createJob(callback?: (err: AWSError, data: ElasticTranscoder.Types.CreateJobResponse) => void): Request<ElasticTranscoder.Types.CreateJobResponse, AWSError>; 30 /** 31 * The CreatePipeline operation creates a pipeline with settings that you specify. 32 */ 33 createPipeline(params: ElasticTranscoder.Types.CreatePipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.CreatePipelineResponse) => void): Request<ElasticTranscoder.Types.CreatePipelineResponse, AWSError>; 34 /** 35 * The CreatePipeline operation creates a pipeline with settings that you specify. 36 */ 37 createPipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.CreatePipelineResponse) => void): Request<ElasticTranscoder.Types.CreatePipelineResponse, AWSError>; 38 /** 39 * The CreatePreset operation creates a preset with settings that you specify. Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces. Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services. 40 */ 41 createPreset(params: ElasticTranscoder.Types.CreatePresetRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.CreatePresetResponse) => void): Request<ElasticTranscoder.Types.CreatePresetResponse, AWSError>; 42 /** 43 * The CreatePreset operation creates a preset with settings that you specify. Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces. Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services. 44 */ 45 createPreset(callback?: (err: AWSError, data: ElasticTranscoder.Types.CreatePresetResponse) => void): Request<ElasticTranscoder.Types.CreatePresetResponse, AWSError>; 46 /** 47 * The DeletePipeline operation removes a pipeline. You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error. 48 */ 49 deletePipeline(params: ElasticTranscoder.Types.DeletePipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.DeletePipelineResponse) => void): Request<ElasticTranscoder.Types.DeletePipelineResponse, AWSError>; 50 /** 51 * The DeletePipeline operation removes a pipeline. You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error. 52 */ 53 deletePipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.DeletePipelineResponse) => void): Request<ElasticTranscoder.Types.DeletePipelineResponse, AWSError>; 54 /** 55 * The DeletePreset operation removes a preset that you've added in an AWS region. You can't delete the default presets that are included with Elastic Transcoder. 56 */ 57 deletePreset(params: ElasticTranscoder.Types.DeletePresetRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.DeletePresetResponse) => void): Request<ElasticTranscoder.Types.DeletePresetResponse, AWSError>; 58 /** 59 * The DeletePreset operation removes a preset that you've added in an AWS region. You can't delete the default presets that are included with Elastic Transcoder. 60 */ 61 deletePreset(callback?: (err: AWSError, data: ElasticTranscoder.Types.DeletePresetResponse) => void): Request<ElasticTranscoder.Types.DeletePresetResponse, AWSError>; 62 /** 63 * The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria. 64 */ 65 listJobsByPipeline(params: ElasticTranscoder.Types.ListJobsByPipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ListJobsByPipelineResponse) => void): Request<ElasticTranscoder.Types.ListJobsByPipelineResponse, AWSError>; 66 /** 67 * The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria. 68 */ 69 listJobsByPipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.ListJobsByPipelineResponse) => void): Request<ElasticTranscoder.Types.ListJobsByPipelineResponse, AWSError>; 70 /** 71 * The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria. 72 */ 73 listJobsByStatus(params: ElasticTranscoder.Types.ListJobsByStatusRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ListJobsByStatusResponse) => void): Request<ElasticTranscoder.Types.ListJobsByStatusResponse, AWSError>; 74 /** 75 * The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria. 76 */ 77 listJobsByStatus(callback?: (err: AWSError, data: ElasticTranscoder.Types.ListJobsByStatusResponse) => void): Request<ElasticTranscoder.Types.ListJobsByStatusResponse, AWSError>; 78 /** 79 * The ListPipelines operation gets a list of the pipelines associated with the current AWS account. 80 */ 81 listPipelines(params: ElasticTranscoder.Types.ListPipelinesRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ListPipelinesResponse) => void): Request<ElasticTranscoder.Types.ListPipelinesResponse, AWSError>; 82 /** 83 * The ListPipelines operation gets a list of the pipelines associated with the current AWS account. 84 */ 85 listPipelines(callback?: (err: AWSError, data: ElasticTranscoder.Types.ListPipelinesResponse) => void): Request<ElasticTranscoder.Types.ListPipelinesResponse, AWSError>; 86 /** 87 * The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. 88 */ 89 listPresets(params: ElasticTranscoder.Types.ListPresetsRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ListPresetsResponse) => void): Request<ElasticTranscoder.Types.ListPresetsResponse, AWSError>; 90 /** 91 * The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. 92 */ 93 listPresets(callback?: (err: AWSError, data: ElasticTranscoder.Types.ListPresetsResponse) => void): Request<ElasticTranscoder.Types.ListPresetsResponse, AWSError>; 94 /** 95 * The ReadJob operation returns detailed information about a job. 96 */ 97 readJob(params: ElasticTranscoder.Types.ReadJobRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadJobResponse) => void): Request<ElasticTranscoder.Types.ReadJobResponse, AWSError>; 98 /** 99 * The ReadJob operation returns detailed information about a job. 100 */ 101 readJob(callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadJobResponse) => void): Request<ElasticTranscoder.Types.ReadJobResponse, AWSError>; 102 /** 103 * The ReadPipeline operation gets detailed information about a pipeline. 104 */ 105 readPipeline(params: ElasticTranscoder.Types.ReadPipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadPipelineResponse) => void): Request<ElasticTranscoder.Types.ReadPipelineResponse, AWSError>; 106 /** 107 * The ReadPipeline operation gets detailed information about a pipeline. 108 */ 109 readPipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadPipelineResponse) => void): Request<ElasticTranscoder.Types.ReadPipelineResponse, AWSError>; 110 /** 111 * The ReadPreset operation gets detailed information about a preset. 112 */ 113 readPreset(params: ElasticTranscoder.Types.ReadPresetRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadPresetResponse) => void): Request<ElasticTranscoder.Types.ReadPresetResponse, AWSError>; 114 /** 115 * The ReadPreset operation gets detailed information about a preset. 116 */ 117 readPreset(callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadPresetResponse) => void): Request<ElasticTranscoder.Types.ReadPresetResponse, AWSError>; 118 /** 119 * The TestRole operation tests the IAM role used to create the pipeline. The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify. 120 */ 121 testRole(params: ElasticTranscoder.Types.TestRoleRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.TestRoleResponse) => void): Request<ElasticTranscoder.Types.TestRoleResponse, AWSError>; 122 /** 123 * The TestRole operation tests the IAM role used to create the pipeline. The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify. 124 */ 125 testRole(callback?: (err: AWSError, data: ElasticTranscoder.Types.TestRoleResponse) => void): Request<ElasticTranscoder.Types.TestRoleResponse, AWSError>; 126 /** 127 * Use the UpdatePipeline operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings. 128 */ 129 updatePipeline(params: ElasticTranscoder.Types.UpdatePipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineResponse) => void): Request<ElasticTranscoder.Types.UpdatePipelineResponse, AWSError>; 130 /** 131 * Use the UpdatePipeline operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings. 132 */ 133 updatePipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineResponse) => void): Request<ElasticTranscoder.Types.UpdatePipelineResponse, AWSError>; 134 /** 135 * With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline. When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request. 136 */ 137 updatePipelineNotifications(params: ElasticTranscoder.Types.UpdatePipelineNotificationsRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineNotificationsResponse) => void): Request<ElasticTranscoder.Types.UpdatePipelineNotificationsResponse, AWSError>; 138 /** 139 * With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline. When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request. 140 */ 141 updatePipelineNotifications(callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineNotificationsResponse) => void): Request<ElasticTranscoder.Types.UpdatePipelineNotificationsResponse, AWSError>; 142 /** 143 * The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request. 144 */ 145 updatePipelineStatus(params: ElasticTranscoder.Types.UpdatePipelineStatusRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineStatusResponse) => void): Request<ElasticTranscoder.Types.UpdatePipelineStatusResponse, AWSError>; 146 /** 147 * The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request. 148 */ 149 updatePipelineStatus(callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineStatusResponse) => void): Request<ElasticTranscoder.Types.UpdatePipelineStatusResponse, AWSError>; 150 /** 151 * Waits for the jobComplete state by periodically calling the underlying ElasticTranscoder.readJoboperation every 30 seconds (at most 120 times). 152 */ 153 waitFor(state: "jobComplete", params: ElasticTranscoder.Types.ReadJobRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadJobResponse) => void): Request<ElasticTranscoder.Types.ReadJobResponse, AWSError>; 154 /** 155 * Waits for the jobComplete state by periodically calling the underlying ElasticTranscoder.readJoboperation every 30 seconds (at most 120 times). 156 */ 157 waitFor(state: "jobComplete", callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadJobResponse) => void): Request<ElasticTranscoder.Types.ReadJobResponse, AWSError>; 158 } 159 declare namespace ElasticTranscoder.Types { 160 export type AccessControl = string; 161 export type AccessControls = AccessControl[]; 162 export interface Artwork { 163 /** 164 * The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the InputBucket object in that pipeline identifies the bucket. If the file name includes a prefix, for example, cooking/pie.jpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. 165 */ 166 InputKey?: WatermarkKey; 167 /** 168 * The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive. 169 */ 170 MaxWidth?: DigitsOrAuto; 171 /** 172 * The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive. 173 */ 174 MaxHeight?: DigitsOrAuto; 175 /** 176 * Specify one of the following values to control scaling of the output album art: Fit: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value. Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value. Stretch: Elastic Transcoder stretches the output art to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input art and the output art are different, the output art will be distorted. Keep: Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output art. ShrinkToFit: Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up. ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up. 177 */ 178 SizingPolicy?: SizingPolicy; 179 /** 180 * When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth and MaxHeight. 181 */ 182 PaddingPolicy?: PaddingPolicy; 183 /** 184 * The format of album art, if any. Valid formats are .jpg and .png. 185 */ 186 AlbumArtFormat?: JpgOrPng; 187 /** 188 * The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork. 189 */ 190 Encryption?: Encryption; 191 } 192 export type Artworks = Artwork[]; 193 export type Ascending = string; 194 export type AspectRatio = string; 195 export type AudioBitDepth = string; 196 export type AudioBitOrder = string; 197 export type AudioBitRate = string; 198 export type AudioChannels = string; 199 export type AudioCodec = string; 200 export interface AudioCodecOptions { 201 /** 202 * You can only choose an audio profile when you specify AAC for the value of Audio:Codec. Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles: auto: If you specify auto, Elastic Transcoder selects the profile based on the bit rate selected for the output file. AAC-LC: The most common AAC profile. Use for bit rates larger than 64 kbps. HE-AAC: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps. HE-AACv2: Not supported on some players and devices. Use for bit rates less than 48 kbps. All outputs in a Smooth playlist must have the same value for Profile. If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required. 203 */ 204 Profile?: AudioCodecProfile; 205 /** 206 * You can only choose an audio bit depth when you specify flac or pcm for the value of Audio:Codec. The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file. Valid values are 16 and 24. The most common bit depth is 24. 207 */ 208 BitDepth?: AudioBitDepth; 209 /** 210 * You can only choose an audio bit order when you specify pcm for the value of Audio:Codec. The order the bits of a PCM sample are stored in. The supported value is LittleEndian. 211 */ 212 BitOrder?: AudioBitOrder; 213 /** 214 * You can only choose whether an audio sample is signed when you specify pcm for the value of Audio:Codec. Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned). The supported value is Signed. 215 */ 216 Signed?: AudioSigned; 217 } 218 export type AudioCodecProfile = string; 219 export type AudioPackingMode = string; 220 export interface AudioParameters { 221 /** 222 * The audio codec for the output file. Valid values include aac, flac, mp2, mp3, pcm, and vorbis. 223 */ 224 Codec?: AudioCodec; 225 /** 226 * The sample rate of the audio stream in the output file, in Hertz. Valid values include: auto, 22050, 32000, 44100, 48000, 96000 If you specify auto, Elastic Transcoder automatically detects the sample rate. 227 */ 228 SampleRate?: AudioSampleRate; 229 /** 230 * The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive. 231 */ 232 BitRate?: AudioBitRate; 233 /** 234 * The number of audio channels in the output file. The following values are valid: auto, 0, 1, 2 One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto. The output of a specific channel value and inputs are as follows: auto channel specified, with any input: Pass through up to eight input channels. 0 channels specified, with any input: Audio omitted from the output. 1 channel specified, with at least one input channel: Mono sound. 2 channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, see Audio:AudioPackingMode. For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode. 235 */ 236 Channels?: AudioChannels; 237 /** 238 * The method of organizing audio channels and tracks. Use Audio:Channels to specify the number of channels in your output, and Audio:AudioPackingMode to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack. The following values are valid: SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks When you specify SingleTrack, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack for all non-mxf containers. The outputs of SingleTrack for a specific channel value and inputs are as follows: 0 channels with any input: Audio omitted from the output 1, 2, or auto channels with no audio input: Audio omitted from the output 1 channel with any input with audio: One track with one channel, downmixed if necessary 2 channels with one track with one channel: One track with two identical channels 2 or auto channels with two tracks with one channel each: One track with two channels 2 or auto channels with one track with two channels: One track with two channels 2 channels with one track with multiple channels: One track with two channels auto channels with one track with one channel: One track with one channel auto channels with one track with multiple channels: One track with multiple channels When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks. The outputs of OneChannelPerTrack for a specific channel value and inputs are as follows: 0 channels with any input: Audio omitted from the output 1, 2, or auto channels with no audio input: Audio omitted from the output 1 channel with any input with audio: One track with one channel, downmixed if necessary 2 channels with one track with one channel: Two tracks with one identical channel each 2 or auto channels with two tracks with one channel each: Two tracks with one channel each 2 or auto channels with one track with two channels: Two tracks with one channel each 2 channels with one track with multiple channels: Two tracks with one channel each auto channels with one track with one channel: One track with one channel auto channels with one track with multiple channels: Up to eight tracks with one channel each When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks. The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs are as follows: 0 channels with any input: Audio omitted from the output 1, 2, or auto channels with no audio input: Audio omitted from the output 1 channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks 2 channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks 2 or auto channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks 2 or auto channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks 2 channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks auto channels with one track with one channel: One track with one channel, plus seven MOS tracks auto channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all 239 */ 240 AudioPackingMode?: AudioPackingMode; 241 /** 242 * If you specified AAC for Audio:Codec, this is the AAC compression profile to use. Valid values include: auto, AAC-LC, HE-AAC, HE-AACv2 If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file. 243 */ 244 CodecOptions?: AudioCodecOptions; 245 } 246 export type AudioSampleRate = string; 247 export type AudioSigned = string; 248 export type Base64EncodedString = string; 249 export type BucketName = string; 250 export interface CancelJobRequest { 251 /** 252 * The identifier of the job that you want to cancel. To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action. 253 */ 254 Id: Id; 255 } 256 export interface CancelJobResponse { 257 } 258 export interface CaptionFormat { 259 /** 260 * The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output. Valid Embedded Caption Formats: for FLAC: None For MP3: None For MP4: mov-text For MPEG-TS: None For ogg: None For webm: None Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. For FMP4: dfxp Non-FMP4 outputs: All sidecar types fmp4 captions have an extension of .ismt 261 */ 262 Format?: CaptionFormatFormat; 263 /** 264 * The prefix for caption filenames, in the form description-{language}, where: description is a description of the video. {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names. If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files. For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt. 265 */ 266 Pattern?: CaptionFormatPattern; 267 /** 268 * The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats. 269 */ 270 Encryption?: Encryption; 271 } 272 export type CaptionFormatFormat = string; 273 export type CaptionFormatPattern = string; 274 export type CaptionFormats = CaptionFormat[]; 275 export type CaptionMergePolicy = string; 276 export interface CaptionSource { 277 /** 278 * The name of the sidecar caption file that you want Elastic Transcoder to include in the output file. 279 */ 280 Key?: LongKey; 281 /** 282 * A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of: 2-character ISO 639-1 code 3-character ISO 639-2 code For more information on ISO language codes and language names, see the List of ISO 639-1 codes. 283 */ 284 Language?: Key; 285 /** 286 * For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions. Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss. 287 */ 288 TimeOffset?: TimeOffset; 289 /** 290 * The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions. 291 */ 292 Label?: Name; 293 /** 294 * The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources. 295 */ 296 Encryption?: Encryption; 297 } 298 export type CaptionSources = CaptionSource[]; 299 export interface Captions { 300 /** 301 * A policy that determines how Elastic Transcoder handles the existence of multiple captions. MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language. MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files. Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources. MergePolicy cannot be null. 302 */ 303 MergePolicy?: CaptionMergePolicy; 304 /** 305 * Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank. 306 */ 307 CaptionSources?: CaptionSources; 308 /** 309 * The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error. 310 */ 311 CaptionFormats?: CaptionFormats; 312 } 313 export interface Clip { 314 /** 315 * Settings that determine when a clip begins and how long it lasts. 316 */ 317 TimeSpan?: TimeSpan; 318 } 319 export type CodecOption = string; 320 export type CodecOptions = {[key: string]: CodecOption}; 321 export type Composition = Clip[]; 322 export interface CreateJobOutput { 323 /** 324 * The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails. 325 */ 326 Key?: Key; 327 /** 328 * Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. If you don't want Elastic Transcoder to create thumbnails, specify "". If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence: {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job. Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}. {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object. When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension. 329 */ 330 ThumbnailPattern?: ThumbnailPattern; 331 /** 332 * The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. 333 */ 334 ThumbnailEncryption?: Encryption; 335 /** 336 * The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata. 337 */ 338 Rotate?: Rotate; 339 /** 340 * The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. 341 */ 342 PresetId?: Id; 343 /** 344 * (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4 and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer. The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist. 345 */ 346 SegmentDuration?: FloatString; 347 /** 348 * Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output. 349 */ 350 Watermarks?: JobWatermarks; 351 /** 352 * Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output. 353 */ 354 AlbumArt?: JobAlbumArt; 355 /** 356 * You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null. 357 */ 358 Composition?: Composition; 359 /** 360 * You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions: Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file. Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text Valid outputs include: mov-text Elastic Transcoder supports a maximum of one embedded format per output. Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file. Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt Valid outputs include: dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process. To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array. For more information on embedded files, see the Subtitles Wikipedia page. For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. 361 */ 362 Captions?: Captions; 363 /** 364 * You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually. 365 */ 366 Encryption?: Encryption; 367 } 368 export type CreateJobOutputs = CreateJobOutput[]; 369 export interface CreateJobPlaylist { 370 /** 371 * The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique. Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions. 372 */ 373 Name?: Filename; 374 /** 375 * The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth. 376 */ 377 Format?: PlaylistFormat; 378 /** 379 * For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object. If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key: OutputKeyPrefixOutputs:Key If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000: OutputKeyPrefixOutputs:Key.m3u8 OutputKeyPrefixOutputs:Key00000.ts If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8: OutputKeyPrefixOutputs:Key_v4.m3u8 OutputKeyPrefixOutputs:Key_iframe.m3u8 OutputKeyPrefixOutputs:Key.ts Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions. If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs. 380 */ 381 OutputKeys?: OutputKeys; 382 /** 383 * The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. 384 */ 385 HlsContentProtection?: HlsContentProtection; 386 /** 387 * The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. 388 */ 389 PlayReadyDrm?: PlayReadyDrm; 390 } 391 export type CreateJobPlaylists = CreateJobPlaylist[]; 392 export interface CreateJobRequest { 393 /** 394 * The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files. 395 */ 396 PipelineId: Id; 397 /** 398 * A section of the request body that provides information about the file that is being transcoded. 399 */ 400 Input?: JobInput; 401 /** 402 * A section of the request body that provides information about the files that are being transcoded. 403 */ 404 Inputs?: JobInputs; 405 /** 406 * A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the Outputs syntax instead of the Output syntax. 407 */ 408 Output?: CreateJobOutput; 409 /** 410 * A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax. 411 */ 412 Outputs?: CreateJobOutputs; 413 /** 414 * The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. 415 */ 416 OutputKeyPrefix?: Key; 417 /** 418 * If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. The maximum number of master playlists in a job is 30. 419 */ 420 Playlists?: CreateJobPlaylists; 421 /** 422 * User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them. 423 */ 424 UserMetadata?: UserMetadata; 425 } 426 export interface CreateJobResponse { 427 /** 428 * A section of the response body that provides information about the job that is created. 429 */ 430 Job?: Job; 431 } 432 export interface CreatePipelineRequest { 433 /** 434 * The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. Constraints: Maximum 40 characters. 435 */ 436 Name: Name; 437 /** 438 * The Amazon S3 bucket in which you saved the media files that you want to transcode. 439 */ 440 InputBucket: BucketName; 441 /** 442 * The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.) Specify this value when all of the following are true: You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket. You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists. You do not want to specify the permissions that Elastic Transcoder grants to the files. When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role. You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class. If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead. 443 */ 444 OutputBucket?: BucketName; 445 /** 446 * The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline. 447 */ 448 Role: Role; 449 /** 450 * The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline. If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM. 451 */ 452 AwsKmsKeyArn?: KeyArn; 453 /** 454 * The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide. Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. 455 */ 456 Notifications?: Notifications; 457 /** 458 * The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. If you specify values for ContentConfig, you must also specify values for ThumbnailConfig. If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. Grantee Type: Specify the type of value that appears in the Grantee object: Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. A canonical user ID is not the same as an AWS account number. Email: The value in the Grantee object is the registered email address of an AWS account. Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include: READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. 459 */ 460 ContentConfig?: PipelineOutputConfig; 461 /** 462 * The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails. If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. GranteeType: Specify the type of value that appears in the Grantee object: Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number. Email: The value in the Grantee object is the registered email address of an AWS account. Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group. Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include: READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket. 463 */ 464 ThumbnailConfig?: PipelineOutputConfig; 465 } 466 export interface CreatePipelineResponse { 467 /** 468 * A section of the response body that provides information about the pipeline that is created. 469 */ 470 Pipeline?: Pipeline; 471 /** 472 * Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline. Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges. 473 */ 474 Warnings?: Warnings; 475 } 476 export interface CreatePresetRequest { 477 /** 478 * The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. 479 */ 480 Name: Name; 481 /** 482 * A description of the preset. 483 */ 484 Description?: Description; 485 /** 486 * The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm. 487 */ 488 Container: PresetContainer; 489 /** 490 * A section of the request body that specifies the video parameters. 491 */ 492 Video?: VideoParameters; 493 /** 494 * A section of the request body that specifies the audio parameters. 495 */ 496 Audio?: AudioParameters; 497 /** 498 * A section of the request body that specifies the thumbnail parameters, if any. 499 */ 500 Thumbnails?: Thumbnails; 501 } 502 export interface CreatePresetResponse { 503 /** 504 * A section of the response body that provides information about the preset that is created. 505 */ 506 Preset?: Preset; 507 /** 508 * If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output. 509 */ 510 Warning?: String; 511 } 512 export interface DeletePipelineRequest { 513 /** 514 * The identifier of the pipeline that you want to delete. 515 */ 516 Id: Id; 517 } 518 export interface DeletePipelineResponse { 519 } 520 export interface DeletePresetRequest { 521 /** 522 * The identifier of the preset for which you want to get detailed information. 523 */ 524 Id: Id; 525 } 526 export interface DeletePresetResponse { 527 } 528 export type Description = string; 529 export interface DetectedProperties { 530 /** 531 * The detected width of the input file, in pixels. 532 */ 533 Width?: NullableInteger; 534 /** 535 * The detected height of the input file, in pixels. 536 */ 537 Height?: NullableInteger; 538 /** 539 * The detected frame rate of the input file, in frames per second. 540 */ 541 FrameRate?: FloatString; 542 /** 543 * The detected file size of the input file, in bytes. 544 */ 545 FileSize?: NullableLong; 546 /** 547 * The detected duration of the input file, in milliseconds. 548 */ 549 DurationMillis?: NullableLong; 550 } 551 export type Digits = string; 552 export type DigitsOrAuto = string; 553 export interface Encryption { 554 /** 555 * The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options: S3: Amazon S3 creates and manages the keys used for encrypting your files. S3-AWS-KMS: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify S3-AWS-KMS and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline. AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files. AES-CTR: AES Counter Mode. AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process. For all three AES options, you must provide the following settings, which must be base64-encoded: Key Key MD5 Initialization Vector For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data. 556 */ 557 Mode?: EncryptionMode; 558 /** 559 * The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded: 128, 192, or 256. The key must also be encrypted by using the Amazon Key Management Service. 560 */ 561 Key?: Base64EncodedString; 562 /** 563 * The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded. 564 */ 565 KeyMd5?: Base64EncodedString; 566 /** 567 * The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded. 568 */ 569 InitializationVector?: ZeroTo255String; 570 } 571 export type EncryptionMode = string; 572 export type ExceptionMessages = String[]; 573 export type Filename = string; 574 export type FixedGOP = string; 575 export type FloatString = string; 576 export type FrameRate = string; 577 export type Grantee = string; 578 export type GranteeType = string; 579 export interface HlsContentProtection { 580 /** 581 * The content protection method for your output. The only valid value is: aes-128. This value is written into the method attribute of the EXT-X-KEY metadata tag in the output playlist. 582 */ 583 Method?: HlsContentProtectionMethod; 584 /** 585 * If you want Elastic Transcoder to generate a key for you, leave this field blank. If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded: 128, 192, or 256. 586 */ 587 Key?: Base64EncodedString; 588 /** 589 * If Elastic Transcoder is generating your key for you, you must leave this field blank. The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded. 590 */ 591 KeyMd5?: Base64EncodedString; 592 /** 593 * If Elastic Transcoder is generating your key for you, you must leave this field blank. The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded. 594 */ 595 InitializationVector?: ZeroTo255String; 596 /** 597 * The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file. 598 */ 599 LicenseAcquisitionUrl?: ZeroTo512String; 600 /** 601 * Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you choose WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder writes your data key into the same bucket as the associated playlist. 602 */ 603 KeyStoragePolicy?: KeyStoragePolicy; 604 } 605 export type HlsContentProtectionMethod = string; 606 export type HorizontalAlign = string; 607 export type Id = string; 608 export interface InputCaptions { 609 /** 610 * A policy that determines how Elastic Transcoder handles the existence of multiple captions. MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language. MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files. Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources. MergePolicy cannot be null. 611 */ 612 MergePolicy?: CaptionMergePolicy; 613 /** 614 * Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank. 615 */ 616 CaptionSources?: CaptionSources; 617 } 618 export type Interlaced = string; 619 export interface Job { 620 /** 621 * The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job. 622 */ 623 Id?: Id; 624 /** 625 * The Amazon Resource Name (ARN) for the job. 626 */ 627 Arn?: String; 628 /** 629 * The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files. 630 */ 631 PipelineId?: Id; 632 /** 633 * A section of the request or response body that provides information about the file that is being transcoded. 634 */ 635 Input?: JobInput; 636 /** 637 * Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output. 638 */ 639 Inputs?: JobInputs; 640 /** 641 * If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object. Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file. 642 */ 643 Output?: JobOutput; 644 /** 645 * Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job. If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job. 646 */ 647 Outputs?: JobOutputs; 648 /** 649 * The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix. 650 */ 651 OutputKeyPrefix?: Key; 652 /** 653 * Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. The maximum number of master playlists in a job is 30. 654 */ 655 Playlists?: Playlists; 656 /** 657 * The status of the job: Submitted, Progressing, Complete, Canceled, or Error. 658 */ 659 Status?: JobStatus; 660 /** 661 * User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them. Metadata keys and values must use characters from the following list: 0-9 A-Z and a-z Space The following symbols: _.:/=+-%@ 662 */ 663 UserMetadata?: UserMetadata; 664 /** 665 * Details about the timing of a job. 666 */ 667 Timing?: Timing; 668 } 669 export interface JobAlbumArt { 670 /** 671 * A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files. Replace: The specified album art replaces any existing album art. Prepend: The specified album art is placed in front of any existing album art. Append: The specified album art is placed after any existing album art. Fallback: If the original input file contains artwork, Elastic Transcoder uses that artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file. 672 */ 673 MergePolicy?: MergePolicy; 674 /** 675 * The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are .jpg and .png 676 */ 677 Artwork?: Artworks; 678 } 679 export type JobContainer = string; 680 export interface JobInput { 681 /** 682 * The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. 683 */ 684 Key?: LongKey; 685 /** 686 * The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values: 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate. 687 */ 688 FrameRate?: FrameRate; 689 /** 690 * This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file. 691 */ 692 Resolution?: Resolution; 693 /** 694 * The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values: 1:1, 4:3, 3:2, 16:9 If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio. 695 */ 696 AspectRatio?: AspectRatio; 697 /** 698 * Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values: true, false If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing. 699 */ 700 Interlaced?: Interlaced; 701 /** 702 * The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values: 3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm 703 */ 704 Container?: JobContainer; 705 /** 706 * The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file. 707 */ 708 Encryption?: Encryption; 709 /** 710 * Settings for clipping an input. Each input can have different clip settings. 711 */ 712 TimeSpan?: TimeSpan; 713 /** 714 * You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions: Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file. Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text Valid outputs include: mov-text Elastic Transcoder supports a maximum of one embedded format per output. Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file. Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt Valid outputs include: dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process. To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array. For more information on embedded files, see the Subtitles Wikipedia page. For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. 715 */ 716 InputCaptions?: InputCaptions; 717 /** 718 * The detected properties of the input file. 719 */ 720 DetectedProperties?: DetectedProperties; 721 } 722 export type JobInputs = JobInput[]; 723 export interface JobOutput { 724 /** 725 * A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1. 726 */ 727 Id?: String; 728 /** 729 * The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. 730 */ 731 Key?: Key; 732 /** 733 * Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. If you don't want Elastic Transcoder to create thumbnails, specify "". If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence: {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job. Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}. {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object. When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension. 734 */ 735 ThumbnailPattern?: ThumbnailPattern; 736 /** 737 * The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. 738 */ 739 ThumbnailEncryption?: Encryption; 740 /** 741 * The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270 The value auto generally works only if the file that you're transcoding contains rotation metadata. 742 */ 743 Rotate?: Rotate; 744 /** 745 * The value of the Id object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with ListPresets. 746 */ 747 PresetId?: Id; 748 /** 749 * (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4, MPEG-DASH, and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer. The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist. 750 */ 751 SegmentDuration?: FloatString; 752 /** 753 * The status of one output in a job. If you specified only one output for the job, Outputs:Status is always the same as Job:Status. If you specified more than one output: Job:Status and Outputs:Status for all of the outputs is Submitted until Elastic Transcoder starts to process the first output. When Elastic Transcoder starts to process the first output, Outputs:Status for that output and Job:Status both change to Progressing. For each output, the value of Outputs:Status remains Submitted until Elastic Transcoder starts to process the output. Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error. When all of the outputs reach a terminal status, Job:Status changes to Complete only if Outputs:Status for all of the outputs is Complete. If Outputs:Status for one or more outputs is Error, the terminal status for Job:Status is also Error. The value of Status is one of the following: Submitted, Progressing, Complete, Canceled, or Error. 754 */ 755 Status?: JobStatus; 756 /** 757 * Information that further explains Status. 758 */ 759 StatusDetail?: Description; 760 /** 761 * Duration of the output file, in seconds. 762 */ 763 Duration?: NullableLong; 764 /** 765 * Specifies the width of the output file in pixels. 766 */ 767 Width?: NullableInteger; 768 /** 769 * Height of the output file, in pixels. 770 */ 771 Height?: NullableInteger; 772 /** 773 * Frame rate of the output file, in frames per second. 774 */ 775 FrameRate?: FloatString; 776 /** 777 * File size of the output file, in bytes. 778 */ 779 FileSize?: NullableLong; 780 /** 781 * Duration of the output file, in milliseconds. 782 */ 783 DurationMillis?: NullableLong; 784 /** 785 * Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in Preset for the current output. Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add covers the first one, the third one covers the second, and the fourth one covers the third. 786 */ 787 Watermarks?: JobWatermarks; 788 /** 789 * The album art to be associated with the output file, if any. 790 */ 791 AlbumArt?: JobAlbumArt; 792 /** 793 * You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null. 794 */ 795 Composition?: Composition; 796 /** 797 * You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions: Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file. Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text Valid outputs include: mov-text Elastic Transcoder supports a maximum of one embedded format per output. Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file. Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt Valid outputs include: dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process. To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array. For more information on embedded files, see the Subtitles Wikipedia page. For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. 798 */ 799 Captions?: Captions; 800 /** 801 * The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket. 802 */ 803 Encryption?: Encryption; 804 /** 805 * If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output file, the AppliedColorSpaceConversion parameter shows the conversion used. If no ColorSpaceConversionMode was defined in the preset, this parameter is not be included in the job response. 806 */ 807 AppliedColorSpaceConversion?: String; 808 } 809 export type JobOutputs = JobOutput[]; 810 export type JobStatus = string; 811 export interface JobWatermark { 812 /** 813 * The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use. 814 */ 815 PresetWatermarkId?: PresetWatermarkId; 816 /** 817 * The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket. If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. 818 */ 819 InputKey?: WatermarkKey; 820 /** 821 * The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks. 822 */ 823 Encryption?: Encryption; 824 } 825 export type JobWatermarks = JobWatermark[]; 826 export type Jobs = Job[]; 827 export type JpgOrPng = string; 828 export type Key = string; 829 export type KeyArn = string; 830 export type KeyIdGuid = string; 831 export type KeyStoragePolicy = string; 832 export type KeyframesMaxDist = string; 833 export interface ListJobsByPipelineRequest { 834 /** 835 * The ID of the pipeline for which you want to get job information. 836 */ 837 PipelineId: Id; 838 /** 839 * To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false. 840 */ 841 Ascending?: Ascending; 842 /** 843 * When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results. 844 */ 845 PageToken?: Id; 846 } 847 export interface ListJobsByPipelineResponse { 848 /** 849 * An array of Job objects that are in the specified pipeline. 850 */ 851 Jobs?: Jobs; 852 /** 853 * A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null. 854 */ 855 NextPageToken?: Id; 856 } 857 export interface ListJobsByStatusRequest { 858 /** 859 * To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error. 860 */ 861 Status: JobStatus; 862 /** 863 * To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false. 864 */ 865 Ascending?: Ascending; 866 /** 867 * When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results. 868 */ 869 PageToken?: Id; 870 } 871 export interface ListJobsByStatusResponse { 872 /** 873 * An array of Job objects that have the specified status. 874 */ 875 Jobs?: Jobs; 876 /** 877 * A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null. 878 */ 879 NextPageToken?: Id; 880 } 881 export interface ListPipelinesRequest { 882 /** 883 * To list pipelines in chronological order by the date and time that they were created, enter true. To list pipelines in reverse chronological order, enter false. 884 */ 885 Ascending?: Ascending; 886 /** 887 * When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results. 888 */ 889 PageToken?: Id; 890 } 891 export interface ListPipelinesResponse { 892 /** 893 * An array of Pipeline objects. 894 */ 895 Pipelines?: Pipelines; 896 /** 897 * A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you've reached the last page of results, the value of NextPageToken is null. 898 */ 899 NextPageToken?: Id; 900 } 901 export interface ListPresetsRequest { 902 /** 903 * To list presets in chronological order by the date and time that they were created, enter true. To list presets in reverse chronological order, enter false. 904 */ 905 Ascending?: Ascending; 906 /** 907 * When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results. 908 */ 909 PageToken?: Id; 910 } 911 export interface ListPresetsResponse { 912 /** 913 * An array of Preset objects. 914 */ 915 Presets?: Presets; 916 /** 917 * A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one page or when you've reached the last page of results, the value of NextPageToken is null. 918 */ 919 NextPageToken?: Id; 920 } 921 export type LongKey = string; 922 export type MaxFrameRate = string; 923 export type MergePolicy = string; 924 export type Name = string; 925 export type NonEmptyBase64EncodedString = string; 926 export interface Notifications { 927 /** 928 * The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job. 929 */ 930 Progressing?: SnsTopic; 931 /** 932 * The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job. 933 */ 934 Completed?: SnsTopic; 935 /** 936 * The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. 937 */ 938 Warning?: SnsTopic; 939 /** 940 * The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. 941 */ 942 Error?: SnsTopic; 943 } 944 export type NullableInteger = number; 945 export type NullableLong = number; 946 export type OneTo512String = string; 947 export type Opacity = string; 948 export type OutputKeys = Key[]; 949 export type PaddingPolicy = string; 950 export interface Permission { 951 /** 952 * The type of value that appears in the Grantee object: Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number. Email: The registered email address of an AWS account. Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. 953 */ 954 GranteeType?: GranteeType; 955 /** 956 * The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group. 957 */ 958 Grantee?: Grantee; 959 /** 960 * The permission that you want to give to the AWS user that is listed in Grantee. Valid values include: READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. 961 */ 962 Access?: AccessControls; 963 } 964 export type Permissions = Permission[]; 965 export interface Pipeline { 966 /** 967 * The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset. 968 */ 969 Id?: Id; 970 /** 971 * The Amazon Resource Name (ARN) for the pipeline. 972 */ 973 Arn?: String; 974 /** 975 * The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. Constraints: Maximum 40 characters 976 */ 977 Name?: Name; 978 /** 979 * The current status of the pipeline: Active: The pipeline is processing jobs. Paused: The pipeline is not currently processing jobs. 980 */ 981 Status?: PipelineStatus; 982 /** 983 * The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks. 984 */ 985 InputBucket?: BucketName; 986 /** 987 * The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig. 988 */ 989 OutputBucket?: BucketName; 990 /** 991 * The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline. 992 */ 993 Role?: Role; 994 /** 995 * The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline. If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM. 996 */ 997 AwsKmsKeyArn?: KeyArn; 998 /** 999 * The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job. Completed (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job. Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. 1000 */ 1001 Notifications?: Notifications; 1002 /** 1003 * Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have. GranteeType: The type of value that appears in the Grantee object: Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. Email: The registered email address of an AWS account. Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to transcoded files and playlists. Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include: READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. 1004 */ 1005 ContentConfig?: PipelineOutputConfig; 1006 /** 1007 * Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have. GranteeType: The type of value that appears in the Grantee object: Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number. Email: The registered email address of an AWS account. Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to thumbnail files. Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include: READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket. 1008 */ 1009 ThumbnailConfig?: PipelineOutputConfig; 1010 } 1011 export interface PipelineOutputConfig { 1012 /** 1013 * The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true: You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket. You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists. You do not want to specify the permissions that Elastic Transcoder grants to the files. You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class. If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead. 1014 */ 1015 Bucket?: BucketName; 1016 /** 1017 * The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. 1018 */ 1019 StorageClass?: StorageClass; 1020 /** 1021 * Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user. If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group. 1022 */ 1023 Permissions?: Permissions; 1024 } 1025 export type PipelineStatus = string; 1026 export type Pipelines = Pipeline[]; 1027 export type PixelsOrPercent = string; 1028 export interface PlayReadyDrm { 1029 /** 1030 * The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. 1031 */ 1032 Format?: PlayReadyDrmFormatString; 1033 /** 1034 * The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded: 128, 192, or 256. The key must also be encrypted by using AWS KMS. 1035 */ 1036 Key?: NonEmptyBase64EncodedString; 1037 /** 1038 * The MD5 digest of the key used for DRM on your file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded. 1039 */ 1040 KeyMd5?: NonEmptyBase64EncodedString; 1041 /** 1042 * The ID for your DRM key, so that your DRM license provider knows which key to provide. The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or little endian, check with your DRM provider. 1043 */ 1044 KeyId?: KeyIdGuid; 1045 /** 1046 * The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it must be exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder generates one for you. 1047 */ 1048 InitializationVector?: ZeroTo255String; 1049 /** 1050 * The location of the license key required to play DRM content. The URL must be an absolute path, and is referenced by the PlayReady header. The PlayReady header is referenced in the protection header of the client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An example URL looks like this: https://www.example.com/exampleKey/ 1051 */ 1052 LicenseAcquisitionUrl?: OneTo512String; 1053 } 1054 export type PlayReadyDrmFormatString = string; 1055 export interface Playlist { 1056 /** 1057 * The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique. Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions. 1058 */ 1059 Name?: Filename; 1060 /** 1061 * The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth. 1062 */ 1063 Format?: PlaylistFormat; 1064 /** 1065 * For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object. If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key: OutputKeyPrefixOutputs:Key If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000: OutputKeyPrefixOutputs:Key.m3u8 OutputKeyPrefixOutputs:Key00000.ts If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8: OutputKeyPrefixOutputs:Key_v4.m3u8 OutputKeyPrefixOutputs:Key_iframe.m3u8 OutputKeyPrefixOutputs:Key.ts Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions. If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs. 1066 */ 1067 OutputKeys?: OutputKeys; 1068 /** 1069 * The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. 1070 */ 1071 HlsContentProtection?: HlsContentProtection; 1072 /** 1073 * The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. 1074 */ 1075 PlayReadyDrm?: PlayReadyDrm; 1076 /** 1077 * The status of the job with which the playlist is associated. 1078 */ 1079 Status?: JobStatus; 1080 /** 1081 * Information that further explains the status. 1082 */ 1083 StatusDetail?: Description; 1084 } 1085 export type PlaylistFormat = string; 1086 export type Playlists = Playlist[]; 1087 export interface Preset { 1088 /** 1089 * Identifier for the new preset. You use this value to get settings for the preset or to delete it. 1090 */ 1091 Id?: Id; 1092 /** 1093 * The Amazon Resource Name (ARN) for the preset. 1094 */ 1095 Arn?: String; 1096 /** 1097 * The name of the preset. 1098 */ 1099 Name?: Name; 1100 /** 1101 * A description of the preset. 1102 */ 1103 Description?: Description; 1104 /** 1105 * The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm. 1106 */ 1107 Container?: PresetContainer; 1108 /** 1109 * A section of the response body that provides information about the audio preset values. 1110 */ 1111 Audio?: AudioParameters; 1112 /** 1113 * A section of the response body that provides information about the video preset values. 1114 */ 1115 Video?: VideoParameters; 1116 /** 1117 * A section of the response body that provides information about the thumbnail preset values, if any. 1118 */ 1119 Thumbnails?: Thumbnails; 1120 /** 1121 * Whether the preset is a default preset provided by Elastic Transcoder (System) or a preset that you have defined (Custom). 1122 */ 1123 Type?: PresetType; 1124 } 1125 export type PresetContainer = string; 1126 export type PresetType = string; 1127 export interface PresetWatermark { 1128 /** 1129 * A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters long. 1130 */ 1131 Id?: PresetWatermarkId; 1132 /** 1133 * The maximum width of the watermark in one of the following formats: number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxWidth. integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation. If you specify the value in pixels, it must be less than or equal to the value of MaxWidth. 1134 */ 1135 MaxWidth?: PixelsOrPercent; 1136 /** 1137 * The maximum height of the watermark in one of the following formats: number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxHeight. integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation. If you specify the value in pixels, it must be less than or equal to the value of MaxHeight. 1138 */ 1139 MaxHeight?: PixelsOrPercent; 1140 /** 1141 * A value that controls scaling of the watermark: Fit: Elastic Transcoder scales the watermark so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value. Stretch: Elastic Transcoder stretches the watermark to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the watermark and the values of MaxWidth and MaxHeight are different, the watermark will be distorted. ShrinkToFit: Elastic Transcoder scales the watermark down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up. 1142 */ 1143 SizingPolicy?: WatermarkSizingPolicy; 1144 /** 1145 * The horizontal position of the watermark unless you specify a non-zero value for HorizontalOffset: Left: The left edge of the watermark is aligned with the left border of the video. Right: The right edge of the watermark is aligned with the right border of the video. Center: The watermark is centered between the left and right borders. 1146 */ 1147 HorizontalAlign?: HorizontalAlign; 1148 /** 1149 * The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign: number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth. integer percentage (%): The range of valid values is 0 to 100. For example, if you specify Left for HorizontalAlign and 5px for HorizontalOffset, the left side of the watermark appears 5 pixels from the left border of the output video. HorizontalOffset is only valid when the value of HorizontalAlign is Left or Right. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped. Use the value of Target to specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation. 1150 */ 1151 HorizontalOffset?: PixelsOrPercent; 1152 /** 1153 * The vertical position of the watermark unless you specify a non-zero value for VerticalOffset: Top: The top edge of the watermark is aligned with the top border of the video. Bottom: The bottom edge of the watermark is aligned with the bottom border of the video. Center: The watermark is centered between the top and bottom borders. 1154 */ 1155 VerticalAlign?: VerticalAlign; 1156 /** 1157 * VerticalOffset The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign: number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxHeight. integer percentage (%): The range of valid values is 0 to 100. For example, if you specify Top for VerticalAlign and 5px for VerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video. VerticalOffset is only valid when the value of VerticalAlign is Top or Bottom. If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation. 1158 */ 1159 VerticalOffset?: PixelsOrPercent; 1160 /** 1161 * A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of Opacity is float. Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for Opacity. The .jpg file format doesn't support transparency. 1162 */ 1163 Opacity?: Opacity; 1164 /** 1165 * A value that determines how Elastic Transcoder interprets values that you specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight: Content: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. Frame: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. 1166 */ 1167 Target?: Target; 1168 } 1169 export type PresetWatermarkId = string; 1170 export type PresetWatermarks = PresetWatermark[]; 1171 export type Presets = Preset[]; 1172 export interface ReadJobRequest { 1173 /** 1174 * The identifier of the job for which you want to get detailed information. 1175 */ 1176 Id: Id; 1177 } 1178 export interface ReadJobResponse { 1179 /** 1180 * A section of the response body that provides information about the job. 1181 */ 1182 Job?: Job; 1183 } 1184 export interface ReadPipelineRequest { 1185 /** 1186 * The identifier of the pipeline to read. 1187 */ 1188 Id: Id; 1189 } 1190 export interface ReadPipelineResponse { 1191 /** 1192 * A section of the response body that provides information about the pipeline. 1193 */ 1194 Pipeline?: Pipeline; 1195 /** 1196 * Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline. Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges. 1197 */ 1198 Warnings?: Warnings; 1199 } 1200 export interface ReadPresetRequest { 1201 /** 1202 * The identifier of the preset for which you want to get detailed information. 1203 */ 1204 Id: Id; 1205 } 1206 export interface ReadPresetResponse { 1207 /** 1208 * A section of the response body that provides information about the preset. 1209 */ 1210 Preset?: Preset; 1211 } 1212 export type Resolution = string; 1213 export type Role = string; 1214 export type Rotate = string; 1215 export type SizingPolicy = string; 1216 export type SnsTopic = string; 1217 export type SnsTopics = SnsTopic[]; 1218 export type StorageClass = string; 1219 export type String = string; 1220 export type Success = string; 1221 export type Target = string; 1222 export interface TestRoleRequest { 1223 /** 1224 * The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test. 1225 */ 1226 Role: Role; 1227 /** 1228 * The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket. 1229 */ 1230 InputBucket: BucketName; 1231 /** 1232 * The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket. 1233 */ 1234 OutputBucket: BucketName; 1235 /** 1236 * The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to. 1237 */ 1238 Topics: SnsTopics; 1239 } 1240 export interface TestRoleResponse { 1241 /** 1242 * If the operation is successful, this value is true; otherwise, the value is false. 1243 */ 1244 Success?: Success; 1245 /** 1246 * If the Success element contains false, this value is an array of one or more error messages that were generated during the test process. 1247 */ 1248 Messages?: ExceptionMessages; 1249 } 1250 export type ThumbnailPattern = string; 1251 export type ThumbnailResolution = string; 1252 export interface Thumbnails { 1253 /** 1254 * The format of thumbnails, if any. Valid values are jpg and png. You specify whether you want Elastic Transcoder to create thumbnails when you create a job. 1255 */ 1256 Format?: JpgOrPng; 1257 /** 1258 * The approximate number of seconds between thumbnails. Specify an integer value. 1259 */ 1260 Interval?: Digits; 1261 /** 1262 * To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together. The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object. 1263 */ 1264 Resolution?: ThumbnailResolution; 1265 /** 1266 * To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together. The aspect ratio of thumbnails. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file. 1267 */ 1268 AspectRatio?: AspectRatio; 1269 /** 1270 * The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096. 1271 */ 1272 MaxWidth?: DigitsOrAuto; 1273 /** 1274 * The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072. 1275 */ 1276 MaxHeight?: DigitsOrAuto; 1277 /** 1278 * Specify one of the following values to control scaling of thumbnails: Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value. Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted. Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails. ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. 1279 */ 1280 SizingPolicy?: SizingPolicy; 1281 /** 1282 * When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings. 1283 */ 1284 PaddingPolicy?: PaddingPolicy; 1285 } 1286 export type Time = string; 1287 export type TimeOffset = string; 1288 export interface TimeSpan { 1289 /** 1290 * The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file. 1291 */ 1292 StartTime?: Time; 1293 /** 1294 * The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file. If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message. 1295 */ 1296 Duration?: Time; 1297 } 1298 export interface Timing { 1299 /** 1300 * The time the job was submitted to Elastic Transcoder, in epoch milliseconds. 1301 */ 1302 SubmitTimeMillis?: NullableLong; 1303 /** 1304 * The time the job began transcoding, in epoch milliseconds. 1305 */ 1306 StartTimeMillis?: NullableLong; 1307 /** 1308 * The time the job finished transcoding, in epoch milliseconds. 1309 */ 1310 FinishTimeMillis?: NullableLong; 1311 } 1312 export interface UpdatePipelineNotificationsRequest { 1313 /** 1314 * The identifier of the pipeline for which you want to change notification settings. 1315 */ 1316 Id: Id; 1317 /** 1318 * The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic. Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic. Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic. Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic. 1319 */ 1320 Notifications: Notifications; 1321 } 1322 export interface UpdatePipelineNotificationsResponse { 1323 /** 1324 * A section of the response body that provides information about the pipeline associated with this notification. 1325 */ 1326 Pipeline?: Pipeline; 1327 } 1328 export interface UpdatePipelineRequest { 1329 /** 1330 * The ID of the pipeline that you want to update. 1331 */ 1332 Id: Id; 1333 /** 1334 * The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. Constraints: Maximum 40 characters 1335 */ 1336 Name?: Name; 1337 /** 1338 * The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks. 1339 */ 1340 InputBucket?: BucketName; 1341 /** 1342 * The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline. 1343 */ 1344 Role?: Role; 1345 /** 1346 * The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline. If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM. 1347 */ 1348 AwsKmsKeyArn?: KeyArn; 1349 /** 1350 * The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic. Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic. Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic. Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic. 1351 */ 1352 Notifications?: Notifications; 1353 /** 1354 * The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. If you specify values for ContentConfig, you must also specify values for ThumbnailConfig. If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. Grantee Type: Specify the type of value that appears in the Grantee object: Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. A canonical user ID is not the same as an AWS account number. Email: The value in the Grantee object is the registered email address of an AWS account. Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include: READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. 1355 */ 1356 ContentConfig?: PipelineOutputConfig; 1357 /** 1358 * The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails. If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. GranteeType: Specify the type of value that appears in the Grantee object: Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number. Email: The value in the Grantee object is the registered email address of an AWS account. Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group. Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include: READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket. 1359 */ 1360 ThumbnailConfig?: PipelineOutputConfig; 1361 } 1362 export interface UpdatePipelineResponse { 1363 /** 1364 * The pipeline updated by this UpdatePipelineResponse call. 1365 */ 1366 Pipeline?: Pipeline; 1367 /** 1368 * Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline. Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges. 1369 */ 1370 Warnings?: Warnings; 1371 } 1372 export interface UpdatePipelineStatusRequest { 1373 /** 1374 * The identifier of the pipeline to update. 1375 */ 1376 Id: Id; 1377 /** 1378 * The desired status of the pipeline: Active: The pipeline is processing jobs. Paused: The pipeline is not currently processing jobs. 1379 */ 1380 Status: PipelineStatus; 1381 } 1382 export interface UpdatePipelineStatusResponse { 1383 /** 1384 * A section of the response body that provides information about the pipeline. 1385 */ 1386 Pipeline?: Pipeline; 1387 } 1388 export type UserMetadata = {[key: string]: String}; 1389 export type VerticalAlign = string; 1390 export type VideoBitRate = string; 1391 export type VideoCodec = string; 1392 export interface VideoParameters { 1393 /** 1394 * The video codec for the output file. Valid values include gif, H.264, mpeg2, vp8, and vp9. You can only specify vp8 and vp9 when the container type is webm, gif when the container type is gif, and mpeg2 when the container type is mpg. 1395 */ 1396 Codec?: VideoCodec; 1397 /** 1398 * Profile (H.264/VP8/VP9 Only) The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles: baseline: The profile most commonly used for videoconferencing and for mobile applications. main: The profile used for standard-definition digital TV broadcasts. high: The profile used for high-definition digital TV broadcasts and for Blu-ray discs. Level (H.264 Only) The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels: 1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1 MaxReferenceFrames (H.264 Only) Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following: Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16) where Width in pixels and Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends on the value of the Level object. See the list below. (A macroblock is a block of pixels measuring 16x16.) 1 - 396 1b - 396 1.1 - 900 1.2 - 2376 1.3 - 2376 2 - 2376 2.1 - 4752 2.2 - 8100 3 - 8100 3.1 - 18000 3.2 - 20480 4 - 32768 4.1 - 32768 MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only) The maximum number of bits per second in a video buffer; the size of the buffer is specified by BufferSize. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video. BufferSize (Optional, H.264/MPEG2/VP8/VP9 only) The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify MaxBitRate and omit BufferSize, Elastic Transcoder sets BufferSize to 10 times the value of MaxBitRate. InterlacedMode (Optional, H.264/MPEG2 Only) The interlace mode for the output video. Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering. Valid values include Progressive (no interlacing, top to bottom), TopFirst (top field first), BottomFirst (bottom field first), and Auto. If InterlaceMode is not specified, Elastic Transcoder uses Progressive for the output. If Auto is specified, Elastic Transcoder interlaces the output. ColorSpaceConversionMode (Optional, H.264/MPEG2 Only) The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms used by the computer to store information about how to render color. Bt.601 is the standard for standard definition video, while Bt.709 is the standard for high definition video. Valid values include None, Bt709toBt601, Bt601toBt709, and Auto. If you chose Auto for ColorSpaceConversionMode and your output is interlaced, your frame rate is one of 23.97, 24, 25, 29.97, 50, or 60, your SegmentDuration is null, and you are using one of the resolution changes from the list below, Elastic Transcoder applies the following color space conversions: Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709 Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709 HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies Bt709ToBt601 HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies Bt709ToBt601 Elastic Transcoder may change the behavior of the ColorspaceConversionMode Auto mode in the future. All outputs in a playlist must use the same ColorSpaceConversionMode. If you do not specify a ColorSpaceConversionMode, Elastic Transcoder does not change the color space of a file. If you are unsure what ColorSpaceConversionMode was applied to your output file, you can check the AppliedColorSpaceConversion parameter included in your job response. If your job does not have an AppliedColorSpaceConversion in its response, no ColorSpaceConversionMode was applied. ChromaSubsampling The sampling pattern for the chroma (color) channels of the output video. Valid values include yuv420p and yuv422p. yuv420p samples the chroma information of every other horizontal and every other vertical line, yuv422p samples the color information of every horizontal line and every other vertical line. LoopCount (Gif Only) The number of times you want the output gif to loop. Valid values include Infinite and integers between 0 and 100, inclusive. 1399 */ 1400 CodecOptions?: CodecOptions; 1401 /** 1402 * Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality. For Smooth outputs, the FrameRate must have a constant ratio to the KeyframesMaxDist. This allows Smooth playlists to switch between different quality levels while the file is being played. For example, an input file can have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then needs to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and 10, and KeyframesMaxDist of 90, 75, and 30, respectively. Alternately, this can be achieved by setting FrameRate to auto and having the same values for MaxFrameRate and KeyframesMaxDist. 1403 */ 1404 KeyframesMaxDist?: KeyframesMaxDist; 1405 /** 1406 * Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. Whether to use a fixed value for FixedGOP. Valid values are true and false: true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance between key frames (the number of frames in a group of pictures, or GOP). false: The distance between key frames can vary. FixedGOP must be set to true for fmp4 containers. 1407 */ 1408 FixedGOP?: FixedGOP; 1409 /** 1410 * The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of Level and Profile. If you specify auto, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other than auto, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile: Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile) 1 - 64 : 80 1b - 128 : 160 1.1 - 192 : 240 1.2 - 384 : 480 1.3 - 768 : 960 2 - 2000 : 2500 3 - 10000 : 12500 3.1 - 14000 : 17500 3.2 - 20000 : 25000 4 - 20000 : 25000 4.1 - 50000 : 62500 1411 */ 1412 BitRate?: VideoBitRate; 1413 /** 1414 * The frames per second for the video stream in the output file. Valid values include: auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify auto, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation: Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels) where: width in pixels and height in pixels represent the Resolution of the output video. maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level. The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed): 1 - 380160 1b - 380160 1.1 - 76800 1.2 - 1536000 1.3 - 3041280 2 - 3041280 2.1 - 5068800 2.2 - 5184000 3 - 10368000 3.1 - 27648000 3.2 - 55296000 4 - 62914560 4.1 - 62914560 1415 */ 1416 FrameRate?: FrameRate; 1417 /** 1418 * If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include: 10, 15, 23.97, 24, 25, 29.97, 30, 60. 1419 */ 1420 MaxFrameRate?: MaxFrameRate; 1421 /** 1422 * To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together. The width and height of the video in the output file, in pixels. Valid values are auto and width x height: auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules. width x height : The width and height of the output video in pixels. Note the following about specifying the width and height: The width must be an even integer between 128 and 4096, inclusive. The height must be an even integer between 96 and 3072, inclusive. If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution. If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution. We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value): 1 - 25344 1b - 25344 1.1 - 101376 1.2 - 101376 1.3 - 101376 2 - 101376 2.1 - 202752 2.2 - 404720 3 - 404720 3.1 - 921600 3.2 - 1310720 4 - 2097152 4.1 - 2097152 1423 */ 1424 Resolution?: Resolution; 1425 /** 1426 * To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together. The display aspect ratio of the video in the output file. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input file. If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video. 1427 */ 1428 AspectRatio?: AspectRatio; 1429 /** 1430 * The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096. 1431 */ 1432 MaxWidth?: DigitsOrAuto; 1433 /** 1434 * The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072. 1435 */ 1436 MaxHeight?: DigitsOrAuto; 1437 /** 1438 * The value that Elastic Transcoder adds to the metadata in the output file. 1439 */ 1440 DisplayAspectRatio?: AspectRatio; 1441 /** 1442 * Specify one of the following values to control scaling of the output video: Fit: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value. Fill: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value. Stretch: Elastic Transcoder stretches the output video to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input video and the output video are different, the output video will be distorted. Keep: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output video. ShrinkToFit: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up. ShrinkToFill: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up. 1443 */ 1444 SizingPolicy?: SizingPolicy; 1445 /** 1446 * When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for MaxWidth and MaxHeight. 1447 */ 1448 PaddingPolicy?: PaddingPolicy; 1449 /** 1450 * Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video. Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency. When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions. 1451 */ 1452 Watermarks?: PresetWatermarks; 1453 } 1454 export interface Warning { 1455 /** 1456 * The code of the cross-regional warning. 1457 */ 1458 Code?: String; 1459 /** 1460 * The message explaining what resources are in a different region from the pipeline. AWS KMS keys must be in the same region as the pipeline. 1461 */ 1462 Message?: String; 1463 } 1464 export type Warnings = Warning[]; 1465 export type WatermarkKey = string; 1466 export type WatermarkSizingPolicy = string; 1467 export type ZeroTo255String = string; 1468 export type ZeroTo512String = string; 1469 /** 1470 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1471 */ 1472 export type apiVersion = "2012-09-25"|"latest"|string; 1473 export interface ClientApiVersions { 1474 /** 1475 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1476 */ 1477 apiVersion?: apiVersion; 1478 } 1479 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1480 } 1481 export = ElasticTranscoder;