Deploy player option to development environment

Article summary

Did you find this summary helpful?

Thank you for your feedback

The following describes how to deploy the configured player options to the development environment.

Request

PUT {API_URL}/players/{player_no}/applyDev

Player option information

Field name	Required	Type	Restrictions	Description
player_no	Y	Integer	Path Parameter	Player number
option	Y	Object (json)		Player option information
option.aspectRatio	N	String	Free/paid	Aspect ratio, default: 16/9 Options: 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: TRUE
option.repeat	N	Boolean	Free/paid	Repeat video, default: FALSE
option.lang	N	String	Free/paid	Set UI language, default: auto Options: auto, ko, en, ja
option.muted	N	Boolean	Free/paid	Mute, default: FALSE
option.objectFit	N	String	Free/paid	Fit video to screen, default: contain, Options: contain, cover, fill
option.controlActiveTime	N	Integer	Free/paid	Control bar active time (ms) Default: 3000
option.controls	N	Boolean	Free/paid	Whether to use the control bar, default: TRUE
option.controlBtn	N	Object	Paid	Set control bar button visibility, changeable for paid users only
option.controlBtn.fullscreen	N	Boolean	Paid	Full screen, changeable for paid users only, default: TRUE
option.controlBtn.pictureInPicture	N	Boolean	Paid	Mini player, changeable for paid users only, default: TRUE
option.controlBtn.play	N	Boolean	Paid	Display play button, changeable for paid users only, default: TRUE
option.controlBtn.times	N	Boolean	Paid	Display time, changeable for paid users only, default: TRUE
option.controlBtn.volume	N	Boolean	Paid	Adjust volume, changeable for paid users only, default: TRUE
option.controlBtn.subtitle	N	Boolean	Paid	Display subtitle control button, changeable for paid users only, default: TRUE
option.controlBtn.setting	N	Boolean	Paid	Display settings button, changeable for paid users only, default: TRUE
option.descriptionNotVisible	N	Boolean	Paid	Hide video metadata UI, only paid users can set metadata, default: FALSE
option.playRateSetting	N	Array	Paid	Play speed selection options Changeable for paid users only, default option value: [0.5, 0.75, 1, 1.5, 2]
option.progressBarColor	N	String	Paid	Control bar color, changeable for paid users only Default: #4299f5
option.seekingPreview	N	Boolean	Paid	Preview video segment movement, default: TRUE
option.startMutedInfoNotVisible	N	Boolean	Paid	Mute indication, default: FALSE
option.keyboardShortcut	N	Boolean	Paid	Keyboard shortcut status, default: TRUE
option.touchGestures	N	Boolean	Paid	Activate touch gestures
option.ui	N	String	Paid	Set UI, default: all Only paid users can set options: all, mobile, pc
option.lowLatencyMode	N	Boolean	Paid	Respond to LL-HLS ultra-latency mode and keep live video always in the latest segment Default: FALSE
option.customBtns	N	Array	Paid	Add custom buttons (up to 4)
option.customBtns.ui	Y	String	Paid	Custom button device environment UI (PC, MOBILE)
option.customBtns.position	Y	String	Paid	Set custom button location (left-top, left-bottom, right-top, right-bottom
option.customBtns.flow	N	String	Paid	Set custom button creation location (left, right, default: left)
option.customBtns.icon	Y	String	Paid	Set custom button image URL

Request example

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
  }
}

Success code

HttpStatusCode	Code	Message
200	200	ok

Errors

HttpStatusCode	Code	Message
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

Response example

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

// Upon success
{
  "code": "200",
  "message": "ok"
}

// Upon failure
"error": {
    "errorCode": "4804",
    "message": "The feature can't be used in the free version of player. "
  }
}

Was this article helpful?

What's Next

Distribution of Player Option Production Environment

Table of contents

Request