プレイヤーオプションを develop環境にデプロイ
- 印刷する
- PDF
プレイヤーオプションを develop環境にデプロイ
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
設定したプレイヤーオプションを development環境にデプロイする方法は次の通りです。
リクエスト
PUT {API_URL}/players/{player_no}/applyDev
プレイヤーオプション情報
フィールド名 | 必須の有無 | タイプ | 制限 | 説明 |
---|---|---|---|---|
player_no | Y | Integer | Path Parameter | プレイヤー番号 |
option | Y | Object(json) | プレイヤーオプション情報 | |
option.aspectRatio | N | String | 無料/有料 | 画面アスペクト比、デフォルトは16/9、 オプション: 16/9 、4/3 、1/1 、9/16 、21/9 |
option.autoPause | N | Boolean | 無料/有料 | 無効の場合、再生が自動で止まる |
option.autostart | N | Boolean | 無料/有料 | 自動再生かどうか、デフォルトは TRUE |
option.repeat | N | Boolean | 無料/有料 | リピート再生、デフォルトは FALSE |
option.lang | N | String | 無料/有料 | UI言語の設定、デフォルト: auto オプション: auto 、ko 、en 、ja |
option.muted | N | Boolean | 無料/有料 | ミュート、デフォルトは FALSE |
option.objectFit | N | String | 無料/有料 | 映像のアスペクト比をモニターに合わせる、デフォルトは contain、 オプション: contain、cover、fill |
option.controlActiveTime | N | Integer | 無料/有料 | コントロールバーの表示時間(ms) デフォルトは 3000 |
option.controls | N | Boolean | 無料/有料 | コントロールバーの使用有無、デフォルトは TRUE |
option.controlBtn | N | Object | 有料 | コントロールバーボタンの表示有無を設定、有料のみ変更可能 |
option.controlBtn.fullscreen | N | Boolean | 有料 | 全画面、有料のみ変更可能、デフォルトは TRUE |
option.controlBtn.pictureInPicture | N | Boolean | 有料 | ミニプレイヤー、有料のみ変更可能、デフォルトは TRUE |
option.controlBtn.play | N | Boolean | 有料 | プレイボタンの表示、有料のみ変更可能、デフォルトは TRUE |
option.controlBtn.times | N | Boolean | 有料 | 時間の表示、有料のみ変更可能、デフォルトは TRUE |
option.controlBtn.volume | N | Boolean | 有料 | 音量調整、有料のみ変更可能 TRUE |
option.controlBtn.subtitle | N | Boolean | 有料 | 字幕コントロールボタンの表示、有料のみ変更可能、デフォルトは TRUE |
option.controlBtn.setting | N | Boolean | 有料 | 設定ボタンの表示、有料のみ変更可能、デフォルトは TRUE |
option.descriptionNotVisible | N | Boolean | 有料 | 映像メタデータ UIを非表示にする、有料のみメタデータを設定可能、デフォルトは FALSE |
option.playRateSetting | N | Array | 有料 | 倍速選択オプション 有料のみ変更可能、デフォルトオプション値: [0.5,0.75,1,1.5,2] |
option.progressBarColor | N | String | 有料 | コントロールバーのカラー、有料のみ変更可能 デフォルト : #4299f5 |
option.seekingPreview | N | Boolean | 有料 | 映像区間移動時のプレビュー、デフォルトは TRUE |
option.startMutedInfoNotVisible | N | Boolean | 有料 | ミュートの表示、デフォルトは FALSE |
option.keyboardShortcut | N | Boolean | 有料 | キーボードショートカットキー機能の有無、デフォルトは TRUE |
option.touchGestures | N | Boolean | 有料 | タッチジェスチャーの有効化 |
option.ui | N | String | 有料 | UIの設定、デフォルトは all 有料のみオプションを設定可能: all、mobile、pc |
option.lowLatencyMode | N | Boolean | 有料 | LL-HLS超遅延モードに対応、LIVE映像を常に最新区間に維持 デフォルト: FALSE |
option.customBtns | N | Array | 有料 | カスタムボタンを追加(最大4個) |
option.customBtns.ui | Y | String | 有料 | カスタムボタンのデバイス環境 UI (PC、MOBILE) |
option.customBtns.position | Y | String | 有料 | カスタムボタンの位置を設定(left-top、left-bottom、right-top、right-bottom |
option.customBtns.flow | N | String | 有料 | カスタムボタン作成位置を設定(left、right、デフォルト: left) |
option.customBtns.icon | Y | String | 有料 | カスタムボタン画像 URLを設定 |
リクエスト例
PUT /api/v1/players/1/applyDev
HOST: vpe.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
x-ncp-region_code:KR
Request body
{
"option": {
"aspectRatio": "string",
"autoPause": true,
"autostart": true,
"controlActiveTime": 0,
"controlBtn": {
"fullscreen": true,
"pictureInPicture": true,
"play": true,
"setting": true,
"times": true,
"volume": true,
"subtitle": true
},
"controls": true,
"descriptionNotVisible": true,
"keyboardShortcut": true,
"lang": "auto",
"lowLatencyMode": true,
"muted": true,
"objectFit": "string",
"playRateSetting": [
0
],
"progressBarColor": "string",
"repeat": true,
"seekingPreview": true,
"startMutedInfoNotVisible": true,
"touchGestures": true,
"ui": "string",
"visibleWatermark": true
}
}
成功コード
HttpStatusCode | Code | Message |
---|---|---|
200 | 200 | ok |
エラーコード
HttpStatusCode | Code | Message | Description |
---|---|---|---|
200 | 4601 | Query string player_no is missing. | |
200 | 4729 | Body (JSON) customBtns must be array. | |
200 | 4730 | Body (JSON) customBtns is up to 4. | |
200 | 4731 | Body (JSON) customBtns position is invalid. | |
200 | 4732 | Body (JSON) customBtns position is required. | |
200 | 4733 | Body (JSON) customBtns icon is required. | |
200 | 4734 | Body (JSON) customBtns ui is required. | |
200 | 4735 | Body (JSON) customBtns ui is invalid. | |
200 | 4736 | Body (JSON) customBtns flow is invalid. | |
200 | 4706 | Enter an option value for Body (JSON). | |
200 | 4801 | No player information. | |
200 | 4804 | The feature can't be used in the free version of player. |
レスポンス例
HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Feb 2021 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
// 成功時
{
"code": "200",
"message": "ok"
}
// 失敗時
"error": {
"errorCode": "4804",
"message": "The feature can't be used in the free version of player. "
}
}
この記事は役に立ちましたか?