ライブカーテンの開始

Prev Next

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

ライブチャンネルの再生画面を管理者権限で一定時間、他の映像や画像に置き換えて配信するライブカーテンを開始します。この機能を利用すると、ライブ配信のブラインド処理、サービスのお知らせを行うことができます。
作成したライブカーテンコンテンツを基に好きなタイミングで使用可能で、チャンネルがPUBLISHING状態の場合にのみ開始することができます。

注意

ライブカーテンの使用時は次の点にご注意ください。

  • Generalチャンネル(HLSのみサポート)をサポートし、VOD2LIVEと同時配信(Re-Stream)チャンネルはサポートしません。
  • Bypass(pass-through)と Audio only画質を含まない画質設定をサポートします。
  • 2つ以上の mp4ファイルを使用する場合、全ファイルの解像度を同じにしてください。
  • ライブカーテン進行中に録画を終了すると、ライブカーテンは中断され、既存の配信映像に切り替わります。
  • リクエスト後のライブカーテンコンテンツの反映時間は、{セグメントあたりの再生時間} X {セグメント数}に比例します。
    <例> セグメントあたりの再生時間が2秒でセグメント数が3の場合、リクエスト後約7~8秒後に HLS URLで確認可能

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v2/channels/{channelId}/curtain/insert

リクエストヘッダ

Live Station APIで共通して使用されるヘッダの詳細は、Live Stationのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
channelId String Required チャンネル ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
contentId Array Required ライブカーテンコンテンツ IDリスト
insertTime Integer Optional ライブカーテンの維持時間(分)
  • 1~10 (デフォルト: 3)
参考

開始リクエストと同時にライブカーテンが開始され、insertTimeに入力した時間だけ維持されます。insertTimeを入力しなかった場合は、デフォルトで3分間維持されます。維持時間が過ぎると、既存の配信映像に切り替わります。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/channels/ls-20250814******-zTwK2/curtain/insert' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json' \
--data '{
    "contentId": [
        412
    ],
    "insertTime": 5
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
content Object - レスポンス結果
content.content Object - ライブカーテン情報
content.content.ids Array - コンテンツ IDリスト
content.content.insertTime Integer - ライブカーテンの維持時間(分)
content.content.responseTime Integer - レスポンスタイム(ミリ秒)
  • Unix Timestamp形式
content.channelId String - チャンネル ID
content.isLiveCurtain Boolean - ライブカーテンは進行中か
  • true | false
    • true: 進行中
    • false: 進行中ではない

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

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

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "content": {
        "content": {
            "ids": [
                412
            ],
            "insertTime": 5,
            "responseTime": 1755581363917
        },
        "channelId": "ls-20250814******-zTwK2",
        "isLiveCurtain": true
    }
}