ADDER Infinity User Manual page 65

create_channel
This method was last updated in API version 4, and is compatible with API requests from
version 4 onwards.
This function creates a new channel. The API user must have admin privileges to call this
method successfully.
Note that, although the source device ID inputs are each optional, at least one is
required.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- name (the display name for the new channel)
- desc (the display description for the new channel. Optional, default is empty.)
- loc (the display location for the new channel. Optional, default is empty.)
- allowed (the permitted connection modes for the channel. Optional; if omitted, the
global setting will be inherited. Permitted values are:
v - video-only
vs - video-only and shared
s - shared only
e - private only
vse - any mode allowed)
- video1 (device ID of video source 1. Optional, default is empty.)
- video1head (video head number for source 1. Optional, default is 1.)
- video2 (device ID of video source 2. Optional, default is empty.)
- video2head (video head number for source 2. Optional, default is 1.)
- audio (device ID of the audio source. Optional, default is empty.)
- usb (device ID of the usb source. Optional, default is empty.)
- serial (device ID of the serial source. Optional, default is empty.)
- groupname (the name of a channel group of which the created channel will be a
member. Optional, default is empty.)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
- id (the ID of the new channel, if it was created)
Examples
Input:
/api/?v=4&method=create_channel&token=xxxxx&name=my_channel&video1=21&audio
=81&groupname=my_channel_group
Output:
<api_response>
<version>3</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
<id>91</success>
</api_response>
delete_channel
This method was last updated in API version 4, and is compatible with API requests from
version 4 onwards.
This function deletes a channel. The API user must have admin privileges to call this
method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- id (the ID of the channel to be deleted)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=4&method=delete_channel&token=xxxxx&id=5
Output:
<api_response>
<version>4</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
64