AppBroadcastState AppBroadcastState AppBroadcastState AppBroadcastState Class

Definition

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 : sealed class AppBroadcastState : IAppBroadcastStatepublic sealed class AppBroadcastState : IAppBroadcastStatePublic NotInheritable Class AppBroadcastState Implements IAppBroadcastState// 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

AuthenticationResult AuthenticationResult AuthenticationResult AuthenticationResult

Gets the authentication result of the app broadcast state.

public : WebAuthenticationResult AuthenticationResult { get; set; }public WebAuthenticationResult AuthenticationResult { get; set; }Public ReadWrite Property AuthenticationResult As WebAuthenticationResult// You can use this property in JavaScript.
Value
WebAuthenticationResult WebAuthenticationResult WebAuthenticationResult WebAuthenticationResult

The authentication result of the app broadcast state.

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

CameraCaptureError CameraCaptureError CameraCaptureError CameraCaptureError

Gets the camera capture error associated with the app broadcast state.

public : unsigned int CameraCaptureError { get; }public uint CameraCaptureError { get; }Public ReadOnly Property CameraCaptureError As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The camera capture error associated with the app broadcast state.

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

CameraCaptureState CameraCaptureState CameraCaptureState CameraCaptureState

Gets the camera capture state.

public : AppBroadcastCameraCaptureState CameraCaptureState { get; }public AppBroadcastCameraCaptureState CameraCaptureState { get; }Public ReadOnly Property CameraCaptureState As AppBroadcastCameraCaptureState// 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

EncodedVideoSize EncodedVideoSize EncodedVideoSize EncodedVideoSize

Gets the encoded video size of the app broadcast.

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

The encoded video size of the app broadcast.

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

IsCaptureTargetRunning IsCaptureTargetRunning IsCaptureTargetRunning IsCaptureTargetRunning

Gets a value indicating if the capture target is currently running.

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

True if the capture target is currently running; 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

MicrophoneCaptureError MicrophoneCaptureError MicrophoneCaptureError MicrophoneCaptureError

Gets the microphone capture error associated with the app broadcast state.

public : unsigned int MicrophoneCaptureError { get; }public uint MicrophoneCaptureError { get; }Public ReadOnly Property MicrophoneCaptureError As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The microphone capture error associated with the app broadcast state.

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

MicrophoneCaptureState MicrophoneCaptureState MicrophoneCaptureState MicrophoneCaptureState

Gets the microphone capture state.

public : AppBroadcastMicrophoneCaptureState MicrophoneCaptureState { get; }public AppBroadcastMicrophoneCaptureState MicrophoneCaptureState { get; }Public ReadOnly Property MicrophoneCaptureState As AppBroadcastMicrophoneCaptureState// 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

OAuthCallbackUri OAuthCallbackUri OAuthCallbackUri OAuthCallbackUri

Gets the OAuth callback URI associated with the app broadcast state.

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

The OAuth callback URI.

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

OAuthRequestUri OAuthRequestUri OAuthRequestUri OAuthRequestUri

Gets the OAuth request URI associated with the app broadcast state.

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

The OAuth request URI.

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

PlugInState PlugInState PlugInState PlugInState

Gets the state of the plugin associated with the app broadcast state.

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

The state of the plugin associated with the app broadcast state.

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

ShouldCaptureCamera ShouldCaptureCamera ShouldCaptureCamera ShouldCaptureCamera

Gets or sets a value specifying whether the camera should be captured for the app broadcast.

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

A value specifying whether the camera should be captured for the app broadcast.

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

ShouldCaptureMicrophone ShouldCaptureMicrophone ShouldCaptureMicrophone ShouldCaptureMicrophone

Gets or sets a value specifying whether the microphone should be captured for the app broadcast.

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

A value specifying whether the microphone should be captured for the app broadcast.

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

SignInState SignInState SignInState SignInState

Gets or sets a value specifying the sign-in state of the app broadcast.

public : AppBroadcastSignInState SignInState { get; set; }public AppBroadcastSignInState SignInState { get; set; }Public ReadWrite Property SignInState As AppBroadcastSignInState// You can use this property in JavaScript.
Value
AppBroadcastSignInState AppBroadcastSignInState AppBroadcastSignInState AppBroadcastSignInState

A value specifying the sign-in state of the app broadcast.

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

StreamState StreamState StreamState StreamState

Gets a value specifying the state of the app broadcast stream.

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 specifying the state of the app broadcast stream.

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

TerminationReason TerminationReason TerminationReason TerminationReason

Gets a value specifying the reason that the app broadcast was terminated.

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

