画質セットの作成

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Live Station で利用する画質セットを作成する APIです。作成した画質セットを照会するための画質セットリストの照会 APIと画質セット情報の照会 APIを提供します。

注意

Low latency画質セットは、ベータサービスとして提供しております。
ベータ期間中、Low latency画質は NAVERクラウド Video Player Enhancementのみを利用して安定的に再生できます。

リクエスト

POST https://livestation.apigw.ntruss.com/api/v2/qualitySets

リクエストヘッダ

ヘッダ名	要否	説明
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}`
Content-Type	YES	Request body content typeを application/jsonに指定 `Content-Type: application/json`
x-ncp-region_code	YES	リージョンコード(KR)

リクエストボディ

フィールド名	要否	タイプ	制約事項	説明
name	Yes	String	画質名は、数字、英字の最低3文字以上から最大20文字まで入力可能特殊文字の「-」を許可
qualityIds	Yes	Integer[]		画質の構成数は、1～4
segmentCount	No	Integer	1 ~ 10	LL-HLS、 DASHの場合に無視(if protolType is ll-hls or dash、the option should be ignored)
isEnabledUll	Yes	Boolean		Low Latency用の画質セットを作成する場合に、 true
segmentDuration	No	Integer	1000 ~ 10000	HLSプロトコルの segment durationの長さの設定(in milliseconds) LL-HLS、DASHの場合に、無視
enableHlsTimedMetadata	Yes	Boolean
timedMetadata	No	Object
timedMetadata.header	No	String
timedMetadata.interval	No	Integer
timedMetadata.key	No	String

レスポンス

フィールド名	タイプ	説明	備考
enableHlsTimedMetadata	Boolean
timedMetadata	Object
timedMetadata.interval	Integer
timedMetadata.key	String
timedMetadata.header	String
id	Integer
status	String
genType	String
name	String
createdTime	Integer
segmentDuration	Integer
segmentCount	Integer
isEnabledUll	Boolean	Low Latency画質セットの有無
targetLatency	Integer	Low Latency画質セットの target latency
qualityIds[]	Integer[]
qualities[]	Object[]
qualities[].id	Integer
qualities[].name	String		画質プロファイル名
qualities[].type	String	AUDIO, NORMAL
qualities[].genType	String	CUSTOM,SYSTEM
qualities[].status	String
qualities[].video	Object		if type = AUDIO, video Object doesn not need.
qualities[].video.fps	Integer	1 ~ 60 fps
qualities[].video.birate	Integer	1 ~ 204800000 bps
qualities[].video.bframes	Integer	0～4の範囲の整数
qualities[].video.level	Integer	-1
qualities[].video.width	Integer	16 ~ 4096
qualities[].video.height	Integer	16 ~ 4096
qualities[].video.bypass	Boolean
qualities[].video.orientation	String	FIX, FREE	FIX
qualities[].video.keepRatio	Boolean
qualities[].video.codec	String	H264
qualities[].video.profile	String	BASELINE, MAIN, HIGH
qualities[].video.rateControl	Integer	VBR,CBR	VBR
qualities[].video.videoH264ParamRefFrames	Integer	1	1
qualities[].audio	Object
qualities[].audio.codec	String	AAC, MP3	AAC
qualities[].audio.profile	String	LC	LC
qualities[].audio.samplerate	Integer	AAC : [8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000] MP3 : [8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000]	44100
qualities[].audio.channels	Integer	AAC : 0 ~ 8 MP3 : 0 ~ 2	0
qualities[].audio.bitrate	Integer	16 ~ 320 bps
qualities[].audio.bypass	Boolean		false

例

リクエスト例

HLS用の画質セットの作成

POST /api/v2/qualitySets
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

{  
   "enableHlsTimedMetadata":true,
   "name":"myqualityset",
   "qualityIds":[
      4,
      5
   ],
   "segmentCount":3,
   "segmentDuration":3000,
   "timedMetadata":{
      "header":"ncloud.livestation.metadata",
      "interval":1000,
      "key":"utc"
   }
}

Low Latency用の画質セットの作成

POST /api/v2/qualitySets
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
{
  "enableHlsTimedMetadata": true,
  "isEnabledUll": true,
  "name": "myqualityset",
  "qualityIds": [
    1,2
  ],
  "timedMetadata": {
    "header": "ncloud.livestation.metadata",
    "interval": 1000,
    "key": "utc"
  }
}

レスポンス例

HLS用の画質セットの作成レスポンス

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

{
    "content": {
        "createdTime": 1585656720798,
        "enableHlsTimedMetadata": true,
        "genType": "CUSTOM",
        "id": 23,
        "name": "testquality-api",
        "qualities": [
            {
                "audio": {
                    "bypass": false,
                    "bitrate": 128,
                    "channels": 0,
                    "codec": "AAC",
                    "profile": "LC",
                    "samplerate": 48000
                },
                "genType": "SYSTEM",
                "id": 4,
                "name": "720p-16-9",
                "status": "CREATED",
                "type": "NORMAL",
                "video": {
                    "bypass": false,
                    "bframes": 0,
                    "bitrate": 2500000,
                    "codec": "H264",
                    "fps": 30.0,
                    "height": 720,
                    "level": -1,
                    "profile": "MAIN",
                    "rateControl": "VBR",
                    "videoH264ParamRefFrames": 1,
                    "width": 1280
                }
            },
            {
                "audio": {
                    "bypass": false,
                    "bitrate": 128,
                    "channels": 0,
                    "codec": "AAC",
                    "profile": "LC",
                    "samplerate": 48000
                },
                "genType": "SYSTEM",
                "id": 5,
                "name": "720p-9-16",
                "status": "CREATED",
                "type": "NORMAL",
                "video": {
                    "bypass": false,
                    "bframes": 0,
                    "bitrate": 2500000,
                    "codec": "H264",
                    "fps": 30.0,
                    "height": 1280,
                    "level": -1,
                    "profile": "MAIN",
                    "rateControl": "VBR",
                    "videoH264ParamRefFrames": 1,
                    "width": 720
                }
            }
        ],
        "qualityIds": [
            4,
            5
        ],
        "segmentCount": 3,
        "segmentDuration": 3000,
        "status": "CREATED",
        "timedMetadata": {
            "header": "ncloud.livestation.metadata",
            "interval": 1000,
            "key": "utc"
        }
    },
    "result": "success"
}

Low Latency画質セットの作成レスポンス

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

{
  "content": {
    "disabled": false,
    "id": 246,
    "status": "CREATED",
    "createdTime": 1666009295544,
    "genType": "CUSTOM",
    "name": "testquality-llhls",
    "qualityIds": [
      1,
      2
    ],
    "qualities": [
      {
        "disabled": false,
        "id": 1,
        "status": "CREATED",
        "createdTime": 1546300800000,
        "genType": "SYSTEM",
        "name": "bypass",
        "type": "BYPASS",
        "video": {},
        "audio": {
          "bypass": true
        }
      },
      {
        "disabled": false,
        "id": 2,
        "status": "CREATED",
        "createdTime": 1546300800000,
        "genType": "SYSTEM",
        "name": "1080p-16-9",
        "type": "NORMAL",
        "video": {
          "fps": 30,
          "bitrate": 5000000,
          "bframes": 0,
          "level": -1,
          "width": 1920,
          "height": 1080,
          "bypass": false,
          "codec": "H264",
          "profile": "HIGH",
          "rateControl": "VBR",
          "videoH264ParamRefFrames": 1
        },
        "audio": {
          "codec": "AAC",
          "profile": "LC",
          "samplerate": 48000,
          "channels": 0,
          "bitrate": 192,
          "bypass": false
        }
      }
    ],
    "enableHlsTimedMetadata": true,
    "isEnabledUll": true,
    "targetLatency": 3,
    "timedMetadata": {
      "key": "utc",
      "header": "ncloud.livestation.metadata",
      "interval": 1000
    }
  }
}

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

What's Next

画質セットの削除

リクエスト
レスポンス
例

タグ

Live Station