ImageEncodingProperties Class

Definition

Describes the format of an image stream.

public ref class ImageEncodingProperties sealed
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.DualApiPartition(version=100794368)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Static(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics2, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Static(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ImageEncodingProperties sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.DualApiPartition(version=100794368)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics, 65536, "Windows.Foundation.UniversalApiContract")]
class ImageEncodingProperties sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.DualApiPartition(version=100794368)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics3, 458752, "Windows.Foundation.UniversalApiContract")]
class ImageEncodingProperties sealed
[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.DualApiPartition(version=100794368)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics2), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Static(typeof(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ImageEncodingProperties
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.DualApiPartition(version=100794368)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class ImageEncodingProperties
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.DualApiPartition(version=100794368)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.Media.MediaProperties.IImageEncodingPropertiesStatics3), 458752, "Windows.Foundation.UniversalApiContract")]
public sealed class ImageEncodingProperties
function ImageEncodingProperties()
Public NotInheritable Class ImageEncodingProperties
Inheritance
ImageEncodingProperties
Attributes
Implements

Windows 10 requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

For how-to guidance for using ImageEncodingProperties to set the encoding properties for captured images, see Basic photo, video, and audio capture with MediaCapture.

Version history

Windows version SDK version Value added
1803 17134 Copy
1809 17763 CreateHeif

Constructors

ImageEncodingProperties()

Creates a new instance of the ImageEncodingProperties class.

Properties

Height

Gets or sets the image height.

Properties

Gets additional format properties for the image stream.

Subtype

Gets or sets the subtype of the format.

Type

Gets the format type.

Width

Gets or sets the image width.

Methods

Copy()

Creates a copy of the ImageEncodingProperties object.

CreateBmp()

Creates an instance of ImageEncodingProperties for a BMP image.

CreateHeif()

Creates an instance of ImageEncodingProperties for HEIF format.

CreateJpeg()

Creates an instance of ImageEncodingProperties for a JPEG image.

CreateJpegXR()

Creates an instance of ImageEncodingProperties for a JPEG XR image.

CreatePng()

Creates an instance of ImageEncodingProperties for a PNG image.

CreateUncompressed(MediaPixelFormat)

Creates an instance of ImageEncodingProperties for an uncompressed image.

Applies to

See also