OSDN Git Service

Version 0.6.194, X.UI.Page working.
[pettanr/clientJs.git] / 0.6.x / js / 07_audio / 00_XAudio.js
index 5d714c2..234f057 100644 (file)
@@ -25,16 +25,17 @@ X_TEMP.onSystemReady.push(
        });\r
 \r
 /**\r
- * <p>複数のバックエンドから、与えられた音声を再生可能なものを見つけ、音声を再生します。\r
+ * <p>è¤\87æ\95°ã\81®ã\82ªã\83¼ã\83\87ã\82£ã\82ªã\83»ã\83\90ã\83\83ã\82¯ã\82¨ã\83³ã\83\89ã\81\8bã\82\89ã\80\81ä¸\8eã\81\88ã\82\89ã\82\8cã\81\9fé\9f³å£°ã\82\92å\86\8dç\94\9få\8f¯è\83½ã\81ªã\82\82ã\81®ã\82\92è¦\8bã\81¤ã\81\91ã\80\81é\9f³å£°ã\82\92å\86\8dç\94\9fã\81\97ã\81¾ã\81\99ã\80\82\r
  * <p>HTMLAudio の動作・機能がブラウザ毎にバラバラなのに業を煮やし、メソッドやイベントは独自に定義しています。\r
  * <h4>バックエンドの種類</h4>\r
  * <p>HTMLAudio, WebAudio, Silverlight, WMP\r
  * <h4>イベント</h4>\r
  * <dl>\r
- * <dt>X.Event.BACKEND_READY <dd>音声(src リスト)を再生可能なバックエンドが見つかった。\r
- * <dt>X.Event.BACKEND_NONE  <dd>音声を再生可能なバックエンドが見つからなかった。Audio は kill されます。\r
- * <dt>X.Event.READY         <dd>再生可能、実際の状態は canplay から loadeddata まで様々、、、\r
- * <dt>X.Event.ERROR         <dd><ul>\r
+ * <dt>X.Event.BACKEND_READY   <dd>音声(src リスト)を再生可能なバックエンドが見つかった。\r
+ * <dt>X.Event.BACKEND_NONE    <dd>音声を再生可能なバックエンドが見つからなかった。Audio は kill されます。\r
+ * <dt>X.Event.MEDIA_CAN_TOUCH <dd>モバイル端末の制約で音声の再生またはロードに、タッチを必要とする場合、タッチイベント内で play を呼び出す準備が出来たことを通知する。\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
@@ -47,7 +48,6 @@ X_TEMP.onSystemReady.push(
  * <dt>X.Event.MEDIA_PAUSED    <dd>ポーズした\r
  * <dt>X.Event.MEDIA_WAITING   <dd>再生中に音声が待機状態に。\r
  * <dt>X.Event.MEDIA_SEEKING   <dd>シーク中に音声が待機状態に。\r
- * <dt>X.Event.MEDIA_CAN_TOUCH <dd>シーク中に音声が待機状態に。\r
  * </dl>\r
  * \r
  * @alias X.Audio\r
@@ -70,14 +70,14 @@ X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](
                 * @type {string}\r
                 */\r
                'source'      : '',\r
+               \r
                /**\r
                 * 音声再生バックエンドの名前。X.Event.BACKEND_READY で設定される。\r
                 * @alias Audio.prototype.backendName\r
                 * @type {string}\r
                 */\r
                'backendName' : '',\r
