Global handler for playlists. More...

#include <PlaylistHandler.h>

Inheritance diagram for Playlist::Handler:

Public Types
enum	PlaylistIndex : uint8_t { Current =0, Active }
	The PlaylistIndex enum.

Public Slots
int	loadOldPlaylists ()
	load playlists of last session from database More...

Signals
void	sigPlaylistCreated (PlaylistPtr pl)
	emitted when new playlist has been created More...

void	sigCurrentTrackChanged (int trackIndex, int playlist_idx)
	emitted when current track index has changed More...

void	sigNewPlaylistAdded (PlaylistPtr pl)
	emitted when new playlist has been added More...

void	sigPlaylistNameChanged (int idx)
	emitted when playlist name has changed More...

void	sigCurrentPlaylistChanged (int idx)
	emitted when tracks were added/removed or have changed More...

void	sigActivePlaylistChanged (int idx)

void	sigTrackDeletionRequested (const MetaDataList &tracks, Library::TrackDeletionMode deletion_mode)
	emitted when a track deletion was triggered over the Ui More...

void	sigFindTrackRequested (TrackID trackId)

Public Member Functions
void	shutdown ()
	Call this before the program stops. Singletons and Destructors don't work out so well.

void	clearPlaylist (int playlistIndex)
	clears the current visible playlist More...

void	playNext (const MetaDataList &tracks)
	insert tracks to active playlist after current playback position More...

void	playNext (const QStringList &paths)

void	insertTracks (const MetaDataList &tracks, int idx, int playlistIndex)
	insert tracks into a playlist at a given index More...

void	insertTracks (const QStringList &paths, int idx, int playlistIndex)

void	appendTracks (const MetaDataList &tracks, int playlistIndex)
	append tracks at a given playlist index More...

void	appendTracks (const QStringList &paths, int playlistIndex)

void	moveRows (const IndexSet &indexes, int tgt_idx, int playlistIndex)
	move rows within playlist More...

void	removeRows (const IndexSet &indexes, int playlistIndex)
	remove rows from playlist More...

void	changeTrack (int trackIndex, int playlistIndex)
	change the track in a given playlist More...

int	activeIndex () const
	get active playlist index More...

PlaylistConstPtr	activePlaylist () const

int	current_index () const

void	set_current_index (int playlistIndex)

int	count () const
	Returns number of playlists. More...

PlaylistConstPtr	playlist (int playlistIndex) const
	get specific playlist at given index More...

void	deletePlaylist (int playlistIndex)
	delete the given playlist from database More...

int	closePlaylist (int playlistIndex)
	close playlist More...

void	resetPlaylist (int playlistIndex)
	reload playlist from db More...

QString	requestNewPlaylistName (const QString &prefix=QString()) const
	Request a new name for the playlist (usually New %1 is returned). If the prefix differs, instead of New, the prefix is chosen. E.g. "File system 2" for tracks added by the file manager. More...

Util::SaveAsAnswer	savePlaylist (int playlistIndex)
	save playlist to database, overwrite old one More...

Util::SaveAsAnswer	savePlaylistAs (int playlistIndex, const QString &name, bool forceOverride)
	Save playlist under new name. More...

Util::SaveAsAnswer	renamePlaylist (int playlistIndex, const QString &name)
	rename playlist More...

void	savePlaylistToFile (int playlistIndex, const QString &filename, bool relative)
	save a playlist to file More...

int	createPlaylist (const MetaDataList &tracks, const QString &name=QString(), bool temporary=true, PlaylistType type=PlaylistType::Std)
	create a new playlist More...

int	createPlaylist (const QStringList &path_list, const QString &name=QString(), bool temporary=true, PlaylistType type=PlaylistType::Std)
	create a new playlist (overloaded) More...

int	createPlaylist (const QString &dir, const QString &name=QString(), bool temporary=true, PlaylistType type=PlaylistType::Std)
	create a new playlist (overloaded) More...

int	createPlaylist (const CustomPlaylist &pl)
	create a new playlist (overloaded) More...

int	createEmptyPlaylist (bool overrideCurrent=false)
	create a new empty playlist More...

int	createEmptyPlaylist (const QString &name)

void	deleteTracks (int playlistIndex, const IndexSet &rows, Library::TrackDeletionMode deletion_mode)

