高度なカスタマイズ
動画プレイヤー:JS関数
INTER-STREAMの動画プレーヤー(FlashおよびHTML5)でサポートされているJavascript関数のリストです。
制御機能
制御機能は、動画プレーヤーでアクションを実行する機能です。
wsvp_play()
現在の動画を再生/再開します。
wsvp_pause()
現在の動画を一時停止します。
wsvp_seek(t)
現在の動画を指定された時間にシークします(可能な場合)。
パラメータ
- t(string):シークする時間("h:m:s"形式)。h=時間(整数)、m=分(整数)、s=秒(10進数)
例)
wsvp_seek("0:0:120"); // 120秒目までシーク
wsvp_seek("0:10:3.5"); // 10分3.5秒までシーク
wsvp_seek("0:10:3.5"); // 10分3.5秒までシーク
wsvp_skipFwd()
プレイリストの次の動画にスキップします。
wsvp_skipBwd()
現在の動画のプレイリスト再生順が2番目以降の場合、プレイリストの前の動画にスキップします。
それ以外の場合は現在の動画が最初から再生を開始します。
wsvp_resize(width,height)
動画プレーヤーのサイズを変更します。
パラメータ
- width(integer):幅(ピクセル単位)
- height(integer):高さ(ピクセル単位)
例)
wsvp_resize(640,480); // 動画プレーヤーのサイズを640px*480pxに変更
wsvp_playClip(id_clip,play_in_current_playlist,id_as_number)
動画IDもしくはチャンネルプレイリスト内の番号を指定して動画を再生します。
パラメータ
- id_clip(integer):動画IDもしくは現在のチャンネルプレイリスト内の動画の番号。
- play_in_current_playlist(string):
"yes"に設定すると、動画プレーヤーは現在のプレイリスト内の動画を再生しようとします(動画がプレイリストに存在している必要があります)。
再生しようとしている動画が現在のプレイリストに存在しない場合は"no"に設定します。 - id_as_number(boolean):"id_clip"が動画IDの場合は"false"、現在のチャンネルプレイリスト内の動画の番号の場合は"true"に設定します。
例)
wsvp_playClip(2,"yes",false); //プレイリストからID=2の動画を再生
wsvp_playClip(2,"yes",true); //プレイリストから、プレイリスト内の動画番号=2の動画を再生
wsvp_playClip(2,"no",false); //動画プレーヤーをリロードしてID=2の動画を再生(現在のプレイリストは失われます)
wsvp_playClip(2,"yes",true); //プレイリストから、プレイリスト内の動画番号=2の動画を再生
wsvp_playClip(2,"no",false); //動画プレーヤーをリロードしてID=2の動画を再生(現在のプレイリストは失われます)
wsvp_switchQuality(quality_id)
動画の画質を選択します(動画プレーヤーの当該アイコンから動画の品質を選択するのと同じです)。
パラメータ
- quality_id(int):画質のID。利用できない、もしくは無効である場合、現在の画質が維持されます。
注:動画の画質は[一般設定>動画]で定義されています。
例)
wsvp_switchQuality(1); // 品質1を選択、再生
wsvp_switchQuality(2); // 品質2を選択、再生
wsvp_switchQuality(2); // 品質2を選択、再生
wsvp_getCurrentQuality()
現在の動画の画質のID(int)を返します。
イベント関数(コールバック)
特定のイベントが発生したときに動画プレーヤーから呼び出されます。
呼び出されるにはJavascriptで関数を定義する必要があります。
wsvp_onPlayerStateChange(data)
動画プレーヤーが状態を変更したときに呼び出されます。
パラメータ
- data(object):データとともに動画プレーヤーから返されたオブジェクト
- オブジェクトのプロパティ:
status(string) 設定可能な値:paused, playing, ended, buffering
- オブジェクトのプロパティ:
例)
function wsvp_onPlayerStateChange(data)
{
// ブラウザのコンソールにステータスを表示
console.log("Player status change: "+data.status);
}
{
// ブラウザのコンソールにステータスを表示
console.log("Player status change: "+data.status);
}
wsvp_onTimeChange(data)
再生中に動画の時間が変わった時に呼び出されます。
パラメータ
- data(object):データとともに動画プレーヤーから返されたオブジェクト
- オブジェクトのプロパティ:
time(number) 現在の再生開始からの時間(秒)
- オブジェクトのプロパティ:
例)
function wsvp_onTimeChange(data)
{
// ブラウザのコンソールに動画の再生開始からの時間を表示
console.log("Video current time: "+data.time+" seconds);
}
{
// ブラウザのコンソールに動画の再生開始からの時間を表示
console.log("Video current time: "+data.time+" seconds);
}
wsvp_onDurationChange(data)
動画の再生時間の全長が変わった時に呼び出されます。
パラメータ
- data(object):データとともに動画プレーヤーから返されたオブジェクト
- オブジェクトのプロパティ:
time(number) 現在の動画の再生時間の全長(秒)
- オブジェクトのプロパティ:
例)
function wsvp_onDurationChange(data)
{
// ブラウザのコンソールに動画の再生時間を表示
console.log("Video duration is: "+data.time+" seconds");
}
{
// ブラウザのコンソールに動画の再生時間を表示
console.log("Video duration is: "+data.time+" seconds");
}
wsvp_onFullScreenChange(data)
全画面表示ボタンがクリックされたときに呼び出され、切り替えモードに戻ります。
パラメータ
- data(object):データとともに動画プレーヤーから返されたオブジェクト
- オブジェクトのプロパティ:
mode(string) 設定可能な値:fs_real(本来のフルスクリーンモードが有効),fs_sim(ブラウザのウィンドウサイズに合わせて動画プレーヤーのサイズを変更するフルスクリーンのシミュレーションであり本来のフルスクリーンは未サポート),normal(フルスクリーンではない)
- オブジェクトのプロパティ:
例)
function wsvp_onFullScreenChange(data)
{
// ブラウザのコンソールに動画の再生時間を表示
console.log("Toggled screen mode: "+data.mode);
}
{
// ブラウザのコンソールに動画の再生時間を表示
console.log("Toggled screen mode: "+data.mode);
}
wsvp_onLoadedClipData(data)
動画データがloadされたときに呼び出されます。
パラメータ
- data(object):データとともに動画プレーヤーから返されたオブジェクト
- オブジェクトのプロパティ:
date(string) 動画のフォーマット日
description(string) 動画の説明文
dislikes(integer) 動画の「低評価」の数
duration(string) 動画の再生時間
id(integer) 動画のID
is_ad(integer) 広告かどうか(可能な値:1|0)
likes(integer) 動画の「高評価(いいね)」の数
on_sale(integer) 販売中かどうか(可能な値:1|0)
product_url(string) 商品のURL(動画が販売中の場合)
socialie(integer) SNS共有オプションを表示するかどうか(可能な値:1|0)
title(string) 動画のタイトル
trailer(integer) 再生が予告編(プレビュー)に対応するかどうか(動画が販売中の場合)(可能な値:1|0)
url(string) 動画のURL
user(string) 動画作成者のユーザー名
user_href(string) 動画作成者のユーザーURL
user_id(integer) 動画作成者のユーザーID
views(string) 動画の統計/フォーマット済み合計視聴数
- オブジェクトのプロパティ:
例)
function wsvp_onLoadedClipData(data)
{
// ブラウザのコンソールに動画タイトルを表示
console.log("Clip title: "+data.title);
// 動画全体のデータオブジェクトをブラウザのコンソールに表示
console.log("Clip data:");
console.log(data);
}
{
// ブラウザのコンソールに動画タイトルを表示
console.log("Clip title: "+data.title);
// 動画全体のデータオブジェクトをブラウザのコンソールに表示
console.log("Clip data:");
console.log(data);
}
wsvp_onPlayerError(data)
動画再生中にエラーが発生したときに呼び出されます。
パラメータ
- data(object):データとともに動画プレーヤーから返されたオブジェクト
- オブジェクトのプロパティ:
error(string) エラーメッセージ
- オブジェクトのプロパティ:
例)
function wsvp_onPlayerError(data)
{
// ブラウザのコンソールにエラーを表示
console.log("Error playing the video: "+data.error);
}
{
// ブラウザのコンソールにエラーを表示
console.log("Error playing the video: "+data.error);
}