APIリファレンス
VidioClientは、PythonからVIDIO APIと対話するための主要なエントリーポイントです。これを使用してファイルをアップロードしたり、ハイライトリールジョブを作成したり、ジョブのステータスを確認したり、出力をレンダリングしたり、処理が完了するのを待機したりできます。
APIアクセスは現在、Studioプラン以上で利用可能です。
クライアントモデル
VidioClientは、VIDIO APIを操作するためのシンプルなインターフェースを提供します。APIキーを使用してクライアントを作成した後、入力ファイルをアップロードし、ハイライトリールジョブを作成し、ジョブのステータスをポーリングし、出力をレンダリングし、ジョブが完了するのを待つことができます。
プロパティ
api_keystring
リクエストを認証するために使用するあなたのVIDIO APIキー。
メソッド
クラス
VidioClient(api_key)クライアントを初期化
新しいVidioClientインスタンスを作成します。
Parameters
api_keystring
あなたのVIDIO APIキー。
Returns
構成されたVidioClientインスタンス。
python
from vidio import VidioClient
import os
client = VidioClient(
api_key=os.getenv("VIDIO_API_KEY")
)メソッド
client.upload(file_path)ファイルをアップロード
ローカルファイルをVIDIOにアップロードし、入力キーを含むアップロード結果を返します。
Parameters
file_pathstring
アップロードしたいファイルのローカルパス。
Returns
`input_key`を含むアップロード結果オブジェクト。
python
result = client.upload("/path/to/video.mp4")
print(result.input_key)メソッド
client.create_highlight_reel(input_keys, video_category, output_length, aspect_ratio)ハイライトリールを作成
1つ以上のアップロードされた入力ファイルからハイライトリールジョブを作成します。
Parameters
input_keyslist[string]
upload()によって返されたアップロードファイルキーのリスト。入力キーの順序は、出力ビデオのメディアの順序を決定します。video_categorystring
ball-sportsなどのビデオカテゴリー。podcast、ball-sports、non-ball-sports、beauty-product-demo、wedding、travel、othersが可能です。最良の結果を得るには、コンテンツに最も適したカテゴリーを指定してください。コンテンツがどのカテゴリーにも該当しない場合は、othersを使用してください。output_lengthinteger
秒単位の希望の出力長。出力長は、すべての入力ビデオの合計長以下である必要があります。
aspect_ratiostring
landscape、portrait、またはsquareなどの出力アスペクト比。Returns
`job_id`とステータス情報を含むジョブオブジェクト。
python
job = client.create_highlight_reel(
input_keys=[result.input_key],
video_category="ball-sports",
output_length=30,
aspect_ratio="landscape",
)
print(job.job_id)
print(job.status)メソッド
client.get_job(job_id)ジョブを取得
ジョブの現在のステータスを取得します。
Parameters
job_idstring
ハイライトリールジョブが作成されたときに返されたジョブID。
Returns
最新のステータスを持つジョブオブジェクト。
python
job_status = client.get_job(job.job_id)
print(job_status.status)メソッド
client.wait_for_job(job_id)ジョブを待機
ハイライトリールジョブが完了状態になるまでAPIをポーリングします。
Parameters
job_idstring
待機するジョブID。
Returns
最終的に完了したジョブオブジェクト。
python
final_job = client.wait_for_job(job.job_id)
print(final_job.status)メソッド
client.render(job_id)出力をレンダリング
完了したハイライトリールジョブの出力ビデオのレンダリングを開始します。
Parameters
job_idstring
完了したハイライトリールジョブID。
Returns
レンダーステータスを持つレンダー結果オブジェクト。
python
render_result = client.render(
job_id=job.job_id
)
print(render_result.status)メソッド
client.wait_for_render(job_id)レンダーを待機
レンダーが完了し、出力が準備できるまでポーリングします。
Parameters
job_idstring
レンダーに関連付けられたジョブID。
Returns
最終的なレンダー結果オブジェクト。
python
final_render = client.wait_for_render(job.job_id)
print(final_render.output_url)