NAV Navbar
  • Authorization
  • Server
  • Tasks (channels)
  • Outputs
  • Video templates
  • Audio templates
  • Overlays
  • Authorization

    Authorize

    Authorise on the transcoder.

    URL

    api/1/user/auth
    

    Success Response (writing access):

    { result : 1, read_only : 0 }   
    

    Success Response (read-only):

    { result : 1, read_only : 0 }   
    

    Error Response:

    { result : 0, error : "wrong login or password" }
    

    POST

    None

    parameter type required
    login [string] required
    password [string] required

    Check authorized

    Check if user session is valid

    URL

      api/1/user/authorized
    

    Success Response (writing access):

    { result : 1, read_only : 0 }
    

    Success Response (read only)

    { result : 1, read_only : 1 }
    

    Error Response:

    { result : 0, error : "expired session" }
    

    POST OR GET

    None

    None

    Change password

    Change user's password.

    URL

    api/1/user/change_pass
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "expired session" }
    

    POST

    None

    parameter type required
    current_password [string] required
    new_password [string] required

    Get users list

    Get list of users.

    URL

    api/1/user/get_list
    

    Success Response:

    {"result":1,"users":[{"id":0,"name":"Admin","read_only":0}]}
    

    Error Response:

    { result : 0, error : "expired session" }
    

    POST OR GET

    None

    None

    Get user

    Get single user description.

    URL:

    api/1/user/get/{user_id}
    

    Success Response:

    {"result":1,"user":{"id":0,"name":"Admin","read_only":0}}
    

    Error Response:

    { result : 0, error : "expired session" }
    

    POST OR GET

    parameter type required
    {user_id} integer required

    None

    Update user

    Update user account settings.

    URL:

    api/1/user/update
    

    Success Response:

    {"result":1}
    

    Error Response:

    { result : 0, error : "expired session" }
    

    POST

    None

    parameter type required default
    user_id [integer] required
    name [string] required
    password [string] required
    read_only [integer(1/0)] optional 0

    Delete user

    Delete user account.

    URL:

    api/1/user/delete
    

    Success Response:

    {"result":1}
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required
    user_id [integer] required

    Server

    Ping server

    Check if server alive and responding to API calls.

    URL:

    api/1/ping
    

    Success Response:

    {"result":1}
    

    Error Response:

    Code: 404   
    

    POST OR GET

    None

    None

    Get transcoder information

    Get transcoder description and basic stat information.

    URL:

    api/1/server/info
    

    Success Response:

    {"result":1,"serverInfo":{"ActiveOutputStreams":0,"BuildDate":"01.09.2017 15:30:15","CPULoad":37,"DVBTunersCount":0,"FailedChannels":0,"GPULoad":3,"Id":"89c73b92-3aa9-4901-957a-8682e6b6e745","MemoryUsage":9208,"Time":"\/Date(1504457174860)\/","TotalChannels":3,"TotalInputBitrate":"0,00","TotalOutputBitrate":"0,00","TotalOutputStreams":7,"TranscodingChannels":0,"Uptime":1046,"VersionName":"2.4.3"}}
    

    Error Response:

    { result : 0, error : "expired session" }
    

    POST OR GET

    None

    None

    Get transcoder version

    Get transcoder firmware version.

    URL:

    api/1/server/version
    

    Success Response:

    {"result":"01.09.2017 15:30:15"}
    

    Error Response:

    Code: 404   
    

    POST OR GET

    None

    None

    Get events

    Get last events cache.

    URL:

    api/1/server/events/cache
    

    Success Response:

    {"result":1,"LastItemTicks":636400549787307977,"Log":[{"date":"\/Date(1504458163082)\/","description":"app started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458163121)\/","description":"app started in Host mode","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458163666)\/","description":"task 0 autostart disabled","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458163674)\/","description":"task 1 autostart disabled","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458163678)\/","description":"task 2 autostart disabled","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458163694)\/","description":"http:\/\/localhost:80\/input host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458163710)\/","description":"installed features [release]: none","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458163711)\/","description":"http:\/\/localhost:80\/output host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458163728)\/","description":"http:\/\/localhost:80\/internal host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458163738)\/","description":"http:\/\/localhost:80\/proxy host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458164121)\/","description":"http:\/\/localhost:80\/api\/1\/ host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458164129)\/","description":"http:\/\/localhost:80\/api\/1\/enumeration host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458164142)\/","description":"http:\/\/localhost:80\/ host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458164154)\/","description":"http:\/\/localhost:80\/settings host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458164162)\/","description":"http:\/\/localhost:80\/update host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458164178)\/","description":"http:\/\/localhost:80\/httpproxy host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458164186)\/","description":"http:\/\/localhost:80\/rpc host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458164198)\/","description":"http:\/\/localhost:80\/analyzer host started","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458173764)\/","description":"The remote server returned an error: (404) Not Found.","moduleName":null,"processID":null,"severity":30,"source":"sys"},{"date":"\/Date(1504458173776)\/","description":"Watcher process is not responding, checking again","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458174787)\/","description":"The remote server returned an error: (404) Not Found.","moduleName":null,"processID":null,"severity":30,"source":"sys"},{"date":"\/Date(1504458174807)\/","description":"Watcher process is not responding, checking again","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458175826)\/","description":"The remote server returned an error: (404) Not Found.","moduleName":null,"processID":null,"severity":30,"source":"sys"},{"date":"\/Date(1504458175843)\/","description":"Watcher process is not responding, checking again","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458175879)\/","description":"user action: login","moduleName":"","processID":null,"severity":10,"source":"Admin"},{"date":"\/Date(1504458176860)\/","description":"The remote server returned an error: (404) Not Found.","moduleName":null,"processID":null,"severity":30,"source":"sys"},{"date":"\/Date(1504458176868)\/","description":"Watcher process is not responding, checking again","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458177904)\/","description":"The remote server returned an error: (404) Not Found.","moduleName":null,"processID":null,"severity":30,"source":"sys"},{"date":"\/Date(1504458177923)\/","description":"Watcher process is not responding, checking again","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458178936)\/","description":"The remote server returned an error: (404) Not Found.","moduleName":null,"processID":null,"severity":30,"source":"sys"},{"date":"\/Date(1504458178944)\/","description":"Watcher process seems to be down, restarting it","moduleName":null,"processID":null,"severity":10,"source":"sys"},{"date":"\/Date(1504458178728)\/","description":"checking channels...","moduleName":"watcher","processID":null,"severity":0,"source":"sys"},{"date":"\/Date(1504458178729)\/","description":"all channels are checked","moduleName":"watcher","processID":null,"severity":0,"source":"sys"},{"date":"\/Date(1504458178730)\/","description":"watcher is alive","moduleName":"watcher","processID":null,"severity":0,"source":"sys"}],"total_count":34,"total_count_by_severity":[{"severity":0,"count":3},{"severity":10,"count":25},{"severity":20,"count":0},{"severity":30,"count":6}]}  
    

    Error Response:

    { result : 0, error : "expired session" }
    

    POST (with params) OR GET (without params)

    None

    parameter type required description
    host [string] optional filter by host field
    min_severity [integer] optional default = 0, filter by minimal severity
    hostedObject [string] optional filter by hosted object field
    processID [string] optional filter by processID field
    since [long_integer] optional filter by date ticks field
    interval [long_integer] optional filter by [date, date + interval]
    skip [integer] optional skip N items
    limit [integer] optional limit to N items at the response
    reverse [integer(1/0)] optional reverse the items order at the response
    search [string] optional returns only the items which include the search string

    Tasks (channels)

    Get channels list

    Get transcoding tasks list.

    URL:

    api/1/channel/get_list
    

    Success Response:

    {"result":1,"channels":[{"audio_codec":"","audio_gain":0,"autostart_enabled":false,"backup_d_pid":[0],"backup_enabled":0,"backup_s_pid":["4294967295"],"backup_sdi_mode":"NTSC","backup_service_id":4294967295,"backup_v_pid":["4294967295"],"channel_id":0,"crop":"0","d_pid":[0],"enableCCPassthrough":1,"health":"down","interlace_mode":"auto","name":"DXD","pip_channels":[],"s_pid":["4294967295"],"sdi_mode":"HD1080i50","service_id":4294967295,"source_address":"playout_source\\playout.txt","source_backup_address":"","source_backup_port":3100,"source_backup_protocol":"udp","source_port":5000,"source_protocol":"tsplayout","state":"stopped","task_progress":0,"uptime_seconds":0,"v_pid":["4294967295"],"video_codec":""},{"audio_codec":"","audio_gain":0,"autostart_enabled":false,"backup_d_pid":[0],"backup_enabled":0,"backup_s_pid":["4294967295"],"backup_sdi_mode":"HD1080i50","backup_service_id":1,"backup_v_pid":["4294967295"],"channel_id":1,"crop":"0","d_pid":[0],"enableCCPassthrough":1,"health":"down","interlace_mode":"auto","name":"test","pip_channels":[],"s_pid":["4294967295"],"sdi_mode":"HD1080i50","service_id":4294967295,"source_address":"\test_cases\\6ch.ts","source_backup_address":"","source_backup_port":0,"source_backup_protocol":"file2live","source_port":0,"source_protocol":"file2live","state":"stopped","task_progress":0,"uptime_seconds":0,"v_pid":["4294967295"],"video_codec":""},{"audio_codec":"","audio_gain":0,"autostart_enabled":false,"backup_d_pid":[0],"backup_enabled":0,"backup_s_pid":["4294967295"],"backup_sdi_mode":"HD1080i50","backup_service_id":4294967295,"backup_v_pid":["4294967295"],"channel_id":2,"crop":"0","d_pid":[0],"enableCCPassthrough":0,"health":"down","interlace_mode":"auto","name":"rtmp input test","pip_channels":[],"s_pid":["4294967295"],"sdi_mode":"HD1080i50","service_id":4294967295,"source_address":"rtmp:\/\/5.131.132.60:1935\/tv10\/xetero","source_backup_address":"","source_backup_port":0,"source_backup_protocol":"rtmp","source_port":0,"source_protocol":"rtmp","state":"stopped","task_progress":0,"uptime_seconds":0,"v_pid":["4294967295"],"video_codec":""}],"total_count":3}
    

    Error Response:

    { result : 0, error : "expired session" }
    

    POST OR GET

    None

    None

    Add channel

    Add new transcoding task.

    URL:

    api/1/channel/add
    

    Success Response:

    { result : 1, channel_id : 42 }
    

    Error Response:

    { result : 0, error : "required parameter name is missing" }
    

    POST

    None

    parameter type required default
    name [string] required
    source_address [string] optional
    source_backup_address [string] optional
    source_port [integer] optional 80
    source_protocol [string] required
    v_pid[] [array of integer] optional
    s_pid[] [array of integer] optional
    d_pid[] [array of integer] optional
    service_id [integer] optional
    audio_gain [double] optional
    source_backup_port [integer] optional
    source_backup_protocol [string] optional
    backup_v_pid[] [array of integer] optional
    backup_s_pid[] [array of integer] optional
    backup_d_pid[] [array of integer] optional
    backup_service_id [integer] optional
    backup_enabled [integer(1/0)] optional 0
    crop [integer] optional 0
    sdi_mode [string] optional
    backup_sdi_mode [string] optional
    interlace_mode [string] optional auto
    enableCCPassthrough [integer(1/0)] optional 0

    Update channel

    Update transcoding task.

    URL:

    api/1/channel/update
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required default
    channel_id [integer] required
    name [string] required
    source_address [string] optional
    source_backup_address [string] optional
    source_port [integer] optional 80
    source_protocol [string] required
    v_pid[] [array of integer] optional
    s_pid[] [array of integer] optional
    d_pid[] [array of integer] optional
    service_id [integer] optional
    audio_gain [double] optional
    source_backup_port [integer] optional
    source_backup_protocol [string] optional
    backup_v_pid[] [array of integer] optional
    backup_s_pid[] [array of integer] optional
    backup_d_pid[] [array of integer] optional
    backup_service_id [integer] optional
    backup_enabled [integer(1/0)] optional 0
    crop [integer] optional 0
    sdi_mode [string] optional
    backup_sdi_mode [string] optional
    interlace_mode [string] optional auto
    enableCCPassthrough [integer(1/0)] optional 0

    Delete channel

    Delete transcoding task.

    URL:

    api/1/channel/delete
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "database error" }
    

    POST

    None

    parameter type required
    channel_id [integer] required

    Start channel

    Start transcoding task.

    URL:

    api/1/channel/start
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "no gpu available" }
    

    POST

    None

    parameter type required
    channel_id [integer] required

    Stop channel

    Stop transcoding task.

    URL:

    api/1/channel/stop
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required
    channel_id [integer] required

    Start all channels

    Start all transcoding tasks.

    URL:

    api/1/channel/start/all
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "no gpu available" }
    

    POST

    None

    None

    Stop all channels

    Stop all transcoding tasks.

    URL:

    api/1/channel/stop/all
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "database error" }
    

    POST

    None

    None

    Get channel state

    Get state of the transcoding task.

    URL:

    api/1/channel/state
    

    Success Response:

    { result : "transcoding", health : "up", task_progress : 75}
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required
    channel_id [integer] required

    Outputs

    Get outputs list

    Get list of output streams.

    URL:

    api/1/output/get_list
    

    Success Response:

    {"result":1,"outputs":[{"audio_template_id":0,"autostart":1,"channel_id":0,"channel_name":"DXD","content_id":"123456","description":"","enabled":0,"format":"dash","format_specific_settings":"-UseTimeline true","key_provider":"widevinecenc","key_provider_url":"http:\/\/license.uat.widevine.com\/cenc\/getcontentkey\/widevine_test","key_request_interval":10,"output_id":1,"output_url":"http:\/\/localhost\/input\/testdash","output_url_full":"http:\/\/localhost\/input\/testdash\/output.mpd","running":0,"segment_size":4,"template_id":9},"total_count":1}
    

    Error Response:

    { result : 0, error : "database error" }
    

    POST OR GET

    None

    None

    Add output

    Add output stream.

    URL:

    api/1/output/add
    

    Success Response:

    { result : 1, output_id: 42}
    

    Error Response:

    { result : 0, error : "required parameter expected: channel_id" }
    

    POST

    None

    parameter type required default
    channel_id [integer] required
    template_id [integer] required
    audio_template_id [integer] required
    format [string] required
    segment_size [integer] required
    output_url [string] required
    key_provider [string] optional
    key_provider_url [string] optional
    content_id [string] optional
    autostart [integer(1/0)] optional 1
    description [string] optional
    format_specific_settings [string] optional

    Update output

    Update output stream.

    URL:

    api/1/output/update
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "required parameter expected: output_id" }
    

    POST

    None

    parameter type required default
    output_id [integer] required
    channel_id [integer] required
    template_id [integer] required
    audio_template_id [integer] required
    format [string] required
    segment_size [integer] required
    output_url [string] required
    key_provider [string] optional
    key_provider_url [string] optional
    content_id [string] optional
    autostart [integer(1/0)] optional 1
    description [string] optional
    format_specific_settings [string] optional

    Enable output

    Enable output stream.

    URL:

    api/1/output/enable
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required
    output_id [integer] required
    enable [integer(1/0) required

    Toggle output

    Start/stop output stream.

    URL:

    api/1/output/toggle
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required default
    output_id [integer] required
    start [integer(1/0) optional NOT running_now

    Delete output

    Delete output stream.

    URL:

    api/1/output/delete
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "database error" }
    

    POST

    None

    parameter type required
    output_id [integer] required

    Video templates

    Get video templates list

    Get list of video transcoder templates.

    URL:

    api/1/output/get_list
    

    Success Response:

    {"result":1,"templates":[{"codec":"H264","description":"","ext_id":-1,"name":"SD wide","streams":[{"aspect_ratio":"letterboxing","b_frames_count":0,"bitrate":600,"codec_level":"3","codec_profile":"base","deinterlace":1,"deinterlace_algorithm":"BOB","gop_length":120,"hrd_buffer_length":0,"hrd_conformance":1,"hrd_initial_delay":0,"hw_acceleration":1,"idr_interval":0,"look_ahead_depth":0,"optimization":"7","rate_control_method":"CBR","ref_frames_number":1,"resolution":"480x270","show_logo":0,"slice_count":0,"stream_id":5,"target_fps":30,"template_id":1,"use_look_ahead":0},{"aspect_ratio":"letterboxing","b_frames_count":0,"bitrate":1200,"codec_level":"3","codec_profile":"base","deinterlace":1,"deinterlace_algorithm":"BOB","gop_length":120,"hrd_buffer_length":0,"hrd_conformance":1,"hrd_initial_delay":0,"hw_acceleration":1,"idr_interval":0,"look_ahead_depth":0,"optimization":"7","rate_control_method":"CBR","ref_frames_number":1,"resolution":"720x404","show_logo":0,"slice_count":0,"stream_id":6,"target_fps":30,"template_id":1,"use_look_ahead":0},{"aspect_ratio":"letterboxing","b_frames_count":0,"bitrate":2000,"codec_level":"3","codec_profile":"base","deinterlace":1,"deinterlace_algorithm":"BOB","gop_length":120,"hrd_buffer_length":0,"hrd_conformance":1,"hrd_initial_delay":0,"hw_acceleration":1,"idr_interval":0,"look_ahead_depth":0,"optimization":"7","rate_control_method":"CBR","ref_frames_number":1,"resolution":"720x404","show_logo":0,"slice_count":0,"stream_id":7,"target_fps":30,"template_id":1,"use_look_ahead":0}],"template_id":1,"version":""}]}
    

    Error Response:

    { result : 0, error : "database error" }
    

    POST OR GET

    None

    None

    Add template

    Add video transcoder template.

    URL:

    api/1/template/add
    

    Success Response:

    { result : 1, template_id: 42}
    

    Error Response:

    { result : 0, error : "required parameter expected: name" }
    

    POST

    None

    parameter type required default
    name [string] required
    codec [string] optional H264
    version [string] optional
    description [string] optional

    Add video transcoding template stream

    Add video transcoder template stream.

    URL:

    api/1/template/stream/add
    

    Success Response:

    { result : 1, stream_id: 42}
    

    Error Response:

    { result : 0, error : "required parameter expected: bitrate" }
    

    POST

    None

    parameter type required default description
    template_id [integer] required
    resolution [string] required example: 720x576
    bitrate [integer] required KBits
    deinterlace [integer(1/0)] required
    hw_acceleration [integer(1/0)] required always 1
    show_logo [integer(1/0)] required always 0
    optimization [string] optional best speed
    codec_profile [string] optional base
    codec_level [string] optional 3
    aspect_ratio [string] optional source
    rate_control_method [string] optional CBR
    slice_count [integer] optional
    gop_length [integer] optional 100
    b_frames_count [integer] optional 0
    idr_interval [integer] optional 0
    ref_frames_number [integer] optional 1
    hrd_conformance [integer(1/0)] optional 1
    hrd_buffer_length [integer] optional
    hrd_initial_delay [integer] optional
    use_look_ahead [integer(1/0)] optional 0
    look_ahead_depth [integer] optional
    deinterlace_algorithm [string(BOB/ADVANCED] optional BOB

    Update template

    Update video transcoder template.

    URL:

    api/1/template/update
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "database error" }
    

    POST

    None

    parameter type required default
    template_id [integer] required
    name [string] required
    codec [string] optional H264
    version [string] optional
    description [string] optional

    Update video transcoding template stream

    Update video transcoder template stream.

    URL:

    api/1/template/stream/update
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "required parameter expected: bitrate" }
    

    POST

    None

    parameter type required default description
    stream_id [integer] required
    template_id [integer] required
    resolution [string] required example: 720x576
    bitrate [integer] required KBits
    deinterlace [integer(1/0)] required
    hw_acceleration [integer(1/0)] required always 1
    show_logo [integer(1/0)] required always 0
    optimization [string] optional best speed
    codec_profile [string] optional base
    codec_level [string] optional 3
    aspect_ratio [string] optional source
    rate_control_method [string] optional CBR
    slice_count [integer] optional
    gop_length [integer] optional 100
    b_frames_count [integer] optional 0
    idr_interval [integer] optional 0
    ref_frames_number [integer] optional 1
    hrd_conformance [integer(1/0)] optional 1
    hrd_buffer_length [integer] optional
    hrd_initial_delay [integer] optional
    use_look_ahead [integer(1/0)] optional 0
    look_ahead_depth [integer] optional
    deinterlace_algorithm [string(BOB/ADVANCED] optional BOB

    Delete video transcoding template stream

    Update video transcoder template stream.

    URL:

    api/1/template/stream/delete
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required
    stream_id [integer] required

    Delete template

    Delete video transcoder template.

    URL:

    api/1/template/delete
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "database error" }
    

    POST

    None

    parameter type required
    template_id [integer] required

    Audio templates

    Get audio transcoder templates list

    Get list of audio transcoder templates.

    URL:

    api/1/audio/template/get_list
    

    Success Response:

    {"result":1,"templates":[{"bitrate":64,"codec":"AACPLUS","description":"","ext_id":-1,"name":"AAC PLUS 64","sample_rate":44100,"template_id":0,"version":""},{"bitrate":64,"codec":"mp2","description":"","ext_id":-1,"name":"mp2","sample_rate":44100,"template_id":1,"version":""},{"bitrate":0,"codec":"passthrough","description":"","ext_id":-1,"name":"Passthrough","sample_rate":0,"template_id":2,"version":""}]}
    

    Error Response:

    { result : 0, error : "database error" }
    

    POST OR GET

    None

    None

    Add audio template

    Add audio transcoder template.

    URL:

    api/1/audio/template/add
    
    

    Success Response:

    { result : 1, template_id: 42}
    

    Error Response:

    { result : 0, error : "required parameter expected: bitrate" }
    

    POST

    None

    parameter type required
    name [string] required
    codec [string] required
    sample_rate [integer] required
    bitrate [integer] required
    version [string] optional
    description[string] optional

    Update audio template

    Update audio transcoder template.

    URL:

    api/1/audio/template/update
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required
    template_id [integer] required
    name [string] required
    codec [string] required
    sample_rate [integer] required
    bitrate [integer] required
    version [string] optional
    description[string] optional

    Delete audio template

    Delete audio transcoder template.

    URL:

    api/1/audio/template/delete
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required
    template_id [integer] required

    Overlays

    Get overlays

    Get list of video overlays.

    URL:

    api/1/audio/overlay/get_list
    

    Success Response:

    {"result":1,"overlays":[{"channel_id":2,"font_size":12,"image_overlay_source_url":"http:\/\/example.com\/logo.png","luma_only":0,"name":"logo","overlay_id":0,"position":"700x300","size":"50x50","text_flipping_interval_seconds":1,"text_overlay_source_url":"","type":"image","video_overlay_source_channel_id":2}]}
    

    Error Response:

    { result : 0, error : "database error" }
    

    POST OR GET

    None

    None

    Add overlay

    Add video transcoder overlay.

    URL:

    api/1/overlay/add
    

    Success Response:

    { result : 1, overlay_id: 42}
    

    Error Response:

    { result : 0, error : "required parameter expected: channel_id" }
    

    POST

    None

    parameter type required default description
    channel_id [integer] required
    name [string] optional
    video_overlay_source_channel_id [string] required for video type overlays, optional for other overlay types
    position [string] optional 0x0 example: 100x20
    size [string] optional 0x0 example: 720x576
    type [string(video/text/image)] optional video
    image_overlay_source_url [string] optional
    text_overlay_source_url [string] optional
    luma_only [integer(1/0)] optional 0
    text_flipping_interval_seconds [integer] optional 1
    font_size [integer] optional default = 12

    Update overlay

    Update video transcoder overlay.

    URL:

    api/1/overlay/update
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "required parameter expected: channel_id" }
    

    POST

    None

    parameter type required default description
    overlay_id [integer] required
    channel_id [integer] required
    name [string] optional
    video_overlay_source_channel_id [string] required for video type overlays, optional for other overlay types
    position [string] optional 0x0 example: 100x20
    size [string] optional 0x0 example: 720x576
    type [string(video/text/image)] optional video
    image_overlay_source_url [string] optional
    text_overlay_source_url [string] optional
    luma_only [integer(1/0)] optional 0
    text_flipping_interval_seconds [integer] optional 1
    font_size [integer] optional default = 12

    Delete overlay

    Delete video transcoder overlay.

    URL:

    api/1/overlay/delete
    

    Success Response:

    { result : 1 }
    

    Error Response:

    { result : 0, error : "wrong item id" }
    

    POST

    None

    parameter type required
    overlay_id [integer] required