AppBroadcastProviderSettings AppBroadcastProviderSettings AppBroadcastProviderSettings AppBroadcastProviderSettings Class

Definition

Provides access to the settings of the remote broadcast provider service. These settings can be viewed and changed by the broadcast provider.

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 AppBroadcastProviderSettings : IAppBroadcastProviderSettingspublic sealed class AppBroadcastProviderSettings : IAppBroadcastProviderSettingsPublic NotInheritable Class AppBroadcastProviderSettings Implements IAppBroadcastProviderSettings// 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

Remarks

Get an instance of this class by calling AppBroadcastManager.GetProviderSettings.

Properties

AudioEncodingBitrate AudioEncodingBitrate AudioEncodingBitrate AudioEncodingBitrate

Gets or sets the audio encoding bitrate of the broadcast stream, in bits per second.

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

The audio encoding bitrate of the broadcast stream, in bits per second.

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

CustomVideoEncodingBitrate CustomVideoEncodingBitrate CustomVideoEncodingBitrate CustomVideoEncodingBitrate

Gets or sets a custom video encoding bitrate of the broadcast stream, in bits per second.

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

The custom video encoding bitrate of the broadcast stream, in bits per second.

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

Remarks

If you specify a custom video encoding bitrate, you should set the VideoEncodingBitrateMode to Custom.

CustomVideoEncodingHeight CustomVideoEncodingHeight CustomVideoEncodingHeight CustomVideoEncodingHeight

Gets or sets a custom video encoding height of the broadcast stream.

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

The custom video encoding height of the 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

Remarks

If you specify a custom video encoding height, you should set the VideoEncodingResolutionMode to Custom.

CustomVideoEncodingWidth CustomVideoEncodingWidth CustomVideoEncodingWidth CustomVideoEncodingWidth

Gets or sets a custom video encoding width of the broadcast stream.

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

The custom video encoding width of the 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

Remarks

If you specify a custom video encoding width, you should set the VideoEncodingResolutionMode to Custom.

DefaultBroadcastTitle DefaultBroadcastTitle DefaultBroadcastTitle DefaultBroadcastTitle

Gets or sets the default title for broadcasts.

public : PlatForm::String DefaultBroadcastTitle { get; set; }public string DefaultBroadcastTitle { get; set; }Public ReadWrite Property DefaultBroadcastTitle As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The default title for broadcasts.

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

Remarks

Set the title of the current broadcast by setting the AppBroadcastBackgroundService.BroadcastTitle property.

VideoEncodingBitrateMode VideoEncodingBitrateMode VideoEncodingBitrateMode VideoEncodingBitrateMode

Gets or sets the video encoding bitrate mode for the remote broadcast provider service.

public : AppBroadcastVideoEncodingBitrateMode VideoEncodingBitrateMode { get; set; }public AppBroadcastVideoEncodingBitrateMode VideoEncodingBitrateMode { get; set; }Public ReadWrite Property VideoEncodingBitrateMode As AppBroadcastVideoEncodingBitrateMode// 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

Remarks

If you set this value to Custom, you should provide a value for the CustomVideoEncodingBitrate property.

VideoEncodingResolutionMode VideoEncodingResolutionMode VideoEncodingResolutionMode VideoEncodingResolutionMode

Gets or sets the video encoding resolution mode for the remote broadcast provider service.

public : AppBroadcastVideoEncodingResolutionMode VideoEncodingResolutionMode { get; set; }public AppBroadcastVideoEncodingResolutionMode VideoEncodingResolutionMode { get; set; }Public ReadWrite Property VideoEncodingResolutionMode As AppBroadcastVideoEncodingResolutionMode// 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

Remarks

If you set this value to Custom, you should provide a value for the CustomVideoEncodingWidth and CustomVideoEncodingHeight properties.