このセクションの記事

もっと見る

プレイヤーコマンドのご利用方法

Avatar
更新

プレーヤーコマンドはビデオグプレイヤーをお客様ページにiframeで埋め込む場合に、埋め込み先のお客様ページ（以後「埋込ページ」とする）で、プレイヤーを操作するための機能になります。

 

◯目次

 

◯ 注意事項

  • プレーヤーコマンドは WebMessagingというブラウザの機能により、iframeに操作の通知を行うことで動作します。この仕組みに対応していないブラウザではご利用になれません。

 

◯操作できるプレイヤーコマンド

 

◯サンプル

※以下サンプルには jQuery を利用しています。

 

コアプレイヤー

再生

※ ブラウザ側の仕様により、ページを開いてから最初の再生時にはご利用いただけない場合がございます。

  • コマンド名：play
  • データ：true
  • データ形式：true
  • コーディング例：

 

一時停止

  • コマンド名：pause
  • データ：true
  • データ形式：true
  • コーディング例：

 

停止

  • コマンド名：stop
  • データ：なし
  • データ形式：なし
  • コーディング例：

 

シーク

※シークの精度は再生機器の仕様により、指定した秒数に厳密にシークされないことがあります。

  • コマンド名：seek
  • データ：シーク先秒数
  • データ形式：数値
  • コーディング例：

 

ミュート（消音）

  • コマンド名：setMute
  • データ：なし、true、false
    • なし：ミュートのトグル
    • true：ミュートon
    • false：ミュートoff
  • データ形式：なし、またはbool
  • コーディング例：

 

ボリューム

  • コマンド名：setVolume
  • データ：音量(%)
  • データ形式：数値 0 - 100
  • コーディング例：

 

フルスクリーン

※ブラウザの仕様により正常に動作しない場合がございます。

  • コマンド名：setFullscreen
  • データ：なし、true、false
    • なし：フルスクリーンのトグル
    • true：フルスクリーンon
    • false：フルスクリーンoff
  • データ形式：なし、またはbool
  • コーディング例：

 

再生位置取得(プレイヤーバージョン2.2.x以上)

※本コマンドをご利用の際はプレイヤーイベントのplayerPostionを合わせてご利用ください。

  • コマンド名：getPosition
  • データ：なし
  • データ形式：なし
  • コーディング例：

 

ボリューム取得(プレイヤーバージョン2.2.x以上)

※本コマンドをご利用の際はプレイヤーイベントのresponseVolumeを合わせてご利用ください。

  • コマンド名：getVolume
  • データ：なし
  • データ形式：なし
  • コーディング例：

 

倍速再生(プレイヤーバージョン2.2.x以上)

  • コマンド名：setPlaybackRate
  • データ：倍率
  • データ形式：0-10
  • コーディング例：

 

倍速再生率取得(プレイヤーバージョン2.2.x以上)

  • コマンド名：getPlaybackRate
  • データ：なし
  • データ形式：なし
  • コーディング例：

プレイリスト

※プレイリスト関連のプレイヤーコマンドは、プレイリスト機能を利用している必要があります。

 

プレイリストのアイテム選択

  • コマンド名：playlistItem
  • データ：プレイリストのインデックス番号
  • データ形式：数値 先頭：0
  • コーディング例：

 

プレイリストの入れ替え

  • コマンド名：load
  • データ：動画のリスト
  • データ形式：
    [
  {
    image: "文字列：サムネイル画像のURL"
    title: "文字列：動画のタイトル",
    sources: [
        {
          file: "文字列：動画のURL",
        },
      ],
  },
]
  • コーディング例：

 

字幕 

※字幕関連のプレイヤーコマンドは、字幕機能を利用している必要があります。

 

字幕の選択 (プレイヤーバージョン2.2.x以上)

  • コマンド名：setCurrentCaptions
  • データ：字幕のインデックス番号
  • データ形式：数値 先頭：0
  • コーディング例：

 

字幕の表示 (プレイヤーバージョン2.2.x以上)

  • コマンド名：setCaption
  • データ：なし、true、false
    • なし：字幕のトグル
    • true：字幕を表示する
    • false：字幕を非表示にする
  • データ形式：なし、またはbool
    • コーディング例：

 

 

関連記事