AppBroadcastBackgroundService クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
ブロードキャスト UWP アプリとシステムホスト型ブロードキャスト サービスの間のインターフェイスを提供します。 このクラスは、ブロードキャスト サービス認証を容易にするオブジェクトへのアクセスを提供し、ブロードキャスト プロバイダー サービスに対するデバイスのインターネットの帯域幅機能をテストし、タスクがキャプチャされたオーディオ フレームとビデオ フレームを取得して、ブロードキャスト プロバイダー サービスに送信できるようにします。
注意
この API には appBroadcast と appBroadcastSettings の機能が必要です。これは、すべての Windows アプリで使用できるわけではありません。 開発者アカウントが Microsoft によって特別にプロビジョニングされていない限り、この API の呼び出しは実行時に失敗します。
public ref class AppBroadcastBackgroundService sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Media.Capture.AppBroadcastContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AppBroadcastBackgroundService final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Media.Capture.AppBroadcastContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AppBroadcastBackgroundService
Public NotInheritable Class AppBroadcastBackgroundService
- 継承
- 属性
Windows の要件
デバイス ファミリ |
Windows Desktop Extension SDK (10.0.15063.0 で導入)
|
API contract |
Windows.Media.Capture.AppBroadcastContract (v1.0 で導入)
|
アプリの機能 |
appBroadcast
appBroadcastSettings
|
注釈
バックグラウンド タスクの Run メソッドに渡された IBackgroundTaskInstance の TriggerDetails プロパティを AppBroadcastTriggerDetails にキャストし、BackgroundService プロパティにアクセスして、このクラスのインスタンスを取得します。
この API は、アイドル タイムアウトが原因でバックグラウンド サービスがシャットダウンした場合にエラーをスローする可能性があります。
バージョン履歴
Windows のバージョン | SDK バージョン | 追加された値 |
---|---|---|
1709 | 16299 | BroadcastChannel |
1709 | 16299 | BroadcastChannelChanged |
1709 | 16299 | BroadcastLanguage |
1709 | 16299 | BroadcastLanguageChanged |
1709 | 16299 | BroadcastTitleChanged |
プロパティ
AppId |
ブロードキャストするゲームの識別子を含む文字列を取得します。 デスクトップ デバイスでブロードキャストする場合、この値は、ユーザーがブロードキャストを開始したゲームです。 |
BroadcastChannel |
現在のブロードキャスト チャネルの名前を含む文字列を取得します。 |
BroadcastLanguage |
現在のブロードキャスト チャネルの言語を表す文字列を取得します。 |
BroadcastTitle |
ブロードキャストのユーザー指定のタイトルを含む文字列を取得します。 |
PlugInState |
ブロードキャスト バックグラウンド タスクの現在の状態を指定する値を取得または設定します。 |
SignInInfo |
アプリ ブロードキャスト バックグラウンド サービスのサインイン情報を表す オブジェクトを取得します。 |
StreamInfo |
アプリ ブロードキャスト バックグラウンド サービスのストリーム状態を管理する オブジェクトを取得します。 |
TitleId |
ブロードキャストするタイトルの一意識別子を取得します。 |
ViewerCount |
ブロードキャストの閲覧者の数を取得または設定します。 |
メソッド
TerminateBroadcast(AppBroadcastTerminationReason, UInt32) |
ブロードキャストを終了します。 |
イベント
BroadcastChannelChanged |
BroadcastChannel プロパティの値が変更されたときに発生します。 |
BroadcastLanguageChanged |
BroadcastLanguage プロパティの値が変更されたときに発生します。 |
BroadcastTitleChanged |
BroadcastTitle プロパティの値が変更されたときに発生します。 |
HeartbeatRequested |
ブロードキャストバックグラウンドタスクが現在アクティブであることを確認するために、システムによって定期的に発生します。 |