TransformPutSchema – Media API – MediaKind

TransformPutSchema

object

propertiesobject TransformPutProperties Required

The properties of the Transform

Show 2 propertiesHide 2 properties

descriptionstringOptional<=1024 characters

The description of the Transform.

outputslist of objects TransformOutput Required

An array of TransformOutputs that the Transform should generate. Currently limited to one.

Show 3 propertiesHide 3 properties

onErrorenumOptional

Defines what the service should do when one output fails. Continue to produce other outputs, or stop processing.

Allowed values:ContinueJobStopProcessingJob

presetobjectRequired

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 variantsHide 7 variants

Discriminated by @odata.type. Select one variant:

#Microsoft.Media.BuiltInStandardEncoderPresetobject BuiltInStandardEncoderPreset

@odata.typestringRequired

The discriminator for derived types.

advancedSettingsNamestringOptional

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.

presetNamestringRequired

The built-in preset to be used for encoding videos. Options include:

#MediaKind.BuiltInAssetConverterPresetobject BuiltInAssetConverterPreset

@odata.typestringRequired

The discriminator for derived types.

presetNameenumRequired

The built-in preset to be used for performing asset conversion.

Allowed values:CopyTopBitrateInterleavedCopyAllBitrateNonInterleavedCopyAllBitrateInterleaved

#Microsoft.Media.BuiltInAssetConverterPresetobject BuiltInAssetConverterPreset

@odata.typestringRequired

The discriminator for derived types.

presetNameenumRequired

The built-in preset to be used for performing asset conversion.

Allowed values:CopyTopBitrateInterleavedCopyAllBitrateNonInterleavedCopyAllBitrateInterleaved

#MediaKind.ThumbnailGeneratorPresetobject ThumbnailGeneratorPreset

@odata.typestringRequired

The discriminator for derived types.

baseFilenamestringOptional<=64 characterspattern: ^[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 Required1+ items

The set of thumbnails to be produced.

Show 9 propertiesHide 9 properties

formatenumRequired

The output format for the thumbnails.

Allowed values:JpegPng

heightstringOptional

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.

labelstringOptional<=64 characterspattern: ^[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}.vtt

qualityintegerOptional0 to 100Defaults to 70

The compression quality for JPEG images. Between 0-100, default: 70.

rangestringOptionalDefaults 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.

spriteColumnintegerOptional1 to 10

The number of columns used if you want a thumbnail sprite image. Default: Single image output files.

startstringOptionalDefaults to PT10S

Either an ISO8601 duration, or a percentage of the asset duration. Default: PT10S.

stepstringOptional

The intervals at which thumbnails are generated. Either an ISO8601 duration, or a percentage of the asset duration.

widthstringOptional

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.TrackInserterPresetobject TrackInserterPreset

@odata.typestringRequired

The discriminator for derived types.

baseFilenamestringOptional<=64 characterspattern: ^[A-Za-z0-9_-]+$

Used to create the output filename.

trackslist of objectsRequired1-1 items

The set of tracks to be inserted. Currently limited to one.

Show 2 variantsHide 2 variants

Discriminated by @odata.type. Select one variant:

#MediaKind.TextTrackobject TextTrack

@odata.typestringRequired

The discriminator for derived types.

displayNamestringOptional

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 propertiesHide 3 properties

characteristicsstringOptional

The characteristics for the HLS setting.

defaultbooleanOptionalDefaults to false

Default track?

forcedbooleanOptionalDefaults to false

Forced track?

languageCodestringOptional

The RFC5646 language code for the track.

playerVisibilityenumOptionalDefaults 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:VisibleHidden

trackNamestringRequired

The name of the track in the manifest.

#MediaKind.AudioTrackobject AudioTrack

@odata.typestringRequired

The discriminator for derived types.

dashSettingsobject DashSettings Optional

The DASH specific setting for the audio track.

Show 1 propertyHide 1 property

rolestringOptional

The role for the DASH setting.

displayNamestringOptional

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 propertiesHide 3 properties

characteristicsstringOptional

The characteristics for the HLS setting.

defaultbooleanOptionalDefaults to false

Default track?

forcedbooleanOptionalDefaults to false

Forced track?

languageCodestringOptional

The RFC5646 language code for the audio track.

trackNamestringRequired

The name of the audio track in the manifest.

#MediaKind.AIPipelinePresetobject AIPipelinePreset

@odata.typestringRequired

The discriminator for derived types.

pipelineobject PipelineArguments Required

AI pipeline settings

Show 2 propertiesHide 2 properties

argumentsmap from strings to list of objects ArgumentSchema Optional

Arguments to each operation in the AI pipeline

Show value schemaHide value schema

[any key]list of objects

Show 2 propertiesHide 2 properties

namestringRequired1-260 characterspattern: ^[A-Za-z0-9_-]+$

The name of the argument

valueany AnyValue Required

The value of the argument

namestringRequired0-255 characters

The name of the AI pipeline the Transform will execute.

#MediaKind.EncoderPresetobject EncoderPreset

@odata.typestringRequired

The discriminator for derived types.

advancedSettingsNamestringOptional

configmap from strings to anyRequired

The configuration for the custom preset.

Show value schemaHide value schema

[any key]any

presetNamestringRequired

Name of this preset.

relativePriorityenumOptionalDefaults to Normal

Sets the relative priority of the TransformOutputs within a Transform

Allowed values:HighLowNormal