A command line wrapper for the Dolby.io REST APIs.
Project description
Dolby.io REST APIs CLI
Command Line Interface utility for the dolby.io REST Communications APIs.
Install this project
Check the dolbyio-rest-apis-cli package on PyPI. To install the latest stable python package run the following command:
python3 -m pip install dolbyio-rest-apis-cli
Upgrade your package to the latest version:
python3 -m pip install --upgrade dolbyio-rest-apis-cli
Communications Commands
Display the help and version of the command line:
communications --help
communications --version
Authentication
Get your consumer key and secret from the dolby.io dashboard and run the following command to get the access token as a json payload:
communications auth -k "CONSUMER_KEY" -s "CONSUMER_SECRET" --output json
Add the flag --api
to get an access token that you can use to query the REST APIs.
Change the output to --output text
to get a text format for the output.
Use --output access_token
to retrieve only the access token so you can easily assign it to a variable:
ACCESS_TOKEN=$(communications auth -k "CONSUMER_KEY" -s "CONSUMER_SECRET" --api --output access_token 2> /dev/null)
Remix
Using the access token you've retrieved using the auth
command, you can start a remix for a specific conference:
communications remix \
--access_token "ACCESS_TOKEN" \
--cid "00000000-0000-0000-0000-000000000000" \
--start \
--output json
Or simply check the status of a remix:
communications remix \
--access_token "ACCESS_TOKEN" \
--cid "00000000-0000-0000-0000-000000000000" \
--output json
Streaming
Start the streaming to an RTMP endpoint for a specific conference:
communications streaming \
--access_token "ACCESS_TOKEN" \
--cid "00000000-0000-0000-0000-000000000000" \
--action start \
--target rtmp \
--output json \
--urls "rtmp://a.rtmp.youtube.com/live2/{streaming_key}"
Stop the RTMP streaming for a specific conference:
communications streaming \
--access_token "ACCESS_TOKEN" \
--cid "00000000-0000-0000-0000-000000000000" \
--action stop \
--target rtmp \
--output json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dolbyio-rest-apis-cli-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa91adb3de87d964b3bf08b0366814de5a71bdaa00efe490c9f0a1d0704868d8 |
|
MD5 | 3a1a367ba5b94e572ca860fbeca3a7ec |
|
BLAKE2b-256 | 709bc488a7333e97078a431f136d22ad82a91117c1a9779aeae637bbf7c9fe4c |
Hashes for dolbyio_rest_apis_cli-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc811baa7a83d18c7e7ca26867235cb4f3e5878cc6827b5c7a124b623cd866eb |
|
MD5 | 3738223e57fd79669368d6b0f02f4c05 |
|
BLAKE2b-256 | 6d0ac8a952dd179d445385c07da238fd20aee28b0538c8dad20dbc3e5ad30284 |