Show / Hide Table of Contents

Interface IImageCaptureEnvironment

Represents the environment that a device can capture screenshots.

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

Methods

View Source

CaptureScreenshotAsync(TimeSpan?)

Captures a screenshot from the device.

Declaration
Task<BitmapStream> CaptureScreenshotAsync(TimeSpan? timeout = null)
Parameters
Type Name Description
TimeSpan? timeout

The timeout for the operation.

Returns
Type Description
Task<BitmapStream>

An object containing the bitmap and associated stream data.

View Source

CaptureScreenshotAsync(CancellationToken)

Captures a screenshot from the device.

Declaration
Task<BitmapStream> CaptureScreenshotAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

The cancellation token for the operation.

Returns
Type Description
Task<BitmapStream>

An object containing the bitmap and associated stream data.

Extension Methods

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