ExifInterface

Artifact: androidx.exifinterface:exifinterface

View Source

Added in 1.0.0

---

Kotlin |Java

public class ExifInterface

---

This is a class for reading and writing Exif tags in various image file formats.

Supported for reading: JPEG, PNG, WebP, HEIC, DNG, CR2, NEF, NRW, ARW, RW2, ORF, PEF, SRW, RAF, AVIF (on API 31+).

Supported for writing: JPEG, PNG, WebP.

XMP Support

This class can read raw XMP data from the supported image file formats.

XMP data can be stored within Exif data (under tag 700), but many of the formats also define a separate storage location for XMP. ExifInterface handles this ambiguity as follows:

• JPEG
  • The XMP spec part 3 section 3.3.2 forbids the XMP tag (700) being present in the Exif segment of JPEG files (i.e. XMP should always be in a separate APP1 segment).
  • If XMP is present in both Exif and separate segments, the XMP from the Exif segment is returned from getAttributeBytes and modifications to the XMP with setAttribute are written back to the XMP in the Exif segment, the XMP in the separate segment is preserved unmodified. This is contrary to the spec described above (which suggests the standalone XMP should be preferred over the XMP in the Exif segment).
  • If XMP is not present in either location, and is added with setAttribute, it is written as a standalone segment, in line with the spec described above.
• HEIC &AVIF
  • If XMP is present in both Exif and separate segments, the XMP from the separate segment is returned from getAttributeBytes.

Summary

