Class MediaProvider

An implementation of IMediaProvider

Inheritance

object

MediaProvider

Implements

IMediaProvider

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Phoenix.Aruba

Assembly: Phoenix.Plugin.Aruba.dll

Syntax

public class MediaProvider : IMediaProvider, IDisposable

Constructors

MediaProvider(IDeviceManager, IPhoenixLogger)

Initializes a new instance of the MediaProvider class.

Declaration

public MediaProvider(IDeviceManager deviceManager, IPhoenixLogger logger)

Parameters

Type	Name	Description
IDeviceManager	deviceManager	The device manager.
IPhoenixLogger	logger	The Logger.

Properties

Logger

Gets the Phoenix.Logger.IPhoenixLogger.

Declaration

public IPhoenixLogger Logger { get; }

Property Value

Type	Description
IPhoenixLogger

UseDxdiagCache

Gets or sets a value indicating whether the CaptureDxdiag() should use a cached version of a DxDiag attachment, if one exists.

Declaration

public bool UseDxdiagCache { get; set; }

Property Value

Type	Description
bool

Methods

CanCaptureAsync(IAttachmentType, IGameDevice)

Checks if a capture can be performed.

Declaration

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

Parameters

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

Returns

Type	Description
Task<bool>	Whether capture can be performed.

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

Begins capturing on a device.

Declaration

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

Parameters

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

Returns

Type	Description
Task<string>	File path to capture.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(bool)

Disposes of unmanaged resources.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	Indicates whether managed resources can also be disposed.

GetUniqueFileName(string)

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

Declaration

public 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

public bool IsCapturable(IAttachmentType attachmentType)

Parameters

Type	Name	Description
IAttachmentType	attachmentType	The attachment type.

Returns

Type	Description
bool	Whether the given attachment type is capturable.

Implements

IMediaProvider

IDisposable