...

Transcoding management with REST API

Obsolete REST API version (server builds before 5.2.898)

REST query should be HTTP/HTTPS POST request as:

...

• test.flashphoner.com is WCS server address
• 8081 is a standard REST / HTTP port of  WCS server
• 8444 is a standard HTTPS port
• rest-api is mandatory URL prefix
• /transcoder/startup is REST query

REST queries and response states

{
 "uri": "transcoder://tcode1",
 "remoteStreamName": "test",
 "localStreamName": "testT",
 "encoder": {
  "width": 640,
  "height": 480,
  "keyFrameInterval": 30,
  "fps": 30,
  "watermark": "Test.png"
 }
}

{
 "remoteStreamName": "test"
}

[
    {
        "localMediaSessionId": "42a92132-bcd1-4436-a96f-3fec36b32b37",
        "localStreamName": "testT",
        "remoteStreamName": "test",
        "uri": "transcoder://tcode1",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false,
        "encoder": {
            "width": 640,
            "height": 480,
            "keyFrameInterval": 30,
            "fps": 30,
            "watermark": "Test.png"
        }
    }
]

[
    {
        "localMediaSessionId": "42a92132-bcd1-4436-a96f-3fec36b32b37",
        "localStreamName": "testT",
        "remoteStreamName": "test",
        "uri": "transcoder://tcode1",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false,
        "encoder": {
            "width": 640,
            "height": 480,
            "keyFrameInterval": 30,
            "fps": 30
        }
    }
]

{
"uri":"transcoder://tcode1"
}

...

transcoder://tcode1

testT

test

42a92132-bcd1-4436-a96f-3fec36b32b37

PROCESSED_LOCAL

true

true

false

640

480

30

30

500

OPENH264

Known limits

1. Transcoder cannot be created by REST API for audio only stream. In response to /transcoder/startup query for such stream, server returns 400 Bad request with message "Can't start transcoder for audio only stream"

...

4, If only width is specified, the quey return 400 Bad request with message "Height is not specified"

REST API version 2 (server builds since 5.2.898)

REST query should be HTTP/HTTPS POST request as:

• HTTP: http://test.flashphoner.com:8081/rest-api/transcoder2/startup
• HTTPS: https://test.flashphoner.com:8444/rest-api/transcoder2/startup

Where:

• test.flashphoner.com is WCS server address
• 8081 is a standard REST / HTTP port of  WCS server
• 8444 is a standard HTTPS port
• rest-api is mandatory URL prefix
• /transcoder2/startup is REST query

REST queries and response states

{
 "uri": "transcoder2://tcode2",
 "remoteStreamName": "test",
 "localStreamName": "testT",
 "encoder": {
  "videoCodec": "H264",
  "audioCodec": "mpeg4-generic",
  "width": 320,
  "height": 240,
  "keyFrameInterval": 60,
  "fps": 30,
  "audioRate": 44100
 }
}

{
 "remoteStreamName": "test"
}

[
  {
    "localMediaSessionId": "82ad5545-e11e-4f0f-801a-49e69d8c38f2",
    "localStreamName": "testT",
    "remoteStreamName": "test",
    "uri": "transcoder2://tcode2",
    "status": "PROCESSED_LOCAL",
    "hasAudio": true,
    "hasVideo": true,
    "record": false,
    "encoder": {
      "width": 320,
      "height": 240,
      "keyFrameInterval": 60,
      "fps": 30,
      "audioRate": 44100,
      "audioCodec": "mpeg4-generic",
      "videoCodec": "H264",
      "videoRate": 90000
    }
  }
]

[
  {
    "localMediaSessionId": "82ad5545-e11e-4f0f-801a-49e69d8c38f2",
    "localStreamName": "testT",
    "remoteStreamName": "test",
    "uri": "transcoder2://tcode2",
    "status": "PROCESSED_LOCAL",
    "hasAudio": true,
    "hasVideo": true,
    "record": false,
    "encoder": {
      "width": 320,
      "height": 240,
      "keyFrameInterval": 60,
      "fps": 30,
      "audioRate": 44100,
      "audioCodec": "mpeg4-generic",
      "videoCodec": "H264",
      "videoRate": 90000
    }
  }
]

{
 "uri":"transcoder2://tcode2"
}

Parameters

transcoder2://tcode2

testT

test

82ad5545-e11e-4f0f-801a-49e69d8c38f2

PROCESSED_LOCAL

true

true

false

320

240

30

30

500

OPENH264

Known limits

1. If video transcoding parameters are passed for audio only stream, or audio transcoding parameters are passed for video only stream, 400 Bad request will return

Quick manual for testing

1. For test we use

...