Get Channel Settings (REST)

Overview

The Channels REST API returns detailed information about all, or a single channel.

Request URL

To get information for all channels with 1 request:

    http://myserver/channels.json

To get information for a single channel:

    http://myserver/channels/<channel-id>.json
    Ex. http://myserver/channels/1.json

Return

Channel Index

http://myserver/channels.json

[
  {
    "channel": {
      "bandwidth": 20000000,
      "continuity": true,
      "continuity_as_run_enabled": false,
      "continuity_content_file_id": 1,
      "continuity_duration": 0,
      "continuity_feed_id": null,
      "continuity_input_id": null,
      "continuity_offset": 0,
      "continuity_playlist_audio_inp ut_id": null,
      "continuity_playlist_id": null,
      "continuity_playlist_randomize ": false,
      "continuity_resume": false,
      "continuity_switch_audio_input _id": null,
      "continuity_switch_input_id": null,
      "continuity_window": 0,
      "created_at": "2017-05-22T10:11:59-04:00",
      "description": "Broadcast Channel 1",
      "fast_play": 1,
      "gdp_head_end": null,
      "gdp_network_id": null,
      "id": 1,
      "ip_address": "127.0.0.1",
      "ip_interface": null,
      "ip_port": 5555,
      "ip_protocol": "UDP",
      "ip_ttl": 50,
      "ip_type": "UNICAST",
      "minerva_channel_id": null,
      "name": "Channel 1",
      "normal_switch_output_id": null,
      "osd": false,
      "pid_map_id": null,
      "play_immediate_delay": 1000,
      "pmt_table_id": 2,
      "remap": null,
      "server_id": 1,
      "server_stream_key": 0,
      "show_guide_program_details": false,
      "station_output": false,
      "stream_clone": true,
      "stream_clone_interfaces": "eth0,eth1",
      "switch_input_id": null,
      "transition_mode": 0,
      "tv_guide_station_id": "",
      "updated_at": "2017-05-22T10:14:58-04:00",
      "vmr_supported": true
    }
  },
  {
    "channel": {
      "bandwidth": 20000000,
      "continuity": false,
      "continuity_as_run_enabled": null,
      "continuity_content_file_id": null,
      "continuity_duration": 0,
      "continuity_feed_id": null,
      "continuity_input_id": null,
      "continuity_offset": 0,
      "continuity_playlist_audio_inp ut_id": null,
      "continuity_playlist_id": null,
      "continuity_playlist_randomize ": false,
      "continuity_resume": false,
      "continuity_switch_audio_input _id": null,
      "continuity_switch_input_id": null,
      "continuity_window": 0,
      "created_at": "2017-05-23T13:29:10-04:00",
      "description": "Broadcast Channel 2",
      "fast_play": 0,
      "gdp_head_end": null,
      "gdp_network_id": null,
      "id": 2,
      "ip_address": "127.0.0.1",
      "ip_interface": null,
      "ip_port": 5556,
      "ip_protocol": "UDP",
      "ip_ttl": 50,
      "ip_type": "UNICAST",
      "minerva_channel_id": null,
      "name": "Channel 2",
      "normal_switch_output_id": null,
      "osd": false,
      "pid_map_id": null,
      "play_immediate_delay": 1000,
      "pmt_table_id": 2,
      "remap": null,
      "server_id": 1,
      "server_stream_key": 1,
      "show_guide_program_details": false,
      "station_output": false,
      "stream_clone": false,
      "stream_clone_interfaces": "",
      "switch_input_id": null,
      "transition_mode": 1,
      "tv_guide_station_id": null,
      "updated_at": "2017-05-23T13:29:10-04:00",
      "vmr_supported": true
    } 
  }
]

Channel Show

http://myserver/channels/1.json
{
  "channel": {
    "bandwidth": 20000000,
    "continuity": true,
    "continuity_as_run_enabled": false,
    "continuity_content_file_id": 1,
    "continuity_duration": 0,
    "continuity_feed_id": null,
    "continuity_input_id": null,
    "continuity_offset": 0,
    "continuity_playlist_audio_input_id": null,
    "continuity_playlist_id": null,
    "continuity_playlist_randomize ": false,
    "continuity_resume": false,
    "continuity_switch_audio_input _id": null,
    "continuity_switch_input_id": null,
    "continuity_window": 0,
    "created_at": "2017-05-22T10:11:59-04:00",
    "description": "Broadcast Channel 1",
    "fast_play": 1,
    "gdp_head_end": null,
    "gdp_network_id": null,
    "id": 1,
    "ip_address": "127.0.0.1",
    "ip_interface": null,
    "ip_port": 5555,
    "ip_protocol": "UDP",
    "ip_ttl": 50,
    "ip_type": "UNICAST",
    "minerva_channel_id": null,
    "name": "Channel 1",
    "normal_switch_output_id": null,
    "osd": false,
    "pid_map_id": null,
    "play_immediate_delay": 1000,
    "pmt_table_id": 2,
    "remap": null,
    "server_id": 1,
    "server_stream_key": 0,
    "show_guide_program_details": false,
    "station_output": false,
    "stream_clone": true,
    "stream_clone_interfaces": "eth0,eth1",
    "switch_input_id": null,
    "transition_mode": 0,
    "tv_guide_station_id": "",
    "updated_at": "2017-05-22T10:14:58-04:00",
    "vmr_supported": true
  }
}
Introduced
Server Version 6.0.0

 

in HC API Channel Management

Related Articles