AppBroadcastBackgroundServiceStreamInfo
AppBroadcastBackgroundServiceStreamInfo
AppBroadcastBackgroundServiceStreamInfo
AppBroadcastBackgroundServiceStreamInfo
Class
Definition
Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Prerelease APIs are identified by a Prerelease label.
[Contains prerelease APIs.]
Manages the stream state of the app broadcast background service.
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 AppBroadcastBackgroundServiceStreamInfo : IAppBroadcastBackgroundServiceStreamInfopublic sealed class AppBroadcastBackgroundServiceStreamInfo : IAppBroadcastBackgroundServiceStreamInfoPublic NotInheritable Class AppBroadcastBackgroundServiceStreamInfo Implements IAppBroadcastBackgroundServiceStreamInfo// You can use this class in JavaScript.
- Attributes
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Properties
AudioCodec AudioCodec AudioCodec AudioCodec
Gets or sets the audio codec used by the app broadcast background service.
public : PlatForm::String AudioCodec { get; set; }public string AudioCodec { get; set; }Public ReadWrite Property AudioCodec As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The audio codec used by the app broadcast background service.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
BandwidthTestBitrate BandwidthTestBitrate BandwidthTestBitrate BandwidthTestBitrate
Gets or sets the bandwidth test bitrate for the app broadcast background service.
public : ulong BandwidthTestBitrate { get; set; }public ulong BandwidthTestBitrate { get; set; }Public ReadWrite Property BandwidthTestBitrate As ulong// You can use this property in JavaScript.
- Value
- ulong ulong ulong ulong
The bandwidth test bitrate for the app broadcast background service.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
BroadcastStreamReader BroadcastStreamReader BroadcastStreamReader BroadcastStreamReader
Gets the broadcast stream reader for the app broadcast background service.
public : AppBroadcastStreamReader BroadcastStreamReader { get; }public AppBroadcastStreamReader BroadcastStreamReader { get; }Public ReadOnly Property BroadcastStreamReader As AppBroadcastStreamReader// You can use this property in JavaScript.
- Value
- AppBroadcastStreamReader AppBroadcastStreamReader AppBroadcastStreamReader AppBroadcastStreamReader
The broadcast stream reader for the app broadcast background service.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
DesiredVideoEncodingBitrate DesiredVideoEncodingBitrate DesiredVideoEncodingBitrate DesiredVideoEncodingBitrate
Gets or sets the desired video encoding bitrate for the app broadcast background service.
public : ulong DesiredVideoEncodingBitrate { get; set; }public ulong DesiredVideoEncodingBitrate { get; set; }Public ReadWrite Property DesiredVideoEncodingBitrate As ulong// You can use this property in JavaScript.
- Value
- ulong ulong ulong ulong
The desired video encoding bitrate for the app broadcast background service.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
StreamState StreamState StreamState StreamState
Gets a value indicating the app broadcast stream state.
public : AppBroadcastStreamState StreamState { get; }public AppBroadcastStreamState StreamState { get; }Public ReadOnly Property StreamState As AppBroadcastStreamState// You can use this property in JavaScript.
- Value
- AppBroadcastStreamState AppBroadcastStreamState AppBroadcastStreamState AppBroadcastStreamState
A value indicating the app broadcast stream state.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Methods
ReportProblemWithStream() ReportProblemWithStream() ReportProblemWithStream() ReportProblemWithStream()
Prerelease. Notifies the system that a problem with the broadcast stream has been detected.
public : void ReportProblemWithStream()public void ReportProblemWithStream()Public Function ReportProblemWithStream() As void// You can use this method in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.16257.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v2)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Remarks
The may be a problem with the broadcast stream if the FrameId of an audio or video frame is not an increment of 1 from the previous frame.
Events
StreamStateChanged StreamStateChanged StreamStateChanged StreamStateChanged
Occurs when the app broadcast stream state changes.
public : event TypedEventHandler StreamStateChanged<AppBroadcastBackgroundServiceStreamInfo, AppBroadcastStreamStateChangedEventArgs>public event TypedEventHandler StreamStateChanged<AppBroadcastBackgroundServiceStreamInfo, AppBroadcastStreamStateChangedEventArgs>Public Event StreamStateChanged<AppBroadcastBackgroundServiceStreamInfo, AppBroadcastStreamStateChangedEventArgs>// You can use this event in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
VideoEncodingBitrateChanged VideoEncodingBitrateChanged VideoEncodingBitrateChanged VideoEncodingBitrateChanged
Occurs when the app broadcast video encoding bitrate changes.
public : event TypedEventHandler VideoEncodingBitrateChanged<AppBroadcastBackgroundServiceStreamInfo, object>public event TypedEventHandler VideoEncodingBitrateChanged<AppBroadcastBackgroundServiceStreamInfo, object>Public Event VideoEncodingBitrateChanged<AppBroadcastBackgroundServiceStreamInfo, object>// You can use this event in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
VideoEncodingResolutionChanged VideoEncodingResolutionChanged VideoEncodingResolutionChanged VideoEncodingResolutionChanged
Occurs when the app broadcast video encoding resolution changes.
public : event TypedEventHandler VideoEncodingResolutionChanged<AppBroadcastBackgroundServiceStreamInfo, object>public event TypedEventHandler VideoEncodingResolutionChanged<AppBroadcastBackgroundServiceStreamInfo, object>Public Event VideoEncodingResolutionChanged<AppBroadcastBackgroundServiceStreamInfo, object>// You can use this event in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|