Remove-ImageMetadata

Namespace ImagePlayground

Inputs

System.String

Removes selected metadata from an image.

Remarks

JPEG and PNG files are rewritten without re-encoding their compressed image data. Choose individual metadata families, or use All for the compatibility behavior that removes every supported family. HEIF and HEIC cleanup is limited to EXIF and XMP.

Examples

Authored help example

Save a copy without metadata


Remove-ImageMetadata -FilePath in.jpg -OutputPath out.jpg -All

Remove C2PA Content Credentials but preserve EXIF, XMP, IPTC, and ICC metadata


Remove-ImageMetadata -FilePath in.jpg -OutputPath out.jpg -MetadataType C2pa

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

Remove-ImageMetadata [-All] -FilePath <String> [-MetadataType <Exif>] -OutputPath <String> [-PassThru] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

All SwitchParameter optionalposition: namedpipeline: False: Remove every metadata family supported by the image format.
FilePath String requiredposition: 0pipeline: True (ByValue): Source image file.
MetadataType ImageMetadataType[] optionalposition: namedpipeline: Falsevalues: 6: Metadata families to remove. When omitted, all supported metadata is removed for backward compatibility.; Possible values: Exif, Xmp, Iptc, Icc, C2pa, All
OutputPath String requiredposition: 1pipeline: False: Destination image path.
PassThru SwitchParameter optionalposition: namedpipeline: False: Return a result describing which metadata was removed and whether re-encoding occurred.