Presets
GET Presets#
Get all Presets
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/presets |
| Headers | Authorization |
| Parameters | version, projectId, pageIndex, pageSize, type, search, outputGroupType |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| PageIndex | No | integer($int32) | 1 | Enter the page index, from which page you want to see presets |
| PageSize | No | integer($int32) | 10 | Enter how many pages you want to list from page index you selected |
| Type | No | integer($int32) | 0 | Shows the type of preset |
| Search | No | string | "string" | Shows the substring that must match the preset name |
| OutputGroupType | No | integer($int32) | 0 | Shows the output category of the preset |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "id": 0, "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "presetType": "string", "name": "string", "description": "string", "category": "string" } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the requested presets | |
| id | integer($int32) | 0 | Returns the id of the preset |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the preset |
| presetType | string | "string" | Returns the type of preset. For example it returns Custom or System preset |
| name | string | "string" | Returns the display name of the preset |
| description | string | "string" | Returns the description of the preset |
| category | string | "string" | Returns the category of the preset |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
POST Preset#
Create a new Preset.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/presets |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | {name, description, category, container{type}, videoDescription{codecType, width, height, rateControlMode, qualityTuningLevel, bitrate, maxBitrate, framerateControl, framerateDenominator, framerateNumerator, framerateConversionAlgorithm, parNumerator, parDenominator, gopSize, gopSizeUnit, numberBFramesBetweenReferenceFrames, codecProfile, codecLevel, colorMetadata, deinterlace, presetOption, fragmentationType}, audioDescription{codecType, audioDescriptionBroadcasterMix, bitrate, rateControlMode, codecProfile, codingMode, rawFormat, sampleRate, specification}} |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Version | Yes | integer($int32) | v1 | Shows the version of API |
Request body#
{ "name": "string", "description": "string", "category": "string", "container": { "type": 0 }, "videoDescription": { "codecType": 0, "width": 0, "height": 0, "rateControlMode": 0, "qualityTuningLevel": 0, "bitrate": 0, "maxBitrate": 0, "framerateControl": "string", "framerateDenominator": 0, "framerateNumerator": 0, "framerateConversionAlgorithm": "string", "parNumerator": 0, "parDenominator": 0, "gopSize": 0, "gopSizeUnit": 0, "numberBFramesBetweenReferenceFrames": 0, "codecProfile": 0, "codecLevel": "string", "colorMetadata": 0, "deinterlace": true, "presetOption": 0, "fragmentationType": 0 }, "audioDescription": { "codecType": 0, "audioDescriptionBroadcasterMix": 0, "bitrate": 0, "rateControlMode": 0, "codecProfile": 0, "codingMode": 0, "rawFormat": 0, "sampleRate": 0, "specification": 0 }}
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| name | Yes | string | "string" | It specifies the name for the preset to be created |
| description | No | string | "string" | It specifies the description for the preset to be created |
| category | No | string | "string" | It specifies the category for the preset to be created |
| container | Yes | object | It specifies the container properties for the preset to be created | |
| type | Yes | integer($int32) | 0 | It specifies the container type for the preset to be created |
| videoDescription | Yes | object | It specifies the video description properties for the preset to be created | |
| codecType | Yes | integer($int32) | 0 | It specifies the video codec type for the preset to be created |
| width | Yes | integer($int32) | 0 | It specifies the video width for the preset to be created |
| height | Yes | integer($int32) | 0 | It specifies the video height for the preset to be created |
| qualityTuningLevel | Yes | integer($int32) | 0 | It specifies the video quality tuning level for the preset to be created |
| bitrate | Yes | integer($int32) | 0 | It specifies the video bitrate for the preset to be created |
| maxBitrate | Yes | integer($int32) | 0 | It specifies the video maximum bitrate for the preset to be created |
| framerateControl | Yes | string | "string" | It specifies the video framerate control for the preset to be created |
| framerateDenominator | No | integer($int32) | 0 | It specifies the video framerate denominator for the custom preset to be created |
| framerateNumerator | No | integer($int32) | 0 | It specifies the video framerate numerator for the custom preset to be created |
| framerateConversionAlgorithm | Yes | string | "string" | It specifies the video framerate conversion algorithm for the preset to be created |
| parNumerator | No | integer($int32) | 0 | It specifies the video pixel aspect ration numerator for the custom preset to be created |
| parDenominator | No | integer($int32) | 0 | It specifies the video pixel aspect ration denominator for the custom preset to be created |
| gopSize | Yes | integer($int32) | 0 | It specifies the video GOP size for the preset to be created |
| gopSizeUnit | Yes | integer($int32) | 0 | It specifies th video GOP size unit for the preset to be created |
| numberBFramesBetweenReferenceFrames | Yes | integer($int32) | 0 | It specifies the video number of b-frames between reference frames for the preset to be created |
| codecProfile | Yes | integer($int32) | 0 | It specifies the video codec profile for the preset to be created |
| codecLevel | Yes | string | "string" | It specifies the video codec level for the preset to be created |
| colorMetadata | Yes | integer($int32) | 0 | It specifies the video color metadata for the preset to be created |
| deinterlace | Yes | bool | false | It specifies whether the video deinterlace algorithm is enabled for the preset to be created |
| presetOption | Yes | integer($int32) | 0 | It specifies the video preset option for the preset to be created |
| fragmentationType | Yes | integer($int32) | 0 | It specifies the video fragmentation type for the preset to be created |
| audioDescription | Yes | object | 0 | It specifies the audio description properties for the preset to be created |
| codecType | Yes | integer($int32) | 0 | It specifies the audio codec type for the preset to be created |
| audioDescriptionBroadcasterMix | Yes | integer($int32) | 0 | It specifies the audio description broadcaster mix for the preset to be created |
| bitrate | Yes | integer($int32) | 0 | It specifies the audio bitrate for the preset to be created |
| rateControlMode | Yes | integer($int32) | 0 | It specifies the audio rate control mode for the preset to be created |
| codecProfile | Yes | integer($int32) | 0 | It specifies the audio codec profile for the preset to be created |
| codingMode | Yes | integer($int32) | 0 | It specifies the audio coding mode for the preset to be created |
| rawFormat | Yes | integer($int32) | 0 | It specifies the audio coding mode for the preset to be created |
| sampleRate | Yes | integer($int32) | 0 | It specifies the audio sample rate for the preset to be created |
| specification | Yes | integer($int32) | 0 | It specifies the audio specification for the preset to be created |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
"success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "insertDate": "2022-04-17T12:43:21.411Z", "updateDate": "2022-04-17T12:43:21.411Z", "insertedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "updatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "presetType": 0, "presetTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "name": "string", "description": "string", "category": "string", "container": { "type": 0, "containerOptions": [ { "id": 0, "value": "string", "enabled": true } ] }, "videoDescription": { "name": "string", "codecType": 0, "codecTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "width": 0, "height": 0, "rateControlMode": 0, "rateControlModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "qualityTuningLevel": 0, "qualityTuningLevelOptions": [ { "id": 0, "value": "string", "enabled": true } ], "bitrate": 0, "maxBitrate": 0, "framerateControl": "string", "framerateDenominator": 0, "framerateNumerator": 0, "framerateConversionAlgorithm": "string", "interlaceMode": "string", "fieldEncoding": "string", "scanTypeConversionMode": "string", "videoFrameRateOptions": [ [ "string" ] ], "parNumerator": 0, "parDenominator": 0, "videoPixelRatioOptions": [ [ "string" ] ], "gopSize": 0, "gopSizeUnit": 0, "gopSizeUnitOptions": [ { "id": 0, "value": "string", "enabled": true } ], "numberBFramesBetweenReferenceFrames": 0, "gopClosedCadence": 0, "numberReferenceFrames": 0, "dynamicSubGop": "string", "repeatPps": "string", "gopBReference": "string", "sceneChangeDetection": "string", "minInterval": 0, "codecProfile": 0, "codecProfileOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codecLevel": "string", "codecLevelOptions": [ "string" ], "colorMetadata": 0, "colorMetadataOptions": [ { "id": 0, "value": "string", "enabled": true } ], "slices": 0, "entropyEncoding": "string", "adaptiveQuantization": "string", "deinterlace": true, "timecodeInsertion": true, "sharpness": "string", "presetOption": 0, "presetOptions": [ { "id": 0, "value": "string", "enabled": true } ], "fragmentationType": 0, "fragmentationTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ] }, "audioDescription": { "audioTypeControl": "string", "codecType": 0, "codecTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "audioDescriptionBroadcasterMix": 0, "audioDescriptionBroadcasterMixOptions": [ { "id": 0, "value": "string", "enabled": true } ], "bitrate": 0, "audioSampleBitrateOptions": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "rateControlMode": 0, "rateControlModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codecProfile": 0, "codecProfileOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codingMode": 0, "codingModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "rawFormat": 0, "rawFormatOptions": [ { "id": 0, "value": "string", "enabled": true } ], "sampleRate": 0, "specification": 0, "specificationOptions": [ { "id": 0, "value": "string", "enabled": true } ], "languageCodeControl": "string" } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the created preset | |
| id | integer($int32) | 0 | Returns the id of the created preset |
| insertDate | DateTime | "2022-04-17T12:43:21.411Z" | Returns the insertion date of the created preset |
| updateDate | DateTime | "2022-04-17T12:43:21.411Z" | Returns the latest updated date of the created preset |
| insertedBy | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the person who inserted the preset |
| updatedBy | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the person who updated the preset |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the created preset |
| presetType | integer($int32) | 0 | Returns the id of the preset type of the created preset |
| presetTypeOptions | array[object] | Returns the list of options for preset types | |
| id | integer($int32) | 0 | Returns the id of the selected preset type |
| value | string | "string" | Returns the value of the selected preset type |
| enabled | bool | false | Returns whether the selected preset type is enabled |
| name | string | "string" | Returns the name of the created preset |
| description | string | "string" | Returns the description of the created preset |
| category | string | "string" | Returns the category of the created preset |
| container | object | Returns the container properties of the created preset | |
| type | integer($int32) | 0 | Returns the selected container id of the created preset |
| containerOptions | array[object] | Returns the list of options of containers | |
| id | integer($int32) | 0 | Returns the id of the selected container |
| value | string | "string" | Returns the value of the selected container |
| enabled | bool | false | Returns whether the selected container is enabled |
| videoDescription | object | Returns the video description for the created preset | |
| name | string | "string" | Returns the name for the created preset |
| codecType | integer($int32) | 0 | Returns the video codec type for the created preset |
| codecTypeOptions | array[object] | Returns the list of options for codec types | |
| id | integer($int32) | 0 | Returns the id of the codec option |
| value | string | "string" | Returns the value of the codec option |
| enabled | bool | false | Returns whether the codec option is enabled |
| width | integer($int32) | 0 | Returns the video width |
| height | integer($int32) | 0 | Returns the video height |
| rateControlMode | integer($int32) | 0 | Returns the id of the selected video rate control mode for the created preset |
| rateControlModeOptions | array[object] | Returns the list of options for rate control mode | |
| id | integer($int32) | 0 | Returns the id of the rate control mode option |
| value | string | "string" | Returns the value of the rate control mode option |
| enabled | bool | false | Returns whether the rate control mode option is enabled |
| qualityTuningLevel | integer($int32) | 0 | Returns the id of the selected quality tuning level for the created preset |
| qualityTuningLevelOptions | array[object] | Returns the list of options for quality tuning level | |
| id | integer($int32) | 0 | Returns the id of the quality tuning level option |
| value | string | "string" | Returns the value of the quality tuning level option |
| enabled | bool | false | Returns whether the quality tuning level option is enabled |
| bitrate | integer($int32) | 0 | Returns the bitrate for the created preset |
| maxBitrate | integer($int32) | 0 | Returns the maximum bitrate for the created preset |
| framerateControl | string | "string" | Returns the framerate control for the created preset |
| framerateDenominator | integer($int32) | 0 | Returns the framerate denominator for custom framerate |
| framerateNumerator | integer($int32) | 0 | Returns the framerate numerator for custom framerate |
| framerateConversionAlgorithm | string | "string" | Returns the framerate conversion algorithmn for the created preset |
| interlaceMode | string | "string" | Returns the interlaces mode for the created preset |
| fieldEncoding | string | "string" | Returns the field encoding for the created preset |
| scanTypeConversionMode | string | "string" | Returns the scan type conversion mode for the created preset |
| videoFrameRateOptions | array[string[]] | {"string", "string"},{"string", "string"} | Returns the list of video frame rate options for the created preset |
| parNumerator | integer($int32) | 0 | Returns the numerator for custom pixel aspect ratio |
| parDenominator | integer($int32) | 0 | Returns the denominator for custom pixel aspect ratio |
| videoPixelRatioOptions | array[string[]] | {"string", "string"},{"string", "string"} | Returns the list of video pixel ratio options for the created preset |
| gopSize | integer($int32) | 0 | Returns the GOP size for the created preset |
| gopSizeUnit | integer($int32) | 0 | Returns the GOP unit size for the created preset |
| gopSizeUnitOptions | array[object] | Returns the list of options for GOP size unit | |
| id | integer($int32) | 0 | Returns the id of the GOP size unit option |
| value | string | "string" | Returns the value of the GOP size unit option |
| enabled | bool | false | Returns whether the GOP size unit option is enabled |
| numberBFramesBetweenReferenceFrames | integer($int32) | 0 | Returns the number of b-frames between reference frames for the created preset |
| gopClosedCadence | integer($int32) | 0 | Returns GOP closed cadence for the created preset |
| numberReferenceFrames | integer($int32) | 0 | Returns the number of reference frames for the created preset |
| dynamicSubGop | string | "string" | Returns the dynamic Sub GOP for the created preset |
| repeatPps | string | "string" | Returns the peer-to-peer streaming for the created preset |
| gopBReference | string | "string" | Returns the GOP B-Reference for the created preset |
| sceneChangeDetection | string | "string" | Returns the scene change detection for the created preset |
| minInterval | integer($int32) | 0 | Returns the minimum interval for the created preset |
| codecProfile | integer($int32) | 0 | Returns the selected codec profile for the created preset |
| codecProfileOptions | array[object] | Returns the list of options for codec profile options | |
| id | integer($int32) | 0 | Returns the id of the codec profilet option |
| value | string | "string" | Returns the value of the codec profile option |
| enabled | bool | false | Returns whether the codec profile option is enabled |
| codecLevel | string | "string" | Returns the selected codec level for the created preset |
| codecLevelOptions | array[string] | {"string", "string"} | Returns the list of codec level options for the created preset |
| colorMetadata | integer($int32) | 0 | Returns the selected color metadata for the created preset |
| codecProfileOptions | array[object] | Returns the list of options for color metadata options | |
| id | integer($int32) | 0 | Returns the id of the color metadata option |
| value | string | "string" | Returns the value of the color metadata option |
| enabled | bool | false | Returns whether the color metadata option is enabled |
| slices | integer($int32) | 0 | Returns the number of video slices of the created preset |
| entropyEncoding | string | "string" | Returns the entropy encoding for the created preset |
| adaptiveQuantization | string | "string" | Returns the adaptive quantization for the created preset |
| deinterlace | bool | false | Returns whether the deinterlace is enabled for the created preset |
| timecodeInsertion | bool | false | Returns whether the timecode insertion is enabled for the created preset |
| sharpness | string | "string" | Returns the video sharpness for the created preset |
| presetOption | integer($int32) | 0 | Returns the selected preset for the created preset |
| presetOptions | array[object] | Returns the list of options for preset options | |
| id | integer($int32) | 0 | Returns the id of the preset option |
| value | string | "string" | Returns the value of the preset option |
| enabled | bool | false | Returns whether the preset option is enabled |
| fragmentationType | integer($int32) | 0 | Returns the selected fragmentation type for the created preset |
| fragmentationTypeOptions | array[object] | Returns the list of options for fragmentation type options | |
| id | integer($int32) | 0 | Returns the id of the fragmentation type option |
| value | string | "string" | Returns the value of the fragmentation type option |
| enabled | bool | false | Returns whether the fragmentation type option is enabled |
| audioDescription | object | Returns the audio description for the created preset | |
| audioTypeControl | string | "string" | Returns the audio type control for the created preset |
| codecType | integer($int32) | 0 | Returns the selected audio codec type for the created preset |
| codecTypeOptions | array[object] | Returns the list of options for audio codec type options | |
| id | integer($int32) | 0 | Returns the id of the audio codec type option |
| value | string | "string" | Returns the value of the audio codec type option |
| enabled | bool | false | Returns whether the audio codec type option is enabled |
| audioDescriptionBroadcasterMix | integer($int32) | 0 | Returns the selected audio description broadcaster mix for the created preset |
| audioDescriptionBroadcasterMixOptions | array[object] | Returns the list of options for audio description broadcaster mix options | |
| id | integer($int32) | 0 | Returns the id of the audio description broadcaster mix option |
| value | string | "string" | Returns the value of the audio description broadcaster mix option |
| enabled | bool | false | Returns whether the audio description broadcaster mix option is enabled |
| bitrate | long | 0 | Returns the audio bitrate for the created preset |
| audioSampleBitrateOptions | Dictionary<string, string[]> | {"string", {"string", "string"}} | Returns the audio sample bitrate properties for the created preset |
| rateControlMode | integer($int32) | 0 | Returns the selected rate control mode for the created preset |
| rateControlModeOptions | array[object] | Returns the list of options for rate control mode options | |
| id | integer($int32) | 0 | Returns the id of the rate control mode option |
| value | string | "string" | Returns the value of the rate control mode option |
| enabled | bool | false | Returns whether the rate control mode option is enabled |
| codecProfile | integer($int32) | 0 | Returns the selected codec profile for the created preset |
| codecProfileOptions | array[object] | Returns the list of options for codec profile options | |
| id | integer($int32) | 0 | Returns the id of the codec profile option |
| value | string | "string" | Returns the value of the codec profile option |
| enabled | bool | false | Returns whether the codec profile option is enabled |
| codingMode | integer($int32) | 0 | Returns the selected coding mode for the created preset |
| codingModeOptions | array[object] | Returns the list of options for coding mode options | |
| id | integer($int32) | 0 | Returns the id of the coding mode option |
| value | string | "string" | Returns the value of the coding mode option |
| enabled | bool | false | Returns whether the coding mode option is enabled |
| rawFormat | integer($int32) | 0 | Returns the selected raw format for the created preset |
| rawFormatOptions | array[object] | Returns the list of options for the raw format options | |
| id | integer($int32) | 0 | Returns the id of the raw format option |
| value | string | "string" | Returns the value of the raw format option |
| enabled | bool | false | Returns whether the raw format option is enabled |
| sampleRate | long | 0 | Returns the audio sample rate for the created preset |
| sampleRate | long | 0 | Returns the audio sample rate for the created preset |
| specification | integer($int32) | 0 | Returns the selected specification for the created preset |
| specificationOptions | array[object] | Returns the list of options for the specification options | |
| id | integer($int32) | 0 | Returns the id of the specification option |
| value | string | "string" | Returns the value of the specification option |
| enabled | bool | false | Returns whether the specification option is enabled |
| languageCodeControl | string | "string" | Returns the language code control for the created preset |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
PUT Preset#
Update a Preset.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/presets |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | {name, description, category, container{type}, videoDescription{codecType, width, height, rateControlMode, qualityTuningLevel, bitrate, maxBitrate, framerateControl, framerateDenominator, framerateNumerator, framerateConversionAlgorithm, parNumerator, parDenominator, gopSize, gopSizeUnit, numberBFramesBetweenReferenceFrames, codecProfile, codecLevel, colorMetadata, deinterlace, presetOption, fragmentationType}, audioDescription{codecType, audioDescriptionBroadcasterMix, bitrate, rateControlMode, codecProfile, codingMode, rawFormat, sampleRate, specification}} |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Version | Yes | integer($int32) | v1 | Shows the version of API |
Request body#
{ "name": "string", "description": "string", "category": "string", "container": { "type": 0 }, "videoDescription": { "codecType": 0, "width": 0, "height": 0, "rateControlMode": 0, "qualityTuningLevel": 0, "bitrate": 0, "maxBitrate": 0, "framerateControl": "string", "framerateDenominator": 0, "framerateNumerator": 0, "framerateConversionAlgorithm": "string", "parNumerator": 0, "parDenominator": 0, "gopSize": 0, "gopSizeUnit": 0, "numberBFramesBetweenReferenceFrames": 0, "codecProfile": 0, "codecLevel": "string", "colorMetadata": 0, "deinterlace": true, "presetOption": 0, "fragmentationType": 0 }, "audioDescription": { "codecType": 0, "audioDescriptionBroadcasterMix": 0, "bitrate": 0, "rateControlMode": 0, "codecProfile": 0, "codingMode": 0, "rawFormat": 0, "sampleRate": 0, "specification": 0 }}
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| name | Yes | string | "string" | It specifies the name for the preset to be updated |
| description | No | string | "string" | It specifies the description for the preset to be updated |
| category | No | string | "string" | It specifies the category for the preset to be updated |
| container | Yes | object | It specifies the container properties for the preset to be updated | |
| type | Yes | integer($int32) | 0 | It specifies the container type for the preset to be updated |
| videoDescription | Yes | object | It specifies the video description properties for the preset to be updated | |
| codecType | Yes | integer($int32) | 0 | It specifies the video codec type for the preset to be updated |
| width | Yes | integer($int32) | 0 | It specifies the video width for the preset to be updated |
| height | Yes | integer($int32) | 0 | It specifies the video height for the preset to be updated |
| qualityTuningLevel | Yes | integer($int32) | 0 | It specifies the video quality tuning level for the preset to be updated |
| bitrate | Yes | integer($int32) | 0 | It specifies the video bitrate for the preset to be updated |
| maxBitrate | Yes | integer($int32) | 0 | It specifies the video maximum bitrate for the preset to be updated |
| framerateControl | Yes | string | "string" | It specifies the video framerate control for the preset to be updated |
| framerateDenominator | No | integer($int32) | 0 | It specifies the video framerate denominator for the custom preset to be updated |
| framerateNumerator | No | integer($int32) | 0 | It specifies the video framerate numerator for the custom preset to be updated |
| framerateConversionAlgorithm | Yes | string | "string" | It specifies the video framerate conversion algorithm for the preset to be updated |
| parNumerator | No | integer($int32) | 0 | It specifies the video pixel aspect ration numerator for the custom preset to be updated |
| parDenominator | No | integer($int32) | 0 | It specifies the video pixel aspect ration denominator for the custom preset to be updated |
| gopSize | Yes | integer($int32) | 0 | It specifies the video GOP size for the preset to be updated |
| gopSizeUnit | Yes | integer($int32) | 0 | It specifies th videoe GOP size unit for the preset to be updated |
| numberBFramesBetweenReferenceFrames | Yes | integer($int32) | 0 | It specifies the video number of b-frames between reference frames for the preset to be updated |
| codecProfile | Yes | integer($int32) | 0 | It specifies the video codec profile for the preset to be updated |
| codecLevel | Yes | string | "string" | It specifies the video codec level for the preset to be updated |
| colorMetadata | Yes | integer($int32) | 0 | It specifies the video color metadata for the preset to be updated |
| deinterlace | Yes | bool | false | It specifies whether the video deinterlace algorithmn is enabled for the preset to be updated |
| presetOption | Yes | integer($int32) | 0 | It specifies the video preset option for the preset to be updated |
| fragmentationType | Yes | integer($int32) | 0 | It specifies the video fragmentation type for the preset to be updated |
| audioDescription | Yes | object | 0 | It specifies the audio description properties for the preset to be updated |
| codecType | Yes | integer($int32) | 0 | It specifies the audio codec type for the preset to be updated |
| audioDescriptionBroadcasterMix | Yes | integer($int32) | 0 | It specifies the audio description broadcaster mix for the preset to be updated |
| bitrate | Yes | integer($int32) | 0 | It specifies the audio bitrate for the preset to be updated |
| rateControlMode | Yes | integer($int32) | 0 | It specifies the audio rate control mode for the preset to be updated |
| codecProfile | Yes | integer($int32) | 0 | It specifies the audio codec profile for the preset to be updated |
| codingMode | Yes | integer($int32) | 0 | It specifies the audio coding mode for the preset to be updated |
| rawFormat | Yes | integer($int32) | 0 | It specifies the audio coding mode for the preset to be updated |
| sampleRate | Yes | integer($int32) | 0 | It specifies the audio sample rate for the preset to be updated |
| specification | Yes | integer($int32) | 0 | It specifies the audio specification for the preset to be updated |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
"success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "insertDate": "2022-04-17T12:43:21.411Z", "updateDate": "2022-04-17T12:43:21.411Z", "insertedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "updatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "presetType": 0, "presetTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "name": "string", "description": "string", "category": "string", "container": { "type": 0, "containerOptions": [ { "id": 0, "value": "string", "enabled": true } ] }, "videoDescription": { "name": "string", "codecType": 0, "codecTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "width": 0, "height": 0, "rateControlMode": 0, "rateControlModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "qualityTuningLevel": 0, "qualityTuningLevelOptions": [ { "id": 0, "value": "string", "enabled": true } ], "bitrate": 0, "maxBitrate": 0, "framerateControl": "string", "framerateDenominator": 0, "framerateNumerator": 0, "framerateConversionAlgorithm": "string", "interlaceMode": "string", "fieldEncoding": "string", "scanTypeConversionMode": "string", "videoFrameRateOptions": [ [ "string" ] ], "parNumerator": 0, "parDenominator": 0, "videoPixelRatioOptions": [ [ "string" ] ], "gopSize": 0, "gopSizeUnit": 0, "gopSizeUnitOptions": [ { "id": 0, "value": "string", "enabled": true } ], "numberBFramesBetweenReferenceFrames": 0, "gopClosedCadence": 0, "numberReferenceFrames": 0, "dynamicSubGop": "string", "repeatPps": "string", "gopBReference": "string", "sceneChangeDetection": "string", "minInterval": 0, "codecProfile": 0, "codecProfileOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codecLevel": "string", "codecLevelOptions": [ "string" ], "colorMetadata": 0, "colorMetadataOptions": [ { "id": 0, "value": "string", "enabled": true } ], "slices": 0, "entropyEncoding": "string", "adaptiveQuantization": "string", "deinterlace": true, "timecodeInsertion": true, "sharpness": "string", "presetOption": 0, "presetOptions": [ { "id": 0, "value": "string", "enabled": true } ], "fragmentationType": 0, "fragmentationTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ] }, "audioDescription": { "audioTypeControl": "string", "codecType": 0, "codecTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "audioDescriptionBroadcasterMix": 0, "audioDescriptionBroadcasterMixOptions": [ { "id": 0, "value": "string", "enabled": true } ], "bitrate": 0, "audioSampleBitrateOptions": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "rateControlMode": 0, "rateControlModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codecProfile": 0, "codecProfileOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codingMode": 0, "codingModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "rawFormat": 0, "rawFormatOptions": [ { "id": 0, "value": "string", "enabled": true } ], "sampleRate": 0, "specification": 0, "specificationOptions": [ { "id": 0, "value": "string", "enabled": true } ], "languageCodeControl": "string" } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the updated preset | |
| id | integer($int32) | 0 | Returns the id of the updated preset |
| insertDate | DateTime | "2022-04-17T12:43:21.411Z" | Returns the insertion date of the updated preset |
| updateDate | DateTime | "2022-04-17T12:43:21.411Z" | Returns the latest updated date of the updated preset |
| insertedBy | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the person who inserted the preset |
| updatedBy | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the person who updated the preset |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the updated preset |
| presetType | integer($int32) | 0 | Returns the id of the preset type of the updated preset |
| presetTypeOptions | array[object] | Returns the list of options for preset types | |
| id | integer($int32) | 0 | Returns the id of the selected preset type |
| value | string | "string" | Returns the value of the selected preset type |
| enabled | bool | false | Returns whether the selected preset type is enabled |
| name | string | "string" | Returns the name of the updated preset |
| description | string | "string" | Returns the description of the updated preset |
| category | string | "string" | Returns the category of the updated preset |
| container | object | Returns the container properties of the updated preset | |
| type | integer($int32) | 0 | Returns the selected container id of the updated preset |
| containerOptions | array[object] | Returns the list of options of containers | |
| id | integer($int32) | 0 | Returns the id of the selected container |
| value | string | "string" | Returns the value of the selected container |
| enabled | bool | false | Returns whether the selected container is enabled |
| videoDescription | object | Returns the video description for the updated preset | |
| name | string | "string" | Returns the name for the updated preset |
| codecType | integer($int32) | 0 | Returns the video codec type for the updated preset |
| codecTypeOptions | array[object] | Returns the list of options for codec types | |
| id | integer($int32) | 0 | Returns the id of the codec option |
| value | string | "string" | Returns the value of the codec option |
| enabled | bool | false | Returns whether the codec option is enabled |
| width | integer($int32) | 0 | Returns the video width |
| height | integer($int32) | 0 | Returns the video height |
| rateControlMode | integer($int32) | 0 | Returns the id of the selected video rate control mode for the updated preset |
| rateControlModeOptions | array[object] | Returns the list of options for rate control mode | |
| id | integer($int32) | 0 | Returns the id of the rate control mode option |
| value | string | "string" | Returns the value of the rate control mode option |
| enabled | bool | false | Returns whether the rate control mode option is enabled |
| qualityTuningLevel | integer($int32) | 0 | Returns the id of the selected quality tuning level for the updated preset |
| qualityTuningLevelOptions | array[object] | Returns the list of options for quality tuning level | |
| id | integer($int32) | 0 | Returns the id of the quality tuning level option |
| value | string | "string" | Returns the value of the quality tuning level option |
| enabled | bool | false | Returns whether the quality tuning level option is enabled |
| bitrate | integer($int32) | 0 | Returns the bitrate for the updated preset |
| maxBitrate | integer($int32) | 0 | Returns the maximum bitrate for the updated preset |
| framerateControl | string | "string" | Returns the framerate control for the updated preset |
| framerateDenominator | integer($int32) | 0 | Returns the framerate denominator for custom framerate |
| framerateNumerator | integer($int32) | 0 | Returns the framerate numerator for custom framerate |
| framerateConversionAlgorithm | string | "string" | Returns the framerate conversion algorithm for the updated preset |
| interlaceMode | string | "string" | Returns the interlaces mode for the updated preset |
| fieldEncoding | string | "string" | Returns the field encoding for the updated preset |
| scanTypeConversionMode | string | "string" | Returns the scan type conversion mode for the updated preset |
| videoFrameRateOptions | array[string[]] | {"string", "string"},{"string", "string"} | Returns the list of video frame rate options for the updated preset |
| parNumerator | integer($int32) | 0 | Returns the numerator for custom pixel aspect ratio |
| parDenominator | integer($int32) | 0 | Returns the denominator for custom pixel aspect ratio |
| videoPixelRatioOptions | array[string[]] | {"string", "string"},{"string", "string"} | Returns the list of video pixel ratio options for the updated preset |
| gopSize | integer($int32) | 0 | Returns the GOP size for the updated preset |
| gopSizeUnit | integer($int32) | 0 | Returns the GOP unit size for the updated preset |
| gopSizeUnitOptions | array[object] | Returns the list of options for GOP size unit | |
| id | integer($int32) | 0 | Returns the id of the GOP size unit option |
| value | string | "string" | Returns the value of the GOP size unit option |
| enabled | bool | false | Returns whether the GOP size unit option is enabled |
| numberBFramesBetweenReferenceFrames | integer($int32) | 0 | Returns the number of b-frames between reference frames for the updated preset |
| gopClosedCadence | integer($int32) | 0 | Returns GOP closed cadence for the updated preset |
| numberReferenceFrames | integer($int32) | 0 | Returns the number of reference frames for the updated preset |
| dynamicSubGop | string | "string" | Returns the dynamic Sub GOP for the updated preset |
| repeatPps | string | "string" | Returns the peer-to-peer streaming for the updated preset |
| gopBReference | string | "string" | Returns the GOP B-Reference for the updated preset |
| sceneChangeDetection | string | "string" | Returns the scene change detection for the updated preset |
| minInterval | integer($int32) | 0 | Returns the minimum interval for the updated preset |
| codecProfile | integer($int32) | 0 | Returns the selected codec profile for the updated preset |
| codecProfileOptions | array[object] | Returns the list of options for codec profile options | |
| id | integer($int32) | 0 | Returns the id of the codec profile option |
| value | string | "string" | Returns the value of the codec profile option |
| enabled | bool | false | Returns whether the codec profile option is enabled |
| codecLevel | string | "string" | Returns the selected codec level for the updated preset |
| codecLevelOptions | array[string] | {"string", "string"} | Returns the list of codec level options for the updated preset |
| colorMetadata | integer($int32) | 0 | Returns the selected color metadata for the updated preset |
| codecProfileOptions | array[object] | Returns the list of options for color metadata options | |
| id | integer($int32) | 0 | Returns the id of the color metadata option |
| value | string | "string" | Returns the value of the color metadata option |
| enabled | bool | false | Returns whether the color metadata option is enabled |
| slices | integer($int32) | 0 | Returns the number of video slices of the updated preset |
| entropyEncoding | string | "string" | Returns the entropy encoding for the updated preset |
| adaptiveQuantization | string | "string" | Returns the adaptive quantization for the updated preset |
| deinterlace | bool | false | Returns whether the deinterlace is enabled for the updated preset |
| timecodeInsertion | bool | false | Returns whether the timecode insertion is enabled for the updated preset |
| sharpness | string | "string" | Returns the video sharpness for the updated preset |
| presetOption | integer($int32) | 0 | Returns the selected preset for the updated preset |
| presetOptions | array[object] | Returns the list of options for preset options | |
| id | integer($int32) | 0 | Returns the id of the preset option |
| value | string | "string" | Returns the value of the preset option |
| enabled | bool | false | Returns whether the preset option is enabled |
| fragmentationType | integer($int32) | 0 | Returns the selected fragmentation type for the updated preset |
| fragmentationTypeOptions | array[object] | Returns the list of options for fragmentation type options | |
| id | integer($int32) | 0 | Returns the id of the fragmentation type option |
| value | string | "string" | Returns the value of the fragmentation type option |
| enabled | bool | false | Returns whether the fragmentation type option is enabled |
| audioDescription | object | Returns the audio description for the updated preset | |
| audioTypeControl | string | "string" | Returns the audio type control for the updated preset |
| codecType | integer($int32) | 0 | Returns the selected audio codec type for the updated preset |
| codecTypeOptions | array[object] | Returns the list of options for audio codec type options | |
| id | integer($int32) | 0 | Returns the id of the audio codec type option |
| value | string | "string" | Returns the value of the audio codec type option |
| enabled | bool | false | Returns whether the audio codec type option is enabled |
| audioDescriptionBroadcasterMix | integer($int32) | 0 | Returns the selected audio description broadcaster mix for the updated preset |
| audioDescriptionBroadcasterMixOptions | array[object] | Returns the list of options for audio description broadcaster mix options | |
| id | integer($int32) | 0 | Returns the id of the audio description broadcaster mix option |
| value | string | "string" | Returns the value of the audio description broadcaster mix option |
| enabled | bool | false | Returns whether the audio description broadcaster mix option is enabled |
| bitrate | long | 0 | Returns the audio bitrate for the updated preset |
| audioSampleBitrateOptions | Dictionary<string, string[]> | {"string", {"string", "string"}} | Returns the audio sample bitrate properties for the updated preset |
| rateControlMode | integer($int32) | 0 | Returns the selected rate control mode for the updated preset |
| rateControlModeOptions | array[object] | Returns the list of options for rate control mode options | |
| id | integer($int32) | 0 | Returns the id of the rate control mode option |
| value | string | "string" | Returns the value of the rate control mode option |
| enabled | bool | false | Returns whether the rate control mode option is enabled |
| codecProfile | integer($int32) | 0 | Returns the selected codec profile for the updated preset |
| codecProfileOptions | array[object] | Returns the list of options for codec profile options | |
| id | integer($int32) | 0 | Returns the id of the codec profile option |
| value | string | "string" | Returns the value of the codec profile option |
| enabled | bool | false | Returns whether the codec profile option is enabled |
| codingMode | integer($int32) | 0 | Returns the selected coding mode for the updated preset |
| codingModeOptions | array[object] | Returns the list of options for coding mode options | |
| id | integer($int32) | 0 | Returns the id of the coding mode option |
| value | string | "string" | Returns the value of the coding mode option |
| enabled | bool | false | Returns whether the coding mode option is enabled |
| rawFormat | integer($int32) | 0 | Returns the selected raw format for the updated preset |
| rawFormatOptions | array[object] | Returns the list of options for the raw format options | |
| id | integer($int32) | 0 | Returns the id of the raw format option |
| value | string | "string" | Returns the value of the raw format option |
| enabled | bool | false | Returns whether the raw format option is enabled |
| sampleRate | long | 0 | Returns the audio sample rate for the updated preset |
| sampleRate | long | 0 | Returns the audio sample rate for the updated preset |
| specification | integer($int32) | 0 | Returns the selected specification for the updated preset |
| specificationOptions | array[object] | Returns the list of options for the specification options | |
| id | integer($int32) | 0 | Returns the id of the specification option |
| value | string | "string" | Returns the value of the specification option |
| enabled | bool | false | Returns whether the specification option is enabled |
| languageCodeControl | string | "string" | Returns the language code control for the updated preset |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Preset#
Get a Preset.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/presets/{id} |
| Headers | Authorization |
| Parameters | version, projectId, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| {id} | Yes | integer($int32) | 0 | Shows the id of the preset |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Version | Yes | integer($int32) | v1 | Shows the version of API |
| Id | Yes | integer($int32) | 0 | Shows the id of the preset |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
"success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "insertDate": "2022-04-17T12:43:21.411Z", "updateDate": "2022-04-17T12:43:21.411Z", "insertedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "updatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "presetType": 0, "presetTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "name": "string", "description": "string", "category": "string", "container": { "type": 0, "containerOptions": [ { "id": 0, "value": "string", "enabled": true } ] }, "videoDescription": { "name": "string", "codecType": 0, "codecTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "width": 0, "height": 0, "rateControlMode": 0, "rateControlModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "qualityTuningLevel": 0, "qualityTuningLevelOptions": [ { "id": 0, "value": "string", "enabled": true } ], "bitrate": 0, "maxBitrate": 0, "framerateControl": "string", "framerateDenominator": 0, "framerateNumerator": 0, "framerateConversionAlgorithm": "string", "interlaceMode": "string", "fieldEncoding": "string", "scanTypeConversionMode": "string", "videoFrameRateOptions": [ [ "string" ] ], "parNumerator": 0, "parDenominator": 0, "videoPixelRatioOptions": [ [ "string" ] ], "gopSize": 0, "gopSizeUnit": 0, "gopSizeUnitOptions": [ { "id": 0, "value": "string", "enabled": true } ], "numberBFramesBetweenReferenceFrames": 0, "gopClosedCadence": 0, "numberReferenceFrames": 0, "dynamicSubGop": "string", "repeatPps": "string", "gopBReference": "string", "sceneChangeDetection": "string", "minInterval": 0, "codecProfile": 0, "codecProfileOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codecLevel": "string", "codecLevelOptions": [ "string" ], "colorMetadata": 0, "colorMetadataOptions": [ { "id": 0, "value": "string", "enabled": true } ], "slices": 0, "entropyEncoding": "string", "adaptiveQuantization": "string", "deinterlace": true, "timecodeInsertion": true, "sharpness": "string", "presetOption": 0, "presetOptions": [ { "id": 0, "value": "string", "enabled": true } ], "fragmentationType": 0, "fragmentationTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ] }, "audioDescription": { "audioTypeControl": "string", "codecType": 0, "codecTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "audioDescriptionBroadcasterMix": 0, "audioDescriptionBroadcasterMixOptions": [ { "id": 0, "value": "string", "enabled": true } ], "bitrate": 0, "audioSampleBitrateOptions": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "rateControlMode": 0, "rateControlModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codecProfile": 0, "codecProfileOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codingMode": 0, "codingModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "rawFormat": 0, "rawFormatOptions": [ { "id": 0, "value": "string", "enabled": true } ], "sampleRate": 0, "specification": 0, "specificationOptions": [ { "id": 0, "value": "string", "enabled": true } ], "languageCodeControl": "string" } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the requested preset | |
| id | integer($int32) | 0 | Returns the id of the requested preset |
| insertDate | DateTime | "2022-04-17T12:43:21.411Z" | Returns the insertion date of the requested preset |
| updateDate | DateTime | "2022-04-17T12:43:21.411Z" | Returns the latest updated date of the requested preset |
| insertedBy | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the person who inserted the preset |
| updatedBy | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the person who updated the preset |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the requested preset |
| presetType | integer($int32) | 0 | Returns the id of the preset type of the requested preset |
| presetTypeOptions | array[object] | Returns the list of options for preset types | |
| id | integer($int32) | 0 | Returns the id of the selected preset type |
| value | string | "string" | Returns the value of the selected preset type |
| enabled | bool | false | Returns whether the selected preset type is enabled |
| name | string | "string" | Returns the name of the requested preset |
| description | string | "string" | Returns the description of the requested preset |
| category | string | "string" | Returns the category of the requested preset |
| container | object | Returns the container properties of the requested preset | |
| type | integer($int32) | 0 | Returns the selected container id of the requested preset |
| containerOptions | array[object] | Returns the list of options of containers | |
| id | integer($int32) | 0 | Returns the id of the selected container |
| value | string | "string" | Returns the value of the selected container |
| enabled | bool | false | Returns whether the selected container is enabled |
| videoDescription | object | Returns the video description for the requested preset | |
| name | string | "string" | Returns the name for the requested preset |
| codecType | integer($int32) | 0 | Returns the video codec type for the requested preset |
| codecTypeOptions | array[object] | Returns the list of options for codec types | |
| id | integer($int32) | 0 | Returns the id of the codec option |
| value | string | "string" | Returns the value of the codec option |
| enabled | bool | false | Returns whether the codec option is enabled |
| width | integer($int32) | 0 | Returns the video width |
| height | integer($int32) | 0 | Returns the video height |
| rateControlMode | integer($int32) | 0 | Returns the id of the selected video rate control mode for the requested preset |
| rateControlModeOptions | array[object] | Returns the list of options for rate control mode | |
| id | integer($int32) | 0 | Returns the id of the rate control mode option |
| value | string | "string" | Returns the value of the rate control mode option |
| enabled | bool | false | Returns whether the rate control mode option is enabled |
| qualityTuningLevel | integer($int32) | 0 | Returns the id of the selected quality tuning level for the requested preset |
| qualityTuningLevelOptions | array[object] | Returns the list of options for quality tuning level | |
| id | integer($int32) | 0 | Returns the id of the quality tuning level option |
| value | string | "string" | Returns the value of the quality tuning level option |
| enabled | bool | false | Returns whether the quality tuning level option is enabled |
| bitrate | integer($int32) | 0 | Returns the bitrate for the requested preset |
| maxBitrate | integer($int32) | 0 | Returns the maximum bitrate for the requested preset |
| framerateControl | string | "string" | Returns the framerate control for the requested preset |
| framerateDenominator | integer($int32) | 0 | Returns the framerate denominator for custom framerate |
| framerateNumerator | integer($int32) | 0 | Returns the framerate numerator for custom framerate |
| framerateConversionAlgorithm | string | "string" | Returns the framerate conversion algorithmn for the requested preset |
| interlaceMode | string | "string" | Returns the interlaces mode for the requested preset |
| fieldEncoding | string | "string" | Returns the field encoding for the requested preset |
| scanTypeConversionMode | string | "string" | Returns the scan type conversion mode for the requested preset |
| videoFrameRateOptions | array[string[]] | {"string", "string"},{"string", "string"} | Returns the list of video frame rate options for the requested preset |
| parNumerator | integer($int32) | 0 | Returns the numerator for custom pixel aspect ratio |
| parDenominator | integer($int32) | 0 | Returns the denominator for custom pixel aspect ratio |
| videoPixelRatioOptions | array[string[]] | {"string", "string"},{"string", "string"} | Returns the list of video pixel ratio options for the requested preset |
| gopSize | integer($int32) | 0 | Returns the GOP size for the requested preset |
| gopSizeUnit | integer($int32) | 0 | Returns the GOP unit size for the requested preset |
| gopSizeUnitOptions | array[object] | Returns the list of options for GOP size unit | |
| id | integer($int32) | 0 | Returns the id of the GOP size unit option |
| value | string | "string" | Returns the value of the GOP size unit option |
| enabled | bool | false | Returns whether the GOP size unit option is enabled |
| numberBFramesBetweenReferenceFrames | integer($int32) | 0 | Returns the number of b-frames between reference frames for the requested preset |
| gopClosedCadence | integer($int32) | 0 | Returns GOP closed cadence for the requested preset |
| numberReferenceFrames | integer($int32) | 0 | Returns the number of reference frames for the requested preset |
| dynamicSubGop | string | "string" | Returns the dynamic Sub GOP for the requested preset |
| repeatPps | string | "string" | Returns the peer-to-peer streaming for the requested preset |
| gopBReference | string | "string" | Returns the GOP B-Reference for the requested preset |
| sceneChangeDetection | string | "string" | Returns the scene change detection for the requested preset |
| minInterval | integer($int32) | 0 | Returns the minimum interval for the requested preset |
| codecProfile | integer($int32) | 0 | Returns the selected codec profile for the requested preset |
| codecProfileOptions | array[object] | Returns the list of options for codec profile options | |
| id | integer($int32) | 0 | Returns the id of the codec profilet option |
| value | string | "string" | Returns the value of the codec profile option |
| enabled | bool | false | Returns whether the codec profile option is enabled |
| codecLevel | string | "string" | Returns the selected codec level for the requested preset |
| codecLevelOptions | array[string] | {"string", "string"} | Returns the list of codec level options for the requested preset |
| colorMetadata | integer($int32) | 0 | Returns the selected color metadata for the updated preset |
| codecProfileOptions | array[object] | Returns the list of options for color metadata options | |
| id | integer($int32) | 0 | Returns the id of the color metadata option |
| value | string | "string" | Returns the value of the color metadata option |
| enabled | bool | false | Returns whether the color metadata option is enabled |
| slices | integer($int32) | 0 | Returns the number of video slices of the requested preset |
| entropyEncoding | string | "string" | Returns the entropy encoding for the requested preset |
| adaptiveQuantization | string | "string" | Returns the adaptive quantization for the requested preset |
| deinterlace | bool | false | Returns whether the deinterlace is enabled for the requested preset |
| timecodeInsertion | bool | false | Returns whether the timecode insertion is enabled for the requested preset |
| sharpness | string | "string" | Returns the video sharpness for the requested preset |
| presetOption | integer($int32) | 0 | Returns the selected preset for the requested preset |
| presetOptions | array[object] | Returns the list of options for preset options | |
| id | integer($int32) | 0 | Returns the id of the preset option |
| value | string | "string" | Returns the value of the preset option |
| enabled | bool | false | Returns whether the preset option is enabled |
| fragmentationType | integer($int32) | 0 | Returns the selected fragmentation type for the requested preset |
| fragmentationTypeOptions | array[object] | Returns the list of options for fragmentation type options | |
| id | integer($int32) | 0 | Returns the id of the fragmentation type option |
| value | string | "string" | Returns the value of the fragmentation type option |
| enabled | bool | false | Returns whether the fragmentation type option is enabled |
| audioDescription | object | Returns the audio description for the requested preset | |
| audioTypeControl | string | "string" | Returns the audio type control for the requested preset |
| codecType | integer($int32) | 0 | Returns the selected audio codec type for the requested preset |
| codecTypeOptions | array[object] | Returns the list of options for audio codec type options | |
| id | integer($int32) | 0 | Returns the id of the audio codec type option |
| value | string | "string" | Returns the value of the audio codec type option |
| enabled | bool | false | Returns whether the audio codec type option is enabled |
| audioDescriptionBroadcasterMix | integer($int32) | 0 | Returns the selected audio description broadcaster mix for the requested preset |
| audioDescriptionBroadcasterMixOptions | array[object] | Returns the list of options for audio description broadcaster mix options | |
| id | integer($int32) | 0 | Returns the id of the audio description broadcaster mix option |
| value | string | "string" | Returns the value of the audio description broadcaster mix option |
| enabled | bool | false | Returns whether the audio description broadcaster mix option is enabled |
| bitrate | long | 0 | Returns the audio bitrate for the updated preset |
| audioSampleBitrateOptions | Dictionary<string, string[]> | {"string", {"string", "string"}} | Returns the audio sample bitrate properties for the requested preset |
| rateControlMode | integer($int32) | 0 | Returns the selected rate control mode for the requested preset |
| rateControlModeOptions | array[object] | Returns the list of options for rate control mode options | |
| id | integer($int32) | 0 | Returns the id of the rate control mode option |
| value | string | "string" | Returns the value of the rate control mode option |
| enabled | bool | false | Returns whether the rate control mode option is enabled |
| codecProfile | integer($int32) | 0 | Returns the selected codec profile for the requested preset |
| codecProfileOptions | array[object] | Returns the list of options for codec profile options | |
| id | integer($int32) | 0 | Returns the id of the codec profile option |
| value | string | "string" | Returns the value of the codec profile option |
| enabled | bool | false | Returns whether the codec profile option is enabled |
| codingMode | integer($int32) | 0 | Returns the selected coding mode for the requested preset |
| codingModeOptions | array[object] | Returns the list of options for coding mode options | |
| id | integer($int32) | 0 | Returns the id of the coding mode option |
| value | string | "string" | Returns the value of the coding mode option |
| enabled | bool | false | Returns whether the coding mode option is enabled |
| rawFormat | integer($int32) | 0 | Returns the selected raw format for the requested preset |
| rawFormatOptions | array[object] | Returns the list of options for the raw format options | |
| id | integer($int32) | 0 | Returns the id of the raw format option |
| value | string | "string" | Returns the value of the raw format option |
| enabled | bool | false | Returns whether the raw format option is enabled |
| sampleRate | long | 0 | Returns the audio sample rate for the requested preset |
| sampleRate | long | 0 | Returns the audio sample rate for the requested preset |
| specification | integer($int32) | 0 | Returns the selected specification for the requested preset |
| specificationOptions | array[object] | Returns the list of options for the specification options | |
| id | integer($int32) | 0 | Returns the id of the specification option |
| value | string | "string" | Returns the value of the specification option |
| enabled | bool | false | Returns whether the specification option is enabled |
| languageCodeControl | string | "string" | Returns the language code control for the requested preset |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
DELETE Preset#
Delete a preset.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/presets/{id} |
| Headers | Authorization |
| Parameters | version, projectId, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| {id} | Yes | integer($int32) | 0 | Shows the id of the preset |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Version | Yes | integer($int32) | v1 | Shows the version of API |
| Id | Yes | integer($int32) | 0 | Shows the id of the preset |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "message" : "string"}| Field Name | Type | Example | Description |
|---|---|---|---|
| message | string | string | Return the message in regard to deletion of the preset |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
POST Preset#
Duplicate a preset.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/presets/{id}/duplicate |
| Headers | Authorization |
| Parameters | version, projectId, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| {id} | Yes | integer($int32) | 0 | Shows the id of the preset |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Version | Yes | integer($int32) | v1 | Shows the version of API |
| Id | Yes | integer($int32) | 0 | Shows the id of the preset |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
"success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "insertDate": "2022-04-17T12:43:21.411Z", "updateDate": "2022-04-17T12:43:21.411Z", "insertedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "updatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "presetType": 0, "presetTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "name": "string", "description": "string", "category": "string", "container": { "type": 0, "containerOptions": [ { "id": 0, "value": "string", "enabled": true } ] }, "videoDescription": { "name": "string", "codecType": 0, "codecTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "width": 0, "height": 0, "rateControlMode": 0, "rateControlModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "qualityTuningLevel": 0, "qualityTuningLevelOptions": [ { "id": 0, "value": "string", "enabled": true } ], "bitrate": 0, "maxBitrate": 0, "framerateControl": "string", "framerateDenominator": 0, "framerateNumerator": 0, "framerateConversionAlgorithm": "string", "interlaceMode": "string", "fieldEncoding": "string", "scanTypeConversionMode": "string", "videoFrameRateOptions": [ [ "string" ] ], "parNumerator": 0, "parDenominator": 0, "videoPixelRatioOptions": [ [ "string" ] ], "gopSize": 0, "gopSizeUnit": 0, "gopSizeUnitOptions": [ { "id": 0, "value": "string", "enabled": true } ], "numberBFramesBetweenReferenceFrames": 0, "gopClosedCadence": 0, "numberReferenceFrames": 0, "dynamicSubGop": "string", "repeatPps": "string", "gopBReference": "string", "sceneChangeDetection": "string", "minInterval": 0, "codecProfile": 0, "codecProfileOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codecLevel": "string", "codecLevelOptions": [ "string" ], "colorMetadata": 0, "colorMetadataOptions": [ { "id": 0, "value": "string", "enabled": true } ], "slices": 0, "entropyEncoding": "string", "adaptiveQuantization": "string", "deinterlace": true, "timecodeInsertion": true, "sharpness": "string", "presetOption": 0, "presetOptions": [ { "id": 0, "value": "string", "enabled": true } ], "fragmentationType": 0, "fragmentationTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ] }, "audioDescription": { "audioTypeControl": "string", "codecType": 0, "codecTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "audioDescriptionBroadcasterMix": 0, "audioDescriptionBroadcasterMixOptions": [ { "id": 0, "value": "string", "enabled": true } ], "bitrate": 0, "audioSampleBitrateOptions": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "rateControlMode": 0, "rateControlModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codecProfile": 0, "codecProfileOptions": [ { "id": 0, "value": "string", "enabled": true } ], "codingMode": 0, "codingModeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "rawFormat": 0, "rawFormatOptions": [ { "id": 0, "value": "string", "enabled": true } ], "sampleRate": 0, "specification": 0, "specificationOptions": [ { "id": 0, "value": "string", "enabled": true } ], "languageCodeControl": "string" } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Returns the duplicated preset | |
| id | integer($int32) | 0 | Returns the id of the duplicated preset |
| insertDate | DateTime | "2022-04-17T12:43:21.411Z" | Returns the insertion date of the duplicated preset |
| updateDate | DateTime | "2022-04-17T12:43:21.411Z" | Returns the latest updated date of the duplicated preset |
| insertedBy | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the person who inserted the preset |
| updatedBy | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the person who updated the preset |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the requested preset |
| presetType | integer($int32) | 0 | Returns the id of the preset type of the duplicated preset |
| presetTypeOptions | array[object] | Returns the list of options for preset types | |
| id | integer($int32) | 0 | Returns the id of the selected preset type |
| value | string | "string" | Returns the value of the selected preset type |
| enabled | bool | false | Returns whether the selected preset type is enabled |
| name | string | "string" | Returns the name of the duplicated preset |
| description | string | "string" | Returns the description of the duplicated preset |
| category | string | "string" | Returns the category of the duplicated preset |
| container | object | Returns the container properties of the duplicated preset | |
| type | integer($int32) | 0 | Returns the selected container id of the duplicated preset |
| containerOptions | array[object] | Returns the list of options of containers | |
| id | integer($int32) | 0 | Returns the id of the selected container |
| value | string | "string" | Returns the value of the selected container |
| enabled | bool | false | Returns whether the selected container is enabled |
| videoDescription | object | Returns the video description for the duplicated preset | |
| name | string | "string" | Returns the name for the duplicated preset |
| codecType | integer($int32) | 0 | Returns the video codec type for the duplicated preset |
| codecTypeOptions | array[object] | Returns the list of options for codec types | |
| id | integer($int32) | 0 | Returns the id of the codec option |
| value | string | "string" | Returns the value of the codec option |
| enabled | bool | false | Returns whether the codec option is enabled |
| width | integer($int32) | 0 | Returns the video width |
| height | integer($int32) | 0 | Returns the video height |
| rateControlMode | integer($int32) | 0 | Returns the id of the selected video rate control mode for the duplicated preset |
| rateControlModeOptions | array[object] | Returns the list of options for rate control mode | |
| id | integer($int32) | 0 | Returns the id of the rate control mode option |
| value | string | "string" | Returns the value of the rate control mode option |
| enabled | bool | false | Returns whether the rate control mode option is enabled |
| qualityTuningLevel | integer($int32) | 0 | Returns the id of the selected quality tuning level for the duplicated preset |
| qualityTuningLevelOptions | array[object] | Returns the list of options for quality tuning level | |
| id | integer($int32) | 0 | Returns the id of the quality tuning level option |
| value | string | "string" | Returns the value of the quality tuning level option |
| enabled | bool | false | Returns whether the quality tuning level option is enabled |
| bitrate | integer($int32) | 0 | Returns the bitrate for the duplicated preset |
| maxBitrate | integer($int32) | 0 | Returns the maximum bitrate for the duplicated preset |
| framerateControl | string | "string" | Returns the framerate control for the duplicated preset |
| framerateDenominator | integer($int32) | 0 | Returns the framerate denominator for custom framerate |
| framerateNumerator | integer($int32) | 0 | Returns the framerate numerator for custom framerate |
| framerateConversionAlgorithm | string | "string" | Returns the framerate conversion algorithmn for the duplicated preset |
| interlaceMode | string | "string" | Returns the interlaces mode for the duplicated preset |
| fieldEncoding | string | "string" | Returns the field encoding for the duplicated preset |
| scanTypeConversionMode | string | "string" | Returns the scan type conversion mode for the duplicated preset |
| videoFrameRateOptions | array[string[]] | {"string", "string"},{"string", "string"} | Returns the list of video frame rate options for the duplicated preset |
| parNumerator | integer($int32) | 0 | Returns the numerator for custom pixel aspect ratio |
| parDenominator | integer($int32) | 0 | Returns the denominator for custom pixel aspect ratio |
| videoPixelRatioOptions | array[string[]] | {"string", "string"},{"string", "string"} | Returns the list of video pixel ratio options for the duplicated preset |
| gopSize | integer($int32) | 0 | Returns the GOP size for the duplicated preset |
| gopSizeUnit | integer($int32) | 0 | Returns the GOP unit size for the duplicated preset |
| gopSizeUnitOptions | array[object] | Returns the list of options for GOP size unit | |
| id | integer($int32) | 0 | Returns the id of the GOP size unit option |
| value | string | "string" | Returns the value of the GOP size unit option |
| enabled | bool | false | Returns whether the GOP size unit option is enabled |
| numberBFramesBetweenReferenceFrames | integer($int32) | 0 | Returns the number of b-frames between reference frames for the duplicated preset |
| gopClosedCadence | integer($int32) | 0 | Returns GOP closed cadence for the duplicated preset |
| numberReferenceFrames | integer($int32) | 0 | Returns the number of reference frames for the duplicated preset |
| dynamicSubGop | string | "string" | Returns the dynamic Sub GOP for the duplicated preset |
| repeatPps | string | "string" | Returns the peer-to-peer streaming for the duplicated preset |
| gopBReference | string | "string" | Returns the GOP B-Reference for the duplicated preset |
| sceneChangeDetection | string | "string" | Returns the scene change detection for the duplicated preset |
| minInterval | integer($int32) | 0 | Returns the minimum interval for the duplicated preset |
| codecProfile | integer($int32) | 0 | Returns the selected codec profile for the duplicated preset |
| codecProfileOptions | array[object] | Returns the list of options for codec profile options | |
| id | integer($int32) | 0 | Returns the id of the codec profilet option |
| value | string | "string" | Returns the value of the codec profile option |
| enabled | bool | false | Returns whether the codec profile option is enabled |
| codecLevel | string | "string" | Returns the selected codec level for the duplicated preset |
| codecLevelOptions | array[string] | {"string", "string"} | Returns the list of codec level options for the duplicated preset |
| colorMetadata | integer($int32) | 0 | Returns the selected color metadata for the updated preset |
| codecProfileOptions | array[object] | Returns the list of options for color metadata options | |
| id | integer($int32) | 0 | Returns the id of the color metadata option |
| value | string | "string" | Returns the value of the color metadata option |
| enabled | bool | false | Returns whether the color metadata option is enabled |
| slices | integer($int32) | 0 | Returns the number of video slices of the duplicated preset |
| entropyEncoding | string | "string" | Returns the entropy encoding for the duplicated preset |
| adaptiveQuantization | string | "string" | Returns the adaptive quantization for the duplicated preset |
| deinterlace | bool | false | Returns whether the deinterlace is enabled for the duplicated preset |
| timecodeInsertion | bool | false | Returns whether the timecode insertion is enabled for the duplicated preset |
| sharpness | string | "string" | Returns the video sharpness for the duplicated preset |
| presetOption | integer($int32) | 0 | Returns the selected preset for the duplicated preset |
| presetOptions | array[object] | Returns the list of options for preset options | |
| id | integer($int32) | 0 | Returns the id of the preset option |
| value | string | "string" | Returns the value of the preset option |
| enabled | bool | false | Returns whether the preset option is enabled |
| fragmentationType | integer($int32) | 0 | Returns the selected fragmentation type for the duplicated preset |
| fragmentationTypeOptions | array[object] | Returns the list of options for fragmentation type options | |
| id | integer($int32) | 0 | Returns the id of the fragmentation type option |
| value | string | "string" | Returns the value of the fragmentation type option |
| enabled | bool | false | Returns whether the fragmentation type option is enabled |
| audioDescription | object | Returns the audio description for the duplicated preset | |
| audioTypeControl | string | "string" | Returns the audio type control for the duplicated preset |
| codecType | integer($int32) | 0 | Returns the selected audio codec type for the duplicated preset |
| codecTypeOptions | array[object] | Returns the list of options for audio codec type options | |
| id | integer($int32) | 0 | Returns the id of the audio codec type option |
| value | string | "string" | Returns the value of the audio codec type option |
| enabled | bool | false | Returns whether the audio codec type option is enabled |
| audioDescriptionBroadcasterMix | integer($int32) | 0 | Returns the selected audio description broadcaster mix for the duplicated preset |
| audioDescriptionBroadcasterMixOptions | array[object] | Returns the list of options for audio description broadcaster mix options | |
| id | integer($int32) | 0 | Returns the id of the audio description broadcaster mix option |
| value | string | "string" | Returns the value of the audio description broadcaster mix option |
| enabled | bool | false | Returns whether the audio description broadcaster mix option is enabled |
| bitrate | long | 0 | Returns the audio bitrate for the duplicated preset |
| audioSampleBitrateOptions | Dictionary<string, string[]> | {"string", {"string", "string"}} | Returns the audio sample bitrate properties for the duplicated preset |
| rateControlMode | integer($int32) | 0 | Returns the selected rate control mode for the duplicated preset |
| rateControlModeOptions | array[object] | Returns the list of options for rate control mode options | |
| id | integer($int32) | 0 | Returns the id of the rate control mode option |
| value | string | "string" | Returns the value of the rate control mode option |
| enabled | bool | false | Returns whether the rate control mode option is enabled |
| codecProfile | integer($int32) | 0 | Returns the selected codec profile for the duplicated preset |
| codecProfileOptions | array[object] | Returns the list of options for codec profile options | |
| id | integer($int32) | 0 | Returns the id of the codec profile option |
| value | string | "string" | Returns the value of the codec profile option |
| enabled | bool | false | Returns whether the codec profile option is enabled |
| codingMode | integer($int32) | 0 | Returns the selected coding mode for the duplicated preset |
| codingModeOptions | array[object] | Returns the list of options for coding mode options | |
| id | integer($int32) | 0 | Returns the id of the coding mode option |
| value | string | "string" | Returns the value of the coding mode option |
| enabled | bool | false | Returns whether the coding mode option is enabled |
| rawFormat | integer($int32) | 0 | Returns the selected raw format for the duplicated preset |
| rawFormatOptions | array[object] | Returns the list of options for the raw format options | |
| id | integer($int32) | 0 | Returns the id of the raw format option |
| value | string | "string" | Returns the value of the raw format option |
| enabled | bool | false | Returns whether the raw format option is enabled |
| sampleRate | long | 0 | Returns the audio sample rate for the duplicated preset |
| sampleRate | long | 0 | Returns the audio sample rate for the duplicated preset |
| specification | integer($int32) | 0 | Returns the selected specification for the duplicated preset |
| specificationOptions | array[object] | Returns the list of options for the specification options | |
| id | integer($int32) | 0 | Returns the id of the specification option |
| value | string | "string" | Returns the value of the specification option |
| enabled | bool | false | Returns whether the specification option is enabled |
| languageCodeControl | string | "string" | Returns the language code control for the duplicated preset |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found