-               \r
-               // TODO\r
+\r
                'Constructor' : function( sourceList, opt_option ){\r
                        X_Audio_startDetectionBackend(\r
                                X_Audio_BACKENDS[ 0 ], this,\r
@@ -90,6 +90,12 @@ X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](
                /**\r
                 * 再生。開始位置・終了位置、ループの有無、ループ以降の開始位置、ループ以降の終了位置\r
                 * @alias Audio.prototype.play\r
+                * @param {number=} startTime 開始時間を ms で\r
+                * @param {number=} endTime 終了時間を ms で\r
+                * @param {boolean=} endTime に達した際に曲をループさせるか\r
+                * @param {number=} loopStartTime ループ以後の開始時間を ms で\r
+                * @param {number=} loopEndTime ループ以後の終了時間を ms で\r
+                * @return {Audio} メソッドチェーン\r
                 */\r
                'play' : function( startTime, endTime, loop, loopStartTime, loopEndTime ){\r
                        var pair = X_Pair_get( this );\r
@@ -97,8 +103,10 @@ X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](
                        return this;\r
                },\r
                /**\r
-                * シーク\r
+                * シーク、再生中で無い場合は次回再生開始位置の指定のみ\r
                 * @alias Audio.prototype.seek\r
+                * @param {number} seekTime シーク位置を ms で\r
+                * @return {Audio} メソッドチェーン\r
                 */\r
                'seek' : function( seekTime ){\r
                        var pair = X_Pair_get( this );\r
@@ -108,6 +116,7 @@ X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](
                /**\r
                 * ポーズ\r
                 * @alias Audio.prototype.pause\r
+                * @return {Audio} メソッドチェーン\r
                 */\r
                'pause' : function(){\r
                        var pair = X_Pair_get( this );\r
@@ -117,6 +126,21 @@ X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](
                /**\r
                 * 状態の getter と setter\r
                 * @alias Audio.prototype.state\r
+                * @param {object=} obj setter の場合、上書きする値を格納したobject\r
+                * @return {Audio|object}\r
+                * @example\r
+                * audio.setState(\r
+                                       {\r
+                                       'startTime'     : 0,\r
+                                       'endTime'       : 80000,\r
+                                       'loopStartTime' : 120000,\r
+                                       'loopEndTime'   : 200000,\r
+                                       'currentTime'   : 0,\r
+                                       'loop'          : true,\r
+                                       'looded'        : false,\r
+                                       'volume'        : 1,\r
+                                       'autoplay'      : true\r
+                                       });\r
                 */\r
                'state' : function( obj ){\r
                        var pair = X_Pair_get( this );\r
@@ -130,18 +154,22 @@ X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](
                                        'currentTime'   : -1,\r
                                        'loop'          : false,\r
                                        'looded'        : false,\r
-                                       'error'         : false,\r
+                                       'error'         : 0,\r
+                                       'autoplay'      : false,\r
                                        'playing'       : false,\r
-                                       'source'        : this[ 'source' ] || '',\r
-                                       'duration'      : 0\r
+                                       'source'        : this[ 'source' ],\r
+                                       'duration'      : 0,\r
+                                       'volume'        : 0.5\r
                                        };\r
                        };\r
                        pair && pair.setState( obj );\r
                        return this;\r
                },              \r
                /**\r
-                * ループの getter と setter\r
+                * ループの setter\r
                 * @alias Audio.prototype.loop\r
+                * @param {boolean} v \r
+                * @return {Audio}\r
                 */\r
                'loop' : function( v ){\r
                        var pair = X_Pair_get( this );\r
@@ -149,8 +177,10 @@ X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](
                        return this;\r
                },\r
                /**\r
-                * ボリュームの getter と setter 実装不十分!\r
+                * ボリュームの setter 実装不十分!\r
                 * @alias Audio.prototype.volume\r
+                * @param {number} v \r
+                * @return {Audio}\r
                 */\r
                'volume' : function( v ){\r
                        var pair = X_Pair_get( this );\r
@@ -158,8 +188,10 @@ X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](
                        return this;\r
                },\r
                /**\r
-                * 再生位置。\r
+                * å\86\8dç\94\9fä½\8dç½®ã\81®setterã\80\82\r
                 * @alias Audio.prototype.currentTime\r
+                * @param {number} v msで\r
+                * @return {Audio}\r
                 */\r
                'currentTime' : function( v ){\r
                        var pair = X_Pair_get( this );\r
@@ -169,6 +201,7 @@ X[ 'Audio' ] = X_EventDispatcher[ 'inherits' ](
                /**\r
                 * 再生中か?\r
                 * @alias Audio.prototype.isPlaying\r
+                * @return {boolean}\r
                 */\r
                'isPlaying' : function(){\r
                        var pair = X_Pair_get( this );\r
@@ -347,6 +380,7 @@ var X_AudioBase = X_EventDispatcher[ 'inherits' ](
                        'volume'        : this.gain,\r
                        'playing'       : this.playing,                         \r
                        'duration'      : this.duration,\r
+                       'autoplay'      : this.autoplay,\r
                        \r
                        'currentTime'  : this.playing ? this.getActualCurrentTime() : this.seekTime,\r
                        'error'        : this.getActualError ? this.getActualError() : this.error\r