You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

417 lines
23 KiB

  1. <!---
  2. Licensed to the Apache Software Foundation (ASF) under one
  3. or more contributor license agreements. See the NOTICE file
  4. distributed with this work for additional information
  5. regarding copyright ownership. The ASF licenses this file
  6. to you under the Apache License, Version 2.0 (the
  7. "License"); you may not use this file except in compliance
  8. with the License. You may obtain a copy of the License at
  9. http://www.apache.org/licenses/LICENSE-2.0
  10. Unless required by applicable law or agreed to in writing,
  11. software distributed under the License is distributed on an
  12. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  13. KIND, either express or implied. See the License for the
  14. specific language governing permissions and limitations
  15. under the License.
  16. -->
  17. # cordova-plugin-camera
  18. Этот плагин предоставляет API для съемки и для выбора изображения из библиотеки изображений системы.
  19. cordova plugin add cordova-plugin-camera
  20. ## navigator.camera.getPicture
  21. Снимает фотографию с помощью камеры, или получает фотографию из галереи изображений устройства. Изображение передается на функцию обратного вызова успешного завершения как `String` в base64-кодировке, или как URI указывающего на файл изображения. Метод возвращает объект `CameraPopoverHandle`, который может использоваться для перемещения инструмента выбора файла.
  22. navigator.camera.getPicture( cameraSuccess, cameraError, cameraOptions );
  23. ### Описание
  24. Функция `camera.getPicture` открывает приложение камеры устройства, которое позволяет снимать фотографии. Это происходит по умолчанию, когда `Camera.sourceType` равно `Camera.PictureSourceType.CAMERA` . Как только пользователь делает снимок,приложение камеры закрывается и приложение восстанавливается.
  25. Если `Camera.sourceType` является `Camera.PictureSourceType.PHOTOLIBRARY` или `Camera.PictureSourceType.SAVEDPHOTOALBUM` , то показывается диалоговое окно, которое позволяет пользователям выбрать существующее изображение. Функция `camera.getPicture` возвращает объект `CameraPopoverHandle` объект, который может использоваться для перемещения диалога выбора изображения, например, при изменении ориентации устройства.
  26. Возвращаемое значение отправляется в функцию обратного вызова `cameraSuccess` в одном из следующих форматов, в зависимости от параметра `cameraOptions` :
  27. * A объект `String` содержащий фото изображение в base64-кодировке.
  28. * Объект `String` представляющий расположение файла изображения на локальном хранилище (по умолчанию).
  29. Вы можете сделать все, что угодно вы хотите с закодированным изображением или URI, например:
  30. * Отобразить изображение с помощью тега `<img>`, как показано в примере ниже
  31. * Сохранять данные локально (`LocalStorage`, [Lawnchair][1], и т.д.)
  32. * Отправлять данные на удаленный сервер
  33. [1]: http://brianleroux.github.com/lawnchair/
  34. **Примечание**: разрешение фото на более новых устройствах является достаточно хорошим. Фотографии из галереи устройства не масштабируются к более низкому качеству, даже если указан параметр `quality`. Чтобы избежать общих проблем с памятью, установите `Camera.destinationType` в `FILE_URI` вместо `DATA_URL`.
  35. ### Поддерживаемые платформы
  36. * Amazon Fire OS
  37. * Android
  38. * BlackBerry 10
  39. * Обозреватель
  40. * Firefox OS
  41. * iOS
  42. * Tizen
  43. * Windows Phone 7 и 8
  44. * Windows 8
  45. ### Предпочтения (iOS)
  46. * **CameraUsesGeolocation** (логическое значение, по умолчанию false). Для захвата изображения JPEG, значение true, чтобы получить данные геопозиционирования в заголовке EXIF. Это вызовет запрос на разрешения геолокации, если задано значение true.
  47. <preference name="CameraUsesGeolocation" value="false" />
  48. ### Особенности Amazon Fire OS
  49. Amazon Fire OS используют намерения для запуска активности камеры на устройстве для съемки фотографий, и на устройствах с низким объемам памяти, активность Cordova может быть завершена. В этом случае изображение может не появиться при восстановлении активности Cordova.
  50. ### Особенности Android
  51. Android используют намерения для запуска активности камеры на устройстве для съемки фотографий, и на устройствах с низким объемам памяти, активность Cordova может быть завершена. В этом случае изображение может не появиться при восстановлении активности Cordova.
  52. ### Браузер причуды
  53. Может возвращать только фотографии как изображения в кодировке base64.
  54. ### Особенности Firefox OS
  55. Плагин Camera на данный момент реализован с использованием [Web Activities][2].
  56. [2]: https://hacks.mozilla.org/2013/01/introducing-web-activities/
  57. ### Особенности iOS
  58. Включение функции JavaScript `alert()` в любой из функций обратного вызова функции может вызвать проблемы. Оберните вызов alert в `setTimeout()` для позволения окну выбора изображений iOS полностью закрыться перед отображение оповещения:
  59. setTimeout(function() {/ / ваши вещи!}, 0);
  60. ### Особенности Windows Phone 7
  61. Вызов встроенного приложения камеры, в то время как устройство подключено к Zune не работает, и инициирует обратный вызов для ошибки.
  62. ### Особенности Tizen
  63. Tizen поддерживает только значение `destinationType` равное `Camera.DestinationType.FILE_URI` и значение `sourceType` равное `Camera.PictureSourceType.PHOTOLIBRARY`.
  64. ### Пример
  65. Сделайте фотографию и получите его как изображение в base64-кодировке:
  66. navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
  67. destinationType: Camera.DestinationType.DATA_URL
  68. });
  69. function onSuccess(imageData) {
  70. var image = document.getElementById('myImage');
  71. image.src = "data:image/jpeg;base64," + imageData;
  72. }
  73. function onFail(message) {
  74. alert('Failed because: ' + message);
  75. }
  76. Сделайте фотографию и получить расположение файла с изображением:
  77. navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
  78. destinationType: Camera.DestinationType.FILE_URI });
  79. function onSuccess(imageURI) {
  80. var image = document.getElementById('myImage');
  81. image.src = imageURI;
  82. }
  83. function onFail(message) {
  84. alert('Failed because: ' + message);
  85. }
  86. ## CameraOptions
  87. Необязательные параметры для настройки параметров камеры.
  88. { quality : 75,
  89. destinationType : Camera.DestinationType.DATA_URL,
  90. sourceType : Camera.PictureSourceType.CAMERA,
  91. allowEdit : true,
  92. encodingType: Camera.EncodingType.JPEG,
  93. targetWidth: 100,
  94. targetHeight: 100,
  95. popoverOptions: CameraPopoverOptions,
  96. saveToPhotoAlbum: false };
  97. ### Параметры
  98. * **quality**: качество сохраняемого изображения, выражается в виде числа в диапазоне от 0 до 100, где 100 является обычно полным изображением без потери качества при сжатии. Значение по умолчанию — 50. *(Число)* (Обратите внимание, что информация о разрешении камеры недоступна.)
  99. * **параметр destinationType**: выберите формат возвращаемого значения. Значение по умолчанию — FILE_URI. Определяется в `navigator.camera.DestinationType` *(число)*
  100. Camera.DestinationType = {
  101. DATA_URL: 0, / / возвращение изображения в base64-кодировке строки
  102. FILE_URI: 1, / / возврат файла изображения URI
  103. NATIVE_URI: 2 / / возвращение образа собственного URI (например, Библиотека активов: / / на iOS или содержание: / / на андроиде)
  104. };
  105. * **тип источника**: установить источник рисунка. По умолчанию используется камера. Определяется в `navigator.camera.PictureSourceType` *(число)*
  106. Camera.PictureSourceType = {
  107. PHOTOLIBRARY: 0,
  108. CAMERA: 1,
  109. SAVEDPHOTOALBUM: 2
  110. };
  111. * **allowEdit**: позволит редактирование изображения средствами телефона перед окончательным выбором изображения. *(Логический)*
  112. * **Тип_шифрования**: выберите возвращенный файл в кодировку. Значение по умолчанию — JPEG. Определяется в `navigator.camera.EncodingType` *(число)*
  113. Camera.EncodingType = {
  114. JPEG: 0, // возвращает изображение в формате JPEG
  115. PNG: 1 // возвращает рисунок в формате PNG
  116. };
  117. * **targetWidth**: ширина изображения в пикселах к которой необходимо осуществить масштабирование. Это значение должно использоваться совместно с **targetHeight**. Пропорции изображения останутся неизменными. *(Число)*
  118. * **targetHeight**: высота изображения в пикселах к которой необходимо осуществить масштабирование. Это значение должно использоваться совместно с **targetWidth**. Пропорции изображения останутся неизменными. *(Число)*
  119. * **тип носителя**: Установите источник получения изображения, из которого надо выбрать изображение. Работает только если `PictureSourceType` равно `PHOTOLIBRARY` или `SAVEDPHOTOALBUM` . Определяется в `nagivator.camera.MediaType` *(число)*
  120. Camera.MediaType = {
  121. PICTURE: 0, / / разрешить выбор только сохраненных изображений. DEFAULT. Will return format specified via DestinationType
  122. VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
  123. ALLMEDIA : 2 // allow selection from all media types
  124. };
  125. * **correctOrientation**: вращает изображение, чтобы внести исправления к ориентации устройства во время захвата. *(Логический)*
  126. * **saveToPhotoAlbum**: сохранить изображение в фотоальбом на устройстве после захвата. *(Логическое)*
  127. * **popoverOptions**: только для iOS параметры, которые определяют местоположение инструмента в iPad. Определены в`CameraPopoverOptions`.
  128. * **cameraDirection**: выбрать камеру для использования (передней или задней стороне). Значение по умолчанию — обратно. Определяется в `navigator.camera.Direction` *(число)*
  129. Camera.Direction = {
  130. BACK : 0, // Use the back-facing camera
  131. FRONT : 1 // Use the front-facing camera
  132. };
  133. ### Особенности Amazon Fire OS
  134. * Любое значение `cameraDirection` возвращает фотографию сделанную задней камерой.
  135. * Игнорирует параметр `allowEdit`.
  136. * Оба параметра `Camera.PictureSourceType.PHOTOLIBRARY` и `Camera.PictureSourceType.SAVEDPHOTOALBUM` отображают один и тот же фотоальбом.
  137. ### Особенности Android
  138. * Любое значение `cameraDirection` возвращает фотографию сделанную задней камерой.
  139. * Игнорирует параметр `allowEdit`.
  140. * Оба параметра `Camera.PictureSourceType.PHOTOLIBRARY` и `Camera.PictureSourceType.SAVEDPHOTOALBUM` отображают один и тот же фотоальбом.
  141. ### Особенности BlackBerry 10
  142. * Игнорирует `quality` параметр.
  143. * Игнорирует параметр `allowEdit`.
  144. * `Camera.MediaType` не поддерживается.
  145. * Игнорирует параметр `correctOrientation`.
  146. * Игнорирует параметр `cameraDirection`.
  147. ### Особенности Firefox OS
  148. * Игнорирует `quality` параметр.
  149. * Значение `Camera.DestinationType` игнорируется и равно `1` (URI для файла изображения)
  150. * Игнорирует параметр `allowEdit`.
  151. * Игнорирует параметр `PictureSourceType` (пользователь выбирает его в диалоговом окне)
  152. * Игнорирует параметр `encodingType`
  153. * Игнорирует `targetWidth` и `targetHeight`
  154. * `Camera.MediaType` не поддерживается.
  155. * Игнорирует параметр `correctOrientation`.
  156. * Игнорирует параметр `cameraDirection`.
  157. ### Особенности iOS
  158. * Установите `quality` ниже 50, для того чтобы избежать ошибок памяти на некоторых устройствах.
  159. * При использовании `destinationType.FILE_URI` , фотографии сохраняются во временном каталоге приложения. Содержимое приложения временного каталога удаляется при завершении приложения.
  160. ### Особенности Tizen
  161. * options, не поддерживается
  162. * всегда возвращает URI файла
  163. ### Особенности Windows Phone 7 и 8
  164. * Игнорирует параметр `allowEdit`.
  165. * Игнорирует параметр `correctOrientation`.
  166. * Игнорирует параметр `cameraDirection`.
  167. * Игнорирует `saveToPhotoAlbum` параметр. Важно: Все изображения, снятые камерой wp7/8 cordova API всегда копируются в рулон камеры телефона. В зависимости от параметров пользователя это также может означать, что изображение автоматически загружены на их OneDrive. Потенциально это может означать, что этот образ доступен для более широкой аудитории, чем ваше приложение предназначено. Если этот блокатор для вашего приложения, вам нужно будет осуществить CameraCaptureTask, как описано на сайте msdn: <http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh394006.aspx> вы можете также комментарий или вверх голосование связанный с этим вопрос [отслеживания][3]
  168. * Игнорирует свойство `mediaType` объекта `cameraOptions` так как Windows Phone SDK не предоставляет способ выбрать видео из PHOTOLIBRARY.
  169. [3]: https://issues.apache.org/jira/browse/CB-2083
  170. ## CameraError
  171. Функция обратного вызова вызываемая в случае возникновения ошибки.
  172. function(message) {
  173. // Show a helpful message
  174. }
  175. ### Параметры
  176. * **сообщение**: сообщение об ошибке предоставляемое платформой устройства. *(Строка)*
  177. ## cameraSuccess
  178. Функция обратного вызова onSuccess, получающая данные изображения.
  179. function(imageData) {
  180. // Do something with the image
  181. }
  182. ### Параметры
  183. * **imageData**: Данные изображения в Base64 кодировке, *или* URI, в зависимости от применяемых параметров `cameraOptions`. *(Строка)*
  184. ### Пример
  185. // Show image
  186. //
  187. function cameraCallback(imageData) {
  188. var image = document.getElementById('myImage');
  189. image.src = "data:image/jpeg;base64," + imageData;
  190. }
  191. ## CameraPopoverHandle
  192. Дескриптор диалогового окна инструмента, созданный `navigator.camera.getPicture`.
  193. ### Методы
  194. * **setPosition**: Задайте положение инструмента выбора изображения.
  195. ### Поддерживаемые платформы
  196. * iOS
  197. ### setPosition
  198. Устанавливает положение инструмента выбора изображения.
  199. **Параметры**:
  200. * `cameraPopoverOptions`: Объект `CameraPopoverOptions`, определяющий новое положение
  201. ### Пример
  202. var cameraPopoverHandle = navigator.camera.getPicture(onSuccess, onFail,
  203. { destinationType: Camera.DestinationType.FILE_URI,
  204. sourceType: Camera.PictureSourceType.PHOTOLIBRARY,
  205. popoverOptions: new CameraPopoverOptions(300, 300, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY)
  206. });
  207. // Reposition the popover if the orientation changes.
  208. window.onorientationchange = function() {
  209. var cameraPopoverOptions = new CameraPopoverOptions(0, 0, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
  210. cameraPopoverHandle.setPosition(cameraPopoverOptions);
  211. }
  212. ## CameraPopoverOptions
  213. Параметры только для iOS, которые определяют расположение элемента привязки и направление стрелки инструмента при выборе изображений из библиотеки изображений iPad или альбома.
  214. {x: 0, y: 32, ширина: 320, высота: 480, arrowDir: Camera.PopoverArrowDirection.ARROW_ANY};
  215. ### CameraPopoverOptions
  216. * **x**: x координата в пикселях элемента экрана, на котором закрепить инструмента. *(Число)*
  217. * **x**: y координата в пикселях элемента экрана, на котором закрепить инструмента. *(Число)*
  218. * **width**: ширина в пикселях элемента экрана, на котором закрепить инструмент выбора изображения. *(Число)*
  219. * **height**: высота в пикселях элемента экрана, на котором закрепить инструмент выбора изображения. *(Число)*
  220. * **arrowDir**: Направление, куда должна указывать стрелка на инструменте. Определено в `Camera.PopoverArrowDirection` *(число)*
  221. Camera.PopoverArrowDirection = {
  222. ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
  223. ARROW_DOWN : 2,
  224. ARROW_LEFT : 4,
  225. ARROW_RIGHT : 8,
  226. ARROW_ANY : 15
  227. };
  228. Обратите внимание, что размер инструмента может изменяться для корректировки в зависимости направлении стрелки и ориентации экрана. Убедитесь, что учитываете возможные изменения ориентации при указании расположения элемента привязки.
  229. ## navigator.camera.cleanup
  230. Удаляет промежуточные фотографии, сделанные камерой из временного хранилища.
  231. navigator.camera.cleanup( cameraSuccess, cameraError );
  232. ### Описание
  233. Удаляет промежуточные файлы изображений, которые хранятся во временном хранилище после вызова метода `camera.getPicture` . Применяется только тогда, когда значение `Camera.sourceType` равно `Camera.PictureSourceType.CAMERA` и `Camera.destinationType` равняется `Camera.DestinationType.FILE_URI`.
  234. ### Поддерживаемые платформы
  235. * iOS
  236. ### Пример
  237. navigator.camera.cleanup(onSuccess, onFail);
  238. function onSuccess() {
  239. console.log("Camera cleanup success.")
  240. }
  241. function onFail(message) {
  242. alert('Failed because: ' + message);
  243. }