オプション設定

HTMLオーバーレイをONにすると、Androidデバイス上の
/sdcard/com.mediagram.magnezio/html/overlay.html
がビデオにオーバーレイ表示されます。デフォルトのファイル名はoverlay.htmlですが、「HTMLを選択... 」メニューで所定のディレクトリ
/sdcard/com.mediagram.magnezio/html/
に置かれている任意のHTMLに変更できます（拡張子は.html又は.htm）。

HTMLはどんな内容でも構わず、必ずしも通知されたメタデータやtweetを表示／利用する必要はありませんが、以下の制限があります：

• HDテレビ画面の解像度（1920×1080画素）を想定し、レンダリングはこのサイズに固定されています。 液晶の解像度が異なる場合はフルスクリーン表示になるようスケーリングされます。 横画面の場合は常に全画面表示になりStatus Barは表示されません。 液晶解像度が16:9でない場合は、画面の下部又は左右（sidepanel表示）に黒い非表示領域が設けられます。
• header要素内で

  <meta name="viewport" content="width=1920,height=1080"/>

  を指定してビデオ全画面にオーバーレイさせます。
• 縦横のスクロールバー表示やズーム表示のUIは禁止されています。
• 横画面ではAndroid 4.2.x以降では画面をタップするとAction BarとNavigation BarがHTMLの手前に表示されるため、 その背後に置かれた要素はタップできなくなります。 また、ビデオ再生時にはHTMLの手前に再生制御のUIが提示されますので、その背後に置かれた要素はタップできなくなります。
• ビデオにオーバーレイするため背景は透明に設定してありますので、background-color に濃い色を指定するとビデオが見えづらくなり、機種によってフリッカーが発生する可能性があります。
• MagnezioでTwitter機能を利用する場合は、Twitterのアカウントが必要です。 最初に一度だけOAuth認証によりTwitterにログインし、Access Tokenを取得する必要があります。 Twitterを利用しない場合は「つぶやきを表示しますか？（Twitterアカウントが必要です）」というダイアログで「表示しない」を選んで下さい。その際に「設定を保存」をチェックしておくと、次にHTMLオーバーレイ機能をONにした時にこの手順を省略できます。

  後日Twitterを利用したくなった場合は、Androidのアプリケーション管理画面でMagnezioアプリの「データを消去」で設定をクリアして下さい。 クリアすると、設定済みの郵便番号も含めBMLのスクリプトで設定されたデータ（NVRAM、ブックマーク、ルート証明書等）が全てクリアされます。

• HTMLオーバーレイをONにするとunloadイベント、OFFにするとonunloadイベントがそれぞれ発生しますので、必要に応じて開始／停止処理をして下さい。
• HTML にJavaScript関数onMetaData()が定義されていれば、放送ストリームに含まれているメタデータが通知されます。関数の仕様は以下の通りです。
  function onMetaData(meta) {...}

  引数metaは以下のプロパティを持つオブジェクトです：

  meta.tsName	その放送ストリームの名称（放送局名）
  meta.eventName	番組名
  meta.startTime	番組開始時刻
  meta.duration	番組の長さ
  meta.text	番組説明 メタデータに放送用追加記号が含まれる場合、置換可能なものは[二]や[デ]のような標準文字の組み合わせに自動置換します。また改行は捨てられます。

• HTML にJavaScript関数onCaption()が定義されていれば、放送ストリームに含まれている字幕文字列が通知されます。関数の仕様は以下の通りです。
  function onCaption(cap) {...}

  引数metaは以下のプロパティを持つオブジェクトです：

  cap	字幕文字列（UTF-8符号） 文字列は全て全角に変換され、DRCS、改行、引用符（”）は除去されます。 字幕に放送用追加記号が含まれる場合、置換可能なものは[二]や[デ]のような標準文字の組み合わせに自動置換します。

• HTML にJavaScript関数onVideoStarted(), onVideoStopped(), onVideoCurrentPosition()が定義されていれば、ビデオの再生開始、停止、現在位置が通知されます。それぞれの関数の仕様は以下の通りです。
  function onVideoStarted() {...}

  ビデオ再生が開始したことが通知されます。

  function onVideoStopped () {...}

  ビデオ再生が停止したことが通知されます。

  function onVideoCurrentPosition(millis) {...}

  ビデオ再生開始から約１秒間隔で現在の再生位置が通知されます。

  millis	現在の再生位置（current position、再生開始時刻からの経過時間） 単位はミリ秒

• tweetを表示（処理）する場合はHTMLにJavaScript関数onTweet()を定義して下さい。関数の仕様は以下の通りです。
  function onTweet(tweet) {...}

  引数tweetは以下のプロパティを持つオブジェクトです：

  tweet.date	tweetの時刻を表すミリ秒（又はtweetが到着した時刻）
  tweet.id	tweetのID
  tweet.text	tweetの本文（本文中の改行や全角スペースは半角スペースに置換されます）
  tweet.user	tweetをしたユーザのscreen name
  tweet.image	tweetをしたユーザのアイコン
  tweet.myself	tweetがユーザ自身のものならtrue
  tweet.friend	tweetをしたユーザがfriendならtrue
  tweet.follower	tweetをしたユーザがfollowerならtrue
  tweet.white	tweetをしたユーザがwhitelist.xmlに登録されていればtrue
  tweet.isRetweet	tweetがretweetならtrue
  tweet.tags	tweetに含まれるハッシュタグの一覧

  onTWeet()に渡されるtweetは、様々なXMLファイルやJavaScript APIでで制御可能です。

• tweetに関する統計情報を取得してtweetの勢いなどを表示するには、HTMLにJavaScript関数onTweetStat()を定義して下さい。関数の仕様は以下の通りです。
  function onTweetStat(stat) {...}

  引数tweetは以下のプロパティを持つオブジェクトです：

  stat.total	オーバーレイを開始してから受信した総tweet数（通知されないものも含む）
  stat.average	オーバーレイを開始してから受信した平均tweet数（tweets/分）
  stat.count	最後の15秒間に受信したtweet数（通知されないものも含む）
  stat.shown	最後の15秒間に通知されたtweet数
  stat.averageOfLastInterval	最後の15秒間に通知された平均tweet数の分換算値