Hybrid Player

Owned by jpteam (Unlicensed)
Last updated: Feb 05, 2021
2 min read


Web Interface

使用方法

制御スクリプトをhtmlの適切な場所に挿入します。

具現に必要な文字列は全てUTF-8でエンコードしてください。

<script src=”kollus.mobile.min.js”></script>

制御スクリプト API Reference

メソッド説明パラメータ
versionスクリプトの現在バージョンをリターン
startPlayerを画面に呼出、再生させる-(string) media_url: 再生URL
-(object) options: 再生オプション
-(object) position: 再生位置
left, top 位置から width, height サイズで再生
-(int) left
-(int) top
-(int) width
-(int) height
-(int) marginTop
stop画面に表示されたPlayerを止めるなし
showPlayerを画面に表示し、pause状態の場合には停止した位置から再生を開始するなし
hidePlayerを画面から非表示にするなし
fullscreenPlayerを前画面モードに変更なし
download_homeダウンロードホーム画面を表示なし
download選択したフォルダに指定したURLのコンテンツをダウンロード(array)
(string) folder
(string) url
remove_contentsダウンロードしたコンテンツを全て削除なし
download_listダウンロードリストをJSONで取得なし
content_infoダウンロードしたコンテンツ情報をJSONで取得media_content_key
player_infoPlayer情報をJSONで取得なし
bind特定イベント名でCallback関数を設定(string) event_name : イベント名
(function) callback : Callback関数
unbindイベント名に設定されたCallback関数を全て削除(string) event_name : イベント名

制御スクリプトサンプル

version

Playerの現在バージョンを受け取る

定義
string version;

使用例
var ver = window.KollusMobile.version;

start

Playerを画面に呼出、再生させる

定義
void start(string media_url, ojbect option);

Param
  • media_url
    • 基本値 : なし. (string)
    • 動画再生に必要なURI
  • option
    • 基本値 : なし (object)
    • Playerオプション
オプション (Option)
  • position
    • 基本値 : left(0), top(0), width(640), height(480), marginTop(0), (int)
    • 動画が表示される位置を指定します。
    • left, top, width, height, marginTop
Option サンプル
{
    player: {
	media_url: '',
	options: {
	    position: {
		left: 0,
		top: 0,
		width: 0,
		height: 0,
		marginTop: 0
	   }
	}
    }
};
使用例
window.KollusMobile.start({
	media_url: 'http://v.jp.kollus.com/sr?key=D9C34B...062BA9F06|V1.0',
	options: {
	    position: {
		"left": 0,
		"top": 0,
		"width": 640,
		"height": 480,
		"marginTop": 0
	   }
	}
});

stop

画面に表示されたPlayerを止める

定義
void stop();

使用例
window.KollusMobile.stop();

show

画面から非表示にされたPlayerを再度画面上に表示する

定義
void show();


使用例

window.KollusMobile.show();


hide

画面に表示されたPlayerを非表示にする

定義
void hide();


使用例

window.KollusMobile.hide();


download_home

ダウンロードホームを表示します。

定義
void download_home();

使用例
window.KollusMobile.hide();


download

コンテンツダウンロードする際に呼出

定義
void download(ojbect option);

パラメータ (Params)
  • option
    • 基本値 : なし (object)
    • ダウンロードオプション
    • folder : ダウンロードする場所
      • ない場合Rootにダウンロードされる
    • url : ダウンロードするコンテンツURL
Params サンプル
[
    {
        “folder”:”映画”,
        “url”:”http://v.jp.kollus.com/i/abcdef”
    },
    {
        “folder”:”アニメ”,
        “url”:”http://v.jp.kollus.com/i/abcdef”
    },
    {
        “url”:”http://v.jp.kollus.com/i/abcdef”
    }
]

使用例
window.KollusMobile.download(
	[
                {
                    “folder”:”映画”,
                    “url”:”http://v.jp.kollus.com/i/abcdef”
                },
                {
                “folder”:”アニメ”,
                “url”:”http://v.jp.kollus.com/i/abcdef”
            },
            {
                “url”:”http://v.jp.kollus.com/i/abcdef”
            }
        ]);


remove_contents

ダウンロードしたコンテンツを全て削除

作業完了後同じイベントがCallbackリクエストされる。

定義
void remove_contents();

使用例
window.KollusMobile.bind(“remove_contents”, function(){
  console.log(“remove_contents completed”);
});

window.KollusMobile.remove_contents();


download_list

ダウンロードリストをobject形でCallback取得

パラメータはありません。

定義
void download_list();

使用例
window.KollusMobile.bind(“download_list”, function(data){
  var json = $.parseJSON(data);
});

window.KollusMobile.download_list();

