applican

マイページに戻る

Media ver.2.0

オーデイオの再生・バックグラウンド再生・停止・一時停止・解放・音量調整・録音を制御する事が出来ます。

アプリカンAPIのver.2.0系のMediaのリファレンスです

  1. アプリカンAPIのver.1.0系のMediaのリファレンスはこちらからご確認ください。

※メソッドを使用する前には必ず再生でしたらプレイヤーオブジェクト、録音でしたらレコーダーオブジェクトを作成してください。

機能

オブジェクト作成

再生(Applican MediaPlayer)

録音(Applican MediaRecorder)

利用用途

ゲームサウンド以外で音声を扱いたい場合(ミュージックプレーヤー等)、こちらの機能をご利用ください。

【対応ランタイムバージョン】

ランタイムのバージョン毎に最適化したサンプルをダウンロードしてご使用ください。

サンプル media
サンプル media
サンプル media
サンプル media
サンプル media

オブジェクト作成

メソッド

プロパティ

onplaybackfinished 再生・録音終了時にコールバックされます。

createMediaPlayer

メソッド説明

createMediaPlayer(String outputFile , Function SuccessCallback, Function ErrorCallback)

プレイヤーオブジェクトを作成します。

パラメータ

outputFile : String 再生ファイル URLを指定します。
SuccessCallback : Function プレイヤーオブジェクトを作成出来た場合にCallbackされます。
ErrorCallback : Function プレイヤーオブジェクトを作成出来なかった場合にCallbackされます。

Return

void

サンプルコード

createMediaPlayer = function() {
    //オブジェクト作成
    applican.media.createMediaPlayer(local://media/sample.mp3, function(result) {
        player = result;
        //再生終了時の処理
        player.onplaybackfinished = function() {
            player.stop();
            player.release();
            player = null;
            alert('再生を終了しました');
        };
        //再生開始
        player.play();
        alert('再生開始');
    }, function() {
        //オブジェクト作成が失敗
        alert('オブジェクトエラー');
    });
}

createMediaRecorder

メソッド説明

createMediaRecorder(String outputFile , Function SuccessCallback, Function ErrorCallback)

値を設定します。

パラメータ

outputFile : String 録音ファイル URLを指定します。
SuccessCallback : Function レコーダーオブジェクトを作成出来た場合にCallbackされます。
ErrorCallback : Function レコーダーオブジェクトを作成出来なかった場合にCallbackされます。

Return

void

サンプルコード

createMediaRecorder = function() {
    //ファイルシステムを取得
    applican.requestFileSystem(LocalFileSystem.PERSISTENT, 0, function(fs) {
        var recordedPath = fs.root.fullPath + "/recording_test.m4a";

        //オブジェクト作成
        applican.media.createMediaRecorder(recordedPath, function(result) {
            recorder = result;
            //録音終了時の処理
            recorder.onplaybackfinished = function() {
                recorder.stop();
                recorder.release();
                recorder = null;
                alert('録音を終了しました');
            };
            //録音開始
            recorder.record();
            alert('録音を開始しました');
        }, function() {
            //録音失敗
            alert('録音が失敗しました');
        });
    }, function() {
        //ファイルシステムエラー
        alert('ファイルシステムエラー');
    });
}

再生(MediaPlayer)

メソッド

player.release

メソッド説明

player.release(Function SuccessCallback, Function ErrorCallback)

プレイヤーのリソースを解放します。

パラメータ

SuccessCallback : Function プレイヤーのリソースを解放出来た場合にCallbackされます。
ErrorCallback : Function プレイヤーのリソースを解放出来なかった場合にCallbackされます。

Return

void

サンプルコード

var player;

//プレイヤーのリソース解放用メソッド呼び出し
player.release(success, failure);

//プレイヤーのリソース解放成功時のコールバック
function success() {
    console.log("release() successful.");
    player = null;
}
//プレイヤーのリソース解放失敗時のコールバック
function failure(error) {
    console.log("release() failure.", error);
    player = null;
}

player.play

メソッド説明

player.play(<MediaPlayerOption> options, Function SuccessCallback, Function ErrorCallback)

