Kollus VG Controller는 Videogateway로 제공되는 미디어의 일부 컨트롤을 고객사 웹사이트 내에서 구현 할 수 있도록 지원하는 Javascript library입니다. Kollus VG Controller는 다음과 같은 특징을 가지고 있습니다.
- Videogateway에서 자동으로 실행되는 플레이어의 타입에 관계없이 동일한 코드로 제어 가능
- 간단한 설치 + 쉬운 사용방법
- 플레이어의 감지 실행을 고민할 필요가 없음
- 서드파티 자바스크립트 라이브러리가 필요치 않음
메소드와 이벤트 목록 이름 옆에 표기되는 Flash, V2, V3, V4 Player 등은 해당 메소드나 이벤트를 지원하는Player를 의미합니다.
Flash : 암호화되지 않은 파일의 경우 일반적으로 Flash Player 를 통해 재생됩니다.[^1]
V2 : 암호화된 파일의 경우 일반적으로 V2 Player를 통해 재생됩니다. V2 Player는 IE의 경우 ActiveX, Chrome이나 Firefox의 경우 NPAPI를 이용 하는 Player입니다.[^2]
V3 : 암호화된 파일이 Edge나 Chrome 45버전 이상의 웹브라우져에서 호출될 경우 실행되는 하이브리드 HTML5 Player입니다.
V4 : 암호화되지 않은 파일의 경우 실행되는 HTML5 Player이며 Flash Player를 대체합니다.
이름 옆에 아무 Player도 표시되지 않는 경우는 모든 플레이어가 공통적으로 기능을 지원한다는 의미입니다.
[^1]: Adobe에서 2020년부터 Flash Player에 대한 지원을 중단한다고 발표하였습니다.
[^2]: Chrome 42+ / Firefox 52+ 브라우저에서는 NPAPI 지원을 중단하였습니다.
설치하기
VgControllerClient
(고객사 html page에 삽입)
theme | Midnight |
---|
V/G Controller
Kollus VG ControllerはVideogatewayで提供されるメディアの一部機能を外部から制御するためのJavascript libraryとなります。Kollus VG Controllerは以下の目的で提供しています。
- Playerの種類に関わらず同一コードで制御することが可能
- インストール ・使用が比較的に簡単
- Playerの感知・実行が不要 (Videogatewayから自動で感知・呼出)
- 3rd party Javascript libraryが不要
メソッドとイベントリスト名に表記するFlash, V2, V3, V4 Playerは対応しているPlayerの種類となります。
※注意: V2, V3 PlayerはKolllus VODで暗号化されたコンテンツの再生に使用されるKollus security playerとなり、インストールが必要です。
Flash: 非暗号化ファイルの場合、HTML5 Playerが起動しない環境ではFlash Playerが起動します。[^1]
V2: 暗号化されたファイルの場合、IE(ActiveX), Chrome・Firefox(NPAPI)環境でV2 Playerが起動します。[^2]
V3: 暗号化されたファイルの場合、Edge・Chrome 45以降のブラウザ環境でV3 Player(HTML5基盤暗号化Player)が起動します。
V4: 非暗号化ファイルの場合、基本的にV4 Player(標準 HTML5 Player)が起動します。
メソッド・イベントにPlayerバージョンの表記がないものは全てのPlayerが対応
[^1]: Adobe社から2020年以降にFlash Playerの対応中止を公表しています。
https://blogs.adobe.com/conversations/2017/07/adobe-flash-update.html
[^2]: Chrome 42+ / Firefox 52+ バージョンではNPAPI対応を中止しました。
セットアップ
VgControllerClient
(顧客のhtml pageに挿入)
Code Block | ||
---|---|---|
| ||
... <script src="https://file.kollus.com/vgcontroller/vg-controller-client.latest.min.js"></script> <script> window.onload = function() { try { var controller = new VgControllerClient({ target_window: document.getElementById('child').contentWindow }); // ここからイベントリスナーを登録したり、ウェブページElementにメソッドをbindしてください。 } catch(e) { target_window: document.getElementById('child').contentWindow // Videogateweay Controller Libraryは window.postMessage APIを使用するため、 }); // 여기서부터該当機能に対応していないブラウザでは動作しません。 이벤트 리스너를 등록하거나, 웹페이지 Element에 메소드를 bind하면 됩니다. // ここに適切なfail-overコードを追加してください。 } catch(e) { } }; </script> <body> <iframe id="child" src="http://v.jp..."></iframe> Videogateweay Controller Library는 window.postMessage API를 이용하기 때문에 // 해당 기능을 지원하지 않는 웹브라우져에서는 동작하지 않습니다. // 이 부분에 적절한 fail-over 코드를 추가하여 주십시요. } }; </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() 를 사용해도 정상적으로 작동합니다.
이벤트 리스닝
플레이어로부터 수신되는 각종 이벤트 발생시 사용자가 정의한 callback 함수를 실행하도록 이벤트 리스너(EventListener)를 등록하는 방법입니다.
Code Block | ||
---|---|---|
| ||
controller.on('event_name', function(param) {
// 이벤트 리스너
}); |
Code Block | ||
---|---|---|
| ||
controller.on('event_name', function(param) {
// 첫번째 리스너
});
controller.on('event_name', function(param) {
// 두번째 리스너
});
// 이벤트 발생시 첫번째, 두번째 리스너가 모두 실행
// 다만, 자바스크립트 이벤트 루프와 callback 함수가 실행되는 방식에 의해, 첫번째 리스너가 반드시 먼저
// 실행된다고 보장할 수 없으며, 두번째 리스너가 실행되는 것이 첫번째 리스너가 실행된 뒤인 것도 아닙니다. |
</body>
... |
- VgControllerClient 生成の際にパラメータで転送するtarget_windowには、Webページに添付しているKollus Videogateway iframeのHTMLElementにcontentWindow属性を入力します。
- このスクリプトはwindow.postMessage API を使ってPlayerとの通信を行うため、該当機能に対応していないブラウザでは動作しません。
- Web Page内部に複数のiframeをembedしている場合、制御するiframe毎にVgControllerClient を生成する必要があります。
- 以前バージョンとの互換性を考慮して(v0.5以前) new VgControllerClient()の代わりにnew Kollus.VideogatewayController()を使用しても正常に動作します。
try-catch文のException code listは以下のようになります。
code message -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. イベントリスナーが関数形ではない
VgControllerServer
(Kollus VG view html pageに挿入)
Code Block | ||
---|---|---|
| ||
...
<script src="/path/to/vg-controller-server.1.1.6.min.js"></script>
<script>
window.onload = function() {
try {
var player = [PLAYER オブジェクト Element (v2, v3, v4, flash player)];
var controller = VgControllerServer(player, {
player_type: 'v4', //[v2, v3, v4, flash]
target_window: window.parent,
media_info: {media_info_object} //1.1.4バージョンにて字幕関連メソッドを使用する際に必要です。
});
//player オブジェクトの生成及び初期化が完了されてからイベントを登録してください。
//player オブジェクトが初期化されてない状態で setEventListeners メソッドを呼出す場合、
//VG-Controllerが正常に動作しない可能性があります。
controller.setEventListeners();
} catch(e) {
// VG Controllerは window.postMessage APIを使用しているため、
// 該当機能に対応していないブラウザでは動作しません。
// ここに適切な fail-over コードを追加してください。
}
};
</script>
... |
CDN
Vg-Controller Client LibraryをCDNで提供します。最新バージョンのライブラリを使用するには以下のリンクを挿入してください。
Code Block | ||
---|---|---|
| ||
http://file.kollus.com/vgcontroller/vg-controller-client.latest.min.js |
以前バージョンのライブラリを使用するにはlatestの代わりにバージョン名を入力してください。
Code Block | ||
---|---|---|
| ||
http://file.kollus.com/vgcontroller/vg-controller-client.1.1.4.min.js |
VR Contents (mobile device)
iframe 内部で呼び出す360 VR コンテンツの場合、Android・iOS デバイスで再生する際に正常に動作しません。
- Androidの場合にはOrientation値が正常に適用されないため左/右の方向が逆になることがあります。
- iOSの場合にはiOS 13以降からGyroscopeを正常に動作させるためにはDeviceMotion権限を取得する必要がありますが、
- この権限がiframe内部では取得することができないため正常に動作しません。(iOS 13 未満のバージョンではsafari設定から'動作と方向へのアクセス'オプションを変更しなければなりません。)
上記Android・iOSの動作問題を解決するためにはVG-Controller 1.1.10+ を設置する必要があり、VG-Controller ClientからDeviceMotion イベントを自動で登録してVG-Controller Serverとの通信を行います。(周期的にiframe 外部のイベントをiframe内部に転送します。)
- iOSの場合には上記の内容の上、更にController.set_vr_overlay() メソッドを実行させる必要があります。詳しい内容は以下のメソッド項目からset_vr_overlayメソッドを参考にしてください。
※Known Issue: iOS 13.4 バージョンでは権限を取得しても DeviceMotionの rotationRate値が正常に発生しないエラーが報告されています。
Intent Scheme Call Bug (iframe in Android)
Player ページがiframe内部からVGを呼出す構造になっている場合、稀にAndroidデバイスでKollus security player (Android Player アプリ)が実行されない現象があります。
Android OSでは Intent Schemeを使用して呼出していますが、Chrome + iframe 環境で正常に動作していません。
この場合にはVG-Controller 1.1.15+を使用してください。(VG-Controllerが自動で感知・処理します。)
イベントリスニング
Playerのイベントが発生した際に使用者が定義したcallback関数を実行するためのイベントリスナー(EventListener)を登録する方法となります。
Code Block | ||
---|---|---|
| ||
controller.on('event_name', function(param) {
// イベントリスナー
}); |
単一イベントに複数のリスナーを登録することができます。この場合、イベントが発生すると登録されている全てのリスナーが実行されます。
Code Block | ||
---|---|---|
| ||
controller.on('event_name', function(param) {
// 1番目のリスナー
});
controller.on('event_name', function(param) {
// 2番目のリスナー
});
// イベント発生の際に1番目、2番目リスナーが全て実行
// 但し、JAVA Scriptイベントループとcallback関数の実行方式によって
// リスナーが順番通りに実行されない可能性があります。 |
イベントリスナーを登録する関数である「on」 はメソッドチェイニング(Method chaining)に対応しています。
Code Block | ||
---|---|---|
| ||
controller.on('event_name_1', function(param) {
// 1番目のリスナー
}).on('event_name_2', function(param) {
// 2番目のリスナー
}); |
メソッド使用
Videogateway Controller Libraryが対応するメソッドを呼び出す方法となります。
Code Block | ||
---|---|---|
| ||
controller.play(); |
上記の記載だけで呼び出すことができますが、場合によってはパラメーターが必要なメソッドもあります。
Code Block | ||
---|---|---|
| ||
controller.set_volume(90); |
参考事項
メソッドリスト
on(event_name, callback_function)
イベントリスナーを登録します。
Code Block | ||
---|---|---|
| ||
controller.on('event_name', function(param) {
// event_nameに該当するイベントが発生したとき、2番目の因子であるcallback functionを実行
}); |
Parameters:
- event_name
String
callback functionをbindするイベント名 - callback_function Function イベント発生する際に実行されるcallback functionとなります。場合によってcallback functionにはパラメータが付与されることがあります。
Return:
- Object VG-Controller Client オブジェクトをリターンします。
off(event_name)
登録されたイベントリスナーを削除します。
Code Block | ||
---|---|---|
| ||
controller.off('event_name'); |
Parameters:
- event_name
String
callback functionでbindされたイベント名
Return:
- Object VG-Controller Client オブジェクトをリターンします。
get_progress()
再生進行中の位置情報をリターンします。
Parameters:
No parameter
Return:
Object percent, position, durationをpropertyで持つobjectをリターンします。各入力値の説明はprogressイベントを参考にしてください。
play([start_at])
コンテンツを再生します。
Code Block | ||
---|---|---|
| ||
controller.play(); |
特定時点から再生する場合、以下のように再生する位置をパラメータで入力してください。
Code Block | ||
---|---|---|
| ||
controller.play(10); // 10秒時点から再生 |
Parameters:
- start_at
Integer
(Optional) 再生を開始する位置:省略した場合最初から再生開始
Return:
No return
pause()
コンテンツ再生を一時停止します。
Parameters:
- No parameter
Return:
No return
set_volume(volume)
音量を変更します。音量は 0 <= volume <= 100 の間のIntegerタイプの値を入力します。範囲外の値は0か100に調整されます。
Parameters:
- volume
Integer
変更する音量
Return:
No return
get_volume()
現在設定された音量値をリターンします。
Parameters:
- No parameter
Return:
Integer
現在設定されている音量
mute()
ミュートをOn/Offにします。On/Offはスイッチ方式で作動します。(呼出す度に状態が変更)
Parameters:
- No parameter
Return:
No return
ff()
set_jumpstep メソッドで設定された入力値の通りに現在の再生位置から後ろに移動します。初期値は10秒です。
Parameters:
- No parameter
Return:
No return
rw()
set_jumpstep メソッドで設定された入力値の通りに現在の再生位置から前に移動します。初期値は10秒です。
Parameters:
- No parameter
Return:
No return
_current_time(current_time)
play(start_at) メソッドは該当位置に移動後即時に再生を開始しますが、set_current_time(current_time) メソッドは現在のplaying/paused状態を維持します。
Parameters:
移動する時間
Return:
No return
get_current_time()
現在の位置をリターン
Parameters:
Return:
Number
現在の位置 (小数点5桁まで)
set_screen() V2 V3 V4
全体画面をOn/Offします。On/Offはスイッチ方式で作動します。(呼出す度に状態が変更)
- Flash Player 対応不可
- IE, Firefox対応不可
Parameters:
- No parameter
Return:
No return
get_screen()
現在画面モードをリターン:set_screenの対応有無(V2, V3, V4 Player)に関係なくget_screen関数は全てのPlayerから画面モードをリターンします。
- 全体画面Off : windowed
- 全体画面On : fullscreen
Parameters:
- No parameter
Return:
String
リターンされる現在の画面モード:windowed, fullscreenのいずれかの値
set_jumpstep(jumpstep)
ff メソッド、または rw メソッドで移動する位置を設定します。位置は「秒単位の定数」で入力します。
Parameters:
- jumpstep
Integer
移動する時間値
Return:
No return
get_jumpstep()
現在設定されている移動する時間値をリターン
Parameters:
- No parameter
Return:
Integer
リターンされる時間値
set_control_visibility(visibility)
Player Control panelの表示・非表示を設定:trueは表示、falseは非表示
Parameters:
- visibility
Boolean
Control panelの表示有無
Return:
No return
get_control_visibility()
layer Control panelの表示・非表示設定をリターン
Parameters:
- No parameter
Return:
Boolean
Control panelの表示有無
_video_visibility(visibility) V3 V4
パラメータをtrueにすると表示、falseにすると非表示になります。
Parameters:
visibility
Boolean
Return:
No return
set_speed(speed) V2 V3 V4
倍速範囲を設定します。(0.5 <= speed <= 4) 最大倍速はPlayerの設定により変更することがあります。倍速は0.1刻みで調整することができます。範囲外の値を入力する場合範囲の最低、最大値(0.5と4)で固定されます。
Parameters:
- speed
Integer
設定する倍速値
Return:
No return
get_speed() V2 V3 V4
設定された倍速値をリターン: Javascriptには明確なFloatタイプがないため、小数点を表現するためにStringタイプでリターンします。
Parameters:
- No parameter
Return:
String
設定された倍速値。定数(1, 2, 3, 4)の場合、小数点を表示します。(1.0, 2.0, 3.0, 4.0)
set_playback_rates(playback_rates) V3 V4
倍速値のグループを設定:Array typeとなり順番は無視されます。(Player側で整列してUIを構成)二重配列形態で表示される場合、UIから見られる倍速値グループの行数を設定することができます。この場合、最初の因子は倍速値の配列となり2番目の因子は行数を意味します。ex) [[0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4], 2]
Parameters:
- playback_rates Array 設定する倍速値グループの配列
Return:
No return
get_playback_rates() V3 V4
倍速値グループの配列をリターン
Parameters:
- No parameter
Return:
Array 設定された倍速値グループの配列
set_topmost(topmost) V2
ウィンドウの最上位配置を設定: 最上位に設定した場合、閲覧中のブラウザがバックグラウンドに入っても他のウィンドウより前面に表示されます。
Parameters:
- No parameter
Return:
No return
get_topmost() V2
ウィンドウの最上位配置設定をリターン: V2 Player以外のPlayerから呼出された場合falseをリターンします。
Parameters:
- topmost
Boolean
trueは設定on, falseは設定off
Return:
Boolean
設定内容
set_brightness(brightness) V2
映像の明るさを設定します。この設定はV2 Playerのみ対応します。映像の明るさは -50 <= brightness <= 50となります。範囲外の値を入力する場合範囲の最低、最大値(-50と50)で固定されます。
Parameters:
- brightness
Integer
明るさ設定値
Return:
No return
get_brightness() V2
明るさ設定値をリターン: V2 Player以外の場合常に0をリターンします。
Parameters:
- No parameter
Return:
Integer
明るさ設定値
set_contrast(contrast) V2
映像のコントラストを設定します。この設定はV2 Playerのみ対応します。映像のコントラストは -50 <= contrast <= 50となります。範囲外の値を入力する場合範囲の最低、最大値(-50と50)で固定されます。
Parameters:
- contrast
Integer
コントラスト設定値
Return:
No return
get_contrast() V2
コントラスト設定値をリターン: V2 Player以外には常に0をリターンします。
Parameters:
- No parameter
Return:
Integer
コントラスト設定値
set_saturation(saturation) V2
映像の色調を設定します。この設定はV2 Playerのみ対応します。映像の色調は -50 <= saturation <= 50となります。範囲外の値を入力する場合範囲の最低、最大値(-50と50)で固定されます。
Parameters:
- saturation
Integer
色調設定値
Return:
No return
get_saturation() V2
色調設定値をリターン: V2 Player以外には常に0をリターンします。
Parameters:
- No parameter
Return:
Integer
色調設定値
set_repeat_start([position])
リピート再生の開始位置を設定します。因子なしで呼び出す場合現在の位置を開始位置として設定します。
Code Block | ||
---|---|---|
| ||
controller.on('event_name_1', function(param) {
// 첫번째 리스너
}).on('event_name_2', function(param) {
// 두번째 리스너
}); |
Videogateway Controller Library가 지원하는 메소드를 호출하는 방법은 간단합니다.
Code Block | ||
---|---|---|
| ||
controller.play(); |
set_repeat_start(); |
因子で位置(秒)値を入力すると指定した位置をリピート再生の開始位置として設定します。
Code Block | ||
---|---|---|
| ||
controller.set_repeat_start(10); // 10秒時点を開始位置に設定 |
設定されている終了位置より開始位置が後になる場合、終了位置が解除されます。
Parameters:
- position
Integer
(Optional) 開始位置値
Return:
No return
set_repeat_end([position])
リピート再生の終了位置を設定します。因子なしで呼び出す場合現在の位置を終了位置として設定します。
Code Block | ||
---|---|---|
| ||
controller.set_volumerepeat_end(90); |
참고사항
메소드 목록
on(event_name, callback_function)
이벤트 리스너를 등록합니다.
因子で位置(秒)値を入力すると指定した位置をリピート再生の終了位置として設定します。
Code Block | ||
---|---|---|
| ||
controller.on('event_name', function(param) {
// event_name에 해당하는 이벤트 발생시, 두번째 인자인 callback function 실행
}); |
- event_name String callback function을 bind할 이벤트 이름입니다.
- callback_function Function 이벤트 발생시 실행될 callback function입니다. 경우에 따라서 callback function에는 파라미터가 주어질 수 있습니다.
Return:
- Object VG-Controller Client 객체를 반환합니다.
off(event_name)
등록된 이벤트 리스너를 제거합니다.
Code Block | ||
---|---|---|
| ||
controller.off('event_name'); |
- event_name String callback function으로 bind된 이벤트 이름입니다.
Return:
- Object VG-Controller Client 객체를 반환합니다.
get_progress()
재생 진행중인 위치 정보를 반환합니다.set_repeat_end(20); // 20秒時点を開始位置に設定 |
設定されている開始位置より終了位置が前になる場合、開始位置が解除されます。
Parameters:
- position
Integer
(Optional) 終了位置値
Return:
No return
unset_repeat()
リピート再生設定を解除
Parameters:
- No parameter
Return:
No return
get_repeat() V2 V3 V4
リピート再生設定状態をリターン: V3, V4 Playerは状態の文字列と時間がリターンします。V2 Playerの場合状態の文字列のみリターンします。状態文字列はcancel, start, endの3種類となります。
Parameters:
- No parameter
Return:
No return
refresh_bookmark()
Playerのbookmarkリストを更新
Parameters:
- No parameter
eturn:
Object percent, position, duration을 property로 갖는 object 객체를 반환합니다. 각 값들에 대한 설명은 progress 이벤트 를 참고하여 주십시요.
play([start_at])
동영상을 재생합니다.
Code Block | ||
---|---|---|
| ||
controller.play(); |
특정 지점부터 재생하려면 다음과 같이 재생할 위치를 파라미터로 입력하여 주십시요.
Code Block | ||
---|---|---|
| ||
controller.play(10); // 10초 위치부터 재생 |
start_at Integer (Optional) 재생 시작 위치입니다. 생략하면 처음부터 재생합니다.
eturn:
No return
pause()
동영상 재생을 일시정지합니다.
Parameters:
No parameter
eturnReturn:
No return
enable_fullscreen_button() V3 V4
Playerの全体画面ボタンを有効にします。(IE バージョン10 以前のバージョンはfullscreen 機能に対応していないためfullscreen buttonは自動で無効になります。)
Parameters:
- No parameter
Return:
No return
get_player_id() V2 V3
PlayerのユニークIDをリターンします。この関数は「ready」イベントが呼出されるまでにはnullをリターンします。
Parameters:
- No parameter
Return:
String
PlayerのユニークID
get_hardware_id() V2 V3
ハードウェアユニークIDをリターンします。この関数は「ready」イベントが呼出されるまでにはnullをリターンします。
Parameters:
- No parameter
Return:
String
ハードウェアユニークID
get_player_type()
現在のPlayer Typeをリターン:Flash, V2, V3, V4
Parameters:
- No parameter
Return:
String
現在のPlayer Type
set_subtitle_visibility(visibility)
字幕表示を設定
Parameters:
- visibility
Boolean
表示設定
Return:
No return
set_subtitle_
volume(volume)음량을 변경합니다. 음량은 0 <= volume <= 100 사이의 Integer형 값이어야 합니다. 이 범위를 벗어난 감은 0이나 100으로 재조정 됩니다.
Parameters:
volume Integer 변경할 음량입니다.
eturnshadow_rect(is_rect)
字幕の背景スタイルを設定:パラメータがtrueならblock形の不透明背景となり、falseなら文字の陰影として設定されます。
Parameters:
- is_rect
Boolean
字幕の背景スタイルがBlock形であるかの有無
Return:
No return
get_subtitle_shadow_
volumerect()
현재 설정된 음량을 반환합니다.字幕の背景スタイルがBlock形の不透明背景に設定されているかをリターンします。
Parameters:
No parameter
eturn:
Integer 현재 설정된 음량입니다.
mute()
음소거를 설정하거나 해제합니다. 음소거가 해제된 상태에서 호출하면 음소거를 설정하고, 반대로 설정된 상태라면 해제합니다.
Parameters:
No parameter
eturnis_rectBoolean
字幕の背景スタイルがBlock形であるかの有無
Return:
No return
set_subtitle_font_size(size) V3 V4
字幕フォントのサイズを設定します。
Parameters:
- size
Integer
字幕フォントのサイズです。単位はpxです。
Return:
No return
get_subtitle_font_size()
set_jumpstep 메소드에 의해 설정된 이동할 시간값만큼 현재 재생 위치보다 이후로 이동합니다. 초기값은 10초입니다. V3 V4
字幕フォントのサイズを設定をリターン
Parameters:
- No parametereturn
Return:
No return
- size
Integer
字幕フォントのサイズです。単位はpxです。
get_video_info()
set_jumpstep 메소드에 의해 설정된 이동할 시간값만큼 현재 재생 위치보다 이전으로 이동합니다. 초기값은 10초입니다. Flash V4
コンテンツのwidth, height, bitrate 値をリターンします。この関数は「ready」イベントが呼出されるまでにはnullをリターンします。
Parameters:
- No parametereturn
Return:
No returnObject width, height, bitrateがpropertyになるObjectをリターン
set_lms_
screencheck()
V3 V4일반 윈도우 모드와 전체화면 모드로 화면 상태를 변경합니다. 화면이 일반 윈도우 모드인 경우 호출하면 전체화면으로, 전체화면 모드인 경우는 일반 윈도우 모드로 변경됩니다.
Playerが終了またはブラウザを閉じた場合LMSデータが転送されたことを確認してから削除されるように設定します。
Parameters:
No parameter
Return:
No
get_screen()
현재 화면 모드를 반환합니다. set_screen이 V2, V3, V4 Player에서만 지원되긴 하지만, get_screen 함수는 모든 Player에서 정상적으로 현재 화면 상태를 반환합니다. 반환되는 값은 다음과 같습니다.
- 일반 윈도우 모드 : windowed
- 전체화면 모드 : fullscreen
Parameters:
No parameter
eturn:
String 반환되는 현재 화면 모드입니다. windowed, fullscreen 두 값 가운데 하나를 갖습니다.
set_jumpstep(jumpstep)
ff 메소드나 rw 메소드를 통해 이동할 시간값을 설정합니다. 시간값은 초단위 정수로 입력합니다.
Parameters:
jumpstep Integer 이동할 시간값 입니다.
eturn:
No return
get_jumpstep()
현재 설정된 이동할 시간값을 반환합니다.parameter
set_keyframe_seek_default(is_default) V2
Seekする際にKeyframe移動をdefaultにするかを設定
Parameters:
is_default
Boolean
default 設定有無
Return:
No parameter
set_short_key(enable) V2
ショートカットキーのOn/Off設定
Parameters:
enable
Boolean
ショートカットキー設定
Return:
No parameter
set_enable_close_event()
close callback 関数の使用有無を設定
Parameters:
No parameter
Return:
Integer 반환되는 이동할 시간값입니다.
set_control_visibility(visibility)
Player 내장 Control들을 숨김하거나 숨김을 해제합니다. 파라미터로 true를 주면 숨김 해제, false를 주면 숨김입니다.
Parameters:
visibility Boolean 내장 Control 숨김 여부입니다.
eturn:
No return
get_control_visibility()
설정된 내장 Control 숨김 여부를 반환합니다.
Parameters:
No parameter
eturn:
Boolean 내장 Control 숨김 여부입니다.
set_scalemode(scalemode) Flash
Flash Player의 Scalemode를 변경합니다. Flash Player가 아닌 환경에서 호출할 경우 오류를 발생시키진 않지만, Scalemode가 변경되진 않습니다. Scalemode는 다음 4가지 중 하나여야 합니다. (다른 값일 경우는 동작하지 않습니다.)
- letterbox, stretch, zoom, none
Parameters:
scalemode String 설정할 scalemode의 값입니다.
eturn:
No return
get_scalemode() Flash
설정된 Flash Player의 Scalemode를 반환합니다. Flash Player가 아닌 경우는 가장 이전에 호출된 set_scalemode 메소드에서 설정된 값이 반환됩니다.No parameter
get_enable_close_event()
close callback 関数の使用設定をリターン
Parameters:
No parameter
Return:
Boolean
使用設定をリターン
set_close_callback_fn(fn)
ブラウザを閉じた際に実行する関数を登録します。
Parameters:
fn
Function
閉じた際に実行する関数
Return:
No parameter
get_lms_data() V4
現在まで保存されたLMS dataをリターンします。
Parameters:
No parameter
Return:
Object
LMS data
get_hls_frag_data() V4
hlsのfrag dataを呼出す
Parameters:
No parameter
Return:
String 설정된 Scalemode값 입니다.
set_speed(speed) V2 V3 V4
재생 배속을 설정합니다. 배속의 범위는 기본적으로 0.5 <= speed <= 4 입니다. 배속 최대값은 플레이어의 설정에 따라 바뀔 수 있습니다. 또한, 배속은 0.1씩 증가하거나 감소할 수 있습니다. 그보다 작은 단위로 증감할 경우 기대한대로 배속이 증감하지 않을 수 있으니 주의하여 주십시요. 0.5보다 작거나 4보다 큰 값을 입력할 경우는 각각 0.5와 4로 값이 고정됩니다.
Parameters:
speed Integer 설정할 배속값 입니다.
eturn:
No return
get_speed() V2 V3 V4
설정된 배속값을 반환합니다. Javascript에는 명시적인 Float형이 존재하지 않으므로, 소수점을 표현하기 위해 String형으로 반환합니다.
Parameters:
No parameter
eturn:
String 설정된 배속값입니다. 1이나 2인 경우 각각 문자열 '1.0'과 '2.0'으로 표현합니다.
set_playback_rates(playback_rates) V3 V4
배속값 그룹을 설정합니다. Array type으로 순서는 상관없습니다. (Player 내부에서 Sort하여 UI를 구성합니다.) 이중배열의 형태로 들어가는 경우 UI에서 보여지는 배속값 그룹의 세로 줄 수를 설정 할 수 있습니다. 이 경우 첫번째 인자는 배속값의 배열이며, 두번째 인자는 세로 줄 수를 나타냅니다. ex) [[0.5, 1, 1.5, 2, 3, 4], 2]
Parameters:
playback_rates Array 설정할 배속값 그룹의 배열입니다.
eturn:
No return
get_playback_rates() V3 V4
배속값 그룹의 배열을 반환합니다.base_url
String
M3U8 ファイルの呼出URLurl
String
TS ファイル(media file)の呼出URLduration
Integer
TS ファイルの全体時間auto_level
Boolean
ABR 有無level
Integer
現在ビットレートレベル値media_sequence
Integer
メディアシーケンスナンバーprogram_date_time
Integer
Program Date Timetag_list
Array
Tags [key, value]encrypted
Boolean
Encrypt 有無
set_controls_inactive_time (time) V2
V3
V4
コントロールバーが非表示になる時間を設定します。0の場合固定 (V3, V4 のみ)
Parameters:
time
Integer
コントロールバーが非表示になる時間
Return:
No parameter
get_controls_inactive_time () V2
V3
V4
設定されているコントロールバーの非表示時間をリターン
Parameters:
No parameter
Return:
Integer
コントロールバーの非表示時間
set_controls_activity (activity) V3
V4
コントローラー(ControlBar, BigPlayButton)の有効・無効を設定
Parameters:
activity
Boolean
コントローラーの有効・無効設定
Return:
No parameter
get_controls_activity () V3
V4
コントローラー設定をリターン
Parameters:
No parameter
Return:
Array 설정된 배속값 그룹 배열입니다.Boolean
コントローラー設定
set_
topmost(topmostcontrolbar_progress_only (enable) V2
윈도우 최상위 여부를 설정합니다. 최상위로 설정하면 현재 웹브라우져가 백그라운드 상태가 되어도 항상 다른 윈도우보다 위에 있게 됩니다. V3
V4
コントロールバーのProgressBarのみ表示する設定
Parameters:
No parameter
eturnenable
Boolean
ProgressBar Only設定
Return:
No
parameter
get_
topmostcontrolbar_progress_only () V2
윈도우 최상위 설정을 반환합니다. V2 Player를 제외한 다른 Player에서 호출시 항상 false를 반환합니다. V3
V4
ProgressBar Only設定をリターン
Parameters:
topmost Boolean true는 최상위 설정, false는 최상위 설정 해제입니다.
eturnNo parameter
Return:
Boolean
ProgressBar Only設定
영상의 밝기를 설정합니다. 이 설정은 V2 Player에서만 동작합니다. 영상의 밝기는 -50 <= brightness <= 50입니다. -50보다 작거나 50보다 큰 값을 입력하면 각각 -50과 50으로 재조정됩니다.
Parameters:
brightness Integer 영상 밝기값 입니다.
eturnset_
brightness(brightness) V2controlbar_hide_playing (enable) V4
再生中にコントロールバーとプログレスバーまで非表示にする設定
Parameters:
enable
Boolean
再生中にプログレスバーまで非表示にする設定
Return:
No return
get_controlbar_hide_
brightnessplaying ()
V2설정된 영상 밝기값을 반환합니다. V2 Player가 아닌 경우 이 메소드를 호출하면 무조건 0을 반환합니다. V4
再生中にコントロールバーとプログレスバーまで非表示にする設定をリターン
Parameters:
No parameter
eturn:
Integer 설정된 영상 밝기값 입니다.
set_contrast(contrast) V2
영상의 대비를 설정합니다. 이 설정은 V2 Player에서만 동작합니다. 영상의 대비는 -50 <= contrast <= 50입니다. -50보다 작거나 50보다 큰 값을 입력하면 각각 -50과 50으로 재조정됩니다.
Parameters:
contrast Integer 영상 대비값 입니다.
eturn:
No return
get_contrast() V2
설정된 영상 대비값을 반환합니다. V2 Player가 아닌 경우 이 메소드를 호출하면 무조건 0을 반환합니다.Return:
Boolean
再生中にプログレスバーまで非表示にする設定
set_subtitle_activity (activity) V2
V3
V4
字幕の位置を変更
Parameters:
activity
Boolean
trueの場合コントロールバー領域分だけ上に位置が上がり、falseの場合下がる
Return:
No return
get_subtitle_activity () V3
V4
字幕の位置をリターン
Parameters:
No parameter
Return:
Boolean
tコントロールバー領域分だけ上に位置が上がっているかをリターン
get_subtitles_LIST () V2
V3
V4
VGから字幕の順番を変更してPlayer側にリターンする場合があるため、APIを呼出して取得する字幕リストではなく、
VGのMediaInfoオブジェクト内部の字幕属性をリターンします。
Parameters:
No parameter
Return:
Integer 설정된 영상 대비값 입니다.Array
字幕リストの配列オブジェクト
set_current_
saturationsubtitle (
saturation) V2영상의 색조를 설정합니다. 이 설정은 V2 Player에서만 동작합니다. 영상의 색조는 -50 <= saturation <= 50입니다. -50보다 작거나 50보다 큰 값을 입력하면 각각 -50과 50으로 재조정됩니다.
Parameters:
saturation Integer 영상 색조값 입니다.
eturnindex) V2
V3
V4
字幕を変更
Parameters:
index
Number
get_subtitles_list()メソッドでリターンされた字幕配列のindex値
Return:
No return
set_
saturationratio (type) V2
설정된 영상 색조값을 반환합니다. V2 Player가 아닌 경우 이 메소드를 호출하면 무조건 0을 반환합니다.
Parameters:
No parameter
eturn:
Integer 설정된 영상 색조값 입니다.
set_repeat_start([position])
구간반복의 시작 위치를 설정합니다. 인자 없이 호출하면 현재 위치를 구간반복의 시작 위치로 설정합니다.
Code Block | ||
---|---|---|
| ||
controller.set_repeat_start(); |
Code Block | ||
---|---|---|
| ||
controller.set_repeat_start(10); // 10초 위치를 시작 위치로 설정 |
Parameters:
position Integer (Optional) 시작 위치값 입니다.
eturn:
No return
set_repeat_end([position])
구간반복의 종료 위치를 설정합니다. 인자 없이 호출하면 현재 위치를 구간반복의 종료 위치로 설정합니다.
Code Block | ||
---|---|---|
| ||
controller.set_repeat_end(); |
인자로 위치(초)값을 입력하면 지정한 위치를 구간반복의 종료 위치로 설정합니다.
Code Block | ||
---|---|---|
| ||
controller.set_repeat_end(20); // 20초 위치를 종료 위치로 설정 |
Parameters:
position Integer (Optional) 종료 위치값 입니다.
eturn:
No return
unset_repeat()
설정된 구간반복을 해제합니다.
Parameters:
No parameter
eturn:
No return
refresh_bookmark()
플레이어 내 bookmark 리스트를 새로 갱신합니다.
Parameters:
No parameter
eturn:
No return
enable_fullscreen_button() V3 V4
플레이어 내부의 fullscreen button을 활성화시킵니다. (IE 10 이하는 웹브라우져에서 fullscreen 기능을 지원하지 않으므로, 해당 웹브라우져에선 자동적으로 fullscreen button이 비활성화된 상태로 표시됩니다.)
Parameters:
No parameter
eturn:
No return
get_player_id() V2 V3
플레이어 고유 아이디를 반환합니다. 이 함수는 ready 이벤트가 호출되기 전까지는 null을 리턴합니다.
Parameters:
No parameter
eturn:
String 플레이어 고유 아이디입니다.
get_hardware_id() V2 V3
하드웨어 고유 아이디를 반환합니다. 이 함수는 ready 이벤트가 호출되기 전까지는 null을 리턴합니다.
Parameters:
No parameter
eturn:
String 하드웨어 고유 아이디입니다.
set_subtitle_visibility(visibility)
자막 출력을 설정합니다.
Parameters:
visibility Boolean 출력 여부입니다.
eturn:
No return
get_video_info() Flash V4
미디어의 width, height, bitrate값을 반환합니다. 이 함수는 ready 이벤트가 호출되기 전까지는 null을 리턴합니다.
Parameters:
No parameter
eturn:
Object width, height, bitrate를 property로 갖는 Object를 반환합니다.
이벤트 목록
loaded
플레이어 로딩이 완료되면 이벤트가 발생합니다.
ready
플레이어 로딩이 끝나고 재생 정보를 서버로부터 획득하였으며, 실제 재생준비가 완료된 시점입니다.
play
재생 시작시에 발생합니다. 초기 재생 시작을 제외하고 일시 멈춤 상태에서 다시 재생을 시작할때도 발생합니다.
progress
재생시 매초마다 발생합니다.V3
V4
画面拡大モードを変更
Parameters:
type
String
contain, fill, enlargementの中一つを適用することが可能- contain: 比率に合わせて埋める
- fill: 画面全体に埋める
- enlargement: 縦幅に合わせて埋める(左右にスクロール可能)
Return:
No return
get_error_detail () V2
V3
V4
Errorが発生した場合、code, message, param値をオブジェクトでリターンする。param値はmessage以外にも追加で情報を転送する必要がある場合含まれます。
Parameters:
No parameter
Return:
Object
Errorの詳細値をリターン {code, message, param}
set_vr_overlay (options) V3
V4
iOSデバイスはDeviceMotion権限を取得するためNative CodeであるDeviceMotionEvent.requestPermissionメソッドを呼び出す必要があります。
User Action (Touch)を必要とするため、iframeオブジェクト上にTouch Eventを受け取るための任意のオブジェクトが必要になります。
VG-Controller Client初期化してから該当メソッドを呼出すとVG-Controller Client 内部から自動でTouch Eventオブジェクトを生成し、権限を受け取る準備をします。
※iOS 13.4バージョンでは権限を取得してもDeviceMotionのrotationRate値が正常に適用されないエラーが判明されています。
Code Block | ||
---|---|---|
| ||
var controller = new VgControllerClient({
target_window: player.contentWindow
});
controller.set_vr_overlay({
target_element: document.getElementById('player').parentElement,
permission_request_help_message: 'Custom Info Message'
}); |
Parameters:
options
object
- target_element (必須)
- 任意のTouch Eventオブジェクトを生成するDom Elementです。ifrmaeオブジェクトの親Elementを指定してください。
- 重要:iframeオブジェクトの親Elementはposition値がrelativeまたはabsoluteでなければなりません。
- permission_request_help_message
- 既にDeviceMotion Permissionを実行している場合にはブラウザデータ保存所に該当値が保存されます。Permissionをキャンセルした場合、キャンセル状態で保存されるため、requestPermissionを実行することができません。実行できない状況に対した説明文を設定してください。説明文を設定していない場合、以下のデフォルト内容が表示されます。
- "動作と方向"へのアクセス権限がないためジャイロスコープが動作しません。設定 > Safari > 詳細 > Webサイトデータからデータを削除して再度お試しください。
- 既にDeviceMotion Permissionを実行している場合にはブラウザデータ保存所に該当値が保存されます。Permissionをキャンセルした場合、キャンセル状態で保存されるため、requestPermissionを実行することができません。実行できない状況に対した説明文を設定してください。説明文を設定していない場合、以下のデフォルト内容が表示されます。
- target_element (必須)
Return:
No return
set_custom_error (code, message, param) V3
V4
Playerのエラーメッセージを変更します。
メソッドの実行時点がエラーが起きている状態であれば、画面に表示されているエラーメッセージとparam値を入れ替えた内容で表示します。
メソッドの実行時点がエラーが起きていない状態であれば、該当エラーが発生した場合に入れ替えたエラーメッセージとparam値を表示することにします。
※Error code 値が変更の基準になるため、Error codeを正確に入力してください。
Parameters:
code
Integer
エラーコードmessage
String
ユーザーエラーメッセージparam
String
ユーザー Param メッセージ
Return:
No return
set_close_button (enable, fn) V4
Playerの右上に閉じるボタンを追加します。(Mobile player only)閉じるボタンがクリックされた際にCallback関数を実行します。※ready event 以降に呼出してください。
Parameters:
enable
Boolean
閉じるボタン配置有無fn Function 閉じるボタンクリックされた際に実行する関数
Return:
No return
hide_controlbar_button (value) V4
コントロールバーから特定ボタン (fullscreen, setting)を除去します。fullscreenボタンを除去する場合、hide_control_bar(['fullscreen'])を呼出してください。※ready event 以降に呼出してください。
Parameters:
value Array 除去するボタン (fullscreen, setting) 配列
Return:
No return
set_chat_config (value) V4
チャットウィンドウに必要な情報を表示するcustomer_pageをTab page形で表示するように設定します。urlを入力してhtmlページにリンクしたり、html tagをそのまま入力することも可能です。※ready event 以降に呼出してください。
- ブラウザのセキュリティポリシーのため、urlは https のみ対応します。
- htmlを入力する場合、<script>tagは動作しません。
Code Block | ||
---|---|---|
| ||
const config = {
customer_page: [{
title:'関連情報',
url:'https://google.com',
//html:'<h2 style="color:red">正しいHTMLの書き方</h2>'
}]
};
controller.set_chat_config(config); |
Parameters:
value Object チャット設定 (Json object)
Return:
No return
hide_controlbar_button (value) V4
Android webview環境にて、チャットのキーボードが立ち上がる際にwebviewの位置がキーボードに合わせて動かないため正常に見えなくなるのでこの問題を修正するためにこのメソッドを呼出する必要があります。
height値は全体が見える状態(キーボードがない状態)を1.0とします。例えばキーボードが立ち上がって画面の40%が被られたと想定した場合には height = 0.6 を呼出して対応します。
Parameters:
value
Integer
画面対比キーボードの縦幅パーセンテージ
Return:
No return
dispose () V3
V4
Playerオブジェクトを削除
Parameters:
No parameter
Return:
No return
イベントリスト
loaded
Playerの読込が完了するとイベントが発生します。
ready
Playerの読込が終わってから再生情報をサーバーから獲得して再生準備が完了された時点
play
再生開始の時に発生:一時停止状態から再度再生した際にも発生します。
progress
再生中に毎秒発生
Code Block | ||
---|---|---|
| ||
controller.on('progress', function(percent, position, duration) {
// 인자의 순서는 위와과 같습니다.
}); |
Parameters:
- percent Integer 진행 백분율입니다. 값의 범위는 0 <= percent <= 100 입니다.
- position Integer 현재 재생중인 위치의 값입니다. 초단위입니다.
- duration Integer 동영상의 전체 재생 길이입니다. 초단위입니다.
pause
일시 정지시에 발생합니다.
done
재생 완료시에 발생합니다. 재생 완료는 duration의 끝까지 모두 재생한 경우를 의미합니다.
muted Flash V3 V4
음소거 상태가 변경시 호출됩니다. (음소거시, 음소거 해제시 모두 발생)因子の順番は上記の通りになります。
}); |
V3, V4 Playerの場合、HTML5 Video Playerの構造上の都合のためprogressイベントが正確に1秒毎に発生しない可能性があります。 (0.1秒から最大0.5秒まで差が発生する可能性があります。)V3, V4 Playerにprogressイベントで作業する場合上記の内容に注意してください。
Parameters:
- percent
Integer
進行率のパーセントとなります。範囲は 0 <=percent <=100となります。 - position
Integer
現在再生中の位置値となります。単位:秒 - duration
Integer
コンテンツの長さとなります。 単位:秒
pause
一時停止した場合に発生
done
再生を完了した場合に発生:再生完了はdurationの最後の時点に到達した際に判別
muted Flash V3 V4
ミュート状態が変更された際に発生 (ミュートOn/Off 何れも発生)
Code Block | ||
---|---|---|
| ||
controller.on('muted', function(is_muted) {
// is_mutedがtrueはミュートOn, falseはミュートOff
}); |
V2 Playerの場合には現状mutedイベントは対応していません。ミュート状態になる場合volumechangeイベントが発生し、変更された音量を0で転送します。
Parameters:
- is_muted
Boolean
trueはミュートOn, falseはミュートOff
close V2
Playerが終了またはブラウザを閉じると発生
seeking V4
シークが始まると発生
seeked V4
シークが終わると発生
scalemodechange Flash
スケールモードが変更された際に発生します。
Code Block | ||
---|---|---|
| ||
controller.on('mutedscalemodechange', function(is_mutedscalemode) { // is_muted가 true면 음소거, false면 해제입니다... }); |
Parameters:
- is_muted Boolean true면 음소거, false면 음소거 해제입니다.
scalemodechange Flash
스케일모드가 변경시 발생합니다.Flash Playerのみ対応:パラメータは以下の中で決まります。
- letterbox, stretch, zoom, none
Parameters:
- scalemode
String
letterbox, stretch, zoom, none の中で一つ
topmostchange V2
ウィンドウの最上位配置設定が変更した際に発生
Code Block | ||
---|---|---|
| ||
controller.on('scalemodechangetopmostchange', function(scalemodeis_topmost) { // ... is_topmostがtrueは最上位設定On, falseは最上位設定Off }); |
V2 Player以外のPlayerではイベントが発生しません。
Parameters:
- scalemode String letterbox, stretch, zoom, none 가운데 하나입니다.
topmostchange V2
화면 최상위 설정 변경시 발생합니다.- is_topmost
Boolean
trueは最上位設定On, falseは最上位設定Off
screenchange
全体画面のOn/Offの際に発生
IE10 以前のバージョンでenable_fullscreen_button()が有効化されている場合、fullscreen ボタンをクリックしても実際の動作はしませんがscreenchangeイベントはリターンされます。
Code Block theme Midnight controller.on('
screenchange', function(
screen) { //
... });
화면 최상위 설정은 V2 Player에만 존재하는 기능입니다. 다른 Player에서는 이벤트를 발생시키지 않습니다.screen パラメータは2つの文字列を転送します。screen: windowed, fullscreen
Parameters:
- is_topmost Boolean true면 최상위 설정, false면 최상위 설정 해제입니다.
screenchange
전체, 일반화면 변경시 발생합니다.
- IE10 이하의 브라우져의 경우, enable_fullscreen_button()이 활성화 되어 있는 상태라면, fullscreen 버튼 클릭시 실제 fullscreen/windowed 전환이 이루어 지지는 않지만 screenchange 이벤트는 정상적으로 반환이 됩니다.screen
String
windowedは全体画面Off, fullscreenは全体画面On
volumechange
音量変更の際に発生
Code Block | ||
---|---|---|
| ||
controller.on(' |
volumechange', function( |
volume) { // |
volumeの範囲は 0 <= volume <= 100 }); |
screen 파라미터는 다음의 2가지 문자열 가운데 하나를 제공합니다. screen: windowed, fullscreen
Parameters:
- screen String windowed는 일반화면, fullscreen은 전체화면입니다.
volumechange
음량 변경시 발생합니다.Parameters:
- volume
Integer
変更された音量:範囲は 0 <= volume <= 100
speedchange V2
V3
V4
倍速変更の際に発生:倍速最大値はPlayerの設定により変更
Code Block | ||
---|---|---|
| ||
controller.on('volumechangespeedchange', function(volumespeed) { // volume의 범위는speed範囲は 0.5 <= volumespeed <= 1004 입니다. }); |
Parameters:
- volume Integer 변경된 음량입니다. 범위는 0 speed
String
変更された倍速:範囲は 0.5 <= volume speed <= 100 입니다4となります。Javascriptの特性で2.0は2に表記されるため、Integerタイプの代わりにStringタイプで転送
V3
V4
배속 변경시 발생합니다. 배속 최대값은 Player의 설정에 따라 바뀔 수 있습니다.倍速値グループが変更されると発生
Code Block | theme | Midnight
---|
controller.on('speedchangeplaybackrateschange', function(speedplayback_rates) { // speed의 범위는 0.5 <= speed <= 4 입니다. // playback_ratesは配列の文字列となり、単一または二重配列でリターン }); |
Parameters:
- speed String 변경된 배속입니다. 범위는 0.5 <= speed <= 4 입니다. Javascript 언어 특성상 2.0은 2로 표기 되기 때문에, Integer형 대신에 String형을 사용해 제공합니다.
videosettingchange V2
비디오 속성 변경시 발생합니다.playback_rates
String
変更された倍速値グループの文字列単一配列 : 倍速値リストが1列で表示 ex) [1, 2, 3]
二重配列 : 倍速値リストが複数列で表示 ex) [[0.5, 1, 1.5, 2], 2]
映像設定変更の際に発生
Code Block | ||
---|---|---|
| ||
controller.on('videosettingchange', function(videosetting) { // videosetting 파라미터는 다음의パラメータは次のObjectタイプ 형태로 표시되는 Object 타입입니다. // // { // "brightness": 0, // "contrast": 0, // "saturation": 0 // } }); |
비디오 속성 변경 기능은 V2 Player에만 존재하는 기능입니다. 다른 Player에서는 이벤트를 발생시키지 않습니다. 각 값의 범위는 모두 映像設定変更はV2 Playerのみ対応しています。他のPlayerではイベントが発生しません。範囲は全て -50 <= value <= 50의 범위를 갖습니다. 사용자가 별도로 지정하지 않았을 경우 기본값은 0 입니다.50となります。別途指定がなかった場合defaultは0となります。
Parameters:
- videosetting videosetting
Object
brightness(밝기明るさ), contrast(대비コントラスト), saturation(채도)를 property로 갖는 object입니다.色調)がpropertyになるobject
jumpstepchange
ff, rw 메소드를 통해 이동할 시간값 변경시 발생합니다.メソッドから移動時間値が変更された際に発生
Code Block | ||
---|---|---|
| ||
controller.on('jumpstepchange', function(jumpstep) { // jumpstep은jumpstep 초단위입니다.単位:秒 }); |
Parameters:
- jumpstep Integer 변경된 이동할 시간값입니다. 초단위입니다.jumpstep
Integer
変更された移動時間値 (単位:秒)
subtitlevisibilitychange V2
V3
V4
字幕表示状態が変更されると発生
hlsfragchange V4
hlsのfragが変更されると発生
html5_video_supported V3 V4
V3, V4 Player에서만 발생합니다. Player가 내부에서 HTML5 Video 재생기능을 사용할 수 있다고 판단하여 HTML5 Video Player를 로드할 경우 엔 true를, 전용 플레이어를 재생해야 한다고 판단할 경우엔 false를 리턴합니다. Playerのみ発生します。PlayerがHTML5 Video 再生機能が使用できる環境だと判断してV4(HTML5 Video Player)を読み込んだ場合にはtrue, V3を読み込む場合にはfalseをリターンします。 (http://caniuse.com/#feat=video 참조 参考)
Parameters:
- html5_video_supported
Boolean
Player가 HTML5 Player로 로드될 경우 true, 전용 플레이어로 로드될 경우는 false가 리턴됩니다.
error
Player가 재생오류를 반환하는 경우 발생합니다.- PlayerがV4(HTML5 Player)で読み込む場合true, V3を読み込む場合falseがリターン
error
Playerが再生エラーをリターンした際に発生
Code Block | ||
---|---|---|
| ||
controller.on('error', function(error_code) { // ... }); |
Parameters:
- error_code Integer Kollus Player 에러 코드입니다.code
Integer
Kollus Playerのエラーコード
device_orientation_changed v4
mobile deviceの縦/横が回転された際に発生
Parameters:
- orientation
String
縦: Portrait 横: Landscape