Audio
Audioウィジェットは、オーディオファイルを再生するプレーヤーです。
再生・一時停止・10秒前後移動ボタンと再生位置スライダーを備えた標準UIも一緒に提供します。
定義・役割
Audioウィジェットは、指定したオーディオソース(アセット・URL)を再生します。音量・再生速度・左右バランス・繰り返しの有無と開始位置を設定でき、アプリがバックグラウンドに切り替わったときの動作も指定できます。
- カテゴリー:Contents
- 標準UI:再生/一時停止・10秒前後移動ボタンと再生位置スライダー
- デフォルト音量:
0.5 - デフォルトの再生状態:
Stop
機能
| 機能 | 説明 |
|---|---|
| 再生 / 停止 | statusの値でオーディオの再生と停止を制御します。 |
| 繰り返し再生 | loopをオンにすると、再生が終わったあとseekの位置から再び繰り返します。 |
| 音量・速度・バランス | volume、playBackRate、balanceで音量・再生速度・左右の音響バランスを調整します。 |
| 開始位置の指定 | seekで全体の長さに対する開始位置をパーセント(%)で指定します。 |
| 標準UIの表示 | showUiをオンにすると、再生/一時停止・10秒移動ボタンと進行スライダーが表示されます。 |
| バックグラウンド動作 | playBackgroundOptionで、アプリがバックグラウンドに移ったときに再生を停止・一時停止・継続するかを選択します。 |
使い方
- 左のウィジェットパレットでContentsカテゴリーを開きます。
- Audio項目をキャンバスにドラッグ&ドロップします。
- 右のPropertiesパネルで
audioプロパティに再生するオーディオソース(アセット・URL)を指定します。 - 必要に応じて
volume・loop・playBackRate・balanceなどを調整します。 statusをPlayに設定すると再生が始まります。
プロパティ
| プロパティ | 説明 | デフォルト値 | 値 / タイプ |
|---|---|---|---|
audio | 再生するオーディオソース(アセットまたはURL) | なし(空のソース) | オーディオソース |
showUi | 標準プレーヤーUI(ボタン・スライダー)を表示するかどうか | true | true/false(bool) |
status | 再生状態 | Stop | Stop, Play |
loop | 繰り返し再生するかどうか | false | true/false(bool) |
volume | 再生音量 | 0.5 | 数値 0.0 ~ 1.0 |
seek | 再生開始位置(全体の長さに対する%) | 0 | 整数 0 ~ 99 |
playBackRate | 再生速度の倍率 | 1.0 | 数値 0.5 ~ 2.0 |
balance | 左右の音響バランス | 0.0 | 数値 -1.0 ~ 1.0 |
playBackgroundOption | アプリがバックグラウンドに移ったときの再生動作 | Disable | Disable, DisablePause, Enabled |
注意・ヒント
警告
audioソースが空の場合(空のURL)、音は再生されません。再生するにはaudioプロパティにオーディオソースを必ず指定してください。
ヒント
seekは秒単位ではなく、全体の長さに対する百分率(0~99)です。loopをオンにすると、再生が終わったあとこの位置から再び繰り返されます。
さらに詳しく
ヒント
このウィジェットをスクリプトで制御するWidget Control(Property・Method・Event)の全体は、Audio Widget Controlドキュメントで確認してください。