AppBroadcastBackgroundService
AppBroadcastBackgroundService
AppBroadcastBackgroundService
AppBroadcastBackgroundService
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 an interface between the broadcasting UWP app and the system-hosted broadcast service. This class provides access to objects that facilitate broadcast service authentication, test the bandwidth capabilities of the device's internet to the broadcasting provider service, and allow your task to acquire captured audio and video frames so that they can be sent to the broadcast provider service.
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 AppBroadcastBackgroundService : IAppBroadcastBackgroundServicepublic sealed class AppBroadcastBackgroundService : IAppBroadcastBackgroundServicePublic NotInheritable Class AppBroadcastBackgroundService Implements IAppBroadcastBackgroundService// 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 casting the TriggerDetails property of the IBackgroundTaskInstance passed into your background task's Run method to a AppBroadcastTriggerDetails and then accessing the BackgroundService property.
Properties
AppId AppId AppId AppId
Gets a string containing an identifier for the game being broadcast. When broadcasting on a desktop device, this value is the game on which the user initiated broadcasting.
public : PlatForm::String AppId { get; }public string AppId { get; }Public ReadOnly Property AppId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A string containing a system-defined identifier for the broadcasting app.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
BroadcastChannel BroadcastChannel BroadcastChannel BroadcastChannel
Prerelease. Gets a string containing the name of the current broadcast channel.
public : PlatForm::String BroadcastChannel { get; set; }public string BroadcastChannel { get; set; }Public ReadWrite Property BroadcastChannel As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A string containing the name of the current broadcast channel.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.16257.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v2)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
BroadcastLanguage BroadcastLanguage BroadcastLanguage BroadcastLanguage
Prerelease. Gets a string representing the language of the current broadcast channel.
public : PlatForm::String BroadcastLanguage { get; set; }public string BroadcastLanguage { get; set; }Public ReadWrite Property BroadcastLanguage As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A string representing the language of the current broadcast channel.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.16257.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v2)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
BroadcastTitle BroadcastTitle BroadcastTitle BroadcastTitle
Gets a string containing the user-specified title of the broadcast.
public : PlatForm::String BroadcastTitle { get; }public string BroadcastTitle { get; }Public ReadOnly Property BroadcastTitle As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A string containing the user-specified title of the broadcast.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
PlugInState PlugInState PlugInState PlugInState
Gets or sets a value specifying the current state of the broadcast background task.
public : AppBroadcastPlugInState PlugInState { get; set; }public AppBroadcastPlugInState PlugInState { get; set; }Public ReadWrite Property PlugInState As AppBroadcastPlugInState// You can use this property in JavaScript.
- Value
- AppBroadcastPlugInState AppBroadcastPlugInState AppBroadcastPlugInState AppBroadcastPlugInState
A value specifying the current state of the broadcast background task.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
SignInInfo SignInInfo SignInInfo SignInInfo
Gets an object that represents the sign-in information for the app broadcast background service.
public : AppBroadcastBackgroundServiceSignInInfo SignInInfo { get; set; }public AppBroadcastBackgroundServiceSignInInfo SignInInfo { get; set; }Public ReadWrite Property SignInInfo As AppBroadcastBackgroundServiceSignInInfo// You can use this property in JavaScript.
- Value
- AppBroadcastBackgroundServiceSignInInfo AppBroadcastBackgroundServiceSignInInfo AppBroadcastBackgroundServiceSignInInfo AppBroadcastBackgroundServiceSignInInfo
An object that represents the sign-in information for the app broadcast background service.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
StreamInfo StreamInfo StreamInfo StreamInfo
Gets an object that manages the stream state of the app broadcast background service.
public : AppBroadcastBackgroundServiceStreamInfo StreamInfo { get; set; }public AppBroadcastBackgroundServiceStreamInfo StreamInfo { get; set; }Public ReadWrite Property StreamInfo As AppBroadcastBackgroundServiceStreamInfo// You can use this property in JavaScript.
- Value
- AppBroadcastBackgroundServiceStreamInfo AppBroadcastBackgroundServiceStreamInfo AppBroadcastBackgroundServiceStreamInfo AppBroadcastBackgroundServiceStreamInfo
An object that manages the stream state of the app broadcast background service.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
TitleId TitleId TitleId TitleId
Gets a unique identifier for the title being broadcast.
public : PlatForm::String TitleId { get; }public string TitleId { get; }Public ReadOnly Property TitleId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A unique identifier for the title being broadcast.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
ViewerCount ViewerCount ViewerCount ViewerCount
Gets or sets the number of viewers of the broadcast.
public : unsigned int ViewerCount { get; set; }public uint ViewerCount { get; set; }Public ReadWrite Property ViewerCount As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The number of viewers of the broadcast.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Methods
TerminateBroadcast(AppBroadcastTerminationReason, UInt32) TerminateBroadcast(AppBroadcastTerminationReason, UInt32) TerminateBroadcast(AppBroadcastTerminationReason, UInt32) TerminateBroadcast(AppBroadcastTerminationReason, UInt32)
Terminates a broadcast.
public : void TerminateBroadcast(AppBroadcastTerminationReason reason, unsigned int providerSpecificReason)public void TerminateBroadcast(AppBroadcastTerminationReason reason, UInt32 providerSpecificReason)Public Function TerminateBroadcast(reason As AppBroadcastTerminationReason, providerSpecificReason As UInt32) As void// You can use this method in JavaScript.
- reason
- AppBroadcastTerminationReason AppBroadcastTerminationReason AppBroadcastTerminationReason AppBroadcastTerminationReason
A value indicating the reason that the broadcast is being terminated.
- providerSpecificReason
- unsigned int UInt32 UInt32 UInt32
An integer that conveys a provider-specific reason that the broadcast is being terminated.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Events
BroadcastChannelChanged BroadcastChannelChanged BroadcastChannelChanged BroadcastChannelChanged
Prerelease. Occurs when the value of the BroadcastChannel property changes.
public : event TypedEventHandler BroadcastChannelChanged<AppBroadcastBackgroundService, object>public event TypedEventHandler BroadcastChannelChanged<AppBroadcastBackgroundService, object>Public Event BroadcastChannelChanged<AppBroadcastBackgroundService, object>// You can use this event in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.16257.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v2)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
BroadcastLanguageChanged BroadcastLanguageChanged BroadcastLanguageChanged BroadcastLanguageChanged
Prerelease. Occurs when the value of the BroadcastLanguage property changes.
public : event TypedEventHandler BroadcastLanguageChanged<AppBroadcastBackgroundService, object>public event TypedEventHandler BroadcastLanguageChanged<AppBroadcastBackgroundService, object>Public Event BroadcastLanguageChanged<AppBroadcastBackgroundService, object>// You can use this event in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.16257.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v2)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
BroadcastTitleChanged BroadcastTitleChanged BroadcastTitleChanged BroadcastTitleChanged
Prerelease. Occurs when the value of the BroadcastTitle property changes.
public : event TypedEventHandler BroadcastTitleChanged<AppBroadcastBackgroundService, object>public event TypedEventHandler BroadcastTitleChanged<AppBroadcastBackgroundService, object>Public Event BroadcastTitleChanged<AppBroadcastBackgroundService, object>// You can use this event in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.16257.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v2)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
HeartbeatRequested HeartbeatRequested HeartbeatRequested HeartbeatRequested
Raised by the system periodically to confirm that the broadcasting background task is currently active.
public : event TypedEventHandler HeartbeatRequested<AppBroadcastBackgroundService, AppBroadcastHeartbeatRequestedEventArgs>public event TypedEventHandler HeartbeatRequested<AppBroadcastBackgroundService, AppBroadcastHeartbeatRequestedEventArgs>Public Event HeartbeatRequested<AppBroadcastBackgroundService, AppBroadcastHeartbeatRequestedEventArgs>// You can use this event in JavaScript.
| 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 Handled property to true to confirm that the background task is currently active. Failure to respond to this event and set the Handled property to true can result in the background task for the broadcast app being terminated.