Live Stationの概要

Prev Next

Classic/VPC環境で利用できます。

Live Stationは、ライブ配信サービスの構築に必要なすべての機能を提供する NAVERクラウドプラットフォームの映像エンコードプラットフォームサービスです。Live Stationサービスは、ライブチャンネル管理、ショートクリップ/ライブカーテンの作成と管理、画質管理、同時配信(Re-Stream)チャンネル管理、VOD2LIVEチャンネル管理、イベント管理機能を RESTful API形式で提供します。

Live Stationの共通設定

Live Station APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://livestation.apigw.ntruss.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • Unix Timestamp形式
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名
Content-Type Required リクエストデータの形式
  • application/json
x-ncp-region_code Required リージョンコード
  • KR (有効値)

レスポンス

共通レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

error

errorは API呼び出し失敗情報を定義します。errorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
error Object - エラーコードとメッセージ
error.errorCode String Required エラーコード
error.message String Required エラーメッセージ
error.errorName String Required エラー名

レスポンスステータスコード

Live Station APIで共通して使用されるレスポンスステータスコードの詳細は、Live Stationのレスポンスステータスコードをご参照ください。

参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "error": {
        "errorCode": 250000,
        "message": "Unexpected error occurred.",
        "errorName": "EXCEPTION"
    }
}

Live Station API

Live Stationサービスで提供する APIの説明は次の通りです。

Channel Management

Channel Management関連 APIの説明は次の通りです。

Channel

Channel関連 APIの説明は次の通りです。

API 説明
チャンネルの作成 ライブチャンネルを作成
チャンネルリストの照会 ライブチャンネルリストを照会
チャンネルストリームメタデータの照会 ライブチャンネル配信ストリームのメタデータを照会
チャンネルの照会 ライブチャンネルの詳細情報を照会
チャンネル Service URLの照会 チャンネルライブ再生 URL、タイムシフト URL、サムネイル URLを照会
チャンネル設定の変更 ライブチャンネル設定を変更
チャンネルの停止 ライブチャンネルを停止
チャンネル停止の解除 停止されたライブチャンネルを有効化
チャンネル CDNの変更 ライブチャンネルの連携 CDNサーバを変更
チャンネル CDNの一括変更 2つ以上のライブチャンネルの連携 CDNサーバを一括変更
チャンネルの返却 ライブチャンネルを返却

Recording

Recording関連 APIの説明は次の通りです。

API 説明
録画の開始 チャンネル配信中に録画開始
録画の終了 チャンネル録画終了
録画ファイルのアップロード 録画ファイルを Object Storageバケットにアップロード
録画ファイルリストの照会 録画ファイルリストを照会
録画ファイルの照会 録画ファイルの詳細情報を照会
録画ファイルの削除 録画ファイルを削除

Short Clip

Short Clip関連 APIの説明は次の通りです。

API 説明
スナップショットの作成 配信中ライブチャンネルのスナップショットを作成
スナップショットの照会 スナップショットの詳細情報を照会
ショートクリップの作成 スナップショットを利用してライブショートクリップを作成
ショートクリップリストの照会 ライブショートクリップリストを照会
ショートクリップの照会 ライブショートクリップの詳細情報を照会

Live Curtain

Live Curtain関連 APIの説明は次の通りです。

API 説明
ライブカーテンコンテンツの作成 ライブカーテンに使用するコンテンツを作成
ライブカーテンコンテンツリストの照会 ライブカーテンコンテンツリストを照会
ライブカーテンコンテンツの照会 ライブカーテンコンテンツの詳細情報を照会
ライブカーテンコンテンツの削除 ライブカーテンコンテンツを削除
ライブカーテンの開始 ライブカーテン配信を開始
ライブカーテンの終了 ライブカーテン配信を強制終了

Quality Management

Quality Management関連 APIの説明は次の通りです。

Quality Profile

Quality Profile関連 APIの説明は次の通りです。

API 説明
画質リストの照会 全画質リストを照会
画質の照会 全画質の詳細情報を照会
Custom画質の作成 Custom画質を作成
Custom画質の削除 Custom画質を削除

Quality Setting

Quality Setting関連 APIの説明は次の通りです。

API 説明
画質設定リストの照会 全画質設定リストを照会
画質設定の照会 全画質設定の詳細情報を照会
Custom画質設定の作成 Custom画質設定を作成
Custom画質設定の更新 Custom画質設定を更新
Custom画質設定の削除 Custom画質設定を削除

Re-Stream Management

Re-Stream Management関連 APIの説明は次の通りです。

API 説明
チャンネルの作成 同時配信チャンネルを作成
同時配信プラットフォームリストの照会 同時配信プラットフォームリストを照会
チャンネルリストの照会 同時配信チャンネルリストを照会
チャンネルの照会 同時配信チャンネルの詳細情報を照会
同時配信プラットフォームの更新 同時配信プラットフォーム情報を更新
チャンネルの返却 同時配信チャンネルを返却

VOD2LIVE Management

VOD2LIVE Management関連 APIの説明は次の通りです。

Channel

Channel関連 APIの説明は次の通りです。

API 説明
チャンネルの作成 VOD2LIVEチャンネルを作成
チャンネルリストの照会 VOD2LIVEチャンネルリストを照会
チャンネルの照会 VOD2LIVEチャンネルの詳細情報を照会
チャンネル Service URLの照会 VOD2LIVEチャンネルの再生 URL、サムネイル URLを照会
チャンネル設定の変更 VOD2LIVEチャンネル設定を変更
チャンネルの停止 VOD2LIVEチャンネルを停止
チャンネル停止の解除 停止した VOD2LIVEチャンネルを有効化
チャンネル CDNの変更 VOD2LIVEチャンネルに連携された CDNサーバを変更
チャンネル CDNの一括変更 複数の VOD2LIVEチャンネルの CDNサーバを一括変更
チャンネルの返却 VOD2LIVEチャンネルを返却

Schedule

Schedule関連 APIの説明は次の通りです。

API 説明
スケジュールの作成 VOD配信スケジュールを作成
スケジュールの照会 VOD配信スケジュールを照会
スケジュールの更新 VOD配信スケジュールを更新
スケジュールの削除 VOD配信スケジュールを削除

Event

Event関連 APIの説明は次の通りです。

API 説明
管理者グループリストの照会 管理者グループリストを照会
管理者の照会 管理者情報を照会
イベントアラームの設定 イベントアラームを設定
イベントリストの照会 全チャンネルのイベントリストを照会
Liveチャンネル配信イベントリストの照会 ライブチャンネル配信イベントリストを照会
Liveチャンネルイベントリストの照会 ライブチャンネルのイベントリストを照会
Re-Streamチャンネル配信イベントリストの照会 同時配信チャンネルの配信イベントリストを照会
Re-Streamチャンネルイベントリストの照会 同時配信チャンネルのイベントリストを照会
Callback Endpointの登録 すべてのチャンネルイベントアラームを受信するデフォルトのコールバックエンドポイントを登録
Callback Endpointの登録(Live) ライブチャンネルイベントアラームを受信するコールバックエンドポイントを登録
Callback Endpointの登録(Re-Stream) 同時配信チャンネルイベントアラームを受信するコールバックエンドポイントを登録
Callback Endpointの登録(VOD2LIVE) VOD2LIVEチャンネルイベントアラームを受信するコールバックエンドポイントを登録
Callback Endpointの照会 登録されたコールバックエンドポイントを照会

Live Station関連リソース

Live Station APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。