Raritan PX2/PX3 JSON-RPC API
|
The webcam manager interface. More...
import"WebcamManager.idl";
Public Member Functions | |
vector< Webcam_2_0_1 > | getWebcams () |
Retrieve all connected webcams. More... | |
int | getChannel (in Webcam_2_0_1 webcam, in string clientType, out Channel_1_0_1 channel) |
Returns an existing channel that is currently viewing the given webcam or creates one If the client type is unknown it's added to the list of client types. More... | |
vector< Channel_1_0_1 > | getChannels () |
Returns all channels. More... | |
int | removeClientType (in string clientType) |
Remove a client type. More... | |
vector< string > | getClientTypes () |
Get all known client types. More... | |
map< string, Priority > | getClientTypePriorities () |
Get the priority of all known client types. More... | |
int | setClientTypePriorities (in map< string, Priority > priorities) |
Set the priority of a client type. More... | |
map< string, Priority > | getWebcamPriorities () |
Get the priority of a webcam. More... | |
int | setWebcamPriorities (in map< string, Priority > priorities) |
Set the priority of a webcam. More... | |
Public Attributes | |
constant int | NO_ERROR = 0 |
Error codes. More... | |
constant int | ERR_INVALID_PARAM = 1 |
Invalid parameter for an operation. | |
The webcam manager interface.
int webcam::WebcamManager_2_0_1::getChannel | ( | in Webcam_2_0_1 | webcam, |
in string | clientType, | ||
out Channel_1_0_1 | channel | ||
) |
Returns an existing channel that is currently viewing the given webcam or creates one If the client type is unknown it's added to the list of client types.
Note: When a new channel is created the priority of the given webcam and channel type is summed up. The result is used to determine the used overall priority.
webcam | webcam |
clientType | the channel client type -> getClientTypes() |
channel | Result: The channel |
vector<Channel_1_0_1> webcam::WebcamManager_2_0_1::getChannels | ( | ) |
Returns all channels.
Note: you need to release every unneeded channel
map<string, Priority> webcam::WebcamManager_2_0_1::getClientTypePriorities | ( | ) |
Get the priority of all known client types.
vector<string> webcam::WebcamManager_2_0_1::getClientTypes | ( | ) |
Get all known client types.
map<string, Priority> webcam::WebcamManager_2_0_1::getWebcamPriorities | ( | ) |
Get the priority of a webcam.
vector<Webcam_2_0_1> webcam::WebcamManager_2_0_1::getWebcams | ( | ) |
Retrieve all connected webcams.
int webcam::WebcamManager_2_0_1::removeClientType | ( | in string | clientType | ) |
Remove a client type.
clientType | client type |
int webcam::WebcamManager_2_0_1::setClientTypePriorities | ( | in map< string, Priority > | priorities | ) |
Set the priority of a client type.
priorities | a hash map with the key "event type ID" and the value "priority" |
int webcam::WebcamManager_2_0_1::setWebcamPriorities | ( | in map< string, Priority > | priorities | ) |
Set the priority of a webcam.
priorities | a hash map with the key "webcam ID" and the value "priority" |
constant int webcam::WebcamManager_2_0_1::NO_ERROR = 0 |
Error codes.
Operation successful, no error