AppBroadcastPreviewStreamReader
AppBroadcastPreviewStreamReader
AppBroadcastPreviewStreamReader
AppBroadcastPreviewStreamReader
Class
Definition
Provides information about and access to the app broadcast preview stream.
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 AppBroadcastPreviewStreamReader : IAppBroadcastPreviewStreamReaderpublic sealed class AppBroadcastPreviewStreamReader : IAppBroadcastPreviewStreamReaderPublic NotInheritable Class AppBroadcastPreviewStreamReader Implements IAppBroadcastPreviewStreamReader// 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
|
Properties
VideoBitmapAlphaMode VideoBitmapAlphaMode VideoBitmapAlphaMode VideoBitmapAlphaMode
Gets the video bitmap alpha mode for the app broadcast preview stream.
public : BitmapAlphaMode VideoBitmapAlphaMode { get; }public BitmapAlphaMode VideoBitmapAlphaMode { get; }Public ReadOnly Property VideoBitmapAlphaMode As BitmapAlphaMode// You can use this property in JavaScript.
The video bitmap alpha mode for the app broadcast preview stream.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
VideoBitmapPixelFormat VideoBitmapPixelFormat VideoBitmapPixelFormat VideoBitmapPixelFormat
Gets the video bitmap pixel format for the app broadcast preview stream.
public : BitmapPixelFormat VideoBitmapPixelFormat { get; }public BitmapPixelFormat VideoBitmapPixelFormat { get; }Public ReadOnly Property VideoBitmapPixelFormat As BitmapPixelFormat// You can use this property in JavaScript.
The video bitmap pixel format for the app broadcast preview stream.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
VideoHeight VideoHeight VideoHeight VideoHeight
Gets the video height, in pixels, of the app broadcast preview stream.
public : unsigned int VideoHeight { get; }public uint VideoHeight { get; }Public ReadOnly Property VideoHeight As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The video height, in pixels, of the app broadcast preview stream.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
VideoStride VideoStride VideoStride VideoStride
Gets the video stride of the app broadcast preview stream.
public : unsigned int VideoStride { get; }public uint VideoStride { get; }Public ReadOnly Property VideoStride As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The video stride of the app broadcast preview stream.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
VideoWidth VideoWidth VideoWidth VideoWidth
Gets the video width, in pixels, of the app broadcast preview stream.
public : unsigned int VideoWidth { get; }public uint VideoWidth { get; }Public ReadOnly Property VideoWidth As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The video width, in pixels, of the app broadcast preview stream.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Methods
TryGetNextVideoFrame() TryGetNextVideoFrame() TryGetNextVideoFrame() TryGetNextVideoFrame()
Attempts to retrieve the next video frame from the app broadcast preview stream.
public : AppBroadcastPreviewStreamVideoFrame TryGetNextVideoFrame()public AppBroadcastPreviewStreamVideoFrame TryGetNextVideoFrame()Public Function TryGetNextVideoFrame() As AppBroadcastPreviewStreamVideoFrame// You can use this method in JavaScript.
The next video frame from the app broadcast preview stream.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Events
VideoFrameArrived VideoFrameArrived VideoFrameArrived VideoFrameArrived
Occurs when a new video frame arrives from the app broadcast preview stream.
public : event TypedEventHandler VideoFrameArrived<AppBroadcastPreviewStreamReader, object>public event TypedEventHandler VideoFrameArrived<AppBroadcastPreviewStreamReader, object>Public Event VideoFrameArrived<AppBroadcastPreviewStreamReader, object>// 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
|