キャプチャ

デバイスのオーディオ、イメージ、およびビデオキャプチャ機能へのアクセスを提供します。

重要なプライバシーの注意：画像、ビデオ、またはデバイスのカメラやマイクからの音声の収集と利用を重要なプライバシーの問題を発生させます。アプリのプライバシーポリシーは、アプリがそのようなセンサーを使用する方法と、記録されたデータは他の当事者と共有かどうかを議論すべきです。さらに、カメラまたはマイクのアプリの使用がない場合明らかに、ユーザーインターフェイスで、アプリ (デバイスオペレーティングシステムしない場合そう既に) カメラまたはマイクにアクセスする前に、ジャストインタイム通知を提供する必要があります。その通知は、上記の (例えば、 [ok]をおかげで選択肢を提示する) によってユーザーのアクセス許可を取得するだけでなく、同じ情報を提供する必要があります。いくつかのアプリのマーケットプレース - 時間の通知を提供して、カメラまたはマイクにアクセスする前にユーザーからアクセス許可を取得するアプリをする必要がありますに注意してください。詳細については、プライバシーに関するガイドを参照してください。

オブジェクト

メソッド

スコープ

The capture object is assigned to the navigator.device object, and therefore has global scope.

// The global capture object
var capture = navigator.device.capture;

プロパティ

supportedAudioModes: デバイスでサポートされている形式の録音。（ConfigurationData[])
supportedImageModes: 記録画像サイズとデバイスでサポートされている形式です。（ConfigurationData[])
supportedVideoModes: 記録のビデオ解像度とデバイスでサポートされている形式です。（ConfigurationData[])

メソッド

capture.captureAudio: オーディオクリップを記録するデバイスのオーディオ録音アプリケーションを起動します。
capture.captureImage: 写真を撮るため、デバイスのカメラアプリケーションを起動します。
capture.captureVideo: ビデオを記録するためのデバイスのビデオレコーダーアプリケーションを起動します。

サポートされているプラットフォーム

アンドロイド
ブラックベリー WebWorks (OS 5.0 およびより高い)
iOS
Windows Phone 7 と 8
Windows 8

機能へのアクセス

バージョン 3.0 は、コルドバのプラグインとしてデバイスレベルの Api を実装します。 CLI の使用 plugin のコマンドライン・インタフェースを追加または削除、プロジェクトに対してこの機能を記載されているコマンド。

    $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
    $ cordova plugin rm org.apache.cordova.core.media-capture

これらのコマンドすべてのターゲットプラットフォームに適用されますが、以下のプラットフォームに固有の構成設定を変更します。

アンドロイド

(in app/res/xml/plugins.xml) < 機能名 =「キャプチャ」>< param の名前 =「android パッケージ」value="org.apache.cordova.Capture"/></機能 > (app/AndroidManifest.xml) で < 使用許可 android:name="android.permission.RECORD_AUDIO"/>< 使用許可 android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

ブラックベリー WebWorks

(in www/plugins.xml) < 機能名 =「キャプチャ」>< param の名前「ブラックベリー パッケージ」value="org.apache.cordova.capture.MediaCapture ="/></機能 > (www/config.xml) で < id="blackberry.system 機能"必要 ="true"のバージョン =「1.0.0.0」/>< id="blackberry.io.file の機能"必要 ="true"バージョン =「1.0.0.0」/>

iOS （config.xml)

< 機能名 =「キャプチャ」>< param の名前 = 値「ios パッケージ」="CDVCapture"/></機能 >

(Windows PhoneProperties/WPAppManifest.xml)

<Capabilities>
    <Capability Name="ID_CAP_MEDIALIB" />
    <Capability Name="ID_CAP_MICROPHONE" />
    <Capability Name="ID_HW_FRONTCAMERA" />
    <Capability Name="ID_CAP_ISV_CAMERA" />
    <Capability Name="ID_CAP_CAMERA" />
</Capabilities>

