Skip to main content

Python SDK for Audiostack API

Project description

api.audio logo

audiostack SDK


audiostack is the official audiostack Python 3 SDK. This SDK provides easy access to the api.audio API for applications written in python.

Maintainers

License

This project is licensed under the terms of the MIT license.

🧐 About

This repository is actively maintained by Audiostack. For examples, recipes and api reference see the api.audio docs. Feel free to get in touch with any questions or feedback!

:book: Changelog

You can view here our updated Changelog.

:speedboat: Quickstarts

Get started with our quickstart recipes.

🏁 Getting Started

Installation

You don't need this source code unless you want to modify it. If you want to use the package, just run:

pip install audiostack -U
#or
pip3 install audiostack -U

Prerequisites

Python 3.6+

🚀 Hello World

Create a file hello.py

touch hello.py

Authentication

This library needs to be configured with your account's api-key which is available in your api.audio Console. Import the audiostack package and set audiostack.api_key with the api-key you got from the console:

import audiostack
audiostack.api_key = "your-key"

Create Text to audio in 4 steps

Let's create our first audio asset.

✍️ Create a new script, our scriptText will be the text that is later synthesized.

script = audiostack.Content.Script.create(scriptText="hello world")
print(script.message, script.scriptId)

🎤 Render the scriptText that was created in the previous step. Lets use voice Aria. Lets download our tts file also.

tts = audiostack.Speech.TTS.create(scriptItem=script, voice="Aria")
print(tts)
tts.download(autoName=True)

🎧 Now let's mix the speech we just created with a sound template.

mix = audiostack.Production.Mix.create(speechItem=tts, soundTemplate="jakarta")
print(mix)

Lets convert out produced mix into a mp3 and download it.

enc = audiostack.Delivery.Encoder.encode_mix(productionItem=mix, preset="mp3_low")
enc.download()

Easy right? 🔮 This is the final hello.py file.

import audiostack
audiostack.api_key = "your-key"

script = audiostack.Content.Script.create(scriptText="hello world")
print(script.message, script.scriptId)

tts = audiostack.Speech.TTS.create(scriptItem=script, voice="Aria")
print(tts)
tts.download(autoName=True)

mix = audiostack.Production.Mix.create(speechItem=tts, soundTemplate="jakarta")
print(mix)

enc = audiostack.Delivery.Encoder.encode_mix(productionItem=mix, preset="mp3_low")
enc.download()

Now let's run the code:

python hello.py
#or
python3 hello.py

Once this has completed, find the downloaded audio asset and play it! :sound: :sound: :sound:

Import

import audiostack

Authentication

The library needs to be configured with your account's secret key which is available in your Aflorithmic Dashboard. Set audiostack.api_key with the api-key you got from the dashboard:

audiostack.api_key = "your-key"

Authentication with environment variable (recommended)

You can also authenticate using audiostack_key environment variable and the audiostack SDK will automatically use it. To setup, open the terminal and type:

export audiostack_key=<your-key>

If you provide both an environment variable and audiostack.api_key authentication value, the audiostack.api_key value will be used instead.

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

audiostack-1.0.4.tar.gz (15.4 kB view hashes)

Uploaded Source

Built Distribution

audiostack-1.0.4-py3-none-any.whl (22.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