Get player options

Available in Classic and VPC

Get information about the options set for a player.

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 example

The request example is as follows:

curl --location --request GET 'https://vpe.apigw.ntruss.com/api/v1/players/6144/options' \
--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'

Response

This section describes the response format.

Response body

The response body includes the following data:

customBtns

The following describes customBtns.

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",
    "result": {
        "env": "dev",
        "option": {
            "touchGestures": true,
            "autostart": true,
            "controlBtn": {
                "fullscreen": true,
                "pictureInPicture": true,
                "volume": true,
                "play": true,
                "times": true,
                "setting": true,
                "subtitle": false,
                "progressBar": true
            },
            "autoPause": true,
            "seekingPreview": true,
            "descriptionNotVisible": false,
            "playRateSetting": [
                0.5,
                1,
                1.5,
                2,
                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,
            "customBtns": [
                {
                    "ui": "pc",
                    "flow": "left",
                    "position": "right-bottom",
                    "icon": "{Icon URL}"
                }
            ],
            "watermarkConfig": {
                "randPosition": true,
                "randPositionInterVal": 60000,
                "x": null,
                "y": null,
                "opacity": null
            }
        }
    }
}