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.
_login()[source]

Retrieve and set api_key for further authentication.

_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.
_string2bool(string)[source]

Converts ‘true’ to True, ‘false’ to False and returns anything else.

_valid_key(api_key=None)[source]

Test if api_key is valid.

input_by_input_name(input_name)[source]

Lookup input_id (e.g. net_stream1) by configure input name.

input_by_output_name(output_name)[source]

Lookup input_id by configured output 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
input_config(input_id)[source]

Return dict of input stream config variables.

list_inputs()[source]

Return list of configured inputs.

list_outputs(input_id)[source]

Return list of outputs configured for input_id.

output_config(input_id, output_name)[source]

Return dict of output stream config variables.

read_service_log(service_name)[source]

Retrieve log lines for service or stream.

Parameters:service_name (str) – Name of service for which to retrieve logs
Result:A list of log lines.
Return type:list
reboot_device()[source]

Reboot the DVEO device.

reset_service(service_name)[source]

Kill and restart a service.

restart_all_streams()[source]

Kill and restart all the active streams.

restart_service(service_name)[source]

Restart service (without killing).

service_status(service_name)[source]

Return status line of service (daemon or stream) as string.

start_service(service_name)[source]

Start service.

stop_service(service_name)[source]

Stop service.

system_status()[source]

Return dict of system status information.

Utility functions

Various utility functions for use with the DVEO API module

dveo.utils.parse_xsd(xml)[source]

Parses API xsd document from xml string.

Parameters:xml (str) – XSD document in string form
Returns:dict with operations: parameters
Return type:dict