Deploy player (develop)

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in Classic and VPC

Deploy player settings to the develop environment.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Video Player Enhancement APIs, see Video Player Enhancement request headers.

Request path parameters

You can use the following path parameters with your request:

Request body

You can include the following data in the body of your request:

customBtns

The following describes customBtns.

Request example

The request example is as follows:

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}"
            }
        ]
    }
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For information about the HTTP status codes common to all Video Player Enhancement APIs, see Common Video Player Enhancement response status codes.

Response example

The response example is as follows:

{
    "code": "200",
    "message": "ok"
}