TranscodingProfiles

Get All Transcoding Profiles GET /transcodingprofiles/

Description

Request all transcoding profiles.

Properties

Title

Get all transcoding profile

URL

/transcodingprofiles/

Method

GET

Headers

Name	Value	Required	Description
Authorization	Token xxxxx	yes	Authorization token required to communicate with the API.

URL Params

Name	Type	Required	Description
limit	integer	no	Limit the number of objects to return.
offset	integer	no	Do not return the first x objects, where x is the amount specified by offset.

Success Response

200 - OK

[
  {
    "id": 1,
    "name": "XDCAMHD422 MXF",
    "codec_name": "mpeg2video",
    "codec_profile": "xdcamhd422",
    "video_container": "mxf",
    "frame_rate": "25",
    "video_data_rate": "",
    "width": 1920,
    "height": 1080,
    "display_aspect_ratio": "16:9",
    "pix_fmt": "",
    "progressive": false,
    "passthrough": true,
    "default_profile": false,
    "interlaced": "tff",
    "ar_conversion": "squeeze",
    "should_have_audio": true,
    "audio_codec_name": "pcm_s16le",
    "audio_container": "",
    "audio_codec_profile": "",
    "audio_data_rate": "",
    "tracks": 8,
    "channels_per_track": 1,
    "bits_per_sample": 16,
    "sample_rate": 48000
  },
  ...
]

Sample Call

curl -X GET http://medialoopster-url/api/transcodingprofiles/

Get Single Transcoding Profile GET /transcodingprofiles/{id}/

Description

Request a single transcoding profile.

Properties

Title

Get single transcoding profile

URL

/transcodingprofiles/{id}/

Method

GET

Headers

Name	Value	Required	Description
Authorization	Token xxxxx	yes	Authorization token required to communicate with the API.

Success Response

200 - OK

{
  "id": 1,
  "name": "XDCAMHD422 MXF",
  "codec_name": "mpeg2video",
  "codec_profile": "xdcamhd422",
  "video_container": "mxf",
  "frame_rate": "25",
  "video_data_rate": "",
  "width": 1920,
  "height": 1080,
  "display_aspect_ratio": "16:9",
  "pix_fmt": "",
  "progressive": false,
  "passthrough": true,
  "default_profile": false,
  "interlaced": "tff",
  "ar_conversion": "squeeze",
  "should_have_audio": true,
  "audio_codec_name": "pcm_s16le",
  "audio_container": "",
  "audio_codec_profile": "",
  "audio_data_rate": "",
  "tracks": 8,
  "channels_per_track": 1,
  "bits_per_sample": 16,
  "sample_rate": 48000
}

Error Response

404 - Not Found

{
  "errors": [
    {
      "status": "404",
      "code": "not_found",
      "detail": "TranscodingProfile object with pk=u'{id}' does not exist.",
      "title": "Not Found"
    }
  ]
}

Sample Call

curl -X GET http://medialoopster-url/api/transcodingprofiles/1/

Create Transcoding ProfilePOST /transcodingprofiles/

Work in progress!

Description

Create a new transcoding profile.

Properties

Title

Create transcoding profile

URL

/transcodingprofiles/

Method

POST

Headers

Name	Value	Required	Description
Authorization	Token xxxxx	yes	Authorization token required to communicate with the API.
Content-Type	application/json	no	If the request body is sent as raw data instead of form-data this header needs to be set as well.

Data Params

Name	Type	Required	Description
name	string	yes	The name of the transcoding profile.

Success Response

200 - OK

{
  "id": 2,
  "name": "Transcoding Profile Name",
  "codec_name": "",
  "codec_profile": "",
  "video_container": "",
  "frame_rate": "",
  "video_data_rate": "",
  "width": 0,
  "height": 0,
  "display_aspect_ratio": "",
  "pix_fmt": "",
  "progressive": false,
  "passthrough": false,
  "default_profile": false,
  "interlaced": "tff",
  "ar_conversion": "box",
  "should_have_audio": true,
  "audio_codec_name": "",
  "audio_container": "",
  "audio_codec_profile": "",
  "audio_data_rate": "",
  "tracks": 0,
  "channels_per_track": 0,
  "bits_per_sample": 0,
  "sample_rate": 0
}

Error Response

400 - Bad Request

{
  "errors": [
    {
      "status": "400",
      "source": {
        "pointer": "/name"
      },
      "code": "required",
      "detail": "This field is required.",
      "title": "Validation Error"
    }
  ]
}

Sample Call

curl -X POST http://medialoopster-url/api/transcodingprofiles/ \
  -d '{
    "name": "Transcoding Profile Name"
  }'