Struct rustube::Video

pub struct Video { /* fields omitted */ }

A YouTube downloader, which allows you to download all available formats and qualities of a YouTube video.

Each instance of Video represents an existing, available, and downloadable video.

There are two ways of constructing an instance of Video:

1. By using the asynchronous Video::from_* methods. These methods will take some kind of video-identifier, like an Url or an Id, will then internally download the necessary video information and finally descramble it.
2. By calling VideoDescrambler::descramble. Since a VideoDescrambler already contains the necessary video information, and just need to descramble it, no requests are performed. (This gives you more control over the process).

Examples

• Constructing using Video::from_url (or Video::from_id) (easiest way)

let url = Url::parse("https://youtube.com/watch?iv=5jlI4uzZGjU")?;
let video: Video = Video::from_url(&url).await?;

• Constructing using VideoDescrambler::descramble

let url = Url::parse("https://youtube.com/watch?iv=5jlI4uzZGjU")?;
let fetcher: VideoFetcher = VideoFetcher::from_url(&url)?;
let descrambler: VideoDescrambler = fetcher.fetch().await?;  
let video: Video = descrambler.descramble()?;

• Construction using chained calls

let url = Url::parse("https://youtube.com/watch?iv=5jlI4uzZGjU")?;
let video: Video = VideoFetcher::from_url(&url)?
   .fetch()
   .await?
   .descramble()?;

• Downloading a video using an existing Video instance

let video_path = video
   .streams()
   .iter()
   .filter(|stream| stream.includes_video_track && stream.includes_audio_track)
   .max_by_key(|stream| stream.quality_label)
   .unwrap()
   .download()
   .await?;

Implementations

impl Video

pub async fn from_url(url: &Url) -> Result<Self>

This is supported on crate features download and regex and descramble only.

Creates a Video from an Url.

Errors

• When VideoFetcher::from_url fails.
• When VideoFetcher::fetch fails.
• When VideoDescrambler::descramble fails.

pub async fn from_id(id: IdBuf) -> Result<Self>

This is supported on crate features descramble and download only.

Creates a Video from an Id.

Errors

• When VideoFetcher::fetch fails.
• When VideoDescrambler::descramble fails.

pub fn video_info(&self) -> &VideoInfo

This is supported on crate feature descramble only.

The VideoInfo of the video.

pub fn streams(&self) -> &Vec<Stream>

This is supported on crate feature descramble only.

All Streams of the video.

pub fn into_streams(self) -> Vec<Stream>

This is supported on crate feature descramble only.

Takes all Streams of the video.

pub fn into_parts(self) -> (VideoInfo, Vec<Stream>)

This is supported on crate feature descramble only.

Decomposes a Video into it’s raw parts.

pub fn video_details(&self) -> Arc<VideoDetails>

This is supported on crate feature descramble only.

The VideoDetailss of the video.

pub fn id(&self) -> Id<'_>

This is supported on crate feature descramble only.

The Id of the video.

pub fn title(&self) -> &str

This is supported on crate feature descramble only.

The title of the video.

pub fn is_age_restricted(&self) -> bool

This is supported on crate feature descramble only.

Whether or not the video is age restricted.

pub fn best_quality(&self) -> Option<&Stream>

This is supported on crate feature descramble only.

The Stream with the best quality. This stream is guaranteed to contain both a video as well as an audio track.

pub fn worst_quality(&self) -> Option<&Stream>

This is supported on crate feature descramble only.

The Stream with the worst quality. This stream is guaranteed to contain both a video as well as an audio track.

pub fn best_video(&self) -> Option<&Stream>

This is supported on crate feature descramble only.

The Stream with the best video quality. This stream is guaranteed to contain only a video but no audio track.

pub fn worst_video(&self) -> Option<&Stream>

This is supported on crate feature descramble only.

The Stream with the worst video quality. This stream is guaranteed to contain only a video but no audio track.

pub fn best_audio(&self) -> Option<&Stream>

This is supported on crate feature descramble only.

The Stream with the best audio quality. This stream is guaranteed to contain only a audio but no video track.

pub fn worst_audio(&self) -> Option<&Stream>

This is supported on crate feature descramble only.

The Stream with the worst audio quality. This stream is guaranteed to contain only a audio but no video track.

Trait Implementations

impl Clone for Video

This is supported on crate feature descramble only.

fn clone(&self) -> Video

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Video

This is supported on crate feature descramble only.

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

Formats the value using the given formatter.

impl Display for Video

This is supported on crate feature descramble only.

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

Formats the value using the given formatter.

impl PartialEq<Video> for Video

This is supported on crate feature descramble only.

fn eq(&self, other: &Video) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Video) -> bool

This method tests for !=.

impl StructuralPartialEq for Video

This is supported on crate feature descramble only.