diff --git a/schemas/2022-07-01/Microsoft.Media.json b/schemas/2022-07-01/Microsoft.Media.json new file mode 100644 index 0000000000..16cf1a49e5 --- /dev/null +++ b/schemas/2022-07-01/Microsoft.Media.json @@ -0,0 +1,2525 @@ +{ + "id": "https://schema.management.azure.com/schemas/2022-07-01/Microsoft.Media.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Media", + "description": "Microsoft Media Resource Types", + "resourceDefinitions": { + "mediaServices_transforms": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2022-07-01" + ] + }, + "name": { + "type": "string", + "description": "The Transform name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TransformProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A Transform." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/mediaServices_transforms_jobs_childResource" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Media/mediaServices/transforms" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Media/mediaServices/transforms" + }, + "mediaServices_transforms_jobs": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2022-07-01" + ] + }, + "name": { + "type": "string", + "description": "The Job name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/JobProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the Job." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Media/mediaServices/transforms/jobs" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Media/mediaServices/transforms/jobs" + } + }, + "definitions": { + "AacAudio": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.AacAudio" + ] + }, + "profile": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AacLc", + "HeAacV1", + "HeAacV2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The encoding profile to be used when encoding audio with AAC." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes Advanced Audio Codec (AAC) audio encoding settings." + }, + "AbsoluteClipTime": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.AbsoluteClipTime" + ] + }, + "time": { + "type": "string", + "format": "duration", + "description": "The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds." + } + }, + "required": [ + "@odata.type", + "time" + ], + "description": "Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not." + }, + "Audio": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/AacAudio" + }, + { + "$ref": "#/definitions/DDAudio" + } + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.Audio" + ] + }, + "bitrate": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The bitrate, in bits per second, of the output encoded audio." + }, + "channels": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of channels in the audio." + }, + "samplingRate": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sampling rate to use for encoding in hertz." + } + }, + "required": [ + "@odata.type" + ], + "description": "Defines the common properties for all audio codecs." + }, + "AudioAnalyzerPreset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/VideoAnalyzerPreset" + } + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.AudioAnalyzerPreset" + ] + }, + "audioLanguage": { + "type": "string", + "description": "The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). If you know the language of your content, it is recommended that you specify it. The language must be specified explicitly for AudioAnalysisMode::Basic, since automatic language detection is not included in basic mode. If the language isn't specified or set to null, automatic language detection will choose the first language detected and process with the selected language for the duration of the file. It does not currently support dynamically switching between languages after the first language is detected. The automatic detection works best with audio recordings with clearly discernable speech. If automatic detection fails to find the language, transcription would fallback to 'en-US'.\" The list of supported languages is available here: https://go.microsoft.com/fwlink/?linkid=2109463" + }, + "experimentalOptions": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Dictionary containing key value pairs for parameters not exposed in the preset itself" + }, + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard", + "Basic" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen." + } + }, + "required": [ + "@odata.type" + ], + "description": "The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track." + }, + "AudioOverlay": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.AudioOverlay" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the properties of an audio overlay." + }, + "AudioTrackDescriptor": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/SelectAudioTrackByAttribute" + }, + { + "$ref": "#/definitions/SelectAudioTrackById" + } + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.AudioTrackDescriptor" + ] + }, + "channelMapping": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FrontLeft", + "FrontRight", + "Center", + "LowFrequencyEffects", + "BackLeft", + "BackRight", + "StereoLeft", + "StereoRight" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Optional designation for single channel audio tracks. Can be used to combine the tracks into stereo or multi-channel audio tracks." + } + }, + "required": [ + "@odata.type" + ], + "description": "A TrackSelection to select audio tracks." + }, + "BuiltInStandardEncoderPreset": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.BuiltInStandardEncoderPreset" + ] + }, + "configurations": { + "oneOf": [ + { + "$ref": "#/definitions/PresetConfigurations" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "An object of optional configuration settings for encoder." + }, + "presetName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "H264SingleBitrateSD", + "H264SingleBitrate720p", + "H264SingleBitrate1080p", + "AdaptiveStreaming", + "AACGoodQualityAudio", + "DDGoodQualityAudio", + "ContentAwareEncodingExperimental", + "ContentAwareEncoding", + "CopyAllBitrateNonInterleaved", + "H264MultipleBitrate1080p", + "H264MultipleBitrate720p", + "H264MultipleBitrateSD", + "H265ContentAwareEncoding", + "H265AdaptiveStreaming", + "H265SingleBitrate720p", + "H265SingleBitrate1080p", + "H265SingleBitrate4K" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The built-in preset to be used for encoding videos." + } + }, + "required": [ + "@odata.type", + "presetName" + ], + "description": "Describes a built-in preset for encoding the input video with the Standard Encoder." + }, + "ClipTime": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/AbsoluteClipTime" + }, + { + "$ref": "#/definitions/UtcClipTime" + } + ], + "properties": {}, + "description": "Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media." + }, + "Codec": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/Audio" + }, + { + "$ref": "#/definitions/CopyVideo" + }, + { + "$ref": "#/definitions/CopyAudio" + }, + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "label": { + "type": "string", + "description": "An optional label for the codec. The label can be used to control muxing behavior." + } + }, + "description": "Describes the basic properties of all codecs." + }, + "CopyAudio": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.CopyAudio" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "A codec flag, which tells the encoder to copy the input audio bitstream." + }, + "CopyVideo": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.CopyVideo" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "A codec flag, which tells the encoder to copy the input video bitstream without re-encoding." + }, + "DDAudio": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.DDAudio" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes Dolby Digital Audio Codec (AC3) audio encoding settings. The current implementation for Dolby Digital Audio support are: Audio channel numbers at 1((mono), 2(stereo), 6(5.1side); Audio sampling frequency rates at: 32K/44.1K/48K Hz; Audio bitrate values as AC3 specification supports: 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000, 384000, 448000, 512000, 576000, 640000 bps." + }, + "Deinterlace": { + "type": "object", + "properties": { + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Off", + "AutoPixelAdaptive" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The deinterlacing mode. Defaults to AutoPixelAdaptive." + }, + "parity": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Auto", + "TopFieldFirst", + "BottomFieldFirst" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The field parity for de-interlacing, defaults to Auto." + } + }, + "description": "Describes the de-interlacing settings." + }, + "FaceDetectorPreset": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.FaceDetectorPreset" + ] + }, + "blurType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Box", + "Low", + "Med", + "High", + "Black" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Blur type." + }, + "experimentalOptions": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Dictionary containing key value pairs for parameters not exposed in the preset itself" + }, + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Analyze", + "Redact", + "Combined" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This mode provides the ability to choose between the following settings: 1) Analyze - For detection only.This mode generates a metadata JSON file marking appearances of faces throughout the video.Where possible, appearances of the same person are assigned the same ID. 2) Combined - Additionally redacts(blurs) detected faces. 3) Redact - This enables a 2-pass process, allowing for selective redaction of a subset of detected faces.It takes in the metadata file from a prior analyze pass, along with the source video, and a user-selected subset of IDs that require redaction." + }, + "resolution": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SourceResolution", + "StandardDefinition" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the maximum resolution at which your video is analyzed. The default behavior is \"SourceResolution,\" which will keep the input video at its original resolution when analyzed. Using \"StandardDefinition\" will resize input videos to standard definition while preserving the appropriate aspect ratio. It will only resize if the video is of higher resolution. For example, a 1920x1080 input would be scaled to 640x360 before processing. Switching to \"StandardDefinition\" will reduce the time it takes to process high resolution video. It may also reduce the cost of using this component (see https://azure.microsoft.com/en-us/pricing/details/media-services/#analytics for details). However, faces that end up being too small in the resized video may not be detected." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes all the settings to be used when analyzing a video in order to detect (and optionally redact) all the faces present." + }, + "Fade": { + "type": "object", + "properties": { + "duration": { + "type": "string", + "description": "The Duration of the fade effect in the video. The value can be in ISO 8601 format (For example, PT05S to fade In/Out a color during 5 seconds), or a frame count (For example, 10 to fade 10 frames from the start time), or a relative value to stream duration (For example, 10% to fade 10% of stream duration)" + }, + "fadeColor": { + "type": "string", + "description": "The Color for the fade In/Out. it can be on the CSS Level1 colors https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/color_keywords or an RGB/hex value: e.g: rgb(255,0,0), 0xFF0000 or #FF0000" + }, + "start": { + "type": "string", + "description": "The position in the input video from where to start fade. The value can be in ISO 8601 format (For example, PT05S to start at 5 seconds), or a frame count (For example, 10 to start at the 10th frame), or a relative value to stream duration (For example, 10% to start at 10% of stream duration). Default is 0" + } + }, + "required": [ + "duration", + "fadeColor" + ], + "description": "Describes the properties of a Fade effect applied to the input media." + }, + "Filters": { + "type": "object", + "properties": { + "crop": { + "oneOf": [ + { + "$ref": "#/definitions/Rectangle" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a rectangular window applied to the input media before processing it." + }, + "deinterlace": { + "oneOf": [ + { + "$ref": "#/definitions/Deinterlace" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the de-interlacing settings." + }, + "fadeIn": { + "oneOf": [ + { + "$ref": "#/definitions/Fade" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Fade effect applied to the input media." + }, + "fadeOut": { + "oneOf": [ + { + "$ref": "#/definitions/Fade" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Fade effect applied to the input media." + }, + "overlays": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Overlay" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of overlays to be applied to the input video. These could be audio, image or video overlays." + }, + "rotation": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Auto", + "None", + "Rotate0", + "Rotate90", + "Rotate180", + "Rotate270" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto." + } + }, + "description": "Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding." + }, + "Format": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/ImageFormat" + }, + { + "$ref": "#/definitions/MultiBitrateFormat" + } + ], + "properties": { + "filenamePattern": { + "type": "string", + "description": "The file naming pattern used for the creation of output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {AudioStream} - string \"Audio\" plus audio stream number(start from 1). {Bitrate} - The audio/video bitrate in kbps. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename." + } + }, + "required": [ + "filenamePattern" + ], + "description": "Base class for output." + }, + "FromAllInputFile": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.FromAllInputFile" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "An InputDefinition that looks across all of the files provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to allow selection of a single track across a set of input files." + }, + "FromEachInputFile": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.FromEachInputFile" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "An InputDefinition that looks at each input file provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to select tracks from each file given." + }, + "H264Layer": { + "type": "object", + "properties": { + "adaptiveBFrame": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use." + }, + "bFrames": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level." + }, + "bitrate": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field." + }, + "bufferWindow": { + "type": "string", + "format": "duration", + "description": "The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S)." + }, + "crf": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 23." + }, + "entropyMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Cabac", + "Cavlc" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level." + }, + "frameRate": { + "type": "string", + "description": "The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video." + }, + "height": { + "type": "string", + "description": "The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input." + }, + "label": { + "type": "string", + "description": "The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file." + }, + "level": { + "type": "string", + "description": "We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer." + }, + "maxBitrate": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate." + }, + "profile": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Auto", + "Baseline", + "Main", + "High", + "High422", + "High444" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "We currently support Baseline, Main, High, High422, High444. Default is Auto." + }, + "referenceFrames": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting." + }, + "slices": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame." + }, + "width": { + "type": "string", + "description": "The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input." + } + }, + "required": [ + "bitrate" + ], + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec." + }, + "H264Video": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.H264Video" + ] + }, + "complexity": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Speed", + "Balanced", + "Quality" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tells the encoder how to choose its encoding settings. The default value is Balanced." + }, + "layers": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/H264Layer" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The collection of output H.264 layers to be produced by the encoder." + }, + "rateControlMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "ABR", + "CBR", + "CRF" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The video rate control mode." + }, + "sceneChangeDetection": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes all the properties for encoding a video with the H.264 codec." + }, + "H265Layer": { + "type": "object", + "properties": { + "adaptiveBFrame": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use." + }, + "bFrames": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level." + }, + "bitrate": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The average bitrate in bits per second at which to encode the input video when generating this layer. For example: a target bitrate of 3000Kbps or 3Mbps means this value should be 3000000 This is a required field." + }, + "bufferWindow": { + "type": "string", + "format": "duration", + "description": "The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S)." + }, + "crf": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 28." + }, + "frameRate": { + "type": "string", + "description": "The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video." + }, + "height": { + "type": "string", + "description": "The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input." + }, + "label": { + "type": "string", + "description": "The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file." + }, + "level": { + "type": "string", + "description": "We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.265 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer." + }, + "maxBitrate": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate." + }, + "profile": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Auto", + "Main", + "Main10" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "We currently support Main. Default is Auto." + }, + "referenceFrames": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting." + }, + "slices": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame." + }, + "width": { + "type": "string", + "description": "The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input." + } + }, + "required": [ + "bitrate" + ], + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.265 video codec." + }, + "H265Video": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.H265Video" + ] + }, + "complexity": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Speed", + "Balanced", + "Quality" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced." + }, + "layers": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/H265Layer" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The collection of output H.265 layers to be produced by the encoder." + }, + "sceneChangeDetection": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes all the properties for encoding a video with the H.265 codec." + }, + "Image": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/JpgImage" + }, + { + "$ref": "#/definitions/PngImage" + } + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.Image" + ] + }, + "range": { + "type": "string", + "description": "The position relative to transform preset start time in the input video at which to stop generating thumbnails. The value can be in ISO 8601 format (For example, PT5M30S to stop at 5 minutes and 30 seconds from start time), or a frame count (For example, 300 to stop at the 300th frame from the frame at start time. If this value is 1, it means only producing one thumbnail at start time), or a relative value to the stream duration (For example, 50% to stop at half of stream duration from start time). The default value is 100%, which means to stop at the end of the stream." + }, + "start": { + "type": "string", + "description": "The position in the input video from where to start generating thumbnails. The value can be in ISO 8601 format (For example, PT05S to start at 5 seconds), or a frame count (For example, 10 to start at the 10th frame), or a relative value to stream duration (For example, 10% to start at 10% of stream duration). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video and will only produce one thumbnail, no matter what other settings are for Step and Range. The default value is macro {Best}." + }, + "step": { + "type": "string", + "description": "The intervals at which thumbnails are generated. The value can be in ISO 8601 format (For example, PT05S for one image every 5 seconds), or a frame count (For example, 30 for one image every 30 frames), or a relative value to stream duration (For example, 10% for one image every 10% of stream duration). Note: Step value will affect the first generated thumbnail, which may not be exactly the one specified at transform preset start time. This is due to the encoder, which tries to select the best thumbnail between start time and Step position from start time as the first output. As the default value is 10%, it means if stream has long duration, the first generated thumbnail might be far away from the one specified at start time. Try to select reasonable value for Step if the first thumbnail is expected close to start time, or set Range value at 1 if only one thumbnail is needed at start time." + } + }, + "required": [ + "@odata.type", + "start" + ], + "description": "Describes the basic properties for generating thumbnails from the input video" + }, + "ImageFormat": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/JpgFormat" + }, + { + "$ref": "#/definitions/PngFormat" + } + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.ImageFormat" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the properties for an output image file." + }, + "InputDefinition": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/FromAllInputFile" + }, + { + "$ref": "#/definitions/FromEachInputFile" + }, + { + "$ref": "#/definitions/InputFile" + } + ], + "properties": { + "includedTracks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/TrackDescriptor" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of TrackDescriptors which define the metadata and selection of tracks in the input." + } + }, + "description": "Base class for defining an input. Use sub classes of this class to specify tracks selections and related metadata." + }, + "InputFile": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.InputFile" + ] + }, + "filename": { + "type": "string", + "description": "Name of the file that this input definition applies to." + } + }, + "required": [ + "@odata.type" + ], + "description": "An InputDefinition for a single file. TrackSelections are scoped to the file specified." + }, + "JobInput": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/JobInputClip" + }, + { + "$ref": "#/definitions/JobInputs" + }, + { + "$ref": "#/definitions/JobInputSequence" + } + ], + "properties": {}, + "description": "Base class for inputs to a Job." + }, + "JobInputAsset": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.JobInputAsset" + ] + }, + "assetName": { + "type": "string", + "description": "The name of the input Asset." + } + }, + "required": [ + "@odata.type", + "assetName" + ], + "description": "Represents an Asset for input into a Job." + }, + "JobInputClip": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/JobInputAsset" + }, + { + "$ref": "#/definitions/JobInputHttp" + } + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.JobInputClip" + ] + }, + "end": { + "oneOf": [ + { + "$ref": "#/definitions/ClipTime" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media." + }, + "files": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of files. Required for JobInputHttp. Maximum of 4000 characters each. Query strings will not be returned in service responses to prevent sensitive data exposure." + }, + "inputDefinitions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InputDefinition" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata." + }, + "label": { + "type": "string", + "description": "A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'." + }, + "start": { + "oneOf": [ + { + "$ref": "#/definitions/ClipTime" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media." + } + }, + "required": [ + "@odata.type" + ], + "description": "Represents input files for a Job." + }, + "JobInputHttp": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.JobInputHttp" + ] + }, + "baseUri": { + "type": "string", + "description": "Base URI for HTTPS job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris. Maximum length of 4000 characters. The query strings will not be returned in service responses to prevent sensitive data exposure." + } + }, + "required": [ + "@odata.type" + ], + "description": "Represents HTTPS job input." + }, + "JobInputs": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.JobInputs" + ] + }, + "inputs": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of inputs to a Job." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes a list of inputs to a Job." + }, + "JobInputSequence": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.JobInputSequence" + ] + }, + "inputs": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "JobInputs that make up the timeline." + } + }, + "required": [ + "@odata.type" + ], + "description": "A Sequence contains an ordered list of Clips where each clip is a JobInput. The Sequence will be treated as a single input." + }, + "JobOutput": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/JobOutputAsset" + } + ], + "properties": { + "label": { + "type": "string", + "description": "A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform." + }, + "presetOverride": { + "oneOf": [ + { + "$ref": "#/definitions/Preset" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Base type for all Presets, which define the recipe or instructions on how the input media files should be processed." + } + }, + "description": "Describes all the properties of a JobOutput." + }, + "JobOutputAsset": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.JobOutputAsset" + ] + }, + "assetName": { + "type": "string", + "description": "The name of the output Asset." + } + }, + "required": [ + "@odata.type", + "assetName" + ], + "description": "Represents an Asset used as a JobOutput." + }, + "JobProperties": { + "type": "object", + "properties": { + "correlationData": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Customer provided key, value pairs that will be returned in Job and JobOutput state events." + }, + "description": { + "type": "string", + "description": "Optional customer supplied description of the Job." + }, + "input": { + "oneOf": [ + { + "$ref": "#/definitions/JobInput" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Base class for inputs to a Job." + }, + "outputs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/JobOutput" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The outputs for the Job." + }, + "priority": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal." + } + }, + "required": [ + "input", + "outputs" + ], + "description": "Properties of the Job." + }, + "JpgFormat": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.JpgFormat" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the settings for producing JPEG thumbnails." + }, + "JpgImage": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.JpgImage" + ] + }, + "layers": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/JpgLayer" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A collection of output JPEG image layers to be produced by the encoder." + }, + "spriteColumn": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the properties for producing a series of JPEG images from the input video." + }, + "JpgLayer": { + "type": "object", + "properties": { + "height": { + "type": "string", + "description": "The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input." + }, + "label": { + "type": "string", + "description": "The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file." + }, + "quality": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The compression quality of the JPEG output. Range is from 0-100 and the default is 70." + }, + "width": { + "type": "string", + "description": "The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input." + } + }, + "description": "Describes the settings to produce a JPEG image from the input video." + }, + "mediaServices_transforms_jobs_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2022-07-01" + ] + }, + "name": { + "type": "string", + "description": "The Job name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/JobProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the Job." + }, + "type": { + "type": "string", + "enum": [ + "jobs" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Media/mediaServices/transforms/jobs" + }, + "Mp4Format": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.Mp4Format" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the properties for an output ISO MP4 file." + }, + "MultiBitrateFormat": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/Mp4Format" + }, + { + "$ref": "#/definitions/TransportStreamFormat" + } + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.MultiBitrateFormat" + ] + }, + "outputFiles": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together ." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection." + }, + "OutputFile": { + "type": "object", + "properties": { + "labels": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of labels that describe how the encoder should multiplex video and audio into an output file. For example, if the encoder is producing two video layers with labels v1 and v2, and one audio layer with label a1, then an array like '[v1, a1]' tells the encoder to produce an output file with the video track represented by v1 and the audio track represented by a1." + } + }, + "required": [ + "labels" + ], + "description": "Represents an output file produced." + }, + "Overlay": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/AudioOverlay" + }, + { + "$ref": "#/definitions/VideoOverlay" + } + ], + "properties": { + "audioGainLevel": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0." + }, + "end": { + "type": "string", + "format": "duration", + "description": "The end position, with reference to the input video, at which the overlay ends. The value should be in ISO 8601 format. For example, PT30S to end the overlay at 30 seconds into the input video. If not specified or the value is greater than the input video duration, the overlay will be applied until the end of the input video if the overlay media duration is greater than the input video duration, else the overlay will last as long as the overlay media duration." + }, + "fadeInDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S)." + }, + "fadeOutDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S)." + }, + "inputLabel": { + "type": "string", + "description": "The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG, PNG, GIF or BMP format, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats." + }, + "start": { + "type": "string", + "format": "duration", + "description": "The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds into the input video. If not specified the overlay starts from the beginning of the input video." + } + }, + "required": [ + "inputLabel" + ], + "description": "Base type for all overlays - image, audio or video." + }, + "PngFormat": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.PngFormat" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the settings for producing PNG thumbnails." + }, + "PngImage": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.PngImage" + ] + }, + "layers": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/PngLayer" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A collection of output PNG image layers to be produced by the encoder." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the properties for producing a series of PNG images from the input video." + }, + "PngLayer": { + "type": "object", + "properties": { + "height": { + "type": "string", + "description": "The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input." + }, + "label": { + "type": "string", + "description": "The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file." + }, + "width": { + "type": "string", + "description": "The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input." + } + }, + "description": "Describes the settings to produce a PNG image from the input video." + }, + "Preset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/FaceDetectorPreset" + }, + { + "$ref": "#/definitions/AudioAnalyzerPreset" + }, + { + "$ref": "#/definitions/BuiltInStandardEncoderPreset" + }, + { + "$ref": "#/definitions/StandardEncoderPreset" + } + ], + "properties": {}, + "description": "Base type for all Presets, which define the recipe or instructions on how the input media files should be processed." + }, + "PresetConfigurations": { + "type": "object", + "properties": { + "complexity": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Speed", + "Balanced", + "Quality" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency." + }, + "interleaveOutput": { + "oneOf": [ + { + "type": "string", + "enum": [ + "NonInterleavedOutput", + "InterleavedOutput" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files." + }, + "keyFrameIntervalInSeconds": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The key frame interval in seconds. Example: set KeyFrameIntervalInSeconds as 2 to reduce the playback buffering for some players." + }, + "maxBitrateBps": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum bitrate in bits per second (threshold for the top video layer). Example: set MaxBitrateBps as 6000000 to avoid producing very high bitrate outputs for contents with high complexity." + }, + "maxHeight": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum height of output video layers. Example: set MaxHeight as 720 to produce output layers up to 720P even if the input is 4K." + }, + "maxLayers": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum number of output video layers. Example: set MaxLayers as 4 to make sure at most 4 output layers are produced to control the overall cost of the encoding job." + }, + "minBitrateBps": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The minimum bitrate in bits per second (threshold for the bottom video layer). Example: set MinBitrateBps as 200000 to have a bottom layer that covers users with low network bandwidth." + }, + "minHeight": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The minimum height of output video layers. Example: set MinHeight as 360 to avoid output layers of smaller resolutions like 180P." + } + }, + "description": "An object of optional configuration settings for encoder." + }, + "Rectangle": { + "type": "object", + "properties": { + "height": { + "type": "string", + "description": "The height of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "left": { + "type": "string", + "description": "The number of pixels from the left-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "top": { + "type": "string", + "description": "The number of pixels from the top-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "width": { + "type": "string", + "description": "The width of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + } + }, + "description": "Describes the properties of a rectangular window applied to the input media before processing it." + }, + "SelectAudioTrackByAttribute": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.SelectAudioTrackByAttribute" + ] + }, + "attribute": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Bitrate", + "Language" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The TrackAttribute to filter the tracks by." + }, + "filter": { + "oneOf": [ + { + "type": "string", + "enum": [ + "All", + "Top", + "Bottom", + "ValueEquals" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks." + }, + "filterValue": { + "type": "string", + "description": "The value to filter the tracks by. Only used when AttributeFilter.ValueEquals is specified for the Filter property." + } + }, + "required": [ + "@odata.type", + "attribute", + "filter" + ], + "description": "Select audio tracks from the input by specifying an attribute and an attribute filter." + }, + "SelectAudioTrackById": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.SelectAudioTrackById" + ] + }, + "trackId": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Track identifier to select" + } + }, + "required": [ + "@odata.type", + "trackId" + ], + "description": "Select audio tracks from the input by specifying a track identifier." + }, + "SelectVideoTrackByAttribute": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.SelectVideoTrackByAttribute" + ] + }, + "attribute": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Bitrate", + "Language" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The TrackAttribute to filter the tracks by." + }, + "filter": { + "oneOf": [ + { + "type": "string", + "enum": [ + "All", + "Top", + "Bottom", + "ValueEquals" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks." + }, + "filterValue": { + "type": "string", + "description": "The value to filter the tracks by. Only used when AttributeFilter.ValueEquals is specified for the Filter property. For TrackAttribute.Bitrate, this should be an integer value in bits per second (e.g: '1500000'). The TrackAttribute.Language is not supported for video tracks." + } + }, + "required": [ + "@odata.type", + "attribute", + "filter" + ], + "description": "Select video tracks from the input by specifying an attribute and an attribute filter." + }, + "SelectVideoTrackById": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.SelectVideoTrackById" + ] + }, + "trackId": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Track identifier to select" + } + }, + "required": [ + "@odata.type", + "trackId" + ], + "description": "Select video tracks from the input by specifying a track identifier." + }, + "StandardEncoderPreset": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.StandardEncoderPreset" + ] + }, + "codecs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Codec" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of codecs to be used when encoding the input video." + }, + "experimentalOptions": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Dictionary containing key value pairs for parameters not exposed in the preset itself" + }, + "filters": { + "oneOf": [ + { + "$ref": "#/definitions/Filters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding." + }, + "formats": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Format" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of outputs to be produced by the encoder." + } + }, + "required": [ + "@odata.type", + "codecs", + "formats" + ], + "description": "Describes all the settings to be used when encoding the input video with the Standard Encoder." + }, + "TrackDescriptor": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/AudioTrackDescriptor" + }, + { + "$ref": "#/definitions/VideoTrackDescriptor" + } + ], + "properties": {}, + "description": "Base type for all TrackDescriptor types, which define the metadata and selection for tracks that should be processed by a Job" + }, + "TransformOutput": { + "type": "object", + "properties": { + "onError": { + "oneOf": [ + { + "type": "string", + "enum": [ + "StopProcessingJob", + "ContinueJob" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'." + }, + "preset": { + "oneOf": [ + { + "$ref": "#/definitions/Preset" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Base type for all Presets, which define the recipe or instructions on how the input media files should be processed." + }, + "relativePriority": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal." + } + }, + "required": [ + "preset" + ], + "description": "Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output." + }, + "TransformProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "An optional verbose description of the Transform." + }, + "outputs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/TransformOutput" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "An array of one or more TransformOutputs that the Transform should generate." + } + }, + "required": [ + "outputs" + ], + "description": "A Transform." + }, + "TransportStreamFormat": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.TransportStreamFormat" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output video file(s)." + }, + "UtcClipTime": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.UtcClipTime" + ] + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time position on the timeline of the input media based on Utc time." + } + }, + "required": [ + "@odata.type", + "time" + ], + "description": "Specifies the clip time as a Utc time position in the media file. The Utc time can point to a different position depending on whether the media file starts from a timestamp of zero or not." + }, + "Video": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/H265Video" + }, + { + "$ref": "#/definitions/Image" + }, + { + "$ref": "#/definitions/H264Video" + } + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.Video" + ] + }, + "keyFrameInterval": { + "type": "string", + "format": "duration", + "description": "The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting." + }, + "stretchMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "AutoSize", + "AutoFit" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize." + }, + "syncMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Auto", + "Passthrough", + "Cfr", + "Vfr" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Video Sync Mode." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the basic properties for encoding the input video." + }, + "VideoAnalyzerPreset": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.VideoAnalyzerPreset" + ] + }, + "insightsToExtract": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AudioInsightsOnly", + "VideoInsightsOnly", + "AllInsights" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines the type of insights that you want the service to generate. The allowed values are 'AudioInsightsOnly', 'VideoInsightsOnly', and 'AllInsights'. The default is AllInsights. If you set this to AllInsights and the input is audio only, then only audio insights are generated. Similarly if the input is video only, then only video insights are generated. It is recommended that you not use AudioInsightsOnly if you expect some of your inputs to be video only; or use VideoInsightsOnly if you expect some of your inputs to be audio only. Your Jobs in such conditions would error out." + } + }, + "required": [ + "@odata.type" + ], + "description": "A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file." + }, + "VideoOverlay": { + "type": "object", + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.VideoOverlay" + ] + }, + "cropRectangle": { + "oneOf": [ + { + "$ref": "#/definitions/Rectangle" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a rectangular window applied to the input media before processing it." + }, + "opacity": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque." + }, + "position": { + "oneOf": [ + { + "$ref": "#/definitions/Rectangle" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a rectangular window applied to the input media before processing it." + } + }, + "required": [ + "@odata.type" + ], + "description": "Describes the properties of a video overlay." + }, + "VideoTrackDescriptor": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/SelectVideoTrackByAttribute" + }, + { + "$ref": "#/definitions/SelectVideoTrackById" + } + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Media.VideoTrackDescriptor" + ] + } + }, + "required": [ + "@odata.type" + ], + "description": "A TrackSelection to select video tracks." + } + } +} \ No newline at end of file diff --git a/schemas/common/autogeneratedResources.json b/schemas/common/autogeneratedResources.json index b62032ca32..cab8992e39 100644 --- a/schemas/common/autogeneratedResources.json +++ b/schemas/common/autogeneratedResources.json @@ -13405,6 +13405,12 @@ { "$ref": "https://schema.management.azure.com/schemas/2021-11-01/Microsoft.Media.json#/resourceDefinitions/mediaServices_transforms_jobs" }, + { + "$ref": "https://schema.management.azure.com/schemas/2022-07-01/Microsoft.Media.json#/resourceDefinitions/mediaServices_transforms" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2022-07-01/Microsoft.Media.json#/resourceDefinitions/mediaServices_transforms_jobs" + }, { "$ref": "https://schema.management.azure.com/schemas/2022-08-01/Microsoft.Media.json#/resourceDefinitions/mediaServices_accountFilters" },