AppCaptureState AppCaptureState AppCaptureState AppCaptureState Class

Definition

Represents the state of app capture.

public : sealed class AppCaptureState : IAppCaptureStatepublic sealed class AppCaptureState : IAppCaptureStatePublic NotInheritable Class AppCaptureState Implements IAppCaptureState// 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.AppCaptureContract (introduced v4)
Capabilities
appCaptureSettings

Properties

IsHistoricalCaptureEnabled IsHistoricalCaptureEnabled IsHistoricalCaptureEnabled IsHistoricalCaptureEnabled

Gets a value specifying whether historical app capture is enabled.

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

True if the historical app capture is enabled; otherwise, false.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppCaptureContract (introduced v4)
Capabilities
appCaptureSettings

IsTargetRunning IsTargetRunning IsTargetRunning IsTargetRunning

Gets a value indicating whether the app capture target is currently running.

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

True if the app 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.AppCaptureContract (introduced v4)
Capabilities
appCaptureSettings

MicrophoneCaptureError MicrophoneCaptureError MicrophoneCaptureError MicrophoneCaptureError

Gets an error code associated with microphone capture for app capture.

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

An error code associated with microphone capture for app capture.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppCaptureContract (introduced v4)
Capabilities
appCaptureSettings

MicrophoneCaptureState MicrophoneCaptureState MicrophoneCaptureState MicrophoneCaptureState

Gets the current microphone capture state.

public : AppCaptureMicrophoneCaptureState MicrophoneCaptureState { get; }public AppCaptureMicrophoneCaptureState MicrophoneCaptureState { get; }Public ReadOnly Property MicrophoneCaptureState As AppCaptureMicrophoneCaptureState// 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.AppCaptureContract (introduced v4)
Capabilities
appCaptureSettings

ShouldCaptureMicrophone ShouldCaptureMicrophone ShouldCaptureMicrophone ShouldCaptureMicrophone

Gets a value specifying whether the microphone should be captured.

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

True if the microphone should be captured; otherwise, false.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.15063.0)
API contract
Windows.Media.Capture.AppCaptureContract (introduced v4)
Capabilities
appCaptureSettings

Methods

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

Restarts microphone capture for app capture.

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.AppCaptureContract (introduced v4)
Capabilities
appCaptureSettings

Events

CaptureTargetClosed CaptureTargetClosed CaptureTargetClosed CaptureTargetClosed

Occurs when the capture target is closed.

public : event TypedEventHandler CaptureTargetClosed<AppCaptureState,  object>public event TypedEventHandler CaptureTargetClosed<AppCaptureState,  object>Public Event CaptureTargetClosed<AppCaptureState,  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.AppCaptureContract (introduced v4)
Capabilities
appCaptureSettings

MicrophoneCaptureStateChanged MicrophoneCaptureStateChanged MicrophoneCaptureStateChanged MicrophoneCaptureStateChanged

Occurs when the state of microphone capture for app capture changes.

public : event TypedEventHandler MicrophoneCaptureStateChanged<AppCaptureState,  AppCaptureMicrophoneCaptureStateChangedEventArgs>public event TypedEventHandler MicrophoneCaptureStateChanged<AppCaptureState,  AppCaptureMicrophoneCaptureStateChangedEventArgs>Public Event MicrophoneCaptureStateChanged<AppCaptureState,  AppCaptureMicrophoneCaptureStateChangedEventArgs>// 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.AppCaptureContract (introduced v4)
Capabilities
appCaptureSettings