いくつかのプラットフォームは特別な構成を必要とせずにこの機能をサポート可能性があります。概要については、プラットフォームのサポートを参照してください。

capture.captureAudio

オーディオレコーダーアプリケーションを起動し、キャプチャしたオーディオクリップファイルに関する情報を返します。

navigator.device.capture.captureAudio(
    CaptureCB captureSuccess, CaptureErrorCB captureError,  [CaptureAudioOptions options]
);

説明

オーディオ録音デバイスの既定のオーディオ録音アプリケーションを使用してキャプチャする非同期操作を開始します。操作を単一のセッションで複数の録音をキャプチャするデバイスのユーザーことができます。

キャプチャ操作が終了、ユーザーアプリケーション、または録音で指定された最大数の録音が終了すると CaptureAudioOptions.limit に達した。いいえの場合 limit パラメーターの値が指定されて、既定の 1 つ (1)、キャプチャ操作終了後、ユーザーが単一のオーディオクリップを録音します。

キャプチャ操作が完了すると、 CaptureCallback の配列を実行 MediaFile オーディオクリップファイルをキャプチャしてそれぞれを記述するオブジェクトします。オーディオクリップをキャプチャする前に、ユーザーが操作を終了した場合、 CaptureErrorCallback で実行する、 CaptureError オブジェクト、特色、 CaptureError.CAPTURE_NO_MEDIA_FILES のエラーコード。

サポートされているプラットフォーム

アンドロイド
ブラックベリー WebWorks (OS 5.0 およびより高い)
iOS
Windows Phone 7 と 8
Windows 8

簡単な例

// capture callback
var captureSuccess = function(mediaFiles) {
    var i, path, len;
    for (i = 0, len = mediaFiles.length; i < len; i += 1) {
        path = mediaFiles[i].fullPath;
        // do something interesting with the file
    }
};

// capture error callback
var captureError = function(error) {
    navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};

// start audio capture
navigator.device.capture.captureAudio(captureSuccess, captureError, {limit:2});

完全な例

<!DOCTYPE html>
<html>
  <head>
    <title>Capture Audio</title>

    <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
    <script type="text/javascript" charset="utf-8" src="json2.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Called when capture operation is finished
    //
    function captureSuccess(mediaFiles) {
        var i, len;
        for (i = 0, len = mediaFiles.length; i < len; i += 1) {
            uploadFile(mediaFiles[i]);
        }
    }

    // Called if something bad happens.
    //
    function captureError(error) {
        var msg = 'An error occurred during capture: ' + error.code;
        navigator.notification.alert(msg, null, 'Uh oh!');
    }

    // A button will call this function
    //
    function captureAudio() {
        // Launch device audio recording application,
        // allowing user to capture up to 2 audio clips
        navigator.device.capture.captureAudio(captureSuccess, captureError, {limit: 2});
    }

    // Upload files to server
    function uploadFile(mediaFile) {
        var ft = new FileTransfer(),
            path = mediaFile.fullPath,
            name = mediaFile.name;

        ft.upload(path,
            "http://my.domain.com/upload.php",
            function(result) {
                console.log('Upload success: ' + result.responseCode);
                console.log(result.bytesSent + ' bytes sent');
            },
            function(error) {
                console.log('Error uploading file ' + path + ': ' + error.code);
            },
            { fileName: name });
    }

    </script>
    </head>
    <body>
        <button onclick="captureAudio();">Capture Audio</button> <br>
    </body>
</html>

ブラックベリー WebWorks 癖

BlackBerry の WebWorks のコルドバ声ノートレコーダーアプリケーションを起動し、リム、によって提供されるオーディオ録音をキャプチャしようとします。アプリは受け取ります、 CaptureError.CAPTURE_NOT_SUPPORTED 、アプリケーションがデバイスにインストールされていない場合はエラーコード。

iOS の癖

iOS に既定のオーディオ録音アプリケーションがない単純なユーザーインターフェイスが提供されます。

