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

ExifTagInfo

class 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 Exify#buildTag.

See Also
Exify

Functions

equals	`fun equals(obj: java.lang.Object): boolean`
forceGetValueAsLong	`fun forceGetValueAsLong(defaultValue: long): long` Gets a long representation of the value.
forceGetValueAsString	`fun forceGetValueAsString(): java.lang.String` Gets a string representation of the value.
forceSetComponentCount	`fun forceSetComponentCount(count: int): void` Sets the component count of this tag. Call this function before setValue() if the length of value does not match the component count.
getBytes	`fun getBytes(buf: kotlin.Array<byte>): void` Equivalent to getBytes(buffer, 0, buffer.length). `fun getBytes(buf: kotlin.Array<byte>, offset: int, length: int): void` Gets the `#TYPE_UNDEFINED` or `#TYPE_UNSIGNED_BYTE` data.
getComponentCount	`fun getComponentCount(): int` Gets the component count of this tag.
getDataSize	`fun getDataSize(): int` Gets the total data size in bytes of the value of this tag.
getDataType	`fun getDataType(): short` Gets the data type of this tag
getElementSize	`static fun getElementSize(type: short): int` Gets the element size of the given data type in bytes.
getIfd	`fun getIfd(): int` Returns the ID of the IFD this tag belongs to.
getOffset	`fun getOffset(): int` Gets the offset of this tag. This is only valid if this data size > 4 and contains an offset to the location of the actual value.
getRational	`fun getRational(index: int): Rational` Gets the `#TYPE_RATIONAL` or `#TYPE_UNSIGNED_RATIONAL` data.
getString	`fun getString(): java.lang.String` Gets the `#TYPE_ASCII` data.
getStringByte	`fun getStringByte(): kotlin.Array<byte>`
getTagId	`fun getTagId(): short` Gets the TID of this tag.
getValue	`fun getValue(): java.lang.Object` Gets the tag's value or null if none exists.
getValueAsByte	`fun getValueAsByte(defaultValue: byte): byte` 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`.
getValueAsBytes	`fun getValueAsBytes(): kotlin.Array<byte>` Gets the value as a byte array. This method should be used for tags of type `#TYPE_UNDEFINED` or `#TYPE_UNSIGNED_BYTE`.
getValueAsInt	`fun getValueAsInt(defaultValue: int): int` 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`.
getValueAsInts	`fun getValueAsInts(): kotlin.Array<int>` Gets the value as an array of ints. This method should be used for tags of type `#TYPE_UNSIGNED_SHORT`, `#TYPE_UNSIGNED_LONG`.
getValueAsLong	`fun getValueAsLong(defaultValue: long): long` 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`.
getValueAsLongs	`fun getValueAsLongs(): kotlin.Array<long>` Gets the value as an array of longs. This method should be used for tags of type `#TYPE_UNSIGNED_LONG`.
getValueAsRational	`fun getValueAsRational(defaultValue: long): Rational` `fun getValueAsRational(defaultValue: Rational): Rational` 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`.
getValueAsRationals	`fun getValueAsRationals(): kotlin.Array<Rational>` Gets the value as an array of Rationals. This method should be used for tags of type `#TYPE_RATIONAL` or `#TYPE_UNSIGNED_RATIONAL`.
getValueAsString	`fun getValueAsString(defaultValue: java.lang.String): java.lang.String` `fun getValueAsString(): java.lang.String` Gets the value as a String. This method should be used for tags of type `#TYPE_ASCII`.
getValueAt	`fun getValueAt(index: int): long` Gets the value for type `#TYPE_ASCII`, `#TYPE_LONG`, `#TYPE_UNDEFINED`, `#TYPE_UNSIGNED_BYTE`, `#TYPE_UNSIGNED_LONG`, or `#TYPE_UNSIGNED_SHORT`. For `#TYPE_RATIONAL` or `#TYPE_UNSIGNED_RATIONAL`, call `#getRational(int)` instead.
hasDefinedCount	`fun hasDefinedCount(): boolean`
hasValue	`fun hasValue(): boolean` Returns true if this ExifTag contains value; otherwise, this tag will contain an offset value that is determined when the tag is written.
isValidIfd	`static fun isValidIfd(ifdId: int): boolean` Returns true if the given IFD is a valid IFD.
isValidType	`static fun isValidType(type: short): boolean` Returns true if a given type is a valid tag type.
setHasDefinedCount	`fun setHasDefinedCount(d: boolean): void`
setIfd	`fun setIfd(ifdId: int): void`
setOffset	`fun setOffset(offset: int): void` Sets the offset of this tag.
setTimeValue	`fun setTimeValue(time: long): boolean` Sets a timestamp to this tag. The method converts the timestamp with the format of "yyyy:MM:dd kk:mm:ss" and calls `#setValue(String)`. This method will fail if the data type is not `#TYPE_ASCII` or the component count of this tag is not 20 or undefined.
setValue	`fun setValue(value: kotlin.Array<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. `fun setValue(value: int): 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. `fun setValue(value: kotlin.Array<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. `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 component count in the definition for this tag is not 1. `fun setValue(value: kotlin.Array<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. `fun setValue(value: Rational): boolean` 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. `fun setValue(value: kotlin.Array<byte>, offset: int, length: int): boolean` Sets byte values 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 length does NOT match the component count in the definition for this tag. `fun setValue(value: kotlin.Array<byte>): boolean` Equivalent to setValue(value, 0, value.length). `fun setValue(value: byte): 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. `fun setValue(obj: java.lang.Object): 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. `fun setValue(value: java.lang.String): 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.
toString	`fun toString(): java.lang.String`

Other members

TYPE_ASCII	`TYPE_ASCII` The ASCII type in the EXIF standard. An 8-bit byte containing one 7-bit ASCII code. The final byte is terminated with NULL.
TYPE_LONG	`TYPE_LONG` The SLONG type in the EXIF standard. A 32-bit (4-byte) signed integer (2's complement notation).
TYPE_RATIONAL	`TYPE_RATIONAL` The SRATIONAL type of EXIF standard. It consists of two SLONGs. The first one is the numerator and the second one is the denominator.
TYPE_UNDEFINED	`TYPE_UNDEFINED` The UNDEFINED type in the EXIF standard. An 8-bit byte that can take any value depending on the field definition.
TYPE_UNSIGNED_BYTE	`TYPE_UNSIGNED_BYTE` The BYTE type in the EXIF standard. An 8-bit unsigned integer.
TYPE_UNSIGNED_LONG	`TYPE_UNSIGNED_LONG` The LONG type in the EXIF standard. A 32-bit (4-byte) unsigned integer
TYPE_UNSIGNED_RATIONAL	`TYPE_UNSIGNED_RATIONAL` The RATIONAL type of EXIF standard. It consists of two LONGs. The first one is the numerator and the second one expresses the denominator.
TYPE_UNSIGNED_SHORT	`TYPE_UNSIGNED_SHORT` The SHORT type in the EXIF standard. A 16-bit (2-byte) unsigned integer