Struct DownloaderBuilder

pub struct DownloaderBuilder { /* private fields */ }

Builder to construct a new downloader

Implementations

impl DownloaderBuilder

pub fn new() -> Self

Create a new DownloaderBuilder

This is the same as Downloader::builder

pub fn rustypipe(self, rp: &RustyPipe) -> Self

Use a custom RustyPipe client

pub fn ffmpeg<S: Into<String>>(self, ffmpeg: S) -> Self

Set the path to ffmpeg, used to join video and audio files

The default system-wide ffmpeg binary is used by default.

pub fn multi_progress(self, progress: MultiProgress) -> Self

Available on crate feature indicatif only.

Set the indicatif MultiProgress used to show download progress for all downloads

pub fn progress_style(self, style: ProgressStyle) -> Self

Available on crate feature indicatif only.

Set the indicatif ProgressStyle for the progress bars displayed under multi_progress

pub fn stream_filter(self, filter: StreamFilter) -> Self

Set the default StreamFilter for all downloads.

The filter can be overridden for individual download queries.

pub fn video_format(self, video_format: DownloadVideoFormat) -> Self

Set the DownloadVideoFormat of downloaded videos

pub fn n_retries(self, n_retries: u32) -> Self

Set the number of retries in case a download fails with a 403 error

pub fn path_precheck(self) -> Self

Enable path precheck

The downloader will check if the destination path (predicted from the entity to download and the StreamFilter) exists and skips the download with DownloadError::Exists without fetching any player data.

This allows fast resumption of playlist downloads.

pub fn audio_tag(self) -> Self

Available on crate feature audiotag only.

Enable audio tagging

pub fn crop_cover(self) -> Self

Available on crate feature audiotag only.

Crop YouTube thumbnails to get square album covers

pub fn client_type(self, client_type: ClientType) -> Self

Set the ClientType used to fetch the YT player

pub fn client_types<T: Into<Vec<ClientType>>>(self, client_types: T) -> Self

Set a list of client types used to fetch the YT player

The clients are used in the given order. If a client cannot fetch the requested video, an attempt is made with the next one.

pub fn build(self) -> Downloader

Create a new, configured Downloader instance

pub fn build_with_client(self, http_client: Client) -> Downloader

Create a new, configured Downloader instance using a custom Reqwest Client

Trait Implementations

impl Default for DownloaderBuilder

fn default() -> Self

Returns the “default value” for a type.