AppBroadcastGlobalSettings
AppBroadcastGlobalSettings
AppBroadcastGlobalSettings
AppBroadcastGlobalSettings
Class
Definition
Specifies global broadcasting settings that persist across all broadcasting UWP apps.
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 AppBroadcastGlobalSettings : IAppBroadcastGlobalSettingspublic sealed class AppBroadcastGlobalSettings : IAppBroadcastGlobalSettingsPublic NotInheritable Class AppBroadcastGlobalSettings Implements IAppBroadcastGlobalSettings// You can use this class in JavaScript.
- Attributes
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Remarks
Get an instance of this class by calling AppBroadcastManager.GetGlobalSettings.
Properties
CameraOverlayLocation CameraOverlayLocation CameraOverlayLocation CameraOverlayLocation
Gets or sets a value that specifies the location of the camera overlay within the broadcast video frame.
public : AppBroadcastCameraOverlayLocation CameraOverlayLocation { get; set; }public AppBroadcastCameraOverlayLocation CameraOverlayLocation { get; set; }Public ReadWrite Property CameraOverlayLocation As AppBroadcastCameraOverlayLocation// You can use this property in JavaScript.
- Value
- AppBroadcastCameraOverlayLocation AppBroadcastCameraOverlayLocation AppBroadcastCameraOverlayLocation AppBroadcastCameraOverlayLocation
A value that specifies the location of the camera overlay within the broadcast video frame.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
CameraOverlaySize CameraOverlaySize CameraOverlaySize CameraOverlaySize
Gets or sets a value that specifies the size of the camera overlay within the broadcast video frame.
public : AppBroadcastCameraOverlaySize CameraOverlaySize { get; set; }public AppBroadcastCameraOverlaySize CameraOverlaySize { get; set; }Public ReadWrite Property CameraOverlaySize As AppBroadcastCameraOverlaySize// You can use this property in JavaScript.
- Value
- AppBroadcastCameraOverlaySize AppBroadcastCameraOverlaySize AppBroadcastCameraOverlaySize AppBroadcastCameraOverlaySize
A value that specifies the size of the camera overlay within the broadcast video frame.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
HasHardwareEncoder HasHardwareEncoder HasHardwareEncoder HasHardwareEncoder
Gets a value indicating whether the current device supports hardware-based media encoding.
public : PlatForm::Boolean HasHardwareEncoder { get; }public bool HasHardwareEncoder { get; }Public ReadOnly Property HasHardwareEncoder As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the device supports hardware encoding; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
IsAudioCaptureEnabled IsAudioCaptureEnabled IsAudioCaptureEnabled IsAudioCaptureEnabled
Gets or sets a value indicating whether audio capture is enabled for broadcasting.
public : PlatForm::Boolean IsAudioCaptureEnabled { get; set; }public bool IsAudioCaptureEnabled { get; set; }Public ReadWrite Property IsAudioCaptureEnabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if audio capture is enabled; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
IsBroadcastEnabled IsBroadcastEnabled IsBroadcastEnabled IsBroadcastEnabled
Gets a value that indicates if broadcasting is enabled on the device.
public : PlatForm::Boolean IsBroadcastEnabled { get; }public bool IsBroadcastEnabled { get; }Public ReadOnly Property IsBroadcastEnabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if broadcasting is enabled on the device; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
IsCameraCaptureEnabledByDefault IsCameraCaptureEnabledByDefault IsCameraCaptureEnabledByDefault IsCameraCaptureEnabledByDefault
Gets or sets a value indicating whether camera capture for broadcasting is enabled by default.
public : PlatForm::Boolean IsCameraCaptureEnabledByDefault { get; set; }public bool IsCameraCaptureEnabledByDefault { get; set; }Public ReadWrite Property IsCameraCaptureEnabledByDefault As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if camera capture is enabled by default; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
IsCursorImageCaptureEnabled IsCursorImageCaptureEnabled IsCursorImageCaptureEnabled IsCursorImageCaptureEnabled
Gets a value indicating whether the cursor image is captured.
public : PlatForm::Boolean IsCursorImageCaptureEnabled { get; set; }public bool IsCursorImageCaptureEnabled { get; set; }Public ReadWrite Property IsCursorImageCaptureEnabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the cursor image is captured; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
IsDisabledByPolicy IsDisabledByPolicy IsDisabledByPolicy IsDisabledByPolicy
Gets a value that indicates if broadcasting is disabled on the device by group policy.
public : PlatForm::Boolean IsDisabledByPolicy { get; }public bool IsDisabledByPolicy { get; }Public ReadOnly Property IsDisabledByPolicy As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if broadcasting is disabled on the device by group policy; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
IsEchoCancellationEnabled IsEchoCancellationEnabled IsEchoCancellationEnabled IsEchoCancellationEnabled
Gets or sets a value indicating whether echo cancellation is enabled.
public : PlatForm::Boolean IsEchoCancellationEnabled { get; set; }public bool IsEchoCancellationEnabled { get; set; }Public ReadWrite Property IsEchoCancellationEnabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if echo cancellation is enabled; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
IsGpuConstrained IsGpuConstrained IsGpuConstrained IsGpuConstrained
Gets a value indicating whether the GPU on the device is constrained.
public : PlatForm::Boolean IsGpuConstrained { get; }public bool IsGpuConstrained { get; }Public ReadOnly Property IsGpuConstrained As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the GPU is constrained; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
IsMicrophoneCaptureEnabledByDefault IsMicrophoneCaptureEnabledByDefault IsMicrophoneCaptureEnabledByDefault IsMicrophoneCaptureEnabledByDefault
Gets or sets a value indicating whether microphone capture for broadcasting is enabled by default.
public : PlatForm::Boolean IsMicrophoneCaptureEnabledByDefault { get; set; }public bool IsMicrophoneCaptureEnabledByDefault { get; set; }Public ReadWrite Property IsMicrophoneCaptureEnabledByDefault As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if microphone capture is enabled by default; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
MicrophoneGain MicrophoneGain MicrophoneGain MicrophoneGain
Gets or sets a value indicating the microphone gain for broadcast audio capture.
public : double MicrophoneGain { get; set; }public double MicrophoneGain { get; set; }Public ReadWrite Property MicrophoneGain As double// You can use this property in JavaScript.
- Value
- double double double double
The microphone gain for broadcast audio capture.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
SelectedCameraId SelectedCameraId SelectedCameraId SelectedCameraId
Gets or sets a string containing the device ID of the camera used for broadcast video capture.
public : PlatForm::String SelectedCameraId { get; set; }public string SelectedCameraId { get; set; }Public ReadWrite Property SelectedCameraId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The device ID of the camera used for broadcast video capture.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
SystemAudioGain SystemAudioGain SystemAudioGain SystemAudioGain
Gets or sets the system gain for broadcast audio capture.
public : double SystemAudioGain { get; set; }public double SystemAudioGain { get; set; }Public ReadWrite Property SystemAudioGain As double// You can use this property in JavaScript.
- Value
- double double double double
The system gain for broadcast audio capture.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|