View Player Option
- Print
- PDF
View Player Option
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
The following details how to view options set in a player.
Requests
GET {API_URL}/players/{player_no}/options
Request Parameters
Field name | Requirement status | Type | Restrictions | Description |
---|---|---|---|---|
player_no | Y | Integer | Path Parameter | Player number |
Responses
Field name | Type | Description | Remarks |
---|---|---|---|
result | Object | ||
result.env | String | Environment | |
result.options | String(json) | Set options |
Player option information
Field name | Requirement status | Type | Limit | Description |
---|---|---|---|---|
player_no | Y | Integer | Player number | |
option | Y | Object(json) | Player option information | |
option.aspectRatio | N | String | Free/Paid | Aspect ratio, default 16/9, option: 16/9, 4/3, 1/1, 9/16, 21/9 |
option.autoPause | N | Boolean | Free/Paid | Automatically stop playback when disabled |
option.autostart | N | Boolean | Free/Paid | Automatic playback status, default value TRUE |
option.repeat | N | Boolean | Free/Paid | Repeat video, default FALSE |
option.lang | N | String | Free/Paid | UI language setting, default value: auto option: auto, ko, en, ja |
option.muted | N | Boolean | Free/Paid | Mute, default FALSE |
option.objectFit | N | String | Free/Paid | Fit image to screen, default contain, option: contain, cover, fill |
option.controlActiveTime | N | Integer | Free/Paid | Active time of control bar (ms) default value 3000 |
option.controls | N | Boolean | Free/Paid | Use of the control bar, default value TRUE |
option.controlBtn | N | Object | Paid | Setting for exposure of control bar button, paid only changeable |
option.controlBtn.fullscreen | N | Boolean | Paid | Full screen, paid only changeable, default TRUE |
option.controlBtn.pictureInPicture | N | Boolean | Paid | Mini player, paid only changeable, default TRUE |
option.controlBtn.play | N | Boolean | Paid | Play button exposure, paid only changeable, default TRUE |
option.controlBtn.times | N | Boolean | Paid | Time display, paid only changeable, default TRUE |
option.controlBtn.volume | N | Boolean | Paid | Volume control, paid only changeable, default TRUE |
option.controlBtn.setting | N | Boolean | Paid | Setting button exposure, paid only changeable, default TRUE |
option.descriptionNotVisible | N | Boolean | Paid | Hide video metadata UI, paid only available to set metadata, default FALSE |
option.playRateSetting | N | Array | Paid | Options for selecting the playback speed Only those charged can be changed. Default option value: [0.5,0.75,1,1.5,2] |
option.progressBarColor | N | String | Paid | Control bar color, paid only changeable Default value: #4299f5 |
option.seekingPreview | N | Boolean | Paid | Preview of video section seeking, default TRUE |
option.setStartTime | N | String | Paid | Initial release date |
option.startMutedInfoNotVisible | N | Boolean | Paid | Mute notifications, default FALSE |
option.keyboardShortcut | N | Boolean | Paid | Keyboard shortcuts status, default value TRUE |
option.touchGestures | N | Boolean | Paid | Enable touch gestures |
option.ui | N | String | Paid | UI settings, default value all Option settings are available only for paid ones: all, mobile, pc |
option.lowLatencyMode | N | Boolean | Paid | Supports LL-HLS ultra-delay mode, always maintains the latest section of LIVE video Default value: FALSE |
option.customBtns | N | Array | Paid | Add Custom button (up to 4) |
option.customBtns.ui | Y | String | Paid | Custom button device environment UI (PC, MOBILE) |
option.customBtns.position | Y | String | Paid | Custom button position settings (left-top, left-bottom, right-top, right-bottom |
option.customBtns.flow | N | String | Paid | Custom button creation position settings (left, right, Default value: left) |
option.customBtns.icon | Y | String | Paid | Custom button image URL settings |
Request Examples
GET /api/v1/players/option?player_no=1
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
Success code
HttpStatusCode | Code | Message |
---|---|---|
200 | 200 | ok |
Errors
HttpStatusCode | Code | Message | Description |
---|---|---|---|
200 | 4601 | Query string player_no is missing. | |
200 | 4801 | No player information. |
Response examples
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": "string",
"message": "string",
"result": {
"env": "string",
"option": {
"aspectRatio": "string",
"autoPause": true,
"autostart": true,
"controlActiveTime": 0,
"controlBtn": {
"fullscreen": true,
"pictureInPicture": true,
"play": true,
"setting": true,
"times": true,
"volume": true
},
"controls": true,
"descriptionNotVisible": true,
"keyboardShortcut": true,
"muted": true,
"objectFit": "string",
"playRateSetting": [
0
],
"progressBarColor": "string",
"repeat": true,
"seekingPreview": true,
"startMutedInfoNotVisible": true,
"touchGestures": true,
"ui": "string"
}
}
}
Was this article helpful?