dveo package¶
Module contents¶
-
class
dveo.
API
(address, password, username='apiuser', port='25599', https=False, data_format='json')[source]¶ Bases:
object
Instantiate a single DVEO API container object.
Parameters: - address (str) – IP address or hostname of encoder.
- password (str) – Password for the apiuser account, if user security is disabled anything is valid, like ‘’.
- username (str) – (optional) apiuser username is usually locked to apiuser.
- port (str or int) – (optional) Port number configured for the API webserver, defaults to 25599.
- https (bool) – (optional) Enable https instead of http connections, defaults to False.
- data_format (str) – (optional) Choose between json and xml format. Older firmwares have problems with the JSON output format, defaults to json.
-
_request
(operation, payload={})[source]¶ Send request to API, return result data.
Parameters: - operation (str) – Operation to request from the API.
- payload (dict) – Dict key:value pairs to send as POST data to API.
-
input_by_input_name
(input_name)[source]¶ Lookup input_id (e.g. net_stream1) by configure input name.
-
input_by_output_param
(output_param_name, output_param_value, partial=False, include_value=False)[source]¶ Lookup input_id by output config paramater.
Parameters: - output_param_name (str) – Name of output config parameter
- output_param_value (str) – Value of parameter
- partial (bool) – (optional) Allow for partial matches, defaults to False
- include_value – (optional) Include param value(s) in output, useful with partial, defaults to False