Interface IAimpGroupingPresets

Allow access to preset for data storage.

Namespace: AIMP.SDK.MusicLibrary.Presets

Assembly: AIMP.SDK.dll

Syntax

public interface IAimpGroupingPresets

Methods

Add(String, String, IAimpGroupingTreeDataProvider)

Adds new grouping template with custom data provider IAimpGroupingTreeDataProvider.

Declaration

AimpActionResult<IAimpGroupingPreset> Add(string id, string name, IAimpGroupingTreeDataProvider provider)

Parameters

Type	Name	Description
System.String	id	The identifier.
System.String	name	Template name.
IAimpGroupingTreeDataProvider	provider	Custom data provider IAimpGroupingTreeDataProvider.

Add(String, String, IList<String>)

Adds new grouping template with default data provider.

Declaration

AimpActionResult<IAimpGroupingPresetStandard> Add(string id, string name, IList<string> fieldNames)

Parameters

Type	Name	Description
System.String	id	The identifier.
System.String	name	Template name.
System.Collections.Generic.IList<System.String>	fieldNames	The list of fields

Add(String, String, String)

Adds new grouping template with default data provider.

Declaration

AimpActionResult<IAimpGroupingPresetStandard> Add(string id, string name, string fieldName)

Parameters

Type	Name	Description
System.String	id	The identifier.
System.String	name	Template name.
System.String	fieldName	The field name.

BeginUpdate()

Adds blocking on sending notifications during changes. Use it if you want to change multiple properties at the same time.

Declaration

void BeginUpdate()

Delete(Int32)

Removes a template by index.

Declaration

AimpActionResult Delete(int index)

Parameters

Type	Name	Description
System.Int32	index	Index.

EndUpdate()

Removes blocking on sending notifications.

Declaration

void EndUpdate()

GetCount()

Gets the count of presets.

Declaration

int GetCount()

GetPreset(Int32)

Gets the grouping preset by index.

Declaration

AimpActionResult<IAimpGroupingPreset> GetPreset(int index)

Parameters

Type	Name	Description
System.Int32	index	Index.

GetPresetById(String)

Gets the grouping preset by identifier.

Declaration

AimpActionResult<IAimpGroupingPreset> GetPresetById(string id)

Parameters

Type	Name	Description
System.String	id	The identifier.

GetStandardPreset(Int32)

Gets the standard grouping preset by index.

Declaration

AimpActionResult<IAimpGroupingPresetStandard> GetStandardPreset(int index)

Parameters

Type	Name	Description
System.Int32	index	Index.

GetStandardPresetById(String)

Gets the standard grouping preset by identifier.

Declaration

AimpActionResult<IAimpGroupingPresetStandard> GetStandardPresetById(string id)

Parameters

Type	Name	Description
System.String	id	The identifier.