anna
/
ocarina
1
0
Fork 0
Code Issues 7 Pull Requests Releases Wiki Activity

playlist: Add doxygen comments. 

Signed-off-by: Anna Schumaker <Anna@OcarinaProject.net>
This commit is contained in:
Anna Schumaker 2014-09-15 08:26:52 -04:00
parent d0fd103504
commit 73264e04ce
2 changed files with 49 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
core/playlist.cpp
View File

@ -1,4 +1,5 @@
/*
/**
* @file
* Copyright 2013 (c) Anna Schumaker.
*/
#include <core/library.h>

48
include/core/playlist.h
View File

@ -1,4 +1,5 @@
/*
/**
* @file
* Copyright 2013 (c) Anna Schumaker.
*/
#ifndef OCARINA_CORE_PLAYLIST_H
@ -9,15 +10,60 @@
#include <string>
/**
* Namespace for accessing playlists.
*/
namespace playlist
{
/**
* Read playlist information from disk.
*/
void init();
/**
* Check if a specific track is in a playlist.
*
* @param track The track in question.
* @param name The name of the playlist to check.
* @return True if the track is in the playlist, false otherwise.
*/
bool has(Track *, const std::string &);
/**
* Add a track to a playlist.
*
* @param track The track to add.
* @param name The name of the playlist to add to.
*/
void add(Track *, const std::string &);
/**
* Remove a track from a playlist.
*
* @param track The track to remove.
* @param name The name of the playlist to remove from.
*/
void del(Track *, const std::string &);
/**
* Use to change the currently queued playlist.
*
* @param name The name of the queue to queue up.
*/
void select(const std::string &);
/**
* Use to access specific tracks in a playlist.
*
* @param name The playlist to access.
* @return The IndexEntry containing the tracks.
*/
IndexEntry *get_tracks(const std::string &);
/**
* @return The playlist queue.
*/
Queue *get_queue();
};