Skip to content

Latest commit

 

History

History
133 lines (99 loc) · 5.55 KB

CameraPreview.md

File metadata and controls

133 lines (99 loc) · 5.55 KB
title author description keywords dev_langs
CameraPreview
skommireddi
The CameraPreview control allows to easily preview video in the MediaPlayerElement from available camera frame source groups. You can subscribe and get real time video frames and software bitmaps as they arrive from the selected camera source. It shows only frame sources that support color video preview or video record streams.
windows 10, uwp, windows community toolkit, windows toolkit, CameraPreview, Camera, Preview, Video Frame, Software Bitmap
csharp
vb

CameraPreview

The CameraPreview control allows to easily preview video in the MediaPlayerElement from available camera frame source groups. You can subscribe and get real time video frames and software bitmaps as they arrive from the selected camera source. It shows only frame sources that support color video preview or video record streams.

Important

Make sure you have the webcam capability enabled for your app to access the device's camera.

[!div class="nextstepaction"] Try it in the sample app

Syntax

<controls:CameraPreview x:Name="CameraPreviewControl">
</controls:CameraPreview>
CameraPreviewControl.PreviewFailed += CameraPreviewControl_PreviewFailed;
await CameraPreviewControl.StartAsync();
CameraPreviewControl.CameraHelper.FrameArrived += CameraPreviewControl_FrameArrived;


private void CameraPreviewControl_FrameArrived(object sender, FrameEventArgs e)
{
     var videoFrame = e.VideoFrame;
     var softwareBitmap = videoFrame.SoftwareBitmap;
}

private void CameraPreviewControl_PreviewFailed(object sender, PreviewFailedEventArgs e)
{
    var errorMessage = e.Error;
}
    AddHandler CameraPreviewControl.PreviewFailed, AddressOf CameraPreviewControl_PreviewFailed
    Await CameraPreviewControl.StartAsync()
    AddHandler CameraPreviewControl.CameraHelper.FrameArrived, AddressOf CameraPreviewControl_FrameArrived

    Private Sub CameraPreviewControl_FrameArrived(ByVal sender As Object, ByVal e As FrameEventArgs)
        Dim videoFrame = e.VideoFrame
        Dim softwareBitmap = videoFrame.SoftwareBitmap
    End Sub

    Private Sub CameraPreviewControl_PreviewFailed(ByVal sender As Object, ByVal e As PreviewFailedEventArgs)
        Dim errorMessage = e.[Error]
    End Sub

Important

As a developer, you will need to make sure the CameraHelper resources used by the control are cleaned up when appropriate. See CameraHelper documentation for more details

Properties

Property Type Description
CameraHelper CameraHelper Gets the CameraHelper associated with the control.
IsFrameSourceGroupButtonVisible bool Set this property to hide or show Frame Source Group Button. Note: This button is conditionally visible based on more than one source being available. 
<controls:CameraPreview x:Name="CameraPreviewControl" IsFrameSourceGroupButtonVisible="false"
</controls:CameraPreview>

Methods

Methods Return Type Description
StartAsync() Task Initializes camera preview control with a default Camera Helper instance and starts preview and frame capture.
StartAsync(CameraHelper cameraHelper) Task Initializes camera preview control with provided Camera Helper instance.
Stop() void Stops camera preview and disposes MediaPlayer.

Events

Events Description
PreviewFailed Fires when camera preview fails. You can get the error reason from the PreviewFailedEventArgs.

Examples

Demonstrates using the camera control and camera helper to preview video from a specific media frame source group.

var availableFrameSourceGroups = await CameraHelper.GetFrameSourceGroupsAsync();
if(availableFrameSourceGroups != null)
{
  CameraHelper cameraHelper = new CameraHelper() { FrameSourceGroup = availableFrameSourceGroups.FirstOrDefault() };
  _cameraPreviewControl.PreviewFailed += CameraPreviewControl_PreviewFailed;
  await _cameraPreviewControl.StartAsync(cameraHelper);
  _cameraPreviewControl.CameraHelper.FrameArrived += CameraPreviewControl_FrameArrived; 
}
    Dim availableFrameSourceGroups = Await CameraHelper.GetFrameSourceGroupsAsync()

    If availableFrameSourceGroups IsNot Nothing Then
        Dim cameraHelper As CameraHelper = New CameraHelper() With {
        .FrameSourceGroup = availableFrameSourceGroups.FirstOrDefault()
    }
        AddHandler CameraPreviewControl.PreviewFailed, AddressOf CameraPreviewControl_PreviewFailed
        Await _CameraPreviewControl.StartAsync(cameraHelper)
        AddHandler CameraPreviewControl.CameraHelper.FrameArrived, AddressOf CameraPreviewControl_FrameArrived
    End If

Sample Project

CameraPreview Sample Page Source. You can see this in action in the Windows Community Toolkit Sample App.

Requirements

[Device family] Universal, 10.0.17134.0 or higher
Namespace Microsoft.Toolkit.Uwp.UI.Controls
NuGet package Microsoft.Toolkit.Uwp.UI.Controls

API