servius/songbird
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: added documentation for yt-dlp feature (#106)

Browse Source 
* Docs: added documentation for yt-dlp feature
* Docs: remove trailing whitespace
This commit is contained in:
Lunarmagpie
2022-01-04 08:45:39 -05:00
committed by GitHub
parent 62ecfe68d6
commit 73323e58dd
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/input/ytdl_src.rs
View File

@@ -31,7 +31,8 @@ const YOUTUBE_DL_COMMAND: &str = if cfg!(feature = "youtube-dlc") {
/// If you need looping or track seeking, then consider using /// If you need looping or track seeking, then consider using
/// [`Restartable::ytdl`]. /// [`Restartable::ytdl`].
/// ///
/// Uses `youtube-dlc` if the `"youtube-dlc"` feature is enabled. /// `youtube-dlc` and `yt-dlp` are also useable by enabling the `youtube-dlc`
/// and `yt-dlp` features respectively.
/// ///
/// [`Restartable::ytdl`]: crate::input::restartable::Restartable::ytdl /// [`Restartable::ytdl`]: crate::input::restartable::Restartable::ytdl
pub async fn ytdl(uri: impl AsRef<str>) -> Result<Input> { pub async fn ytdl(uri: impl AsRef<str>) -> Result<Input> {
@@ -169,7 +170,8 @@ pub(crate) async fn _ytdl_metadata(uri: &str) -> Result<Metadata> {
/// If you need looping or track seeking, then consider using /// If you need looping or track seeking, then consider using
/// [`Restartable::ytdl_search`]. /// [`Restartable::ytdl_search`].
/// ///
/// Uses `youtube-dlc` if the `"youtube-dlc"` feature is enabled. /// `youtube-dlc` and `yt-dlp` are also useable by enabling the `youtube-dlc`
/// and `yt-dlp` features respectively.
/// ///
/// [`Restartable::ytdl_search`]: crate::input::restartable::Restartable::ytdl_search /// [`Restartable::ytdl_search`]: crate::input::restartable::Restartable::ytdl_search
pub async fn ytdl_search(name: impl AsRef<str>) -> Result<Input> { pub async fn ytdl_search(name: impl AsRef<str>) -> Result<Input> {