AppBroadcastPreview AppBroadcastPreview AppBroadcastPreview AppBroadcastPreview Class

Definition

Provides status information and access to the app broadcast preview.

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 AppBroadcastPreview : IAppBroadcastPreviewpublic sealed class AppBroadcastPreview : IAppBroadcastPreviewPublic NotInheritable Class AppBroadcastPreview Implements IAppBroadcastPreview// 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

Properties

ErrorCode ErrorCode ErrorCode ErrorCode

Gets the error code associated with the app broadcast preview.

public : IReference<uint> ErrorCode { get; }public Nullable<uint> ErrorCode { get; }Public ReadOnly Property ErrorCode As Nullable<uint>// You can use this property in JavaScript.
Value
IReference<unsigned int> Nullable<uint> Nullable<uint> Nullable<uint>

The error code associated with the app broadcast preview.

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

PreviewState PreviewState PreviewState PreviewState

Gets a value that indicates the state of the app broadcast preview.

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

A value that indicates the state of the app broadcast preview.

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

PreviewStreamReader PreviewStreamReader PreviewStreamReader PreviewStreamReader

Gets a stream reader for the app broadcast preview.

public : AppBroadcastPreviewStreamReader PreviewStreamReader { get; }public AppBroadcastPreviewStreamReader PreviewStreamReader { get; }Public ReadOnly Property PreviewStreamReader As AppBroadcastPreviewStreamReader// You can use this property in JavaScript.
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

Methods

StopPreview() StopPreview() StopPreview() StopPreview()

Stope the app broadcast preview.

public : void StopPreview()public void StopPreview()Public Function StopPreview() As void// You can use this method in JavaScript.
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

Events

PreviewStateChanged PreviewStateChanged PreviewStateChanged PreviewStateChanged

Occurs when the state of the app broadcast preview changes.

public : event TypedEventHandler PreviewStateChanged<AppBroadcastPreview,  AppBroadcastPreviewStateChangedEventArgs>public event TypedEventHandler PreviewStateChanged<AppBroadcastPreview,  AppBroadcastPreviewStateChangedEventArgs>Public Event PreviewStateChanged<AppBroadcastPreview,  AppBroadcastPreviewStateChangedEventArgs>// You can use this event in JavaScript.
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