画質設定の照会

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

全(System、Custom)画質設定の詳細情報を照会します。

リクエスト

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

メソッド	URI
GET	/api/v2/qualitySets/{qualitySetId}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`qualitySetId`	Integer	Required	画質設定 ID 画質設定リストの照会を参照

リクエスト例

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

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/qualitySets/****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`content`	Object	-	画質設定情報
`content.disabled`	Boolean	-	画質を無効化するか `true` \| `false` `true`: 無効化 `false`: 有効化
`content.id`	Integer	-	画質設定 ID
`content.status`	String	-	画質設定の状態 `CREATED`: 作成完了 (有効値)
`content.createdTime`	Integer	-	画質設定作成日時(ミリ秒) Unix Timestamp形式
`content.genType`	String	-	設定の分類 `CUSTOM` \| `SYSTEM` `CUSTOM`: 直接作成 `SYSTEM`: デフォルトで提供
`content.name`	String	-	画質設定名
`content.segmentDuration`	Integer	-	セグメントあたりの再生時間(ミリ秒) セグメントの再生時間が長いほどファイルサイズが大きくなり、読み込み時間が長くなる可能性があるセグメントの再生時間が短いほどファイルサイズは小さくなるが、バッファリングが発生する可能性がある `isEnabledUll`が`false`の場合、表示
`content.segmentCount`	Integer	-	セグメント数セグメント数が多いほど再生安定性は向上するが、遅延の可能性とメモリ使用量も増加セグメント数が少ないほど遅延の可能性は減少するが、再生安定性とタイムシフトの再生範囲も減少 `isEnabledUll`が`false`の場合、表示
`content.qualities`	Array	-	画質リスト: qualities
`content.inUseChannelNames`	Array	-	使用中チャンネルリスト使用しているチャンネルがない場合、空の値`[]`を表示
`content.enableHlsTimedMetadata`	Boolean	-	時間ベースのメタデータを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`content.isEnabledUll`	Boolean	-	Low Latency設定 `true` \| `false` `true`: LL-HLS (CMAFを利用した低遅延 HLSストリーミングのためのオプション) `false`: HLS (安定性と互換性の高い HLSストリーミングを利用するためのオプション)
`content.targetLatency`	Integer	-	目標の Low Latency遅延時間(秒) `isEnabledUll`が`true`の場合、表示
`content.timedMetadata`	Object	-	時間ベースのメタデータ設定 `enableHlsTimedMetadata`が`true`の場合、表示
`content.timedMetadata.key`	String	-	キー `utc` (有効値)
`content.timedMetadata.header`	String	-	ヘッダ(識別値)
`content.timedMetadata.interval`	Integer	-	挿入周期(ミリ秒) `1000` (有効値)

`qualities`

qualitiesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`disabled`	Boolean	-	画質を無効化するか `true` \| `false` `true`: 無効化 `false`: 有効化
`id`	Integer	-	画質 ID
`status`	String	-	画質の状態 `CREATED`: 作成完了 (有効値)
`createdTime`	Integer	-	画質作成日時(ミリ秒) Unix Timestamp形式
`genType`	String	-	設定の分類 `CUSTOM` \| `SYSTEM` `CUSTOM`: 直接作成 `SYSTEM`: デフォルトで提供
`name`	String	-	画質名
`type`	String	-	画質タイプ `NORMAL` \| `AUDIO` \| `BYPASS` `NORMAL`: ビデオ、オーディオ出力 `AUDIO`: オーディオ専用出力 `BYPASS`: ソースの出力設定に従う
`video`	Object	-	ビデオ設定情報 `type`が`AUDIO`の場合、配下の情報を含め、表示しない
`video.fps`	Float	-	1秒当たりのフレーム数(fps)
`video.bitrate`	Integer	-	ビデオストリームのビットレート(bps)
`video.bframes`	Integer	-	Bフレーム(双方向予測フレーム)数
`video.level`	Integer	-	ビデオコーデックレベル `-1`: AUTO (有効値) 再生(デコード)に必要なハードウェアの性能限界値をあらかじめ定義しておいた標準明細
`video.width`	Integer	-	出力ビデオの幅(ピクセル)
`video.height`	Integer	-	出力ビデオの高さ(ピクセル)
`video.bypass`	Boolean	-	ビデオストリームバイパス `true` \| `false` `true`: ソースストリームをそのまま使用(pass-through) `false`: 設定情報に合わせてトランスコード
`video.codec`	String	-	ビデオコーデックの形式 `H264` (有効値)
`video.orientation`	String	-	ビデオの方向転換設定 `FIX` \| `FREE` `FIX`: 固定 `FREE`: 転換可能
`video.profile`	String	-	ビデオコーデックプロファイル `BASELINE` \| `MAIN` \| `HIGH` `BASELINE`: 基本オプション(低スペック端末用、最低限の機能を提供) `MAIN`: HD推奨オプション `HIGH`: Full HD推奨オプションビデオの使用用途に合わせて H.264コーデックの特定の技術を使用できるようにあらかじめ定義しておいた標準明細
`video.rateControl`	String	-	ビットレート配分方式 `VBR` \| `CBR` `VBR`: 可変ビットレート(Variable Bitrate) `CBR`: 固定ビットレート(Constant Bitrate)
`video.videoH264ParamRefFrames`	Integer	-	H.264参照フレーム数 `1` (有効値)
`audio`	Object	-	オーディオ設定情報
`audio.codec`	String	-	オーディオコーデックの形式 `AAC` \| `MP3`
`audio.profile`	String	-	オーディオコーデックプロファイル `LC`: AAC-LC (有効値)
`audio.samplerate`	Integer	-	オーディオサンプリングレート(Hz) 1秒当たりのサンプリング数
`audio.channels`	Integer	-	オーディオチャンネル数
`audio.bitrate`	Integer	-	オーディオストリームのビットレート(Kbps)
`audio.bypass`	Boolean	-	オーディオストリームバイパス `true` \| `false` `true`: ソースストリームをそのまま使用(pass-through) `false`: 設定情報に合わせてトランスコード

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

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

レスポンス例

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

{
    "content": {
        "disabled": false,
        "id": ****,
        "status": "CREATED",
        "createdTime": 1755138264000,
        "genType": "CUSTOM",
        "name": "setting000",
        "segmentDuration": 1000,
        "segmentCount": 2,
        "qualities": [
            {
                "disabled": false,
                "id": 5,
                "status": "CREATED",
                "createdTime": 1546300800000,
                "genType": "SYSTEM",
                "name": "720p-9-16",
                "type": "NORMAL",
                "video": {
                    "fps": 30.0,
                    "bitrate": 2500000,
                    "bframes": 0,
                    "level": -1,
                    "width": 720,
                    "height": 1280,
                    "bypass": false,
                    "codec": "H264",
                    "profile": "MAIN",
                    "rateControl": "VBR",
                    "videoH264ParamRefFrames": 1
                },
                "audio": {
                    "codec": "AAC",
                    "profile": "LC",
                    "samplerate": 48000,
                    "channels": 0,
                    "bitrate": 128,
                    "bypass": false
                }
            },
            {
                "disabled": false,
                "id": ****,
                "status": "CREATED",
                "createdTime": 1755134604000,
                "genType": "CUSTOM",
                "name": "quality000",
                "type": "NORMAL",
                "video": {
                    "fps": 60.0,
                    "bitrate": 204800000,
                    "bframes": 4,
                    "level": -1,
                    "width": 1920,
                    "height": 1080,
                    "bypass": true,
                    "codec": "H264",
                    "profile": "HIGH",
                    "rateControl": "VBR",
                    "videoH264ParamRefFrames": 1
                },
                "audio": {
                    "codec": "AAC",
                    "profile": "LC",
                    "samplerate": 44100,
                    "channels": 2,
                    "bitrate": 320,
                    "bypass": true
                }
            }
        ],
        "inUseChannelNames": [
            "channel000"
        ],
        "enableHlsTimedMetadata": true,
        "isEnabledUll": false,
        "timedMetadata": {
            "key": "utc",
            "header": "ncloud.livestation.metadata",
            "interval": 1000
        }
    }
}