AppBroadcastState Class

Definition

Namespace:

Windows.Media.Capture

Represents and manages the state of an app broadcast.

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 ref class AppBroadcastState sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Media.Capture.AppBroadcastContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AppBroadcastState final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Media.Capture.AppBroadcastContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AppBroadcastState

Public NotInheritable Class AppBroadcastState

Inheritance

Object Platform::Object IInspectable AppBroadcastState

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows Desktop Extension SDK (introduced in 10.0.15063.0)
API contract	Windows.Media.Capture.AppBroadcastContract (introduced in v1.0)
App capabilities	appBroadcast appBroadcastSettings

Remarks

This API may throw an error if the background service has shut down due to idle timeout.

Properties

AuthenticationResult	Gets the authentication result of the app broadcast state.
CameraCaptureError	Gets the camera capture error associated with the app broadcast state.
CameraCaptureState	Gets the camera capture state.
EncodedVideoSize	Gets the encoded video size of the app broadcast.
IsCaptureTargetRunning	Gets a value indicating if the capture target is currently running.
MicrophoneCaptureError	Gets the microphone capture error associated with the app broadcast state.
MicrophoneCaptureState	Gets the microphone capture state.
OAuthCallbackUri	Gets the OAuth callback URI associated with the app broadcast state.
OAuthRequestUri	Gets the OAuth request URI associated with the app broadcast state.
PlugInState	Gets the state of the plugin associated with the app broadcast state.
ShouldCaptureCamera	Gets or sets a value specifying whether the camera should be captured for the app broadcast.
ShouldCaptureMicrophone	Gets or sets a value specifying whether the microphone should be captured for the app broadcast.
SignInState	Gets or sets a value specifying the sign-in state of the app broadcast.
StreamState	Gets a value specifying the state of the app broadcast stream.
TerminationReason	Gets a value specifying the reason that the app broadcast was terminated.
TerminationReasonPlugInSpecific	Gets a value indicating the plug-in-specified reason that app broadcast was terminated.
ViewerCount	Gets the viewer count of the app broadcast.

Methods

RestartCameraCapture()	Restarts camera capture for the app broadcast.
RestartMicrophoneCapture()	Restarts microphone capture for the app broadcast.

Events

CameraCaptureStateChanged	Occurs when the camera capture state changes.
CaptureTargetClosed	Occurs when the capture target is closed.
MicrophoneCaptureStateChanged	Occurs when the microphone capture state changes.
PlugInStateChanged	Occurs when the state of the plugin associated with the app broadcast state changes.
StreamStateChanged	Occurs when the stream state of the app broadcast changes.
ViewerCountChanged	Occurs when the viewer count of the app broadcast changes.