録画の開始

Prev Next

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

ライブチャンネルのビデオ録画を開始します。チャンネルがPUBLISHINGの状態でのみ開始できます。

リクエスト

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

メソッド URI
PUT /api/v2/channels/{channelId}/startRecord

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request PUT 'https://livestation.apigw.ntruss.com/api/v2/channels/ls-20250814******-PZohi/startRecord' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
content Object - レスポンス結果
content.recordList Object - 録画ファイルリスト
content.recordList.{recordId} Object - 録画ファイル情報
  • {recordId}: 録画ファイル ID
content.recordList.{recordId}.recordType String - レコーディングファイルタイプ
  • MP4 | HLS
content.recordList.{recordId}.channelId String - チャンネル ID
content.recordList.{recordId}.status String - ファイルの状態
  • RECORDING | PROCESSING | PROCESSING_FAIL | TRANSFER_READY | TRANSFER | TRANSFER_FINISH | TRANSFER_FAIL | DELETED
    • RECORDING: レコーディング中
    • PROCESSING: 処理中
    • PROCESSING_FAIL: 処理失敗
    • TRANSFER_READY: 転送待ち
    • TRANSFER: 転送中
    • TRANSFER_FINISH: 転送完了
    • TRANSFER_FAIL: 転送失敗
    • DELETED: 削除完了
content.recordList.{recordId}.recordSeq Integer - 録画ファイルのシーケンス番号
content.recordList.{recordId}.streamSeq Integer - ストリームのシーケンス番号
content.recordList.{recordId}.recordBeginTime Integer - 録画開始日時(ミリ秒)
  • Unix Timestamp形式
content.recordList.{recordId}.createdTime Integer - 録画ファイル作成日時(ミリ秒)
  • Unix Timestamp形式
content.recordList.{recordId}.resolution String - 解像度
  • {横}x{縦}形式
content.recordList.{recordId}.fileName String - ファイル名
content.recordList.{recordId}.videoBitrate Integer - ビデオストリームのビットレート(bps)
content.recordList.{recordId}.audioBitrate Integer - オーディオストリームのビットレート(bps)
content.recordList.{recordId}.videoFrameRate Float - 1秒当たりのフレーム数(fps)
content.recordList.{recordId}.audioCodec String - オーディオコーデック
content.recordList.{recordId}.objectStorageUrl String - レコーディング URL
  • Object Storageバケットにアップロードされていない状態の場合、-と表示
total Integer - 録画ファイルの総数

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

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

レスポンス例

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

{
    "content": {
        "recordList": {
            "270****": {
                "recordType": "MP4",
                "channelId": "ls-20250814******-PZohi",
                "status": "RECORDING",
                "recordSeq": 1307133,
                "streamSeq": 361545,
                "recordBeginTime": 1755498175000,
                "createdTime": 1755498175000,
                "fileName": "361545-1307133-20250818****.mp4",
                "objectStorageUrl": "-"
            },
            "270****": {
                "recordType": "HLS",
                "channelId": "ls-20250814******-PZohi",
                "status": "RECORDING",
                "recordSeq": 1307133,
                "streamSeq": 361545,
                "recordBeginTime": 1755498175000,
                "createdTime": 1755498175000,
                "resolution": "720x1280",
                "fileName": "720p-9-16/playlist.m3u8",
                "videoBitrate": 2500000,
                "audioBitrate": 128000,
                "videoFrameRate": 30.0,
                "audioCodec": "AAC",
                "objectStorageUrl": "-"
            },
            "270****": {
                "recordType": "HLS",
                "channelId": "ls-20250814******-PZohi",
                "status": "RECORDING",
                "recordSeq": 1307133,
                "streamSeq": 361545,
                "recordBeginTime": 1755498175000,
                "createdTime": 1755498175000,
                "resolution": "1920x1080",
                "fileName": "quality000/playlist.m3u8",
                "videoBitrate": 8960000,
                "audioBitrate": 320000,
                "videoFrameRate": 60.0,
                "audioCodec": "AAC",
                "objectStorageUrl": "-"
            }
        }
    },
    "total": 3
}