AppBroadcastStreamAudioHeader AppBroadcastStreamAudioHeader AppBroadcastStreamAudioHeader AppBroadcastStreamAudioHeader Class

Definition

Provides metadata about a broadcast audio 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 AppBroadcastStreamAudioHeader : IAppBroadcastStreamAudioHeaderpublic sealed class AppBroadcastStreamAudioHeader : IAppBroadcastStreamAudioHeaderPublic NotInheritable Class AppBroadcastStreamAudioHeader Implements IAppBroadcastStreamAudioHeader// 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 AudioHeader property of an AppBroadcastStreamAudioFrame object obtained from a call to AppBroadcastStreamReader.TryGetNextAudioFrame.

Properties

AbsoluteTimestamp AbsoluteTimestamp AbsoluteTimestamp AbsoluteTimestamp

Gets a time stamp indicating the system time at which the audio 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 audio 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 audio 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 audio 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 audio 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 audio frame contains a discontinuity in the audio 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 audio 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

RelativeTimestamp RelativeTimestamp RelativeTimestamp RelativeTimestamp

Gets a time stamp indicating the relative time within the audio stream at which the audio 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

A time stamp indicating the relative time within the audio stream 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