プレイヤーを操作するためのJavaScriptAPI一覧です。
目次
- Eviry.Player.ready(callback, [extid])(プレイヤーAPIの呼び出し)
- MillviPlayer.fetchAudienceCount()(ライブ配信時の視聴者数を取得)
- MillviPlayer.getCurrentPosition()(現在の再生位置を取得)
- MillviPlayer.getDuration()(動画の長さを取得)
- MillviPlayer.getVideoID()(動画IDを取得)
- MillviPlayer.isEnded()(再生完了状態を取得)
- MillviPlayer.isPausing()(一時停止状態を取得)
- MillviPlayer.isPlaying()(再生状態を取得)
- MillviPlayer.pause()(動画の一時停止)
- MillviPlayer.play()(動画の再生)
- MillviPlayer.setCurrentPosition()(動画の再生位置指定、シーク)
- MillviPlayer.reloadFlash()(IE向け、プレイヤーの再度表示に必要)
Eviry.Player.ready(callback, [extid])
(プレイヤーAPIの呼び出し)
仕様
ページ内に貼り付けられているミルビィプレイヤーがロードされて操作が可能になったタイミングで第1引数に指定されたコールバック関数を実行します。
成功時(ミルビィプレイヤー[MillviPlayer]の正常取得)も失敗時(ページ内にミルビィプレイヤーが見つからないなど、ミルビィプレイヤーの取得失敗時)も実行されます。成功/失敗は関数の第1引数に渡されるMillviPlayerで判断可能です。
ページ内に複数のミルビィプレイヤー埋め込みコードが含まれている場合、対象のミルビィプレイヤーを特定するために extid を指定する必要があります。 extid はミルビィプレイヤー埋め込みコードのパラメーター Eviry.Player.extid に対応します。 未指定の場合は最初に取得可能なミルビィプレイヤーとなります。
引数
名前 | 値 |
---|---|
callback | MillviPlayer を取得するコールバック関数。 |
extid | 対象プレイヤーを特定するための ID (Eviry.Player.extid に指定した ID)。省略可。 |
返り値
無し
callback の仕様
第1引数でミルビィプレイヤーを取得。ミルビィプレイヤーの取得に失敗した場合は null。
MillviPlayer.fetchAudienceCount()
(ライブ配信時の視聴者数を取得)
※本APIはベータ版です。
仕様
視聴中のライブ配信のリアルタイム視聴者数と総視聴者数を取得します。
(ライブでないビデオ視聴時にはリアルタイム視聴者数、総視聴者数共に-1になります。)
引数
名前 | 値 |
---|---|
callback | 視聴者数を取得した時の動作 |
realtimeCount | リアルタイム視聴者数 |
totalCount | 総視聴者数 |
(視聴者数取得失敗時にはrealtimeCount、totalCount共に-1になります。)
返り値
無し
サンプルコード
callbackにsuccessとfailを定義し、結果を元に画面表示を書き換えます。
<html>
<head></head>
<body>
<script type="text/javascript">var Eviry=Eviry||{};Eviry.Player||(Eviry.Player={});Eviry.Player.embedkey="xxx";</script>
<script type="text/javascript" src="https://xxxxxxxxxxxxx/eviry.player.min.js"></script>
<script type="text/javascript">
<!--
function getAudienceCount () {
Eviry.Player.ready(function (millviplayer) {
if (millviplayer) {
millviplayer.fetchAudienceCount(function (realtimeCount, totalCount) {
document.getElementById("realtimeCount").innerHTML = realtimeCount;
document.getElementById("totalCount").innerHTML = totalCount;
});
}
});
}
-->
</script>
<div>
<button onclick="getAudienceCount()">視聴者数取得</button><br>
<span>現在の視聴者数: <span id="realtimeCount">0</span></span><br>
<span>総視聴者数: <span id="totalCount">0</span></span>
</div>
</body>
</html>
MillviPlayer.getCurrentPosition()
(現在の再生位置を取得)
仕様
現在の再生時間を取得します。
引数
無し
返り値
[number] 再生位置(秒:小数点付き)
サンプルコード
こちらをご参照ください。
MillviPlayer.getDuration()
(動画の長さを取得)
仕様
動画の総再生時間を取得します。
引数
なし
返り値
[string] 動画 総再生時間
MillviPlayer.getVideoID()
(動画IDを取得)
仕様
再生中の動画の動画 ID を取得します。
引数
無し
返り値
[string] 動画 ID
MillviPlayer.isEnded()
(再生完了状態を取得)
仕様
Eviry.Player.readyを利用して取得したプレイヤーに対して使用可能です。
再生完了状態の時trueを返し、それ以外の状態ではfalseを返します。
ただし、スマートフォンでは完了時に機種側で最初に戻ってしまう場合の完了状態を取得できません。
その場合は Eviry.Player.eventListeners をお試しください。
引数
無し
返り値
Boolean(再生完了状態の時trueを返し、それ以外の状態ではfalse)
MillviPlayer.isPausing()
(一時停止状態を取得)
仕様
Eviry.Player.readyを利用して取得したプレイヤーに対して使用可能です。
一時停止状態の時trueを返し、それ以外の状態ではfalseを返します。
引数
無し
返り値
Boolean(一時停止状態の時trueを返し、それ以外の状態ではfalse)
MillviPlayer.isPlaying()
(再生状態を取得)
仕様
Eviry.Player.readyを利用して取得したプレイヤーに対して使用可能です。
再生状態の時trueを返し、それ以外の状態ではfalseを返します。
引数
無し
返り値
Boolean(再生状態の時true、それ以外の状態ではfalse)
MillviPlayer.pause()
(動画の一時停止)
仕様
一時停止します。
引数
無し
返り値
無し
サンプルコード
表示した動画を一時停止します。
<html>
<head></head>
<body>
<script type="text/javascript">var Eviry=Eviry||{};Eviry.Player||(Eviry.Player={});Eviry.Player.host="demo";Eviry.Player.id_vhost=1;Eviry.Player.id_tag=1;</script>
<script type="text/javascript" src="https://xxxxxxxxxxxxx/eviry.player.min.js"></script>
<script type="text/javascript">
<!--
Eviry.Player.ready(function (millviplayer) {
if (millviplayer) {
millviplayer.pause();
}
});
-->
</script>
</body>
</html>
MillviPlayer.play()
(動画の再生)
仕様
一時停止状態から再生を再開します。
注意
PC 以外の端末は、ユーザーインターフェース上で一度再生することで使用可能となります
引数
time [number] 再生時間(秒:小数点付き)
※ 未入力の場合、現在の再生時間から再開する。
返り値
なし
MillviPlayer.setCurrentPosition()
(動画の再生位置指定、シーク)
仕様
再生時間を指定します。
(Android4 系未満の端末に対してプログレッシブダウンロード配信の場合は動作しません)
引数
time [number] 再生時間(秒:小数点付き)
返り値
無し
MillviPlayer.reloadFlash()
(IE向け、プレイヤーの再度表示に必要)
仕様
Internet Explorer ではプレイヤーをdisplay: none で非表示後、display: block で再度表示する場合に、millviplayer.reloadFlash()を呼び出す必要があります。
当APIを適切に呼び出さない場合、動画再生の挙動が Internet Explorer で異なる可能性があります。
引数
無し
返り値
無し