AppCaptureSettings Class

Definition

Namespace:

Windows.Media.Capture

Represents app capture settings.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

public ref class AppCaptureSettings sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Media.Capture.AppCaptureContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AppCaptureSettings final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Media.Capture.AppCaptureContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AppCaptureSettings

Public NotInheritable Class AppCaptureSettings

Inheritance

Object Platform::Object IInspectable AppCaptureSettings

Attributes

ContractVersionAttribute ThreadingAttribute

Windows requirements

Device family	Windows Desktop Extension SDK (introduced in 10.0.10240.0)
API contract	Windows.Media.Capture.AppCaptureContract (introduced in v1.0)
App capabilities	appCaptureSettings

Remarks

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

Version history

Windows version	SDK version	Value added
1511	10586	IsMicrophoneCaptureEnabled
1607	14393	IsMicrophoneCaptureEnabledByDefault
1607	14393	MicrophoneGain
1607	14393	SystemAudioGain
1607	14393	VideoEncodingFrameRateMode
1703	15063	IsCursorImageCaptureEnabled
1703	15063	IsEchoCancellationEnabled

Properties

AlternateShortcutKeys	Gets the alternate shortcut key settings. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
AppCaptureDestinationFolder	Gets or sets the app capture destination folder. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
AudioEncodingBitrate	Gets or sets the audio encoding bitrate. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
CustomVideoEncodingBitrate	Gets or sets the custom video encoding bitrate. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
CustomVideoEncodingHeight	Gets or sets the custom video encoding height. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
CustomVideoEncodingWidth	Gets the custom video encoding width. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
HasHardwareEncoder	Gets a value indicating if the device has a hardware encoder. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
HistoricalBufferLength	Gets or sets the historical buffer length. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
HistoricalBufferLengthUnit	Gets or sets the units of the historical buffer length. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsAppCaptureEnabled	Gets or sets a value indicating if app capture is enabled. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsAudioCaptureEnabled	Gets or sets a value indicating whether audio capture is enabled.
IsCpuConstrained	Gets a value indicating if app capture is CPU-constrained. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsCursorImageCaptureEnabled	Gets a value indicating whether the cursor image is captured.
IsDisabledByPolicy	Gets a value indicating if app capture is disabled by policy. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsEchoCancellationEnabled	Gets a value indicating whether echo cancellation is enabled for app capture.
IsGpuConstrained	Gets a value indicating if app capture is GPU-constrained. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsHistoricalCaptureEnabled	Gets or sets a value indicating if historical capture is enabled. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsHistoricalCaptureOnBatteryAllowed	Gets or sets a value indicating whether historical capture is allowed while the device is on battery power. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsHistoricalCaptureOnWirelessDisplayAllowed	Gets or sets a value indicating whether historical capture is allowed on wireless displays. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsMemoryConstrained	Gets a value indicating whether the device is memory-constrained. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsMicrophoneCaptureEnabled	Gets or sets a value indicating if microphone capture is enabled. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsMicrophoneCaptureEnabledByDefault	Gets or sets a value indicating if microphone capture is enabled by default. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
MaximumRecordLength	Gets or sets the maximum recording length. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
MicrophoneGain	Gets or sets a value specifying the gain applied to the microphone audio. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
ScreenshotDestinationFolder	Gets or sets the screenshot destination folder. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
SystemAudioGain	Gets or sets a value specifying the gain applied to the system audio. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
VideoEncodingBitrateMode	Gets or sets the video encoding bitrate. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
VideoEncodingFrameRateMode	Gets or sets a value indicating the video encoding frame rate mode. Note This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
VideoEncodingResolutionMode	Gets or sets the video encoding resolution mode.

See also

• Object