Metadata-Version: 2.1
Name: dveo
Version: 0.2.0
Summary: DVEO REST API wrapper
Home-page: https://github.com/madeddie/dveo
Author: Edwin Hermans
Author-email: edwin@madtech.cx
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/madeddie/dveo/issues
Project-URL: Source, https://github.com/madeddie/dveo/
Description: DVEO REST API wrapper for Python
        ================================
        
        This module tries to make using the `DVEO`_ REST API easier to use with
        Python.
        
        Example of usage:
        
        .. code:: python
        
           >>> 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
        ------------
        
        .. code:: bash
        
           $ 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.
        
        .. _DVEO: https://dveo.com/
Keywords: dveo video encoder api
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
