最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。
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 | プレイヤーオプション情報
|
option.touchGestures |
Boolean | Optional | タッチジェスチャーを使用するか
|
option.autostart |
Boolean | Optional | 自動再生
|
option.controlBtn |
Object | Optional | コントロールバーボタンの設定 |
option.controlBtn.fullscreen |
Boolean | Optional | フルスクリーン(全画面)ボタンを表示するか
|
option.controlBtn.pictureInPicture |
Boolean | Optional | PIP(ミニプレイヤーに切り替え)ボタンを表示するか
|
option.controlBtn.volume |
Boolean | Optional | ボリューム調整ボタンを表示するか
|
option.controlBtn.play |
Boolean | Optional | プレイヤーボタンを表示するか
|
option.controlBtn.times |
Boolean | Optional | 時間を表示するか
|
option.controlBtn.setting |
Boolean | Optional | 設定ボタンを表示するか
|
option.controlBtn.subtitle |
Boolean | Optional | 字幕選択ボタンを表示するか
|
option.controlBtn.progressBar |
Boolean | Optional | 再生バーを表示するか
|
option.autoPause |
Boolean | Optional | ブラウザ無効化時の自動停止
|
option.seekingPreview |
Boolean | Optional | シークバーにサムネイルを表示するか
|
option.descriptionNotVisible |
Boolean | Optional | ディスクリプション(映像のタイトルとメタデータ UIの表示)を使用するか
|
option.playRateSetting |
Array | Optional | 再生倍速オプションリスト
|
option.repeat |
Boolean | Optional | リピート再生
|
option.startMutedInfoNotVisible |
Boolean | Optional | 再生開始時、ミュートするか
|
option.ui |
String | Optional | コントロール UIタイプ
|
option.aspectRatio |
String | Optional | 画面アスペクト比
|
option.controlActiveTime |
Integer | Optional | コントロールバー自動非表示時間(ミリ秒)
|
option.muted |
Boolean | Optional | ミュートアラートの表示
|
option.controls |
Boolean | Optional | コントロールバーを使用するか
|
option.progressBarColor |
String | Optional | コントロールバーのカラー
|
option.keyboardShortcut |
Boolean | Optional | キーボードショートカットを使用するか
|
option.objectFit |
String | Optional | 全画面表示方式
|
option.lowLatencyMode |
Boolean | Optional | 超低遅延モードを使用するか
|
option.lang |
String | Optional | 言語設定
|
option.visibleWatermark |
Boolean | Optional | テキストウォーターマークを使用するか
|
option.watermarkConfig |
Object | Conditional | テキストウォーターマークの詳細オプション設定
|
option.watermarkConfig.randPosition |
Boolean | Conditional | 位置ランダム
|
option.watermarkConfig.randPositionInterVal |
Integer | Conditional | 表示のインターバル(ミリ秒)
|
option.watermarkConfig.x |
Integer | Conditional | 水平オフセット
|
option.watermarkConfig.y |
Integer | Conditional | 垂直オフセット
|
option.watermarkConfig.opacity |
Float | Conditional | 透明度
|
option.iosFullscreenNativeMode |
Boolean | Optional | iOSモバイル Safariに対応するフルスクリーン(全画面)モード設定をサポートするか
|
option.customBtns |
Array | Optional | カスタムボタン設定: customBtns
|
customBtns
customBtnsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
ui |
String | Conditional | ボタン UI環境
|
flow |
String | Conditional | 作成位置
|
position |
String | Conditional | ボタンの位置
|
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"
}