AppCapture AppCapture AppCapture AppCapture 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.]
Provides information about the app capture feature.

public : sealed class AppCapture : IAppCapturepublic sealed class AppCapture : IAppCapturePublic NotInheritable Class AppCapture Implements IAppCapture// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Properties

IsCapturingAudio IsCapturingAudio IsCapturingAudio IsCapturingAudio

Gets a value indicating whether another app is currently capturing audio.

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

True if another app is currently capturing audio; otherwise, false.

IsCapturingVideo IsCapturingVideo IsCapturingVideo IsCapturingVideo

Gets a value indicating whether another app is currently capturing video.

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

True if another app is currently capturing video; otherwise, false.

Methods

GetForCurrentView() GetForCurrentView() GetForCurrentView() GetForCurrentView()

Gets the instance of this class for the current view.

public : static AppCapture GetForCurrentView()public static AppCapture GetForCurrentView()Public Static Function GetForCurrentView() As AppCapture// You can use this method in JavaScript.
Returns

The instance for the current view.

SetAllowedAsync(Boolean) SetAllowedAsync(Boolean) SetAllowedAsync(Boolean) SetAllowedAsync(Boolean)

Prerelease. Sets a value that specifies whether the app capture is currently allowed for the calling app.

public : static IAsyncAction SetAllowedAsync(bool allowed)public static IAsyncAction SetAllowedAsync(Boolean allowed)Public Static Function SetAllowedAsync(allowed As Boolean) As IAsyncAction// You can use this method in JavaScript.
Parameters
allowed
bool Boolean Boolean Boolean

True if app capture is allowed; otherwise, false.

Returns
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

The default value for this property is true, meaning that app capture is allowed. When an app sets this value, the set value does not persist across instances of the app.

Events

CapturingChanged CapturingChanged CapturingChanged CapturingChanged

Raised when the capturing status changes.

public : event TypedEventHandler CapturingChanged<AppCapture,  object>public event TypedEventHandler CapturingChanged<AppCapture,  object>Public Event CapturingChanged<AppCapture,  object>// You can use this event in JavaScript.

Remarks

Warning

You must unregister the handler for this event when your app is suspended.