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 : IAppBroadcastServices
public sealed class AppBroadcastServices : IAppBroadcastServices
Public NotInheritable Class AppBroadcastServices Implements IAppBroadcastServices
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
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
var string = appBroadcastServices.broadcastLanguage;
appBroadcastServices.broadcastLanguage = string;
Value
Platform::String string string string

A string that specifies the language settings for app broadast.

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

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
var string = appBroadcastServices.broadcastTitle;
appBroadcastServices.broadcastTitle = string;
Value
Platform::String string string string

The title of the broadcast.

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

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
var bool = appBroadcastServices.canCapture;
Value
Platform::Boolean bool bool bool

True if the broadcast service can capture; otherwise, false.

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

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
var appBroadcastCaptureTargetType = appBroadcastServices.captureTargetType;
appBroadcastServices.captureTargetType = appBroadcastCaptureTargetType;
Value
AppBroadcastCaptureTargetType AppBroadcastCaptureTargetType AppBroadcastCaptureTargetType AppBroadcastCaptureTargetType

A value that specifies the type of capture target to be used for broadcast.

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

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
var appBroadcastState = appBroadcastServices.state;
Value
AppBroadcastState AppBroadcastState AppBroadcastState AppBroadcastState

The current state of the app broadcast services.

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

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
var string = appBroadcastServices.userName;
Value
Platform::String string string string

The username used for authentication for app broadcast.

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

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 )
Windows.Media.Capture.AppBroadcastServices.enterBroadcastModeAsync(plugIn).done( /* Your success and error handlers */ );
Parameters
plugIn
AppBroadcastPlugIn AppBroadcastPlugIn AppBroadcastPlugIn AppBroadcastPlugIn

The app broadcast plugin with which broadcast mode is entered.

Returns

An asynchronous operation that returns a status code on successful completion.

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

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
appBroadcastServices.exitBroadcastMode(reason);
Parameters
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

PauseBroadcast() PauseBroadcast() PauseBroadcast() PauseBroadcast()

Pauses the app broadcasting.

public : void PauseBroadcast()
public void PauseBroadcast()
Public Function PauseBroadcast() As void
appBroadcastServices.pauseBroadcast();
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

ResumeBroadcast() ResumeBroadcast() ResumeBroadcast() ResumeBroadcast()

Resumes the app broadcasting.

public : void ResumeBroadcast()
public void ResumeBroadcast()
Public Function ResumeBroadcast() As void
appBroadcastServices.resumeBroadcast();
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

StartBroadcast() StartBroadcast() StartBroadcast() StartBroadcast()

Starts app broadcasting.

public : void StartBroadcast()
public void StartBroadcast()
Public Function StartBroadcast() As void
appBroadcastServices.startBroadcast();
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

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
var appBroadcastPreview = appBroadcastServices.startPreview(desiredSize);
Parameters
desiredSize
Size Size Size Size

An object specifying the size, in pixels, of the app broadcast preview.

Returns
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