A value specifying the reason that the app broadcast was terminated.

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

TerminationReasonPlugInSpecific TerminationReasonPlugInSpecific TerminationReasonPlugInSpecific TerminationReasonPlugInSpecific

Gets a value indicating the plug-in-specified reason that app broadcast was terminated.

public : unsigned int TerminationReasonPlugInSpecific { get; }public uint TerminationReasonPlugInSpecific { get; }Public ReadOnly Property TerminationReasonPlugInSpecific As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

A value indicating the plug-in-specified reason that app broadcast was terminated.

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

ViewerCount ViewerCount ViewerCount ViewerCount

Gets the viewer count of the app broadcast.

public : unsigned int ViewerCount { get; }public uint ViewerCount { get; }Public ReadOnly Property ViewerCount As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The viewer count of the app broadcast.

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

RestartCameraCapture() RestartCameraCapture() RestartCameraCapture() RestartCameraCapture()

Restarts camera capture for the app broadcast.

public : void RestartCameraCapture()public void RestartCameraCapture()Public Function RestartCameraCapture() 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

RestartMicrophoneCapture() RestartMicrophoneCapture() RestartMicrophoneCapture() RestartMicrophoneCapture()

Restarts microphone capture for the app broadcast.

public : void RestartMicrophoneCapture()public void RestartMicrophoneCapture()Public Function RestartMicrophoneCapture() 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

CameraCaptureStateChanged CameraCaptureStateChanged CameraCaptureStateChanged CameraCaptureStateChanged

Occurs when the camera capture state changes.

public : event TypedEventHandler CameraCaptureStateChanged<AppBroadcastState,  AppBroadcastCameraCaptureStateChangedEventArgs>public event TypedEventHandler CameraCaptureStateChanged<AppBroadcastState,  AppBroadcastCameraCaptureStateChangedEventArgs>Public Event CameraCaptureStateChanged<AppBroadcastState,  AppBroadcastCameraCaptureStateChangedEventArgs>// 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

CaptureTargetClosed CaptureTargetClosed CaptureTargetClosed CaptureTargetClosed

Occurs when the capture target is closed.

public : event TypedEventHandler CaptureTargetClosed<AppBroadcastState,  object>public event TypedEventHandler CaptureTargetClosed<AppBroadcastState,  object>Public Event CaptureTargetClosed<AppBroadcastState,  object>// 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

MicrophoneCaptureStateChanged MicrophoneCaptureStateChanged MicrophoneCaptureStateChanged MicrophoneCaptureStateChanged

Occurs when the microphone capture state changes.

public : event TypedEventHandler MicrophoneCaptureStateChanged<AppBroadcastState,  AppBroadcastMicrophoneCaptureStateChangedEventArgs>public event TypedEventHandler MicrophoneCaptureStateChanged<AppBroadcastState,  AppBroadcastMicrophoneCaptureStateChangedEventArgs>Public Event MicrophoneCaptureStateChanged<AppBroadcastState,  AppBroadcastMicrophoneCaptureStateChangedEventArgs>// 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

PlugInStateChanged PlugInStateChanged PlugInStateChanged PlugInStateChanged

Occurs when the state of the plugin associated with the app broadcast state changes.

public : event TypedEventHandler PlugInStateChanged<AppBroadcastState,  AppBroadcastPlugInStateChangedEventArgs>public event TypedEventHandler PlugInStateChanged<AppBroadcastState,  AppBroadcastPlugInStateChangedEventArgs>Public Event PlugInStateChanged<AppBroadcastState,  AppBroadcastPlugInStateChangedEventArgs>// 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

StreamStateChanged StreamStateChanged StreamStateChanged StreamStateChanged

Occurs when the stream state of the app broadcast changes.

public : event TypedEventHandler StreamStateChanged<AppBroadcastState,  AppBroadcastStreamStateChangedEventArgs>public event TypedEventHandler StreamStateChanged<AppBroadcastState,  AppBroadcastStreamStateChangedEventArgs>Public Event StreamStateChanged<AppBroadcastState,  AppBroadcastStreamStateChangedEventArgs>// 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

ViewerCountChanged ViewerCountChanged ViewerCountChanged ViewerCountChanged

Occurs when the viewer count of the app broadcast changes.

public : event TypedEventHandler ViewerCountChanged<AppBroadcastState,  AppBroadcastViewerCountChangedEventArgs>public event TypedEventHandler ViewerCountChanged<AppBroadcastState,  AppBroadcastViewerCountChangedEventArgs>Public Event ViewerCountChanged<AppBroadcastState,  AppBroadcastViewerCountChangedEventArgs>// 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