Skip to main content

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.

Release files for dveo 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dveo 0.2.1
File Size Uploaded
dveo-0.2.1.tar.gz 5.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dveo 0.2.1
File Interpreter ABI Platform
dveo-0.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 12.1 kB

Release files / dveo-0.2.1.tar.gz

Download URL dveo-0.2.1.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
2acdc419bc575da9b422c91110fdc3b52bd829c365f50401337c913a402beb12
BLAKE2b-256 checksum
How to use checksums
d32346ea1adc1884e68223a5354dd065300bec7b66ccad20079698b7a3f28ced
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / dveo-0.2.1-py3-none-any.whl

Download URL dveo-0.2.1-py3-none-any.whl
Size 6.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
072cd442b86c75100db2c553c5545258fb54e1bff31ff8ad9ee3bc87657c92b4
BLAKE2b-256 checksum
How to use checksums
3f045264954b4a12e778c49ad105769f80e549edd2ab9832df125e0f1c7f70f4
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page