View Player Option
    • PDF

    View Player Option

    • PDF

    Article summary

    The following details how to view options set in a player.

    Requests

    GET {API_URL}/players/{player_no}/options
    

    Request Parameters

    Field nameRequirement statusTypeRestrictionsDescription
    player_noYIntegerPath ParameterPlayer number

    Responses

    Field nameTypeDescriptionRemarks
    resultObject
    result.envStringEnvironment
    result.optionsString(json)Set options

    Player option information

    Field nameRequirement statusTypeLimitDescription
    player_noYIntegerPlayer number
    optionYObject(json)Player option information
    option.aspectRatioNStringFree/PaidAspect ratio, default 16/9,
    option: 16/9, 4/3, 1/1, 9/16, 21/9
    option.autoPauseNBooleanFree/PaidAutomatically stop playback when disabled
    option.autostartNBooleanFree/PaidAutomatic playback status, default value TRUE
    option.repeatNBooleanFree/PaidRepeat video, default FALSE
    option.langNStringFree/PaidUI language setting, default value: auto
    option: auto, ko, en, ja
    option.mutedNBooleanFree/PaidMute, default FALSE
    option.objectFitNStringFree/PaidFit image to screen, default contain,
    option: contain, cover, fill
    option.controlActiveTimeNIntegerFree/PaidActive time of control bar (ms)
    default value 3000
    option.controlsNBooleanFree/PaidUse of the control bar, default value TRUE
    option.controlBtnNObjectPaidSetting for exposure of control bar button, paid only changeable
    option.controlBtn.fullscreenNBooleanPaidFull screen, paid only changeable, default TRUE
    option.controlBtn.pictureInPictureNBooleanPaidMini player, paid only changeable, default TRUE
    option.controlBtn.playNBooleanPaidPlay button exposure, paid only changeable, default TRUE
    option.controlBtn.timesNBooleanPaidTime display, paid only changeable, default TRUE
    option.controlBtn.volumeNBooleanPaidVolume control, paid only changeable, default TRUE
    option.controlBtn.settingNBooleanPaidSetting button exposure, paid only changeable, default TRUE
    option.descriptionNotVisibleNBooleanPaidHide video metadata UI, paid only available to set metadata, default FALSE
    option.playRateSettingNArrayPaidOptions for selecting the playback speed
    Only those charged can be changed. Default option value: [0.5,0.75,1,1.5,2]
    option.progressBarColorNStringPaidControl bar color, paid only changeable
    Default value: #4299f5
    option.seekingPreviewNBooleanPaidPreview of video section seeking, default TRUE
    option.setStartTimeNStringPaidInitial release date
    option.startMutedInfoNotVisibleNBooleanPaidMute notifications, default FALSE
    option.keyboardShortcutNBooleanPaidKeyboard shortcuts status, default value TRUE
    option.touchGesturesNBooleanPaidEnable touch gestures
    option.uiNStringPaidUI settings, default value all
    Option settings are available only for paid ones: all, mobile, pc
    option.lowLatencyModeNBooleanPaidSupports LL-HLS ultra-delay mode, always maintains the latest section of LIVE video
    Default value: FALSE
    option.customBtnsNArrayPaidAdd Custom button (up to 4)
    option.customBtns.uiYStringPaidCustom button device environment UI (PC, MOBILE)
    option.customBtns.positionYStringPaidCustom button position settings (left-top, left-bottom, right-top, right-bottom
    option.customBtns.flowNStringPaidCustom button creation position settings (left, right, Default value: left)
    option.customBtns.iconYStringPaidCustom 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

    HttpStatusCodeCodeMessage
    200200ok

    Errors

    HttpStatusCodeCodeMessageDescription
    2004601Query string player_no is missing.
    2004801No 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?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.