Constants
static final short	ALTITUDE_ABOVE_SEA_LEVEL = 0 The constant used by TAG_GPS_ALTITUDE_REF to denote the altitude is above sea level.
static final short	ALTITUDE_BELOW_SEA_LEVEL = 1 The constant used by TAG_GPS_ALTITUDE_REF to denote the altitude is below sea level.
static final int[]	BITS_PER_SAMPLE_GREYSCALE_1 The constant used by TAG_BITS_PER_SAMPLE.
static final int[]	BITS_PER_SAMPLE_GREYSCALE_2 The constant used by TAG_BITS_PER_SAMPLE.
static final int[]	BITS_PER_SAMPLE_RGB The constant used by TAG_BITS_PER_SAMPLE.
static final int	COLOR_SPACE_S_RGB = 1 The constant used by TAG_COLOR_SPACE to denote sRGB color space.
static final int	COLOR_SPACE_UNCALIBRATED = 65535 The constant used by TAG_COLOR_SPACE to denote Uncalibrated.
static final short	CONTRAST_HARD = 2 The constant used by TAG_CONTRAST to denote hard contrast.
static final short	CONTRAST_NORMAL = 0 The constant used by TAG_CONTRAST to denote normal contrast.
static final short	CONTRAST_SOFT = 1 The constant used by TAG_CONTRAST to denote soft contrast.
static final int	DATA_DEFLATE_ZIP = 8 The constant used by TAG_COMPRESSION, see DNG Specification 1.4.0.0.
static final int	DATA_HUFFMAN_COMPRESSED = 2 The constant used by TAG_COMPRESSION to denote the image is huffman compressed.
static final int	DATA_JPEG = 6 The constant used by TAG_COMPRESSION to denote the image is JPEG.
static final int	DATA_JPEG_COMPRESSED = 7 The constant used by TAG_COMPRESSION, see DNG Specification 1.4.0.0.
static final int	DATA_LOSSY_JPEG = 34892 The constant used by TAG_COMPRESSION, see DNG Specification 1.4.0.0.
static final int	DATA_PACK_BITS_COMPRESSED = 32773 The constant used by TAG_COMPRESSION to denote the image is pack-bits compressed.
static final int	DATA_UNCOMPRESSED = 1 The constant used by TAG_COMPRESSION to denote the image is not compressed.
static final short	EXPOSURE_MODE_AUTO = 0 The constant used by TAG_EXPOSURE_MODE to denote the exposure mode is Auto.
static final short	EXPOSURE_MODE_AUTO_BRACKET = 2 The constant used by TAG_EXPOSURE_MODE to denote the exposure mode is Auto bracket.
static final short	EXPOSURE_MODE_MANUAL = 1 The constant used by TAG_EXPOSURE_MODE to denote the exposure mode is Manual.
static final short	EXPOSURE_PROGRAM_ACTION = 6 The constant used by TAG_EXPOSURE_PROGRAM to denote exposure program is Action program (biased toward fast shutter speed).
static final short	EXPOSURE_PROGRAM_APERTURE_PRIORITY = 3 The constant used by TAG_EXPOSURE_PROGRAM to denote exposure program is Aperture priority.
static final short	EXPOSURE_PROGRAM_CREATIVE = 5 The constant used by TAG_EXPOSURE_PROGRAM to denote exposure program is Creative program (biased toward depth of field).
static final short	EXPOSURE_PROGRAM_LANDSCAPE_MODE = 8 The constant used by TAG_EXPOSURE_PROGRAM to denote exposure program is Landscape mode (for landscape photos with the background in focus).
static final short	EXPOSURE_PROGRAM_MANUAL = 1 The constant used by TAG_EXPOSURE_PROGRAM to denote exposure program is Manual.
static final short	EXPOSURE_PROGRAM_NORMAL = 2 The constant used by TAG_EXPOSURE_PROGRAM to denote exposure program is Normal.
static final short	EXPOSURE_PROGRAM_NOT_DEFINED = 0 The constant used by TAG_EXPOSURE_PROGRAM to denote exposure program is not defined.
static final short	EXPOSURE_PROGRAM_PORTRAIT_MODE = 7 The constant used by TAG_EXPOSURE_PROGRAM to denote exposure program is Portrait mode (for closeup photos with the background out of focus).
static final short	EXPOSURE_PROGRAM_SHUTTER_PRIORITY = 4 The constant used by TAG_EXPOSURE_PROGRAM to denote exposure program is Shutter priority.
static final short	FILE_SOURCE_DSC = 3 The constant used by TAG_FILE_SOURCE to denote the source is DSC.
static final short	FILE_SOURCE_OTHER = 0 The constant used by TAG_FILE_SOURCE to denote the source is other.
static final short	FILE_SOURCE_REFLEX_SCANNER = 2 The constant used by TAG_FILE_SOURCE to denote the source is scanner of reflex type.
static final short	FILE_SOURCE_TRANSPARENT_SCANNER = 1 The constant used by TAG_FILE_SOURCE to denote the source is scanner of transparent type.
static final short	FLAG_FLASH_FIRED = 1 The flag used by TAG_FLASH to indicate whether the flash is fired.
static final short	FLAG_FLASH_MODE_AUTO = 24 The flag used by TAG_FLASH to indicate the camera's flash mode is Auto.
static final short	FLAG_FLASH_MODE_COMPULSORY_FIRING = 8 The flag used by TAG_FLASH to indicate the camera's flash mode is Compulsory flash firing.
static final short	FLAG_FLASH_MODE_COMPULSORY_SUPPRESSION = 16 The flag used by TAG_FLASH to indicate the camera's flash mode is Compulsory flash suppression.
static final short	FLAG_FLASH_NO_FLASH_FUNCTION = 32 The flag used by TAG_FLASH to indicate no flash function is present.
static final short	FLAG_FLASH_RED_EYE_SUPPORTED = 64 The flag used by TAG_FLASH to indicate red-eye reduction is supported.
static final short	FLAG_FLASH_RETURN_LIGHT_DETECTED = 6 The flag used by TAG_FLASH to indicate strobe return light is detected.
static final short	FLAG_FLASH_RETURN_LIGHT_NOT_DETECTED = 4 The flag used by TAG_FLASH to indicate strobe return light is not detected.
static final short	FORMAT_CHUNKY = 1 The constant used by TAG_PLANAR_CONFIGURATION to denote Chunky format.
static final short	FORMAT_PLANAR = 2 The constant used by TAG_PLANAR_CONFIGURATION to denote Planar format.
static final short	GAIN_CONTROL_HIGH_GAIN_DOWN = 4 The constant used by TAG_GAIN_CONTROL to denote high gain down.
static final short	GAIN_CONTROL_HIGH_GAIN_UP = 2 The constant used by TAG_GAIN_CONTROL to denote high gain up.
static final short	GAIN_CONTROL_LOW_GAIN_DOWN = 3 The constant used by TAG_GAIN_CONTROL to denote low gain down.
static final short	GAIN_CONTROL_LOW_GAIN_UP = 1 The constant used by TAG_GAIN_CONTROL to denote low gain up.
static final short	GAIN_CONTROL_NONE = 0 The constant used by TAG_GAIN_CONTROL to denote none gain adjustment.
static final String	GPS_DIRECTION_MAGNETIC = "M" The constant used by GPS attributes to denote the direction is magnetic direction.
static final String	GPS_DIRECTION_TRUE = "T" The constant used by GPS attributes to denote the direction is true direction.
static final String	GPS_DISTANCE_KILOMETERS = "K" The constant used by TAG_GPS_DEST_DISTANCE_REF to denote the distance unit is kilometers.
static final String	GPS_DISTANCE_MILES = "M" The constant used by TAG_GPS_DEST_DISTANCE_REF to denote the distance unit is miles.
static final String	GPS_DISTANCE_NAUTICAL_MILES = "N" The constant used by TAG_GPS_DEST_DISTANCE_REF to denote the distance unit is nautical miles.
static final String	GPS_MEASUREMENT_2D = "2" The constant used by TAG_GPS_MEASURE_MODE to denote GPS measurement is 2-dimensional.
static final String	GPS_MEASUREMENT_3D = "3" The constant used by TAG_GPS_MEASURE_MODE to denote GPS measurement is 3-dimensional.
static final short	GPS_MEASUREMENT_DIFFERENTIAL_CORRECTED = 1 The constant used by TAG_GPS_DIFFERENTIAL to denote differential correction is applied.
static final String	GPS_MEASUREMENT_INTERRUPTED = "V" The constant used by TAG_GPS_STATUS to denote GPS measurement is interrupted.
static final String	GPS_MEASUREMENT_IN_PROGRESS = "A" The constant used by TAG_GPS_STATUS to denote GPS measurement is in progress.
static final short	GPS_MEASUREMENT_NO_DIFFERENTIAL = 0 The constant used by TAG_GPS_DIFFERENTIAL to denote no differential correction is applied.
static final String	GPS_SPEED_KILOMETERS_PER_HOUR = "K" The constant used by TAG_GPS_SPEED_REF to denote the speed unit is kilometers per hour.
static final String	GPS_SPEED_KNOTS = "N" The constant used by TAG_GPS_SPEED_REF to denote the speed unit is knots.
static final String	GPS_SPEED_MILES_PER_HOUR = "M" The constant used by TAG_GPS_SPEED_REF to denote the speed unit is miles per hour.
static final String	LATITUDE_NORTH = "N" The constant used by GPS latitude-related tags to denote the latitude is North latitude.
static final String	LATITUDE_SOUTH = "S" The constant used by GPS latitude-related tags to denote the latitude is South latitude.
static final short	LIGHT_SOURCE_CLOUDY_WEATHER = 10 The constant used by TAG_LIGHT_SOURCE to denote light source is Cloudy weather.
static final short	LIGHT_SOURCE_COOL_WHITE_FLUORESCENT = 14 The constant used by TAG_LIGHT_SOURCE to denote light source is Cool white fluorescent (W 3800 - 4500K).
static final short	LIGHT_SOURCE_D50 = 23 The constant used by TAG_LIGHT_SOURCE to denote light source is D50.
static final short	LIGHT_SOURCE_D55 = 20 The constant used by TAG_LIGHT_SOURCE to denote light source is D55.
static final short	LIGHT_SOURCE_D65 = 21 The constant used by TAG_LIGHT_SOURCE to denote light source is D65.
static final short	LIGHT_SOURCE_D75 = 22 The constant used by TAG_LIGHT_SOURCE to denote light source is D75.
static final short	LIGHT_SOURCE_DAYLIGHT = 1 The constant used by TAG_LIGHT_SOURCE to denote light source is Daylight.
static final short	LIGHT_SOURCE_DAYLIGHT_FLUORESCENT = 12 The constant used by TAG_LIGHT_SOURCE to denote light source is Daylight fluorescent (D 5700 - 7100K).
static final short	LIGHT_SOURCE_DAY_WHITE_FLUORESCENT = 13 The constant used by TAG_LIGHT_SOURCE to denote light source is Day white fluorescent (N 4600 - 5500K).
static final short	LIGHT_SOURCE_FINE_WEATHER = 9 The constant used by TAG_LIGHT_SOURCE to denote light source is Fine weather.
static final short	LIGHT_SOURCE_FLASH = 4 The constant used by TAG_LIGHT_SOURCE to denote light source is Flash.
static final short	LIGHT_SOURCE_FLUORESCENT = 2 The constant used by TAG_LIGHT_SOURCE to denote light source is Fluorescent.
static final short	LIGHT_SOURCE_ISO_STUDIO_TUNGSTEN = 24 The constant used by TAG_LIGHT_SOURCE to denote light source is ISO studio tungsten.
static final short	LIGHT_SOURCE_OTHER = 255 The constant used by TAG_LIGHT_SOURCE to denote light source is other.
static final short	LIGHT_SOURCE_SHADE = 11 The constant used by TAG_LIGHT_SOURCE to denote light source is Shade.
static final short	LIGHT_SOURCE_STANDARD_LIGHT_A = 17 The constant used by TAG_LIGHT_SOURCE to denote light source is Standard light A.
static final short	LIGHT_SOURCE_STANDARD_LIGHT_B = 18 The constant used by TAG_LIGHT_SOURCE to denote light source is Standard light B.
static final short	LIGHT_SOURCE_STANDARD_LIGHT_C = 19 The constant used by TAG_LIGHT_SOURCE to denote light source is Standard light C.
static final short	LIGHT_SOURCE_TUNGSTEN = 3 The constant used by TAG_LIGHT_SOURCE to denote light source is Tungsten (incandescent light).
static final short	LIGHT_SOURCE_UNKNOWN = 0 The constant used by TAG_LIGHT_SOURCE to denote light source is unknown.
static final short	LIGHT_SOURCE_WARM_WHITE_FLUORESCENT = 16 The constant used by TAG_LIGHT_SOURCE to denote light source is Warm white fluorescent (L 2600 - 3250K).
static final short	LIGHT_SOURCE_WHITE_FLUORESCENT = 15 The constant used by TAG_LIGHT_SOURCE to denote light source is White fluorescent (WW 3250 - 3800K).
static final String	LONGITUDE_EAST = "E" The constant used by GPS longitude-related tags to denote the longitude is East longitude.
static final String	LONGITUDE_WEST = "W" The constant used by GPS longitude-related tags to denote the longitude is West longitude.
static final short	METERING_MODE_AVERAGE = 1 The constant used by TAG_METERING_MODE to denote metering mode is Average.
static final short	METERING_MODE_CENTER_WEIGHT_AVERAGE = 2 The constant used by TAG_METERING_MODE to denote metering mode is CenterWeightedAverage.
static final short	METERING_MODE_MULTI_SPOT = 4 The constant used by TAG_METERING_MODE to denote metering mode is MultiSpot.
static final short	METERING_MODE_OTHER = 255 The constant used by TAG_METERING_MODE to denote metering mode is other.
static final short	METERING_MODE_PARTIAL = 6 The constant used by TAG_METERING_MODE to denote metering mode is Partial.
static final short	METERING_MODE_PATTERN = 5 The constant used by TAG_METERING_MODE to denote metering mode is Pattern.
static final short	METERING_MODE_SPOT = 3 The constant used by TAG_METERING_MODE to denote metering mode is Spot.
static final short	METERING_MODE_UNKNOWN = 0 The constant used by TAG_METERING_MODE to denote metering mode is unknown.
static final int	ORIENTATION_FLIP_HORIZONTAL = 2 Indicates the image is left right reversed mirror.
static final int	ORIENTATION_FLIP_VERTICAL = 4 Indicates the image is upside down mirror, it can also be represented by flip horizontally firstly and rotate 180 degree clockwise.
static final int	ORIENTATION_NORMAL = 1
static final int	ORIENTATION_ROTATE_180 = 3 Indicates the image is rotated by 180 degree clockwise.
static final int	ORIENTATION_ROTATE_270 = 8 Indicates the image is rotated by 270 degree clockwise.
static final int	ORIENTATION_ROTATE_90 = 6 Indicates the image is rotated by 90 degree clockwise.
static final int	ORIENTATION_TRANSPOSE = 5 Indicates the image is flipped about top-left <--> bottom-right axis, it can also be represented by flip horizontally firstly and rotate 270 degree clockwise.
static final int	ORIENTATION_TRANSVERSE = 7 Indicates the image is flipped about top-right <--> bottom-left axis, it can also be represented by flip horizontally firstly and rotate 90 degree clockwise.
static final int	ORIENTATION_UNDEFINED = 0
static final int	ORIGINAL_RESOLUTION_IMAGE = 0 The constant used by TAG_NEW_SUBFILE_TYPE.
static final int	PHOTOMETRIC_INTERPRETATION_BLACK_IS_ZERO = 1 The constant used by TAG_PHOTOMETRIC_INTERPRETATION.
static final int	PHOTOMETRIC_INTERPRETATION_RGB = 2 The constant used by TAG_PHOTOMETRIC_INTERPRETATION.
static final int	PHOTOMETRIC_INTERPRETATION_WHITE_IS_ZERO = 0 The constant used by TAG_PHOTOMETRIC_INTERPRETATION.
static final int	PHOTOMETRIC_INTERPRETATION_YCBCR = 6 The constant used by TAG_PHOTOMETRIC_INTERPRETATION.
static final int	REDUCED_RESOLUTION_IMAGE = 1 The constant used by TAG_NEW_SUBFILE_TYPE.
static final short	RENDERED_PROCESS_CUSTOM = 1 The constant used by TAG_CUSTOM_RENDERED to denote special processing is used.
static final short	RENDERED_PROCESS_NORMAL = 0 The constant used by TAG_CUSTOM_RENDERED to denote no special processing is used.
static final short	RESOLUTION_UNIT_CENTIMETERS = 3 The constant used to denote resolution unit as centimeters.
static final short	RESOLUTION_UNIT_INCHES = 2 The constant used to denote resolution unit as inches.
static final short	SATURATION_HIGH = 0 The constant used by TAG_SHARPNESS to denote high saturation.
static final short	SATURATION_LOW = 0 The constant used by TAG_SATURATION to denote low saturation.
static final short	SATURATION_NORMAL = 0 The constant used by TAG_SATURATION to denote normal saturation.
static final short	SCENE_CAPTURE_TYPE_LANDSCAPE = 1 The constant used by TAG_SCENE_CAPTURE_TYPE to denote the scene capture type is Landscape.
static final short	SCENE_CAPTURE_TYPE_NIGHT = 3 The constant used by TAG_SCENE_CAPTURE_TYPE to denote the scene capture type is Night scene.
static final short	SCENE_CAPTURE_TYPE_PORTRAIT = 2 The constant used by TAG_SCENE_CAPTURE_TYPE to denote the scene capture type is Portrait.
static final short	SCENE_CAPTURE_TYPE_STANDARD = 0 The constant used by TAG_SCENE_CAPTURE_TYPE to denote the scene capture type is Standard.
static final short	SCENE_TYPE_DIRECTLY_PHOTOGRAPHED = 1 The constant used by TAG_SCENE_TYPE to denote the scene is directly photographed.
static final short	SENSITIVITY_TYPE_ISO_SPEED = 3 The constant used by TAG_SENSITIVITY_TYPE to denote sensitivity type is ISO speed.
static final short	SENSITIVITY_TYPE_REI = 2 The constant used by TAG_SENSITIVITY_TYPE to denote sensitivity type is Recommended exposure index (REI).
static final short	SENSITIVITY_TYPE_REI_AND_ISO = 6 The constant used by TAG_SENSITIVITY_TYPE to denote sensitivity type is Recommended exposure index (REI) and ISO speed.
static final short	SENSITIVITY_TYPE_SOS = 1 The constant used by TAG_SENSITIVITY_TYPE to denote sensitivity type is Standard output sensitivity (SOS).
static final short	SENSITIVITY_TYPE_SOS_AND_ISO = 5 The constant used by TAG_SENSITIVITY_TYPE to denote sensitivity type is Standard output sensitivity (SOS) and ISO speed.
static final short	SENSITIVITY_TYPE_SOS_AND_REI = 4 The constant used by TAG_SENSITIVITY_TYPE to denote sensitivity type is Standard output sensitivity (SOS) and recommended exposure index (REI).
static final short	SENSITIVITY_TYPE_SOS_AND_REI_AND_ISO = 7 The constant used by TAG_SENSITIVITY_TYPE to denote sensitivity type is Standard output sensitivity (SOS) and recommended exposure index (REI) and ISO speed.
static final short	SENSITIVITY_TYPE_UNKNOWN = 0 The constant used by TAG_SENSITIVITY_TYPE to denote sensitivity type is unknown.