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

ExifTagInfo

This class stores information of an EXIF tag. For more information about defined EXIF tags, please read the Jeita EXIF 2.2 standard. Tags should be instantiated using .

open class ExifTagInfo

Constructors

ExifTagInfo

core

open fun ExifTagInfo(tagId: Short, type: Short, componentCount: Int, ifd: Int, hasDefinedComponentCount: Boolean)

Functions

equals

core

open fun equals(obj: Any): Boolean

forceGetValueAsLong

core

Gets a long representation of the value.

open fun forceGetValueAsLong(defaultValue: Long): Long

forceGetValueAsString

core

Gets a string representation of the value.

open fun forceGetValueAsString(): String

getComponentCount

core

Gets the component count of this tag.

open fun getComponentCount(): Int

getDataSize

core

Gets the total data size in bytes of the value of this tag.

open fun getDataSize(): Int

getDataType

core

Gets the data type of this tag

open fun getDataType(): Short

getElementSize

core

Gets the element size of the given data type in bytes.

open fun getElementSize(type: Short): Int

getIfd

core

Returns the ID of the IFD this tag belongs to.

open fun getIfd(): Int

getTagId

core

Gets the TID of this tag.

open fun getTagId(): Short

getValue

core

Gets the tag's value or null if none exists.

open fun getValue(): Any

getValueAsByte

core

Gets the value as a byte. If there are more than 1 bytes in this value, gets the first byte. This method should be used for tags of type TYPE_UNDEFINED or TYPE_UNSIGNED_BYTE .

open fun getValueAsByte(defaultValue: Byte): Byte

getValueAsBytes

core

Gets the value as a byte array. This method should be used for tags of type TYPE_UNDEFINED or TYPE_UNSIGNED_BYTE .

open fun getValueAsBytes(): Array<Byte>

getValueAsInt

core

Gets the value as an int. If there are more than 1 ints in this value, gets the first one. This method should be used for tags of type TYPE_UNSIGNED_SHORT , TYPE_UNSIGNED_LONG .

open fun getValueAsInt(defaultValue: Int): Int

getValueAsInts

core

Gets the value as an array of ints. This method should be used for tags of type TYPE_UNSIGNED_SHORT , TYPE_UNSIGNED_LONG .

open fun getValueAsInts(): Array<Int>

getValueAsLong

core

Gets the value or null if none exists. If there are more than 1 longs in this value, gets the first one. This method should be used for tags of type TYPE_UNSIGNED_LONG .

open fun getValueAsLong(defaultValue: Long): Long

getValueAsLongs

core

Gets the value as an array of longs. This method should be used for tags of type TYPE_UNSIGNED_LONG .

open fun getValueAsLongs(): Array<Long>

getValueAsRational

core

Gets the value as a Rational. If there are more than 1 Rationals in this value, gets the first one. This method should be used for tags of type TYPE_RATIONAL or TYPE_UNSIGNED_RATIONAL .

open fun getValueAsRational(defaultValue: Rational): Rational

open fun getValueAsRational(defaultValue: Long): Rational

getValueAsRationals

core

Gets the value as an array of Rationals. This method should be used for tags of type TYPE_RATIONAL or TYPE_UNSIGNED_RATIONAL .

open fun getValueAsRationals(): Array<Rational>

getValueAsString

core

Gets the value as a String. This method should be used for tags of type TYPE_ASCII .

open fun getValueAsString(): String

open fun getValueAsString(defaultValue: String): String

hasValue

core

Returns true if this ExifTag contains value; otherwise, this tag will contain an offset value that is determined when the tag is written.

open fun hasValue(): Boolean

isValidIfd

core

Returns true if the given IFD is a valid IFD.

open fun isValidIfd(ifdId: Int): Boolean

isValidType

core

Returns true if a given type is a valid tag type.

open fun isValidType(type: Short): Boolean

setTimeValue

core

Sets a timestamp to this tag. The method converts the timestamp with the format of "yyyy:MM:dd kk:mm:ss" and calls setValue . This method will fail if the data type is not TYPE_ASCII or the component count of this tag is not 20 or undefined.

open fun setTimeValue(time: Long): Boolean

setValue

core

Sets a Rational value into this tag. This method should be used for tags of type TYPE_UNSIGNED_RATIONAL , or TYPE_RATIONAL . This method will fail if:

The component type of this tag is not TYPE_UNSIGNED_RATIONAL or TYPE_RATIONAL .
The value overflows.
The component count in the definition for this tag is not 1.

open fun setValue(value: Rational): Boolean

Sets Rational values into this tag. This method should be used for tags of type TYPE_UNSIGNED_RATIONAL , or TYPE_RATIONAL . This method will fail if:

The component type of this tag is not TYPE_UNSIGNED_RATIONAL or TYPE_RATIONAL .
The value overflows.
The value.length does NOT match the component count in the definition for this tag.

open fun setValue(value: Array<Rational>): Boolean

Sets byte value into this tag. This method should be used for tags of type TYPE_UNSIGNED_BYTE or TYPE_UNDEFINED . This method will fail if:

The component type of this tag is not TYPE_UNSIGNED_BYTE or TYPE_UNDEFINED .
The component count in the definition for this tag is not 1.

open fun setValue(value: Byte): Boolean

Equivalent to setValue(value, 0, value.length).

open fun setValue(value: Array<Byte>): Boolean

Sets integer value into this tag. This method should be used for tags of type TYPE_UNSIGNED_SHORT , or TYPE_LONG . This method will fail if:

The component type of this tag is not TYPE_UNSIGNED_SHORT , TYPE_UNSIGNED_LONG , or TYPE_LONG .
The value overflows.
The component count in the definition of this tag is not 1.

open fun setValue(value: Int): Boolean

Sets integer values into this tag. This method should be used for tags of type TYPE_UNSIGNED_SHORT . This method will fail if:

The component type of this tag is not TYPE_UNSIGNED_SHORT , TYPE_UNSIGNED_LONG , or TYPE_LONG .
The value overflows.
The value.length does NOT match the component count in the definition for this tag.

open fun setValue(value: Array<Int>): Boolean

Sets the value for this tag using an appropriate setValue method for the given object. This method will fail if:

The corresponding setValue method for the class of the object passed in would fail.
There is no obvious way to cast the object passed in into an EXIF tag type.

open fun setValue(obj: Any): Boolean

Sets a string value into this tag. This method should be used for tags of type TYPE_ASCII . The string is converted to an ASCII string. Characters that cannot be converted are replaced with '?'. The length of the string must be equal to either (component count -1) or (component count). The final byte will be set to the string null terminator '\0', overwriting the last character in the string if the value.length is equal to the component count. This method will fail if:

The data type is not TYPE_ASCII or TYPE_UNDEFINED .
The length of the string is not equal to (component count -1) or (component count) in the definition for this tag.

open fun setValue(value: String): Boolean

Sets long values into this tag. This method should be used for tags of type TYPE_UNSIGNED_LONG . This method will fail if:

The component type of this tag is not TYPE_UNSIGNED_LONG .
The value overflows.
The component count in the definition for this tag is not 1.

open fun setValue(value: Long): Boolean

Sets long values into this tag. This method should be used for tags of type TYPE_UNSIGNED_LONG . This method will fail if:

The component type of this tag is not TYPE_UNSIGNED_LONG .
The value overflows.
The value.length does NOT match the component count in the definition for this tag.