Interface IAimpServicePlaylistManager

The service provides an access to playlist manager. Implements the IAimpServicePlaylistManager2 Implements the IAimpService

Inherited Members
Namespace: AIMP.SDK.Playlist
Assembly: AIMP.SDK.dll
Syntax
public interface IAimpServicePlaylistManager : IAimpServicePlaylistManager2, IAimpService

Properties

PlaylistQueue

Gets the playlist queue.

Declaration
IAimpPlaylistQueue PlaylistQueue { get; }

Methods

CreatePlaylist(String, Boolean)

Creates the playlist.

Declaration
AimpActionResult<IAimpPlaylist> CreatePlaylist(string name, bool isActive)
Parameters
Type Name Description
System.String name

The playlist name.

Automatic name will be applied if name is equals empty value.

System.Boolean isActive

If set to true playlist will be active.

CreatePlaylistFromFile(String, Boolean)

Creates the playlist from file.

Declaration
AimpActionResult<IAimpPlaylist> CreatePlaylistFromFile(string fileName, bool isActive)
Parameters
Type Name Description
System.String fileName

Name of the file.

Automatic name will be applied if name is equals empty value.

System.Boolean isActive

If set to true playlist will be active.

GetActivePlaylist()

Gets the current active playlist.

Declaration
AimpActionResult<IAimpPlaylist> GetActivePlaylist()

GetLoadedPlaylist(Int32)

Gets the loaded playlist by index.

Declaration
AimpActionResult<IAimpPlaylist> GetLoadedPlaylist(int index)
Parameters
Type Name Description
System.Int32 index

The index.

GetLoadedPlaylistById(String)

Gets the loaded playlist by identifier.

Declaration
AimpActionResult<IAimpPlaylist> GetLoadedPlaylistById(string id)
Parameters
Type Name Description
System.String id

The identifier.

GetLoadedPlaylistByName(String)

Gets the loaded playlist by name.

Declaration
AimpActionResult<IAimpPlaylist> GetLoadedPlaylistByName(string name)
Parameters
Type Name Description
System.String name

The name.

GetLoadedPlaylistCount()

Gets the loaded playlist count.

Declaration
int GetLoadedPlaylistCount()

GetPlayablePlaylist()

Gets the playable playlist.

Declaration
AimpActionResult<IAimpPlaylist> GetPlayablePlaylist()

SetActivePlaylist(IAimpPlaylist)

Sets the playlist as active.

Declaration
AimpActionResult SetActivePlaylist(IAimpPlaylist playList)
Parameters
Type Name Description
IAimpPlaylist playList

The playlist IAimpPlaylist.

See Also