IMediaFrame IMediaFrame IMediaFrame IMediaFrame Interface

Definition

Represents a single frame of media data.

public : interface IMediaFramepublic interface IMediaFramePublic Interface IMediaFrame// You can use this interface in JavaScript.
Inheritance
IClosableIDisposableIDisposableIDisposable
IMediaFrameIMediaFrameIMediaFrameIMediaFrame
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited methods

Properties

Duration Duration Duration Duration

Gets or sets the duration of the media frame.

public : IReference<TimeSpan> Duration { get; set; }public Nullable<TimeSpan> Duration { get; set; }Public ReadWrite Property Duration As Nullable<TimeSpan>// You can use this property in JavaScript.
Value
IReference<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan>

The duration of the media frame.

ExtendedProperties ExtendedProperties ExtendedProperties ExtendedProperties

Gets the extended property set which enables getting and setting properties on the media frame.

public : IPropertySet ExtendedProperties { get; }public IPropertySet ExtendedProperties { get; }Public ReadOnly Property ExtendedProperties As IPropertySet// You can use this property in JavaScript.
Value
IPropertySet IPropertySet IPropertySet IPropertySet

The extended properties map.

IsDiscontinuous IsDiscontinuous IsDiscontinuous IsDiscontinuous

Gets or sets a value that indicates whether an media frame is the first frame after a gap in the stream.

public : PlatForm::Boolean IsDiscontinuous { get; set; }public bool IsDiscontinuous { get; set; }Public ReadWrite Property IsDiscontinuous As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if the media frame is the first frame after a gap in the stream; otherwise, false.

IsReadOnly IsReadOnly IsReadOnly IsReadOnly

Gets a value indicating whether the audio frame is read-only.

public : PlatForm::Boolean IsReadOnly { get; }public bool IsReadOnly { get; }Public ReadOnly Property IsReadOnly As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if the audio frame is read-only; otherwise, false.

Remarks

When this value is true, both the data payload and the mutable properties of the media frame are read-only.

RelativeTime RelativeTime RelativeTime RelativeTime

Gets or sets the relative time of the frame within the media stream.

public : IReference<TimeSpan> RelativeTime { get; set; }public Nullable<TimeSpan> RelativeTime { get; set; }Public ReadWrite Property RelativeTime As Nullable<TimeSpan>// You can use this property in JavaScript.
Value
IReference<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan>

The relative time of the frame within the media stream.

Remarks

Use SystemRelativeTime to get a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

SystemRelativeTime SystemRelativeTime SystemRelativeTime SystemRelativeTime

Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

public : IReference<TimeSpan> SystemRelativeTime { get; set; }public Nullable<TimeSpan> SystemRelativeTime { get; set; }Public ReadWrite Property SystemRelativeTime As Nullable<TimeSpan>// You can use this property in JavaScript.
Value
IReference<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan>

A timestamp relative to the system.

Remarks

Use RelativeTime to get a timestamp that is relative to the media stream.

Type Type Type Type

Gets a string indicating the type of data the media frame contains.

public : PlatForm::String Type { get; }public string Type { get; }Public ReadOnly Property Type As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

A string indicating the type of data the media frame contains.

See Also

  • IClosable IDisposable IDisposable IDisposable