mirror of
https://github.com/apache/cordova-plugin-camera.git
synced 2025-01-31 20:52:53 +08:00
374 lines
16 KiB
Markdown
374 lines
16 KiB
Markdown
<!---
|
||
Licensed to the Apache Software Foundation (ASF) under one
|
||
or more contributor license agreements. See the NOTICE file
|
||
distributed with this work for additional information
|
||
regarding copyright ownership. The ASF licenses this file
|
||
to you under the Apache License, Version 2.0 (the
|
||
"License"); you may not use this file except in compliance
|
||
with the License. You may obtain a copy of the License at
|
||
|
||
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
Unless required by applicable law or agreed to in writing,
|
||
software distributed under the License is distributed on an
|
||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||
KIND, either express or implied. See the License for the
|
||
specific language governing permissions and limitations
|
||
under the License.
|
||
-->
|
||
|
||
# org.apache.cordova.camera
|
||
|
||
このプラグインは写真を撮るため、システムのイメージ ライブラリからイメージを選択するために API を提供します。
|
||
|
||
cordova plugin add org.apache.cordova.camera
|
||
|
||
|
||
## navigator.camera.getPicture
|
||
|
||
カメラを使用して写真を取るか、デバイスの画像ギャラリーから写真を取得します。 イメージは base64 エンコードとして成功時のコールバックに渡される `String` 、またはイメージ ファイルの URI。 メソッド自体を返します、 `CameraPopoverHandle` オブジェクト ファイル選択ポップ オーバーの位置を変更するために使用することができます。
|
||
|
||
navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
|
||
|
||
|
||
### 説明
|
||
|
||
`camera.getPicture`関数はデバイスのデフォルトのカメラ アプリケーションの写真をスナップするユーザーことができますを開きます。 既定では、この現象が発生したときに `Camera.sourceType` に等しい `Camera.PictureSourceType.CAMERA` 。 ユーザーは写真をスナップ、カメラ アプリケーションを閉じるし、アプリケーションが復元されます。
|
||
|
||
場合 `Camera.sourceType` は、 `Camera.PictureSourceType.PHOTOLIBRARY` または `Camera.PictureSourceType.SAVEDPHOTOALBUM` 、その後、ダイアログが表示されますユーザーを既存のイメージを選択することができます。 `camera.getPicture`関数を返す、 `CameraPopoverHandle` オブジェクトは、たとえば、イメージの選択ダイアログには、デバイスの向きが変更されたときの位置を変更するために使用することができます。
|
||
|
||
戻り値に送信されます、 `cameraSuccess` の指定によって、次の形式のいずれかのコールバック関数 `cameraOptions` :
|
||
|
||
* A `String` 写真の base64 でエンコードされたイメージを含んでいます。
|
||
|
||
* A `String` (既定値) のローカル記憶域上のイメージ ファイルの場所を表します。
|
||
|
||
自由に変更、エンコードされたイメージ、または URI などを行うことができます。
|
||
|
||
* イメージをレンダリングする `<img>` 以下の例のように、タグ
|
||
|
||
* ローカル データの保存 ( `LocalStorage` 、 [Lawnchair][1]など)。
|
||
|
||
* リモート サーバーにデータを投稿します。
|
||
|
||
[1]: http://brianleroux.github.com/lawnchair/
|
||
|
||
**注**: 新しいデバイス上の写真の解像度はかなり良いです。 デバイスのギャラリーから選択した写真が下方の品質に縮小しない場合でも、 `quality` パラメーターを指定します。 一般的なメモリの問題を回避する設定 `Camera.destinationType` を `FILE_URI` よりもむしろ`DATA_URL`.
|
||
|
||
### サポートされているプラットフォーム
|
||
|
||
* アマゾン火 OS
|
||
* アンドロイド
|
||
* ブラックベリー 10
|
||
* Firefox の OS
|
||
* iOS
|
||
* Tizen
|
||
* Windows Phone 7 と 8
|
||
* Windows 8
|
||
|
||
### アマゾン火 OS 癖
|
||
|
||
アマゾン火 OS イメージをキャプチャするデバイス上のカメラの活動を開始する意図を使用して、メモリの少ない携帯電話、コルドバ活動が殺されるかもしれない。 このシナリオでは、コルドバの活動が復元されるとき、画像が表示されません。
|
||
|
||
### Android の癖
|
||
|
||
アンドロイド、イメージをキャプチャするデバイス上でカメラのアクティビティを開始する意図を使用し、メモリの少ない携帯電話、コルドバ活動が殺されるかもしれない。 このシナリオではコルドバ活動が復元されると、イメージが表示されません。
|
||
|
||
### Firefox OS 癖
|
||
|
||
カメラのプラグインは現在、 [Web アクティビティ][2]を使用して実装されていた.
|
||
|
||
[2]: https://hacks.mozilla.org/2013/01/introducing-web-activities/
|
||
|
||
### iOS の癖
|
||
|
||
JavaScript を含む `alert()` 関数コールバックのいずれかの問題を引き起こすことができます。 内でアラートのラップ、 `setTimeout()` iOS イメージ ピッカーまたは完全が終了するまで、警告が表示されますポップ オーバーを許可します。
|
||
|
||
setTimeout(function() {//ここにあなたのことを行います ！}, 0);
|
||
|
||
|
||
### Windows Phone 7 の癖
|
||
|
||
ネイティブ カメラ アプリケーションを呼び出すと、デバイスが Zune を介して接続されている動作しませんし、エラー コールバックをトリガーします。
|
||
|
||
### Tizen の癖
|
||
|
||
Tizen のみをサポートしている、 `destinationType` の `Camera.DestinationType.FILE_URI` と `sourceType` の`Camera.PictureSourceType.PHOTOLIBRARY`.
|
||
|
||
### 例
|
||
|
||
写真を撮るし、base64 エンコード イメージとして取得します。
|
||
|
||
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
|
||
destinationType: Camera.DestinationType.DATA_URL
|
||
});
|
||
|
||
function onSuccess(imageData) {
|
||
var image = document.getElementById('myImage');
|
||
image.src = "data:image/jpeg;base64," + imageData;
|
||
}
|
||
|
||
function onFail(message) {
|
||
alert('Failed because: ' + message);
|
||
}
|
||
|
||
|
||
写真を撮るし、イメージのファイルの場所を取得します。
|
||
|
||
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
|
||
destinationType: Camera.DestinationType.FILE_URI });
|
||
|
||
function onSuccess(imageURI) {
|
||
var image = document.getElementById('myImage');
|
||
image.src = imageURI;
|
||
}
|
||
|
||
function onFail(message) {
|
||
alert('Failed because: ' + message);
|
||
}
|
||
|
||
|
||
## CameraOptions
|
||
|
||
カメラの設定をカスタマイズするオプションのパラメーター。
|
||
|
||
{品質： 75、destinationType: Camera.DestinationType.DATA_URL、sourceType: Camera.PictureSourceType.CAMERA、allowEdit: true の場合、encodingType: Camera.EncodingType.JPEG、targetWidth: 100、targetHeight: 100、popoverOptions： CameraPopoverOptions、saveToPhotoAlbum: false};
|
||
|
||
|
||
### オプション
|
||
|
||
* **品質**： 0-100、100 がファイルの圧縮から損失なしで通常のフル解像度の範囲で表される、保存されたイメージの品質。 *(数)*（カメラの解像度についての情報が利用できないことに注意してください)。
|
||
|
||
* **destinationType**: 戻り値の形式を選択します。定義されている `navigator.camera.DestinationType` *（番号）*
|
||
|
||
Camera.DestinationType = {DATA_URL: 0、/base64 エンコード文字列 FILE_URI としてイメージを返す/: 1、//画像ファイル URI NATIVE_URI を返す： 2//戻り画像ネイティブ URI (例えば、資産ライブラリ://iOS またはコンテンツに：//アンドロイド)};
|
||
|
||
|
||
* **sourceType**: 画像のソースを設定します。定義されている `navigator.camera.PictureSourceType` *（番号）*
|
||
|
||
Camera.PictureSourceType = {フォト ライブラリ: 0, カメラ: 1、SAVEDPHOTOALBUM: 2};
|
||
|
||
|
||
* **allowEdit**: 単純な選択の前に画像の編集を許可します。*(ブール値)*
|
||
|
||
* **encodingType**: 返されるイメージ ファイルのエンコーディングを選択します。定義されている `navigator.camera.EncodingType` *（番号）*
|
||
|
||
Camera.EncodingType = {JPEG: 0//戻る JPEG PNG イメージをエンコード: 1/返す PNG イメージをエンコードされた/};
|
||
|
||
|
||
* **targetWidth**: スケール イメージにピクセル単位の幅。**TargetHeight**を使用する必要があります。縦横比は変わりません。*(数)*
|
||
|
||
* **targetHeight**: スケール イメージにピクセル単位の高さ。**TargetWidth**を使用する必要があります。縦横比は変わりません。*(数)*
|
||
|
||
* **mediaType**： から選択するメディアの種類を設定します。 場合にのみ働きます `PictureSourceType` は `PHOTOLIBRARY` または `SAVEDPHOTOALBUM` 。 定義されている `nagivator.camera.MediaType` *（番号）*
|
||
|
||
Camera.MediaType = {画像： 0//静止画のみを選択できます。 既定値です。 Will return format specified via DestinationType
|
||
VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
|
||
ALLMEDIA : 2 // allow selection from all media types
|
||
};
|
||
|
||
|
||
* **correctOrientation**: キャプチャ中に、デバイスの向きを修正する画像を回転させます。*(ブール値)*
|
||
|
||
* **saveToPhotoAlbum**: キャプチャ後、デバイス上のフォト アルバムに画像を保存します。*(ブール値)*
|
||
|
||
* **popoverOptions**: iPad のポップ オーバーの場所を指定する iOS のみのオプションです。定義されています。`CameraPopoverOptions`.
|
||
|
||
* **cameraDirection**： （前面または背面側） を使用するカメラを選択します。定義されている `navigator.camera.Direction` *（番号）*
|
||
|
||
Camera.Direction = {戻る: 0、//後ろ向きカメラ前部を使用: 1/フロントに面したカメラを使用して/};
|
||
|
||
|
||
### アマゾン火 OSQuirks
|
||
|
||
* 任意 `cameraDirection` 背面写真で結果の値します。
|
||
|
||
* 無視、 `allowEdit` パラメーター。
|
||
|
||
* `Camera.PictureSourceType.PHOTOLIBRARY``Camera.PictureSourceType.SAVEDPHOTOALBUM`両方のアルバムが表示されます同じ写真。
|
||
|
||
### Android の癖
|
||
|
||
* 任意 `cameraDirection` 背面写真で結果の値します。
|
||
|
||
* 無視、 `allowEdit` パラメーター。
|
||
|
||
* `Camera.PictureSourceType.PHOTOLIBRARY``Camera.PictureSourceType.SAVEDPHOTOALBUM`両方のアルバムが表示されます同じ写真。
|
||
|
||
### ブラックベリー 10 癖
|
||
|
||
* 無視、 `quality` パラメーター。
|
||
|
||
* 無視、 `sourceType` パラメーター。
|
||
|
||
* 無視、 `allowEdit` パラメーター。
|
||
|
||
* `Camera.MediaType`サポートされていません。
|
||
|
||
* 無視、 `correctOrientation` パラメーター。
|
||
|
||
* 無視、 `cameraDirection` パラメーター。
|
||
|
||
### Firefox OS 癖
|
||
|
||
* 無視、 `quality` パラメーター。
|
||
|
||
* `Camera.DestinationType`無視され、等しい `1` (イメージ ファイル URI)
|
||
|
||
* 無視、 `allowEdit` パラメーター。
|
||
|
||
* 無視、 `PictureSourceType` パラメーター (ユーザーが選択ダイアログ ウィンドウに)
|
||
|
||
* 無視します、`encodingType`
|
||
|
||
* 無視、 `targetWidth` と`targetHeight`
|
||
|
||
* `Camera.MediaType`サポートされていません。
|
||
|
||
* 無視、 `correctOrientation` パラメーター。
|
||
|
||
* 無視、 `cameraDirection` パラメーター。
|
||
|
||
### iOS の癖
|
||
|
||
* 設定 `quality` 一部のデバイスでメモリ不足エラーを避けるために 50 の下。
|
||
|
||
* 使用する場合 `destinationType.FILE_URI` 、写真、アプリケーションの一時ディレクトリに保存されます。 使用して、このディレクトリの内容を削除可能性があります、 `navigator.fileMgr` Api のストレージ スペースが必要な場合。
|
||
|
||
### Tizen の癖
|
||
|
||
* サポートされていないオプション
|
||
|
||
* 常にファイルの URI を返す
|
||
|
||
### Windows Phone 7 と 8 癖
|
||
|
||
* 無視、 `allowEdit` パラメーター。
|
||
|
||
* 無視、 `correctOrientation` パラメーター。
|
||
|
||
* 無視、 `cameraDirection` パラメーター。
|
||
|
||
* 無視、 `mediaType` のプロパティ `cameraOptions` として Windows Phone SDK には、フォト ライブラリからビデオを選択する方法は行いません。
|
||
|
||
## CameraError
|
||
|
||
エラー メッセージを提供する onError コールバック関数。
|
||
|
||
function(message) {
|
||
// Show a helpful message
|
||
}
|
||
|
||
|
||
### パラメーター
|
||
|
||
* **メッセージ**: メッセージは、デバイスのネイティブ コードによって提供されます。*(文字列)*
|
||
|
||
## cameraSuccess
|
||
|
||
画像データを提供する onSuccess コールバック関数。
|
||
|
||
function(imageData) {
|
||
// Do something with the image
|
||
}
|
||
|
||
|
||
### パラメーター
|
||
|
||
* **imagedata を扱う**: Base64 エンコード イメージのデータ、*または*画像ファイルによって URI の `cameraOptions` 効果。*(文字列)*
|
||
|
||
### 例
|
||
|
||
// Show image
|
||
//
|
||
function cameraCallback(imageData) {
|
||
var image = document.getElementById('myImage');
|
||
image.src = "data:image/jpeg;base64," + imageData;
|
||
}
|
||
|
||
|
||
## CameraPopoverHandle
|
||
|
||
によって作成されたポップオーバーパン ダイアログへのハンドル`navigator.camera.getPicture`.
|
||
|
||
### メソッド
|
||
|
||
* **setPosition**: ポップ オーバーの位置を設定します。
|
||
|
||
### サポートされているプラットフォーム
|
||
|
||
* iOS
|
||
|
||
### setPosition
|
||
|
||
ポップ オーバーの位置を設定します。
|
||
|
||
**パラメーター**:
|
||
|
||
* `cameraPopoverOptions`:、 `CameraPopoverOptions` の新しい位置を指定します。
|
||
|
||
### 例
|
||
|
||
var cameraPopoverHandle = navigator.camera.getPicture(onSuccess, onFail,
|
||
{ destinationType: Camera.DestinationType.FILE_URI,
|
||
sourceType: Camera.PictureSourceType.PHOTOLIBRARY,
|
||
popoverOptions: new CameraPopoverOptions(300, 300, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY)
|
||
});
|
||
|
||
// Reposition the popover if the orientation changes.
|
||
window.onorientationchange = function() {
|
||
var cameraPopoverOptions = new CameraPopoverOptions(0, 0, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
|
||
cameraPopoverHandle.setPosition(cameraPopoverOptions);
|
||
}
|
||
|
||
|
||
## CameraPopoverOptions
|
||
|
||
iOS だけ指定パラメーターをポップ オーバーのアンカー要素の場所および矢印方向計算されたライブラリまたはアルバムから画像を選択するとき。
|
||
|
||
{x: 0, y: 32、幅： 320、高さ： 480、arrowDir: Camera.PopoverArrowDirection.ARROW_ANY};
|
||
|
||
|
||
### CameraPopoverOptions
|
||
|
||
* **x**: ピクセルの x 座標画面要素にポップ オーバーのアンカーになります。*(数)*
|
||
|
||
* **y**: y ピクセル座標の画面要素にポップ オーバーのアンカーになります。*(数)*
|
||
|
||
* **幅**: ポップ オーバーのアンカーになる上の画面要素のピクセル単位の幅。*(数)*
|
||
|
||
* **高さ**: ポップ オーバーのアンカーになる上の画面要素のピクセル単位の高さ。*(数)*
|
||
|
||
* **arrowDir**: 方向のポップ オーバーで矢印をポイントする必要があります。定義されている `Camera.PopoverArrowDirection` *（番号）*
|
||
|
||
Camera.PopoverArrowDirection = {ARROW_UP: 1、/iOS UIPopoverArrowDirection 定数 ARROW_DOWN と一致する/: 2、ARROW_LEFT： 4、ARROW_RIGHT： 8、ARROW_ANY: 15};
|
||
|
||
|
||
矢印の方向と、画面の向きを調整するポップ オーバーのサイズを変更可能性がありますに注意してください。 アンカー要素の位置を指定するときの方向の変化を考慮することを確認します。
|
||
|
||
## navigator.camera.cleanup
|
||
|
||
削除中間一時ストレージからカメラで撮影した写真。
|
||
|
||
navigator.camera.cleanup( cameraSuccess, cameraError );
|
||
|
||
|
||
### 説明
|
||
|
||
削除を呼び出した後に一時記憶域に保存されている画像ファイルを中間 `camera.getPicture` 。 場合にのみ適用されるの値 `Camera.sourceType` に等しい `Camera.PictureSourceType.CAMERA` と、 `Camera.destinationType` に等しい`Camera.DestinationType.FILE_URI`.
|
||
|
||
### サポートされているプラットフォーム
|
||
|
||
* iOS
|
||
|
||
### 例
|
||
|
||
navigator.camera.cleanup(onSuccess, onFail);
|
||
|
||
function onSuccess() {
|
||
console.log("Camera cleanup success.")
|
||
}
|
||
|
||
function onFail(message) {
|
||
alert('Failed because: ' + message);
|
||
} |