サポート問い合わせ先| システムステータス
ページコンテンツ

    概要：Channels API

    Channel Managerエンドポイントを使用すると、Cloud Playoutチャネルを作成し、アセットとライブイベントをプレイリストに追加してから、チャネルをアクティブ化、開始、停止、および削除できます。

    要件

    • ビデオクラウドでCloudPlayoutAPI認証スコープが有効になっている登録済みアプリケーション。（（スタジオUI->管理者-> API認証）

    CloudPlayoutChannelManagerワークフローの作成

    以下は、典型的なCloudPlayoutチャネル管理ワークフローです。

    • チャネルを作成する
    • アセットとライブイベントをプレイリストに追加します
    • チャネルをアクティブ化する
    • チャネルを開始します
    • チャネルを停止します
    • チャネルを削除します

    これらとは別に、チャンネルを取得チャネル情報とチャネルの状態を確認するのに役立ちます。

    チャネルを作成する

    チャネルを作成するには、チャネルの名前、開始時間、入力および出力グループ、リージョン、live_profileなどの必須属性が必要です。DateTime値は、ISO 8601日付形式（UTCまたはタイムオフセット付き）で推奨されます。

    リクエストの例

    要求

    作るPOSTリクエスト先：

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

    ヘッダー

    Content-Type: application/json
Authorization: Bearer {token}

    リクエスト本文

    {
  "name": "channel name",
  "start_time": "2021-06-29T08:30:50.344Z",
  "input_group": [
    {
      "input_type": "playlist or rtmp or slate",
      "input_id": "dummy",
      "loop_on_completion": false
    }
  ],
  "live_profile": "your live profile",
  "output_group": [
    {
      "type": "rtmp or rtp",
      "ingest_locations": [
        {
          "pipeline_id": 1,
          "location": "bc_live or any live channel from your account"
        }
      ]
    },
    {
      "type": "s3",
      "ingest_locations": [
        {
          "pipeline_id": 1,
          "location": "s3 credential id"
        }
      ]
    }
  ],
  "region": "aws region"
}
    レスポンスの例 
    {
  "public_id": "79f0e7503fd64af3b7d2b0f825100f28",
  "name": "channel name",
  "description": "",
  "account_id": "Your account id",
  "state": "DRAFT",
  "status": null,
  "start_time": "2021-06-29 08:30:50 UTC",
  "stop_time": null,
  "input_groups": "playlist",
  "output_groups": "rtmp:s3",
  "loop_playlist": false,
  "playlist_id": "1703814612527248093",
  "channel_class": "single-pipeline",
  "ssai_enabled": true,
  "aws_region": "aws region",
  "message": null,
  "created_at": "2021-06-28 12:43:55 UTC",
  "updated_at": "2021-06-28 12:43:55 UTC",
  "image_url": "https://bc-cloudplayout-prod.s3.amazonaws.com/default_channel_image.png",
  "output_destinations": [
    "Brightcove Live"
  ],
  "channel_created_at": "2021-06-28 12:43:55 UTC",
  "channel_updated_at": "2021-06-28 12:43:55 UTC",
  "channel_created_by": "username@brightcove.com",
  "channel_updated_by": "username@brightcove.com"
}

    必須フィールドに加えて、次のように設定できるフィールドがあります。description、stop_time、ssai_enabled、image_id、mid_roll_import_enabled、mid_roll_slot_time、 NS。からの例を参照してくださいChannels APIリファレンスさまざまな構成のチャネルを作成するため。

    プレイリストにコンテンツを追加する

    次のステップは、チャンネルコンテンツにコンテンツを追加することです。このためにあなたは使用しますCMS API（これは全体の短縮版であることに注意してくださいCMS APIリファレンス Cloud Playoutに関連する操作のみを含み、Cloud Playoutにより適切な説明を含みます）。

    チャネルのplaylist_idを取得します（チャネルの作成要求への応答から、またはチャネルの取得要求から）。これは、CloudPlayoutチャネルのアセットを管理するプレイリストです。

    リクエストの例

    要求

    動画の更新リクエストは、コンテンツを追加するために使用されます。以下のサンプルでは、手動プレイリストを作成するためにビデオIDのコレクションが追加されていますが、ビデオタグなどに基づいてスマートプレイリストを作成することもできることに注意してください。

    作るPATCHリクエスト先：

    https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists/{playlist_id}

    ヘッダー

    Content-Type: application/json
Authorization: Bearer {token}

    リクエスト本文

    {
  "video_ids": [
    "70702887566202",
    "70702887586202",
    "70702260704202",
    "70702260706202"
  ]
}
    レスポンスの例 
    {
  "id": "1701632459864392160",
  "account_id": "Your account id",
  "created_at": "2021-06-04T10:39:32.934Z",
  "updated_at": "2021-06-04T12:29:06.793Z",
  "description": "cloudplayout",
  "favorite": false,
  "name": "cloudplayout_dvfdb",
  "reference_id": null,
  "type": "EXPLICIT",
  "video_ids": [
    "70702887566202",
    "70702887586202",
    "70702260704202",
    "70702260706202"
  ],
  "state": "READY"
}

    ライブイベントを追加する

    ライブイベントをチャンネルに追加するには、ビデオを作ろう CMS APIにリクエストし、CloudPlayoutライブイベントとして識別する特別なタグを含めるように注意してください。

    リクエストの例

    要求

    作るPOSTリクエスト先：

    https://cms.api.brightcove.com/v1/accounts/{account_id}/videos

    ヘッダー

    Content-Type: application/json
