플레이어 옵션 조회
    • PDF

    플레이어 옵션 조회

    • PDF

    기사 요약

    플레이어에 설정된 옵션을 조회하는 방법은 다음과 같습니다.

    요청

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

    요청 파라미터

    필드명필수 여부타입제약 사항설명
    player_noYIntegerPath Parameter플레이어 번호

    응답

    필드명타입설명비고
    resultObject
    result.envString환경
    result.optionsString(json)설정된 옵션

    플레이어 옵션 정보

    필드명필수 여부타입제한설명
    player_noYInteger플레이어 번호
    optionYObject(json)플레이어 옵션 정보
    option.aspectRatioNString무/유료화면비, 기본 값 16/9,
    옵션: 16/9 , 4/3 , 1/1 , 9/16 , 21/9
    option.autoPauseNBoolean무/유료비활성화시 재생 자동 멈춤
    option.autostartNBoolean무/유료자동 재생 여부, 기본 값 TRUE
    option.repeatNBoolean무/유료영상 반복, 기본 값 FALSE
    option.langNString무/유료UI 언어설정, 기본 값: auto
    옵션: auto , ko , en , ja
    option.mutedNBoolean무/유료음소거, 기본값 FALSE
    option.objectFitNString무/유료영상 화면 맞춤, 기본값 contain,
    옵션: contain , cover , fill
    option.controlActiveTimeNInteger무/유료컨트롤바 활성 시간(ms)
    기본 값 3000
    option.controlsNBoolean무/유료컨트롤바 사용 여부 , 기본 값 TRUE
    option.controlBtnNObject유료컨트롤바 버튼 노출 여부 설정 , 유료만 변경 가능
    option.controlBtn.fullscreenNBoolean유료전체 화면, 유료만 변경 가능 , 기본 값 TRUE
    option.controlBtn.pictureInPictureNBoolean유료미니 플레이어, 유료만 변경 가능 , 기본 값 TRUE
    option.controlBtn.playNBoolean유료플레이버튼 노출, 유료만 변경 가능 , 기본 값 TRUE
    option.controlBtn.timesNBoolean유료시간표시, 유료만 변경 가능 , 기본 값 TRUE
    option.controlBtn.volumeNBoolean유료볼륨조절, 유료만 변경 가능 , 기본 값 TRUE
    option.controlBtn.settingNBoolean유료설정버튼 노출, 유료만 변경 가능 , 기본 값 TRUE
    option.descriptionNotVisibleNBoolean유료영상 메타 데이터 UI 숨기기, 유료만 메타데이터 설정 가능, 기본 값 FALSE
    option.playRateSettingNArray유료배속 선택 옵션
    유료만 변경 가능 , 기본옵션 값: [0.5,0.75,1,1.5,2]
    option.progressBarColorNString유료컨트롤바 컬러, 유료만 변경가능
    기본 값 : #4299f5
    option.seekingPreviewNBoolean유료영상 구간 이동 미리보기 ,기본 값 TRUE
    option.setStartTimeNString유료최초 공개일
    option.startMutedInfoNotVisibleNBoolean유료음소거 알림, 기본 값 FALSE
    option.keyboardShortcutNBoolean유료키보드 단축키 여부, 기본 값 TRUE
    option.touchGesturesNBoolean유료터치 제스쳐 활성
    option.uiNString유료UI 설정, 기본 값 all
    유료만 옵션 설정 가능: all, mobile, pc
    option.lowLatencyModeNBoolean유료LL-HLS 초지연모드 대응 , LIVE영상을 항상 최신 구간으로 유지
    기본 값: FALSE
    option.customBtnsNArray유료커스텀 버튼 추가 (최대 4개)
    option.customBtns.uiYString유료커스텀 버튼 디바이스 환경 UI (PC, MOBILE)
    option.customBtns.positionYString유료커스텀 버튼 위치 설정 (left-top, left-bottom, right-top, right-bottom
    option.customBtns.flowNString유료커스텀 버튼 생성 위치 설정 (left, right, 기본값: left)
    option.customBtns.iconYString유료커스텀 버튼 이미지 URL 설정

    요청 예시

    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
    

    성공 코드

    HttpStatusCodeCodeMessage
    200200ok

    에러 코드

    HttpStatusCodeCodeMessageDescription
    2004601Query string player_no is missing.
    2004801No player information.

    응답 예시

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

    이 문서가 도움이 되었습니까?

    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.