TransformOutput – Media API – MediaKind
TransformOutput
object
onError
enum Optional
Defines what the service should do when one output fails. Continue to produce other outputs, or stop processing.
Allowed values: ContinueJob, StopProcessingJob
preset
object Required
Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output.
Show 7 variants
Discriminated by @odata.type. Select one variant:
Microsoft.Media.BuiltInStandardEncoderPreset
object BuiltInStandardEncoderPreset
@odata.typestring Required - The discriminator for derived types.advancedSettingsNamestring Optional - Name of the advanced settings configuration to apply to this transform's config. These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.presetNamestring Required - The built-in preset to be used for encoding videos. Options include:- H264SingleBitrateSD
- H264SingleBitrate720p
- H264SingleBitrate1080p
- H264MultipleBitrateSD
- H264MultipleBitrate720p
- H264MultipleBitrate1080p
- H264MultipleBitrateSDWithCVQ
- H264MultipleBitrate720pWithCVQ
- H264MultipleBitrate1080pWithCVQ
- H265SingleBitrate720p
- H265SingleBitrate1080p
- H265SingleBitrate4K
- AACGoodQualityAudio
MediaKind.BuiltInAssetConverterPreset
object BuiltInAssetConverterPreset
@odata.typestring Required - The discriminator for derived types.presetNameenum Required - The built-in preset to be used for performing asset conversion.
Allowed values: CopyTopBitrateInterleaved, CopyAllBitrateNonInterleaved, CopyAllBitrateInterleaved
Microsoft.Media.BuiltInAssetConverterPreset
object BuiltInAssetConverterPreset
@odata.typestring Required - The discriminator for derived types.presetNameenum Required - The built-in preset to be used for performing asset conversion.
Allowed values: CopyTopBitrateInterleaved, CopyAllBitrateNonInterleaved, CopyAllBitrateInterleaved
MediaKind.ThumbnailGeneratorPreset
object ThumbnailGeneratorPreset
@odata.typestring Required - The discriminator for derived types.baseFilenamestring Optional <=64 characters pattern: ^[A-Za-z0-9_-]+$ - Used to create the output filename as{BaseFilename}_{Label}{Index}{Extension}. The default is the name of the input file. If the name of the input file is too long then it will be truncated to 64 characters.thumbnailslist of objects ThumbnailGeneratorConfiguration Required 1+ items - The set of thumbnails to be produced.
Show 9 properties
formatenum Required - The output format for the thumbnails. Allowed values: Jpeg, Pngheightstring Optional - Either an integer size in pixels, or a percentage of the input resolution. If either width/height is defined as percentage, the other dimension must be the same percentage.labelstring Optional <=64 characters pattern: ^[A-Za-z0-9_-]+$ - Used to create the output filename as{BaseFilename}_{Label}{Index}{Extension}. When generating sprites, the output vtt file will be named{BaseFilename}_{Label}.vttqualityinteger Optional 0 to 100 Defaults to 70 - The compression quality for JPEG images. Between 0-100, default: 70.rangestring Optional Defaults to 1 - Either an ISO8601 duration, or a percentage of the asset duration, or the value '1'. The default is '1', a single thumbnail is produced.spriteColumninteger Optional 1 to 10 - The number of columns used if you want a thumbnail sprite image. Default: Single image output files.startstring Optional Defaults to PT10S - Either an ISO8601 duration, or a percentage of the asset duration. Default: PT10S.stepstring Optional - The intervals at which thumbnails are generated. Either an ISO8601 duration, or a percentage of the asset duration.widthstring Optional - Either an integer size in pixels, or a percentage of the input resolution. If only one of width/height is present, the aspect ratio from the source is preserved.
MediaKind.TrackInserterPreset
object TrackInserterPreset
@odata.typestring Required - The discriminator for derived types.baseFilenamestring Optional <=64 characters pattern: ^[A-Za-z0-9_-]+$ - Used to create the output filename.- For text tracks:
{BaseFilename}.cmft, the default being the input .vtt filename minus the extension, e.g.subtitles.vtt->subtitles.cmft. - For audio tracks:
{BaseFilename}.mp4, the default being the input .mp4 filename, ignored if the audio file is already present in the output asset.
- For text tracks:
trackslist of objects Required 1-1 items - The set of tracks to be inserted. Currently limited to one.
Show 2 variants
Discriminated by @odata.type. Select one variant:
MediaKind.TextTrack
object TextTrack
@odata.typestring Required - The discriminator for derived types.displayNamestring Optional - The display name of the track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.hlsSettingsobject HlsSettings Optional - The HLS specific setting for the track.
Show 3 properties
characteristicsstring Optional - The characteristics for the HLS setting.defaultboolean Optional Defaults to false - Default track?forcedboolean Optional Defaults to false - Forced track?languageCodestring Optional - The RFC5646 language code for the track.playerVisibilityenum Optional Defaults to Visible - When PlayerVisibility is set to 'Visible', the track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to 'Hidden', the track will not be available to the client. The default value is 'Visible'. Allowed values: Visible, HiddentrackNamestring Required - The name of the track in the manifest.
MediaKind.AudioTrack
object AudioTrack
@odata.typestring Required - The discriminator for derived types.dashSettingsobject DashSettings Optional - The DASH specific setting for the audio track.
Show 1 property
rolestring Optional - The role for the DASH setting.displayNamestring Optional - The display name of the audio track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.hlsSettingsobject HlsSettings Optional - The HLS specific setting for the audio track.
Show 3 properties
characteristicsstring Optional - The characteristics for the HLS setting.defaultboolean Optional Defaults to false - Default track?forcedboolean Optional Defaults to false - Forced track?languageCodestring Optional - The RFC5646 language code for the audio track.trackNamestring Required - The name of the audio track in the manifest.
MediaKind.AIPipelinePreset
object AIPipelinePreset
@odata.typestring Required - The discriminator for derived types.pipelineobject PipelineArguments Required - AI pipeline settings
Show 2 properties
argumentsmap from strings to list of objects ArgumentSchema Optional - Arguments to each operation in the AI pipeline
Show value schema
[any key]list of objects
Show 2 properties
namestring Required 1-260 characters pattern: ^[A-Za-z0-9_-]+$ - The name of the argumentvalueany AnyValue Required - The value of the argumentnamestring Required 0-255 characters - The name of the AI pipeline the Transform will execute.
MediaKind.EncoderPreset
object EncoderPreset
@odata.typestring Required - The discriminator for derived types.advancedSettingsNamestring Optional - Name of the advanced settings configuration to apply to this transform's config. These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.configmap from strings to any Required - The configuration for the custom preset.
Show value schema
[any key]anypresetNamestring Required - Name of this preset.relativePriorityenum Optional Defaults to Normal - Sets the relative priority of the TransformOutputs within a Transform
Allowed values: High, Low, Normal