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.

Source Distribution

dveo-0.2.1.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

dveo-0.2.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file dveo-0.2.1.tar.gz.

File metadata

  • Download URL: dveo-0.2.1.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.4

File hashes

Hashes for dveo-0.2.1.tar.gz
Algorithm Hash digest
SHA256 2acdc419bc575da9b422c91110fdc3b52bd829c365f50401337c913a402beb12
MD5 e66e525115618602a8de6e72fca70012
BLAKE2b-256 d32346ea1adc1884e68223a5354dd065300bec7b66ccad20079698b7a3f28ced

See more details on using hashes here.

File details

Details for the file dveo-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: dveo-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.4

File hashes

Hashes for dveo-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 072cd442b86c75100db2c553c5545258fb54e1bff31ff8ad9ee3bc87657c92b4
MD5 200c7e520349ed3ab17749351772b4dd
BLAKE2b-256 3f045264954b4a12e778c49ad105769f80e549edd2ab9832df125e0f1c7f70f4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page