程序包 ohos.media.image

类 PropertyFilter

java.lang.Object

ohos.media.image.common.Filter

ohos.media.image.PropertyFilter

public class PropertyFilter
extends Filter

Provides methods for setting image Exif properties, including adding, deleting, and modifying Exif properties.

从以下版本开始:

4

SystemCapability

SystemCapability.Multimedia#IMAGE

构造器概要

构造器

构造器	说明
PropertyFilter()

方法概要

限定符和类型	方法	说明
long	applyToSource(ImageSource source)	Applies the configured Exif properties to the source file.
PropertyFilter	restore()	Restores all Exif properties.
PropertyFilter	rollbackProperty(String key)	Restores a specified Exif property.
PropertyFilter	setPropertyDouble(String key, double value)	Sets an Exif property of the double type.
PropertyFilter	setPropertyInt(String key, int value)	Sets an Exif property of the int type.
PropertyFilter	setPropertyString(String key, String value)	Sets an Exif property of the string type.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

PropertyFilter

public PropertyFilter()

方法详细资料

setPropertyInt

public PropertyFilter setPropertyInt(String key,
                                     int value)

Sets an Exif property of the int type.

参数:

key - Indicates the property key, which is defined in PropertyKey.

value - Indicates the property value.

返回:

Returns this PropertyFilter object with the Exif property of the int type. This object can be used for subsequent Exif-related operations.

从以下版本开始:

4

setPropertyDouble

public PropertyFilter setPropertyDouble(String key,
                                        double value)

Sets an Exif property of the double type.

参数:

key - Indicates the property key, which is defined in PropertyKey.

value - Indicates the property value.

返回:

Returns this PropertyFilter object with the Exif property of the double type. The object can be used for subsequent Exif-related operations.

从以下版本开始:

4

setPropertyString

public PropertyFilter setPropertyString(String key,
                                        String value)

Sets an Exif property of the string type.

参数:

key - Indicates the property key, which is defined in PropertyKey.

value - Indicates the property value.

返回:

Returns this PropertyFilter object with the Exif property of the string type. The object can be used for subsequent Exif-related operations.

从以下版本开始:

4

rollbackProperty

public PropertyFilter rollbackProperty(String key)

Restores a specified Exif property. This method applies only to the properties that have not been applied to the source file via applyToSource(ImageSource).

参数:

key - Indicates the property key, which is defined in PropertyKey.

返回:

Returns this PropertyFilter object with the restored Exif property. The object can be used for subsequent Exif-related operations.

从以下版本开始:

4

restore

public PropertyFilter restore()

Restores all Exif properties. This method applies only to the properties that have not been applied to the source file via applyToSource(ImageSource).

指定者:

restore 在类中 Filter

返回:

Returns this PropertyFilter object with the restored Exif properties. The object can be used for subsequent Exif-related operations.

从以下版本开始:

4

applyToSource

public long applyToSource(ImageSource source)
                   throws IOException

Applies the configured Exif properties to the source file.

This method requires the permission to modify the source file represented by the ImageSource object. The configured Exif properties do not take effect until this method is called.

This method is applicable to the ImageSource object that has been created based on a File object or a specified file path.

指定者:

applyToSource 在类中 Filter

参数:

source - Indicates the image source file to which the properties will be applied.

返回:

Returns the size (in bytes) of the image file edited based on the Exif properties if the operation is successful; returns -1 otherwise.

抛出:

IOException - Throws this exception if the modification permission has not been obtained.

IllegalArgumentException - Throws this exception if the image source is empty.

IllegalStateException - Throws this exception if the ImageSource object has been released.

从以下版本开始:

4