Interface IPlaylistManager

Namespace: MediaBrowser.Controller.Playlists
Assembly: MediaBrowser.Controller.dll
Syntax
public interface IPlaylistManager

Methods

AddToPlaylist(Playlist, Int64[], Boolean, User, CancellationToken)

Declaration
Task<AddToPlaylistResult> AddToPlaylist(Playlist playlist, long[] itemIds, bool skipDuplicates, User user, CancellationToken cancellationToken)
Parameters
Type Name Description
Playlist playlist
System.Int64[] itemIds
System.Boolean skipDuplicates
User user
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<AddToPlaylistResult>

AddToPlaylist(Int64, Int64[], User)

Adds to playlist.

Declaration
void AddToPlaylist(long playlistId, long[] itemIds, User user)
Parameters
Type Name Description
System.Int64 playlistId

The playlist identifier.
System.Int64[] itemIds

The item ids.
User user

The user.

CreatePlaylist(PlaylistCreationRequest)

Creates the playlist.

Declaration
Task<PlaylistCreationResult> CreatePlaylist(PlaylistCreationRequest options)
Parameters
Type Name Description
PlaylistCreationRequest options

The options.
Returns
Type Description
System.Threading.Tasks.Task<PlaylistCreationResult>

Task<Playlist>.

GetAddToPlaylistInfo(Playlist, Int64[], User, CancellationToken)

Declaration
AddToPlaylistInfo GetAddToPlaylistInfo(Playlist playlist, long[] itemIds, User user, CancellationToken cancellationToken)
Parameters
Type Name Description
Playlist playlist
System.Int64[] itemIds
User user
System.Threading.CancellationToken cancellationToken
Returns
Type Description
AddToPlaylistInfo

MoveItem(Playlist, Int64, Int32)

Declaration
Task MoveItem(Playlist playlist, long entryId, int newIndex)
Parameters
Type Name Description
Playlist playlist
System.Int64 entryId
System.Int32 newIndex
Returns
Type Description
System.Threading.Tasks.Task

MoveItem(Int64, Int64, Int32)

Moves the item.

Declaration
Task MoveItem(long playlistId, long entryId, int newIndex)
Parameters
Type Name Description
System.Int64 playlistId

The playlist identifier.
System.Int64 entryId

The entry identifier.
System.Int32 newIndex

The new index.
Returns
Type Description
System.Threading.Tasks.Task

Task.

RemoveFromPlaylist(Playlist, Int64[])

Declaration
Task RemoveFromPlaylist(Playlist playlist, long[] entryIds)
Parameters
Type Name Description
Playlist playlist
System.Int64[] entryIds
Returns
Type Description
System.Threading.Tasks.Task

RemoveFromPlaylist(Int64, Int64[])

Removes from playlist.

Declaration
Task RemoveFromPlaylist(long playlistId, long[] entryIds)
Parameters
Type Name Description
System.Int64 playlistId

The playlist identifier.
System.Int64[] entryIds

The entry ids.
Returns
Type Description
System.Threading.Tasks.Task

Task.

Events

PlaylistItemsAdded

Declaration
event EventHandler<PlaylistItemsAddedEventArgs> PlaylistItemsAdded
Event Type
Type Description
System.EventHandler<PlaylistItemsAddedEventArgs>

PlaylistItemsMoved

Declaration
event EventHandler<PlaylistItemsMovedEventArgs> PlaylistItemsMoved
Event Type
Type Description
System.EventHandler<PlaylistItemsMovedEventArgs>

PlaylistItemsRemoved

Declaration
event EventHandler<PlaylistItemsRemovedEventArgs> PlaylistItemsRemoved
Event Type
Type Description
System.EventHandler<PlaylistItemsRemovedEventArgs>

Extension Methods