api.photo

Подробное описание

Работа с фотографиями

api.photo

Открытые члены
	defectStatus (fileNameOrPath)
	Получить качество фото из регистра файлов Подробнее...
	falsifiedStatus (fileNameOrPath)
	Получить статус фальсификации фотографии Подробнее...
	isAllowed ()
	Получить признак разрешения использовать фотокамеру Подробнее...
	photoPathDataByName (fileName)
	Получить информацию о файле фотографии по названию файла. Для незагруженных файлов начинается загрузка и возвращается путь до изображения-заглушки Подробнее...
	photoPathDataListByPacket (packetId)
	Получить список информации по файлам, входящим в пакет. Для незагруженных файлов начинается загрузка и возвращается путь до изображения-заглушки Подробнее...
	photoPathDataListByPacketOrName (packetId, photoName)
	Получить информацию по фотографиям либо по идентификатору пакета, либо по названию файла. Если передан верный идентификатор пакета, используется он, иначе - имя файла. Для незагруженных файлов начинается загрузка и возвращается путь до изображения-заглушки Подробнее...
	readExif (path)
	Получить EXIF-метаданные фотографии Подробнее...
	resize (srcPath, maxSize)
	Изменить размер фотографии Подробнее...
	resizeAndCopy (srcPath, dstPath, maxSize, overwrite)
	Изменить размер и скопировать фотографию Подробнее...
	takePhotos (maxCount, externalContext)
	Получить фотографии. Источник фотографий выбирается согласно настройке МТ Подробнее...
	takePhotosFromCamera (maxCount, isFromCameraMT, externalContext)
	Сделать фотографии, используя камеру (МТ или нативную) Подробнее...
	takePhotosFromGallery (maxCount, externalContext)
	Открывает диалоговое окно для выбора файлов Подробнее...

Методы

defectStatus (fileNameOrPath)

struct DefectStatusEnum * defectStatus

(

fileNameOrPath

)

Получить качество фото из регистра файлов

Аргументы

fileNameOrPath

[String] - Путь до файла или название файла

Возвращает

Result - Результат выполнения операции.
В поле value - статус качества фотографии (DefectStatusEnum)

falsifiedStatus (fileNameOrPath)

struct FalsifiedStatusEnum * falsifiedStatus

(

fileNameOrPath

)

Получить статус фальсификации фотографии

Аргументы

fileNameOrPath

[String] - Путь до файла или название файла

Возвращает

Result - Результат выполнения операции.
В поле value - статус фальсификации фотографии (FalsifiedStatusEnum)

isAllowed ()

isAllowed

(

)

Получить признак разрешения использовать фотокамеру

Возвращает

Boolean

photoPathDataByName (fileName)

* photoPathDataByName

(

fileName

)

Получить информацию о файле фотографии по названию файла.
Для незагруженных файлов начинается загрузка и возвращается путь до изображения-заглушки

Аргументы

fileName

[String] - Название файла

Возвращает

PhotoInfo - Информация о файле фотографии

photoPathDataListByPacket (packetId)

photoPathDataListByPacket

(

packetId

)

Получить список информации по файлам, входящим в пакет.
Для незагруженных файлов начинается загрузка и возвращается путь до изображения-заглушки

Аргументы

packetId

[ID] - Идентификатор пакета

Возвращает

PhotoInfo[] - Список информации по файлам

photoPathDataListByPacketOrName (packetId, photoName)

photoPathDataListByPacketOrName	(	packetId	,
		photoName
	)

Получить информацию по фотографиям либо по идентификатору пакета, либо по названию файла.
Если передан верный идентификатор пакета, используется он, иначе - имя файла.
Для незагруженных файлов начинается загрузка и возвращается путь до изображения-заглушки

Уст.:

(23-06-2020) Используйте api.photo.photoPathDataListByPacket(packetId) или api.photo.photoPathDataByName(fileName)

Аргументы

packetId	[ID] - Идентификатор пакета
photoName	[String] - Название файла

Возвращает

PhotoInfo[] - Список информации по файлам

readExif (path)

readExif

(

path

)

Получить EXIF-метаданные фотографии

Аргументы

path	[String] - Путь до файла

Возвращает

Object - Объект, содержащий EXIF-метаданные

// Пример возвращаемого объекта
{
  "Exif.Image.DateTime": "2017:01:16 09:24:21",
  "Exif.Image.ExifTag": "136",
  "Exif.Image.ImageDescription": "c63adbec-21b9-4987-b326-e7a0c297e1bb",
  "Exif.Image.Software": "MT V:4.1.6.6609",
  "Exif.Photo.DateTimeDigitized": "2017:01:16 09:24:21",
  "Exif.Photo.DateTimeOriginal": "2017:01:16 09:24:21",
  "Exif.Photo.ImageUniqueID": "578521030 ... 89b4e252c735"
}

resize (srcPath, maxSize)

resize	(	srcPath	,
		maxSize
	)

Изменить размер фотографии

Аргументы

srcPath	[String] - Путь до файла
maxSize	[Number] - Максимальный размер любой стороны в px

Возвращает

Boolean - Признак успешности

resizeAndCopy (srcPath, dstPath, maxSize, overwrite)

resizeAndCopy	(	srcPath	,
		dstPath	,
		maxSize	,
		overwrite
	)

Изменить размер и скопировать фотографию

Аргументы

srcPath	[String] - Путь до исходного файла
dstPath	[String] - Путь до файла назначения
maxSize	[Number] - Максимальный размер любой стороны в px
overwrite	[Boolean] optional - Переписать файл если существует. По умолчанию false

Возвращает

Boolean - Признак успешности

takePhotos (maxCount, externalContext)

takePhotos	(	maxCount	,
		externalContext
	)

Получить фотографии. Источник фотографий выбирается согласно настройке МТ

Аргументы

maxCount	[Number] optional - Ограничение количества фотографий. Любое число меньше 1 означает без ограничений. По умолчанию без ограничений
context	[Object] optional - Объект с информацией о контексте создания фотографии (аналогично api.context)

Возвращает

String[] - Список путей до полученных фотографий

takePhotosFromCamera (maxCount, isFromCameraMT, externalContext)

takePhotosFromCamera	(	maxCount	,
		isFromCameraMT	,
		externalContext
	)

Сделать фотографии, используя камеру (МТ или нативную)

Аргументы

maxCount	[Number] optional - Ограничение количества фотографий. Любое число меньше 1 означает без ограничений. По умолчанию без ограничений
isFromCameraMT	[Boolean] optional - Признак использования камеры МТ. Камера МТ используется по умолчанию
context	[Object] optional - Объект с информацией о контексте создания фотографии (аналогично api.context)

Возвращает

String[] - Список путей до полученных фотографий

takePhotosFromGallery (maxCount, externalContext)

takePhotosFromGallery	(	maxCount	,
		externalContext
	)

Открывает диалоговое окно для выбора файлов

Аргументы

maxCount	[Number] optional - Ограничение количества фотографий. Любое число меньше 1 означает без ограничений. По умолчанию без ограничений
context	[Object] optional - Объект с информацией о контексте создания фотографии (аналогично api.context)

Возвращает

String[] - Список путей до полученных фотографий