V/G Controller
V/G Controller
Latest version 1.3.0
개요
Kollus VG Controller는 Videogateway로 제공되는 미디어의 일부 컨트롤을 고객사 웹사이트 내에서 구현 할 수 있도록 지원 하는 Javascript library입니다. Kollus VG Controller는 다음과 같은 특징을 가지고 있습니다.
Videogateway에서 자동으로 실행되는 플레이어의 타입에 관계없이 동일한 코드로 제어 가능
간단한 설치 + 쉬운 사용방법
플레이어의 감지 실행을 고민할 필요가 없음
서드파티 자바스크립트 라이브러리가 필요치 않음
메소드와 이벤트 목록 이름 옆에 표기되는 V3, V4 Player(1) 등은 Player를 의미합니다.
시작하기
VgControllerClient
(고객사 html page에 삽입)
아래 예시 코드를 영상이 보여질 html page에 적용하시면 됩니다.
...
<script src="/path/to/vg-controller-client.1.1.16.min.js"></script>
<script>
window.onload = function () {
try {
var controller = new VgControllerClient({
target_window: document.getElementById('child').contentWindow,
});
// 여기서부터 이벤트 리스너를 등록하거나, 웹페이지 Element에 메소드를 bind하면 됩니다.
} catch (e) {
// Videogateweay Controller Library는 window.postMessage API를 이용하기 때문에
// 해당 기능을 지원하지 않는 웹브라우져에서는 동작하지 않습니다.
// 이 부분에 적절한 fail-over 코드를 추가하여 주십시요.
console.error(e);
}
};
</script>
<body>
<iframe id="child" src="http://v.kr..."></iframe>
</body>
...
VgControllerClient 생성시 파라미터로 전달하는 target_window의 경우 홈페이지에 첨부한 Kollus Videogateway iframe의 HTMLElement에 contentWindow 속성을 입력해야 합니다
본 스크립트는 window.postMessage API 를 이용하여 Player와 통신하므로, 해당 기능을 지원하지 않는 웹브라우져에 서는 동작하지 않습니다.
웹페이지 내에 하나 이상의 iframe을 embed한 경우 제어할 iframe마다 서로 다른 VgControllerClient 를 생성해야 합니다.
이전 버전과의 호환성을 위해 (v0.5이하) new VgControllerClient() 대신 new Kollus.VideogatewayController() 를 사용해도 정상적으로 작동합니다.
try-catch문의 Exception code list는 다음과 같습니다.
code | message | description |
---|---|---|
-1 | * | PostMessage API exception code |
-99 | player type is not defined | Player type이 정의되지 않았습니다. |
-99 | player type must be one of v2, v3, v4 and flash | Player type이 유효한 값이 아닙니다. |
-99 | this browser does not support postMessage | 브라우저가 PostMessage API를 지원하지 않습니 다 |
-99 | listener is not callable | 이벤트 리스너가 함수형이 아닙니다. |
CDN
Vg-Controller Client Library를 CDN으로 제공합니다. 가장 최신 버전의 라이브러리를 사용하시려면 아래 링크를 삽입하시면 됩니다
https://file.kollus.com/vgcontroller/vg-controller-client.latest.min.js
이전 버전의 라이브러리를 사용하시려면 latest 대신 버전명으로 변경하여 호출하시면 됩니다.
https://file.kollus.com/vgcontroller/vg-controller-client.1.1.4.min.js
Integrity 속성을 사용하면 VG-Controller Client Library의 악의적인 스크립트 변조를 방지할 수 있습니다. 스크립트 호출시 버전에 맞는 Integrity 속성값을 추가해 주시면 됩니다.
버전별 Integrity 속성값은 여기를 참고하세요.
이벤트 리스닝
플레이어로부터 수신되는 각종 이벤트 발생시 사용자가 정의한 callback 함수를 실행하도록 이벤트 리스너(Event Listener)를 등록하는 방법입니다.
하나의 이벤트에 하나 이상의 리스너를 등록할 수도 있습니다. 이 경우 이벤트 발생시에 등록된 모든 리스너가 실행됩니다
이벤트 리스너를 등록하는 함수인 on 은 메소드 체이닝(Method chaining)을 지원합니다.
하나 이상의 리스너를 등록한 경우 이벤트 발생시에 등록된 모든 리스너가 실행됩니다. 다만, 자바스크립트 이벤트 루프와 callback 함수가 실행되는 방식에 의해, 실행 순서가 바뀔 수 있습니다.
이벤트 목록 | |||
---|---|---|---|
loaded | 플레이어 로딩이 완료되면 이벤트가 발생합니다. | v3, v4 | |
ready | 플레이어 로딩이 끝나고 재생 정보를 서버로부터 획득하였으며, 실제 재생준비가 완료된 시점입니다. | v3, v4 | |
play | 재생 시작시에 발생합니다. 초기 재생 시작을 제외하고 일시 멈춤 상태에서 다시 재생을 시작할때도 발생합니다. | v3, v4 | |
progress | 재생시 매초마다 발생합니다. 단, HTML5 Video Player의 구조상 progress 이벤트가 정확하게 1초마다 발생하지 않을수 있습니다. (0.1에서 최대 0.5초 가량 차이가 날 수도 있습니다.) progress 이벤트로 작업하실 경우 이 부분을 유념하여 주십시요. Parameters:
| v3, v4 | |
pause | 일시 정지시에 발생합니다. | v3, v4 | |
done | 재생 완료시에 발생합니다. 재생 완료는 duration의 끝까지 모두 재생한 경우를 의미합니다. | v3, v4 | |
muted | 음소거 상태가 변경시 호출됩니다. (음소거시, 음소거 해제시 모두 발생) 다만, V2 Player의 경우 현재 muted 이벤트를 제공하지 않습니다. 대신 음소거가 되는 경우 volumechange 이벤트가 발생되고 변경된 음량을 0으로 제공합니다. Parameters:
| v3, v4 | |
seeking | 플레이 시점 변경시 호출됩니다. | v4 | |
seeked | 플레이 시점 변경이 끝났을 때 호출됩니다. | v4 | |
screenchange | 전체, 일반화면 변경시 발생합니다. screen 파라미터는 windowed, fullscreen 2가지 문자열 가운데 하나를 제공합니다. Parameters:
| v3, v4 | |
volumechange | 음량 변경시 발생합니다. Parameters:
| v3, v4 | |
speedchange | 배속 변경시 발생합니다. 배속 최대값은 Player의 설정에 따라 바뀔 수 있습니다. Parameters:
| v3, v4 | |
playbackrateschange | 배속 단위를 설정하는 배속값 그룹 변경시 발생합니다. Parameters:
| v3, v4 | |
videosettingchange | 비디오 속성 변경시 발생합니다. 비디오 속성 변경 기능은 V2 Player에만 존재하는 기능입니다. 다른 Player에서는 이벤트를 발생시키지 않습니다. Parameters:
| v3 | |
jumpstepchange | ff, rw 메소드를 통해 이동할 시간값 변경시 발생합니다. Parameters:
| v3, v4 | |
subtitlevisibilitychange | 자막의 화면출력 상태가 변경되면 발생합니다. Parameters:
| v3, v4 | |
hlsfragchange | hls의 frag(2)가 변경되면 발생합니다. | v4 | |
html5_video_supported | V3, V4 Player에서만 발생합니다. Player가 내부에서 HTML5 Video 재생기능을 사용할 수 있다고 판단하여 HTML5 Video Player를 로드할 경우엔 true 를, 전용 플레이어를 재생해야 한다고 판단할 경우엔 false를 리턴합니다. (http://caniuse.com/#feat=video 참조) Parameters:
| v3, v4 | |
error | Player가 재생오류를 반환하는 경우 발생합니다. Parameters:
| v3, v4 | |
device_orientation_changed | 모바일 디바이스인 경우 가로/세로 회전시 발생합니다. Parameters:
| v4 | |
hls_manifest_loaded | v4 player hls manifest 가 로드될 시 발생합니다.
Parameters:
| v4 |
|
dash_manifest_loaded | v4 player dash manifest 가 로드될 시 발생합니다.
Parameters:
| v4 |
|
bitrate_data_loaded | Hls/Dash manifest가 로드 된 후 Bitrate 데이터를 오름차순으로 정렬한 후 배열에 담아 반환합니다. Parameters:
| v4 | |
bookmark_change | v3 북마크 추가, 업데이트, 삭제시 발생합니다. Parameters:
| V3 | |
waiting | 재생중 waiting 이벤트가 발생될 때 1초마다 호출됩니다 Parameters:
| V4 |
|
user_active_changed | 플레이어 컨트롤바가 활성/비활성화 될 때 이벤트를 발생합니다. Parameters:
| V4 |
|
next_episode_auto_change | 다음 회 자동재생 상태가 변경되면 발생합니다. next_episode_change 이벤트는 deprecated 되었습니다. v3/v4에서는 계속 사용 가능하나 권장하지 않습니다. Parameters:
| V3, V4, V5 |
|
next_episode_requested | 다음 회차 Callback API가 호출되면 발생합니다. Parameters:
| V3, V4, V5 |
|
메소드 사용하기
Videogateway Controller Library가 지원하는 메소드를 호출하는 방법은 간단합니다.
이게 전부입니다. 경우에 따라서 파라미터를 요구하는 메소드도 있습니다.
메소드 목록
이벤트 리스너 메소드 | |||
---|---|---|---|
on (event_name, callback_function) | 이벤트 리스너를 등록합니다. Parameters:
Return:
| v3, v4 | |
off(event_name) | 등록된 이벤트 리스너를 제거합니다. Parameters:
Return:
| v3, v4 |
재생 메소드 | |||
---|---|---|---|
get_progress() | 재생 진행중인 위치 정보를 반환합니다. Parameters:
Return:
| v3, v4 | |
play([start_at]) | 동영상을 재생합니다. Parameters:
Return:
| v3, v4 | 특정 지점부터 재생하려면 다음과 같이 재생할 위치를 파라미터로 입력하여 주십시요. |
pause() | 동영상 재생을 일시정지합니다. Parameters:
Return:
| v3, v4 | |
toggle_pip() | PIP(picture-in-picture) 기능을 Toggle 합니다 Parameters:
Return:
| v3, v4 |
|
음향 메소드 | |||
---|---|---|---|
set_volume(volume) | 음량을 변경합니다. 음량은 0 <= volume <= 100 사이의 Integer형 값이어야 합니다. 이 범위를 벗어난 감은 0이나 100으로 재조정 됩니다. Parameters:
Return:
| v3, v4 | |
get_volume() | 현재 설정된 음량을 반환합니다. Parameters:
Return:
| v3, v4 | |
mute() | 음소거를 설정하거나 해제합니다. 음소거가 해제된 상태에서 호출하면 음소거를 설정하고, 반대로 설정된 상태라면 해제합니다. Parameters:
Return:
| v3, v4 |
Seek 메소드 |
---|