- Created by Ramya Raman (Unlicensed) on May 05, 2021
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
GET channels/command/unMonitor/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Stop monitoring a channel, specified by the required {id} parameter.
Resource URL
http://{host}/api/2.0/channels/command/unMonitor/{id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
id | integer | The ID of the desired channel. |
Example Request
GET
{"Task": {
"id": 595649,
"device_id": 830,
"type": "Toggle Monitoring State",
"type_id": 15,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1384692937639"
}}
GET channels/command/monitor/{id}/{dev_id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Start monitoring a channel on a specific device, specified by the required {id} and {dev_id} parameters.
Resource URL
http://{host}/api/2.0/channels/command/monitor/{id}/{dev_id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
id | integer | The ID of the desired channel. |
dev_id | integer | The ID of the target device to monitor the channel. |
Example Request
GET
{"Task": {
"id": 896170,
"device_id": 621,
"type": "Toggle Monitoring State",
"type_id": 15,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1384693062873"
}}
GET channels/command/enableRecord/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Set a specific channel to be recordable. The recording could be handled manually or by trigger event.
Resource URL
http://{host}/api/2.0/channels/command/enableRecord/{id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
id | integer | The ID of the desired channel. |
Example Request
GET
{"Task": {
"id": 615562,
"device_id": 621,
"type": "Toggle Recording Support",
"type_id": 16,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1384693453126"
}}
GET channels/command/disableRecord/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Stops a specific channel from being recordable.
Resource URL
http://{host}/api/2.0/channels/command/disableRecord/{id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
id | integer | The ID of the desired channel. |
Example Request
GET
{"Task": {
"id": 728757,
"device_id": 830,
"type": "Toggle Recording Support",
"type_id": 16,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1384693554471"
}}
GET channels/command/forceProfile/{id}/{profile_id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Force a monitored channel to use a specific profile, overriding any default and scheduled profile changes. Also used to release a channel from a forced profile.
Resource URL
http://{host}/api/2.0/channels/command/forceProfile/{id}/{profile_id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
id | integer | The ID of the desired channel. |
profile_id | other | Values may be either an Integer profile ID to force that profile or "false" to release the channel. |
Example Request
GET
{"Task": {
"id": 357097,
"device_id": 621,
"type": "Force Profile",
"type_id": 13,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1384693754780"
}}
GET channels/command/startRecord/{ch_id}/{agent_id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Start recording the channel. The recording will continue until "stopRecord" action is sent or record timeout limit reached.
Resource URL
http://{host}/api/2.0/channels/command/startRecord/{ch_id}/{agent_id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
ch_id | integer | The ID of the desired channel. |
agent_id | integer | The ID of the file agent to be used for this record action. |
Example Request
GET
{"Task": {
"id": 334798,
"device_id": 630,
"type": "Toggle Recording",
"type_id": 18,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1384694509515"
}}
GET channels/command/stopRecord/{ch_id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Stops the recording task on this channel.
Resource URL
http://{host}/api/2.0/channels/command/stopRecord/{ch_id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
ch_id | integer | The ID of the currently recording channel. |
Example Request
GET
{"Task": {
"id": 334798,
"device_id": 630,
"type": "Toggle Recording",
"type_id": 18,
"mode": "Canceling",
"mode_id": 3,
"status": "",
"description": "",
"total": 100,
"completed": 15,
"time_remained": 105,
"modified": "1384694525052"
}}
GET channels/command/setSnooze/{id}/{remark}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Set Snooze on channel, disabling error notifications till snooze is cleared.
Resource URL
http://{host}/api/2.0/channels/command/setSnooze/{id}/{remark}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
id | integer | The ID of the desired channel. |
remark | string | The string to use as a remark. |
Example Request
GET
http://192.168.0.101/api/2.0/channels/command/setSnooze/1/this is a snooze remark/.json
{"ChannelStatistics": {
"id": 1,
"is_snoozed": 1,
"snooze_remark": "this is a snooze remark",
"title": "Ch 1",
"uuid": null,
"ip_address": "225.0.5.1",
"ssm_ip_address": null,
"port": 2000,
"network_id": 3,
"iface": "eth0",
"program_number": 1,
"ts_id": 2,
"total_bit_rate": 0,
"null_padding_count": null,
"mux_bitrate_by_pcr": null,
"mux_bitrate_by_time": null,
"cc_errors": 0,
"source_address": "",
"service_type_id": 1,
"device_id": 621,
"is_record_enabled": 1,
"highest_active_event_severity_id": 2,
"clock": null,
"ChannelProfile": [ {
"id": 1,
"title": "default",
"notification_set_id": 1,
"event_rule_set_id": 1,
"is_default": 1,
"is_scanned": 0,
"is_active": 1,
"is_forced": 0,
"is_scrambled": 0
}],
"ChannelPidStatistics": [],
"modified": "1384695051231"
}}
GET channels/command/clearSnooze/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Clears the Snooze state from a channel.
Resource URL
http://{host}/api/2.0/channels/command/clearSnooze/{id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
is | integer | The ID of the desired channel. |
Example Request
GET
{"ChannelStatistics": {
"id": 1,
"is_snoozed": 0,
"snooze_remark": null,
"title": "Ch 1",
"uuid": null,
"ip_address": "225.0.5.1",
"ssm_ip_address": null,
"port": 2000,
"network_id": 3,
"iface": "eth1",
"program_number": 1,
"ts_id": 2,
"total_bit_rate": 1860718,
"null_padding_count": 617619,
"mux_bitrate_by_pcr": 13270594,
"mux_bitrate_by_time": 13075190,
"cc_errors": 0,
"source_address": "192.168.0.98:17035",
"service_type_id": 1,
"device_id": 621,
"is_record_enabled": 1,
"highest_active_event_severity_id": 1,
"clock": "Jitter 28.24ms, Interval 35ms",
"ChannelProfile": [ {
"id": 1,
"title": "default",
"notification_set_id": 1,
"event_rule_set_id": 1,
"is_default": 1,
"is_scanned": 0,
"is_active": 1,
"is_forced": 0,
"is_scrambled": 0
}],
"ChannelPidStatistics": [
{
"content_type": "PAT",
"pid": 0,
"cc_errors": 0,
"bitrate": 24402,
"is_scrambled": 0,
"parent_pid": null,
"ChannelPidStatisticsDescriptors": [ {
"id": 401,
"type": "Content",
"value": "PAT"
}]
},
{
"content_type": "NIT",
"pid": 16,
"cc_errors": 0,
"bitrate": 3050,
"is_scrambled": 0,
"parent_pid": null,
"ChannelPidStatisticsDescriptors": [
{
"id": 401,
"type": "Content",
"value": "NIT"
},
{
"id": 508,
"type": "Network Name",
"value": "Harashut Hashnia"
}
]
},
{
"content_type": "SDT",
"pid": 17,
"cc_errors": 0,
"bitrate": 4575,
"is_scrambled": 0,
"parent_pid": null,
"ChannelPidStatisticsDescriptors": [
{
"id": 401,
"type": "Content",
"value": "SDT"
},
{
"id": 328,
"type": "Service Provider",
"value": "Idan +"
},
{
"id": 329,
"type": "Service Name",
"value": "Ch 1"
}
]
},
{
"content_type": "EIT",
"pid": 18,
"cc_errors": 0,
"bitrate": 175395,
"is_scrambled": 0,
"parent_pid": null,
"ChannelPidStatisticsDescriptors": [
{
"id": 401,
"type": "Content",
"value": "EIT"
},
{
"id": 77,
"type": "Short event",
"value": "17/11/2013 13:59:00 (00:03:00) שגית המושג"
},
{
"id": 77,
"type": "Short event",
"value": "17/11/2013 13:35:00 (00:24:00) האחים דה גמ"
},
{
"id": 77,
"type": "Short event",
"value": "17/11/2013 13:30:00 (00:05:00) מלמולים עו"
}
]
},
{
"content_type": "TDT",
"pid": 20,
"cc_errors": 0,
"bitrate": 3050,
"is_scrambled": 0,
"parent_pid": null,
"ChannelPidStatisticsDescriptors": [ {
"id": 401,
"type": "Content",
"value": "TDT"
}]
},
{
"content_type": "Subtitles",
"pid": 1025,
"cc_errors": 0,
"bitrate": 3050,
"is_scrambled": 0,
"parent_pid": 2560,
"ChannelPidStatisticsDescriptors": [
{
"id": 401,
"type": "Content",
"value": "Subtitles"
},
{
"id": 10,
"type": "Language",
"value": "heb"
}
],
"is_pcr": 0,
"language": "heb"
},
{
"content_type": "PMT",
"pid": 2560,
"cc_errors": 0,
"bitrate": 22877,
"is_scrambled": 0,
"parent_pid": null,
"ChannelPidStatisticsDescriptors": [
{
"id": 401,
"type": "Content",
"value": "PMT"
},
{
"id": 509,
"type": "PCR",
"value": "Jitter 28.24ms, Interval 35ms"
}
]
},
{
"content_type": "Video",
"pid": 2561,
"cc_errors": 0,
"bitrate": 1779885,
"is_scrambled": 0,
"parent_pid": 2560,
"ChannelPidStatisticsDescriptors": [
{
"id": 400,
"type": "Encoding",
"value": "H.264"
},
{
"id": 401,
"type": "Content",
"value": "Video"
},
{
"id": 505,
"type": "Frame Rate",
"value": "25.000"
},
{
"id": 500,
"type": "Resolution",
"value": "720x576i"
},
{
"id": 503,
"type": "Aspect Ratio",
"value": "4:3 SAR 1.09 DAR 1.36"
},
{
"id": 501,
"type": "Color Space",
"value": "YUV420"
},
{
"id": 504,
"type": "Profile@Level",
"value": "MP@3.0"
}
],
"payload_type": "H.264",
"is_pcr": 1
},
{
"content_type": "Audio",
"pid": 2562,
"cc_errors": 0,
"bitrate": 54906,
"is_scrambled": 0,
"parent_pid": 2560,
"ChannelPidStatisticsDescriptors": [
{
"id": 400,
"type": "Encoding",
"value": "LATM/HE-AAC"
},
{
"id": 401,
"type": "Content",
"value": "Audio"
},
{
"id": 510,
"type": "Channels",
"value": "2"
}
],
"payload_type": "LATM/HE-AAC",
"is_pcr": 0
}
],
"modified": "1384695423234"
}}
- No labels