Enums
NOTE
The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
PixelMapFormat7+
Enumerates the pixel formats of images.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| UNKNOWN | 0 | Unknown format. Atomic service API: This API can be used in atomic services since API version 11. Widget capability: This API can be used in ArkTS widgets since API version 12. |
| ARGB_888818+ | 1 | The color information consists of four components: alpha, R (Red), G (Green), and B (Blue). Each component occupies 8 bits, and the total length is 32 bits. Currently, this format supports only PixelMap APIs. |
| RGB_565 | 2 | The color information consists of three components: R (Red), G (Green), and B (Blue), which occupies five bits, six bits, and five bits, respectively. The total length is 16 bits. Atomic service API: This API can be used in atomic services since API version 11. Widget capability: This API can be used in ArkTS widgets since API version 12. |
| RGBA_8888 | 3 | The color information consists of four components: R (Red), G (Green), B (Blue), and alpha. Each component occupies 8 bits, and the total length is 32 bits. It corresponds to CAMERA_FORMAT_RGBA_8888 in CameraFormat. Atomic service API: This API can be used in atomic services since API version 11. Widget capability: This API can be used in ArkTS widgets since API version 12. |
| BGRA_88889+ | 4 | The color information consists of four components: B (Blue), G (Green), R (Red), and alpha. Each component occupies 8 bits, and the total length is 32 bits. Atomic service API: This API can be used in atomic services since API version 11. Widget capability: This API can be used in ArkTS widgets since API version 12. |
| RGB_8889+ | 5 | The color information consists of three components: R (Red), G (Green), and B (Blue). Each component occupies 8 bits, and the total length is 24 bits. Atomic service API: This API can be used in atomic services since API version 11. Widget capability: This API can be used in ArkTS widgets since API version 12. |
| ALPHA_89+ | 6 | The color information consists of only the alpha component, which occupies eight bits. Each row of pixels is composed of one or more pixels, and the data for each row is aligned to 4 bytes. If the byte count of a row is not a multiple of 4, blank bytes are padded at the end to ensure proper alignment. Atomic service API: This API can be used in atomic services since API version 11. Widget capability: This API can be used in ArkTS widgets since API version 12. |
| RGBA_F169+ | 7 | The color information consists of four components: R (Red), G (Green), B (Blue), and alpha. Each component occupies 16 bits, and the total length is 64 bits. Atomic service API: This API can be used in atomic services since API version 11. Widget capability: This API can be used in ArkTS widgets since API version 12. |
| NV219+ | 8 | YVU pixel arrangement, where the V component precedes the U component. The color information consists of the luminance component Y and the interleaved chrominance components V and U. The Y component occupies 8 bits, and the UV components occupy 4 bits on average due to 4:2:0 sampling. The total length is 12 bits on average. It corresponds to CAMERA_FORMAT_YUV_420_SP in CameraFormat. Atomic service API: This API can be used in atomic services since API version 11. Widget capability: This API can be used in ArkTS widgets since API version 12. |
| NV129+ | 9 | YUV pixel arrangement, where the U component precedes the V component. The color information consists of the luminance component Y and the interleaved chrominance components U and V. The Y component occupies 8 bits, and the UV components occupy 4 bits on average due to 4:2:0 sampling. The total length is 12 bits on average. Atomic service API: This API can be used in atomic services since API version 11. Widget capability: This API can be used in ArkTS widgets since API version 12. |
| RGBA_101010212+ | 10 | The color information consists of four components: R (Red), G (Green), B (Blue), and alpha. R, G, and B each occupy 10 bits, and alpha occupies 2 bits. The total length is 32 bits. |
| YCBCR_P01012+ | 11 | The color information consists of the luminance component Y and the chrominance components Cb and Cr. Each component has effective 10 bits. In storage, the Y plane uses 16 bits per pixel (10 of which are effective). The UV plane is interleaved, with every four pixels taking up 32 bits of data (each chrominance component having 10 effective bits), resulting in an average of 15 effective bits overall. It corresponds to CAMERA_FORMAT_YCBCR_P010 in CameraFormat. |
| YCRCB_P01012+ | 12 | The color information consists of the luminance component Y and the chrominance components Cr and Cb. Each component has effective 10 bits. In storage, the Y plane uses 16 bits per pixel (10 of which are effective). The UV plane is interleaved, with every four pixels taking up 32 bits of data (each chrominance component having 10 effective bits), resulting in an average of 15 effective bits overall. It corresponds to CAMERA_FORMAT_YCRCB_P010 in CameraFormat. |
| ASTC_4x418+ | 102 | The storage format is ASTC_4x4, and the memory usage is only 1/4 of that of RGBA_8888. This format is intended for direct display scenarios. It does not support pixel access or editing in post-processing, and does not support cascaded affine transformations. |
AlphaType9+
Enumerates the alpha types of images.
Widget capability: This API can be used in ArkTS widgets since API version 12.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| UNKNOWN | 0 | Unknown alpha type. |
| OPAQUE | 1 | There is no alpha or the image is opaque. |
| PREMUL | 2 | Premultiplied alpha. |
| UNPREMUL | 3 | RGB non-premultiplied alpha. |
AuxiliaryPictureType13+
Enumerates the auxiliary pictures types.
Auxiliary pictures do not directly participate in image display, and not all images contain auxiliary pictures.
Before obtaining and using a specific auxiliary picture, call getAuxiliaryPicture in Picture to obtain the auxiliary picture.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| GAINMAP | 1 | Gain map. It is used to generate HDR images more accurately. HDR synthesis usually involves using the SDR main image, gain map, and HDR metadata to calculate the luminance mapping. |
| DEPTH_MAP | 2 | Depth map. It is used to store the distance between each pixel and the camera, and provides the 3D structure of the scene. It is useful for tasks like 3D reconstruction, background separation, and scene understanding. |
| UNREFOCUS_MAP | 3 | Unrefocus map. It is used to store the pixel content that is not refocused during capture. It is useful for post-processing effects such as portrait blurring, allowing users to select focus areas freely. |
| LINEAR_MAP | 4 | Linear map. It records lighting, color, or other visual elements linearly, providing additional data for image processing. It is useful for visual effect enhancement and color post-processing. |
| FRAGMENT_MAP | 5 | Fragment map. It records areas of the original image obscured by watermarks. These areas might be cropped from the original image or filled with placeholder pixel data. It is useful for watermark removal and original image restoration. |
MetadataType13+
Enumerates image metadata types.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| EXIF_METADATA | 1 | Exif data. |
| FRAGMENT_METADATA | 2 | Fragment map metadata. |
| GIF_METADATA20+ | 5 | GIF image metadata. |
| HEIFS_METADATA23+ | 15 | HEIF image sequence metadata. Model restriction: This API can be used only in the stage model. |
| DNG_METADATA24+ | 16 | DNG image metadata. Model restriction: This API can be used only in the stage model. |
| WEBP_METADATA24+ | 17 | WebP image metadata. Model restriction: This API can be used only in the stage model. |
| PNG_METADATA | 19 | PNG image metadata. Model restriction: This API can be used only in the stage model. Since: 26.0.0 |
| JFIF_METADATA | 20 | JFIF image metadata. Model restriction: This API can be used only in the stage model. Since: 26.0.0 |
| TIFF_METADATA | 21 | TIFF image metadata. Model restriction: This API can be used only in the stage model. Since: 26.0.0 |
ScaleMode9+
Enumerates the scale modes of images.
Widget capability: This API can be used in ArkTS widgets since API version 12.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| CENTER_CROP | 1 | Scales the image so that it fills the requested bounds of the target and crops the extra. |
| FIT_TARGET_SIZE | 0 | Reduces the image size to the dimensions of the target. |
PropertyKey7+
Enumerates the types of Exchangeable Image File Format (Exif) data of an image.
- The key in the format example is image.PropertyKey.XXX (where XXX is the name of an enumeration, for example, NEW_SUBFILE_TYPE).
- The format example is used only to show how to modify values and read results. For details about how to use them, see modifyImageProperty (to modify a single Exif field), modifyImageProperties (to modify multiple Exif fields), getImageProperty (to read a single Exif field), and getImageProperties (to read multiple Exif fields).
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description | Format Example |
|---|---|---|---|
| NEW_SUBFILE_TYPE12+ | "NewSubfileType" | In the Exif, the NewSubfileType field is used to identify the data type of a subfile, for example, full-resolution image, thumbnail, or part of a multi-frame image. The value is a bit mask. The value 0 indicates a full-resolution image, 1 indicates a thumbnail, and 2 indicates a part of a multi-frame image. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Primary image');Example of read result: "0" |
| SUBFILE_TYPE12+ | "SubfileType" | Type of data contained in this subfile. This tag has been deprecated. Use NewSubfileType instead. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Full-resolution image data');Example of read result: "1" |
| IMAGE_WIDTH | "ImageWidth" | Image width. The unit is px. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'4096');Example of read result: "4096" |
| IMAGE_LENGTH | "ImageLength" | Image length. The unit is px. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'3072');Example of read result: "3072" |
| BITS_PER_SAMPLE | "BitsPerSample" | Number of bits per sample. For example, for RGB, which has three components, the format is 8,8,8. Read/Write capability: readable and writable. |
How to modify the parameter: Use three non-negative integers, separated by spaces or commas (,), as a string. Example of modification: imageSource.modifyImageProperty(key,'8 8 8');or imageSource.modifyImageProperty(key,'8,8,8');Example of read result: "8,8,8" |
| COMPRESSION12+ | "Compression" | Compression scheme used on the image data. 1: "Uncompressed" 2: "CCITT RLE" 3: "T4/Group 3 Fax" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Uncompressed');Example of read result: "Uncompressed" |
| PHOTOMETRIC_INTERPRETATION12+ | "PhotometricInterpretation" | Color space of the image data, for example, RGB or YCbCr. 0: "Reversed mono" 1: "Normal mono" 2: "RGB" 3: "Palette" 5: "CMYK" 6: "YCbCr" 8: "CieLAB" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Normal mono');Example of read result: "Normal mono" |
| IMAGE_DESCRIPTION10+ | "ImageDescription" | Image description. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Image description info');Example of read result: "Image description info" |
| MAKE10+ | "Make" | Manufacturer. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Make');Example of read result: "Make" |
| MODEL10+ | "Model" | Device model. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Model');Example of read result: "Model" |
| STRIP_OFFSETS12+ | "StripOffsets" | Byte offset of each strip. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'100');Example of read result: "100" |
| ORIENTATION | "Orientation" | Image orientation. 1: "Top-left" (Image not rotated) 2: "Top-right" (Image flipped horizontally) 3: "Bottom-right" (Image rotated by 180°) 4: "Bottom-left" (Image flipped vertically) 5: "Left-top" (Image flipped horizontally and then rotated clockwise by 270°) 6: "Right-top" (Image rotated clockwise by 90°) 7: "Right-bottom" (Image flipped vertically and then rotated clockwise by 90°) 8: "Left-bottom" (Image rotated clockwise by 270°) If an undefined value x is read, Unknown Value x is returned. The value of the property obtained is returned as a string. When modifying the property, you can specify the property either in the form of a number or a string. For details about the image rotation angle, see Obtaining the Rotation Angle of an Image. Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Top-left');Example of read result: "Top-left" |
| SAMPLES_PER_PIXEL12+ | "SamplesPerPixel" | Number of components per pixel. The value is 3 for RGB and YCbCr images. The JPEG key is used in JPEG compressed data. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'3');Example of read result: "3" |
| ROWS_PER_STRIP12+ | "RowsPerStrip" | Number of rows per strip. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'10');Example of read result: "10" |
| STRIP_BYTE_COUNTS12+ | "StripByteCounts" | Number of bytes in each strip after compression. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'1024');Example of read result: "1024" |
| X_RESOLUTION12+ | "XResolution" | Number of pixels per ResolutionUnit in the image width (X) direction. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'72');Example of read result: "72" |
| Y_RESOLUTION12+ | "YResolution" | Number of pixels per ResolutionUnit in the image height (Y) direction. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'72');Example of read result: "72" |
| PLANAR_CONFIGURATION12+ | "PlanarConfiguration" | Storage format of components of each pixel, which can be chunky or planar. 1: "Chunky format" 2: "Planar format" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Chunky format');Example of read result: "Chunky format" |
| RESOLUTION_UNIT12+ | "ResolutionUnit" | Unit of measurement for XResolution and YResolution, in inches or centimeters. 2: "Inch" 3: "Centimeter" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'2');or imageSource.modifyImageProperty(key,'Inch');Example of read result: "Inch" |
| TRANSFER_FUNCTION12+ | "TransferFunction" | Transfer function for the image, which is usually used for color correction. Read/Write capability: readable and writable. |
This field is in a special format. Although it can be read and written, it is not parsed in the current version. |
| SOFTWARE12+ | "Software" | Name and version number of the software used to create the image. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Software name and version');Example of read result: "Software name and version" |
| DATE_TIME10+ | "DateTime" | Date and time of image creation. Read/Write capability: readable and writable. |
How to modify the parameter: Use either YYYY:MM:DD or YYYY:MM:DD HH:MM:SS. Example of modification: imageSource.modifyImageProperty(key,'2024:07:07 13:45:59');or imageSource.modifyImageProperty(key,'2024:07:07');Example of read result: "2024:07:07 13:45:59" or "2024:07:07" |
| ARTIST12+ | "Artist" | Person who created the image. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'User name');Example of read result: "User name" |
| WHITE_POINT12+ | "WhitePoint" | Chromaticity coordinates of the white point, the reference for "white", in the color space of the image. Read/Write capability: readable and writable. |
How to modify the parameter: Use two non-negative rational numbers, separated by spaces or commas (,), as a string. Example of modification: imageSource.modifyImageProperty(key,'1,2');or imageSource.modifyImageProperty(key,'1 2');Example of read result: "1,2" |
| PRIMARY_CHROMATICITIES12+ | "PrimaryChromaticities" | Chromaticities of the primaries of the image. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'2/1');Example of read result: "0.5" |
| PHOTO_MODE10+ | "PhotoMode" | Photographing mode. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'1');Example of read result: "1" |
| JPEG_INTERCHANGE_FORMAT12+ | "JPEGInterchangeFormat" | Offset of the SOI marker of a JPEG interchange format bitstream. Read/Write capability: read-only |
Example of read result: "1024" |
| JPEG_INTERCHANGE_FORMAT_LENGTH12+ | "JPEGInterchangeFormatLength" | Number of bytes of the JPEG stream. Read/Write capability: read-only |
Example of read result: "1024" |
| YCBCR_COEFFICIENTS12+ | "YCbCrCoefficients" | Coefficients for the conversion matrix that transforms image data from RGB to YCbCr. Read/Write capability: readable and writable. |
How to modify the parameter: Use three non-negative rational numbers, with a total sum of 1, as a string. Example of modification: imageSource.modifyImageProperty(key,'0.299, 0.587, 0.114');Example of read result: "0.299, 0.587, 0.114" |
| YCBCR_SUB_SAMPLING12+ | "YCbCrSubSampling" | Subsampling factors used for the chrominance components of a YCbCr image. Read/Write capability: readable and writable. |
How to modify the parameter: Use two non-negative integers, separated by spaces or commas (,), as a string. Example of modification: imageSource.modifyImageProperty(key,'2,2');or imageSource.modifyImageProperty(key,'2 2');Example of read result: "2,2" |
| YCBCR_POSITIONING12+ | "YCbCrPositioning" | Positioning of subsampled chrominance components relative to luminance samples. 1: "Centered" (Cb/Cr chrominance samples are center-aligned with luma pixels, which is a common practice.) 2: "Co-sited" (Cb/Cr chrominance samples are top-left aligned with Y samples.) Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Centered');Example of read result: "Centered" |
| REFERENCE_BLACK_WHITE12+ | "ReferenceBlackWhite" | Reference values for black and white points. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1');Example of read result: "1,255, 0,255, 0,255" |
| COPYRIGHT12+ | "Copyright" | Copyright notice of the image. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'desc');Example of read result: "desc (Photographer) - [None] (Editor)" |
| EXPOSURE_TIME9+ | "ExposureTime" | Exposure time. The unit is seconds. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'1/2');Example of read result: "1/33 sec." |
| F_NUMBER9+ | "FNumber" | F number, for example, f/1.8. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'1/2');Example of read result: "f/1.0" |
| EXPOSURE_PROGRAM12+ | "ExposureProgram" | Class of the program used by the camera to set exposure when the image was captured. 0: "Not defined" 1: "Manual" 2: "Normal program" 3: "Aperture priority" 4: "Shutter priority" 5: "Creative program (biased toward depth of field)" 6: "Creative program (biased toward fast shutter speed)" 7: "Portrait mode (for closeup photos with the background out of focus)" 8: "Landscape mode (for landscape photos with the background in focus)" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Not defined');Example of read result: "Not defined" |
| SPECTRAL_SENSITIVITY12+ | "SpectralSensitivity" | Spectral sensitivity of each channel of the camera. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'SpectralSensitivity');Example of read result: "SpectralSensitivity" |
| GPS_VERSION_ID12+ | "GPSVersionID" | GPS information version. Read/Write capability: readable and writable. |
How to modify the parameter: Use four non-negative integers, separated by decimal points (.), as a string. Example of modification: imageSource.modifyImageProperty(key,'2.3.0.0');Example of read result: "2.3.0.0" |
| GPS_LATITUDE_REF | "GPSLatitudeRef" | Latitude reference (Northern or Southern Hemisphere) of the image capture location. 78: "North" 83: "South" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'78');or imageSource.modifyImageProperty(key,'North');Example of read result: "N" or "78" |
| GPS_LATITUDE | "GPSLatitude" | Image latitude. The value must be in the format of degree,minute,second, for example, 39,54,7.542. Read/Write capability: readable and writable. |
How to modify the parameter: Use three non-negative rational number strings, separated by commas (,). Example of modification: imageSource.modifyImageProperty(key,'39,54,7.542');Example of read result: "39,54,7.542" |
| GPS_LONGITUDE_REF | "GPSLongitudeRef" | Longitude reference (Eastern or Western Hemisphere) of the image capture location. 69: "East" 87: "West" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'69');or imageSource.modifyImageProperty(key,'East');Example of read result: "69" or "E" |
| GPS_LONGITUDE | "GPSLongitude" | Image longitude. The value must be in the format of degree,minute,second, for example, 116,19,42.16. Read/Write capability: readable and writable. |
How to modify the parameter: Use three non-negative rational number strings, separated by commas (,). Example of modification: imageSource.modifyImageProperty(key,'116,19,42.16');Example of read result: "116,19,42.16" |
| GPS_ALTITUDE_REF12+ | "GPSAltitudeRef" | Whether the latitude is north or south latitude. 0: "Sea level" (Above sea level) 1: "Sea level reference" (Below sea level) Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Sea level');Example of read result: "Sea level" |
| GPS_ALTITUDE12+ | "GPSAltitude" | Altitude based on the reference in GPSAltitudeRef. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'123.45');Example of read result: "123.45" |
| GPS_TIME_STAMP10+ | "GPSTimeStamp" | GPS timestamp. Read/Write capability: readable and writable. |
How to modify the parameter: Use the format HH:mm:ss.ddd. Example of modification: imageSource.modifyImageProperty(key,'12:30:30.123');Example of read result: "12:30:30.123" |
| GPS_SATELLITES12+ | "GPSSatellites" | GPS satellites used for measurement. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'GPS Satellites');Example of read result: "GPSSatellites" |
| GPS_STATUS12+ | "GPSStatus" | Status of the GPS receiver when the image was recorded. 'A': "Measurement in progress" (GPS is working, satellite signals are locked, and location data is trustworthy.) 'V': "Measurement interrupted" (GPS is not working, positioning is unavailable currently, and location data may be missing or incorrect.) Read/Write capability: readable and writable. |
How to modify the parameter: Use letters or strings. Example of modification: imageSource.modifyImageProperty(key,'A');or imageSource.modifyImageProperty(key,'Measurement in progress');Example of read result: "A" |
| GPS_MEASURE_MODE12+ | "GPSMeasureMode" | GPS measurement pmode. Whether the 2D (planar) or 3D (with height) measurement mode is used for GPS positioning. 2: "2-dimensional measurement" (Latitude+longitude) 3: "3-dimensional measurement" (Latitude + longitude + altitude) Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'2');or imageSource.modifyImageProperty(key,'2-dimensional measurement');Example of read result: "2" |
| GPS_DOP12+ | "GPSDOP" | GPS Dilution of Precision (DOP), which reflects the precision of GPS measurements taken when the photo was captured. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1.5');Example of read result: "1.5" |
| GPS_SPEED_REF12+ | "GPSSpeedRef" | Unit used to express the movement speed of the GPS receiver. 'K': "km/h" 'M': "mph" 'N': "knots" Read/Write capability: readable and writable. |
How to modify the parameter: Use letters or strings. Example of modification: imageSource.modifyImageProperty(key,'K');or imageSource.modifyImageProperty(key,'km/h');Example of read result: "K" |
| GPS_SPEED12+ | "GPSSpeed" | Movement speed of the GPS receiver. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'123');or imageSource.modifyImageProperty(key,'123.45');Example of read result: "123.45" |
| GPS_TRACK_REF12+ | "GPSTrackRef" | Which type of "North" is used as the reference for the direction angle. 'T': "True direction" (True north: direction to the geographic North Pole, suitable for mapping and navigation.) 'M': "Magnetic direction" (Magnetic north: Influenced by the Earth's magnetic field, the magnetic declination varies by region and over time.) Read/Write capability: readable and writable. |
How to modify the parameter: Use letters or strings. Example of modification: imageSource.modifyImageProperty(key,'T');or imageSource.modifyImageProperty(key,'True direction');Example of read result: "T" |
| GPS_TRACK12+ | "GPSTrack" | Movement direction of the GPS receiver. Direction of movement (heading) of the camera at the moment the photo was taken, measured in degrees. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'180');Example of read result: "180" |
| GPS_IMG_DIRECTION_REF12+ | "GPSImgDirectionRef" | Reference of the direction of the image when it was captured. 'T': "True direction" (True north: direction to the geographic North Pole, suitable for mapping and navigation.) 'M': "Magnetic direction" (Magnetic north: Influenced by the Earth's magnetic field, the magnetic declination varies by region and over time.) Read/Write capability: readable and writable. |
How to modify the parameter: Use letters or strings. Example of modification: imageSource.modifyImageProperty(key,'T');or imageSource.modifyImageProperty(key,'True direction');Example of read result: "T" |
| GPS_IMG_DIRECTION12+ | "GPSImgDirection" | Direction of the image when it was captured. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'120');Example of read result: "120" |
| GPS_MAP_DATUM12+ | "GPSMapDatum" | Geodetic survey data used by the GPS receiver. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'GPS Map Datum');Example of read result: "GPS Map Datum" |
| GPS_DEST_LATITUDE_REF12+ | "GPSDestLatitudeRef" | Whether the latitude of the destination point is north or south latitude. 78: "North" 83: "South" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'78');or imageSource.modifyImageProperty(key,'North');Example of read result: "78" |
| GPS_DEST_LATITUDE12+ | "GPSDestLatitude" | Latitude of the destination point. Read/Write capability: readable and writable. |
How to modify the parameter: Use three non-negative integers, separated by spaces or commas (,), as a string. Example of modification: imageSource.modifyImageProperty(key,'39,54,7');or imageSource.modifyImageProperty(key,'39 54 7');Example of read result: "39,54,7" |
| GPS_DEST_LONGITUDE_REF12+ | "GPSDestLongitudeRef" | Whether the longitude of the destination point is east or west longitude. 69: "East" 87: "West" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'69');or imageSource.modifyImageProperty(key,'East');Example of read result: "69" |
| GPS_DEST_LONGITUDE12+ | "GPSDestLongitude" | Longitude of the destination point. Read/Write capability: readable and writable. |
How to modify the parameter: Use three non-negative integers, separated by spaces or commas (,), as a string. Example of modification: imageSource.modifyImageProperty(key,'116,19,42');or imageSource.modifyImageProperty(key,'116 19 42');Example of read result: "116,19,42" |
| GPS_DEST_BEARING_REF12+ | "GPSDestBearingRef" | Reference of the bearing to the destination point. 'T': "True direction" (True north: direction to the geographic North Pole, suitable for mapping and navigation.) 'M': "Magnetic direction" (Magnetic north: Influenced by the Earth's magnetic field, the magnetic declination varies by region and over time.) Read/Write capability: readable and writable. |
How to modify the parameter: Use letters or strings. Example of modification: imageSource.modifyImageProperty(key,'T');or imageSource.modifyImageProperty(key,'True direction');Example of read result: "T" |
| GPS_DEST_BEARING12+ | "GPSDestBearing" | Bearing to the destination point. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'120');Example of read result: "120" |
| GPS_DEST_DISTANCE_REF12+ | "GPSDestDistanceRef" | Unit used to express the distance to the destination point. 'K': "km" 'M': "miles" 'N': "nautical miles" Read/Write capability: readable and writable. |
How to modify the parameter: Use letters or strings. Example of modification: imageSource.modifyImageProperty(key,'K');or imageSource.modifyImageProperty(key,'km');Example of read result: "K" |
| GPS_DEST_DISTANCE12+ | "GPSDestDistance" | Distance to the destination point. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'100');Example of read result: "100" |
| GPS_PROCESSING_METHOD12+ | "GPSProcessingMethod" | String that records the name of the method used for positioning. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'GPS Processing Method');Example of read result: "GPS Processing Method" |
| GPS_AREA_INFORMATION12+ | "GPSAreaInformation" | String that records the name of the GPS area. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'GPS Area Information');Example of read result: "GPS Area Information" |
| GPS_DATE_STAMP10+ | "GPSDateStamp" | GPS date stamp. Read/Write capability: readable and writable. |
How to modify the parameter: Use the format "YY:MM:DD". Example of modification: imageSource.modifyImageProperty(key,'2020:07:07');Example of read result: "2020:07:07" |
| GPS_DIFFERENTIAL12+ | "GPSDifferential" | Whether differential correction is applied to the GPS receiver. It is critical to accurate location accuracy. 0: "Without correction" (No differential correction) 1:"Correction applied" (Differential correction applied) Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Without correction');Example of read result: "0" |
| GPS_H_POSITIONING_ERROR12+ | "GPSHPositioningError" | Horizontal positioning error, in meters. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'100');Example of read result: "100" |
| ISO_SPEED_RATINGS9+ | "ISOSpeedRatings" | ISO sensitivity or ISO speed, for example, 400. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'3200');Example of read result: "3200" |
| PHOTOGRAPHIC_SENSITIVITY12+ | "PhotographicSensitivity" | ISO sensitivity (ISO speed) used when the image was captured. It is the recommended field in Exif 2.3 and later. The earlier field, ISOSpeedRatings (Tag 0x8827), has the same data type and meaning. However, if both fields are present, the PhotographicSensitivity value should be used. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'3200');Example of read result: "3200" |
| OECF12+ | "OECF" | Opto-Electric Conversion Function (OECF) specified in ISO 14524. Read/Write capability: readable and writable. |
This field is in a special format. Although it can be read and written, it is not parsed in the current version. |
| SENSITIVITY_TYPE10+ | "SensitivityType" | Sensitivity type. Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Standard output sensitivity (SOS)');Example of read result: "Standard output sensitivity (SOS)" |
| STANDARD_OUTPUT_SENSITIVITY10+ | "StandardOutputSensitivity" | Standard output sensitivity. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'400');Example of read result: "400" |
| RECOMMENDED_EXPOSURE_INDEX10+ | "RecommendedExposureIndex" | Recommended exposure index. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'3200');Example of read result: "3200" |
| ISO_SPEED10+ | "ISOSpeedRatings" | ISO speed. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'3200');Example of read result: "3200" |
| ISO_SPEED_LATITUDE_YYY12+ | "ISOSpeedLatitudeyyy" | ISO speed latitude yyy value of the camera or input device, which is defined in ISO 12232. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'3200');Example of read result: "3200" |
| ISO_SPEED_LATITUDE_ZZZ12+ | "ISOSpeedLatitudezzz" | ISO speed latitude zzz value of the camera or input device, which is defined in ISO 12232. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'3200');Example of read result: "3200" |
| EXIF_VERSION12+ | "ExifVersion" | Version of the supported Exif standard. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string, separated by decimal points (.). Example of modification: imageSource.modifyImageProperty(key,'2.3');Example of read result: "Exif Version 2.3" |
| DATE_TIME_ORIGINAL9+ | "DateTimeOriginal" | Time when the original image data was generated, for example, 2022:09:06 15:48:00. Read/Write capability: readable and writable. |
How to modify the parameter: Use the format "YY:MM:DD HH:mm:ss" or "YY:MM:DD". Example of modification: imageSource.modifyImageProperty(key,'2024:07:07 13:45:59');or imageSource.modifyImageProperty(key,'2024:07:07');Example of read result: "2024:07:07" or "2024:07:07 13:45:59" |
| DATE_TIME_DIGITIZED12+ | "DateTimeDigitized" | Date and time when the image was stored as digital data, in the format of YYYY:MM:DD HH:mm:ss. Read/Write capability: readable and writable. |
How to modify the parameter: Use the format "YY:MM:DD HH:mm:ss" or "YY:MM:DD". Example of modification: imageSource.modifyImageProperty(key,'2024:07:07 13:45:59');or imageSource.modifyImageProperty(key,'2024:07:07');Example of read result: "2024:07:07" or "2024:07:07 13:45:59" |
| OFFSET_TIME12+ | "OffsetTime" | Time with an offset from UTC when the image was captured. Read/Write capability: readable and writable. |
How to modify the parameter: Use the format "YY:MM:DD HH:mm:ss" or "YY:MM:DD". Example of modification: imageSource.modifyImageProperty(key,'2024:07:07 13:45:59');or imageSource.modifyImageProperty(key,'2024:07:07');Example of read result: "2024:07:07" or "2024:07:07 13:45:59" |
| OFFSET_TIME_ORIGINAL12+ | "OffsetTimeOriginal" | Time with an offset from UTC when the original image was created. It is critical for time-sensitive applications. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Offset Time Original');Example of read result: "Offset Time Original" |
| OFFSET_TIME_DIGITIZED12+ | "OffsetTimeDigitized" | Time with an offset from UTC when the image was digitized. It helps to accurately adjust the timestamp. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Offset Time Digitized');Example of read result: "Offset Time Digitized" |
| COMPONENTS_CONFIGURATION12+ | "ComponentsConfiguration" | Specific information about compressed data. Read/Write capability: readable and writable. |
How to modify the parameter: "Y Cb Cr -" Example of modification: imageSource.modifyImageProperty(key,'Y Cb Cr -');Example of read result: "Y Cb Cr -" |
| COMPRESSED_BITS_PER_PIXEL12+ | "CompressedBitsPerPixel" | Number of bits per pixel. It is specific to compressed data. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'0.95');Example of read result: "0.95" |
| SHUTTER_SPEED12+ | "ShutterSpeedValue" | Shutter speed, expressed in Additive System of Photographic Exposure (APEX) values. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1');Example of read result: "1.00 EV (1/2 sec.)" |
| APERTURE_VALUE10+ | "ApertureValue" | Lens aperture. An example in the correct format is 4/1. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'5.6');Example of read result: "5.60 EV (f/7.0)" |
| BRIGHTNESS_VALUE12+ | "BrightnessValue" | Value of brightness, expressed in APEX values. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'2');Example of read result: "2.00 EV (13.71 cd/m^2)" |
| EXPOSURE_BIAS_VALUE10+ | "ExposureBiasValue" | Exposure bias. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1');Example of read result: 1.00 EV |
| MAX_APERTURE_VALUE12+ | "MaxApertureValue" | Smallest F number of the lens. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1');Example of read result: "1.00 EV (f/1.4)" |
| SUBJECT_DISTANCE12+ | "SubjectDistance" | Distance to the subject, in meters. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'100');Example of read result: "100.0 m" |
| METERING_MODE10+ | "MeteringMode" | Metering mode. Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Average');Example of read result: "Average" |
| LIGHT_SOURCE10+ | "LightSource" | Light source. An example value is Fluorescent. Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Daylight');Example of read result: "Daylight" |
| FLASH10+ | "Flash" | Flash status. Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0x00');or imageSource.modifyImageProperty(key,'Flash did not fire');Example of read result: "Flash did not fire" |
| FOCAL_LENGTH10+ | "FocalLength" | Focal length of the lens. The unit is milliseconds. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'50');or imageSource.modifyImageProperty(key,'50/1');Example of read result: "50.0 mm" |
| SUBJECT_AREA12+ | "SubjectArea" | Location and area of the main subject in the entire scene. Read/Write capability: readable and writable. |
How to modify the parameter: Use two non-negative rational numbers, separated by spaces or commas (,), as a string. Example of modification: imageSource.modifyImageProperty(key,'50 50');or imageSource.modifyImageProperty(key,'50,50');Example of read result: "(x,y) = (50,50)" |
| MAKER_NOTE12+ | "MakerNote" | Marker used by Exif/DCF manufacturers to record any required information. This field is read-only in API versions 12 to 19 and is readable and writable in API version 20 and later. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Maker Note');Example of read result: "Maker Note" |
| USER_COMMENT10+ | "UserComment" | User comments. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'User Comment');Example of read result: "User Comment" |
| SUBSEC_TIME12+ | "SubsecTime" | Tag used to record fractions of seconds for the DateTime tag. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'629000');Example of read result: "629000" |
| SUBSEC_TIME_ORIGINAL12+ | "SubsecTimeOriginal" | Tag used to record fractions of seconds for the DateTimeOriginal tag. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'629000');Example of read result: "629000" |
| SUBSEC_TIME_DIGITIZED12+ | "SubsecTimeDigitized" | Tag used to record fractions of seconds for the DateTimeDigitized tag. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'62900');Example of read result: "62900" |
| FLASHPIX_VERSION12+ | "FlashpixVersion" | FlashPix format version supported by an FPXR file. It is used to enhance device compatibility. Read/Write capability: readable and writable. |
How to modify the parameter: Use the version number format "1.0". Example of modification: imageSource.modifyImageProperty(key,'1.0');Example of read result: "FlashPix Version 1.0" |
| COLOR_SPACE12+ | "ColorSpace" | Color space information, which is usually recorded as a color space specifier. 1: "sRGB" (Standard sRGB color space, which is the typical default value) 2: "Adobe RGB" (Not formally defined in Exif, but commonly used in practice) 0xffff: "Uncalibrated" (Uncalibrated and color space unknown) Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'sRGB');Example of read result: "sRGB" |
| PIXEL_X_DIMENSION10+ | "PixelXDimension" | Pixel X dimension. The unit is px. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'4096');Example of read result: "4096" |
| PIXEL_Y_DIMENSION10+ | "PixelYDimension" | Pixel Y dimension. The unit is px. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'3072');Example of read result: "3072" |
| RELATED_SOUND_FILE12+ | "RelatedSoundFile" | Name of an audio file related to the image data. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Related Sound File');Example of read result: "Related Sound File |
| FLASH_ENERGY12+ | "FlashEnergy" | Strobe energy at the time the image was captured, in Beam Candle Power Seconds (BCPS). Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'5.0');or imageSource.modifyImageProperty(key,'5/1');Example of read result: "5" |
| SPATIAL_FREQUENCY_RESPONSE12+ | "SpatialFrequencyResponse" | Spatial frequency table of the camera or input device. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Spatial Frequency Response');Example of read result: "Spatial Frequency Response" |
| FOCAL_PLANE_X_RESOLUTION12+ | "FocalPlaneXResolution" | Number of pixels in the image width (X) direction per FocalPlaneResolutionUnit. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'500');or imageSource.modifyImageProperty(key,'500.0');Example of read result: "500" |
| FOCAL_PLANE_Y_RESOLUTION12+ | "FocalPlaneYResolution" | Number of pixels in the image height (Y) direction per FocalPlaneResolutionUnit. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'500');or imageSource.modifyImageProperty(key,'500.0');Example of read result: "500" |
| FOCAL_PLANE_RESOLUTION_UNIT12+ | "FocalPlaneResolutionUnit" | Unit for measuring FocalPlaneXResolution and FocalPlaneYResolution. 2: "Inch" 3: "Centimeter" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'2');or imageSource.modifyImageProperty(key,'Inch');Example of read result: "Inch" |
| SUBJECT_LOCATION12+ | "SubjectLocation" | Location of the main subject relative to the left edge. Read/Write capability: readable and writable. |
How to modify the parameter: Use two non-negative integers, separated by spaces or commas (,), as a string. Example of modification: imageSource.modifyImageProperty(key,'123 456');or imageSource.modifyImageProperty(key,'123,456');Example of read result: "123,456" |
| EXPOSURE_INDEX12+ | "ExposureIndex" | Exposure index selected at the time the image is captured. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1');Example of read result: "1" |
| SENSING_METHOD12+ | "SensingMethod" | Type of the image sensor on the camera. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'2');or imageSource.modifyImageProperty(key,'One-chip color area sensor');Example of read result: "One-chip color area sensor" |
| FILE_SOURCE12+ | "FileSource" | Image source. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'DSC');Example of read result: "DSC" |
| SCENE_TYPE9+ | "SceneType" | Type of the scene, for example, portrait, scenery, motion, and night. 1: "Directly photographed" (Image captured by the image sensor) Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Directly photographed');Example of read result: "Directly photographed" |
| CFA_PATTERN12+ | "CFAPattern" | Color Filter Array (CFA) geometric pattern of the image sensor. Read/Write capability: readable and writable. |
This field is in a special format. Although it can be read and written, it is not parsed in the current version. |
| CUSTOM_RENDERED12+ | "CustomRendered" | Special processing on image data. 0: "Normal process" (Normal processing without any custom rendering) 1: "Custom process" (Custom processing such as artistic effect, beauty, and HDR) Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Custom process');Example of read result: "Custom process" |
| EXPOSURE_MODE12+ | "ExposureMode" | Exposure mode set when the image was captured. 0: "Auto exposure" 1: "Manual exposure" 2: "Auto bracket" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Auto exposure');Example of read result: "Auto exposure" |
| WHITE_BALANCE10+ | "WhiteBalance" | White balance. 0: "Auto white balance" 1: "Manual white balance" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Auto white balance');Example of read result: "Auto white balance" |
| DIGITAL_ZOOM_RATIO12+ | "DigitalZoomRatio" | Digital zoom ratio when the image was captured. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification: imageSource.modifyImageProperty(key,'1/2');Example of read result: "0.5" |
| FOCAL_LENGTH_IN_35_MM_FILM10+ | "FocalLengthIn35mmFilm" | 35 mm equivalent focal length. The unit is milliseconds. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative integer string. Example of modification: imageSource.modifyImageProperty(key,'50');Example of read result: "50" |
| SCENE_CAPTURE_TYPE12+ | "SceneCaptureType" | Type of the scene that was captured. 0: "Standard" 1: "Landscape" 2: "Portrait" 3: "Night scene" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Standard');Example of read result: "Standard" |
| GAIN_CONTROL12+ | "GainControl" | Degree of overall image gain adjustment. 0: "Normal" (No gain control) 1: "Low gain up" 2: "High gain up" 3: "Low gain down" 4: "High gain down" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Normal');Example of read result: "Normal" |
| CONTRAST12+ | "Contrast" | Direction of contrast processing used by the camera. 0: "Normal" (Normal contrast) 1: "Soft" (Soft contrast) 2: "Hard" (Hard contrast) Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Normal');Example of read result: "Normal" |
| SATURATION12+ | "Saturation" | Direction of saturation processing used by the camera. 0:"Normal" 1: "Low saturation" 2: "High saturation" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Normal');Example of read result: "Normal" |
| SHARPNESS12+ | "Sharpness" | Direction of sharpness processing used by the camera. 0:"Normal" 1: "Soft" 2: "Hard" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'0');or imageSource.modifyImageProperty(key,'Normal');Example of read result: "Normal" |
| DEVICE_SETTING_DESCRIPTION12+ | "DeviceSettingDescription" | Information about the photographing conditions of a specific camera model. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of Modification: imageSource.modifyImageProperty(key,'Device Setting Description');Example of read result: "Device Setting Description" |
| SUBJECT_DISTANCE_RANGE12+ | "SubjectDistanceRange" | Distance to the subject. 0: "Unknown" 1: "Macro" 2: "Close view" 3: "Distant view" Read/Write capability: readable and writable. |
How to modify the parameter: Use numbers or strings. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'Macro');Example of read result: "Macro" |
| IMAGE_UNIQUE_ID12+ | "ImageUniqueID" | Unique identifier assigned to each image. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Image Unique ID');Example of read result: "Image Unique ID" |
| CAMERA_OWNER_NAME12+ | "CameraOwnerName" | Name of the camera owner. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Camera Owner Name');Example of read result: "Camera Owner Name" |
| BODY_SERIAL_NUMBER12+ | "BodySerialNumber" | Serial number of the camera body. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Body Serial Number');Example of read result: "Body Serial Number" |
| LENS_SPECIFICATION12+ | "LensSpecification" | Specifications of the lens. Read/Write capability: readable and writable. |
How to modify the parameter: Use four non-negative rational number strings, separated by spaces or commas (,). Example of modification: imageSource.modifyImageProperty(key,'12 12 12 12'); or imageSource.modifyImageProperty(key,'12,12,12,12');Example of read result: "12,12,12,12" |
| LENS_MAKE12+ | "LensMake" | Manufacturer of the lens. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Lens Make');Example of read result: "Lens Make" |
| LENS_MODEL12+ | "LensModel" | Model of the lens. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Lens Model');Example of read result: "Lens Model" |
| LENS_SERIAL_NUMBER12+ | "LensSerialNumber" | Serial number of the lens. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Lens Serial Number');Example of read result: "Lens Serial Number" |
| COMPOSITE_IMAGE12+ | "CompositeImage" | Whether the image is a composite image. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'1');or imageSource.modifyImageProperty(key,'NonComposite');Example of read result: "1" |
| SOURCE_IMAGE_NUMBER_OF_COMPOSITE_IMAGE12+ | "SourceImageNumberOfCompositeImage" | Number of source images of the composite image. Read/Write capability: readable and writable. |
How to modify the parameter: Use two non-negative integers, separated by spaces or commas (,), as a string. Example of modification: imageSource.modifyImageProperty(key,'1 5');or imageSource.modifyImageProperty(key,'1,5');Example of read result: "1,5" |
| SOURCE_EXPOSURE_TIMES_OF_COMPOSITE_IMAGE12+ | "SourceExposureTimesOfCompositeImage" | Exposure time of source images of the composite image. Read/Write capability: readable and writable. |
How to modify the parameter: Use a string. Example of modification: imageSource.modifyImageProperty(key,'Source Exposure Times Of CompositeImage');Example of read result: "Source Exposure Times Of CompositeImage" |
| GAMMA12+ | "Gamma" | Gamma value. Read/Write capability: readable and writable. |
How to modify the parameter: Use a non-negative rational number as a string. Example of modification imageSource.modifyImageProperty(key,'1');Example of read result: "1" |
| DNG_VERSION12+ | "DNGVersion" | DNG version. It encodes the DNG 4-tier version number. Read/Write capability: readable and writable. |
How to modify the parameter: Use four non-negative integers, separated by spaces or commas (,), as a string. Example of modification imageSource.modifyImageProperty(key,'1 1 1 1');or imageSource.modifyImageProperty(key,'1,1,1,1');Example of read result: "1,1,1,1" |
| DEFAULT_CROP_SIZE12+ | "DefaultCropSize" | Size of the final image area, in raw image coordinates, taking into account extra pixels around the edges of the final image. The unit is px. Read/Write capability: readable and writable. |
How to modify the parameter: Use two non-negative integers, separated by spaces or commas (,), as a string. Example of modification: imageSource.modifyImageProperty(key,'400 400');or imageSource.modifyImageProperty(key,'400,400');Example of read result: "400,400" |
| GIF_LOOP_COUNT12+ | "GIFLoopCount" | Number of GIF loops. The value 0 indicates infinite looping, and another value indicates the actual number of loops. Read/Write capability: read-only |
_ |
| IS_XMAGE_SUPPORTED12+ | "HwMnoteIsXmageSupported" | Whether XMAGE is supported. Read/Write capability: readable and writable. |
_ |
| XMAGE_MODE12+ | "HwMnoteXmageMode" | XMAGE watermark mode. Read/Write capability: readable and writable. |
_ |
| XMAGE_LEFT12+ | "HwMnoteXmageLeft" | X1 coordinate of the watermark region. Read/Write capability: readable and writable. |
_ |
| XMAGE_TOP12+ | "HwMnoteXmageTop" | Y1 coordinate of the watermark region. Read/Write capability: readable and writable. |
_ |
| XMAGE_RIGHT12+ | "HwMnoteXmageRight" | X2 coordinate of the watermark region. Read/Write capability: readable and writable. |
_ |
| XMAGE_BOTTOM12+ | "HwMnoteXmageBottom" | Y2 coordinate of the watermark region. Read/Write capability: readable and writable. |
_ |
| CLOUD_ENHANCEMENT_MODE12+ | "HwMnoteCloudEnhancementMode" | Cloud enhancement mode. Read/Write capability: readable and writable. |
_ |
| WIND_SNAPSHOT_MODE12+ | "HwMnoteWindSnapshotMode" | Motion snapshot mode. Read/Write capability: read-only |
_ |
| SCENE_POINTER12+ | "HwMnoteScenePointer" | Pointer to the scene. Read/Write capability: read-only |
_ |
| SCENE_VERSION12+ | "HwMnoteSceneVersion" | Scene algorithm version. Read/Write capability: read-only |
_ |
| SCENE_FOOD_CONF11+ | "HwMnoteSceneFoodConf" | Photographing scene: food. Read/Write capability: read-only |
_ |
| SCENE_STAGE_CONF11+ | "HwMnoteSceneStageConf" | Photographing scene: stage. Read/Write capability: read-only |
_ |
| SCENE_BLUE_SKY_CONF11+ | "HwMnoteSceneBlueSkyConf" | Photographing scene: blue sky. Read/Write capability: read-only |
_ |
| SCENE_GREEN_PLANT_CONF11+ | "HwMnoteSceneGreenPlantConf" | Photographing scene: green plant. Read/Write capability: read-only |
_ |
| SCENE_BEACH_CONF11+ | "HwMnoteSceneBeachConf" | Photographing scene: beach. Read/Write capability: read-only |
_ |
| SCENE_SNOW_CONF11+ | "HwMnoteSceneSnowConf" | Photographing scene: snow. Read/Write capability: read-only |
_ |
| SCENE_SUNSET_CONF11+ | "HwMnoteSceneSunsetConf" | Photographing scene: sunset. Read/Write capability: read-only |
_ |
| SCENE_FLOWERS_CONF11+ | "HwMnoteSceneFlowersConf" | Photographing scene: flowers. Read/Write capability: read-only |
_ |
| SCENE_NIGHT_CONF11+ | "HwMnoteSceneNightConf" | Photographing scene: night. Read/Write capability: read-only |
_ |
| SCENE_TEXT_CONF11+ | "HwMnoteSceneTextConf" | Photographing scene: text. Read/Write capability: read-only |
_ |
| FACE_POINTER12+ | "HwMnoteFacePointer" | Face pointer. Read/Write capability: read-only |
_ |
| FACE_VERSION12+ | "HwMnoteFaceVersion" | Facial recognition algorithm version. Read/Write capability: read-only |
_ |
| FACE_COUNT11+ | "HwMnoteFaceCount" | Number of faces. Read/Write capability: read-only |
_ |
| FACE_CONF12+ | "HwMnoteFaceConf" | Face confidence. Read/Write capability: read-only |
_ |
| FACE_SMILE_SCORE12+ | "HwMnoteFaceSmileScore" | Smile scores of faces (the number of faces is specified by FaceCount). Read/Write capability: read-only |
_ |
| FACE_RECT12+ | "HwMnoteFaceRect" | Face rectangle. Read/Write capability: read-only |
_ |
| FACE_LEYE_CENTER12+ | "HwMnoteFaceLeyeCenter" | Left eye centered. Read/Write capability: read-only |
_ |
| FACE_REYE_CENTER12+ | "HwMnoteFaceReyeCenter" | Right eye centered. Read/Write capability: read-only |
_ |
| FACE_MOUTH_CENTER12+ | "HwMnoteFaceMouthCenter" | Mouth centered. Read/Write capability: read-only |
_ |
| CAPTURE_MODE10+ | "HwMnoteCaptureMode" | Capture mode. Read/Write capability: readable and writable. |
_ |
| BURST_NUMBER12+ | "HwMnoteBurstNumber" | Number of burst shooting times. Read/Write capability: read-only |
_ |
| FRONT_CAMERA12+ | "HwMnoteFrontCamera" | Whether the front camera is used to take a selfie. Read/Write capability: read-only |
_ |
| ROLL_ANGLE11+ | "HwMnoteRollAngle" | Roll angle. Read/Write capability: read-only |
_ |
| PITCH_ANGLE11+ | "HwMnotePitchAngle" | Pitch angle. Read/Write capability: read-only |
_ |
| PHYSICAL_APERTURE10+ | "HwMnotePhysicalAperture" | Physical aperture. The unit is milliseconds. Read/Write capability: read-only |
_ |
| FOCUS_MODE11+ | "HwMnoteFocusMode" | Focus mode. Read/Write capability: read-only |
_ |
FragmentMapPropertyKey13+
Enumerates the fragment map information.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| X_IN_ORIGINAL | "XInOriginal" | X coordinate of the top-left corner of the fragment map in the original image. |
| Y_IN_ORIGINAL | "YInOriginal" | Y coordinate of the top-left corner of the fragment map in the original image. |
| WIDTH | "FragmentImageWidth" | Width of the fragment map. The unit is px. |
| HEIGHT | "FragmentImageHeight" | Height of the fragment map. The unit is px. |
GifPropertyKey20+
Enumerates the GIF image information.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| GIF_DELAY_TIME | 'GifDelayTime' | Frame delay of the GIF image after clamping. The clamp range is [100, 65535]. The unit is milliseconds. |
| GIF_DISPOSAL_TYPE | 'GifDisposalType' | Disposal type for each frame of the GIF image. - 0: Unspecified. - 1: Do not dispose. - 2: Restore to the background color. - 3: Restore to the previous frame. The value is a positive integer. |
| GIF_HAS_GLOBAL_COLOR_MAP | 'GifHasGlobalColorMap' | Whether the GIF image contains a global color table. Since: 26.0.0 Model restriction: This API can be used only in the stage model. |
| GIF_CANVAS_WIDTH | 'GifCanvasWidth' | Canvas width of the GIF image. The unit is px. Since: 26.0.0 Model restriction: This API can be used only in the stage model. |
| GIF_CANVAS_HEIGHT | 'GifCanvasHeight' | Canvas height of the GIF image. The unit is px. Since: 26.0.0 Model restriction: This API can be used only in the stage model. |
| GIF_LOOP_COUNT | 'GifLoopCount' | Number of GIF loops. The value can be 0 or a positive integer. The value 0 indicates infinite looping, and another value indicates the actual number of loops. Since: 26.0.0 Model restriction: This API can be used only in the stage model. |
| GIF_UNCLAMPED_DELAY_TIME | 'GifUnclampedDelayTime' | Frame delay of a GIF image without clamping. The unit is milliseconds. Since: 26.0.0 Model restriction: This API can be used only in the stage model. |
HeifsPropertyKey23+
Enumerates the HEIF image sequence information.
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| HEIFS_DELAY_TIME | 'HeifsDelayTime' | Delay of each frame in an HEIF image sequence, in milliseconds. |
| HEIFS_UNCLAMPED_DELAY_TIME | 'HeifsUnclampedDelayTime' | Frame delay of a HEIF image sequence without clamping. The unit is milliseconds. Since: 26.0.0 |
| HEIFS_CANVAS_HEIGHT | 'HeifsCanvasHeight' | Canvas height of a HEIF image sequence. The unit is px. Since: 26.0.0 |
| HEIFS_CANVAS_WIDTH | 'HeifsCanvasWidth' | Canvas width of a HEIF sequence image. The unit is px. Since: 26.0.0 |
WebPPropertyKey24+
Enumerates the WebP image information.
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| CANVAS_WIDTH | 'WebPCanvasWidth' | Canvas width of a WebP image. The unit is px. |
| CANVAS_HEIGHT | 'WebPCanvasHeight' | Canvas height of a WebP image. The unit is px. |
| DELAY_TIME | 'WebPDelayTime' | Frame delay of a WebP image after clamping. The clamp range is [100, 65535]. The unit is milliseconds. |
| UNCLAMPED_DELAY_TIME | 'WebPUnclampedDelayTime' | Frame delay of a WebP image without clamping. The unit is milliseconds. |
| LOOP_COUNT | 'WebPLoopCount' | Number of times the WebP image animation loops. If it is set to 0, the number of animation loops is not limited. |
DngPropertyKey24+
Enumerates the DNG image information.
- For details about the fields, see the DNG Specification 1.4.0.0.
- The key in the format example is image.DngPropertyKey.XXX (where XXX is the name of an enumeration, for example, DNG_BACKWARD_VERSION).
- The format example is intended only to demonstrate the format of the read result. For details about how to use the API, see readImageMetadata.
- For details about the return value type, see DngMetadata.
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| DNG_VERSION | 'DNGVersion' | Version number of the DNG image. |
| DNG_BACKWARD_VERSION | 'DNGBackwardVersion' | Minimum backward-compatible version number of the DNG file. |
| UNIQUE_CAMERA_MODEL | 'UniqueCameraModel' | Unique model ID of the camera, which is used to distinguish different devices. |
| LOCALIZED_CAMERA_MODEL | 'LocalizedCameraModel' | Localized camera model name. |
| CFA_PLANE_COLOR | 'CFAPlaneColor' | Color channel definition for each CFA plane. |
| CFA_LAYOUT | 'CFALayout' | CFA layout type, such as RGGB and BGGR. |
| LINEARIZATION_TABLE | 'LinearizationTable' | Linearization lookup table, which is used to map raw sensor values to the linear light intensity. |
| BLACK_LEVEL_REPEAT_DIM | 'BlackLevelRepeatDim' | Black level repetition dimension. |
| BLACK_LEVEL | 'BlackLevel' | Black level under zero illumination, arranged in CFA plane order. |
| BLACK_LEVEL_DELTA_H | 'BlackLevelDeltaH' | Horizontal black level correction increment. |
| BLACK_LEVEL_DELTA_V | 'BlackLevelDeltaV' | Vertical black level correction increment. |
| WHITE_LEVEL | 'WhiteLevel' | White level, indicating the maximum valid output of the sensor. |
| DEFAULT_SCALE | 'DefaultScale' | Default scaling ratio. |
| DEFAULT_CROP_ORIGIN | 'DefaultCropOrigin' | Coordinates (x, y) of the upper left corner of the default crop area. |
| DEFAULT_CROP_SIZE | 'DefaultCropSize' | Width and height of the default crop area. |
| COLOR_MATRIX1 | 'ColorMatrix1' | Color transformation matrix under the first calibration illuminant. |
| COLOR_MATRIX2 | 'ColorMatrix2' | Color transformation matrix under the second calibration illuminant. |
| CAMERA_CALIBRATION1 | 'CameraCalibration1' | Camera transformation matrix under the first calibration illuminant. |
| CAMERA_CALIBRATION2 | 'CameraCalibration2' | Camera transformation matrix under the second calibration illuminant. |
| REDUCTION_MATRIX1 | 'ReductionMatrix1' | Dimension reduction matrix under the first calibration illuminant. |
| REDUCTION_MATRIX2 | 'ReductionMatrix2' | Dimension reduction matrix under the second calibration illuminant. |
| ANALOG_BALANCE | 'AnalogBalance' | Analog gain balance coefficient. |
| AS_SHOT_NEUTRAL | 'AsShotNeutral' | Neutral white point at capture. |
| AS_SHOT_WHITE_XY | 'AsShotWhiteXY' | CIE x-y chromaticity coordinates of the white point at capture. |
| BASELINE_EXPOSURE | 'BaselineExposure' | Baseline exposure compensation value, in EV. |
| BASELINE_NOISE | 'BaselineNoise' | Baseline noise level. |
| BASELINE_SHARPNESS | 'BaselineSharpness' | Baseline sharpness gain. |
| BAYER_GREEN_SPLIT | 'BayerGreenSplit' | Separation degree of the two green channels in a Bayer image. |
| LINEAR_RESPONSE_LIMIT | 'LinearResponseLimit' | Upper limit of the linear response. The value range is [0.0, 1.0]. |
| CAMERA_SERIAL_NUMBER | 'CameraSerialNumber' | Camera serial number. |
| LENS_INFO | 'LensInfo' | Lens information. |
| CHROMA_BLUR_RADIUS | 'ChromaBlurRadius' | Chrominance blur radius, in pixels. |
| ANTI_ALIAS_STRENGTH | 'AntiAliasStrength' | Anti-aliasing filter strength. |
| SHADOW_SCALE | 'ShadowScale' | Shadow region scaling factor. |
| DNG_PRIVATE_DATA | 'DNGPrivateData' | Vendor-specific data block. |
| MAKER_NOTE_SAFETY | 'MakerNoteSafety' | Whether the EXIF MakerNote is secure and can be retained. The value 1 indicates yes, and the value 0 indicates no. |
| CALIBRATION_ILLUMINANT1 | 'CalibrationIlluminant1' | Type of the first calibration illuminant. |
| CALIBRATION_ILLUMINANT2 | 'CalibrationIlluminant2' | Type of the second calibration illuminant. |
| BEST_QUALITY_SCALE | 'BestQualityScale' | Scaling ratio for the optimal image quality. |
| RAW_DATA_UNIQUE_ID | 'RawDataUniqueID' | Unique ID of the raw image data. |
| ORIGINAL_RAW_FILE_NAME | 'OriginalRawFileName' | Original raw file name. |
| ORIGINAL_RAW_FILE_DATA | 'OriginalRawFileData' | Complete data of the original raw file. |
| ACTIVE_AREA | 'ActiveArea' | Valid image area. |
| MASKED_AREAS | 'MaskedAreas' | List of masked areas. |
| AS_SHOT_ICC_PROFILE | 'AsShotICCProfile' | ICC color profile used at capture. |
| AS_SHOT_PRE_PROFILE_MATRIX | 'AsShotPreProfileMatrix' | Pre-transformation matrix before the ICC color profile is applied. |
| CURRENT_ICC_PROFILE | 'CurrentICCProfile' | ICC color profile in use. |
| CURRENT_PRE_PROFILE_MATRIX | 'CurrentPreProfileMatrix' | Pre-transformation matrix used before the current ICC color profile. |
| COLORIMETRIC_REFERENCE | 'ColorimetricReference' | Chromaticity reference standard. |
| CAMERA_CALIBRATION_SIGNATURE | 'CameraCalibrationSignature' | Camera calibration signature. |
| PROFILE_CALIBRATION_SIGNATURE | 'ProfileCalibrationSignature' | Profile calibration signature. |
| EXTRA_CAMERA_PROFILES | 'ExtraCameraProfiles' | List of additional camera profile indexes. |
| AS_SHOT_PROFILE_NAME | 'AsShotProfileName' | Name of the profile used at capture. |
| NOISE_REDUCTION_APPLIED | 'NoiseReductionApplied' | Applied noise reduction intensity level. |
| PROFILE_NAME | 'ProfileName' | Color profile name. |
| PROFILE_HUE_SAT_MAP_DIMS | 'ProfileHueSatMapDims' | Dimensions of the hue/saturation mapping table. |
| PROFILE_HUE_SAT_MAP_DATA1 | 'ProfileHueSatMapData1' | First set of hue/saturation mapping table data. |
| PROFILE_HUE_SAT_MAP_DATA2 | 'ProfileHueSatMapData2' | Second set of hue/saturation mapping table data. |
| PROFILE_TONE_CURVE | 'ProfileToneCurve' | Tone curve of the profile. |
| PROFILE_EMBED_POLICY | 'ProfileEmbedPolicy' | Profile embedding policy. |
| PROFILE_COPYRIGHT | 'ProfileCopyright' | Profile copyright information. |
| FORWARD_MATRIX1 | 'ForwardMatrix1' | First forward transformation matrix. |
| FORWARD_MATRIX2 | 'ForwardMatrix2' | Second forward transformation matrix. |
| PREVIEW_APPLICATION_NAME | 'PreviewApplicationName' | Name of the application that generates the preview image. |
| PREVIEW_APPLICATION_VERSION | 'PreviewApplicationVersion' | Version of the application that generates the preview image. |
| PREVIEW_SETTINGS_NAME | 'PreviewSettingsName' | Name of the preview image processing configuration. |
| PREVIEW_SETTINGS_DIGEST | 'PreviewSettingsDigest' | MD5 digest of the preview image configuration. |
| PREVIEW_COLOR_SPACE | 'PreviewColorSpace' | Color space of the preview image. |
| PREVIEW_DATE_TIME | 'PreviewDateTime' | Preview image generation time. |
| RAW_IMAGE_DIGEST | 'RawImageDigest' | MD5 digest of the raw image data. |
| ORIGINAL_RAW_FILE_DIGEST | 'OriginalRawFileDigest' | MD5 digest of the original raw file data. |
| SUB_TILE_BLOCK_SIZE | 'SubTileBlockSize' | Block length and width for image titled storage. |
| ROW_INTERLEAVE_FACTOR | 'RowInterleaveFactor' | Row interleaving factor. |
| PROFILE_LOOK_TABLE_DIMS | 'ProfileLookTableDims' | ProfileLookTableData dimensions. |
| PROFILE_LOOK_TABLE_DATA | 'ProfileLookTableData' | Color table data. |
| OPCODE_LIST1 | 'OpcodeList1' | First operation code list. |
| OPCODE_LIST2 | 'OpcodeList2' | Second operation code list. |
| OPCODE_LIST3 | 'OpcodeList3' | Third operation code list. |
| NOISE_PROFILE | 'NoiseProfile' | Noise profile parameters. |
| ORIGINAL_DEFAULT_FINAL_SIZE | 'OriginalDefaultFinalSize' | Original default final output dimensions (width and height). |
| ORIGINAL_BEST_QUALITY_FINAL_SIZE | 'OriginalBestQualityFinalSize' | Original output dimensions (width and height) for optimal image quality. |
| ORIGINAL_DEFAULT_CROP_SIZE | 'OriginalDefaultCropSize' | Original default crop dimensions (width and height). |
| PROFILE_HUE_SAT_MAP_ENCODING | 'ProfileHueSatMapEncoding' | Encoding mode of the hue/saturation mapping table. |
| PROFILE_LOOK_TABLE_ENCODING | 'ProfileLookTableEncoding' | Color table encoding mode. |
| BASELINE_EXPOSURE_OFFSET | 'BaselineExposureOffset' | Baseline exposure offset, in EV. |
| DEFAULT_BLACK_RENDER | 'DefaultBlackRender' | Default black field rendering mode. |
| NEW_RAW_IMAGE_DIGEST | 'NewRawImageDigest' | New MD5 digest of the update raw image data. |
| RAW_TO_PREVIEW_GAIN | 'RawToPreviewGain' | Gain ratio of the main raw image to the preview image. |
| DEFAULT_USER_CROP | 'DefaultUserCrop' | Default user crop area. |
PngPropertyKey
Enumerates the PNG image information.
NOTE
- The key in the format example is image.PngPropertyKey.XXX (where XXX is the name of an enumeration, for example, X_PIXELS_PER_METER).
- For details about the return value type, see PngMetadata.
Since: 26.0.0
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| X_PIXELS_PER_METER | 'PngXPixelsPerMeter' | Number of pixels per meter in the X direction of the PNG image. |
| MODIFICATION_TIME | 'PngModificationTime' | Last modification time of the PNG image. |
| SOFTWARE | 'PngSoftware' | Name and version number of the software used to create the PNG image. |
| COPYRIGHT | 'PngCopyright' | Copyright notice of the PNG image. |
| CREATION_TIME | 'PngCreationTime' | Creation time of the PNG image. |
| SRGB_INTENT | 'PngSRGBIntent' | Standard Red Green Blue (sRGB) rendering intent of the PNG image. - 0: perceptual intent - 1: relative colorimetric intent - 2: saturation intent - 3: absolute colorimetric intent |
| AUTHOR | 'PngAuthor' | Author of the PNG image. |
| INTERLACE_TYPE | 'PngInterlaceType' | Interlace mode of the PNG image. - 0: no interlace mode. (The image is loaded sequentially from top to bottom and left to right.) - 1: interlace mode. (The image is displayed progressively through multiple scans, becoming clearer as loading proceeds.) |
| WARNING | 'PngWarning' | Warning information of the PNG image. |
| Y_PIXELS_PER_METER | 'PngYPixelsPerMeter' | Number of pixels per meter in the Y direction of the PNG image. |
| GAMMA | 'PngGamma' | Gamma coefficient value of the PNG image. |
| CHROMATICITIES | 'PngChromaticities' | Primary chromaticities and white point (cHRM) of the PNG image. This information can be used for device-independent color correction. |
| DESCRIPTION | 'PngDescription' | Description of the PNG image. |
| TITLE | 'PngTitle' | Title of the PNG image. |
| COMMENT | 'PngComment' | Comment of the PNG image. |
| DISCLAIMER | 'PngDisclaimer' | Disclaimer of the PNG image. |
JfifPropertyKey
Enumerates the JFIF image information.
NOTE
- The key in the format example is image.JfifPropertyKey.XXX (where XXX is the name of an enumeration, for example, DENSITY_UNIT).
- For details about the return value type, see JfifMetadata.
Since: 26.0.0
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| DENSITY_UNIT | 'JfifDensityUnit' | Physical unit of measurement for JfifXDensity (horizontal pixel density) and JfifYDensity (vertical pixel density). - 0: no units (pixel aspect ratio only) - 1: pixels per inch (DPI) - 2: pixels per centimeter (DPC) The value is a positive integer. |
| X_DENSITY | 'JfifXDensity' | Pixel density in the X direction of the JFIF image. |
| Y_DENSITY | 'JfifYDensity' | Pixel density in the Y direction of the JFIF image. |
| VERSION | 'JfifVersion' | JFIF image version. |
| IS_PROGRESSIVE | 'JfifIsProgressive' | Whether the image uses progressive encoding, that is, the image gradually improves in clarity through multiple scans during loading. The value true indicates yes, and the value false indicates no. |
TiffPropertyKey
Enumerates the TIFF image information.
NOTE
- The key in the format example is image.TiffPropertyKey.XXX (where XXX is the name of an enumeration, for example, DOCUMENT_NAME).
- For details about the return value type, see TiffMetadata.
Since: 26.0.0
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| DOCUMENT_NAME | 'TiffDocumentName' | Document or image name. |
| PHOTOMETRIC_INTERPRETATION | 'TiffPhotometricInterpretation' | Interpretation mode of pixel colors (such as RGB or grayscale). |
| ORIENTATION | 'TiffOrientation' | Image orientation. - 1: "Top-left" (Image not rotated) - 2: "Top-right" (Image flipped horizontally) - 3: "Bottom-right" (Image rotated by 180°) - 4: "Bottom-left" (Image flipped vertically) - 5: "Left-top" (Image flipped horizontally and then rotated clockwise by 270°) - 6: "Right-top" (Image rotated clockwise by 90°) - 7: "Right-bottom" (Image flipped horizontally and then rotated clockwise by 90°) - 8: "Left-bottom" (Image rotated clockwise by 270°) If an undefined value is read, Unknown Value x is returned, where x indicates the original value of the tag. |
| RESOLUTION_UNIT | 'TiffResolutionUnit' | Unit of XResolution (horizontal resolution) and YResolution (vertical resolution). The value can be Inch or Centimeter. |
| COPYRIGHT | 'TiffCopyright' | Copyright notice of the image. |
| DATE_TIME | 'TiffDateTime' | Date and time associated with the image (usually the last modification time). |
| IMAGE_DESCRIPTION | 'TiffImageDescription' | Image description. |
| Y_RESOLUTION | 'TiffYResolution' | Vertical resolution (number of pixels per resolution unit). |
| X_RESOLUTION | 'TiffXResolution' | Horizontal resolution (number of pixels per resolution unit). |
| WHITE_POINT | 'TiffWhitePoint' | Chromaticity coordinates of the white point, the reference for "white", in the color space of the image. |
| TILE_LENGTH | 'TiffTileLength' | Height of each image tile. The unit is px. |
| TRANSFER_FUNCTION | 'TiffTransferFunction' | Transfer function for the image, which is usually used for color correction. |
| TILE_WIDTH | 'TiffTileWidth' | Width of each image tile. The unit is px. |
| MAKE | 'TiffMake' | Capture device manufacturer. |
| MODEL | 'TiffModel' | Capture device model name or ID. |
| HOST_COMPUTER | 'TiffHostComputer' | Host or system used for image processing. |
| COMPRESSION | 'TiffCompression' | Compression scheme used for TIFF image data. - 1: no compression. - 5: LZW (dictionary-based lossless compression algorithm) - 7: JPEG baseline. - 8: DEFLATE (lossless compression algorithm based on LZ77 and Huffman) |
| SOFTWARE | 'TiffSoftware' | Name and version number of the software used to create the image. |
| PRIMARY_CHROMATICITIES | 'TiffPrimaryChromaticities' | Chromaticity coordinates of the RGB primaries in the image. |
| ARTIST | 'TiffArtist' | Person who created the image. |
ImageFormat9+
Enumerates the image formats.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| YCBCR_422_SP | 1000 | YCBCR422 semi-planar format. |
| JPEG | 2000 | JPEG encoding format. |
ComponentType9+
Enumerates the color component types of images.
System capability: SystemCapability.Multimedia.Image.ImageReceiver
| Name | Value | Description |
|---|---|---|
| YUV_Y | 1 | Luminance component. |
| YUV_U | 2 | Chrominance component. |
| YUV_V | 3 | Chrominance component. |
| JPEG | 4 | JPEG type. |
DecodingDynamicRange12+
Enumerates the desired dynamic range of an image during decoding.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| AUTO | 0 | The image is decoded based on the format. If the image is in HDR format, it is decoded based on the HDR content; otherwise, it is decoded based on the SDR content. The image source created by calling CreateIncrementalSource is decoded into SDR content. |
| SDR | 1 | The image is decoded according to the standard dynamic range. |
| HDR | 2 | The image is decoded according to the high dynamic range. The image source created by calling CreateIncrementalSource is decoded into SDR content. |
PackingDynamicRange12+
Enumerates the desired dynamic range of an image during encoding.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| AUTO | 0 | Adaptive. The pixelmap is encoded based on the format. If the PixelMap is in HDR format, it is encoded based on the HDR content; otherwise, it is encoded based on the SDR content. |
| SDR | 1 | The image is decoded according to the standard dynamic range. |
CropAndScaleStrategy18+
Enumerates the order of cropping and scaling.
If the cropAndScaleStrategy parameter is not specified in DecodingOptions and both desiredRegion and desiredSize are set, the final decoding result may vary slightly due to differences in decoding algorithms used for different image formats.
For example, if the original image size is 200x200, and you specify desiredSize:{width: 150, height: 150}, desiredRegion:{x: 0, y: 0, width: 100, height: 100}, the expectation is to decode the top-left 1/4 region of the original image and then scale the pixelMap size to 150x150.
For JPEG and WebP images (as well as some DNG images that decode a JPEG preview within the file and therefore are treated as JPEG format), the system first performs downsampling. For instance, it might downsample by 7/8 and then crop the region based on a 175x175 image size. As a result, the final cropped region will be slightly larger than the top-left 1/4 of the original image.
For SVG images, which are vector-based and can be scaled without losing clarity, the system scales the image based on the ratio of desiredSize to the original image size and then crops the region. This results in a decoded region that may differ from the exact 1/4 region of the original image.
To ensure consistent results when both desiredRegion and desiredSize are set, set the cropAndScaleStrategy parameter to CROP_FIRST.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| SCALE_FIRST | 1 | If both desiredRegion and desiredSize are specified, the image is first scaled based on desiredSize and then cropped based on desiredRegion. |
| CROP_FIRST | 2 | If both desiredRegion and desiredSize are specified, the image is first cropped based on desiredRegion and then scaled based on desiredSize. |
HdrMetadataKey12+
Enumerates the keys of HDR metadata used by pixelmap.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| HDR_METADATA_TYPE | 0 | Metadata type used by pixelmap. |
| HDR_STATIC_METADATA | 1 | Static metadata. |
| HDR_DYNAMIC_METADATA | 2 | Dynamic metadata. |
| HDR_GAINMAP_METADATA | 3 | Metadata used by gain maps. |
HdrMetadataType12+
Enumerates the values available for HDR_METADATA_TYPE in HdrMetadataKey.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| NONE | 0 | No metadata. |
| BASE | 1 | Metadata used for base graphics. |
| GAINMAP | 2 | Metadata used for gain maps. |
| ALTERNATE | 3 | Metadata used for synthesized HDR graphics. |
AntiAliasingLevel12+
Enumerates the anti-aliasing levels.
Atomic service API: This API can be used in atomic services since API version 14.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| NONE | 0 | Nearest neighbor interpolation. |
| LOW | 1 | Bilinear interpolation. |
| MEDIUM | 2 | Bilinear interpolation with mipmap enabled. You are advised to use this value when zooming out an image. |
| HIGH | 3 | Cubic interpolation. |
AllocatorType15+
Enumerates the types of the memory used for image decoding.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| AUTO | 0 | The system determines whether DMA memory or shared memory is used. |
| DMA | 1 | DMA memory is used. |
| SHARE_MEMORY | 2 | Shared memory is used. |
Orientation23+
Enumerates the image orientation types.
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| TOP_LEFT | 1 | Image not rotated. |
| TOP_RIGHT | 2 | Image flipped horizontally. |
| BOTTOM_RIGHT | 3 | Image rotated by 180°. |
| BOTTOM_LEFT | 4 | Image flipped vertically. |
| LEFT_TOP | 5 | Image flipped horizontally and then rotated clockwise by 270°. |
| RIGHT_TOP | 6 | Image rotated clockwise by 90°. |
| RIGHT_BOTTOM | 7 | Image flipped horizontally and then rotated clockwise by 90°. |
| LEFT_BOTTOM | 8 | Image rotated clockwise by 270°. |
FocusMode23+
Enumerates the focus modes.
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| AF_A | 0 | Autofocus. |
| AF_S | 1 | Single autofocus. |
| AF_C | 2 | Continuous autofocus. |
| MF | 3 | Manual focus. |
XmageColorMode23+
Enumerates the XMAGE color modes.
Model restriction: This API can be used only in the stage model.
System capability: SystemCapability.Multimedia.Image.Core
| Name | Value | Description |
|---|---|---|
| NORMAL | 0 | Standard. |
| BRIGHT | 1 | Bright. |
| SOFT | 2 | Soft focus. |
| MONO | 3 | Monochrome. |