リターンされるコンテンツ情報

  • title
    • タイトル
  • media_key
    • メディアコンテンツキー
  • play_at
    • nscreen 情報
  • duration
    • 長さ
  • file_size
    • ファイル容量
  • is_complete
    • ダウンロード完了有無
  • expire_date
    • 有効期限
  • expire_count
    • 残り再生可能回数
  • total_expire_count
    • 設定された再生可能回数
  • expire_playtime
    • 残り再生可能時間(秒)
  • total_expire_playtime
    • 設定された再生可能時間(秒)
  • is_expired
    • コンテンツ有効期限切れ有無
  • snapshot_path
    • コンテンツポスターイメージの経路

content_info

ダウンロードしたコンテンツ情報をobject形でCallback取得

定義
void content_info(string media_content_key);

パラメータ (Params)
  • media_content_key
    • 基本値 : なし. (string)
    • 情報を取得するコンテンツのメディアコンテンツキー
使用例
window.KollusMobile.bind(“content_info”, function(data){
  var json = $.parseJSON(data);
});

window.KollusMobile.content_info('abcdef');

player_info

Player情報をobject形でCallback取得

パラメータはありません。

定義
void player_info();

使用例
window.KollusMobile.bind(“player_info”, function(data){
  var json = $.parseJSON(data);
});

window.KollusMobile.player_info();

リターンされるPlayer情報
項目属性資料形AndroidiOS
generalnotify_3gboolOO

is_nscreenboolOO

is_prefer_sw_codecboolOX

is_native_playerboolXO

disable_manner_modeboolXO
subtitlesizeint32OO

colorint32OO

is_strokeboolOX

stroke_colorint32OX
storagedownloadint64OO

cacheint64OO

etcint64OO

freeint64OO
playerversionstringOO

idstringOO
  • general
    • notify_3g
      • 3G/LTE 状態でデータ使用する際にお知らせ表示の有無
    • is_nscreen
      • 続き再生情報がある際にお知らせ表示の有無
    • is_prefer_sw_codec
      • ソフトウェアコーデックで再生するかの有無
    • is_native_player
      • デバイスのネイティブPlayer使用有無
    • disable_manner_mode
      • マナーモードの際にオーディオ出力有無
  • subtitle
    • size
      • 字幕サイズ
    • color
      • 字幕色
    • is_stroke
      • 字幕枠線有無
    • stroke_color
      • 字幕枠線色
  • storage
    • download
      • 全てのダウンロードコンテンツの容量
    • cache
      • ストリーミングで使用している容量
    • etc
      • アプリ以外で使用している容量
    • free
      • 残り容量
  • player
    • version
      • アプリバージョン
    • id
      • Player ID

bind

showを呼出した際に指定したactionまたは画面転換などアプリ側でイベント発生すると呼出される。

(#アプリの特性上、同じイベントが複数回発生する可能性があります。)

定義
void bind(string event_name, function callback);

イベント種類 (event_name)

  1. back

    • 縦画面モードに転換する場合

    • 戻るボタンを押した場合

  2. error

    • エラーが起きた場合
    • エラーコード

  3. download_list

    • download_list()を呼出した場合

  4. content_info

    • content_info()を呼出した場合

  5. player_info

    • player_info()を呼出した場合

  6. remove_contents

    • remove_contents()を呼出した場合

  7. Player基本動作を実行した場合

    • start, stop, show, hide, fullscreen, popup
使用例
window.KollusMobile.bind('back', function(data) {
		console.log('[back]', data);
	});
window.KollusMobile.bind('error', function(error) {
		console.log('[error]', error);
	});
window.KollusMobile.bind('download_list', function(data) {
		console.log('[download_list] ', data);
	});
window.KollusMobile.bind('content_info', function(data) {
		console.log('[content_info] ', data);
	});
window.KollusMobile.bind('player_info', function(data) {
		console.log('[player_info] ', data);
	});


Webサンプルページ

サンプルは別途文書で提供しています。担当までお問い合わせください。

エラーコード

エラーコード説明
0原因不明のエラー

Android App 説明

Android向けアプリ対応モジュールの説明

OS 対応範囲

  • ICS(API Level 14) 以上から対応、Android SDK v14をベースで開発・検証しています。

テスト端末

  • Nexus 6P

iOS App 説明

iPhone, iPad向けアプリ対応モジュールの説明

OS 対応範囲

  • iOS 8.0 以上、XCode Comfileの対応OS設定をiOS 8.0以上にして開発・検証しています。

テスト端末

  • iPhone 5 (8.3)
  • iPhone 6 plus (10.1.1)
  • iPad mini (9.3.5)

Copyright © CATENOID, lnc. All Rights Reserved.
E-mail. jp_sales@catenoid.net | Tel. 03-4405-8462