サポート サポート問い合わせ先 | システムステータス システムステータス
ページ内容

    概要: Ingest Profiles API

    このトピックでは、 Ingest Profiles APIとして指定することができます。 Ingest Profiles API 自分のレンディションプロファイルを作成、取得、更新、削除できます。 Video Cloud アカウント。

    取り込みプロファイルの管理

    このバージョンの概要は、有効になっているアカウントのものです Dynamic Delivery。 これらのアカウントは有効にすることもできないこともあります コンテキスト認識エンコーディング。 別の概要があります 従来のインジェストプロファイル.

    取り込みプロファイルは、動画をアップロードまたは再トランスコードするときのトランスコーディングの仕様として使用されます。 これらのプロファイルは、 Ingest Profiles API.

    また、 APIリファレンス.

    用語集

    JSONのプロファイル

    以下の「プロファイルJSON」という用語は、プロファイルオブジェクトのJSON表現を意味します。 それらは最上位のプロファイルフィールドとレンディションオブジェクトの集合をリストとして含んでいます。 見る 標準プロファイル すべてのアカウントに含まれる標準プロファイルのJSONを確認し、 コンテンツセキュリティ(DRMおよびHLSe) DRMパッケージングを含むサンプルプロファイルの場合

    プロフィールID

    A profile id いずれかの id or name プロファイルの最上位フィールド。 この例では(プロファイルの断片):

    {
    		"id": "f1b16093e2dc4f81810f1488",
    		"version": 1,
    		"name": "multi-platform-extended-static",
    		"description": "Deliver high quality content for a wide range content types and screen sizes including mobile, desktop and large screens.", ...

    「マルチプラットフォーム拡張スタティック」または「f1b16093e2dc4f81810f1488」は両方とも有効なプロファイルIDです。 最初にプロファイルを作成すると、IDを持たない名前のプロファイルが提供され、レスポンスにはそのIDを含む作成されたプロファイルが含まれます。 その後、いずれかの後続のAPI呼び出しでどちらかを使用できます。

    参照ID

    A reference_id プロファイル内のレンディションを一意に識別します。 参照IDはDRMパッケージに使用され、将来他の目的で使用される可能性があります。 プロファイル内で一意ではなく、参照IDには任意の文字列を使用できます。スペースにはスペースを含めないでください。 レンディションの形式を簡単に識別できるようなスキームを使用することをお勧めします。たとえば、次のようにします。 mp4_1, mp4_2, hls1, hls2などです。

    プロフィールのバージョン

    A version アカウントのプロファイルのリビジョン番号です。 これは、長い整数値で表されます。 注:JSON表現では引用符で囲まれていません。

    アクティブなプロファイル

    プロフィールは active それがアップロードのために使用できるならば。 たとえば、プロファイルを更新すると、バージョン番号が増えた新しいプロファイルがアクティブになり、古いバージョンは非アクティブになります。

    標準プロファイル

    プロフィールは standard Brightcoveで使用するために提供されている場合(つまり、単一のアカウントに固有のカスタムプロファイルではない場合)。

    デフォルトプロファイル

    プロフィールは default プロファイルが明示的に選択されていない場合に使用されます。 アカウント構成がない場合、または構成にデフォルトプロファイルを設定していない場合は、Brightcoveのいずれか standard プロファイルは、お客様のアカウントの種類に応じて使用されます。

    ベースURL

    サービスのURLは次のとおりです。

    https://ingestion.api.brightcove.com/v1/

    承認

    APIの承認は、BrightcoveのOAuth2実装を介して行われます。 アカウントでの次の操作に対する権限を持つクライアント認証情報(クライアントIDとクライアントシークレット)が必要です。

    • video-cloud/ingest-profiles/profile/read
    • video-cloud/ingest-profiles/profile/write
    • video-cloud/ingest-profiles/account/read
    • video-cloud/ingest-profiles/account/write

    取得するには client_idclient_secretOAuthのUIにアクセスしてアプリを登録する必要があります:

    CURL または Postman を介して資格情報を取得することもできます - 以下を参照してください:

    クライアントの資格情報を使用して、APIへの呼び出しを可能にするアクセストークンを取得します。 アクセストークンはAuthorizationヘッダーに渡されます。

    Authorization: Bearer {your_access_token}

    見ます Oauthセクション 詳細についてはこちら。

    最大レンディション

    見る プロファイルを収集するベストプラクティス.

    アカウント操作

    アカウントレベルでは、アカウントのすべてのプロファイルを取得し、新しいプロファイルを作成できます。

    エンドポイント

    /accounts/{account_id}/profiles

    すべてのプロフィールを取得

    アカウントのすべてのプロフィールを取得するには 標準プロファイル)、上記のエンドポイントにGETリクエストを送信します。

    プロフィールを作成する

    新しいプロファイルを作成するには、上記のエンドポイントにPOST要求を送信します。要求の本体としてのプロファイルのJSONデータが含まれます。 を参照してください APIリファレンス 詳細とサンプルリクエストの本文については、 プロファイルフィールドリファレンス 許容されるフィールドのために。

    作る Live プロフィール

    カスタムインジェストプロファイルを作成するには LiveでHLSレンディションを指定するだけで live_stream に設定 true:

    {
      "media_type": "video",
      "format": "ts",
      "segment_seconds": 6,
      "label": "hls1080p",
      "live_stream": true,
      "video_codec": "h264",
      "video_bitrate": 4000,
      "keyframe_interval": 60,
      "width": 1920,
      "height": 1080,
      "h264_profile": "high"
    }

    従来の取り込みのみを使用する必要があることに注意してください rendition の設定 Live プロファイル、 Studio上ではサポートされていません。 インクルード dynamic_origin Dynamic Deliveryプロファイルの設定。

    単一のプロファイル操作

    個々のプロファイルでは、名前またはIDでプロファイルを取得し、プロファイルを置き換えたり、プロファイルを削除したりすることができます。

    エンドポイント

    /accounts/{account_id}/profiles/{profile_id}

      profile_idは、使用することができます どちら

    • 名前(例:マルチプラットフォーム標準静的)
    • 生成されたID(例:f1b16093e2dc4f81810f1488)

    IDでプロフィールを取得する

    単一のプロファイルを取得するには、上記のエンドポイントにGET要求を行います。

    プロフィールを更新する

    プロファイルを更新するには、上記のエンドポイントに対してPUT要求を行います。 コンプリート リクエスト本文のプロファイルのJSONデータ。

    プロファイルを削除する

    プロファイルを削除するには、上記のエンドポイントに対してDELETE要求を行います。

    このアクションは 不可逆

    デフォルトのプロファイル操作

    エンドポイントを使用して、アカウントのデフォルトのビデオオンデマンドおよびライブビデオプロファイルを取得、設定、または更新することができます。

    /accounts/{account_id}/configuration

    デフォルトのプロファイルを取得する

    上記のエンドポイントへのGETリクエストを作成して、アカウントのデフォルトプロファイルを取得します。

    デフォルトプロファイルが設定されていない場合は、システムデフォルトプロファイルが返されます。

    デフォルトのプロファイルを設定する

    デフォルトのプロファイルを設定するには、要求本体のJSONを含む上記のエンドポイントにPOSTリクエストを行います。

    {
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

      default_profile_id次のいずれかを使用できます。

    • 名前(例:マルチプラットフォーム標準静的)
    • 生成されたID(例:f1b16093e2dc4f81810f1488)

    既定のプロファイルを更新する

    デフォルトのプロファイルを更新するには、要求本体にこのJSONを含め、上記のエンドポイントにPUTリクエストを行います。

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

    ゲット configuration_id GETまたはPOST要求への応答から。

    デフォルトライブプロファイルの設定

    デフォルトのライブプロファイルを設定することは、要求本体のこの変更を除いて、デフォルトのビデオオンデマンドプロファイルを設定することとまったく同じです。

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_live_profile_id": {default_live_profile_id}
    }

    デフォルトのソーシャルクリッピングプロファイルの設定

    デフォルトのソーシャルクリッピングプロファイルを設定することは、要求本体のこの変更を除いて、デフォルトのビデオオンデマンドプロファイルを設定することとまったく同じです。

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_social_clipping_profile_id": {default_social_clipping_profile_id}
    }

    注意:

    • 存在しないプロファイルを指定すると、要求は失敗します

    サンプルプロファイル

    標準プロファイル ドキュメントには、現在存在するすべてのデフォルトプロファイルが表示されます Video Cloud アカウント。

    透かし

    動画にウォーターマーク(またはロゴ画像)を追加する場合は、 Brightcove カスタマーサポート.


    ページの最終更新日:12年2020月XNUMX日