From e84d6e330bac6db938ba19b02963605ee0029b2f Mon Sep 17 00:00:00 2001 From: Christophe BOUCAUT Date: Tue, 20 Jan 2015 11:22:48 +0100 Subject: [PATCH 1/4] On passe le plugin dans la variable navigator, au lieu de window. Pour s'approcher du fonctionnement de cordova.camera. --- plugin.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin.xml b/plugin.xml index 2d57c06..4cfdd55 100644 --- a/plugin.xml +++ b/plugin.xml @@ -10,7 +10,7 @@ undefined custom,camera,geneanet - + From 0aefb02acf4651a8cbf76560c680544e75f37093 Mon Sep 17 00:00:00 2001 From: Christophe BOUCAUT Date: Tue, 20 Jan 2015 11:23:37 +0100 Subject: [PATCH 2/4] =?UTF-8?q?Ajout=20de=20la=20documentation=20fran?= =?UTF-8?q?=C3=A7aise.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 ++ doc/en/index.md | 2 + doc/fr/index.md | 119 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 125 insertions(+) create mode 100644 README.md create mode 100644 doc/en/index.md create mode 100644 doc/fr/index.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f7193c0 --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +# org.geneanet.customcamera + +Plugin documentation (french): [doc/fr/index.md](doc/fr/index.md) +Plugin documentation (english): [doc/en/index.md](doc/en/index.md) \ No newline at end of file diff --git a/doc/en/index.md b/doc/en/index.md new file mode 100644 index 0000000..69f0eb4 --- /dev/null +++ b/doc/en/index.md @@ -0,0 +1,2 @@ +# org.geneanet.customcamera + diff --git a/doc/fr/index.md b/doc/fr/index.md new file mode 100644 index 0000000..34fc0b9 --- /dev/null +++ b/doc/fr/index.md @@ -0,0 +1,119 @@ +# org.geneanet.customcamera + +Ce plugin défini une variable globale navigator.GeneanetCustomCamera contenant un objet. Celui-ci permet de démarrer une caméra customisée & customisable en partie. + +## Installation + + cordova plugin add https://github.com/ChristopheBoucaut/customCamera.git + cordova build `platform` + +## Plateformes supportées + ++ Android + +## Utilisation + +### Commande + +``` js +navigator.GeneanetCustomCamera.startCamera(options, onSuccess, onFail); +``` + +### Paramètres + +#### *{Object}* options + +L'objet `options` contient les options de configuration de l'appareil photo. + ++ **imgBackgroundBase64 :** Image qui sera présente par dessus le rendu de l'appareil photo. Doit être en base64. + - **Type :** `string` + - **Valeur par défaut :** `null` + ++ **miniature :** Permet d'activer ou non la fonction de miniature. `true` : Active l'option. `false` : Désactive l'option. + - **Type :** `boolean` + - **Valeur par défaut :** `true` + ++ **saveInGallery :** Permet de stocker la photo dans la gallery du téléphone. `true` : Active l'option. `false` : Désactive l'option. + - **Type :** `boolean` + - **Valeur par défaut :** `false` + ++ **cameraBackgroundColor :** Couleur pour le bouton de prise de photo. + - **Type :** `string` + - **Valeur par défaut :** `"#e26760"` + - **Notes :** + + Une mauvaise valeur ou une valeur `null` produit un effet de transparance. + + Pour connaitre les formats de couleurs, consulter la méthode [`parseColor()`](http://developer.android.com/reference/android/graphics/Color.html#parseColor(java.lang.String)). + ++ **cameraBackgroundColorPressed :** Couleur pour le bouton de prise de photo lorsqu'il est pressé. + - **Type :** `string` + - **Valeur par défaut :** `"#dc453d"` + - **Notes :** + + Une mauvaise valeur ou une valeur `null` produit un effet de transparance. + + Pour connaitre les formats de couleurs, consulter la méthode [`parseColor()`](http://developer.android.com/reference/android/graphics/Color.html#parseColor(java.lang.String)). + ++ **quality :** Qualité de la photo. + - **Type :** `integer` + - **Valeur par défaut :** `100` + - **Notes :** + + La valeur doit être comprise entre 0 et 100. Si la valeur n'est pas dans cet interval, la valeur par défaut est utilisée. + + Pour plus d'information, consulter la méthode [`compress()`](http://developer.android.com/reference/android/graphics/Bitmap.html). + +#### *{Function}* onSuccess + +La fonction `onSuccess` est appelée lorsque la prise de vue est réussie. + ++ **Paramètres :** + - **result :** + + **Type :** `string` + + **Note :** Contient l'image prise au format base64. + +#### *{Function}* onFail + +La fonction `onFail` est appelée lorsque la prise de vue est ratée. ++ **Paramètres :** + - **code :** + + **Type :** `integer` + + **Note :** Contient le code d'erreur. + - **Code "2" :** Erreur lors de l'exécution de l'appareil photo. + - **Code "3" :** L'utilisateur a fermé l'appareil photo sans prendre de photo. + - **message :** + + **Type :** `string` + + **Note :** Contient un message détaillant l'erreur. + +## Implémentation + +### Exemple + +``` js +var base64 = "..."; +navigator.GeneanetCustomCamera.startCamera( + { + imgBackgroundBase64: base64, + saveInGallery: true, + miniature: false, + quality: 70, + cameraBackgroundColor: "#ffffff", + cameraBackgroundColorPressed: null + }, + function(result) { + window.console.log("success"); + $("#imgTaken").attr("src", "data:image/jpeg;base64,"+result); + }, + function(code, message) { + window.console.log("fail"); + window.console.log(code); + window.console.log(message); + } +); +``` + +### AngularJS + +Une implémentation dans AngularJS a été réalisée pour faciliter son utilisation : [TODO](TODO) + +## Contribuer + +Pour contribuer à ce projet, merci de respecter les règles suivantes : ++ **Les bugs, suggestions, etc :** Ils doivent être remontés via le système d'issues de Github. Merci de vérifier que votre sujet n'a pas déjà été traité. ++ **Développement Javascript :** Le code javascript doit être valide avec JSHint. ++ **Développement Java :** Le code java doit être valide [Checkstyle](http://eclipse-cs.sourceforge.net/#!/) \ No newline at end of file From d9c852f90a3f0742631679370e60476d0b69a879 Mon Sep 17 00:00:00 2001 From: ChristopheBoucaut Date: Tue, 20 Jan 2015 11:25:06 +0100 Subject: [PATCH 3/4] Update README.md Rajout d'un saut de ligne. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f7193c0..cc9c08f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # org.geneanet.customcamera Plugin documentation (french): [doc/fr/index.md](doc/fr/index.md) -Plugin documentation (english): [doc/en/index.md](doc/en/index.md) \ No newline at end of file + +Plugin documentation (english): [doc/en/index.md](doc/en/index.md) From 80b79f277030cfe6666e6a01ba2755597c0e1282 Mon Sep 17 00:00:00 2001 From: Christophe BOUCAUT Date: Tue, 20 Jan 2015 11:28:34 +0100 Subject: [PATCH 4/4] Correction de fautes dans la documentation. --- doc/fr/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/fr/index.md b/doc/fr/index.md index 34fc0b9..f1c856a 100644 --- a/doc/fr/index.md +++ b/doc/fr/index.md @@ -1,6 +1,6 @@ # org.geneanet.customcamera -Ce plugin défini une variable globale navigator.GeneanetCustomCamera contenant un objet. Celui-ci permet de démarrer une caméra customisée & customisable en partie. +Ce plugin définit une variable globale navigator.GeneanetCustomCamera contenant un objet. Celui-ci permet de démarrer un appareil photo customisée et customisable en partie. ## Installation @@ -116,4 +116,4 @@ Une implémentation dans AngularJS a été réalisée pour faciliter son utilisa Pour contribuer à ce projet, merci de respecter les règles suivantes : + **Les bugs, suggestions, etc :** Ils doivent être remontés via le système d'issues de Github. Merci de vérifier que votre sujet n'a pas déjà été traité. + **Développement Javascript :** Le code javascript doit être valide avec JSHint. -+ **Développement Java :** Le code java doit être valide [Checkstyle](http://eclipse-cs.sourceforge.net/#!/) \ No newline at end of file ++ **Développement Java :** Le code java doit être valide [Checkstyle](http://eclipse-cs.sourceforge.net/#!/). \ No newline at end of file