Windows Phone 7 と 8 癖

Windows Phone 7 シンプルなユーザーインターフェイスが提供されるので、既定のオーディオ録音アプリケーションはありません。

CaptureAudioOptions

オーディオキャプチャの構成オプションをカプセル化します。

プロパティ

制限: デバイスユーザーは、単一のキャプチャ操作で記録することができますオーディオクリップの最大数。値 1 (デフォルトは 1) 以上にする必要があります。
期間: オーディオのサウンドクリップの最大継続時間を秒単位で。

簡単な例

// limit capture operation to 3 media files, no longer than 10 seconds each
var options = { limit: 3, duration: 10 };

navigator.device.capture.captureAudio(captureSuccess, captureError, options);

Android の癖

durationパラメーターはサポートされていません。長さの記録プログラムで限定することはできません。

ブラックベリー WebWorks 癖

durationパラメーターはサポートされていません。長さの記録プログラムで限定することはできません。

iOS の癖

limitパラメーターはサポートされていません、各呼び出しに対して、1 つだけ記録を作成できます。

capture.captureImage

カメラアプリケーションを起動し、キャプチャしたイメージファイルに関する情報を返します。

navigator.device.capture.captureImage(
    CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
);

説明

デバイスのカメラアプリケーションを使用して画像をキャプチャする非同期操作を開始します。操作では、単一のセッションで 1 つ以上のイメージをキャプチャすることができます。

キャプチャ操作終了いずれかのユーザーが閉じると、カメラアプリケーションまたは録音で指定された最大数 CaptureAudioOptions.limit に達した。場合ない limit 値が指定されて、既定の 1 つ (1)、キャプチャ操作終了後、ユーザーは単一のイメージをキャプチャします。

キャプチャ操作が完了したら、それを呼び出す、 CaptureCB の配列がコールバック MediaFile 各キャプチャされたイメージファイルを記述するオブジェクト。ユーザーは、イメージをキャプチャする前に操作が終了した場合、 CaptureErrorCB コールバックで実行する、 CaptureError オブジェクトの特色、 CaptureError.CAPTURE_NO_MEDIA_FILES エラーコード。

サポートされているプラットフォーム

アンドロイド
ブラックベリー WebWorks (OS 5.0 およびより高い)
iOS
Windows Phone 7 と 8
Windows 8

Windows Phone 7 の癖

Zune を介してお使いのデバイスが接続されているネイティブカメラアプリケーションを呼び出すと、動作しませんし、エラーコールバックを実行します。

簡単な例

// capture callback
var captureSuccess = function(mediaFiles) {
    var i, path, len;
    for (i = 0, len = mediaFiles.length; i < len; i += 1) {
        path = mediaFiles[i].fullPath;
        // do something interesting with the file
    }
};

// capture error callback
var captureError = function(error) {
    navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};

// start image capture
navigator.device.capture.captureImage(captureSuccess, captureError, {limit:2});

完全な例

<!DOCTYPE html>
<html>
  <head>
    <title>Capture Image</title>

    <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
    <script type="text/javascript" charset="utf-8" src="json2.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Called when capture operation is finished
    //
    function captureSuccess(mediaFiles) {
        var i, len;
        for (i = 0, len = mediaFiles.length; i < len; i += 1) {
            uploadFile(mediaFiles[i]);
        }
    }

    // Called if something bad happens.
    //
    function captureError(error) {
        var msg = 'An error occurred during capture: ' + error.code;
        navigator.notification.alert(msg, null, 'Uh oh!');
    }

    // A button will call this function
    //
    function captureImage() {
        // Launch device camera application,
        // allowing user to capture up to 2 images
        navigator.device.capture.captureImage(captureSuccess, captureError, {limit: 2});
    }

    // Upload files to server
    function uploadFile(mediaFile) {
        var ft = new FileTransfer(),
            path = mediaFile.fullPath,
            name = mediaFile.name;

        ft.upload(path,
            "http://my.domain.com/upload.php",
            function(result) {
                console.log('Upload success: ' + result.responseCode);
                console.log(result.bytesSent + ' bytes sent');
            },
            function(error) {
                console.log('Error uploading file ' + path + ': ' + error.code);
            },
            { fileName: name });
    }

    </script>
    </head>
    <body>
        <button onclick="captureImage();">Capture Image</button> <br>
    </body>
