플레이어 옵션 develop 환경 배포

Prev Next

설정한 플레이어 옵션을 development 환경에 배포하는 방법은 다음과 같습니다.

요청

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

플레이어 옵션 정보

필드명 필수 여부 타입 제한 설명
player_no Y Integer Path Parameter 플레이어 번호
option Y Object(json) 플레이어 옵션 정보
option.aspectRatio N String 무/유료 화면비, 기본 값 16/9,
옵션: 16/9 , 4/3 , 1/1 , 9/16 , 21/9
option.autoPause N Boolean 무/유료 비활성화시 재생 자동 멈춤
option.autostart N Boolean 무/유료 자동 재생 여부, 기본 값 TRUE
option.repeat N Boolean 무/유료 영상 반복, 기본 값 FALSE
option.lang N String 무/유료 UI 언어 설정, 기본 값: auto
옵션: auto , ko , en , ja
option.muted N Boolean 무/유료 음소거, 기본값 FALSE
option.objectFit N String 무/유료 영상 화면 맞춤, 기본값 contain,
옵션: contain , cover , fill
option.controlActiveTime N Integer 무/유료 컨트롤바 활성 시간(ms)
기본 값 3000
option.controls N Boolean 무/유료 컨트롤바 사용 여부 , 기본 값 TRUE
option.controlBtn N Object 유료 컨트롤바 버튼 노출 여부 설정 , 유료만 변경 가능
option.controlBtn.fullscreen N Boolean 유료 전체 화면, 유료만 변경 가능 , 기본 값 TRUE
option.controlBtn.pictureInPicture N Boolean 유료 미니 플레이어, 유료만 변경 가능 , 기본 값 TRUE
option.controlBtn.play N Boolean 유료 플레이버튼 노출, 유료만 변경 가능 , 기본 값 TRUE
option.controlBtn.times N Boolean 유료 시간표시, 유료만 변경 가능 , 기본 값 TRUE
option.controlBtn.volume N Boolean 유료 볼륨조절, 유료만 변경 가능 , 기본 값 TRUE
option.controlBtn.subtitle N Boolean 유료 자막제어 버튼 노출, 유료만 변경 가능 , 기본 값 TRUE
option.controlBtn.setting N Boolean 유료 설정버튼 노출, 유료만 변경 가능 , 기본 값 TRUE
option.controlBtn.progressBar N Boolean 유료 재생바 사용여부 , 기본 값 TRUE
option.descriptionNotVisible N Boolean 유료 영상 메타 데이터 UI 숨기기, 유료만 메타데이터 설정 가능, 기본 값 FALSE
option.playRateSetting N Array 유료 배속 선택 옵션
유료만 변경 가능 , 기본 값: [0.5,0.75,1,1.5,2], 선택가능 옵션: [0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5]
option.progressBarColor N String 유료 컨트롤바 컬러, 유료만 변경가능
기본 값 : #4299f5
option.seekingPreview N Boolean 유료 영상 구간 이동 미리보기 ,기본 값 TRUE
option.startMutedInfoNotVisible N Boolean 유료 음소거 알림, 기본 값 FALSE
option.keyboardShortcut N Boolean 유료 키보드 단축키 여부, 기본 값 TRUE
option.touchGestures N Boolean 유료 터치 제스쳐 활성
option.ui N String 유료 UI 설정, 기본 값 all
유료만 옵션 설정 가능: all, mobile, pc
option.lowLatencyMode N Boolean 유료 LL-HLS 초지연모드 대응 , LIVE영상을 항상 최신 구간으로 유지
기본 값: FALSE
option.customBtns N Array 유료 커스텀 버튼 추가 (최대 4개)
option.customBtns.ui Y String 유료 커스텀 버튼 디바이스 환경 UI (PC, MOBILE)
option.customBtns.position Y String 유료 커스텀 버튼 위치 설정 (left-top, left-bottom, right-top, right-bottom
option.customBtns.flow N String 유료 커스텀 버튼 생성 위치 설정 (left, right, 기본값: left)
option.customBtns.icon Y String 유료 커스텀 버튼 이미지 URL 설정

요청 예시

PUT /api/v1/players/1/applyDev
HOST: vpe.apigw.gov-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=

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,
      "progressBar": true
    },
    "controls": true,
    "descriptionNotVisible": true,
    "keyboardShortcut": true,
    "lang": "auto",
    "lowLatencyMode": true,
    "muted": true,
    "objectFit": "string",
    "playRateSetting": [0.5,0.75,1,1.5,2],
    "progressBarColor": "string",
    "repeat": true,
    "seekingPreview": true,
    "startMutedInfoNotVisible": true,
    "touchGestures": true,
    "ui": "string",
    "visibleWatermark": true
  }
}

성공 코드

HttpStatusCode Code Message
200 200 ok

에러 코드

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

응답 예시

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": "200",
  "message": "ok"
}

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