再生を開始します。

パラメータ

options : <MediaPlayerOption> オプションを設定します。
SuccessCallback : Function 再生を開始出来た場合にCallbackされます。
ErrorCallback : Function 再生を開始出来なかった場合にCallbackされます。

Return

void

サンプルコード

var player;

//オプションの設定
var options = {
  output: "speaker",
  background: false,
  loopCount: 2
};

//再生開始用メソッド呼び出し
player.play(options, success, failure);

//再生開始成功時のコールバック
function success() {
    console.log("play() successful.");
}
//再生開始失敗時のコールバック
function failure(error) {
    console.log("play() failure.", error);
}

player.stop

メソッド説明

player.stop(Function SuccessCallback, Function ErrorCallback)

再生を停止します。

パラメータ

SuccessCallback : Function 再生を停止出来た場合にCallbackされます。
ErrorCallback : Function 再生を停止出来なかった場合にCallbackされます。

Return

void

サンプルコード

var player;

//再生停止用メソッド呼び出し
player.stop(success, failure);

//再生停止成功時のコールバック
function success() {
    console.log("stop() successful.");
}
//再生停止失敗時のコールバック
function failure(error) {
    console.log("stop() failure.", error);
}

player.pause

メソッド説明

player.pause(Function SuccessCallback, Function ErrorCallback)

再生を一時停止します。

パラメータ

SuccessCallback : Function 再生を一時停止出来た場合にCallbackされます。
ErrorCallback : Function 再生を一時停止出来なかった場合にCallbackされます。

Return

void

サンプルコード

var player;

//再生停止用メソッド呼び出し
player.pause(success, failure);

//再生停止成功時のコールバック
function success() {
    console.log("pause() successful.");
}
//再生停止失敗時のコールバック
function failure(error) {
    console.log("pause() failure.", error);
}

player.seekTo

メソッド説明

player.seekTo(Number position, Function SuccessCallback, Function ErrorCallback)

再生位置を変更します。

パラメータ

position : Number 再生位置を設定します。
SuccessCallback : Function 再生位置を変更場合にCallbackされます。
ErrorCallback : Function 再生位置を変更出来なかった場合にCallbackされます。

Return

void

サンプルコード

var player;

//再生位置を変更用メソッド呼び出し
player.seekTo(10000, success, failure);

//再生位置を変更成功時のコールバック
function success(result) {
    console.log("seekTo() successful.", result);
}
//再生位置を変更失敗時のコールバック
function failure(error) {
    console.log("seekTo() failure.", error);
}

player.getDuration

メソッド説明

player.getDuration(Function SuccessCallback, Function ErrorCallback)

再生ファイルの再生時間を取得します。

パラメータ

SuccessCallback : Function 再生ファイルの再生時間を取得出来た場合にCallbackされます。
ErrorCallback : Function 再生ファイルの再生時間を取得出来なかった場合にCallbackされます。

Return

void

サンプルコード

var player;

//再生ファイルの再生時間を取得用メソッド呼び出し
player.getDuration(success, failure);

//再生ファイルの再生時間を取得成功時のコールバック
function success(result) {
    console.log("getDuration() successful.", result);
}
//再生ファイルの再生時間を取得失敗時のコールバック
function failure(error) {
    console.log("getDuration() failure.", error);
}

player.getCurrentPosition

メソッド説明

player.getCurrentPosition(Function SuccessCallback, Function ErrorCallback)

現在の再生位置を取得します。

パラメータ

SuccessCallback : Function 現在の再生位置を取得出来た場合にCallbackされます。
ErrorCallback : Function 現在の再生位置を取得出来なかった場合にCallbackされます。

Return

void

サンプルコード

var player;

//現在の再生位置を取得用メソッド呼び出し
player.getCurrentPosition(success, failure);

//現在の再生位置を取得成功時のコールバック
function success(result) {
    console.log("getCurrentPosition() successful.", result);
}
//現在の再生位置を取得失敗時のコールバック
function failure(error) {
    console.log("getCurrentPosition() failure.", error);
}

player.setVolume

