Custom画質の作成

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

System画質以外の画質が必要な場合は、目的の画質を定義して Custom画質を作成します。

リクエスト

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

メソッド	URI
POST	/api/v2/qualityProfiles

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`name`	String	Required	画質名英数字、記号の「-」を使用して3~20文字以内で入力名前は重複しても構わない
`type`	String	Required	画質タイプ `NORMAL` \| `AUDIO` `NORMAL`: ビデオ、オーディオ出力 `AUDIO`: オーディオ専用出力
`video`	Object	Conditional	ビデオ設定情報 `type`が`NORMAL`の場合、必ず入力
`video.codec`	String	Conditional	ビデオコーデックの形式 `H264` (有効値)
`video.profile`	String	Conditional	ビデオコーデックプロファイル `BASELINE` \| `MAIN` \| `HIGH` `BASELINE`: 基本オプション(低スペック端末用、最低限の機能を提供) `MAIN`: HD推奨オプション `HIGH`: Full HD推奨オプションビデオの使用用途に合わせて H.264コーデックの特定の技術を使用できるようにあらかじめ定義しておいた標準明細 `video.width`x`video.height`が1280x720より小さい場合、`BASELINE`のみ入力可能
`video.level`	Integer	Conditional	ビデオコーデックレベル `-1`: AUTO (有効値) 再生(デコード)に必要なハードウェアの性能限界値をあらかじめ定義しておいた標準明細
`video.width`	Integer	Conditional	出力ビデオの幅(ピクセル) 128~1920 偶数のみ入力可能
`video.height`	Integer	Conditional	出力ビデオの高さ(ピクセル) 96~1920 偶数のみ入力可能
`video.fps`	Float	Conditional	1秒当たりのフレーム数(fps) 1~60
`video.bitrate`	Integer	Conditional	ビデオストリームのビットレート(bps) 1~204800000
`video.videoH264ParamRefFrames`	Integer	Optional	H.264参照フレーム数 `1` (有効値)
`video.rateControl`	String	Optional	ビットレートの配分方式 `VBR` (デフォルト) \| `CBR` `VBR`: 可変ビットレート(Variable Bitrate) `CBR`: 固定ビットレート(Constant Bitrate)
`video.bframes`	Integer	Optional	Bフレーム(双方向予測フレーム)数 0~4 (デフォルト: 0) `video.width`x`video.height`が1280x720未満の場合、0~2以内で入力可能 `video.width`x`video.height`が854x480未満の場合、0のみ入力可能
`video.bypass`	Boolean	Optional	ビデオストリームバイパス `true` \| `false` (デフォルト) `true`: ソースストリームをそのまま使用(pass-through) `false`: 設定情報に合わせてトランスコード
`video.orientation`	String	Optional	ビデオの方向転換設定 `FIX` \| `FREE` `FIX`: 固定 `FREE`: 転換可能
`audio`	Object	Required	オーディオ設定情報
`audio.codec`	String	Required	オーディオコーデックの形式 `AAC` \| `MP3`
`audio.profile`	String	Conditional	オーディオコーデックプロファイル `LC`: AAC-LC (有効値) `audio.codec`が`AAC`の場合にのみ入力可能で、必ず入力
`audio.samplerate`	Integer	Required	オーディオサンプリングレート(Hz) `audio.codec`が`AAC`の場合、入力可能な値: `8000` \| `11025` \| `12000` \| `16000` \| `22050` \| `24000` \| `32000` \| `44100` (デフォルト) \| `48000` \| `64000` \|`88200` \| `96000` `audio.codec`が`MP3`の場合、入力可能な値: `8000` \| `11025` \| `12000` \| `16000` \| `22050` \| `24000` \|`32000` \| `44100` (デフォルト) \| `48000` 1秒当たりのサンプリング数
`audio.channels`	Integer	Required	オーディオチャンネル数 `audio.codec`が`AAC`の場合、入力可能な範囲: 0~8 (デフォルト: 0) `audio.codec`が`MP3`の場合、入力可能な範囲: 0~2 (デフォルト: 0)
`audio.bitrate`	Integer	Required	オーディオストリームのビットレート(Kbps) 16~320
`audio.bypass`	Boolean	Optional	オーディオストリームバイパス `true` \| `false` (デフォルト) `true`: ソースストリームをそのまま使用(pass-through) `false`: 設定情報に合わせてトランスコード

リクエスト例

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

curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/qualityProfiles' \
--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' \
--data '{
    "name": "quality000",
    "type": "NORMAL",
    "video": {
        "codec": "H264",
        "profile": "HIGH",
        "level": -1,
        "width": 1920,
        "height": 1080,
        "fps": 60,
        "bitrate": 204800000,
        "videoH264ParamRefFrames": 1,
        "rateControl": "VBR",
        "bframes": 4,
        "bypass": false
    },
    "audio": {
        "codec": "AAC",
        "profile": "LC",
        "samplerate": 44100,
        "channels": 2,
        "bitrate": 320,
        "bypass": false
    }
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "content": {
        "disabled": false,
        "id": ****,
        "status": "CREATED",
        "createdTime": 1755134603531,
        "genType": "CUSTOM",
        "name": "quality000",
        "type": "NORMAL",
        "video": {
            "fps": 60.0,
            "bitrate": 204800000,
            "bframes": 4,
            "level": -1,
            "width": 1920,
            "height": 1080,
            "bypass": false,
            "codec": "H264",
            "profile": "HIGH",
            "rateControl": "VBR",
            "videoH264ParamRefFrames": 1
        },
        "audio": {
            "codec": "AAC",
            "profile": "LC",
            "samplerate": 44100,
            "channels": 2,
            "bitrate": 320,
            "bypass": false
        }
    }
}