FMRadio

非標準
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

This API is available on Firefox or Firefox OS for installed or higher privileged applications.

概要

WebFM API は、端末の FM ラジオへのアクセスを提供します。このインターフェースは、FM ラジオの ON、OFF およびチューニングにより他の局への切り替えを可能にします。これらは navigator.mozFMRadio プロパティを通してアクセスできます。

API 概観

interface FMRadio : EventTarget {
   readonly attribute boolean enabled;
   readonly attribute boolean antennaAvailable;
   readonly attribute double frequency;
   readonly attribute double frequencyUpperBound;
   readonly attribute double frequencyLowerBound;
   readonly attribute double channelWidth;

   attribute Function onantennaavailablechange;
   attribute Function onfrequencychange;
   attribute Function onenabled;
   attribute Function ondisabled;

   DOMRequest enable(double frequency);
   DOMRequest disable();
   DOMRequest setFrequency(double frequency);
   DOMRequest seekUp();
   DOMRequest seekDown();
   DOMRequest cancelSeek();
}

プロパティ

FMRadio.enabled
ラジオが再生中かどうかを示します。
FMRadio.antennaAvailable
アンテナが接続され利用可能かどうかを示します。
FMRadio.frequency
現在のラジオ周波数を示します。
FMRadio.frequencyUpperBound
seek メソッドで検索するラジオ局の周波数の最大値。
FMRadio.frequencyLowerBound
seek メソッドで検索するラジオ局の周波数の最小値。
FMRadio.channelWidth
周波数の範囲のチャンネル幅 (MHz 単位)。

イベントハンドラ

FMRadio.onenabled
enabled イベントのためのハンドラ。ラジオが ON になった時に発火します。
FMRadio.ondisabled
disabled イベントのためのハンドラ。ラジオが OFF になった時に発火します。
FMRadio.onantennaavailablechange
antennaavailablechange イベントのためのハンドラ。アンテナが抜き差しされた時に発火します。
FMRadio.onfrequencychange
frequencychange イベントのためのハンドラ。ラジオ周波数が変更されるたびに発火します。

メソッド

FMRadio.enable()
与えられた周波数でラジオを ON にします。この関数は、引数なしで呼ばれた場合にエラーを投げます。命令の成功またはエラーを扱う DOMRequest を返します。
FMRadio.disable()
ラジオを OFF にします。DOMRequest を返し、これが成功の場合、ラジオが正しく無効化されたことを示します。
FMRadio.setFrequency()
非同期でラジオの周波数を変更します。周波数の値は、frequencyLowerBoundfrequencyUpperBound の間にしなければなりません。この範囲外の値をセットしようとするとエラーになります。
DOMRequest を返し、これが成功の場合、周波数が正しく変更されたことを示します。
FMRadio.seekUp()
次の周波数を探索します (通常は現在よりも高いほうの周波数)。ラジオチャンネルが見つかると、frequencychange イベントが発生します。DOMRequest を返し、これが成功の場合、探索が開始されたことを示します。探索する周波数が上限に達すると、低い周波数に折り返して探索されます。
FMRadio.seekDown()
上記と同じですが、現在よりも低いほうの周波数を探索します。探索する周波数が下限に達すると、高い周波数に折り返して探索されます。
FMRadio.cancelSeek()
ラジオチャンネルの探索をキャンセルします。DOMRequest を返し、これが成功の場合、周波数の探索がキャンセルされたことを示します。

仕様書

仕様はありません。

参照

ドキュメントのタグと貢献者

 このページの貢献者: Marsf, prometeo203
 最終更新者: Marsf,