Detailed Description

Global handler for playlists.

Member Function Documentation

◆ activeIndex()

int Playlist::Handler::activeIndex ( ) const

get active playlist index

Returns

◆ appendTracks()

void Playlist::Handler::appendTracks	(	const MetaDataList &	tracks,
		int	playlistIndex
	)

append tracks at a given playlist index

Parameters

tracks	track list
playlistIndex	playlist index

◆ changeTrack()

void Playlist::Handler::changeTrack	(	int	trackIndex,
		int	playlistIndex
	)

change the track in a given playlist

Parameters

idx	track index
playlistIndex	playlist index

◆ clearPlaylist()

void Playlist::Handler::clearPlaylist ( int playlistIndex )

clears the current visible playlist

Parameters

playlistIndex playlist index

◆ closePlaylist()

int Playlist::Handler::closePlaylist ( int playlistIndex )

close playlist

Parameters

playlistIndex playlist index

◆ count()

int Playlist::Handler::count ( ) const

Returns number of playlists.

Returns

◆ createEmptyPlaylist()

int Playlist::Handler::createEmptyPlaylist ( bool overrideCurrent = false )

create a new empty playlist

Parameters

name	new playlist name. If no name given, current playlist will be overwritten

Returns: new playlist index

◆ createPlaylist() [1/4]

int Playlist::Handler::createPlaylist	(	const MetaDataList &	tracks,
		const QString &	name = `QString()`,
		bool	temporary = `true`,
		PlaylistType	type = `PlaylistType::Std`
	)

create a new playlist

Parameters

tracks	track list
name	new playlist name. If no name given, current playlist will be overwritten
temporary	is the playlist temporary or persistent?
type	deprecated

Returns: new playlist index

◆ createPlaylist() [2/4]

int Playlist::Handler::createPlaylist	(	const QStringList &	path_list,
		const QString &	name = `QString()`,
		bool	temporary = `true`,
		PlaylistType	type = `PlaylistType::Std`
	)

create a new playlist (overloaded)

Parameters

pathlist	paths, may contain files or directories
name	new playlist name. If no name given, current playlist will be overwritten
temporary	is the playlist temporary or persistent?
type	deprecated

Returns: new playlist index

◆ createPlaylist() [3/4]

int Playlist::Handler::createPlaylist	(	const QString &	dir,
		const QString &	name = `QString()`,
		bool	temporary = `true`,
		PlaylistType	type = `PlaylistType::Std`
	)

create a new playlist (overloaded)

Parameters

dir	directory path
name	new playlist name. If no name given, current playlist will be overwritten
temporary	is the playlist temporary or persistent?
type	deprecated

Returns: new playlist index

◆ createPlaylist() [4/4]

int Playlist::Handler::createPlaylist ( const CustomPlaylist & pl )

create a new playlist (overloaded)

Parameters

pl	a CustomPlaylist object fetched from database

Returns: new playlist index

◆ deletePlaylist()

void Playlist::Handler::deletePlaylist ( int playlistIndex )

delete the given playlist from database

Parameters

playlistIndex playlist index

◆ insertTracks()

void Playlist::Handler::insertTracks	(	const MetaDataList &	tracks,
		int	idx,
		int	playlistIndex
	)

insert tracks into a playlist at a given index

Parameters

tracks	track list
idx	track index within playlist
playlistIndex	playlist index

◆ loadOldPlaylists

int Playlist::Handler::loadOldPlaylists ( )

slot

load playlists of last session from database

Returns: number of playlists fetched

◆ moveRows()

void Playlist::Handler::moveRows	(	const IndexSet &	indexes,
		int	tgt_idx,
		int	playlistIndex
	)

move rows within playlist

Parameters

idx_list	list of row indices to be moved
tgt_idx	target index where rows should be moved
playlistIndex	playlist index

◆ playlist()

PlaylistConstPtr Playlist::Handler::playlist ( int playlistIndex ) const

get specific playlist at given index

Parameters

playlistIndex playlist index

Returns: read only pointer object to a playlist, may be nullptr

◆ playNext()

void Playlist::Handler::playNext ( const MetaDataList & tracks )

insert tracks to active playlist after current playback position

Parameters

tracks list of tracks

◆ removeRows()

