プレイヤーのデプロイ(Develop)

Prev Next

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

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

プレイヤー設定を Develop環境にデプロイします。

リクエスト

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

メソッド URI
PUT /api/v1/players/{player_no}/applyDev

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
player_no String Required プレイヤー番号

リクエストボディ

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

フィールド タイプ 必須の有無 説明
option Object Required プレイヤーオプション情報
  • Standardプラン: 全オプションをサポート
  • Basicプラン: 一部のオプションをサポート
option.touchGestures Boolean Optional タッチジェスチャーを使用するか
  • true (デフォルト) | false
    • true: 使用
    • false: 使用しない
option.autostart Boolean Optional 自動再生
  • true (デフォルト) | false
    • true: 使用
    • false: 使用しない
  • Basicプランで使用可能
option.controlBtn Object Optional コントロールバーボタンの設定
option.controlBtn.fullscreen Boolean Optional フルスクリーン(全画面)ボタンを表示するか
  • true (デフォルト) | false
    • true: 表示
    • false: 表示しない
option.controlBtn.pictureInPicture Boolean Optional PIP(ミニプレイヤーに切り替え)ボタンを表示するか
  • true (デフォルト) | false
    • true: 表示
    • false: 表示しない
option.controlBtn.volume Boolean Optional ボリューム調整ボタンを表示するか
  • true (デフォルト) | false
    • true: 表示
    • false: 表示しない
option.controlBtn.play Boolean Optional プレイヤーボタンを表示するか
  • true (デフォルト) | false
    • true: 表示
    • false: 表示しない
option.controlBtn.times Boolean Optional 時間を表示するか
  • true (デフォルト) | false
    • true: 表示
    • false: 表示しない
  • 映像全体の長さと現在の再生時間を表示
option.controlBtn.setting Boolean Optional 設定ボタンを表示するか
  • true (デフォルト) | false
    • true: 表示
    • false: 表示しない
  • 映像の解像度と倍速設定ボタンを表示
option.controlBtn.subtitle Boolean Optional 字幕選択ボタンを表示するか
  • true (デフォルト) | false
    • true: 表示
    • false: 表示しない
option.controlBtn.progressBar Boolean Optional 再生バーを表示するか
  • true (デフォルト) | false
    • true: 表示
    • false: 表示しない
option.autoPause Boolean Optional ブラウザ無効化時の自動停止
  • true (デフォルト) | false
    • true: 使用
    • false: 使用しない
  • Basicプランで使用可能
option.seekingPreview Boolean Optional シークバーにサムネイルを表示するか
  • true (デフォルト) | false
    • true: 表示
    • false: 表示しない
option.descriptionNotVisible Boolean Optional ディスクリプション(映像のタイトルとメタデータ UIの表示)を使用するか
  • true | false (デフォルト)
    • true: 使用
    • false: 使用しない
option.playRateSetting Array Optional 再生倍速オプションリスト
  • 0.5 | 0.75 | 1 | 1.25 | 1.5 | 2 | 2.25 | 2.5 (デフォルト: 0.50.7511.52)
option.repeat Boolean Optional リピート再生
  • true | false (デフォルト)
    • true: リピート
    • false: リピートしない
  • Basicプランで使用可能
option.startMutedInfoNotVisible Boolean Optional 再生開始時、ミュートするか
  • true | false (デフォルト)
    • true: ミュート
    • false: 音を再生
option.ui String Optional コントロール UIタイプ
  • all (デフォルト) | mobile | pc
    • all: 自動切り替え
    • mobile: モバイル
    • pc: PC
option.aspectRatio String Optional 画面アスペクト比
  • 16/9 (デフォルト) | 4/3 | 1/1 | 9/16 | 21/9
  • Basicプランで使用可能
option.controlActiveTime Integer Optional コントロールバー自動非表示時間(ミリ秒)
  • 1500 | 2000 | 3000 (デフォルト) | 4000 | 5000
  • Basicプランで使用可能
option.muted Boolean Optional ミュートアラートの表示
  • true | false (デフォルト)
    • true: 使用
    • false: 使用しない
  • Basicプランで使用可能
option.controls Boolean Optional コントロールバーを使用するか
  • true (デフォルト) | false
    • true: 使用
    • false: 使用しない
  • Basicプランで使用可能
option.progressBarColor String Optional コントロールバーのカラー
  • #4299f5 (デフォルト)
option.keyboardShortcut Boolean Optional キーボードショートカットを使用するか
  • true (デフォルト) | false
    • true: 使用
    • false: 使用しない
