diff --git a/README.md b/README.md index 59351a8..3c88a91 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,33 @@ ## qencode-api-python-client - **install sdk libraries from github** -```` +```sh cd your-workspace-folder git clone https://github.com/qencode-dev/qencode-api-python-client cd qencode-api-python-client pip install -r requirements.txt python setup.py install -```` +``` + **install from pip** -```` +```sh sudo pip install qencode -```` +``` **Usage** -```` +```python import qencode client = qencode.client(API_KEY) client.create() task = client.create_task() -task.start(TRANSCODING_PROFILEID, VIDO_URL) +task.start(TRANSCODING_PROFILEID, VIDEO_URL) -```` +``` **Documentation** @@ -40,38 +40,41 @@ Inside this library, you will find sample code for creating [video transcoding]( Some of the options Qencode offers for transcoding your videos at scale: Resolution - * 8K - * 4K - * 1440p - * 1080p - * 720p - * 480p - * 360p - * 240 - -Features - * Thumbnails - * Watermarking - * VR / 360 Encoding - * Subtitles & Captions - * Create Clips - * Video Stitching - * S3 Storage - * Preview Images - * Custom Resolution - * Callback URLs - * Custom Presets - * Rotate - * Aspect Ratio - * Notifications - * Crop Videos + +- 8K +- 4K +- 1440p +- 1080p +- 720p +- 480p +- 360p +- 240 + +Features + +- Thumbnails +- Watermarking +- VR / 360 Encoding +- Subtitles & Captions +- Create Clips +- Video Stitching +- S3 Storage +- Preview Images +- Custom Resolution +- Callback URLs +- Custom Presets +- Rotate +- Aspect Ratio +- Notifications +- Crop Videos Transfer & Storage Options - * S3 Qencode - * AWS - * Google Cloud - * Backblaze - * Azure - * FTP - * HTTP(S) - * VPN \ No newline at end of file + +- S3 Qencode +- AWS +- Google Cloud +- Backblaze +- Azure +- FTP +- HTTP(S) +- VPN diff --git a/docs/quickstart.md b/docs/quickstart.md index 5a6bdaa..f141ee5 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -2,34 +2,32 @@ **install sdk libraries from github** -```` +```sh cd your-workspace-folder git clone https://github.com/qencode-dev/qencode-api-python-client cd qencode-api-python-client pip install -r requirements.txt python setup.py install -```` +``` **install from pip** -```` +```sh sudo pip install qencode -```` +``` **Usage** -```` +```python import qencode client = qencode.client(API_KEY) client.create() task = client.create_task() -task.start(TRANSCODING_PROFILEID, VIDO_URL) - -```` - +task.start(TRANSCODING_PROFILEID, VIDEO_URL) +``` **Documentation** -Documentation is available at \ No newline at end of file +Documentation is available at diff --git a/docs/usage.md b/docs/usage.md index 89c99b6..78bc3d4 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -2,7 +2,7 @@ **Usage by transcoding profile ID** -```` +``` import sys import os.path sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), os.path.pardir))) @@ -12,7 +12,7 @@ import time API_KEY = 'Your API KEY' TRANSCODING_PROFILEID = 'Your profile ID' -VIDO_URL = 'your source url' +VIDEO_URL = 'your source url' @@ -36,14 +36,14 @@ def start_encode(): task = client.create_task() task.start_time = 0.0 task.duration = 10.0 - task.start(TRANSCODING_PROFILEID, VIDO_URL) + task.start(TRANSCODING_PROFILEID, VIDEO_URL) if task.error: print 'task error:', task.error, task.message raise SystemExit while True: status = task.status() - print '{0} | {1} | {2} | error: {3}'.format(VIDO_URL, + print '{0} | {1} | {2} | error: {3}'.format(VIDEO_URL, status.get('status'), status.get('percent'), status.get('error'), @@ -57,11 +57,11 @@ def start_encode(): if __name__ == '__main__': start_encode() -```` +``` **Usage by custom parameters** -```` +``` import sys import os.path sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), os.path.pardir))) @@ -144,25 +144,26 @@ def start_encode(): if __name__ == '__main__': start_encode() -```` +``` + **Usage with callback methods** -```` +``` def my_callback(e): print e def my_callback2(e): print e - + ... -task.start(TRANSCODING_PROFILEID, VIDO_URL) -if task.error: +task.start(TRANSCODING_PROFILEID, VIDEO_URL) +if task.error: raise SystemExit task.progress_changed(my_callback) task.task_completed(my_callback2) -```` +``` **Documentation**