Version 8.3.8

Back | 

WsTranscodingProfile

Returns list of transcoding profiles for the given account

URL Format

/ws/ws_transcoding_profile/api/{app_token}/mode/json/apiv/5?start={start}&end={end}&excludeGlobal={true}&excludeParent={true}&name={name}

Parameters

Name Req Type Description
app_token string The api token for the given account. You can find the api token when navigating through account->api accounts
apiv integer The api version; only version 5 supported.
excludeParent string If set to 'true' excludes the transcoding profiles from the parent account
excludeGlobal string If set to 'true' excludes the global transcoding profiles.
name string partial search based on the name of the transcoding profile
start int Will return a subset of available transcoding profiless. Used primarily for pagination. Default is set to 0
end integer Will return a subset of available folders. Used primarily for pagination. Default is set to start+20 Zero-based exclusive index: E.G. &start=0&send=4 will return 5 transcoding profiles from the beginning.

Request Headers

Name

Possible Responses

  • 222 Transcoding profiles found
  • 1044 Transcoding profiles not found
  • 102 Invalid app token.
  • 659 Invalid Client

Example Response

{
  "response": {
    "success": {
      "code": 222,
      "message": "Transcoding profiles found",
      "details": ""
    },
    "WsTranscodingProfile": {
      "transcodingProfile": [
        {
          "id": 777,
          "name": "3037-watermarking-test",
          "clientid": 73,
          "sortnum": 0,
          "defaultWidth": 0,
          "maxWidth": 0,
          "allowUpscale": true,
          "addReferenceFile": true,
          "transcodeReferenceFile": false,
          "enableSourceFileRequirements": true
        },
        {
          "id": 778,
          "name": "3037-watermarking-test2",
          "clientid": 73,
          "sortnum": 0,
          "defaultWidth": 0,
          "maxWidth": 0,
          "allowUpscale": true,
          "addReferenceFile": true,
          "transcodeReferenceFile": false,
          "enableSourceFileRequirements": false
        },
        {
          "id": 721,
          "name": "Ar_ref_on_upsacale_on",
          "clientid": 73,
          "sortnum": 0,
          "defaultWidth": 0,
          "maxWidth": 0,
          "allowUpscale": true,
          "addReferenceFile": true,
          "transcodeReferenceFile": false,
          "enableSourceFileRequirements": false
        }
      ],
      "totalCount": "27",
      "defaultVideoTranscodingProfile": {
        "id": 621,
        "name": "3. Universal (3 renditions)",
        "clientid": 0,
        "sortnum": 0,
        "defaultWidth": 0,
        "maxWidth": 0,
        "allowUpscale": true,
        "addReferenceFile": false,
        "transcodeReferenceFile": false,
        "enableSourceFileRequirements": false
      },
      "defaultAudioTranscodingProfile": {
        "id": 621,
        "name": "3. Universal (3 renditions)",
        "clientid": 0,
        "sortnum": 0,
        "defaultWidth": 0,
        "maxWidth": 0,
        "allowUpscale": true,
        "addReferenceFile": false,
        "transcodeReferenceFile": false,
        "enableSourceFileRequirements": false
      }
    }
  }
}