Class Index | File Index

Classes


Class mbedAppBoard.Speaker


Defined in: mbedAppBoard.Speaker.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
mbedAppBoard.Speaker(i_mcu, i_handler)
MbedApplicationBoardのSpeakerを制御するクラスです。
Method Summary
Method Attributes Method Name and Description
 
dispose(i_callback)
インスタンスの確保しているオブジェクトを破棄します。 関数の完了時にonDispose,又はコールバック関数でイベントを通知します。 コンストラクタでGeneratorを指定した場合、yieldと併用して完了を待機できます。
 
sound(i_hz, i_callback)
Spekerから指定周波数の音を出力します。 関数の完了時にonSound,又はコールバック関数でイベントを通知します。 コンストラクタでGeneratorを指定した場合、yieldと併用して完了を待機できます。
 
コンストラクタでi_handlerにGeneratorを指定した場合のみ使用できます。 yieldと併用してコンストラクタの完了を待ちます。
Class Detail
mbedAppBoard.Speaker(i_mcu, i_handler)
MbedApplicationBoardのSpeakerを制御するクラスです。
//Callback
//Generator
//Callback hell
Parameters:
{mbedJS.MCU} i_mcu
インスタンスをバインドするオブジェクトです。
{HashMap|Generator|function} i_handler
非同期イベントの共通ハンドラの連想配列,Generator,個別コールバック関数の何れかを指定します。

{HashMap} 非同期イベントの共通イベントハンドラです。関数の引数returnは各関数の戻り値です。

  • onNew:function() - コンストラクタが完了し、インスタンスが使用可能になった時に呼び出されます。
  • onDispose:function() - disposeの完了時に呼び出されます。
  • onSound() - soundの完了時に呼び出されます。

{function} 関数の完了を受け取るコールバック関数です。onNew相当のコールバック関数が呼び出されます。

{Generator} yieldコールを行う場合にGeneratorを指定します。

Method Detail
dispose(i_callback)
インスタンスの確保しているオブジェクトを破棄します。 関数の完了時にonDispose,又はコールバック関数でイベントを通知します。 コンストラクタでGeneratorを指定した場合、yieldと併用して完了を待機できます。
Parameters:
{function()} i_callback
省略可能です。関数の完了通知を受け取るコールバック関数を指定します。関数の引数には、return値が入ります。 省略時は、コンストラクタに指定した共通イベントハンドラが呼び出されます。

sound(i_hz, i_callback)
Spekerから指定周波数の音を出力します。 関数の完了時にonSound,又はコールバック関数でイベントを通知します。 コンストラクタでGeneratorを指定した場合、yieldと併用して完了を待機できます。
Parameters:
{int} i_hz
出力する周波数です。
{function(return)} i_callback
省略可能です。関数の完了通知を受け取るコールバック関数を指定します。関数の引数には、return値が入ります。 省略時はコンストラクタに指定した共通イベントハンドラが呼び出されます。

waitForNew()
コンストラクタでi_handlerにGeneratorを指定した場合のみ使用できます。 yieldと併用してコンストラクタの完了を待ちます。

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Oct 20 2014 12:21:28 GMT+0900 (JST)