Skip to main content

A command line wrapper for the Dolby.io REST APIs.

Project description

Dolby.io REST APIs Client for Python - CLI

Command Line Interface utility for the dolby.io REST Communications and Media 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 app 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 "APP_KEY" -s "APP_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 "APP_KEY" -s "APP_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

Media Commands

Display the help and version of the command line:

media --help
media --version

Authentication

Get your app key and secret from the dolby.io dashboard and run the following command to get the access token as a json payload:

media auth -k "APP_KEY" -s "APP_SECRET" --output json

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=$(media auth -k "APP_KEY" -s "APP_SECRET" --output access_token 2> /dev/null)

Input / Output

Upload a file to Dolby.io temporary storage:

media io \
    --access_token "<ACCESS_TOKEN>" \
    --dlb_url "dlb://in/file.mp4" \
    --file "/path/to/file.mp4" \
    upload

Download a file from Dolby.io temporary storage:

media io \
    --access_token "<ACCESS_TOKEN>" \
    --dlb_url "dlb://out/processed_file.mp4" \
    --file "/path/to/processed_file.mp4" \
    download

Enhance

Start enhancing a media:

media enhance
    --access_token "<ACCESS_TOKEN>" \
    start \
    --file "/path/to/job_description.json"

The result is the job identifier.

Get the result from a enhancement job:

media enhance
    --access_token "<ACCESS_TOKEN>" \
    result \
    --job_id "00000000-0000-0000-0000-000000000000"

Music Mastering

Start mastering a music:

media mastering
    --access_token "<ACCESS_TOKEN>" \
    start \
    --file "/path/to/job_description.json"

The result is the job identifier.

Get the result from a music mastering job:

media mastering
    --access_token "<ACCESS_TOKEN>" \
    result \
    --job_id "00000000-0000-0000-0000-000000000000"

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

dolbyio-rest-apis-cli-3.6.2.tar.gz (56.4 kB view hashes)

Uploaded Source

Built Distribution

dolbyio_rest_apis_cli-3.6.2-py3-none-any.whl (71.3 kB view hashes)

Uploaded Python 3

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