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

    概要:クラウドプレイアウトAPI

    このトピックでは、CloudPlayoutで使用されるEPGAPIとChannelsAPIの概要を説明します。

    賃貸システムの概要

    に関連するXNUMXつのAPIがあります クラウドプレイアウト:

    • EPG APIを使用すると、クラウドプレイアウトチャネルの電子番組ガイドを取得できます。 Cloud Playoutは、次のスキーマで説明されているように、XMLTV標準に準拠したEPGを生成します。 https://repository.data2type.de/XMLTV/v_1.47/html/index.html.
    • Channels APIを使用すると、UIまたはWebページに表示できるCloudPlayoutチャネルに関する情報を取得できます。

    認証

    Cloud PlayoutAPIは Brightcove OAuthシステム リクエストとともに認証ヘッダーで渡されるアクセストークンを介してリクエストを認証するには、次のようにします。

    Authorization: Bearer {access token}

    アクセストークンは、 OAuth API - 見る アクセストークンの取得 詳細については。 アクセストークンのリクエストを認証するには、クライアントの資格情報も必要です。 これらはStudioの管理セクションで作成できます-を参照してください API クレデンシャルの管理。 資格情報がEPGAPIに必要とする権限は次のとおりです。

    EPGAPIの権限
    EPGAPIの権限

    APIURL

    すべてのクラウドプレイアウトチャネルを取得する

    次のエンドポイントを使用して、アカウントのすべてのクラウドプレイアウトチャネルのリストを取得できます。

    https://cm.cloudplayout.brightcove.com/accounts/{account_id}/cp_channels

      account_id は Video Cloud アカウントID。

    EPGを取得する

    EPGAPIリクエストのURLは次のとおりです。

    https://sm.cloudplayout.brightcove.com/accounts/{account_id}/channels/{channel_id}/epg

      account_id は Video Cloud アカウントID、および channel_id Studioで作成されたチャンネルのIDです。

    チャンネルのIDは、すべてのクラウドプレイアウトチャンネルを取得するリクエストへの応答、またはスタジオのクラウドプレイアウトセクションのチャンネルビューにいる場合はブラウザのURLにあります。

    https://studio.brightcove.com/products/videocloud/cloudplayout/channel/2c73c2112f794e6eb80be1284a495674

    EPGリクエストパラメータ

    次のオプションのクエリパラメータをEPGリクエストに追加できます。

    EPGAPIクエリパラメータ
    パラメーター デフォルト値 説明
    start (今から14日前) EPG応答を照会し、ISO8601日付形式で返すことができる日時
    end (現在-現在の日時) EPG応答を照会してISO8601日付形式で返すことができる日時
    limit (すべてのプログラム) XNUMXつの要求で返されるプログラムの数を制御する整数値
    include_ads false これをtrueに設定すると、応答に広告が含まれます

    ノート

    1.   start/end ウィンドウは14日を超えることはできません。 履歴EPGを照会するには、開始が現在の日時から14日遅れることがあります。 また、現在の日時から最大14日間の将来のEPGデータを取得できます。
    2. 終了時刻と開始時刻の差が14日を超える場合、APIは、要求された時刻から終了時刻までの14日または14日のいずれか早い方のみを生成します。
    3. 両方 start および end タイムゾーンオフセットがある場合とない場合の日時値を受け入れることができます-タイムゾーンオフセットが含まれていない場合、UTCが想定されます。
    4. 両方 start および end URIエンコードする必要があります:
      URIエンコーディング
      ISO8601サンプル URIエンコード
      2020-07-24 15:30:00 2020-07-24%2015%3A30%3A00
      2020-07-24 15:30:00 +0530 2020-07-24%2015%3A30%3A00%20%2B0530

    サンプルEPGAPI応答

    以下は、APIからの応答例です。

    <?xml version="1.0" encoding="utf-8"?>
        <tv source-info-name="Cloudplayout Schedules" source-info-url="http://www.cloudplayout.qa.brightcove.com">
            <channel id="9fb8032ff2fe4f55b388d8969c22ca58">
                <display-name>MyCloudChannel</display-name>
                <icon src="https://bc-cloudplayout-prod.s3.amazonaws.com/default_channel_image.png"/>
            </channel>
            <programme channel="9fb8032ff2fe4f55b388d8969c22ca58" start="20201120132000" stop="20201120132228">
                <title>Frozen</title>
                <desc>FrozenMultiLanguage</desc>
                <length units="seconds">147.605</length>
                <icon src="https://cf-images.us-east-1.qa.boltdns.net/v1/jit/6063799219001/43d57501-b98a-4708-bdd1-a09081f7a585/main/1280x720/1m13s802ms/match/image.jpg" width="1280" height="720"/>
                <category>video</category>
                <keyword>eyJ2aWRlb19pZCI6IjcwNzAwNDQxMDk2MjAyIiwib3JkZXIiOjEsInRhZ3MiOiJjaGlsZHJlbixjb21lZHkiLCJjdXN0b21fbWV0YWRhdGEiOnsicmVnaW9uIjoiYWZyaWNhIiwic29uZ3MiOjV9fQ==</keyword>
            </programme>
            <programme channel="9fb8032ff2fe4f55b388d8969c22ca58" start="20201120132228" stop="20201120133228">
                <title>LiveDemo</title>
                <desc>Live Demo</desc>
                <length units="seconds">600.0</length>
                <icon src="https://img.brightcove.com/cloudplayout/live-icon.jpg" width="1280" height="720"/>
                <category>live</category>
                <keyword>eyJ2aWRlb19pZCI6IjcwNzAxNDg0MjA3MjAyIiwib3JkZXIiOjIsInRhZ3MiOiJjcC1saXZlLXBsYWNlaG9sZGVyLGR1cmF0aW9uLTAwOjEwOjAwIiwiY3VzdG9tX21ldGFkYXRhIjp7InJlZ2lvbiI6Im5vcnRoIGFtZXJpY2EifX0=</keyword>
            </programme>
            <programme channel="9fb8032ff2fe4f55b388d8969c22ca58" start="20201120133228" stop="20201120133327">
                <title>ChildrenComedy</title>
                <desc>ChildrenComedy</desc>
                <length units="seconds">59.164</length>
                <icon src="https://cf-images.us-east-1.qa.boltdns.net/v1/jit/6063799219001/9430773f-76f5-476e-964d-a13b40cab90a/main/1280x720/29s582ms/match/image.jpg" width="1280" height="720"/>
                <category>video</category>
                <keyword>eyJ2aWRlb19pZCI6IjcwNzAxMjE2NDgyMjAyIiwib3JkZXIiOjMsInRhZ3MiOiJyb21hbmNlIiwiY3VzdG9tX21ldGFkYXRhIjp7InJlZ2lvbiI6ImFzaWEiLCJzb25ncyI6NX19</keyword>
            </programme>
            <programme>
                ...
            </programme>
        </tv>

    ノート

    1. 開始タイムスタンプと終了タイムスタンプはUTC時間です。
    2.   category および keyword エントリは内部目的です。

    EPGデータには複数のプログラムデータが含まれており、各プログラムはビデオまたは live 資産:

    <programme channel="27963aa756294a7c98ca1c2c459d4ba2" start="20201118232206" stop="20201118232305">
    	<title>ChildrenComedy</title>
    	<desc>ChildrenComedy</desc>
    	<length> units="seconds">59.164</length>
    	<icon> src="https://cf-images.us-east-1.qa.boltdns.net/v1/jit/6063799219001/9430773f-76f5-476e-964d-a13b40cab90a/main/1280x720/29s582ms/match/image.jpg" width="1280" height="720" ></icon>
    	<category>video</category>
    	<keyword>eyJ2aWRlb19pZCI6IjcwNzAxMjE2NDgyMjAyIiwib3JkZXIiOjEsInRhZ3MiOiJjaGlsZHJlbixjb21lZHkiLCJjdXN0b21fbWV0YWRhdGEiOnsicmVnaW9uIjoiYWZyaWNhIiwic29uZ3MiOjV9fQ==</keyword>
    </programme>

    ここで、 keyword base64でエンコードされたjson値が含まれます。 のデコードされた値 keyword 以下に示します。

    • video_id:は次のようなビデオの識別子です Video Cloud.
    • order:は、クラウドプレイアウトプログラムリスト内のアセットの順序です。
    • tags:カンマ区切り(存在する場合)-の対応するビデオに関連付けられています video cloud.
    • カスタムメタデータ:(存在する場合は、名前と値のペアとして表されます) video cloud.
    {
      "video_id":"70701216482202",
      "order":1,
      "tags":"children,comedy",
      "custom_metadata":{
        "region":"africa",
        "songs":5
      }
    }

    サンプルチャネルAPI応答

    {
            "items": [
              {
                "public_id": "f8eb5f9ccfb84f81b4fb506a663c5545",
                "name": "Channel-4",
                "description": "Test Channel",
                "account_id": "1752604059001",
                "state": "RUNNING",
                "status": "Channel started",
                "start_time": "2021-01-03 15:31:12 UTC",
                "stop_time": null,
                "input_groups": "slate:rtmp:playlist",
                "output_groups": "rtmp",
                "loop_playlist": true,
                "playlist_id": "1687789969630819284",
                "channel_class": "single-pipeline",
                "ssai_enabled": false,
                "aws_region": "us-east-1",
                "message": "",
                "created_at": "2021-01-02 15:39:05 UTC",
                "updated_at": "2021-01-03 15:31:12 UTC",
                "image_url": "https://bc-cloudplayout-prod.s3.amazonaws.com/default_channel_image.png",
                "output_destinations": [
                  "Brightcove Live"
                ],
                "channel_created_at": "2021-01-02 15:39:05 UTC",
                "channel_updated_at": "2021-01-02 15:39:05 UTC",
                "channel_created_by": "rcrooks@brightcove.com",
                "channel_updated_by": "rcrooks@brightcove.com"
              },
              {
                "public_id": "42ecb67a9a964662a4071b4fffff0012",
                "name": "Test-6",
                "description": "Test Channel",
                "account_id": "1752604059001",
                "state": "SCHEDULED",
                "status": "Scheduled for start",
                "start_time": "2021-01-09 05:00:00 UTC",
                "stop_time": "2021-01-09 23:00:00 UTC",
                "input_groups": "slate:rtmp:playlist",
                "output_groups": "rtmp",
                "loop_playlist": true,
                "playlist_id": "1688070644726417934",
                "channel_class": "single-pipeline",
                "ssai_enabled": false,
                "aws_region": "us-east-1",
                "message": "",
                "created_at": "2021-01-05 18:00:18 UTC",
                "updated_at": "2021-01-06 19:08:41 UTC",
                "image_url": "https://bc-cloudplayout-prod.s3.amazonaws.com/default_channel_image.png",
                "output_destinations": [
                  "Brightcove Live"
                ],
                "channel_created_at": "2021-01-05 18:00:18 UTC",
                "channel_updated_at": "2021-01-06 19:06:46 UTC",
                "channel_created_by": "rcrooks@brightcove.com",
                "channel_updated_by": "rcrooks@brightcove.com"
              }
            ]
          }

    制限

    1. EPGは、ベストエフォート/ほぼ正確に生成されます。
    2. EPGが最初にプレイリストから作成されるとき、クラウドプレイアウトが切り替えを開始するのに時間がかかるため、開始時間エラーが発生する可能性があります。
    3. EPGは、保持している現在の情報に基づいて動的に構築されるため、プレイリストが変更されたときにすべての取得で一貫性があるとは限りません。 EPGを変更するアクションには、プレイリストの並べ替えやプレイリスト内のアセットの追加/削除などがあります。
    4. 切り替えで誤動作が発生し、切り替え時間が正確でない場合、将来のEPGでトランジットが不正確になる可能性があります。 これを引き起こす可能性のあるアクションの例としては、プレイリストの切り替えや、プレイリスト内の現在アクティブなアセットの削除などがあります。
    5. EPGの消費者は、最も正確なバージョンを取得するために、可能な限りリアルタイムに近いものを要求する必要があります。

    最終更新日:09年2021月XNUMX日