Page History

...

REST queries and response states

REST query

Request example

Response example

Response states

Description

/transcoder2/startup

Code Block

language	js
theme	RDark

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

200 - OK

400 - Bad request

409 - Conflict

500 - Internal error

Create transcoder with defined parameters for certain stream

/transcoder2/find

Code Block

language	js
theme	RDark

{
 "remoteStreamName": "test"
}

Code Block

language	js
theme	RDark

[
  {
    "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
    }
  }
]

200 – OK

404 – Not found

Find the transcoder by certain criteria

/transcoder/find_all

Code Block

language	js
theme	RDark

[
  {
    "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
    }
  }
]

200 – OK

404 – Not found

Find all transcoders

/transcoder/terminate

Code Block

language	js
theme	RDark

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

200 – OK

404 – Not found

Stop transcoder and its output stream

Parameters

Name	Description	Example
uri	Transcoder URL	transcoder2://tcode2
localStreamName	Transcoder output stream name	testT
remoteStreamName	Stream name to transcode	test
localMediaSessionId	Transcoder media session Id	82ad5545-e11e-4f0f-801a-49e69d8c38f2
status	Transcoder state	PROCESSED_LOCAL
hasAudio	Output stream has audio	true
hasVideo	Output stream has video	true
record	Output stream is recorded	false
Encoder parameters
width	Picture width	320
height	Picture height	240
audioCodec	Audio codec	mpeg4-generic
audioRate	Audio sample rate, Hz	44100
audioChannels	Audio channels	2
audioBitrate	Audio bitrate, bps	64000
videoCodec	Video codec	H264
keyFrameInterval	Key frame generation interval (GOP)	30
fps	Frames per second	30
bitrate	Video bitrate, in kbps	500
type	Encoder type	OPENH264
watermark	Watermark file	Test.png
videoRate	Video sample rate, Hz	90000

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

...

Space shortcuts

Page tree

Versions Compared

Old Version 10

New Version 11

Key

REST queries and response states

Parameters

Known limits