플레이어 배포(Develop)

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

플레이어 설정을 Develop 환경에 배포합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
PUT /api/v1/players/{player_no}/applyDev

요청 헤더

Video Player Enhancement API에서 공통으로 사용하는 헤더에 대한 정보는 Video Player Enhancement 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
player_no String Required 플레이어 번호

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
option Object Required 플레이어 옵션 정보
  • Standard 요금제: 전체 옵션 지원
  • Basic 요금제: 일부 옵션 지원
option.touchGestures Boolean Optional 터치 제스처 사용 여부
  • true (기본값) | false
    • true: 사용
    • false: 사용 안 함
option.autostart Boolean Optional 자동 재생 여부
  • true (기본값) | false
    • true: 사용
    • false: 사용 안 함
  • Basic 요금제에서 사용 가능
option.controlBtn Object Optional 컨트롤바 버튼 설정
option.controlBtn.fullscreen Boolean Optional 풀스크린(전체 화면) 버튼 표시 여부
  • true (기본값) | false
    • true: 표시
    • false: 표시 안 함
option.controlBtn.pictureInPicture Boolean Optional PIP(미니 플레이어 전환) 버튼 표시 여부
  • true (기본값) | false
    • true: 표시
    • false: 표시 안 함
option.controlBtn.volume Boolean Optional 볼륨 조절 버튼 표시 여부
  • true (기본값) | false
    • true: 표시
    • false: 표시 안 함
option.controlBtn.play Boolean Optional 플레이 버튼 표시 여부
  • true (기본값) | false
    • true: 표시
    • false: 표시 안 함
option.controlBtn.times Boolean Optional 시간 표시 여부
  • true (기본값) | false
    • true: 표시
    • false: 표시 안 함
  • 전체 영상 길이 및 현재 재생 시간 표시
option.controlBtn.setting Boolean Optional 설정 버튼 표시 여부
  • true (기본값) | false
    • true: 표시
    • false: 표시 안 함
  • 영상 해상도 및 배속 설정 버튼 표시
option.controlBtn.subtitle Boolean Optional 자막 선택 버튼 표시 여부
  • true (기본값) | false
    • true: 표시
    • false: 표시 안 함
option.controlBtn.progressBar Boolean Optional 재생바 표시 여부
  • true (기본값) | false
    • true: 표시
    • false: 표시 안 함
option.autoPause Boolean Optional 브라우저 비활성 시 자동 정지 여부
  • true (기본값) | false
    • true: 사용
    • false: 사용 안 함
  • Basic 요금제에서 사용 가능
option.seekingPreview Boolean Optional 구간 이동 미리 보기 표시 여부
  • true (기본값) | false
    • true: 표시
    • false: 표시 안 함
option.descriptionNotVisible Boolean Optional 디스크립션(영상 제목 및 메타데이터 UI 표시) 사용 여부
  • true | false (기본값)
    • true: 사용
    • false: 사용 안 함
option.playRateSetting Array Optional 재생 배속 옵션 목록
  • 0.5 | 0.75 | 1 | 1.25 | 1.5 | 2 | 2.25 | 2.5 (기본값: 0.5,0.75,1,1.5,2)
option.repeat Boolean Optional 반복 재생 여부
  • true | false (기본값)
    • true: 반복
    • false: 반복 안 함
  • Basic 요금제에서 사용 가능
option.startMutedInfoNotVisible Boolean Optional 재생 시작 시 음소거 여부
  • true | false (기본값)
    • true: 음소거
    • false: 소리 재생
option.ui String Optional 컨트롤 UI 유형
  • all (기본값) | mobile | pc
    • all: 자동 변환
    • mobile: 모바일
    • pc: PC
option.aspectRatio String Optional 화면비
  • 16/9 (기본값) | 4/3 | 1/1 | 9/16 | 21/9
  • Basic 요금제에서 사용 가능
option.controlActiveTime Integer Optional 컨트롤바 자동 숨김 시간(밀리초)
  • 1500 | 2000 | 3000 (기본값) | 4000 | 5000
  • Basic 요금제에서 사용 가능