void Playlist::Handler::removeRows	(	const IndexSet &	indexes,
		int	playlistIndex
	)

remove rows from playlist

Parameters

indexes	list of row indices to be removed
playlistIndex	playlist index

◆ renamePlaylist()

Util::SaveAsAnswer Playlist::Handler::renamePlaylist	(	int	playlistIndex,
		const QString &	name
	)

rename playlist

Parameters

playlistIndex	playlist index
name	new playlist name

Returns

◆ requestNewPlaylistName()

QString Playlist::Handler::requestNewPlaylistName ( const QString & prefix = QString() ) const

Request a new name for the playlist (usually New %1 is returned). If the prefix differs, instead of New, the prefix is chosen. E.g. "File system 2" for tracks added by the file manager.

Parameters

The	prefix is a localized "New" by default.

Returns: playlist name

◆ resetPlaylist()

void Playlist::Handler::resetPlaylist ( int playlistIndex )

reload playlist from db

Parameters

playlistIndex playlist index

◆ savePlaylist()

Util::SaveAsAnswer Playlist::Handler::savePlaylist ( int playlistIndex )

save playlist to database, overwrite old one

Parameters

playlistIndex playlist index

Returns: SaveAnswer

◆ savePlaylistAs()

Util::SaveAsAnswer Playlist::Handler::savePlaylistAs	(	int	playlistIndex,
		const QString &	name,
		bool	forceOverride
	)

Save playlist under new name.

Parameters

playlistIndex	playlist index
name	new playlist name
force_override	override if name exists

Returns: AlreadyThere if name exists and force_override is false

◆ savePlaylistToFile()

void Playlist::Handler::savePlaylistToFile	(	int	playlistIndex,
		const QString &	filename,
		bool	relative
	)

save a playlist to file

Parameters

filename,if	filename does not end with m3u, extension is appended automatically
relative	relative paths in m3u file

◆ sigCurrentPlaylistChanged

void Playlist::Handler::sigCurrentPlaylistChanged ( int idx )

signal

emitted when tracks were added/removed or have changed

Parameters

idx	playlist index

◆ sigCurrentTrackChanged

void Playlist::Handler::sigCurrentTrackChanged	(	int	trackIndex,
		int	playlist_idx
	)

signal

emitted when current track index has changed

Parameters

trackIndex	index in playlist
playlist_idx	index of playlist

◆ sigNewPlaylistAdded

void Playlist::Handler::sigNewPlaylistAdded ( PlaylistPtr pl )

signal

emitted when new playlist has been added

Parameters

pl	reference to new playlist

◆ sigPlaylistCreated

void Playlist::Handler::sigPlaylistCreated ( PlaylistPtr pl )

signal

emitted when new playlist has been created

Parameters

pl	Playlist, usually current one

◆ sigPlaylistNameChanged

void Playlist::Handler::sigPlaylistNameChanged ( int idx )

signal

emitted when playlist name has changed

Parameters

idx	index of playlist

◆ sigTrackDeletionRequested

void Playlist::Handler::sigTrackDeletionRequested	(	const MetaDataList &	tracks,
		Library::TrackDeletionMode	deletion_mode
	)

signal

emitted when a track deletion was triggered over the Ui

Parameters

tracks	which tracks should be deleted
deletion_mode

Public Types

Public Slots

Signals

Public Member Functions

Detailed Description

Member Function Documentation

◆ activeIndex()

◆ appendTracks()

◆ changeTrack()

◆ clearPlaylist()

◆ closePlaylist()

◆ count()

◆ createEmptyPlaylist()

◆ createPlaylist() [1/4]

◆ createPlaylist() [2/4]

◆ createPlaylist() [3/4]

◆ createPlaylist() [4/4]

◆ deletePlaylist()

◆ insertTracks()

◆ loadOldPlaylists

◆ moveRows()

◆ playlist()

◆ playNext()

◆ removeRows()

◆ renamePlaylist()

◆ requestNewPlaylistName()

◆ resetPlaylist()

◆ savePlaylist()

◆ savePlaylistAs()

◆ savePlaylistToFile()

◆ sigCurrentPlaylistChanged

◆ sigCurrentTrackChanged

◆ sigNewPlaylistAdded

◆ sigPlaylistCreated

◆ sigPlaylistNameChanged

◆ sigTrackDeletionRequested