Interface IMediaProvider

Interface for capturing media from a device.

Namespace: Microsoft.Internal.Studios.Aruba.Infrastructure

Assembly: Aruba.Infrastructure.dll

Syntax

public interface IMediaProvider

Methods

CanCaptureAsync(IAttachmentType, IGameDevice)

Checks if a capture can be performed for the given type on the given device.

Declaration

Task<bool> CanCaptureAsync(IAttachmentType attachmentType, IGameDevice gameDevice)

Parameters

Type	Name	Description
IAttachmentType	attachmentType	The attachment type.
IGameDevice	gameDevice	The device to capture on.

Returns

Type	Description
Task<bool>	The task.

CaptureAsync(IAttachmentType, string, string, IGameDevice, Guid)

Attempts to capture media of the supplied type and returns a path to the created file.

Declaration

Task<string> CaptureAsync(IAttachmentType attachmentType, string fileExtension, string name, IGameDevice gameDevice, Guid bugResolveGuid)

Parameters

Type	Name	Description
IAttachmentType	attachmentType	The attachment type.
string	fileExtension	The file extension to use.
string	name	The file name.
IGameDevice	gameDevice	The device to capture on.
Guid	bugResolveGuid	The bug resolve id for the creation of this bug.

Returns

Type	Description
Task<string>	The task.

GetUniqueFileName(string)

Generates a unique file name in a target folder by incrementing the number suffix if collisions occur.

Declaration

string GetUniqueFileName(string filePath)

Parameters

Type	Name	Description
string	filePath	The source file path.

Returns

Type	Description
string	A unique file name.

IsCapturable(IAttachmentType)

Checks if the provided type has the ability to be captured.

Declaration

bool IsCapturable(IAttachmentType attachmentType)

Parameters

Type	Name	Description
IAttachmentType	attachmentType	The attachment type.

Returns

Type	Description
bool	Whether the attachment type is capturable.