Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

API URL Structure

GET http://{host}/api/4.0/channels/config/.json

GET http://{host}/api/4.0/channels/config/{channel_uuid}/.json


Would retrieve a list/specific channels and their associated data structure.

The "output_id" can be used with either the internal id ("id") or with user defined id ("uuid") - both would be used as a unique identifier.


Returned data structure

[
{
"Channel":{
"uuid":"2ec0e46b-00b0-418a-8409-5767e815ac41",
"label":"Test", "modified":"1556870207425", "created":"1554694024231",
"access_type":"Uncompressed", "snooze_on_profile_change":10, "service_type":"HD Video", "enabled":true, "device_id":1311,
"Profiles":[
{
"label":"Default",
"uuid":"f96c58e4-4a16-400c-812a-fd0f9f83c32d", "notification_set_uuid":"814c8eeb-0ff1-410f-9f3f-6061087b329c", "notification_set_label":"default", "threshold_set_uuid":"9b2f56e7-ab70-4a42-a32b-de22709ae5da", "threshold_set_label":"default",
"is_default":true, "title_color":"Default", "border_color":"Default", "pixelate_level":"None", "Receivers":[
{
"uuid":"171d5c80-7fff-4c23-9383-46503eb1c63e", "stream_type":"2110-20",
"enabled":true, "color_space":null, "resolution":"1920x1080", "frame_rate":"30fps", "aspect_ratio":"16:9", "network":[
{
"interface_ip":"192.168.200.15", "multicast_ip":"232.105.26.177", "source_ip":"232.105.26.177", "multicast_port":5000

"multicast_ip":"232.105.26.178", "multicast_port":5000
},
{
"interface_ip":"192.168.201.15", "multicast_ip":"232.105.26.178", "multicast_port":5000
}
]
},
{
"uuid":"2348f537-dbc7-42c6-93ab-f4c47bd74b9d", "stream_type":"2110-30",
"enabled":true, "bit_per_sample":"16 bit", "channel_mapping":"5.1+2", "network":[
{
"interface_ip":"192.168.200.15", "multicast_ip":"232.105.26.179", "multicast_port":5000
},
{
"interface_ip":"192.168.201.15", "multicast_ip":"232.105.26.179", "multicast_port":5000
}
]
}
]
}
]
}
}
]

},
{
"interface_ip":"192.168.201.15", "multicast_ip":"232.105.26.177", "source_ip":"232.105.26.178", "multicast_port":5000
}
]
},
{
"uuid":"af0b8425-96b4-4e1f-9c35-6d5763d5707f",

"stream_type":"2110-30",
"enabled":true,

"bit_per_sample":"16 bit",

"channel_mapping":"5.1+2",

"network":[
{
"interface_ip":"192.168.200.15",
"multicast_ip":"232.105.26.178",
"multicast_port":5000
},
{
"interface_ip":"192.168.201.15",
"multicast_ip":"232.105.26.178",
"multicast_port":5000
}
]
},
{
"uuid":"2348f537-dbc7-42c6-93ab-f4c47bd74b9d",
"stream_type":"2110-30",
"enabled":true,
"bit_per_sample":"16 bit",
"channel_mapping":"5.1+2",
"network":[
{
"interface_ip":"192.168.200.15",

"multicast_ip":"232.105.26.179",

"multicast_port":5000
},
{
"interface_ip":"192.168.201.15",

"multicast_ip":"232.105.26.179",

"multicast_port":5000
}
]
}
]
}
]
}
}
]


DataFields

Field

TypeDescription

Channel:uuid

UUID

Parent channel identifier

Channel:Profiles:Receivers:uuid

UUID

Receiver essence identifier

Channel:Profiles:Receivers:stream_type

Enum:String

Receiver type out of 21110-10/21110-20/21110-30/MPEG-TS

Channel:Profiles:Receivers:network:interface_ip

IP

Interface IP from which the stream would be joined

Channel:Profiles:Receivers:network:multicast_ip

IP

Source stream multicast address

Channel:Profiles:Receivers:network:multicast_port

Port

Source stream multicast port

Channel:Profiles:Receivers:network:source_ip

IP

Source IP address for SSM based IGMP

  • No labels