CompositeVideoFrameContext
CompositeVideoFrameContext
CompositeVideoFrameContext
CompositeVideoFrameContext
Class
Definition
Provides context for performing a custom overlay operation within the CompositeFrame method.
public : sealed class CompositeVideoFrameContext : ICompositeVideoFrameContextpublic sealed class CompositeVideoFrameContext : ICompositeVideoFrameContextPublic NotInheritable Class CompositeVideoFrameContext Implements ICompositeVideoFrameContext// You can use this class in JavaScript.
- Attributes
Windows 10 requirements
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
To retrieve an instance of this class, implement the CompositeFrame method.
Properties
BackgroundFrame BackgroundFrame BackgroundFrame BackgroundFrame
Gets the background frame for an overlay operation.
public : VideoFrame BackgroundFrame { get; }public VideoFrame BackgroundFrame { get; }Public ReadOnly Property BackgroundFrame As VideoFrame// You can use this property in JavaScript.
The background frame for an overlay operation.
OutputFrame OutputFrame OutputFrame OutputFrame
Gets the output frame for an overlay operation.
public : VideoFrame OutputFrame { get; }public VideoFrame OutputFrame { get; }Public ReadOnly Property OutputFrame As VideoFrame// You can use this property in JavaScript.
The output frame for an overlay operation.
SurfacesToOverlay SurfacesToOverlay SurfacesToOverlay SurfacesToOverlay
Gets the list of Direct3D surfaces to be used in an overlay operation.
public : IVectorView<IDirect3DSurface> SurfacesToOverlay { get; }public IReadOnlyList<IDirect3DSurface> SurfacesToOverlay { get; }Public ReadOnly Property SurfacesToOverlay As IReadOnlyList<IDirect3DSurface>// You can use this property in JavaScript.
- Value
- IVectorView<IDirect3DSurface> IReadOnlyList<IDirect3DSurface> IReadOnlyList<IDirect3DSurface> IReadOnlyList<IDirect3DSurface>
The list of Direct3D surfaces to be used in an overlay operation.
Methods
GetOverlayForSurface(IDirect3DSurface) GetOverlayForSurface(IDirect3DSurface) GetOverlayForSurface(IDirect3DSurface) GetOverlayForSurface(IDirect3DSurface)
Gets a MediaOverlay object for the provided Direct3D surface.
public : MediaOverlay GetOverlayForSurface(IDirect3DSurface surfaceToOverlay)public MediaOverlay GetOverlayForSurface(IDirect3DSurface surfaceToOverlay)Public Function GetOverlayForSurface(surfaceToOverlay As IDirect3DSurface) As MediaOverlay// You can use this method in JavaScript.
Parameters
- surfaceToOverlay
- IDirect3DSurface IDirect3DSurface IDirect3DSurface IDirect3DSurface
The Direct3D surface.
Returns
The created MediaOverlay object.