</html>

CaptureImageOptions

イメージキャプチャの構成オプションをカプセル化します。

プロパティ

制限: ユーザーは、単一のキャプチャ操作でキャプチャすることができますイメージの最大数。値 1 (デフォルトは 1) 以上にする必要があります。

簡単な例

// limit capture operation to 3 images
var options = { limit: 3 };

navigator.device.capture.captureImage(captureSuccess, captureError, options);

iOS の癖

Limitパラメーターはサポートされていませんとだけ 1 枚の画像の呼び出しごと。

capture.captureVideo

ビデオレコーダーアプリケーションを起動し、キャプチャしたビデオクリップファイルに関する情報を返します。

navigator.device.capture.captureVideo(
    CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
);

説明

デバイスのビデオ録画アプリケーションを使用してビデオ記録をキャプチャする非同期操作を開始します。操作は、単一のセッションで 1 つ以上の録音をキャプチャすることができます。

キャプチャ操作終了いずれかユーザーがビデオ録画アプリケーションまたは録音で指定された最大数を終了時 CaptureVideoOptions.limit に達した。いいえの場合 limit パラメーター値が指定されて、既定の 1 つ（1）、ユーザーは 1 つのビデオクリップを記録した後にキャプチャ操作が終了しました。

キャプチャ操作が完了したら、それは CaptureCB の配列でコールバックを実行します MediaFile ビデオクリップファイルをキャプチャしてそれぞれを記述するオブジェクトします。ユーザーがビデオクリップをキャプチャする前に操作を終了した場合、 CaptureErrorCB コールバックで実行する、 CaptureError オブジェクトの特色を CaptureError.CAPTURE_NO_MEDIA_FILES エラーコード。

サポートされているプラットフォーム

アンドロイド
ブラックベリー WebWorks (OS 5.0 およびより高い)
iOS
Windows Phone 7 と 8
Windows 8

簡単な例

// capture callback
var captureSuccess = function(mediaFiles) {
    var i, path, len;
    for (i = 0, len = mediaFiles.length; i < len; i += 1) {
        path = mediaFiles[i].fullPath;
        // do something interesting with the file
    }
};

// capture error callback
var captureError = function(error) {
    navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};

// start video capture
navigator.device.capture.captureVideo(captureSuccess, captureError, {limit:2});

完全な例

<!DOCTYPE html>
<html>
  <head>
    <title>Capture Video</title>

    <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
    <script type="text/javascript" charset="utf-8" src="json2.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Called when capture operation is finished
    //
    function captureSuccess(mediaFiles) {
        var i, len;
        for (i = 0, len = mediaFiles.length; i < len; i += 1) {
            uploadFile(mediaFiles[i]);
        }
    }

    // Called if something bad happens.
    //
    function captureError(error) {
        var msg = 'An error occurred during capture: ' + error.code;
        navigator.notification.alert(msg, null, 'Uh oh!');
    }

    // A button will call this function
    //
    function captureVideo() {
        // Launch device video recording application,
        // allowing user to capture up to 2 video clips
        navigator.device.capture.captureVideo(captureSuccess, captureError, {limit: 2});
    }

    // Upload files to server
    function uploadFile(mediaFile) {
        var ft = new FileTransfer(),
            path = mediaFile.fullPath,
            name = mediaFile.name;

        ft.upload(path,
            "http://my.domain.com/upload.php",
            function(result) {
                console.log('Upload success: ' + result.responseCode);
                console.log(result.bytesSent + ' bytes sent');
            },
            function(error) {
                console.log('Error uploading file ' + path + ': ' + error.code);
            },
            { fileName: name });
    }

    </script>
    </head>
    <body>
        <button onclick="captureVideo();">Capture Video</button> <br>
    </body>
