チャンネル設定の変更

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Live Stationは、チャンネル設定を変更するための APIを提供します。

リクエスト

PUT https://livestation.apigw.ntruss.com/api/v2/channels/{channelId}

リクエストヘッダ

ヘッダ名	必須有無	説明
x-ncp-apigw-timestamp	YES	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	YES	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	YES	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-region_code	YES	リージョンコード(KR)

リクエストボディ

フィールド名	必須有無	タイプ	制限事項	説明
channelName	Yes	String	最小3文字以上、最大20文字まで入力可能記号の「_」を許可	作成するチャンネル名
envType	Optional	String	DEV, STAGE, REAL	作成するチャンネルの使用区分のための設定入力しない場合、REALに設定される
outputProtocol	Optional	String	HLS / HLS,DASH / LL_HLS	入力しない場合、HLSにデフォルト設定 HLS/HLS、DASHプロトコルと LL_HLSプロトコル間の相互切り替えはサポートしない。
useDvr	Yes	Boolean	true, false
immediateOnAir	Yes	Boolean	true, false	配信と同時に録画が作動する自動録画オプション
timemachineMin	Yes	Integer	単位は分(minutes)であり、360のみ設定可能	録画開始時まで動画を見返すことができるタイムマシン機能に関するオプション useDvrが trueの場合、必ず設定すること
record	Yes	Object
record.format	Yes	String	MP4,HLS,ALL	バケットで自動保存される録画ファイルのタイプを指定
record.type	Yes	String	NO_RECORD, AUTO_UPLOAD, MANUAL_UPLOAD	保存された録画ファイルのアップロードタイプを指定「NO_RECORD」に設定時、録画機能を利用不可
record.bucketName	Optional	String		自動保存機能を通じてライブ配信の終了後、入力した Bucketに録画ファイルが自動保存
record.filePath	Optional	String		自動保存機能を通じてライブ配信の終了後、指定した filePathに録画ファイルが自動保存 filePathは「/」から始めること
record.accessControl	Optional	String	PRIVATE, PUBLIC_READ	自動保存機能を通じて録画ファイルをアップロード時､Object Storage Bucketの公開範囲を指定するオプション Default: PRIVATE

レスポンス

フィールド名	タイプ	説明	備考
channelId	String
channelName	String
instanceNo	String
qualitySetId	Integer
qualitySetName	String
outputProtocol	String
channelStatus	String	CREATING, READY, PUBLISH, DELETED,BLOCK, FORCE_BLOCK, FORCE_DELETED
isRecording	Boolean
useDvr	Boolean
immediateOnAir	Boolean	true, false
timemachineMin	Integer		単位: Minute
uploadPath	String	AUTO_UPLOADオプション時の録画ファイルアップロードパス
record	Object
record.format	String	MP4,HLS,ALL
record.type	String	NO_RECORD, AUTO_UPLOAD, MANUAL_UPLOAD
record.bucketName	String
record.filePath	String
record.accessControl	String	PRIVATE, PUBLIC_READ
cdn	Object
cdn.cdnType	String	CDN_PLUS, GLOBAL_CDN, GLOBAL_EDGE
cdn.instanceNo	String		NO_CDNの場合は0
cdn.profileId	Integer	Global Edgeのプロファイル ID	NO_CDNの場合は0
cdn.statusName	String	CDNの状態	RUNNING, PUBLISHING, STOPPING, STOPPED, CREATING, CHANGING, CDN_NOT_FOUND
cdn.serviceName	String	CDN Service Name	NO_CDNの場合は""
cdn.cdnDomain	String	CDN Domain	NO_CDNの場合は""
publishUrl	String
globalPublishUrl	String	海外配信対応のための URL
streamKey	String
recentPublishStartTime	Integer
createdTime	Integer
alertOn	Boolean
alertOptions	Object
alertOptions.alertChangeStatus	Boolean
alertOptions.alertVodUploadFail	Boolean
alertOptions.alertReStreamFail	Boolean
totalPublishSeconds	Integer
envType	String	DEV, STAGE, REAL
callbackEndpoint	String
backupStreamKey	String	配信冗長化のためのバックアップストリームキー
isStreamFailOver	Boolean	配信冗長化設定の適用有無	true, false
origin	Object	CDN連携のための Live stationソース情報
origin.originDomain	String	CDN連携のための Live stationソースドメイン
origin.originPath	String	CDN連携のための Live stationソースの詳細パス
drmEnabledYn	Boolean	DRM Encryption設定の適用有無
drm	Object	Live Stationを活用した DRM Encryption設定
drm.siteId	String	One Click Multi DRMサービスで作成した site id
drm.contentId	String	DRM Encryptionを適用するコンテンツの固有 ID DRMパッケージのために使用し、最低3文字以上の英数字または「-」(ハイフン)、「_」(アンダースコア)を含む最大100文字まで入力可能です。

例

リクエスト例

PUT /api/v2/channels/ls-20210720153935-PjPQi
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
x-ncp-region_code:KR

//Request body 
 {
  "channelName": "mychannel2",
  "envType": "DEV",
  "outputProtocol": "HLS",
  "immediateOnAir": false,
  "record": {
    "type": "NO_RECORD"
  },
  "timemachineMin": 360,
  "useDvr": true
}

レスポンス例

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Sep 2021 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
    "content" : {
        "channelId" : "ls-20210720153935-PjPQi",
        "channelName" : "mychannel2",
        "instanceNo" : 1163899,
        "qualitySetId" : 6,
        "qualitySetName" : "360p-set",
        "outputProtocol" : "HLS,",
        "channelStatus" : "READY",
        "isRecording" : false,
        "useDVR" : true,
        "immediateOnAir" : false,
        "timemachineMin" : 360,
        "cdn" : {
            "instanceNo" : "1163900",
            "serviceName" : "edge-ls-20230914204831-1BRHO",
            "statusName" : "RUNNING",
            "cdnType" : "GLOBAL_EDGE",
            "cdnDomain" : "mycdn.cdn.ntruss.com",
            "profileId" : 299
        },
       "record": {
             "type": "NO_RECORD"
        },
       "drm": {
          "contentId": "my-first-drm",
          "siteId": "drm-20231120182420-dPTGn"
       },
        "drmEnabledYn": true,
        "publishUrl": "rtmp://live-station-rtmp-url",
        "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
        "streamKey": "jjiantco4psakuwd5526u2glcxrqaar4",
        "totalPublishSeconds" : 0,
        "createdTime" : 1584931640000,
        "recentPublishStartTime": 0,
        "alertOn" : false,
        "alertOptions" : {
            "alertChangeStatus" : false,
            "alertVodUploadFail" : false,
            "alertReStreamFail" : false
        },
        "callbackEndpoint": "https://my-callback-endpoint",
        "envType": "REAL",
        "origin": {
            "originDomain": "ls-k1.video.media.ntruss.com",
            "originPath": "1"
       },
     "backupStreamKey": "lbuy4dcrxk2ctxs8uqxanpy833p08vvz?backup=true",
     "isStreamFailOver": true
    }
    }
}

この記事は役に立ちましたか?

What's Next

送出メタ情報照会

リクエスト
レスポンス
例

タグ

Live Station