Interface IAimpPlaylistPreimage

It is a general interface for all preimages.

Preimage is data source for smart-playlists with manual or automatic synchronization. The principle of cooperation between preimage and playlist is so simple: when data or settings in preimage are changed - preimage notify playlist about the changes via the IAimpPlaylistPreimageListener interface that related to binded playlist. Playlist, in own case, will reload data from preimage as soon as data will be required by plugin or user.

Namespace: AIMP.SDK.Playlist

Assembly: AIMP.SDK.dll

Syntax

public interface IAimpPlaylistPreimage

Properties

AutoSync

The Value different from false if automatic synchronization is switched on in the preimage (note that not all preimages support for this property).

Declaration

bool AutoSync { get; set; }

AutoSyncOnStartup

The Value different from false if automatic synchronization is switched on in the preimage at Application startup (note that not all preimages support for this property).

Declaration

bool AutoSyncOnStartup { get; set; }

FactoryId

Id of factory that creates this preimage.

Declaration

string FactoryId { get; }

HasDialog

Return value different from false if preimage has implementation of the ExecuteDialog method.

Declaration

bool HasDialog { get; }

SortTemplate

Return sorting template for values in playlist after adding files from preimage.

Declaration

string SortTemplate { get; }

Methods

ConfigLoad(IAimpStream)

Loads the configuration.

Declaration

AimpActionResult ConfigLoad(IAimpStream stream)

Parameters

Type	Name	Description
IAimpStream	stream	The stream.

ConfigSave(IAimpStream)

Saves the configuration.

Declaration

AimpActionResult ConfigSave(IAimpStream stream)

Parameters

Type	Name	Description
IAimpStream	stream	The stream.

ExecuteDialog(IntPtr)

Executes the dialog.

Declaration

AimpActionResult ExecuteDialog(IntPtr ownerHandle)

Parameters

Type	Name	Description
System.IntPtr	ownerHandle	The owner handle.

FinalizeObject()

Finalizes the object.

Declaration

void FinalizeObject()

Initialize(IAimpPlaylistPreimageListener)

Initializes the specified listener.

Declaration

void Initialize(IAimpPlaylistPreimageListener listener)

Parameters

Type	Name	Description
IAimpPlaylistPreimageListener	listener	The listener.