option.muted Boolean Optional 음소거 알림창 표시 여부
  • true | false (기본값)
    • true: 사용
    • false: 사용 안 함
  • Basic 요금제에서 사용 가능
option.controls Boolean Optional 컨트롤바 사용 여부
  • true (기본값) | false
    • true: 사용
    • false: 사용 안 함
  • Basic 요금제에서 사용 가능
option.progressBarColor String Optional 컨트롤바 컬러
  • #4299f5 (기본값)
option.keyboardShortcut Boolean Optional 키보드 단축키 사용 여부
  • true (기본값) | false
    • true: 사용
    • false: 사용 안 함
option.objectFit String Optional 화면 채움 방식
  • contain (기본값) | cover | fill
    • contain: 비율 맞춤
    • cover: 비율 맞춤+꽉 채움
    • fill: 비율 무시+꽉 채움
  • Basic 요금제에서 사용 가능
option.lowLatencyMode Boolean Optional 초저지연 모드 사용 여부
  • true | false (기본값)
    • true: 사용
    • false: 사용 안 함
  • 사용 시 라이브 영상을 항상 최신 구간으로 유지
option.lang String Optional 언어 설정
  • auto (기본값) | ko | en | ja
    • auto: 자동
    • ko: 한국어
    • en: 영어
    • ja: 일본어
  • Basic 요금제에서 사용 가능
option.visibleWatermark Boolean Optional 텍스트 워터 마크 사용 여부
  • true | false (기본값)
    • true: 사용
    • false: 사용 안 함
option.watermarkConfig Object Conditional 텍스트 워터 마크 상세 옵션 설정
  • option.visibleWatermarktrue인 경우, 하위 정보 포함하여 필수 입력
option.watermarkConfig.randPosition Boolean Conditional 위치 랜덤 여부
  • true | false
    • true: 사용
    • false: 사용 안 함
option.watermarkConfig.randPositionInterVal Integer Conditional 노출 인터벌(밀리초)
  • 3000 | 5000 | 10000 | 30000 | 60000
  • option.watermarkConfig.randPositiontrue인 경우, 필수 입력
option.watermarkConfig.x Integer Conditional 수평 오프셋
  • 0~100
  • 워터 마크의 가로 위치 값을 백분율로 입력
  • option.watermarkConfig.randPositionfalse인 경우, 필수 입력
option.watermarkConfig.y Integer Conditional 수직 오프셋
  • 0~100
  • 워터 마크의 세로 위치 값을 백분율로 입력
  • option.watermarkConfig.randPositionfalse인 경우, 필수 입력
option.watermarkConfig.opacity Float Conditional 투명도
  • 0.1~1 (기본값: 0.2)
  • 숫자가 높을수록 불투명
  • option.watermarkConfig.randPositionfalse인 경우, 필수 입력
option.iosFullscreenNativeMode Boolean Optional iOS 모바일 사파리에 대응하는 풀스크린(전체 화면) 모드 설정 지원 여부
  • true | false
    • true: 지원
    • false: 지원 안 함
  • 1.1.5 버전 이상 또는 최신 버전만 지원
option.customBtns Array Optional 커스텀 버튼 설정: customBtns
  • 최대 4개까지 추가 가능
  • 설정 시 하위 정보 필수 입력

customBtns

customBtns에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
ui String Conditional 버튼 UI 환경
  • PC (기본값) | MOBILE
    • PC: PC
    • MOBILE: 모바일
flow String Conditional 생성 위치
  • left (기본값)| right
    • left: 왼쪽
    • right: 오른쪽
  • position 위치에 기존 버튼 존재 시 해당 버튼의 왼쪽 또는 오른쪽에 생성
position String Conditional 버튼 위치
  • left-top | left-bottom | right-top (기본값) | right-bottom
    • left-top: 좌측 상단
    • left-bottom: 좌측 하단
    • right-top: 우측 상단
    • right-bottom: 우측 하단
icon String Conditional 버튼 이미지 URL

요청 예시

요청 예시는 다음과 같습니다.

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

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
code String - 응답 코드
message String - 응답 메시지

응답 상태 코드

Video Player Enhancement API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Video Player Enhancement 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

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