SDK/ly.img.android.pesdk.backend.exif/Exify

Exify

This class provides methods and constants for reading and writing jpeg file metadata. It contains a collection of ExifTags, and a collection of definitions for creating valid ExifTags. The collection of ExifTags can be updated by: reading new ones from a file, deleting or adding existing ones, or building new ExifTags from a tag definition. These ExifTags can be written to a valid jpeg image as exif metadata.

Each ExifTag has a tag ID (TID) and is stored in a specific image file directory (IFD) as specified by the exif standard. A tag definition can be looked up with a constant that is a combination of TID and IFD. This definition has information about the type, number of components, and valid IFDs for a ExifTagKey.

open class Exify

Constructors

Exify

core

open fun Exify()

Types

ColorSpace

core

Constants for {@see #ExifTagKey.COLOR_SPACE}

interface ColorSpace

ComponentsConfiguration

core

Constants for {@see #ExifTagKey.COMPONENTS_CONFIGURATION}

interface ComponentsConfiguration

Compression

core

Constants for {@see #ExifTagKey.COMPRESSION}

interface Compression

Contrast

core

Constants for {@see #ExifTagKey.CONTRAST}

interface Contrast

ExposureMode

core

Constants for {@see #ExifTagKey.EXPOSURE_MODE}

interface ExposureMode

ExposureProgram

core

Constants for {@see #ExifTagKey.EXPOSURE_PROGRAM}

interface ExposureProgram

FileSource

core

Constants for {@see #ExifTagKey.FILE_SOURCE}

interface FileSource

Flash

core

Constants for {@see #ExifTagKey.FLASH} As the definition in Jeita EXIF 2.2

interface Flash

GainControl

core

Constants for {@see #ExifTagKey.GAIN_CONTROL}

interface GainControl

GpsAltitudeRef

core

Constants for {@see #ExifTagKey.GPS_ALTITUDE_REF}

interface GpsAltitudeRef

GpsDifferential

core

Constants for {@see #ExifTagKey.GPS_DIFFERENTIAL}

interface GpsDifferential

GpsLatitudeRef

core

Constants for {@see #ExifTagKey.GPS_LATITUDE_REF} , {@see #ExifTagKey.GPS_DEST_LATITUDE_REF}

interface GpsLatitudeRef

GpsLongitudeRef

core

Constants for {@see #ExifTagKey.GPS_LONGITUDE_REF} , {@see #ExifTagKey.GPS_DEST_LONGITUDE_REF}

interface GpsLongitudeRef

GpsMeasureMode

core

Constants for {@see #ExifTagKey.GPS_MEASURE_MODE}

interface GpsMeasureMode

GpsSpeedRef

core

Constants for {@see #ExifTagKey.GPS_SPEED_REF} , {@see #ExifTagKey.GPS_DEST_DISTANCE_REF}

interface GpsSpeedRef

GpsStatus

core

Constants for {@see #ExifTagKey.GPS_STATUS}

interface GpsStatus

GpsTrackRef

core

Constants for {@see #ExifTagKey.GPS_TRACK_REF} , {@see #ExifTagKey.GPS_IMG_DIRECTION_REF} , {@see #ExifTagKey.GPS_DEST_BEARING_REF}

interface GpsTrackRef

JpegProcess

core

Constants for the jpeg process algorithm used.

interface JpegProcess

LightSource

core

Constants for {@see #ExifTagKey.LIGHT_SOURCE}

interface LightSource

MeteringMode

core

Constants for {@see #ExifTagKey.METERING_MODE}

interface MeteringMode

Options

core

Options for calling readExif , readExif , readExif

interface Options

Orientation

core

Constants for {@see #ExifTagKey.ORIENTATION} . They can be interpreted as follows:

TOP_LEFT is the normal orientation.
TOP_RIGHT is a left-right mirror.
BOTTOM_LEFT is a 180 degree rotation.
BOTTOM_RIGHT is a top-bottom mirror.
LEFT_TOP is mirrored about the top-left<->bottom-right axis.
TOP_RIGHT is a 90 degree clockwise rotation.
BOTTOM_LEFT is mirrored about the top-right<->bottom-left axis.
BOTTOM_RIGHT is a 270 degree clockwise rotation.

interface Orientation

PhotometricInterpretation

core

Constants for {@see #ExifTagKey.PHOTOMETRIC_INTERPRETATION}

interface PhotometricInterpretation

PlanarConfiguration

core

Constants for {@see #ExifTagKey.PLANAR_CONFIGURATION}

interface PlanarConfiguration

ResolutionUnit

core

Constants for {@see #ExifTagKey.RESOLUTION_UNIT}

interface ResolutionUnit

Saturation

core

Constants for {@see #ExifTagKey.SATURATION}

interface Saturation

SceneCapture

core

Constants for {@see #ExifTagKey.SCENE_CAPTURE_TYPE}

interface SceneCapture

SceneType

core

Constants for {@see #ExifTagKey.SCENE_TYPE}

interface SceneType

SensingMethod

core

Constants for {@see #ExifTagKey.SENSING_METHOD}

interface SensingMethod

SensitivityType

core

Constants for the {@see #ExifTagKey.SENSITIVITY_TYPE} tag

interface SensitivityType

Sharpness

core

Constants for {@see #ExifTagKey.SHARPNESS}

interface Sharpness

SubjectDistance

core

Constants for {@see #ExifTagKey.SUBJECT_DISTANCE}

interface SubjectDistance

TAG

core

enum TAG

WhiteBalance

core

Constants for {@see #ExifTagKey.WHITE_BALANCE}

interface WhiteBalance

YCbCrPositioning

core

Constants for {@see #ExifTagKey.Y_CB_CR_POSITIONING}

interface YCbCrPositioning

Functions

addDateTimeStampTag

core

Creates, formats, and sets the DateTimeStamp tag for one of: {@see #ExifTagKey.DATE_TIME} , {@see #ExifTagKey.DATE_TIME_DIGITIZED} , {@see #ExifTagKey.DATE_TIME_ORIGINAL} .

open fun addDateTimeStampTag(tag: Exify.TAG, timestamp: Long, timezone: TimeZone): Boolean

addGpsDateTimeStampTag

core

Creates and sets the GPS timestamp ExifTagKey.

open fun addGpsDateTimeStampTag(timestamp: Long): Boolean

addGpsTags

core

Creates and sets all to the GPS tags for a give latitude and longitude.

open fun addGpsTags(latitude: Double, longitude: Double): Boolean

buildTag

core

Creates a tag for a defined tag constant in the tag's default IFD.

open fun buildTag(tag: Exify.TAG, val: Any): ExifTagInfo

Creates a tag for a defined tag constant in a given IFD if that IFD is allowed for the ExifTagKey. This method will fail anytime the appropriate for this tag's datatype would fail.

open fun buildTag(tagId: Int, ifdId: Int, val: Any): ExifTagInfo

clearExif

core

Clears this ExifInterface object's existing exif tags.

open fun clearExif()

convertLatOrLongToDouble

core

Gets the double representation of the GPS latitude or longitude coordinate.

open fun convertLatOrLongToDouble(coordinate: Array<Rational>, reference: String): Double

defineTag

core

Returns the constant representing a tag with a given TID and default IFD.

open fun defineTag(ifdId: Int, tagId: Short): Int

deleteTag

core

Removes the ExifTag for a tag constant from that tag's default IFD.

open fun deleteTag(tagId: Int)

open fun deleteTag(tag: Exify.TAG)

Removes the ExifTag for a tag constant from the given IFD.

open fun deleteTag(tagId: Int, ifdId: Int)

getActualTagCount

core

Gets the number of elements for an ExifTag in a given IFD.

open fun getActualTagCount(tagId: Int, ifdId: Int): Int

getAllTags

core

Get the exif tags in this ExifInterface object or null if none exist.

open fun getAllTags(): List<ExifTagInfo>

getAltitude

core

Return the altitude in meters. If the exif tag does not exist, return defaultValue.

open fun getAltitude(defaultValue: Double): Double

getApertureSize

core

Return the aperture size, if present, 0 if missing

open fun getApertureSize(): Double

getDateTime

core

Given an exif date time, like {@see #ExifTagKey.DATE_TIME} or {@see #ExifTagKey.DATE_TIME_DIGITIZED} returns a java Date object

open fun getDateTime(dateTimeString: String, timeZone: TimeZone): Date

getDefinedTagCount

core

Gets the defined number of elements for a ExifTagKey.

open fun getDefinedTagCount(tagId: Int): Int

open fun getDefinedTagCount(tag: Exify.TAG): Int

getDefinedTagDefaultIfd

core

Gets the default IFD for a ExifTagKey.

open fun getDefinedTagDefaultIfd(tagId: Int): Int

getDefinedTagType

core

Gets the defined type for a ExifTagKey.

open fun getDefinedTagType(tagId: Int): Short

getImageSize

core

Returns the Image size as decoded from the SOF marker

open fun getImageSize(): Array<Int>

getJpegProcess

core

this gives information about the process used to create the JPEG file. Possible values are:

'0' Unknown
'192' Baseline
'193' Extended sequential
'194' Progressive
'195' Lossless
'197' Differential sequential
'198' Differential progressive
'199' Differential lossless
'201' Extended sequential, arithmetic coding
'202' Progressive, arithmetic coding
'203' Lossless, arithmetic coding
'205' Differential sequential, arithmetic coding
'206' Differential progressive, arithmetic codng
'207' Differential lossless, arithmetic coding

open fun getJpegProcess(): Short

getLatitude

core

Returns a formatted String with the latitude representation: 39° 8' 16.8" N

open fun getLatitude(): String

getLatLongAsDoubles

core

Gets the GPS latitude and longitude as a pair of doubles from this ExifInterface object's tags, or null if the necessary tags do not exist.

open fun getLatLongAsDoubles(): Array<Double>

getLensModelDescription

core

Returns the lens model as string if any of the tags {@see #ExifTagKey.LENS_MODEL} or {@see #ExifTagKey.LENS_SPECS} are found

open fun getLensModelDescription(): String

getLongitude

core

Returns a formatted String with the longitude representation: 77° 37' 51.6" W

open fun getLongitude(): String

getOrientationValueForRotation

core

Returns the Orientation ExifTag value for a given number of degrees.

open fun getOrientationValueForRotation(degrees: Int): Short

getQualityGuess

core

Returns the JPEG quality used to generate the image or 0 if not found

open fun getQualityGuess(): Int

getResolutionUnit

core

Given the value from {@see #ExifTagKey.FOCAL_PLANE_RESOLUTION_UNIT} or {@see #ExifTagKey.RESOLUTION_UNIT} this method will return the corresponding value in millimeters

open fun getResolutionUnit(resolution: Int): Double

getRotationForOrientationValue

core

Returns the rotation degrees corresponding to an ExifTag Orientation value.

open fun getRotationForOrientationValue(orientation: Short): Int

getTag

core

Returns the ExifTag in that tag's default IFD for a defined tag constant or null if none exists.

open fun getTag(tagId: Int): ExifTagInfo

open fun getTag(tag: Exify.TAG): ExifTagInfo

Gets an ExifTag for an IFD other than the tag's default.

open fun getTag(tagId: Int, ifdId: Int): ExifTagInfo

getTagByteValue

core

open fun getTagByteValue(tagId: Int): Byte

open fun getTagByteValue(tag: Exify.TAG): Byte

open fun getTagByteValue(tagId: Int, ifdId: Int): Byte

getTagByteValues

core

open fun getTagByteValues(tagId: Int): Array<Byte>

open fun getTagByteValues(tag: Exify.TAG): Array<Byte>

open fun getTagByteValues(tagId: Int, ifdId: Int): Array<Byte>

getTagIntValue

core

open fun getTagIntValue(tagId: Int): Integer

open fun getTagIntValue(tag: Exify.TAG): Integer

open fun getTagIntValue(tagId: Int, ifdId: Int): Integer

getTagIntValues

core

open fun getTagIntValues(tagId: Int): Array<Int>

open fun getTagIntValues(tag: Exify.TAG): Array<Int>

open fun getTagIntValues(tagId: Int, ifdId: Int): Array<Int>

getTagLongValue

core

open fun getTagLongValue(tagId: Int): Long

open fun getTagLongValue(tag: Exify.TAG): Long

open fun getTagLongValue(tagId: Int, ifdId: Int): Long

getTagLongValues

core

open fun getTagLongValues(tagId: Int): Array<Long>

open fun getTagLongValues(tag: Exify.TAG): Array<Long>

open fun getTagLongValues(tagId: Int, ifdId: Int): Array<Long>

getTagRationalValue

core

open fun getTagRationalValue(tagId: Int): Rational

open fun getTagRationalValue(tag: Exify.TAG): Rational

open fun getTagRationalValue(tagId: Int, ifdId: Int): Rational

getTagRationalValues

core

open fun getTagRationalValues(tagId: Int): Array<Rational>

open fun getTagRationalValues(tag: Exify.TAG): Array<Rational>

open fun getTagRationalValues(tagId: Int, ifdId: Int): Array<Rational>

getTagsForIfdId

core

Returns a list of ExifTags that share an IFD (which can be obtained by calling getTrueIfd on a defined tag constant) or null if none exist.

open fun getTagsForIfdId(ifdId: Int): List<ExifTagInfo>

getTagsForTagId

core

Returns a list of ExifTags that share a TID (which can be obtained by calling on a defined tag constant) or null if none exist.

open fun getTagsForTagId(tagId: Short): List<ExifTagInfo>

getTagStringValue

core

open fun getTagStringValue(tagId: Int): String

open fun getTagStringValue(tag: Exify.TAG): String

open fun getTagStringValue(tagId: Int, ifdId: Int): String

getTagValue

core

Returns the value of the ExifTag in that tag's default IFD for a defined tag constant or null if none exists or the value could not be cast into the return type.

open fun getTagValue(tagId: Int): Any

open fun getTagValue(tag: Exify.TAG): Any

Gets a tag value for an IFD other than the tag's default.

open fun getTagValue(tagId: Int, ifdId: Int): Any

getThumbnail

core

Returns the thumbnail if it is jpeg compressed, or null if none exists.

open fun getThumbnail(): Array<Byte>

getThumbnailBitmap

core

Returns the thumbnail from IFD1 as a bitmap, or null if none exists.

open fun getThumbnailBitmap(): Bitmap

getThumbnailBytes

core

Returns the thumbnail from IFD1 as a byte array, or null if none exists. The bytes may either be an uncompressed strip as specified in the exif standard or a jpeg compressed image.

open fun getThumbnailBytes(): Array<Byte>

getTrueIfd

core

Returns the default IFD for a tag constant.

open fun getTrueIfd(tag: Int): Int

open fun getTrueIfd(tag: Exify.TAG): Int

getTrueTagKey

core

Returns the TID for a tag constant.

open fun getTrueTagKey(tag: Int): Short

open fun getTrueTagKey(tag: Exify.TAG): Short

getUserComment

core

Decodes the user comment tag into string as specified in the EXIF standard. Returns null if decoding failed.

open fun getUserComment(): String

hasThumbnail

core

Check if thumbnail exists.

open fun hasThumbnail(): Boolean

isTagCountDefined

core

Checks whether a tag has a defined number of elements.

open fun isTagCountDefined(tagId: Int): Boolean

isThumbnailCompressed

core

Check if thumbnail is compressed.

open fun isThumbnailCompressed(): Boolean

readExif

core

Reads the exif tags from a byte array, clearing this ExifInterface object's existing exif tags.

open fun readExif(jpeg: Array<Byte>, options: Int)

Reads the exif tags from an InputStream, clearing this ExifInterface object's existing exif tags.

    ExifInterface exif = new ExifInterface();
    exif.readExif( stream, Options.OPTION_IFD_0 | Options.OPTION_IFD_1 | Options.OPTION_IFD_EXIF );
    ...
    // to request all the options use the OPTION_ALL bit mask
    exif.readExif( stream, Options.OPTION_ALL );

open fun readExif(inStream: InputStream, options: Int)

Reads the exif tags from a file, clearing this ExifInterface object's existing exif tags.

open fun readExif(inFileName: String, options: Int)

removeCompressedThumbnail

core

Clears the compressed thumbnail if it exists.

open fun removeCompressedThumbnail()

removeTagDefinition

core

Removes a tag definition for given defined tag constant.

open fun removeTagDefinition(tagId: Int)

resetTagDefinitions

core

Resets tag definitions to the default ones.

open fun resetTagDefinitions()

setCompressedThumbnail

core

Sets the thumbnail to be a jpeg compressed bitmap. Clears any prior thumbnail.

open fun setCompressedThumbnail(thumb: Bitmap): Boolean

Sets the thumbnail to be a jpeg compressed image. Clears any prior thumbnail.

open fun setCompressedThumbnail(thumb: Array<Byte>): Boolean

setExif

core

Sets the exif tags, clearing this ExifInterface object's existing exif tags.

open fun setExif(tags: Collection<ExifTagInfo>)

setTag

core

Puts an ExifTag into this ExifInterface object's tags, removing a previous ExifTag with the same TID and IFD. The IFD it is put into will be the one the tag was created with in .

open fun setTag(tag: ExifTagInfo): ExifTagInfo

setTagDefinition

core

Creates a new tag definition in this ExifInterface object for a given TID and default IFD. Creating a definition with the same TID and default IFD as a previous definition will override it.