Show / Hide Table of Contents

Interface IVideoCaptureEnvironment

Represents the environment that a device can capture video recordings.

Inherited Members
IDeviceEnvironment.Name
IDeviceContainer.Device
IHasConnectionStatus.ConnectionStatus
Namespace: Microsoft.XboxStudios.DeviceConsole.Environments.Capture
Assembly: DeviceConsole.Environments.dll
Syntax
public interface IVideoCaptureEnvironment : IDeviceEnvironment, IDeviceContainer, IHasConnectionStatus

Methods

View Source

CaptureVideoAsync(TimeSpan, string, TimeSpan?)

Captures a video clip from the device and saves it to the destination.

Declaration
Task<DvrMetadata> CaptureVideoAsync(TimeSpan duration, string destination, TimeSpan? timeout = null)
Parameters
Type Name Description
TimeSpan duration

The duration to capture.

string destination

The destination.

TimeSpan? timeout

The timeout for the operation.

Returns
Type Description
Task<DvrMetadata>

Metadata about the captured clip.

View Source

CaptureVideoAsync(TimeSpan, string, CancellationToken)

Captures a video clip from the device and saves it to the destination.

Declaration
Task<DvrMetadata> CaptureVideoAsync(TimeSpan duration, string destination, CancellationToken cancellationToken)
Parameters
Type Name Description
TimeSpan duration

The duration to capture.

string destination

The destination.

CancellationToken cancellationToken

The cancellation token for the operation.

Returns
Type Description
Task<DvrMetadata>

Metadata about the captured clip.

Extension Methods

IHasConnectionStatusExtensions.IsConnected(IHasConnectionStatus)
  • View Source
In This Article
Back to top Generated by DocFX