</html>

ブラックベリー WebWorks 癖

BlackBerry の WebWorks のコルドバビデオレコーダーアプリケーションを起動し、リム、によって提供されるビデオ録画をキャプチャしようとします。アプリは受け取ります、 CaptureError.CAPTURE_NOT_SUPPORTED 、アプリケーションがデバイスにインストールされていない場合はエラーコード。

CaptureVideoOptions

ビデオキャプチャの構成オプションをカプセル化します。

プロパティ

制限: デバイスのユーザーを単一のキャプチャ操作でキャプチャすることができますビデオクリップの最大数。値 1 (デフォルトは 1) 以上にする必要があります。
期間: ビデオクリップの最大継続時間を秒単位で。

簡単な例

// limit capture operation to 3 video clips
var options = { limit: 3 };

navigator.device.capture.captureVideo(captureSuccess, captureError, options);

ブラックベリー WebWorks 癖

期間パラメーターはサポートされていませんので、録音の長さは限られたプログラムを使用することはできません。

iOS の癖

Limitパラメーターはサポートされていません。のみ 1 つのビデオは、呼び出しごとに記録されます。

CaptureError

失敗したメディアキャプチャ操作からの結果のエラーコードをカプセル化します。

プロパティ

コード: 事前定義されたエラーコードのいずれか次のとおりです。

定数

CaptureError.CAPTURE_INTERNAL_ERR: カメラまたはマイクの画像やサウンドをキャプチャに失敗しました。
CaptureError.CAPTURE_APPLICATION_BUSY：現在カメラやオーディオのキャプチャのアプリケーション別のキャプチャ要求を提供します。
CaptureError.CAPTURE_INVALID_ARGUMENT：無効な API の使用 (例えば、の値 limit が 1 未満です)。
CaptureError.CAPTURE_NO_MEDIA_FILES: ユーザーが何かをキャプチャする前にカメラやオーディオのキャプチャアプリケーションを終了します。
CaptureError.CAPTURE_NOT_SUPPORTED：要求されたキャプチャ操作はサポートされていません。

CaptureCB

成功したメディアキャプチャ操作時に呼び出されます。

function captureSuccess( MediaFile[] mediaFiles ) { ... };

説明

この関数は成功したキャプチャ操作の完了後に実行します。いずれかのメディアファイルをキャプチャすると、この時点で、ユーザーがメディア・キャプチャ・アプリケーションを終了またはキャプチャ制限に達しています。

各 MediaFile オブジェクトにはキャプチャしたメディアファイルについて説明します。

簡単な例

// capture callback
function captureSuccess(mediaFiles) {
    var i, path, len;
    for (i = 0, len = mediaFiles.length; i < len; i += 1) {
        path = mediaFiles[i].fullPath;
        // do something interesting with the file
    }
};

CaptureErrorCB

メディアキャプチャ操作中にエラーが発生した場合に呼び出されます。

function captureError( CaptureError error ) { ... };

説明

この関数でエラーが発生を起動しようとすると、メディアのキャプチャ操作を実行します。障害シナリオを含めますキャプチャアプリケーションがビジー状態、キャプチャ操作は既に起こって、または、操作をキャンセルする前にメディアファイルが自動的にキャプチャされます。

この関数で実行する、 CaptureError 、適切なエラーを格納しているオブジェクトcode.

簡単な例

// capture error callback
var captureError = function(error) {
    navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
};

ConfigurationData

デバイスがサポートするメディアキャプチャパラメーターのセットをカプセル化します。

説明

デバイスでサポートされているメディアのキャプチャのモードについて説明します。構成データには、MIME の種類、およびビデオやイメージキャプチャのキャプチャ寸法が含まれます。

