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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | af1108058aa1c93891a3d945bc6efff687f2315cb5e715a58f4bb2f93b04c337 |
|
MD5 | a8883268f0495aad8d40c845f5242413 |
|
BLAKE2b-256 | fcdf24435e9ef353dba98088b1e2806a9a76c00922edc396aacae9466f37ac55 |
Hashes for dolbyio_rest_apis_cli-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84894aa8df9476fada468a7f978e56d4cd649720264899e8ce906c3f8a4aa326 |
|
MD5 | 7005cb8f1a45f28af4804be43d4d3cb3 |
|
BLAKE2b-256 | a45652fb772749118c813dd01fe0512b1fa64d0d7a1995e54bec8b2cf3267680 |