AppBroadcastServices
AppBroadcastServices
AppBroadcastServices
AppBroadcastServices
Class
Definition
Manages the state of app broadcasts.
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 AppBroadcastServices : IAppBroadcastServicespublic sealed class AppBroadcastServices : IAppBroadcastServicesPublic NotInheritable Class AppBroadcastServices Implements IAppBroadcastServices// 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 |
appBroadcastServices
appBroadcastSettings
appBroadcast
|
Properties
BroadcastLanguage BroadcastLanguage BroadcastLanguage BroadcastLanguage
Gets or sets a string that specifies the language settings for app broadast.
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 that specifies the language settings for app broadast.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
BroadcastTitle BroadcastTitle BroadcastTitle BroadcastTitle
Gets or sets the title of the broadcast.
public : PlatForm::String BroadcastTitle { get; set; }public string BroadcastTitle { get; set; }Public ReadWrite Property BroadcastTitle As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The 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
|
CanCapture CanCapture CanCapture CanCapture
Gets a value indicating whether the broadcast service can capture.
public : PlatForm::Boolean CanCapture { get; }public bool CanCapture { get; }Public ReadOnly Property CanCapture As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the broadcast service can capture; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
CaptureTargetType CaptureTargetType CaptureTargetType CaptureTargetType
Gets or sets a value that specifies the type of capture target to be used for broadcast.
public : AppBroadcastCaptureTargetType CaptureTargetType { get; set; }public AppBroadcastCaptureTargetType CaptureTargetType { get; set; }Public ReadWrite Property CaptureTargetType As AppBroadcastCaptureTargetType// You can use this property in JavaScript.
- Value
- AppBroadcastCaptureTargetType AppBroadcastCaptureTargetType AppBroadcastCaptureTargetType AppBroadcastCaptureTargetType
A value that specifies the type of capture target to be used for broadcast.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
State State State State
Gets the current state of the app broadcast services.
public : AppBroadcastState State { get; }public AppBroadcastState State { get; }Public ReadOnly Property State As AppBroadcastState// You can use this property in JavaScript.
The current state of the app broadcast services.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
UserName UserName UserName UserName
Gets the username used for authentication for app broadcast.
public : PlatForm::String UserName { get; }public string UserName { get; }Public ReadOnly Property UserName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The username used for authentication for app broadcast.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Methods
EnterBroadcastModeAsync(AppBroadcastPlugIn) EnterBroadcastModeAsync(AppBroadcastPlugIn) EnterBroadcastModeAsync(AppBroadcastPlugIn) EnterBroadcastModeAsync(AppBroadcastPlugIn)
Causes the app broadcast service to enter broadcast mode with the specified app broadcast plugin.
public : IAsyncOperation<unsigned int> EnterBroadcastModeAsync(AppBroadcastPlugIn plugIn)public IAsyncOperation<uint> EnterBroadcastModeAsync(AppBroadcastPlugIn plugIn)Public Function EnterBroadcastModeAsync(plugIn As AppBroadcastPlugIn) As IAsyncOperation( Of uint )// You can use this method in JavaScript.
The app broadcast plugin with which broadcast mode is entered.
An asynchronous operation that returns a status code on successful completion.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
ExitBroadcastMode(AppBroadcastExitBroadcastModeReason) ExitBroadcastMode(AppBroadcastExitBroadcastModeReason) ExitBroadcastMode(AppBroadcastExitBroadcastModeReason) ExitBroadcastMode(AppBroadcastExitBroadcastModeReason)
Causes the app broadcast service to exit broadcast mode with the specified reason.
public : void ExitBroadcastMode(AppBroadcastExitBroadcastModeReason reason)public void ExitBroadcastMode(AppBroadcastExitBroadcastModeReason reason)Public Function ExitBroadcastMode(reason As AppBroadcastExitBroadcastModeReason) As void// You can use this method in JavaScript.
- reason
- AppBroadcastExitBroadcastModeReason AppBroadcastExitBroadcastModeReason AppBroadcastExitBroadcastModeReason AppBroadcastExitBroadcastModeReason
An object that specifies the reason that broadcast mode is being exited.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
PauseBroadcast() PauseBroadcast() PauseBroadcast() PauseBroadcast()
Pauses the app broadcasting.
public : void PauseBroadcast()public void PauseBroadcast()Public Function PauseBroadcast() As void// You can use this method in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
ResumeBroadcast() ResumeBroadcast() ResumeBroadcast() ResumeBroadcast()
Resumes the app broadcasting.
public : void ResumeBroadcast()public void ResumeBroadcast()Public Function ResumeBroadcast() As void// You can use this method in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
StartBroadcast() StartBroadcast() StartBroadcast() StartBroadcast()
Starts app broadcasting.
public : void StartBroadcast()public void StartBroadcast()Public Function StartBroadcast() As void// You can use this method in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
StartPreview(Size) StartPreview(Size) StartPreview(Size) StartPreview(Size)
Starts the app broadcast preview.
public : AppBroadcastPreview StartPreview(Size desiredSize)public AppBroadcastPreview StartPreview(Size desiredSize)Public Function StartPreview(desiredSize As Size) As AppBroadcastPreview// You can use this method in JavaScript.
An object specifying the size, in pixels, of the app broadcast preview.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|