Set-ImageHeifXmp

Namespace ImagePlayground

Inputs

System.String

Sets the XMP metadata packet in a HEIF or HEIC file.

Remarks

Requires an existing HEIF XMP item with a single writable file extent.

Examples

Authored help example

Set a HEIC XMP packet from a string


Set-ImageHeifXmp -FilePath photo.heic -Xmp $packet

Set a HEIC XMP packet from a file


Set-ImageHeifXmp -FilePath photo.heic -XmpPath packet.xmp -FilePathOutput photo-updated.heic

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Set-ImageHeifXmp -FilePath <String> [-FilePathOutput <String>] -Xmp <String> [<CommonParameters>]

Parameter set: Xmp

Parameters

FilePath String requiredposition: 0pipeline: True (ByValue): Path to the HEIF or HEIC file.
FilePathOutput String optionalposition: 1pipeline: False: When not specified the source file is overwritten.
Xmp String requiredposition: 2pipeline: False: XMP metadata packet to write.

Set-ImageHeifXmp -FilePath <String> [-FilePathOutput <String>] -XmpPath <String> [<CommonParameters>]

Parameter set: XmpPath

Parameters

FilePath String requiredposition: 0pipeline: True (ByValue): Path to the HEIF or HEIC file.
FilePathOutput String optionalposition: 1pipeline: False: When not specified the source file is overwritten.
XmpPath String requiredposition: 2pipeline: False: Path to a UTF-8 XMP metadata packet file.