--- updatedAt: 2026-07-22T07:09:00.000Z agentTools: siteIndex: https://developer.bitmovin.com/llms.txt projectIndex: https://developer.bitmovin.com/encoding/llms.txt --- # Create H265/HEVC Codec Configuration # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Live Encoding API", "description": "Bitmovins API Reference Description", "version": "3.0", "termsOfService": "https://bitmovin.com", "contact": { "name": "Bitmovin Inc", "url": "https://bitmovin.com", "email": "support@bitmovin.com" } }, "servers": [ { "url": "https://api.bitmovin.com/v1", "description": "Bitmovin Server", "variables": {} } ], "security": [ { "ApiKeyAuth": [] }, { "ApiKeyAuth": [], "TenantOrgId": [] } ], "paths": { "/encoding/configurations/video/h265": { "post": { "tags": [ "H265 Configuration" ], "summary": "Create H265/HEVC Codec Configuration", "operationId": "LivePostEncodingConfigurationsVideoH265", "x-bitmovin": { "product": "shared" }, "requestBody": { "description": "The H265/HEVC Codec Configuration to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/H265VideoConfiguration" } } } }, "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseEnvelope" }, { "properties": { "data": { "properties": { "result": { "allOf": [ { "$ref": "#/components/schemas/H265VideoConfiguration" }, { "description": "H265/HEVC video configuration" } ] } } } } } ] } } } }, "default": { "description": "Error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError" } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "description": "Your Bitmovin API key", "name": "X-Api-Key", "in": "header" }, "TenantOrgId": { "type": "apiKey", "description": "Your Bitmovin account organization", "name": "X-Tenant-Org-Id", "in": "header" } }, "schemas": { "BitmovinResource": { "title": "BitmovinResource", "allOf": [ { "$ref": "#/components/schemas/BitmovinResponse" }, { "properties": { "name": { "type": "string", "description": "Name of the resource. Can be freely chosen by the user.", "example": "Name of the resource" }, "description": { "type": "string", "description": "Description of the resource. Can be freely chosen by the user.", "example": "Description of the resource" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ", "example": "2016-06-25T20:09:23.69Z" }, "modifiedAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ", "example": "2016-06-25T20:09:23.69Z" }, "customData": { "type": "string", "writeOnly": true, "description": "User-specific meta data. This can hold anything.", "additionalProperties": { "type": "object" } } } } ] }, "BitmovinResponse": { "title": "BitmovinResponse", "required": [ "id" ], "properties": { "id": { "type": "string", "readOnly": true, "description": "Id of the resource", "example": "cb90b80c-8867-4e3b-8479-174aa2843f62" } } }, "AutoLevelSetup": { "title": "AutoLevelSetup", "type": "string", "default": "ENABLED", "description": "Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate.", "enum": [ "ENABLED", "DISABLED" ], "x-enum-elements": [ { "name": "ENABLED", "description": "Enable automatic calculation of level, maxrate and bufsize" }, { "name": "DISABLED", "description": "Disable automatic calculation of level, maxrate and bufsize" } ] }, "BAdapt": { "title": "BAdapt", "type": "string", "default": "FULL", "enum": [ "NONE", "FAST", "FULL" ], "x-enum-elements": [ { "name": "NONE", "description": "Very fast, but not recommended" }, { "name": "FAST", "description": "A good balance between speed and quality" }, { "name": "FULL", "description": "Best Quality, but slow with high bframes" } ] }, "Cea608708SubtitleConfiguration": { "title": "Cea608708SubtitleConfiguration", "properties": { "passthroughActivated": { "type": "boolean", "description": "If enabled, CEA 608 an CEA 708 subtitles will be copied from the input video stream to the output video stream. Note: This does not work, if the output framerate is different than the input framerate (except doubling the framerate with deinterlacing per field)", "example": false }, "passthroughMode": { "example": "VIDEO_STREAM", "allOf": [ { "$ref": "#/components/schemas/PassthroughMode" } ] } } }, "ChromaLocation": { "title": "ChromaLocation", "type": "string", "enum": [ "UNSPECIFIED", "LEFT", "CENTER", "TOPLEFT", "TOP", "BOTTOMLEFT", "BOTTOM" ], "x-enum-elements": [ { "name": "UNSPECIFIED", "description": "Unspecified ChromaLocation" }, { "name": "LEFT", "description": "Left ChromaLocation" }, { "name": "CENTER", "description": "Center ChromaLocation" }, { "name": "TOPLEFT", "description": "Topleft ChromaLocation" }, { "name": "TOP", "description": "Top ChromaLocation" }, { "name": "BOTTOMLEFT", "description": "Bottomleft ChromaLocation" }, { "name": "BOTTOM", "description": "Bottom ChromaLocation" } ] }, "CodecConfiguration": { "title": "CodecConfiguration", "required": [ "name" ], "allOf": [ { "$ref": "#/components/schemas/BitmovinResource" } ] }, "ColorConfig": { "title": "ColorConfig", "properties": { "copyChromaLocationFlag": { "type": "boolean", "description": "Copy the chroma location setting from the input source", "example": false }, "copyColorSpaceFlag": { "type": "boolean", "description": "Copy the color space setting from the input source", "example": false }, "copyColorPrimariesFlag": { "type": "boolean", "description": "Copy the color primaries setting from the input source", "example": false }, "copyColorRangeFlag": { "type": "boolean", "description": "Copy the color range setting from the input source", "example": false }, "copyColorTransferFlag": { "type": "boolean", "description": "Copy the color transfer setting from the input source", "example": false }, "chromaLocation": { "description": "The chroma location to be applied", "allOf": [ { "$ref": "#/components/schemas/ChromaLocation" } ] }, "colorSpace": { "description": "The color space to be applied.", "allOf": [ { "$ref": "#/components/schemas/ColorSpace" } ] }, "colorPrimaries": { "description": "The color primaries to be applied.", "allOf": [ { "$ref": "#/components/schemas/ColorPrimaries" } ] }, "colorRange": { "description": "The color range to be applied.", "allOf": [ { "$ref": "#/components/schemas/ColorRange" } ] }, "colorTransfer": { "description": "The color transfer to be applied.", "allOf": [ { "$ref": "#/components/schemas/ColorTransfer" } ] }, "inputColorSpace": { "description": "Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.", "allOf": [ { "$ref": "#/components/schemas/InputColorSpace" } ] }, "inputColorRange": { "description": "Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.", "allOf": [ { "$ref": "#/components/schemas/InputColorRange" } ] }, "inputColorPrimaries": { "description": "Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.", "allOf": [ { "$ref": "#/components/schemas/InputColorPrimaries" } ] }, "inputColorTransfer": { "description": "Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.", "allOf": [ { "$ref": "#/components/schemas/InputColorTransfer" } ] } } }, "ColorPrimaries": { "title": "ColorPrimaries", "type": "string", "enum": [ "UNSPECIFIED", "BT709", "BT470M", "BT470BG", "SMPTE170M", "SMPTE240M", "FILM", "BT2020", "SMPTE428", "SMPTEST428_1", "SMPTE431", "SMPTE432", "JEDEC_P22" ], "x-enum-elements": [ { "name": "UNSPECIFIED", "description": "" }, { "name": "BT709", "description": "" }, { "name": "BT470M", "description": "" }, { "name": "BT470BG", "description": "" }, { "name": "SMPTE170M", "description": "" }, { "name": "SMPTE240M", "description": "" }, { "name": "FILM", "description": "" }, { "name": "BT2020", "description": "" }, { "name": "SMPTE428", "description": "" }, { "name": "SMPTEST428_1", "description": "" }, { "name": "SMPTE431", "description": "" }, { "name": "SMPTE432", "description": "" }, { "name": "JEDEC_P22", "description": "" } ] }, "ColorRange": { "title": "ColorRange", "type": "string", "description": "The color range to be applied", "enum": [ "UNSPECIFIED", "MPEG", "JPEG" ], "x-enum-elements": [ { "name": "UNSPECIFIED", "description": "" }, { "name": "MPEG", "description": "" }, { "name": "JPEG", "description": "" } ] }, "ColorSpace": { "title": "ColorSpace", "type": "string", "description": "The color space to be applied", "enum": [ "UNSPECIFIED", "RGB", "BT709", "FCC", "BT470BG", "SMPTE170M", "SMPTE240M", "YCGCO", "YCOCG", "BT2020_NCL", "BT2020_CL", "SMPTE2085" ], "x-enum-elements": [ { "name": "UNSPECIFIED", "description": "" }, { "name": "RGB", "description": "" }, { "name": "BT709", "description": "" }, { "name": "FCC", "description": "" }, { "name": "BT470BG", "description": "" }, { "name": "SMPTE170M", "description": "" }, { "name": "SMPTE240M", "description": "" }, { "name": "YCGCO", "description": "" }, { "name": "YCOCG", "description": "" }, { "name": "BT2020_NCL", "description": "" }, { "name": "BT2020_CL", "description": "" }, { "name": "SMPTE2085", "description": "" } ] }, "InputColorRange": { "title": "InputColorRange", "type": "string", "description": "Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.", "enum": [ "UNSPECIFIED", "MPEG", "JPEG" ], "x-enum-elements": [ { "name": "UNSPECIFIED", "description": "" }, { "name": "MPEG", "description": "" }, { "name": "JPEG", "description": "" } ] }, "InputColorSpace": { "title": "InputColorSpace", "type": "string", "description": "Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.", "enum": [ "UNSPECIFIED", "RGB", "BT709", "FCC", "BT470BG", "SMPTE170M", "SMPTE240M", "YCGCO", "YCOCG", "BT2020_NCL", "BT2020_CL", "SMPTE2085" ], "x-enum-elements": [ { "name": "UNSPECIFIED", "description": "" }, { "name": "RGB", "description": "" }, { "name": "BT709", "description": "" }, { "name": "FCC", "description": "" }, { "name": "BT470BG", "description": "" }, { "name": "SMPTE170M", "description": "" }, { "name": "SMPTE240M", "description": "" }, { "name": "YCGCO", "description": "" }, { "name": "YCOCG", "description": "" }, { "name": "BT2020_NCL", "description": "" }, { "name": "BT2020_CL", "description": "" }, { "name": "SMPTE2085", "description": "" } ] }, "InputColorPrimaries": { "title": "InputColorPrimaries", "type": "string", "enum": [ "UNSPECIFIED", "BT709", "BT470M", "BT470BG", "SMPTE170M", "SMPTE240M", "FILM", "BT2020", "SMPTE428", "SMPTEST428_1", "SMPTE431", "SMPTE432", "JEDEC_P22" ], "x-enum-elements": [ { "name": "UNSPECIFIED", "description": "" }, { "name": "BT709", "description": "" }, { "name": "BT470M", "description": "" }, { "name": "BT470BG", "description": "" }, { "name": "SMPTE170M", "description": "" }, { "name": "SMPTE240M", "description": "" }, { "name": "FILM", "description": "" }, { "name": "BT2020", "description": "" }, { "name": "SMPTE428", "description": "" }, { "name": "SMPTEST428_1", "description": "" }, { "name": "SMPTE431", "description": "" }, { "name": "SMPTE432", "description": "" }, { "name": "JEDEC_P22", "description": "" } ] }, "InputColorTransfer": { "title": "InputColorTransfer", "type": "string", "enum": [ "UNSPECIFIED", "BT709", "GAMMA22", "GAMMA28", "SMPTE170M", "SMPTE240M", "LINEAR", "LOG", "LOG_SQRT", "IEC61966_2_4", "BT1361_ECG", "IEC61966_2_1", "BT2020_10", "BT2020_12", "SMPTE2084", "SMPTE428", "ARIB_STD_B67" ], "x-enum-elements": [ { "name": "UNSPECIFIED", "description": "" }, { "name": "BT709", "description": "" }, { "name": "GAMMA22", "description": "" }, { "name": "GAMMA28", "description": "" }, { "name": "SMPTE170M", "description": "" }, { "name": "SMPTE240M", "description": "" }, { "name": "LINEAR", "description": "" }, { "name": "LOG", "description": "" }, { "name": "LOG_SQRT", "description": "" }, { "name": "IEC61966_2_4", "description": "" }, { "name": "BT1361_ECG", "description": "" }, { "name": "IEC61966_2_1", "description": "" }, { "name": "BT2020_10", "description": "" }, { "name": "BT2020_12", "description": "" }, { "name": "SMPTE2084", "description": "" }, { "name": "SMPTE428", "description": "" }, { "name": "ARIB_STD_B67", "description": "" } ] }, "ColorTransfer": { "title": "ColorTransfer", "type": "string", "enum": [ "UNSPECIFIED", "BT709", "GAMMA22", "GAMMA28", "SMPTE170M", "SMPTE240M", "LINEAR", "LOG", "LOG_SQRT", "IEC61966_2_4", "BT1361_ECG", "IEC61966_2_1", "BT2020_10", "BT2020_12", "SMPTE2084", "SMPTE428", "ARIB_STD_B67" ], "x-enum-elements": [ { "name": "UNSPECIFIED", "description": "" }, { "name": "BT709", "description": "" }, { "name": "GAMMA22", "description": "" }, { "name": "GAMMA28", "description": "" }, { "name": "SMPTE170M", "description": "" }, { "name": "SMPTE240M", "description": "" }, { "name": "LINEAR", "description": "" }, { "name": "LOG", "description": "" }, { "name": "LOG_SQRT", "description": "" }, { "name": "IEC61966_2_4", "description": "" }, { "name": "BT1361_ECG", "description": "" }, { "name": "IEC61966_2_1", "description": "" }, { "name": "BT2020_10", "description": "" }, { "name": "BT2020_12", "description": "" }, { "name": "SMPTE2084", "description": "" }, { "name": "SMPTE428", "description": "" }, { "name": "ARIB_STD_B67", "description": "" } ] }, "DisplayAspectRatio": { "title": "DisplayAspectRatio", "required": [ "numerator", "denominator" ], "allOf": [ { "properties": { "numerator": { "type": "integer", "format": "int32", "description": "The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.", "minimum": 1, "example": 16 }, "denominator": { "type": "integer", "format": "int32", "description": "The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.", "minimum": 1, "example": 9 } } } ] }, "EncodingMode": { "title": "EncodingMode", "type": "string", "default": "STANDARD", "enum": [ "STANDARD", "SINGLE_PASS", "TWO_PASS", "THREE_PASS", "SMART_PASS" ], "x-enum-elements": [ { "name": "STANDARD", "description": "The standard encoding mode is ONE_PASS for LIVE encodings and TWO_PASS for VOD encodings" }, { "name": "SINGLE_PASS", "description": "Single pass encoding" }, { "name": "TWO_PASS", "description": "Two pass encoding for better quality" }, { "name": "THREE_PASS", "description": "Three pass encoding for best quality (this only works for VoD workflows)" }, { "name": "SMART_PASS", "description": "Smart pass encoding" } ] }, "ForceFlushMode": { "title": "ForceFlushMode", "type": "string", "default": "DISABLED", "description": "Force the encoder to flush frames. Default is DISABLED.", "enum": [ "DISABLED", "ALL_FRAMES", "SLICE_TYPE" ], "x-enum-elements": [ { "name": "DISABLED", "description": "Flush the encoder only when all the input pictures are over" }, { "name": "ALL_FRAMES", "description": "Flush all the frames even when the input is not over" }, { "name": "SLICE_TYPE", "description": "Flush the slicetype decided frames only" } ] }, "AdaptiveQuantMode": { "title": "AdaptiveQuantMode", "type": "string", "default": "VARIANCE", "description": "", "enum": [ "DISABLED", "VARIANCE", "AUTO_VARIANCE", "AUTO_VARIANCE_DARK_SCENES" ], "x-enum-elements": [ { "name": "DISABLED", "description": "Disable adaptive quantization" }, { "name": "VARIANCE", "description": "Redistributes bits within each frame" }, { "name": "AUTO_VARIANCE", "description": "Redistributes bits across the whole video" }, { "name": "AUTO_VARIANCE_DARK_SCENES", "description": "Redistributes bits across the whole video with a bias to dark scenes" } ] }, "H265DynamicRangeFormat": { "title": "H265DynamicRangeFormat", "type": "string", "description": "Configures what kind of dynamic range the output should conform to. Can be used to convert from SDR to HDR, from HDR to SDR or between different HDR formats", "enum": [ "DOLBY_VISION", "DOLBY_VISION_PROFILE_5", "DOLBY_VISION_PROFILE_8_1", "HDR10", "HLG", "SDR" ], "x-enum-elements": [ { "name": "DOLBY_VISION", "description": "Configure the Output to be Dolby Vision Profile 5." }, { "name": "DOLBY_VISION_PROFILE_5", "description": "Configure the Output to be Dolby Vision Profile 5" }, { "name": "DOLBY_VISION_PROFILE_8_1", "description": "Configure the Output to be Dolby Vision Profile 8.1 (HDR10 cross-compatibility)" }, { "name": "HDR10" }, { "name": "HLG" }, { "name": "SDR" } ] }, "H265VideoConfiguration": { "title": "H265VideoConfiguration", "required": [ "profile" ], "allOf": [ { "$ref": "#/components/schemas/VideoConfiguration" }, { "properties": { "presetConfiguration": { "description": "Choose from a set of preset configurations tailored for common use cases. Check out [H265 Presets](https://bitmovin.com/docs/encoding/tutorials/h265-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.", "allOf": [ { "$ref": "#/components/schemas/PresetConfiguration" } ] }, "dynamicRangeFormat": { "description": "Automatically configures the H265 Video Codec to be compatible with the given SDR/HDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results.\nExplicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.", "allOf": [ { "$ref": "#/components/schemas/H265DynamicRangeFormat" } ] }, "crf": { "type": "number", "format": "double", "minimum": 0, "maximum": 51, "description": "Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.", "example": 28 }, "profile": { "description": "", "allOf": [ { "$ref": "#/components/schemas/ProfileH265" } ] }, "bframes": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 16, "default": 4, "description": "Amount of b frames", "example": 3 }, "refFrames": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 16, "default": 4, "description": "Amount of reference frames", "example": 5 }, "qp": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 51, "description": "Quantization factor", "example": 0 }, "maxBitrate": { "type": "integer", "format": "int64", "description": "Maximum Bitrate (bps)", "example": 0 }, "minBitrate": { "type": "integer", "format": "int64", "description": "Minimum Bitrate (bps)", "example": 0 }, "bufsize": { "type": "integer", "format": "int64", "description": "Size of the VBV buffer (bits)", "example": 0 }, "minGop": { "type": "integer", "format": "int32", "description": "Minimum GOP length, the minimum distance between I-frames", "example": 0 }, "maxGop": { "type": "integer", "format": "int32", "description": "Maximum GOP length, the maximum distance between I-frames", "example": 0 }, "openGop": { "type": "boolean", "description": "Enable open-gop, allows referencing frames from a previous gop", "example": false }, "minKeyframeInterval": { "type": "number", "format": "double", "description": "Minimum interval in seconds between key frames", "example": 0 }, "maxKeyframeInterval": { "type": "number", "format": "double", "description": "Maximum interval in seconds between key frames", "example": 0 }, "level": { "description": "", "allOf": [ { "$ref": "#/components/schemas/LevelH265" } ] }, "rcLookahead": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 250, "default": 25, "description": "Number of frames for slice-type decision lookahead", "example": 20 }, "bAdapt": { "description": "Set the level of effort in determining B frame placement", "allOf": [ { "$ref": "#/components/schemas/BAdapt" } ] }, "maxCTUSize": { "description": "", "allOf": [ { "$ref": "#/components/schemas/MaxCtuSize" } ] }, "tuIntraDepth": { "description": "", "allOf": [ { "$ref": "#/components/schemas/TuIntraDepth" } ] }, "tuInterDepth": { "description": "", "allOf": [ { "$ref": "#/components/schemas/TuInterDepth" } ] }, "motionSearch": { "description": "", "allOf": [ { "$ref": "#/components/schemas/MotionSearch" } ] }, "subMe": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 7, "default": 3, "description": "Set the amount of subpel refinement to perform.", "example": 2 }, "motionSearchRange": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 32768, "default": 57, "description": "Set the Motion search range.", "example": 0 }, "weightPredictionOnPSlice": { "type": "boolean", "default": true, "description": "Enable weighted prediction in P slices", "example": true }, "weightPredictionOnBSlice": { "type": "boolean", "default": false, "description": "Enable weighted prediction in B slices", "example": false }, "sao": { "type": "boolean", "default": true, "description": "Toggle sample adaptive offset loop filter", "example": false }, "masterDisplay": { "type": "string", "description": "Set the mastering display color volume SEI info (SMPTE ST 2086). For example `G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1)` describes a P3D65 1000-nits monitor, where G(x=0.265, y=0.690), B(x=0.150, y=0.060), R(x=0.680, y=0.320), WP(x=0.3127, y=0.3290), L(max=1000, min=0.0001). Part of HDR-10 metadata. If used on a Dolby Vision stream, this value must be set to `G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1)`." }, "maxContentLightLevel": { "type": "integer", "format": "int32", "description": "Set the max content light level (MaxCLL). Use together with maxPictureAverageLightLevel (which will be 0 if not set). Part of HDR-10 metadata.", "example": 0 }, "maxPictureAverageLightLevel": { "type": "integer", "format": "int32", "description": "Set the maximum picture average light level (MaxFALL). Use together with maxContentLightLevel (which will be 0 if not set). Part of HDR-10 metadata.", "example": 0 }, "hdr": { "type": "boolean", "description": "Force signaling of HDR parameters in SEI packets. Enabled automatically when masterDisplay or maxContentLightLevel/maxPictureAverageLightLevel are set. Useful when there is a desire to signal 0 values for maxContentLightLevel and maxPictureAverageLightLevel.", "example": false }, "sceneCutThreshold": { "type": "integer", "format": "int32", "minimum": 0, "description": "Scene Change sensitivity. The higher the value, the more likely an I-Frame will be inserted. Set to 0 to disable it.", "example": 0 }, "adaptiveQuantizationMode": { "description": "Controls the adaptive quantization algorithm", "allOf": [ { "$ref": "#/components/schemas/AdaptiveQuantMode" } ] }, "enableHlgSignaling": { "type": "boolean", "description": "Enable SDR compatible HLG signaling. The container and bitstream will indicate BT.2020 but ARIB STD-B67 will be signaled in the alternative transfer characteristics SEI message.", "default": false, "example": false }, "videoFormat": { "description": "Specifies the source format of the original analog video prior to digitizing and encoding", "allOf": [ { "$ref": "#/components/schemas/VideoFormat" } ] }, "psyRateDistortionOptimization": { "type": "number", "format": "double", "minimum": 0, "maximum": 5, "description": "Psycho-visual rate-distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP, RD_REF_ALL, QPRD or FULL_RD", "example": 1 }, "psyRateDistortionOptimizedQuantization": { "type": "number", "format": "double", "minimum": 0, "maximum": 50, "description": "Strength of psycho-visual optimizations in quantization. Only has an effect in presets which use RDOQ (rd-levels 4 and 5). The value must be between 0 and 50, 1.0 is typical", "example": 0 }, "enableHrdSignaling": { "type": "boolean", "description": "Signal hypothetical reference decoder (HRD) information", "example": false }, "cutree": { "type": "boolean", "description": "Enables the use of lookahead’s lowres motion vector fields to determine the amount of reuse of each block to tune adaptive quantization factors.", "example": false }, "minCodingUnitSize": { "description": "Minimum CU size (width and height). By using 16 or 32 the encoder will not analyze the cost of CUs below that minimum threshold, saving considerable amounts of compute with a predictable increase in bitrate. This setting has a large effect on performance on the faster presets.", "allOf": [ { "$ref": "#/components/schemas/MinCodingUnitSize" } ] }, "lookaheadSlices": { "type": "integer", "format": "int32", "description": "Use multiple worker threads to measure the estimated cost of each frame within the lookahead. The higher this parameter, the less accurate the frame costs will be which will result in less accurate B-frame and scene-cut decisions. Valid range: 0 - 16", "example": 4 }, "limitReferences": { "description": "If enabled, limit references per depth, CU or both.", "allOf": [ { "$ref": "#/components/schemas/LimitReferences" } ] }, "rectangularMotionPartitionsAnalysis": { "type": "boolean", "description": "Enable analysis of rectangular motion partitions Nx2N and 2NxN.", "example": true }, "asymetricMotionPartitionsAnalysis": { "type": "boolean", "description": "Enable analysis of asymmetric motion partitions.", "example": false }, "limitModes": { "type": "boolean", "description": "When enabled, will limit modes analyzed for each CU using cost metrics from the 4 sub-CUs. This can significantly improve performance when `rectangularMotionPartitionsAnalysis` and/or `asymetricMotionPartitionsAnalysis` are enabled at minimal compression efficiency loss.", "example": true }, "maxMerge": { "type": "integer", "format": "int32", "description": "Maximum number of neighbor (spatial and temporal) candidate blocks that the encoder may consider for merging motion predictions. Valid range: 1 - 5", "example": 3 }, "earlySkip": { "type": "boolean", "description": "Measure 2Nx2N merge candidates first; if no residual is found, additional modes at that depth are not analysed.", "example": false }, "recursionSkip": { "type": "boolean", "description": "If enabled exits early from CU depth recursion. When a skip CU is found, additional heuristics are used to decide whether to terminate recursion.", "example": true }, "fastSearchForAngularIntraPredictions": { "type": "boolean", "description": "Enable faster search method for angular intra predictions.", "example": false }, "evaluationOfIntraModesInBSlices": { "type": "boolean", "description": "Enables the evaluation of intra modes in B slices.", "example": false }, "signHide": { "type": "boolean", "description": "Hide sign bit of one coefficient per coding tree unit.", "example": true }, "rateDistortionLevelForModeDecision": { "type": "integer", "format": "int32", "description": "Level of rate-distortion optimization in mode decision. The lower the value the faster the encode, the higher the value higher the compression efficiency. Valid range: 0 - 4", "example": 4 }, "rateDistortionLevelForQuantization": { "description": "Specifies the amount of rate-distortion analysis to use within quantization.", "allOf": [ { "$ref": "#/components/schemas/RateDistortionLevelForQuantization" } ] }, "qpMin": { "type": "integer", "format": "int32", "description": "Minimum quantization factor. Valid value range: 0 - 69", "minimum": 0, "maximum": 69, "example": 0 }, "qpMax": { "type": "integer", "format": "int32", "description": "Maximum quantization factor. Valid value range: 0 - 69", "minimum": 0, "maximum": 69, "example": 69 }, "wavefrontParallelProcessing": { "type": "boolean", "description": "The encoder may begin encoding a row as soon as the row above it is at least two CTUs ahead in the encode process. Default is enabled.", "example": true }, "slices": { "type": "integer", "format": "int32", "description": "Encode each incoming frame as multiple parallel slices that may be decoded independently. Default is 1.", "example": 1 }, "copyPicture": { "type": "boolean", "description": "Copy buffers of input picture in frame. Default is enabled.", "example": true }, "levelHighTier": { "type": "boolean", "description": "If high tier is disabled the encoder will attempt to encode only at the main tier. Default is enabled.", "example": true }, "skipSplitRateDistortionAnalysis": { "type": "boolean", "description": "Enable skipping split rate distortion analysis when sum of split CU RD cost larger than one split CU RD cost for intra CU. Default disabled.", "example": false }, "codingUnitLossless": { "type": "boolean", "description": "If enabled, consider lossless mode in CU RDO decisions. Default is disabled.", "example": false }, "transformSkip": { "description": "Enable evaluation of transform skip (bypass DCT but still use quantization) coding for 4x4 TU coded blocks. Default is NONE.", "allOf": [ { "$ref": "#/components/schemas/TransformSkipMode" } ] }, "refineRateDistortionCost": { "type": "boolean", "description": "Enable QP based rate distortion refinement. Default is disabled.", "example": false }, "limitTransformUnitDepthRecursion": { "description": "Enables early exit from transform unit depth recursion, for inter coded blocks. Default is DISABLED.", "allOf": [ { "$ref": "#/components/schemas/LimitTransformUnitDepthRecursionMode" } ] }, "noiseReductionIntra": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2000, "description": "An integer value, which denotes strength of noise reduction in intra CUs. Default 0.", "example": 0 }, "noiseReductionInter": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2000, "description": "An integer value, which denotes strength of noise reduction in inter CUs. Default 0.", "example": 0 }, "rateDistortionPenalty": { "description": "Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.", "allOf": [ { "$ref": "#/components/schemas/RateDistortionPenaltyMode" } ] }, "maximumTransformUnitSize": { "description": "Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.", "allOf": [ { "$ref": "#/components/schemas/MaxTransformUnitSize" } ] }, "dynamicRateDistortionStrength": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 4, "description": "Increases the RD level at points where quality drops due to VBV rate control enforcement. Default 0.", "example": 0 }, "ssimRateDistortionOptimization": { "type": "boolean", "description": "It is used for mode selection during analysis of CTUs and can achieve significant gain in terms of objective quality metrics SSIM and PSNR. Default false.", "example": false }, "temporalMotionVectorPredictors": { "type": "boolean", "description": "Enable temporal motion vector predictors in P and B slices. Default true.", "example": true }, "analyzeSourceFramePixels": { "type": "boolean", "description": "Enable motion estimation with source frame pixels, in this mode, motion estimation can be computed independently. Default false.", "example": false }, "strongIntraSmoothing": { "type": "boolean", "description": "Enable strong intra smoothing for 32x32 intra blocks. Default true.", "example": true }, "constrainedIntraPrediction": { "type": "boolean", "description": "When generating intra predictions for blocks in inter slices, only intra-coded reference pixels are used. Default false.", "example": false }, "scenecutBias": { "type": "number", "format": "double", "minimum": 0, "maximum": 100, "description": "This value represents the percentage difference between the inter cost and intra cost of a frame used in scenecut detection. Default 5.0.", "example": 5 }, "allowedRADLBeforeIDR": { "type": "integer", "format": "int32", "description": "Number of RADL pictures allowed infront of IDR. Requires fixed keyframe interval. Valid values 0 - `bframes`. Default 0.", "example": 0 }, "gopLookahead": { "type": "integer", "format": "int32", "description": "Number of frames for GOP boundary decision lookahead. Valid values 0 - `rcLookahead`. Default 0", "example": 0 }, "bframeBias": { "type": "integer", "format": "int32", "minimum": -90, "maximum": 100, "description": "Bias towards B frames in slicetype decision. The higher the bias the more likely the encoder is to use B frames. Default 0", "example": 0 }, "forceFlush": { "description": "Force the encoder to flush frames. Default is DISABLED.", "allOf": [ { "$ref": "#/components/schemas/ForceFlushMode" } ] }, "adaptiveQuantizationStrength": { "type": "number", "format": "double", "minimum": 0, "maximum": 3, "description": "Adjust the strength of the adaptive quantization offsets. Default 1.0.", "example": 1 }, "adaptiveQuantizationMotion": { "type": "boolean", "description": "Adjust the AQ offsets based on the relative motion of each block with respect to the motion of the frame. Default false.", "example": false }, "quantizationGroupSize": { "description": "Enable adaptive quantization for sub-CTUs. This parameter specifies the minimum CU size at which QP can be adjusted. Default is same as `maxCTUSize`.", "allOf": [ { "$ref": "#/components/schemas/QuantizationGroupSize" } ] }, "strictCbr": { "type": "boolean", "description": "Enables stricter conditions to control bitrate deviance from the target bitrate in ABR mode. Bit rate adherence is prioritised over quality. Default false.", "example": false }, "qpOffsetChromaCb": { "type": "integer", "format": "int32", "minimum": -12, "maximum": 12, "description": "Offset of Cb chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0", "example": 0 }, "qpOffsetChromaCr": { "type": "integer", "format": "int32", "minimum": -12, "maximum": 12, "description": "Offset of Cr chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0", "example": 0 }, "ipRatio": { "type": "number", "format": "double", "description": "QP ratio factor between I and P slices. This ratio is used in all of the rate control modes. Default 1.4", "example": 1.4 }, "pbRatio": { "type": "number", "format": "double", "description": "QP ratio factor between P and B slices. This ratio is used in all of the rate control modes. Default 1.3", "example": 1.3 }, "quantizerCurveCompressionFactor": { "type": "number", "format": "double", "minimum": 0.5, "maximum": 1, "description": "Quantizer curve compression factor. It weights the frame quantizer based on the complexity of residual (measured by lookahead). Default 0.6", "example": 0.6 }, "qpStep": { "type": "integer", "format": "int32", "description": "The maximum single adjustment in QP allowed to rate control. Default 4", "example": 4 }, "grainOptimizedRateControl": { "type": "boolean", "description": "Enables a specialised ratecontrol algorithm for film grain content. Default false.", "example": false }, "blurQuants": { "type": "number", "format": "double", "description": "Temporally blur quants. Default 0.5", "example": 0.5 }, "blurComplexity": { "type": "number", "format": "double", "description": "Temporally blur complexity. Default 20.0", "example": 20 }, "saoNonDeblock": { "type": "boolean", "description": "Specify how to handle depencency between SAO and deblocking filter. When enabled, non-deblocked pixels are used for SAO analysis. When disabled, SAO analysis skips the right/bottom boundary areas. Default false.", "example": false }, "limitSao": { "type": "boolean", "description": "Limit SAO filter computation by early terminating SAO process based on inter prediction mode, CTU spatial-domain correlations, and relations between luma and chroma. Default false.", "example": false }, "lowpassDct": { "type": "boolean", "description": "Will use low-pass subband dct approximation instead of the standard dct for 16x16 and 32x32 blocks. Default false.", "example": false }, "cea608708SubtitleConfig": { "description": "Defines whether CEA 608/708 subtitles are extracted from the input video stream", "allOf": [ { "$ref": "#/components/schemas/Cea608708SubtitleConfiguration" } ] }, "autoLevelSetup": { "description": "Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.", "allOf": [ { "$ref": "#/components/schemas/AutoLevelSetup" } ] } } } ] }, "LevelH265": { "title": "LevelH265", "type": "string", "description": "Specified set of constraints that indicate a degree of required decoder performance for a profile, see: https://en.wikipedia.org/wiki/High_Efficiency_Video_Coding_tiers_and_levels", "enum": [ "1", "2", "2.1", "3", "3.1", "4", "4.1", "5", "5.1", "5.2", "6", "6.1", "6.2" ], "x-enum-elements": [ { "name": "L1", "description": "" }, { "name": "L2", "description": "" }, { "name": "L2_1", "description": "" }, { "name": "L3", "description": "" }, { "name": "L3_1", "description": "" }, { "name": "L4", "description": "" }, { "name": "L4_1", "description": "" }, { "name": "L5", "description": "" }, { "name": "L5_1", "description": "" }, { "name": "L5_2", "description": "" }, { "name": "L6", "description": "" }, { "name": "L6_1", "description": "" }, { "name": "L6_2", "description": "" } ] }, "LimitTransformUnitDepthRecursionMode": { "title": "LimitTransformUnitDepthRecursionMode", "type": "string", "default": "DISABLED", "description": "Enables early exit from transform unit depth recursion, for inter coded blocks.", "enum": [ "DISABLED", "LEVEL_1", "LEVEL_2", "LEVEL_3", "LEVEL_4" ], "x-enum-elements": [ { "name": "DISABLED", "description": "Disable early exit from transform unit dept recursion" }, { "name": "LEVEL_1", "description": "Decides to recurse to next higher depth based on cost comparison of full size transform unit and split transform unit." }, { "name": "LEVEL_2", "description": "Based on first split sub TUs depth, limits recursion of other split sub TUs." }, { "name": "LEVEL_3", "description": "Based on the average depth of the co-located and the neighbor CUs TU depth, limits recursion of the current CU." }, { "name": "LEVEL_4", "description": "Uses the depth of the co-located CUs TU depth to limit the 1st sub TU depth. The 1st sub TU depth is taken as the limiting depth for the other sub TUs." } ] }, "Link": { "title": "Link", "required": [ "href" ], "properties": { "href": { "type": "string", "description": "webpage target URL", "example": "https://bitmovin.com/encoding-documentation/bitmovin-api/#/reference/encoding/manifests/add-period" }, "title": { "type": "string", "description": "Short description of the linked page", "example": "how to add a period to a manifest" } } }, "LimitReferences": { "title": "LimitReferences", "type": "string", "default": "DEPTH_AND_CU", "description": "", "enum": [ "DISABLED", "DEPTH", "CU", "DEPTH_AND_CU" ], "x-enum-elements": [ { "name": "DISABLED", "description": "Disables limiting references" }, { "name": "DEPTH", "description": "Will limit the references analyzed at the current depth based on the references used to code the 4 sub-blocks at the next depth." }, { "name": "CU", "description": "The rectangular and asymmetrical partitions will only use references selected by the 2Nx2N motion search." }, { "name": "DEPTH_AND_CU", "description": "The 2Nx2N motion search at each depth will only use references from the split CUs and the rect/amp motion searches at that depth will only use the reference(s) selected by 2Nx2N." } ] }, "MaxTransformUnitSize": { "title": "MaxTransformUnitSize", "type": "string", "default": "MTU_32x32", "description": "", "enum": [ "MTU_4x4", "MTU_8x8", "MTU_16x16", "MTU_32x32" ], "x-enum-elements": [ { "name": "MTU_4x4", "description": "maximum 4x4 TU" }, { "name": "MTU_8x8", "description": "maximum 8x8 TU" }, { "name": "MTU_16x16", "description": "maximum 16x16 TU" }, { "name": "MTU_32x32", "description": "maximum 32x32 TU" } ] }, "MinCodingUnitSize": { "title": "MinCodingUnitSize", "type": "string", "default": "MCU_8x8", "enum": [ "MCU_8x8", "MCU_16x16", "MCU_32x32" ], "x-enum-elements": [ { "name": "MCU_8x8", "description": "minimum 8x8 CU" }, { "name": "MCU_16x16", "description": "minimum 16x16 CU" }, { "name": "MCU_32x32", "description": "minimum 32x32 CU" } ] }, "MaxCtuSize": { "title": "MaxCtuSize", "type": "string", "default": "64", "description": "Set the maximal CTU (Coding Tree Unit) size", "enum": [ "16", "32", "64" ], "x-enum-elements": [ { "name": "S16", "description": "" }, { "name": "S32", "description": "" }, { "name": "S64", "description": "" } ] }, "Message": { "title": "Message", "required": [ "type", "text" ], "allOf": [ { "$ref": "#/components/schemas/BitmovinResponse" }, { "properties": { "type": { "description": "Message type giving a hint on the importance of the message (log level)", "allOf": [ { "$ref": "#/components/schemas/MessageType" } ] }, "text": { "type": "string", "description": "Message text", "example": "field must not be empty" }, "field": { "type": "string", "description": "Name of the field to which the message is referring to", "example": "manifestId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" }, "description": "collection of links to webpages containing further information on the topic" }, "more": { "type": "object", "description": "Service-specific information" }, "date": { "type": "string", "format": "date-time", "description": "Timestamp when the message occurred", "example": "2016-06-25T20:09:23.69Z" } } } ] }, "MessageType": { "title": "MessageType", "type": "string", "enum": [ "ERROR", "WARNING", "INFO", "DEBUG", "TRACE" ] }, "MotionSearch": { "title": "MotionSearch", "type": "string", "default": "HEX", "description": "Set the Motion search method", "enum": [ "DIA", "HEX", "UMH", "STAR", "FULL" ], "x-enum-elements": [ { "name": "DIA", "description": "" }, { "name": "HEX", "description": "" }, { "name": "UMH", "description": "" }, { "name": "STAR", "description": "" }, { "name": "FULL", "description": "" } ] }, "PassthroughMode": { "title": "PassthroughMode", "type": "string", "default": "VIDEO_STREAM", "description": "Configure if the encoding should use the video stream as the passthrough mode or a dedicated caption stream.", "enum": [ "VIDEO_STREAM", "CAPTION_STREAM", "VIDEO_CAPTION_STREAM" ], "x-enum-elements": [ { "name": "VIDEO_STREAM", "description": "Select the embedded captions from the video stream" }, { "name": "CAPTION_STREAM", "description": "Select the captions from a separate caption stream" }, { "name": "VIDEO_CAPTION_STREAM", "description": "Select the captions from the video stream or from the caption stream. Don't use this option if the input file contains both caption variants." } ] }, "PixelFormat": { "title": "PixelFormat", "type": "string", "default": "YUV420P", "description": "The pixel format to be set", "enum": [ "YUV410P", "YUV411P", "YUV420P", "YUV422P", "YUV440P", "YUV444P", "YUVJ411P", "YUVJ420P", "YUVJ422P", "YUVJ440P", "YUVJ444P", "YUV420P10LE", "YUV422P10LE", "YUV440P10LE", "YUV444P10LE", "YUV420P12LE", "YUV422P12LE", "YUV440P12LE", "YUV444P12LE", "YUV420P10BE", "YUV422P10BE", "YUV440P10BE", "YUV444P10BE", "YUV420P12BE", "YUV422P12BE", "YUV440P12BE", "YUV444P12BE" ], "x-enum-elements": [ { "name": "YUV410P", "description": "" }, { "name": "YUV411P", "description": "" }, { "name": "YUV420P", "description": "" }, { "name": "YUV422P", "description": "" }, { "name": "YUV440P", "description": "" }, { "name": "YUV444P", "description": "" }, { "name": "YUVJ411P", "description": "" }, { "name": "YUVJ420P", "description": "" }, { "name": "YUVJ422P", "description": "" }, { "name": "YUVJ440P", "description": "" }, { "name": "YUVJ444P", "description": "" }, { "name": "YUV420P10LE", "description": "" }, { "name": "YUV422P10LE", "description": "" }, { "name": "YUV440P10LE", "description": "" }, { "name": "YUV444P10LE", "description": "" }, { "name": "YUV420P12LE", "description": "" }, { "name": "YUV422P12LE", "description": "" }, { "name": "YUV440P12LE", "description": "" }, { "name": "YUV444P12LE", "description": "" }, { "name": "YUV420P10BE", "description": "" }, { "name": "YUV422P10BE", "description": "" }, { "name": "YUV440P10BE", "description": "" }, { "name": "YUV444P10BE", "description": "" }, { "name": "YUV420P12BE", "description": "" }, { "name": "YUV422P12BE", "description": "" }, { "name": "YUV440P12BE", "description": "" }, { "name": "YUV444P12BE", "description": "" } ] }, "PresetConfiguration": { "title": "PresetConfiguration", "type": "string", "default": "", "description": "", "enum": [ "LIVE_ULTRAHIGH_QUALITY", "LIVE_VERYHIGH_QUALITY", "LIVE_HIGH_QUALITY", "LIVE_STANDARD", "LIVE_LOW_LATENCY", "LIVE_LOWER_LATENCY", "LIVE_VERYLOW_LATENCY", "VOD_HIGH_QUALITY", "VOD_QUALITY", "VOD_STANDARD", "VOD_SPEED", "VOD_HIGH_SPEED", "VOD_VERYHIGH_SPEED", "VOD_EXTRAHIGH_SPEED", "VOD_SUPERHIGH_SPEED", "VOD_ULTRAHIGH_SPEED", "VOD_HARDWARE_SHORTFORM" ], "x-enum-elements": [ { "name": "LIVE_ULTRAHIGH_QUALITY", "description": "supported for H264" }, { "name": "LIVE_VERYHIGH_QUALITY", "description": "supported for H264" }, { "name": "LIVE_HIGH_QUALITY", "description": "supported for H264, H265" }, { "name": "LIVE_STANDARD", "description": "supported for H264, H265" }, { "name": "LIVE_LOW_LATENCY", "description": "supported for H264, H265" }, { "name": "LIVE_LOWER_LATENCY", "description": "supported for H264" }, { "name": "LIVE_VERYLOW_LATENCY", "description": "supported for H264" }, { "name": "VOD_HIGH_QUALITY", "description": "supported for H264, H265, VP9" }, { "name": "VOD_QUALITY", "description": "supported for H264" }, { "name": "VOD_STANDARD", "description": "supported for H264, H265, VP9" }, { "name": "VOD_SPEED", "description": "supported for H264, H265, VP9" }, { "name": "VOD_HIGH_SPEED", "description": "supported for H264, H265" }, { "name": "VOD_VERYHIGH_SPEED", "description": "supported for H264, H265" }, { "name": "VOD_EXTRAHIGH_SPEED", "description": "supported for H264, H265" }, { "name": "VOD_SUPERHIGH_SPEED", "description": "supported for H264, H265" }, { "name": "VOD_ULTRAHIGH_SPEED", "description": "supported for H264, H265" }, { "name": "VOD_HARDWARE_SHORTFORM", "description": "supported for H264, H265" } ] }, "ProfileH265": { "title": "ProfileH265", "type": "string", "enum": [ "main", "main10" ], "x-enum-elements": [ { "name": "MAIN", "description": "Main profile" }, { "name": "MAIN10", "description": "Main 10 profile" } ] }, "QuantizationGroupSize": { "title": "QuantizationGroupSize", "type": "string", "description": "Enable adaptive quantization for sub-CTUs. This parameter specifies the minimum CU size at which QP can be adjusted.", "enum": [ "QGS_8x8", "QGS_16x16", "QGS_32x32", "QGS_64x64" ], "x-enum-elements": [ { "name": "QGS_8x8", "description": "8x8" }, { "name": "QGS_16x16", "description": "16x16" }, { "name": "QGS_32x32", "description": "32x32" }, { "name": "QGS_64x64", "description": "64x64" } ] }, "RateDistortionLevelForQuantization": { "title": "RateDistortionLevelForQuantization", "type": "string", "default": "LEVELS_AND_CODING_GROUPS", "description": "", "enum": [ "DISABLED", "LEVELS", "LEVELS_AND_CODING_GROUPS" ], "x-enum-elements": [ { "name": "DISABLED", "description": "Rate-distortion cost is not considered in quantization." }, { "name": "LEVELS", "description": "Rate-distortion cost is used to find optimal rounding values for each level." }, { "name": "LEVELS_AND_CODING_GROUPS", "description": "Rate-distortion cost is used to make decimate decisions on each 4x4 coding group." } ] }, "RateDistortionPenaltyMode": { "title": "RateDistortionPenaltyMode", "type": "string", "default": "DISABLED", "description": "Penalty for 32x32 intra transfer units in non-I slices.", "enum": [ "DISABLED", "NORMAL", "MAXIMUM" ], "x-enum-elements": [ { "name": "DISABLED", "description": "Rate distortion penalty disabled." }, { "name": "NORMAL", "description": "Transform units of size 32x32 are given a 4x bit cost penalty compared to smaller transform units, in intra coded CUs in P or B slices." }, { "name": "MAXIMUM", "description": "Transform units of size 32x32 are not even attempted, unless otherwise required by the maximum recursion depth." } ] }, "ResponseEnvelope": { "title": "ResponseEnvelope", "required": [ "requestId", "status", "data" ], "properties": { "requestId": { "type": "string", "readOnly": true, "description": "Unique correlation id", "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333" }, "status": { "description": "Response status information", "readOnly": true, "example": "SUCCESS", "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ] }, "data": { "description": "Response information", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ResultWrapper" } ] }, "more": { "type": "object", "description": "Additional endpoint specific information" } } }, "ResponseError": { "title": "ResponseError", "required": [ "requestId", "status", "data" ], "properties": { "requestId": { "type": "string", "readOnly": true, "description": "Unique correlation id", "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333" }, "status": { "description": "Response status information", "readOnly": true, "example": "ERROR", "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ] }, "data": { "description": "Response information", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ResponseErrorData" } ] } } }, "ResponseErrorData": { "title": "ResponseErrorData", "required": [ "code", "message", "developerMessage" ], "properties": { "code": { "type": "integer", "format": "int32", "readOnly": true, "description": "Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes\n", "example": 1005 }, "message": { "type": "string", "readOnly": true, "description": "General error message" }, "developerMessage": { "type": "string", "readOnly": true, "description": "More detailed message meant for developers" }, "links": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Link" }, "description": "collection of links to webpages containing further information on the topic" }, "details": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Message" }, "description": "collection of messages containing more detailed information on the cause of the error" } } }, "ResponseStatus": { "title": "ResponseStatus", "type": "string", "enum": [ "SUCCESS", "ERROR" ] }, "ResultWrapper": { "title": "ResultWrapper", "properties": { "result": { "type": "object", "readOnly": true } } }, "TransformSkipMode": { "title": "TransformSkipMode", "type": "string", "default": "NONE", "description": "Enable evaluation of transform skip (bypass DCT but still use quantization) coding for 4x4 TU coded blocks.", "enum": [ "NONE", "NORMAL", "FAST" ], "x-enum-elements": [ { "name": "NONE", "description": "No transform skip enabled" }, { "name": "NORMAL", "description": "Enable normal evaluation of transform skip" }, { "name": "FAST", "description": "Only evaluate transform skip for NxN intra predictions (4x4 blocks)." } ] }, "TuInterDepth": { "title": "TuInterDepth", "type": "string", "default": "D1", "description": "Extra recursion depth for intra coded units", "enum": [ "1", "2", "3", "4" ], "x-enum-elements": [ { "name": "D1", "description": "" }, { "name": "D2", "description": "" }, { "name": "D3", "description": "" }, { "name": "D4", "description": "" } ] }, "TuIntraDepth": { "title": "TuIntraDepth", "type": "string", "default": "D1", "description": "Extra recursion depth for inter coded units", "enum": [ "1", "2", "3", "4" ], "x-enum-elements": [ { "name": "D1", "description": "" }, { "name": "D2", "description": "" }, { "name": "D3", "description": "" }, { "name": "D4", "description": "" } ] }, "VideoConfiguration": { "title": "VideoConfiguration", "allOf": [ { "$ref": "#/components/schemas/CodecConfiguration" }, { "properties": { "width": { "type": "integer", "format": "int32", "description": "Width of the encoded video in pixels", "example": 1920 }, "height": { "type": "integer", "format": "int32", "description": "Height of the encoded video in pixels", "example": 1080 }, "bitrate": { "type": "integer", "format": "int64", "description": "Target bitrate for the encoded video in bps. Either bitrate or crf is required.", "example": 10000000 }, "rate": { "type": "number", "format": "double", "description": "Target frame rate of the encoded video. Must be set for live encodings", "example": 24 }, "pixelFormat": { "description": "Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.", "allOf": [ { "$ref": "#/components/schemas/PixelFormat" } ] }, "colorConfig": { "description": "", "allOf": [ { "$ref": "#/components/schemas/ColorConfig" } ] }, "sampleAspectRatioNumerator": { "type": "integer", "format": "int32", "description": "The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed." }, "sampleAspectRatioDenominator": { "type": "integer", "format": "int32", "description": "The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed." }, "displayAspectRatio": { "description": "Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.", "allOf": [ { "$ref": "#/components/schemas/DisplayAspectRatio" } ] }, "encodingMode": { "description": "The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.", "allOf": [ { "$ref": "#/components/schemas/EncodingMode" } ] } } } ] }, "VideoFormat": { "title": "VideoFormat", "type": "string", "default": "UNDEFINED", "description": "", "enum": [ "UNDEFINED", "COMPONENT", "PAL", "NTSC", "SECAM", "MAC" ], "x-enum-elements": [ { "name": "UNDEFINED", "description": "" }, { "name": "COMPONENT", "description": "" }, { "name": "PAL", "description": "" }, { "name": "NTSC", "description": "" }, { "name": "SECAM", "description": "" }, { "name": "MAC", "description": "" } ] } } }, "tags": [ { "name": "H265 Configuration" } ] } ```