AppBroadcastStreamVideoHeader AppBroadcastStreamVideoHeader AppBroadcastStreamVideoHeader AppBroadcastStreamVideoHeader Class

Definition

Provides metadata about a broadcast video frame.

Note

This API requires the appBroadcast and appBroadcastSettings capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime.

public : sealed class AppBroadcastStreamVideoHeader : IAppBroadcastStreamVideoHeaderpublic sealed class AppBroadcastStreamVideoHeader : IAppBroadcastStreamVideoHeaderPublic NotInheritable Class AppBroadcastStreamVideoHeader Implements IAppBroadcastStreamVideoHeader// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppBroadcastContract (introduced v1)
Capabilities
appBroadcastSettings appBroadcast

Remarks

Get an instance of this class by accessing the VideoHeader property of an AppBroadcastStreamVideoFrame object obtained from a call to AppBroadcastStreamReader.TryGetNextVideoFrame.

Properties

AbsoluteTimestamp AbsoluteTimestamp AbsoluteTimestamp AbsoluteTimestamp

Gets a time stamp indicating the system time at which the video frame was captured.

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

A time stamp indicating the system time at which the audio frame was captured.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppBroadcastContract (introduced v1)
Capabilities
appBroadcastSettings appBroadcast

Duration Duration Duration Duration

Gets a value indicating the duration of the video frame.

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

The duration of the video frame.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppBroadcastContract (introduced v1)
Capabilities
appBroadcastSettings appBroadcast

FrameId FrameId FrameId FrameId

Gets a value that identifies the video frame.

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

A value that identifies the video frame.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppBroadcastContract (introduced v1)
Capabilities
appBroadcastSettings appBroadcast

HasDiscontinuity HasDiscontinuity HasDiscontinuity HasDiscontinuity

Gets a value indicating whether the video frame contains a discontinuity in the video stream.

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

True if the video frame contains a discontinuity; otherwise, false.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppBroadcastContract (introduced v1)
Capabilities
appBroadcastSettings appBroadcast

IsKeyFrame IsKeyFrame IsKeyFrame IsKeyFrame

Gets a value indicating whether the video frame is a key frame within the broadcast video stream.

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

True is the video frame is a key frame; otherwise, false.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppBroadcastContract (introduced v1)
Capabilities
appBroadcastSettings appBroadcast

RelativeTimestamp RelativeTimestamp RelativeTimestamp RelativeTimestamp

Gets a time stamp indicating the relative time within the video stream at which the video frame was captured.

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

The relative time within the video stream at which the video frame was captured.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppBroadcastContract (introduced v1)
Capabilities
appBroadcastSettings appBroadcast