option.objectFit String Optional 全画面表示方式
  • contain (デフォルト) | cover | fill
    • contain: アスペクト比を維持
    • cover: アスペクト比を維持+全体を埋める
    • fill: アスペクト比を無視+全体を埋める
  • Basicプランで使用可能
option.lowLatencyMode Boolean Optional 超低遅延モードを使用するか
  • true | false (デフォルト)
    • true: 使用
    • false: 使用しない
  • 使用時、ライブ映像を常に最新の区間で維持
option.lang String Optional 言語設定
  • auto (デフォルト) | ko | en | ja
    • auto: 自動
    • ko: 韓国語
    • en: 英語
    • ja: 日本語
  • Basicプランで使用可能
option.visibleWatermark Boolean Optional テキストウォーターマークを使用するか
  • true | false (デフォルト)
    • true: 使用
    • false: 使用しない
option.watermarkConfig Object Conditional テキストウォーターマークの詳細オプション設定
  • option.visibleWatermarktrueの場合、配下の情報を含めて必ず入力
option.watermarkConfig.randPosition Boolean Conditional 位置ランダム
  • true | false
    • true: 使用
    • false: 使用しない
option.watermarkConfig.randPositionInterVal Integer Conditional 表示のインターバル(ミリ秒)
  • 3000 | 5000 | 10000 | 30000 | 60000
  • option.watermarkConfig.randPositiontrueの場合、必ず入力
option.watermarkConfig.x Integer Conditional 水平オフセット
  • 0~100
  • ウォーターマークの水平位置の値をパーセンテージで入力
  • option.watermarkConfig.randPositionfalseの場合、必ず入力
option.watermarkConfig.y Integer Conditional 垂直オフセット
  • 0~100
  • ウォーターマークの垂直位置の値をパーセンテージで入力
  • option.watermarkConfig.randPositionfalseの場合、必ず入力
option.watermarkConfig.opacity Float Conditional 透明度
  • 0.1~1 (デフォルト: 0.2)
  • 数字が大きいほど不透明
  • option.watermarkConfig.randPositionfalseの場合、必ず入力
option.iosFullscreenNativeMode Boolean Optional iOSモバイル Safariに対応するフルスクリーン(全画面)モード設定をサポートするか
  • true | false
    • true: サポート
    • false: サポートしない
  • 1.1.5バージョン以降または最新バージョンのみサポート
option.customBtns Array Optional カスタムボタン設定: customBtns
  • 最大4個まで追加可能
  • 設定時、配下の情報を必ず入力

customBtns

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

フィールド タイプ 必須の有無 説明
ui String Conditional ボタン UI環境
  • pc (デフォルト) | mobile
    • pc: PC
    • mobile: モバイル
flow String Conditional 作成位置
  • left (デフォルト)| right
    • left: 左
    • right: 右
  • positionの位置に既存のボタンが存在する場合、そのボタンの左側または右側に作成
position String Conditional ボタンの位置
  • left-top | left-bottom | right-top (デフォルト) | right-bottom
    • left-top: 左上
    • left-bottom: 左下
    • right-top: 右上
    • right-bottom: 右下
icon String Conditional ボタン画像 URL

リクエスト例

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

curl --location --request PUT 'https://vpe.apigw.ntruss.com/api/v1/players/6284/applyDev' \
--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 '{
    "option": {
        "touchGestures": true,
        "autostart": true,
        "controlBtn": {
            "fullscreen": true,
            "pictureInPicture": true,
            "volume": true,
            "play": true,
            "times": true,
            "setting": true,
            "progressBar": true
        },
        "seekingPreview": true,
        "descriptionNotVisible": false,
        "playRateSetting": [
            0.5,
            1.0,
            1.5,
            2.0,
            2.5
        ],
        "repeat": false,
        "startMutedInfoNotVisible": false,
        "ui": "pc",
        "aspectRatio": "16/9",
        "controlActiveTime": 3000,
        "muted": false,
        "controls": true,
        "progressBarColor": "#4299f5",
        "keyboardShortcut": true,
        "objectFit": "cover",
        "lowLatencyMode": false,
        "lang": "ko",
        "visibleWatermark": true,
        "watermarkConfig": {
            "randPosition": false,
            "x": 98,
            "y": 2,
            "opacity": 0.6
        },
        "customBtns": [
            {
                "ui": "pc",
                "flow": "left",
                "position": "right-bottom",
                "icon": "{Icon URL}"
            }
        ]
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ

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

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

レスポンス例

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

{
    "code": "200",
    "message": "ok"
}