Authorization: Bearer {token}

    リクエスト本文

    {
  "name": "Name of the event",
  
    "tags": [
      "cp-live-placeholder",
      "duration-00:40:00"
    ]
  ,
  "description": "Description of the event"
}
    レスポンスの例 
    {
  "id": "70702834583294",
  "account_id": "Your account id",
  "ad_keys": null,
  "clip_source_video_id": null,
  "complete": false,
  "created_at": "2021-06-04T11:00:48.551Z",
  "created_by": {
    "type": "user",
    "id": "76072843583",
    "email": "username@brightcove.com"
  },
  "cue_points": [
  ],
  "custom_fields": {
  },
  "delivery_type": "unknown",
  "description": "test description",
  "digital_master_id": null,
  "duration": null,
  "economics": "AD_SUPPORTED",
  "folder_id": null,
  "geo": null,
  "has_digital_master": false,
  "images": {
  },
  "link": null,
  "long_description": null,
  "name": "test live event",
  "original_filename": null,
  "projection": null,
  "published_at": "2021-06-04T11:00:48.565Z",
  "reference_id": null,
  "schedule": null,
  "sharing": null,
  "state": "ACTIVE",
  "tags": [
    "cp-live-placeholder",
    "duration-00:05:00"
  ],
  "text_tracks": [
  ],
  "updated_at": "2021-06-04T11:00:48.572Z",
  "updated_by": {
    "type": "user",
    "id": "76076294383",
    "email": "username@brightcove.com"
  },
  "playback_rights_id": "primary"
}

    を参照してくださいクラウドプレイアウトのCMS APIリファレンス CloudPlayoutでのアセットの管理に関連するその他の例については。

    チャンネルを取得

    このエンドポイントを使用して、チャネルの詳細とチャネルの状態を確認できます。

    リクエストの例

    要求

    作るGETリクエスト先：

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

    ヘッダー

    Content-Type: application/json
Authorization: Bearer {token}
    レスポンスの例 
    {
  "public_id": "channel id",
  "name": "channel name",
  "description": "Channel created for testing Cloud Playout",
  "account_id": "Your account id",
  "state": "DRAFT",
  "status": null,
  "start_time": "2020-12-17 06:00:00 UTC",
  "stop_time": "2020-12-17 07:00:00 UTC",
  "input_groups": "playlist",
  "output_groups": "rtmp",
  "loop_playlist": true,
  "playlist_id": "1686204667297382886",
  "channel_class": "single-pipeline",
  "ssai_enabled": false,
  "aws_region": "us-east-1",
  "message": null,
  "created_at": "2020-12-16 03:41:22 UTC",
  "updated_at": "2020-12-17 04:53:30 UTC",
  "image_url": "https://bc-cloudplayout-prod.s3.amazonaws.com/default_channel_image.png",
  "output_destinations": [
    "Brightcove Live"
  ],
  "channel_created_at": "2020-12-16 03:41:22 UTC",
  "channel_updated_at": "2020-12-17 04:53:30 UTC",
  "channel_created_by": "username@brightcove.com",
  "channel_updated_by": "username@brightcove.com",
  "live_profile": {
    "display_name": "Standard Live HD 720p - Tier 1",
    "name": "standard-live-hd-720p-tier-1",
    "date_created": "2018-06-04 18:16:44 UTC",
    "date_modified": "2018-06-04 18:16:44 UTC"
  },
  "channel_data": {
    "input_group": [
      {
        "input_type": "playlist",
        "value": "cloudplayout_testChannel",
        "description": "Playlist created for Cloud Playout",
        "public_id": "1686204667297382886"
      }
    ],
    "output_groups": [
      {
        "type": "rtmp",
        "location": "bc_live",
        "destination": "Brightcove Live"
      }
    ]
  }
}

    チャネルをアクティブ化する

    以下のリクエストを行って、チャンネルをアクティブにします。リクエスト本文は必要ありません。

    リクエストの例

    要求

    作るPOSTリクエスト先：

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

    ヘッダー

    Content-Type: application/json
  Authorization: Bearer {token}
    レスポンスの例 
    {
  "message":"Channel activation initiated"
}

    チャネルの状態を確認するには、を参照してください。チャンネルセクションを取得その上。

    チャネルを開始します

    以下のリクエストを行ってチャンネルを開始してください。リクエスト本文は必要ありません。

    リクエストの例

    要求

    作るPOSTリクエスト先：

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

    ヘッダー

    Content-Type: application/json
  Authorization: Bearer {token}
    レスポンスの例 
    {
  "message":"Channel start initiated"
}

    チャネルの状態を確認するには、を参照してください。チャンネルセクションを取得その上。

    チャネルを停止します

    以下のリクエストを行ってチャンネルを停止してください。リクエスト本文は必要ありません。

    リクエストの例

    要求

    作るPOSTリクエスト先：

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

    ヘッダー

    Content-Type: application/json
  Authorization: Bearer {token}
    レスポンスの例 
    {
  "message":"Channel stop initiated"
}

    チャネルの状態を確認するには、を参照してください。チャンネルセクションを取得その上。停止すると、チャネルはドラフト状態になります。

    チャネルを削除する

    以下のリクエストでチャンネルを削除してください。リクエスト本文は必要ありません。

    リクエストの例

    要求

    作るDELETEリクエスト先：

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

    ヘッダー

    Content-Type: application/json
  Authorization: Bearer {token}
    レスポンスの例 
    {
  "message":"Delete initiated"
}

    チャネルの状態を確認するには、を参照してください。チャンネルセクションを取得その上。チャネルが削除されると、ID要求によるチャネルの取得からのチャネル情報は表示されなくなります。

    ページの最終更新日22 Sep 2021