Struct YoutubeDl 

pub struct YoutubeDl<'a> { /* private fields */ }

A lazily instantiated call to download a file, finding its URL via youtube-dl.

By default, this uses yt-dlp and is backed by an HttpRequest. This handler attempts to find the best audio-only source (typically WebM, enabling low-cost Opus frame passthrough).

Implementations

impl<'a> YoutubeDl<'a>

pub fn new(client: Client, url: impl Into<Cow<'a, str>>) -> Self

Creates a lazy request to select an audio stream from url, using “yt-dlp”.

This requires a reqwest client: ideally, one should be created and shared between all requests.

pub fn new_ytdl_like( program: &'a str, client: Client, url: impl Into<Cow<'a, str>>, ) -> Self

Creates a lazy request to select an audio stream from url as in new, using program.

pub fn new_search(client: Client, query: impl Into<Cow<'a, str>>) -> Self

Creates a request to search youtube for an optionally specified number of videos matching query, using “yt-dlp”.

pub fn new_search_ytdl_like( program: &'a str, client: Client, query: impl Into<Cow<'a, str>>, ) -> Self

Creates a request to search youtube for an optionally specified number of videos matching query, using program.

pub fn user_args(self, user_args: Vec<String>) -> Self

Sets additional arguments for the “yt-dlp” process

pub async fn search( &mut self, n_results: Option<usize>, ) -> Result<impl Iterator<Item = AuxMetadata>, AudioStreamError>

Runs a search for the given query, returning a list of up to n_results possible matches which are AuxMetadata objects containing a valid URL.

Returns up to 5 matches by default.

pub async fn query( &mut self, n_results: usize, ) -> Result<Vec<YoutubeDlOutput>, AudioStreamError>

Runs a search for the given query, returning a list of up to n_results possible matches.

pub async fn get_stream( &self, result: &YoutubeDlOutput, ) -> Result<AudioStream<Box<dyn MediaSource>>, AudioStreamError>

Get the audio stream from a YoutubeDlOutput.

Trait Implementations

impl<'a> Clone for YoutubeDl<'a>

fn clone(&self) -> YoutubeDl<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Compose for YoutubeDl<'_>

fn create( &mut self, ) -> Result<AudioStream<Box<dyn MediaSource>>, AudioStreamError>

Create a source synchronously.

fn create_async<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<AudioStream<Box<dyn MediaSource>>, AudioStreamError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a source asynchronously.

fn should_create_async(&self) -> bool

Determines whether this source will be instantiated using create or create_async.

fn aux_metadata<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<AuxMetadata, AudioStreamError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Requests auxiliary metadata which can be accessed without parsing the file.

impl<'a> Debug for YoutubeDl<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<YoutubeDl<'static>> for Input

fn from(val: YoutubeDl<'static>) -> Self

Converts to this type from the input type.