|
Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
|
The webcam manager interface. More...
import <WebcamManager.idl;
Public Member Functions | |
| vector< Webcam > | getWebcams () |
| Retrieve all connected webcams. | |
| int | getChannel (in Webcam webcam, in string clientType, out Channel 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. | |
| vector< Channel > | getChannels () |
| Returns all channels. | |
| int | removeClientType (in string clientType) |
| Remove a client type. | |
| vector< string > | getClientTypes () |
| Get all known client types. | |
| map< string, Priority > | getClientTypePriorities () |
| Get the priority of all known client types. | |
| int | setClientTypePriorities (in map< string, Priority > priorities) |
| Set the priority of a client type. | |
| map< string, Priority > | getWebcamPriorities () |
| Get the priority of a webcam. | |
| int | setWebcamPriorities (in map< string, Priority > priorities) |
| Set the priority of a webcam. | |
Public Attributes | |
| constant int | NO_ERROR = 0 |
| Error codes. | |
| constant int | ERR_INVALID_PARAM = 1 |
| Invalid parameter for an operation. | |
The webcam manager interface.
Definition at line 44 of file WebcamManager.idl.
| int webcam::WebcamManager::getChannel | ( | in Webcam | webcam, |
| in string | clientType, | ||
| out Channel | 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 > webcam::WebcamManager::getChannels | ( | ) |
Returns all channels.
Note: you need to release every unneeded channel
| map< string, Priority > webcam::WebcamManager::getClientTypePriorities | ( | ) |
Get the priority of all known client types.
| vector< string > webcam::WebcamManager::getClientTypes | ( | ) |
Get all known client types.
| map< string, Priority > webcam::WebcamManager::getWebcamPriorities | ( | ) |
Get the priority of a webcam.
| vector< Webcam > webcam::WebcamManager::getWebcams | ( | ) |
Retrieve all connected webcams.
| int webcam::WebcamManager::removeClientType | ( | in string | clientType | ) |
Remove a client type.
| clientType | client type |
| int webcam::WebcamManager::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::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::ERR_INVALID_PARAM = 1 |
Invalid parameter for an operation.
Definition at line 50 of file WebcamManager.idl.
| constant int webcam::WebcamManager::NO_ERROR = 0 |
1.10.0