oysteikt/mpd
oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

playlist/Stream: add API documentation

Browse Source
This commit is contained in:
Max Kellermann 2024-05-15 19:59:09 +02:00
parent 4e7b554605
commit eceead671e
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/playlist/PlaylistStream.hxx
View File

@ -1,8 +1,7 @@
// SPDX-License-Identifier: GPL-2.0-or-later // SPDX-License-Identifier: GPL-2.0-or-later
// Copyright The Music Player Daemon Project // Copyright The Music Player Daemon Project
#ifndef MPD_PLAYLIST_STREAM_HXX #pragma once
#define MPD_PLAYLIST_STREAM_HXX
#include "thread/Mutex.hxx" #include "thread/Mutex.hxx"
@ -20,8 +19,12 @@ class Path;
std::unique_ptr<SongEnumerator> std::unique_ptr<SongEnumerator>
playlist_open_path(Path path, Mutex &mutex); playlist_open_path(Path path, Mutex &mutex);
/**
* Opens a playlist from a remote file.
*
* @param uri the absolute URI of the playlist file
* @return a playlist, or nullptr on error
*/
[[gnu::nonnull]] [[gnu::nonnull]]
std::unique_ptr<SongEnumerator> std::unique_ptr<SongEnumerator>
playlist_open_remote(const char *uri, Mutex &mutex); playlist_open_remote(const char *uri, Mutex &mutex);
#endif