エンコードオプションの照会

Prev Next

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

エンコードオプションの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /api/v2/encoding-option/{encodingOptionId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
encodingOptionId String Required エンコードオプション ID

リクエスト例

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

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/encoding-option/1' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
content Object - レスポンス結果
content.disabled Boolean - Sub Accountは無効化するか
  • true | false
    • true: 無効化
    • false: 有効化
content.id Integer - エンコードオプション ID
content.encodingOptionType String - エンコードオプションタイプ
  • NORMAL | AUDIO
    • NORMAL: ビデオエンコードオプション
    • AUDIO: オーディオエンコードオプション
content.name String - エンコードオプション名
content.format String - 変換されたメディアファイルコンテナの形式
content.video Object - ビデオエンコードオプション情報
content.video.codec String - ビデオコーデックの形式
content.video.codecOptions Object - ビデオコーデックの詳細オプション情報
content.video.codecOptions.profile String - ビデオコーデックプロファイル(Video Codec Profile)
content.video.codecOptions.level String - ビデオコーデックレベル(Video Codec Level)
content.video.bitrate Integer - ビデオストリームのビットレート(Kbps)
content.video.width Integer - 出力ビデオの幅(ピクセル)
content.video.height Integer - 出力ビデオの高さ(ピクセル)
content.video.framerate Double - 1秒当たりのフレーム数(fps)
content.video.maxFramerate Double - 1秒当たりの最大フレーム数(fps)
content.video.keyframeInterval Double - ビデオにキーフレームが作成される間隔(秒)
content.video.rateControl String - ビットレートの配分方式
  • AUTO | ABR | CRF | CBR
    • AUTO: 自動
    • ABR: 平均ビットレート(Average Bitrate)
    • CRF: 固定品質(Constant Rate Factor)
    • CBR: 固定ビットレート(Constant Bitrate)
content.video.pass String - ビデオ変換時のエンコードパス設定
  • 1-Pass | 2-Pass
    • 1-Pass: エンコードを1回実行
    • 2-Pass: エンコードを2回実行
content.audio Object - オーディオエンコードオプション情報
content.audio.codec String - オーディオコーデックの形式
content.audio.bitrate Integer - オーディオストリームのビットレート(Kbps)
content.audio.channel Integer - 出力オーディオのチャンネル数設定
  • AUTO | 1 | 2
    • AUTO: 自動
    • 1: モノ
    • 2: ステレオ
content.audio.samplingRate Double - 出力オーディオサンプリングレート(Hz)
defaultSet Boolean - デフォルトエンコードオプションを設定するか
  • true | false
    • true: システム提供
    • false: ユーザー作成
content.regionNo String - リージョン番号
  • 1 (有効値)
    • 1: 韓国リージョン
content.memberNo Integer - メンバー番号

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

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

レスポンス例

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

{
    "content": {
        "disabled": false,
        "id": 1,
        "encodingOptionType": "NORMAL",
        "name": "AVC_SD_1Pass_30fps",
        "format": "MP4",
        "video": {
            "codec": "AVC",
            "codecOptions": {
                "profile": "MAIN",
                "level": "3.1"
            },
            "bitrate": 500,
            "width": 480,
            "height": 320,
            "framerate": -2.0,
            "maxFramerate": 30.0,
            "keyframeInterval": 2.0,
            "rateControl": "ABR",
            "pass": "1-Pass"
        },
        "audio": {
            "codec": "AAC",
            "bitrate": 128,
            "channel": 2,
            "samplingRate": 44100.0
        },
        "defaultSet": true,
        "memberNo": -1
    }
}