\r
var X_Audio_BACKENDS = []; // Array.<Hash>\r
\r
-/*\r
- * X_EVENT_BACKEND_READY\r
- * X_EVENT_BACKEND_NONE\r
- * \r
- * X_EVENT_READY 再生可能、実際の状態は canplay から loadeddata まで様々、、、\r
- * X_EVENT_ERROR\r
- * 1 : ユーザーによってメディアの取得が中断された\r
- * 2 : ネットワークエラー\r
- * 3 : メディアのデコードエラー\r
- * 4 : メディアがサポートされていない\r
+/**\r
+ * <p>複数のバックエンドから、与えられた音声を再生可能なものを見つけ、音声を再生します。\r
+ * <p>HTMLAudio の動作・機能がブラウザ毎にバラバラなのに業を煮やし、メソッドやイベントは独自に定義しています。\r
+ * <h4>バックエンドの種類</h4>\r
+ * <p>HTMLAudio, WebAudio, Silverlight\r
+ * <h4>イベント</h4>\r
+ * <dl>\r
+ * <dt>X.Event.BACKEND_READY <dd>音声(src リスト)を再生可能なバックエンドが見つかった。\r
+ * <dt>X.Event.BACKEND_NONE <dd>音声を再生可能なバックエンドが見つからなかった。\r
+ * <dt>X.Event.READY <dd>再生可能、実際の状態は canplay から loadeddata まで様々、、、\r
+ * <dt>X.Event.ERROR <dd><ul>\r
+ * <li> 1 : ユーザーによってメディアの取得が中断された\r
+ * <li> 2 : ネットワークエラー\r
+ * <li> 3 : メディアのデコードエラー\r
+ * <li> 4 : メディアがサポートされていない\r
+ * </ul>\r
+ * <dt>X.Event.MEDIA_PLAYING <dd>再生中に1秒以下のタイミングで発生．currentTime が取れる?\r
+ * <dt>X.Event.MEDIA_LOOP <dd>ループ直前に発生、ｷｬﾝｾﾙ可能\r
+ * <dt>X.Event.MEDIA_LOOPED <dd>ループ時に発生\r
+ * <dt>X.Event.MEDIA_ENDED <dd>再生位置の(音声の)最後についた\r
+ * <dt>X.Event.MEDIA_PAUSED <dd>ポーズした\r
+ * <dt>X.Event.MEDIA_WAITING <dd>再生中に音声が待機状態に。間もなく X.Event.MEDIA_PLAYING に移行。\r
+ * <dt>X.Event.MEDIA_SEEKING <dd>シーク中に音声が待機状態に。間もなく X.Event.MEDIA_PLAYING に移行。\r
+ * </dl>\r
* \r
- * X_EVENT_MEDIA_PLAYING 再生中に1秒以下のタイミングで発生．currentTime が取れる?\r
- * X_EVENT_MEDIA_LOOP ループ直前に発生、ｷｬﾝｾﾙ可能\r
- * X_EVENT_MEDIA_LOOPED ループ時に発生\r
- * X_EVENT_MEDIA_ENDED 再生位置の(音声の)最後についた\r
- * X_EVENT_MEDIA_PAUSED ポーズした\r
- * X_EVENT_MEDIA_WAITING 再生中に音声が待機状態に。間もなく X_EVENT_MEDIA_PLAYING に移行。\r
- * X_EVENT_MEDIA_SEEKING シーク中に音声が待機状態に。間もなく X_EVENT_MEDIA_PLAYING に移行。\r
+ * @alias X.Audio\r
+ * @class 各種オーディオ機能をラップしインターフェイスを共通化する。\r
+ * @constructs Audio\r
+ * @extends {EventDispatcher}\r
+ * @param {array|string} sourceList\r
+ * @param {object=} opt_option\r
+ * @example //\r
+ * var audio = X.Audio( [ 'etc/special.mp3', 'etc/special.ogg', 'etc/special.wav' ] )\r
+ .listenOnce( X.Event.READY, onReady );\r
*/\r
-\r
-// TODO この内容は、AudioBackend の Abstract クラスにする。AudioSprite は Audio ではなく AudioBackend をマネージする\r
X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](\r
'X.Audio',\r
X_Class.POOL_OBJECT,\r
{\r
+ /**\r
+ * 音声の url。X.Event.BACKEND_READY で設定される。\r
+ * @alias Audio.prototype.source\r
+ * @type {string}\r
+ */\r
'source' : '',\r
+ /**\r
+ * 音声再生バックエンドの名前。X.Event.BACKEND_READY で設定される。\r
+ * @alias Audio.prototype.backendName\r
+ * @type {string}\r
+ */\r
'backendName' : '',\r
\r
'Constructor' : function( sourceList, opt_option ){\r
this[ 'listenOnce' ]( [ X_EVENT_BACKEND_READY, X_EVENT_BACKEND_NONE, X_EVENT_KILL_INSTANCE ], X_Audio_handleEvent );\r
},\r
\r
+ /**\r
+ * 再生。開始位置・終了位置、ループの有無、ループ以降の開始位置、ループ以降の終了位置\r
+ * @alias Audio.prototype.play\r
+ */\r
'play' : function( startTime, endTime, loop, loopStartTime, loopEndTime ){\r
var pair = X_Pair_get( this );\r
pair && pair.play( startTime, endTime, loop, loopStartTime, loopEndTime );\r
return this;\r
},\r
- \r
+ /**\r
+ * シーク\r
+ * @alias Audio.prototype.seek\r
+ */\r
'seek' : function( seekTime ){\r
var pair = X_Pair_get( this );\r
pair && pair.seek( seekTime );\r
return this;\r
},\r
- \r
+ /**\r
+ * ポーズ\r
+ * @alias Audio.prototype.pause\r
+ */\r
'pause' : function(){\r
var pair = X_Pair_get( this );\r
pair && pair.pause();\r
return this;\r
},\r
- \r
+ /**\r
+ * 状態の getter と setter\r
+ * @alias Audio.prototype.state\r
+ */\r
'state' : function( obj ){\r
var pair = X_Pair_get( this );\r
if( obj === undefined ){\r
pair && pair.setState( obj );\r
return this;\r
}, \r
- \r
+ /**\r
+ * ループの getter と setter\r
+ * @alias Audio.prototype.loop\r
+ */\r
'loop' : function( v ){\r
var pair = X_Pair_get( this );\r
pair && pair.loop( v );\r
return this;\r
},\r
-\r
+ /**\r
+ * ボリュームの getter と setter 実装不十分！\r
+ * @alias Audio.prototype.volume\r
+ */\r
'volume' : function( v ){\r
var pair = X_Pair_get( this );\r
pair && pair.volume( v );\r
return this;\r
},\r
-\r
+ /**\r
+ * 再生位置。\r
+ * @alias Audio.prototype.currentTime\r
+ */\r
'currentTime' : function( v ){\r
var pair = X_Pair_get( this );\r
pair && pair.currentTime( v );\r
return this;\r
},\r
-\r
+ /**\r
+ * 再生中か？\r
+ * @alias Audio.prototype.isPlaying\r
+ */\r
'isPlaying' : function(){\r
var pair = X_Pair_get( this );\r
return pair && pair.playing;\r
var i = X_Audio_BACKENDS.indexOf( this ), backend;\r
\r
if( e.canPlay ){\r
- xaudio._backend = i;\r
xaudio[ 'asyncDispatch' ]( {\r
type : X_EVENT_BACKEND_READY,\r
'option' : option,\r
OSDN Git Service
