tencent cloud

フィードバック

Python SDK

最終更新日:2023-10-26 17:31:32

    サーバーでのビデオアップロードのシナリオを実現させるために、VODではPython SDKを提供しています。アップロードのフローは、サーバーからのアップロードガイドをご参照ください。

    統合方式

    pipを使用してインストール

    pip install vod-python-sdk
    

    ソースコードパッケージによるインストール

    プロジェクトの中でpipツールを使用していない場合は、ソースコードを直接ダウンロードし、プロジェクトの中にインポートして使用することができます。

    最新コードをダウンロードして解凍後:

    $ cd vod-python-sdk
    $ python setup.py install
    

    シンプルビデオアップロード

    アップロードオブジェクトの初期化

    Tencent Cloud APIキーを使用して、VodUploadClientインスタンスを初期化します。

    from qcloud_vod.vod_upload_client import VodUploadClient
    
    client = VodUploadClient("your secretId", "your secretKey")
    

    アップロードリクエストのオブジェクト作成

    from qcloud_vod.model import VodUploadRequest
    
    request = VodUploadRequest()
    request.MediaFilePath = "/data/file/Wildlife.mp4"
    

    アップロードの呼び出し

    アップロードメソッドを呼び出し、アクセスポイントリージョンおよびアップロードリクエストを渡します。

    try:
        response = client.upload("ap-guangzhou", request)
        print(response.FileId)
        print(response.MediaUrl)
    except Exception as err:
        // サービス異常の処理
        print(err)
    
    説明:

    アップロード方法は、ファイルのサイズに応じて、通常アップロードとマルチパートアップロードが自動的に選択されます。マルチパートアップロードの各手順を気にすることなく、マルチパートアップロードを行うことができます。

    高度な機能

    カバーの付加

    from qcloud_vod.vod_upload_client import VodUploadClient
    from qcloud_vod.model import VodUploadRequest
    
    client = VodUploadClient("your secretId", "your secretKey")
    request = VodUploadRequest()
    request.MediaFilePath = "/data/file/Wildlife.mp4"
    request.CoverFilePath = "/data/file/Wildlife-Cover.png"
    try:
        response = client.upload("ap-guangzhou", request)
        print(response.FileId)
        print(response.MediaUrl)
        print(response.CoverUrl)
    except Exception as err:
        // サービス異常の処理
        print(err)
    

    タスクフローの指定

    まず、タスクフローテンプレートの作成、およびテンプレートに対する命名を行います。タスクフロー時に、このタスクフローテンプレート名を使用してProcedureパラメータを設定すれば、アップロード成功後、タスクフローを自動的に実行することができます。

    from qcloud_vod.vod_upload_client import VodUploadClient
    from qcloud_vod.model import VodUploadRequest
    
    client = VodUploadClient("your secretId", "your secretKey")
    request = VodUploadRequest()
    request.MediaFilePath = "/data/file/Wildlife.mp4"
    request.Procedure = "Your Procedure Name"
    try:
        response = client.upload("ap-guangzhou", request)
        print(response.FileId)
        print(response.MediaUrl)
    except Exception as err:
        // サービス異常の処理
        print(err)
    

    サブアプリケーションのアップロード

    サブアプリケーションIDを渡します。アップロード成功後、リソースは具体的なサブアプリケーションにのみ属します。

    from qcloud_vod.vod_upload_client import VodUploadClient
    from qcloud_vod.model import VodUploadRequest
    
    client = VodUploadClient("your secretId", "your secretKey")
    request = VodUploadRequest()
    request.MediaFilePath = "/data/file/Wildlife.mp4"
    request.SubAppId = 101
    try:
        response = client.upload("ap-guangzhou", request)
        print(response.FileId)
        print(response.MediaUrl)
    except Exception as err:
        // サービス異常の処理
        print(err)
    

    ストレージリージョンの指定

    コンソールで目標ストレージリージョンがアクティブ化されているか確認します。アクティブ化されていない場合は、アップロードストレージ設定を参考とすることができます。最後に、StorageRegionの属性によって、ストレージリージョンの 英語の略称を設定します。

    from qcloud_vod.vod_upload_client import VodUploadClient
    from qcloud_vod.model import VodUploadRequest
    
    client = VodUploadClient("your secretId", "your secretKey")
    request = VodUploadRequest()
    request.MediaFilePath = "/data/file/Wildlife.mp4"
    request.StorageRegion = "ap-chongqing"
    try:
        response = client.upload("ap-guangzhou", request)
        print(response.FileId)
        print(response.MediaUrl)
    except Exception as err:
        // サービス異常の処理
        print(err)
    

    パート同時実行数の指定

    パート同時実行数は、大きなファイルに対応するもので、複数のパートに分割すると同時にアップロードするものです。パート同時アップロードのメリットは、1個のファイルのアップロードを素早く完了させられることで、SDKはファイルのサイズを基に、通常アップロードとパートアップロードを自動的に選択します。ユーザーは、パートアップロードの各手順に気を遣う必要もなく、パートでのアップロードを実現できます。こうしてファイルの同時パート数は、ConcurrentUploadNumberパラメータによって指定します。

    from qcloud_vod.vod_upload_client import VodUploadClient
    from qcloud_vod.model import VodUploadRequest
    
    client = VodUploadClient("your secretId", "your secretKey")
    request = VodUploadRequest()
    request.MediaFilePath = "/data/file/Wildlife.mp4"
    request.ConcurrentUploadNumber = 5
    try:
        response = client.upload("ap-guangzhou", request)
        print(response.FileId)
        print(response.MediaUrl)
    except Exception as err:
        // サービス異常の処理
        print(err)
    

    一時的な証明書の使用によるアップロード

    一時的な証明書の関連キー情報を渡し、一時的な証明書を使用して身分を検証し、アップロードします。

    from qcloud_vod.vod_upload_client import VodUploadClient
    from qcloud_vod.model import VodUploadRequest
    
    client = VodUploadClient("Credentials TmpSecretId", "Credentials TmpSecretKey", "Credentials Token")
    request = VodUploadRequest()
    request.MediaFilePath = "/data/file/Wildlife.mp4"
    try:
        response = client.upload("ap-guangzhou", request)
        print(response.FileId)
        print(response.MediaUrl)
    except Exception as err:
        // サービス異常の処理
        print(err)
    

    アダプティブビットレートストリーミング(ABS)ファイルのアップロード

    このSDKでアップロードをサポートするABS形式のパッケージにはHLSとDASHがあります。manifest(M3U8またはMPD)で引用するメディアファイルは、必ず相対パスとし(URLおよび絶対パスは不可)、同時にmanifestと同じクラスのディレクトリまたは下の階層のディレクトリに置く必要があります(../は使用不可)。SDKのアップロードインターフェースを呼び出す時に、MediaFilePathパラメータにmanifest パスを入力すると、SDKが関連するメディアファイルリストを解析し、一緒にアップロードします。

    from qcloud_vod.vod_upload_client import VodUploadClient
    from qcloud_vod.model import VodUploadRequest
    
    client = VodUploadClient("your secretId", "your secretKey")
    request = VodUploadRequest()
    request.MediaFilePath = "/data/file/prog_index.mp4"
    try:
        response = client.upload("ap-guangzhou", request)
        print(response.FileId)
        print(response.MediaUrl)
    except Exception as err:
        // サービス異常の処理
        print(err)
    

    インターフェースの説明

    アップロードクライアントクラスVodUploadClient

    属性名 属性説明 タイプ 入力必須
    secretId Tencent Cloud APIキーID。 String はい
    secretKey Tencent Cloud API Key。 String はい

    アップロードリクエストクラスVodUploadRequest

    属性名 属性説明 タイプ 入力必須
    MediaFilePath アップロード予定のメディアファイルパス。ローカルパスにする必要があります。URLはサポートしていません。 String はい
    SubAppId VOD サブアプリケーションID。サブアプリケーションの中のリソースにアクセスしたい場合は、このフィールドにサブアプリケーションIDを入力します。アクセスしない場合、このフィールドは入力不要です。 Integer いいえ
    MediaType アップロード予定のメディアファイルタイプ。選択可能なタイプの詳細は、ビデオアップロードの概要をご参照ください。MediaFilePathに拡張子が付いている場合は入力不要です。 String いいえ
    MediaName アップロード後のメディアの名前。入力しない場合は、デフォルトでMediaFilePathのファイル名を採用します。 String いいえ
    CoverFilePath アップロード予定のカバーファイルパス。ローカルパスにする必要があります。URLはサポートしていません。 String いいえ
    CoverType アップロード予定のカバーファイルタイプ。選択可能なタイプの詳細は、ビデオアップロードの概要をご参照ください。CoverFilePathに拡張子が付いている場合は入力不要です。 String いいえ
    Procedure アップロード後に自動的に実行させたいタスクフロー名。このパラメータは、タスクフローの作成(API方式 またはコンソール方式)時にユーザーが指定します。具体的な内容は、タスクフロー概要をご参照ください。 String いいえ
    ExpireTime メディアファイルの期限。表記形式はISO 8601規格に準拠します。詳細については、ISO日時表記形式の説明をご参照ください。 String いいえ
    ClassId カテゴリーID。メディアのカテゴリー管理に使用します。カテゴリー作成 インターフェースによってカテゴリーを作成し、カテゴリーIDを取得することができます。 Integer いいえ
    SourceContext ソースコンテキスト。ユーザーリクエスト情報のパススルーに使用します。アップロードコールバックインターフェースは、このフィールドの値を戻します。最長250文字。 String いいえ
    StorageRegion ストレージリージョン。ストレージを予定/希望するリージョンを指定します。このフィールドにはストレージリージョンの英語の略称を入力します。 String いいえ
    ConcurrentUploadNumber パート同時実行数。大きなファイルを対象にパートアップロードする時に有効となります。 Integer いいえ

    アップロードレスポンスクラスVodUploadResponse

    属性名 属性説明 タイプ
    FileId メディアファイルの一意の標識。 String
    MediaUrl メディア再生アドレス。 String
    CoverUrl メディアカバーアドレス。 String
    RequestId 一意のリクエストID。リクエストごとに返されます。問題を特定する時はその回のリクエストのRequestIdを提供する必要があります。 String

    アップロードメソッドVodUploadClient.upload(String region, VodUploadRequest request)

    パラメータ名 パラメータの説明 タイプ 入力必須
    region アクセスポイントリージョン。どのリージョンのVODサーバーにリクエストするかであり、ストレージリージョンとは異なります。具体的な内容は、サポートするリージョンリストをご参照ください。 String はい
    request アップロードリクエスト。 VodUploadRequest はい

    エラーコードリスト

    ステータスコード 意味
    InternalError 内部エラー。
    InvalidParameter.ExpireTime パラメータ値のエラー:期限。
    InvalidParameterValue.CoverType パラメータ値のエラー:カバーのタイプ。
    InvalidParameterValue.MediaType パラメータ値のエラー:メディアタイプ。
    InvalidParameterValue.SubAppId パラメータ値のエラー:サブアプリケーションID。
    InvalidParameterValue.VodSessionKey パラメータ値のエラー:VODセッション。
    ResourceNotFound リソースが存在しません。
    お問い合わせ

    カスタマーサービスをご提供できるため、ぜひお気軽にお問い合わせくださいませ。

    テクニカルサポート

    さらにサポートが必要な場合は、サポートチケットを送信して弊社サポートチームにお問い合わせください。24時間365日のサポートをご提供します。

    電話サポート(24 時間365日対応)