Interface IAimpVirtualFile

Interface provides information about virtual file.

Namespace: AIMP.SDK.FileManager

Assembly: AIMP.SDK.dll

Syntax

public interface IAimpVirtualFile

Properties

AudioSourceFile

Gets or sets the real source file.

Property can be not set if real file name is not exists or file name is same to file name of file-container.

Declaration

string AudioSourceFile { get; set; }

ClipFinish

The end of the passage to play (in seconds).

Declaration

double ClipFinish { get; set; }

ClipStart

The beginning of the passage to play (in seconds).

Declaration

double ClipStart { get; set; }

FileFormat

Gets the file format. Ex. mp3, ogg, cda.

Declaration

string FileFormat { get; }

FileUri

Gets or sets the virtual file name.

Declaration

string FileUri { get; set; }

IndexInSet

Gets or sets the index of virtual track in the set (if presented).

Declaration

int IndexInSet { get; set; }

Methods

CreateStream()

Create the instance of the IAimpStream.

Declaration

AimpActionResult<IAimpStream> CreateStream()

GetFileInfo()

Gets the file info.

Declaration

AimpActionResult<IAimpFileInfo> GetFileInfo()

IsExists()

Check is the source exists.

Declaration

bool IsExists()

IsInSameStream(IAimpVirtualFile)

Determines whether [is in same stream] [the specified virtual file].

Declaration

AimpActionResult IsInSameStream(IAimpVirtualFile virtualFile)

Parameters

Type	Name	Description
IAimpVirtualFile	virtualFile	The virtual file.

Synchronize()

Plugin must validate state of all internal data that refer with source. If internal data is not valid, plugin must return any error code except ActionResultType.OK. In this case, the application will automatically reload virtual files for current file-container via one of the IAimpExtensionFileExpander extensions.

The method called by the application before call the CreateStream method.

Declaration

AimpActionResult Synchronize()