Skip to main content

DVEO REST API wrapper

Project description

This module tries to make using the DVEO REST API easier to use with Python.

Example of usage:

>>> from dveo import API
>>> dveo = API('203.0.113.12', 'p455w0rd')
>>> dveo.system_status()['system']['uptime']
OrderedDict([('days', '20'), ('hours', '7'), ('mins', '51')])
>>> dveo.list_inputs()
['net_stream1', 'net_stream2', 'net_stream3', 'net_stream4', ...]
>>> dveo.input_config('net_stream2')['inputname']
'BigTV'
>>> dveo.input_by_output_param('rtmptargeturi', 'acme', partial=True, include_value=True)
[('net_stream1', 'rtmp://vid1.acme.net/stream'), ('net_stream2', 'rtmp://stream10.acme.com/rtmp'), ('net_stream3', 'rtmp://stream11.acme.com/rtmp'), ...]

Check out the variables and commands of your DVEO device API on http(s)://YOURDVEODEVICE:25599/metadata. The URL isn’t protected. The port is set in the DVEO configuration.

Installation

$ pipenv install dveo

Example scripts

In the examples directory you’ll find some implementation examples.

  • retrieve_stream_settings.py loads input and output settings for one or more encoders and prints them and writes them to a json file.

Documentation

Find autogenerated documentation at:

https://dveo.readthedocs.io/

Tested platforms

This code has been tested against the following devices:

  • MultiStreamer DIG/IP
  • Brutus II
  • Brutus III

If you have tested this on another device, please let me know.

How to enable API

To enable the REST API on your DVEO device, follow these steps:

  1. Log in to web interface.

  2. Click on the SYSTEM SETUP tab.

  3. Open the Web Server Setup menu on the left.

  4. Select the API Web Server submenu.

  5. Check the Enable API Web Server box.

  6. If you choose to set Enable User Security to Yes:

    Fill in a password at API User Password (apiuser).

  7. Click the Update button.

  8. Restart the service in the Service Control menu to the right. If it’s stopped it’ll be started.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for dveo, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size dveo-0.2.1-py3-none-any.whl (6.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size dveo-0.2.1.tar.gz (5.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page