メソッド説明

player.setVolume(Number volume, Function SuccessCallback, Function ErrorCallback)

再生音量を変更します。

パラメータ

volume : Number 再生音量を設定します。
再生音量(0~100)
SuccessCallback : Function 再生音量を変更出来た場合にCallbackされます。
ErrorCallback : Function 再生音量を変更出来なかった場合にCallbackされます。

Return

void

サンプルコード

var player;

//再生音量を変更用メソッド呼び出し
player.setVolume(75, success, failure);

//再生音量を変更成功時のコールバック
function success(result) {
    console.log("setVolume() successful.", result);
}
//再生音量を変更失敗時のコールバック
function failure(error) {
    console.log("setVolume() failure.", error);
}

player.getVolume

メソッド説明

player.getVolume(Function SuccessCallback, Function ErrorCallback)

現在の再生音量を取得します。

パラメータ

SuccessCallback : Function 現在の再生音量を取得出来た場合にCallbackされます。
ErrorCallback : Function 現在の再生音量を取得出来なかった場合にCallbackされます。

Return

void

サンプルコード

var player;

//現在の再生音量を取得用メソッド呼び出し
player.getVolume(success, failure);

//現在の再生音量を取得成功時のコールバック
function success(result) {
    console.log("getVolume() successful.", result);
}
//現在の再生音量を取得失敗時のコールバック
function failure(error) {
    console.log("getVolume() failure.", error);
}

録音(MediaRecorder)

メソッド

recorder.release

メソッド説明

recorder.release(Function SuccessCallback, Function ErrorCallback)

レコーダーのリソースを解放します。

パラメータ

SuccessCallback : Function レコーダーのリソースを解放出来た場合にCallbackされます。
ErrorCallback : Function レコーダーのリソースを解放出来なかった場合にCallbackされます。

Return

void

サンプルコード

var recorder;

//レコーダーのリソースを解放用メソッド呼び出し
recorder.release(success, failure);

//レコーダーのリソースを解放成功時のコールバック
function success() {
    console.log("release() successful.");
    recorder = null;
}
//レコーダーのリソースを解放失敗時のコールバック
function failure(error) {
    console.log("release() failure.", error);
    recorder = null;
}

recorder.record

メソッド説明

recorder.record(Any options, Function SuccessCallback, Function ErrorCallback)

録音を開始します。実装にはFileSystemAPIとの連携が必要です。

パラメータ

options : Any オプションを設定します。
※将来使用するために用意されていますが、現在は使用されていません。
 空のオブジェクトまたは null を指定してください。
SuccessCallback : Function 録音を開始出来た場合にCallbackされます。
ErrorCallback : Function 録音を開始出来なかった場合にCallbackされます。

Return

void

サンプルコード

var recorder;

//ファイルシステムを取得
applican.requestFileSystem(LocalFileSystem.PERSISTENT, 0, requestRecordingFilesystemSuccess, requestRecordingFilesystemError);

//ファイルシステムを取得成功時のコールバック
function requestRecordingFilesystemSuccess() {

    //録音を開始用メソッド呼び出し
    recorder.record({}, success, failure);

}
//ファイルシステムを取得失敗時のコールバック
function requestRecordingFilesystemError() {
    console.log("録音の開始に失敗しました (ファイルシステム取得エラー)");
}

//録音を開始成功時のコールバック
function success() {
    console.log("record() successful.");
}
//録音を開始失敗時のコールバック
function failure(error) {
    console.log("record() failure.", error);
}

recorder.stop

メソッド説明

recorder.stop(Function SuccessCallback, Function ErrorCallback)

録音を停止します。

パラメータ

SuccessCallback : Function 録音を停止出来た場合にCallbackされます。
ErrorCallback : Function 録音を停止出来なかった場合にCallbackされます。

Return

void

サンプルコード

var recorder;

//録音を停止用メソッド呼び出し
recorder.stop(success, failure);

//録音を停止成功時のコールバック
function success() {
    console.log("stop() successful.");
}
//録音を停止失敗時のコールバック
function failure(error) {
    console.log("stop() failure.", error);
}