MIME の種類はRFC2046に従う必要があります。例:

3 gpp ビデオ/
ビデオ/quicktime
イメージ/jpeg
オーディオ/amr
オーディオ/wav ファイル

プロパティ

タイプ: 小文字の文字列を ASCII でエンコードされたメディアの種類を表します。（，）
高さ: イメージまたはビデオのピクセルでの高さ。値は、サウンドクリップの場合は 0 です。(数)
幅: イメージまたはピクセルのビデオの幅。値は、サウンドクリップの場合は 0 です。(数)

簡単な例

// retrieve supported image modes
var imageModes = navigator.device.capture.supportedImageModes;

// Select mode that has the highest horizontal resolution
var width = 0;
var selectedmode;
for each (var mode in imageModes) {
    if (mode.width > width) {
        width = mode.width;
        selectedmode = mode;
    }
}

任意のプラットフォームでサポートされていません。すべての構成データの配列は空です。

メディアファイル

メディアキャプチャファイルのプロパティをカプセル化します。

プロパティ

名前: パス情報なしのファイルの名前。（，）
fullPath: 名を含むファイルの完全パス。（，）
タイプ: ファイルの mime の種類 (，)
ファイルサイズ: 日付と時刻、ファイルが最後に変更されました。（日）
サイズ: バイトで、ファイルのサイズ。(数)

メソッド

MediaFile.getFormatData: メディアファイルの形式情報を取得します。

MediaFile.getFormatData

取得についての書式情報メディアキャプチャファイル。

mediaFile.getFormatData (MediaFileDataSuccessCB successCallback, [MediaFileDataErrorCB 解り]);

説明

この関数は、非同期的にメディアファイルの形式情報を取得しようとします。かどうかは成功、呼び出します、 MediaFileDataSuccessCB コールバックを MediaFileData オブジェクト。この関数を呼び出します、試行が失敗した場合、 MediaFileDataErrorCB コールバック。

サポートされているプラットフォーム

アンドロイド
ブラックベリー WebWorks (OS 5.0 およびより高い)
iOS
Windows Phone 7 と 8
Windows 8

MediaFileData

メディアファイルの形式情報をカプセル化します。

プロパティ

コーデック：オーディオおよびビデオコンテンツの実際のフォーマット。（，）
ビットレート：コンテンツの平均ビットレート。値が画像の場合は 0 です。(数)
高さ: イメージまたはビデオのピクセルでの高さ。値は、オーディオクリップの場合は 0 です。(数)
幅: イメージまたはピクセルのビデオの幅。値は、オーディオクリップの場合は 0 です。(数)
期間: 秒のビデオまたはサウンドのクリップの長さ。値が画像の場合は 0 です。(数)

ブラックベリー WebWorks 癖

メディアファイルの形式情報を提供する API がしないので、 MediaFileData によって返されるオブジェクト MediaFile.getFormatData 機能次の既定値。

コーデック：いないサポートしを返しますnull.
ビットレート：いないサポートし、ゼロを返します。
高さ: いないサポートし、ゼロを返します。
幅: いないサポートし、ゼロを返します。
期間：いないサポートし、ゼロを返します。

Android の癖

以下がサポート MediaFileData プロパティ。

コーデック：いないサポートしを返しますnull.
ビットレート：いないサポートし、ゼロを返します。
高さ: サポート: イメージファイルやビデオファイルのみです。
幅: サポート: イメージファイルやビデオファイルのみです。
期間: サポート: オーディオおよびビデオファイルのみです。

iOS の癖

以下がサポート MediaFileData プロパティ。

コーデック：いないサポートしを返しますnull.
ビットレート： iOS4 オーディオのみのデバイスでサポートされています。画像や動画はゼロを返します。
高さ: サポート: イメージファイルやビデオファイルのみです。
幅: サポート: イメージファイルやビデオファイルのみです。
期間: サポート: オーディオおよびビデオファイルのみです。

キャプチャ

ガイド

API リファレンス