--- title: "プレイヤーオプションの照会" slug: "vpe-api-option" tags: ["Video Player Enhancement"] updated: 2026-09-17T09:58:18Z published: 2026-09-17T09:58:18Z canonical: "api.ncloud-docs.com/vpe-api-option" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # プレイヤーオプションの照会 Classic/VPC環境で利用できます。 プレイヤーに設定したオプション情報を照会します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET | /api/v1/players/{player_no}/options | ### リクエストヘッダ Video Player Enhancement APIで共通して使用されるヘッダの詳細は、[Video Player Enhancementのリクエストヘッダ](/docs/ja/vpe-api-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストパスパラメータ リクエストパスパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `player_no` | String | Required | プレイヤー番号 - [プレイヤーリストの照会](/docs/ja/vpe-api-list)を参照 | ### リクエスト例 リクエストのサンプルコードは次の通りです。 ``` curl --location --request GET 'https://vpe.apigw.ntruss.com/api/v1/players/6144/options' \ --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' ``` ## レスポンス レスポンス形式を説明します。 ### レスポンスボディ レスポンスボディの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `code` | String | - | レスポンスコード | | `message` | String | - | レスポンスメッセージ | | `result` | Object | - | レスポンス結果 | | `result.env` | String | - | デプロイ環境 | | `result.option` | Object | - | プレイヤーオプション情報 - Standardプラン: 全オプションをサポート - Basicプラン: 一部のオプションをサポート | | `result.option.touchGestures` | Boolean | - | タッチジェスチャーを使用するか - `true` \| `false` - `true`: 使用 - `false`: 使用しない | | `result.option.autostart` | Boolean | - | 自動再生 - `true` \| `false` - `true`: 使用 - `false`: 使用しない - Basicプランで使用可能 | | `result.option.controlBtn` | Object | - | コントロールバーボタンの設定 | | `result.option.controlBtn.fullscreen` | Boolean | - | フルスクリーン(全画面)ボタンを表示するか - `true` \| `false` - `true`: 表示 - `false`: 表示しない | | `result.option.controlBtn.pictureInPicture` | Boolean | - | PIP(ミニプレイヤーに切り替え)ボタンを表示するか - `true` \| `false` - `true`: 表示 - `false`: 表示しない | | `result.option.controlBtn.volume` | Boolean | - | ボリューム調整ボタンを表示するか - `true` \| `false` - `true`: 表示 - `false`: 表示しない | | `result.option.controlBtn.play` | Boolean | - | プレイヤーボタンを表示するか - `true` \| `false` - `true`: 表示 - `false`: 表示しない | | `result.option.controlBtn.times` | Boolean | - | 時間を表示するか - `true` \| `false` - `true`: 表示 - `false`: 表示しない - 映像全体の長さと現在の再生時間を表示 | | `result.option.controlBtn.setting` | Boolean | - | 設定ボタンを表示するか - `true` \| `false` - `true`: 表示 - `false`: 表示しない - 映像の解像度と倍速設定ボタンを表示 | | `result.option.controlBtn.subtitle` | Boolean | - | 字幕選択ボタンを表示するか - `true` \| `false` - `true`: 表示 - `false`: 表示しない | | `result.option.controlBtn.progressBar` | Boolean | - | 再生バーを表示するか - `true` \| `false` - `true`: 表示 - `false`: 表示しない | | `result.option.autoPause` | Boolean | - | ブラウザ無効化時の自動停止 - `true` \| `false` - `true`: 使用 - `false`: 使用しない - Basicプランで使用可能 | | `result.option.seekingPreview` | Boolean | - | シークバーにサムネイルを表示するか - `true` \| `false` - `true`: 表示 - `false`: 表示しない | | `result.option.descriptionNotVisible` | Boolean | - | ディスクリプション(映像のタイトルとメタデータ UIの表示)を使用するか - `true` \| `false` - `true`: 使用 - `false`: 使用しない | | `result.option.playRateSetting` | Array | - | 再生倍速オプションリスト | | `result.option.repeat` | Boolean | - | リピート再生 - `true` \| `false` - `true`: リピート - `false`: リピートしない - Basicプランで使用可能 | | `result.option.startMutedInfoNotVisible` | Boolean | - | 再生開始時、ミュートするか - `true` \| `false` - `true`: ミュート - `false`: 音を再生 | | `result.option.ui` | String | - | コントロール UIタイプ - `all` \| `mobile` \| `pc` - `all`: 自動切り替え - `mobile`: モバイル - `pc`: PC | | `result.option.aspectRatio` | String | - | 画面アスペクト比 - Basic料金プランで使用可能 | | `result.option.controlActiveTime` | Integer | - | コントロールバー自動非表示時間(ミリ秒) - Basicプランで使用可能 | | `result.option.muted` | Boolean | - | ミュートアラートの表示 - `true` \| `false` - `true`: 使用 - `false`: 使用しない - Basicプランで使用可能 | | `result.option.controls` | Boolean | - | コントロールバーを使用するか - `true` \| `false` - `true`: 使用 - `false`: 使用しない - Basicプランで使用可能 | | `result.option.progressBarColor` | String | - | コントロールバーのカラー | | `result.option.keyboardShortcut` | Boolean | - | キーボードショートカットを使用するか - `true` \| `false` - `true`: 使用 - `false`: 使用しない | | `result.option.objectFit` | String | - | 全画面表示方式 - `contain` \| `cover` \| `fill` - `contain`: アスペクト比を維持 - `cover`: アスペクト比を維持+全体を埋める - `fill`: アスペクト比を無視+全体を埋める - Basicプランで使用可能 | | `result.option.lowLatencyMode` | Boolean | - | 超低遅延モードを使用するか - `true` \| `false` - `true`: 使用 - `false`: 使用しない - 使用時、ライブ映像を常に最新の区間で維持 | | `result.option.lang` | String | - | 言語設定 - `auto` \| `ko` \| `en` \| `ja` - `auto`: 自動 - `ko`: 韓国語 - `en`: 英語 - `ja`: 日本語 - Basic(無料)プランで使用可能 | | `result.option.visibleWatermark` | Boolean | - | テキストウォーターマークを使用するか - `true` \| `false` - `true`: 使用 - `false`: 使用しない | | `result.option.iosFullscreenNativeMode` | Boolean | - | iOSモバイル Safariに対応するフルスクリーン(全画面)モード設定をサポートするか - `true` \| `false` - `true`: サポート - `false`: サポートしていない - 1.1.5バージョン以降または最新バージョンのみサポート | | `result.option.customBtns` | Array | - | カスタムボタン設定: [customBtns](/docs/ja/vpe-api-option#customBtns) | | `result.option.watermarkConfig` | Object | - | テキストウォーターマークの詳細オプション設定 | | `result.option.watermarkConfig.randPosition` | Boolean | - | 位置ランダム - `true` \| `false` - `true`: 使用 - `false`: 使用しない | | `result.option.watermarkConfig.randPositionInterVal` | Integer | - | 表示のインターバル(ミリ秒) - `option.watermarkConfig.randPosition`が`true`の場合、有効値を表示 | | `result.option.watermarkConfig.x` | Integer | - | 水平オフセット(パーセンテージ) - 0~100 - ウォーターマークの水平位置の値 - `option.watermarkConfig.randPosition`が`false`の場合、有効値を表示 | | `result.option.watermarkConfig.y` | Integer | - | 垂直オフセット(パーセンテージ) - ウォーターマークの垂直位置の値 - `option.watermarkConfig.randPosition`が`false`の場合、有効値を表示 | | `result.option.watermarkConfig.opacity` | Float | - | 透明度 - 数字が大きいほど不透明 - `option.watermarkConfig.randPosition`が`false`の場合、有効値を表示 | | `result.option.layout` | Array | Optional | コントロールバーのレイアウト設定 (SDK Version V2以降のみ対応) | #### `customBtns` `customBtns`の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `ui` | String | - | ボタン UI環境 - `pc` \| `mobile` - `pc`: PC - `mobile`: モバイル | | `flow` | String | - | 作成位置 - `left` \| `right` - `left`: 左 - `right`: 右 - `position`の位置に既存のボタンが存在する場合、そのボタンの左側または右側に作成 | | `position` | String | - | ボタンの位置 - `left-top` \| `left-bottom` \| `right-top` \| `right-bottom` - `left-top`: 左上 - `left-bottom`: 左下 - `right-top`: 右上 - `right-bottom`: 右下 | | `icon` | String | - | ボタン画像 URL | ### レスポンスステータスコード Video Player Enhancement APIで共通して使用されるレスポンスステータスコードの詳細は、[Video Player Enhancementのレスポンスステータスコード](/docs/ja/vpe-api-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 ``` { "code": "200", "message": "ok", "result": { "env": "dev", "option": { "touchGestures": true, "autostart": true, "controlBtn": { "fullscreen": true, "pictureInPicture": true, "volume": true, "play": true, "times": true, "setting": true, "subtitle": false, "progressBar": true }, "autoPause": true, "seekingPreview": true, "descriptionNotVisible": false, "playRateSetting": [ 0.5, 1, 1.5, 2, 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, "customBtns": [ { "ui": "pc", "flow": "left", "position": "right-bottom", "icon": "{Icon URL}" } ], "watermarkConfig": { "randPosition": true, "randPositionInterVal": 60000, "x": null, "y": null, "opacity": null } } } } ```