getImageInfo(params: Object)

Requires:
BaseKit≥2.4.3@ray-js/ray≥0.5.9
Platforms:
iOSAndroid
import { getImageInfo } from '@ray-js/ray';

// Promise usage
try {
  const res = await getImageInfo({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Get image information

Parameters

PropertyTypeRequiredDescription
srcstringYesImage path; supports network and local paths
complete() => voidNoCompletion callback (executed on both success and failure)
success(params: Object) => voidNoCallback on successful API call
fail(params: Object) => voidNoFailure callback
success callback parameters
PropertyTypeDescriptionBaseKit Since
widthnumberOriginal image width, in px. Ignoring rotation.v3.2.6
heightnumberOriginal image height, in px. Ignoring rotation.v3.2.6
orientationstringDevice orientation at capture Valid values Description up Default orientation (phone held horizontally), corresponds to 1 in Exif; or no orientation info. up-mirrored Same as up, but mirrored; corresponds to 2 in Exif down Rotated 180°, corresponds to 3 in Exif down-mirrored Same as down, but mirrored; corresponds to 4 in Exif left-mirrored Same as left, but mirrored; corresponds to 5 in Exif right Rotated 90° clockwise, corresponds to 6 in Exif right-mirrored Same as right, but mirrored; corresponds to 7 in Exif left Rotated 90° counterclockwise, corresponds to 8 in Exifv3.2.6
typestringImage format. Valid values Description unknown Unknown format jpeg JPEG compressed format png PNG compressed format gif GIF compressed format tiff TIFF compressed formatv3.2.6
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

import { getImageInfo } from '@ray-js/ray'

// Get image info: src supports network/local paths; using a network image here
getImageInfo({
  src: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_image.jpg",
  success: data => console.log("Width/height/format/orientation:", data.width, data.height, data.type, data.orientation),
  fail: error => console.error(error),
});