Presets

Add a new Preset

POST http://recording_server:9000/api/presets

Adds a new Preset

Headers

Name

Type

Description

Authorization

string

API Token

Request Body

Name

Type

Description

Name

string

Specifies the name of the Preset

Type

string

Matches the Destination Type

Format

string

Encoding Format

VideoCodec

string

Encoding video codec

AudioCodec

string

Encoding audio codec

VideoBitrate

string

Encoding video bitrate

KeyFrameInterval

string

Key-frame interval (GOP-size)

StartTimecode

object

Start timecode type

ManualTimecode

string

Manual start timecode value

Config

string

Total encoding config

Update a Preset

PUT http://recording_server:9000/api/presets/{index}

Updates an existing preset

Query Parameters

Name

Type

Description

{index}

integer

sets an index of a Preset

Headers

Name

Type

Description

Authorization

string

API Token

Request Body

Name

Type

Description

Name

string

Specifies the name of the Preset

Type

string

Matches the Destination Type

Format

string

Encoding Format

VideoCodec

string

Encoding video codec

AudioCodec

string

Encoding audio codec

VideoBitrate

string

Encoding video bitrate

KeyFrameInterval

string

Key-frame interval (GOP-size)

StartTimecode

object

Start timecode type

ManualTimecode

string

Manual start timecode value

Config

string

Total encoding config

Get a Preset

GET http://recording_server:9000/api/presets/{index}

Returns a full configuration of a Preset by its index

Query Parameters

Name

Type

Description

{index}

integer

sets an index of a Preset

Headers

Name

Type

Description

Authorization

string

API Token

{
  "Name": "Encoding preset #1",
  "Type": "Local File Recording",
  "Format": "MOV (QuickTime File Format)",
  "VideoCodec": "Apple ProRes 422 (HQ)",
  "AudioCodec": "AAC (Advanced Audio Coding)",
  "VideoBitrate": null,
  "KeyFrameInterval": null,
  "StartTimecode": {
    "Key": "auto",
    "Value": "Use embedded timecode"
  },
  "ManualTimecode": "00:00:00:00",
  "Config": "format='mov' start_timecode='auto' video::codec='prores' video::profile='3' audio::codec='aac' audio::profile='main'"
}

Get available encoding Formats for a Preset

GET http://recording_server:9000/api/presets/{index}/formats

Returns available encoding containers for the Preset

Query Parameters

Name

Type

Description

{index}

integer

sets an index of a Preset

Headers

Name

Type

Description

Authorization

string

API Token

[
  "MPEG Program Stream",
  "MPEG Transport Stream",
  "MP4 (MPEG-4 Part 14)",
  "MOV (QuickTime File Format)",
  "MOV DNxHD",
  "XDCAM - MPEG IMX (MPEG-4 container)",
  "MXF (Material eXchange Format)",
  "MXF D-10 (Material eXchange Format D-10 Mapping)",
  "ASF (Advanced / Active Streaming Format)",
  "AVI (Audio Video Interleaved)",
  "MKV (Matroska)"
]

Get available video codecs for a Preset

GET http://recording_server:9000/api/presets/{index}/videoCodecs

Returns video codecs available for the specified Format of the Preset

Query Parameters

Name

Type

Description

{index}

integer

sets an index of a Preset

Headers

Name

Type

Description

Authorization

string

API Token

[
  "MPEG-4 part 2 Video",
  "Cisco OpenH264 Encoder",
  "Intel QuickSync SW H.264 Encoder",
  "Intel QuickSync HW H.264 Encoder",
  "Intel QuickSync HEVC Encoder",
  "NVIDIA NVEnc H.264 Encoder",
  "NVIDIA NVEnc H.264 Lossless Encoder",
  "NVIDIA NVEnc H.265 (HEVC) Encoder",
  "MPEG-2 Video",
  "DV Video / DVCPRO-HD",
  "MJPEG (Motion JPEG)",
  "GoPro CineForm HD",
  "Vidvox Hap",
  "MPEG-1 Video",
  "Windows Media Video 8",
  "Apple ProRes proxy",
  "Apple ProRes 422 (LT)",
  "Apple ProRes 422",
  "Apple ProRes 422 (HQ)",
  "QuickTime Animation (RLE) video",
  "DPX (Digital Picture Exchange) image",
  "PNG (Portable Network Graphics) image",
  "Uncompressed 4:2:2 8bit",
  "Uncompressed 4:2:2 10bit",
  "No Video"
]

Get available audio codecs for a Preset

GET http://recording_server:9000/api/presets/{index}/audioCodecs

Returns audio codecs available for the specified Format of the Preset

Query Parameters

Name

Type

Description

{index}

integer

sets an index of a Preset

Headers

Name

Type

Description

Authorization

string

API Token

[
  "AAC (Advanced Audio Coding)",
  "MP2 (MPEG audio layer 2)",
  "MP3 Lame (MPEG audio layer 3)",
  "ATSC A/52A (AC-3)",
  "ATSC A/52 E-AC-3",
  "(Uncompressed) PCM signed 16-bit little-endian",
  "(Uncompressed) PCM signed 24-bit little-endian",
  "(Uncompressed) PCM signed 32-bit little-endian",
  "(Uncompressed) PCM 32-bit floating point little-endian",
  "ALAC (Apple Lossless Audio Codec)",
  "ADPCM IMA QuickTime",
  "ATSC A/52A (AC-3) Fixed",
  "Ogg Vorbis",
  "ADPCM Microsoft",
  "No Audio"
]

Get available Timecode options for a Preset

GET http://recording_server:9000/api/presets/{index}/timecodes

Returns a list of available start timecode values

Query Parameters

Name

Type

Description

{index}

integer

sets an index of a Preset

Headers

Name

Type

Description

Authorization

string

API Token

[
  {
    "Key": "auto",
    "Value": "Use embedded timecode"
  },
  {
    "Key": "local_time",
    "Value": "Use the system time"
  },
  {
    "Key": "00:00:00:00",
    "Value": "Manual timecode"
  },
  {
    "Key": "disabled",
    "Value": "Disable timecode"
  }
]

Get all Presets

GET http://recording_server:9000/api/presets/

Returns a list of available encoding presets

Headers

Name

Type

Description

Authorization

string

API Token

[
  {
    "Index": 0,
    "Name": "Encoding preset #1",
    "Config": "format='mov' start_timecode='auto' video::codec='prores' video::profile='3' audio::codec='aac' audio::profile='main'"
  },
  {
    "Index": 1,
    "Name": "Encoding preset #2",
    "Config": "format='mpegts' protocol='udp://' video::b='5M'"
  }
]

Remove a Preset

DELETE http://recording_server:9000/api/presets/{index}

Removes a Preset by its index

Query Parameters

Name

Type

Description

{index}

integer

Index of a Preset to be removed

Headers

Name

Type

Description

Authorization

string

API Token

PreviousDestinations NextChannels

Last updated 3 years ago