gotube

README

gotube

A simple youtube-dl wrapper for golang

Documentation

Index

• type Caption
• type Channel
• type GoTubeClient
  • func New(youtubeDlPath string, customArgs []string) *GoTubeClient
  • func (gtc *GoTubeClient) NewPlaylist(url string, extractParallel bool) (*Playlist, error)
  • func (gtc *GoTubeClient) NewVideo(url string) (*Video, error)
• type Playlist
• type Stream
  • func (s *Stream) Download(destPath string, destFile string) error
  • func (s *Stream) HasAudio() bool
  • func (s *Stream) HasVideo() bool
  • func (s *Stream) IsDash() bool
• type Streams
  • func (s Streams) Filtered(predicate func(s *Stream) bool) Streams
  • func (s Streams) OrderedBy(property string) Streams
• type Thumbnail
• type Thumbnails
  • func (t Thumbnails) Filtered(predicate func(t *Thumbnail) bool) Thumbnails
  • func (t Thumbnails) OrderedBy(property string) Thumbnails
• type Video
  • func (v *Video) IsAgeRestricted() bool
• type Videos

Types

type Caption

type Caption struct {
	URL       string `json:"url"` //
	Extension string `json:"ext"` //
}

This holds all information about a caption. Not implemented yet.

type Channel

type Channel struct {
	ID   string `json:"uploader_id"`  // The channel ID.
	URL  string `json:"uploader_url"` // The channel URL.
	Name string `json:"uploader"`     // The channel name.
}

This holds basic information about a channel.

type GoTubeClient

type GoTubeClient struct {
	YoutubeDlPath   string
	CustomArguments []string
}

Use this structs methods to extract video/playlist data.

func New

func New(youtubeDlPath string, customArgs []string) *GoTubeClient

This is a constructor for 'GoTubeClient'. Here you can set the path to the youtube-dl binary and custom arguments. Use this structs methods to extract video/playlist data. Returns a new 'SGoTube' struct.

func (*GoTubeClient) NewPlaylist

func (gtc *GoTubeClient) NewPlaylist(url string, extractParallel bool) (*Playlist, error)

Extracts playlist information from given playlist URL. Returns a new 'Playlist' struct and any errors encountered.

func (*GoTubeClient) NewVideo

func (gtc *GoTubeClient) NewVideo(url string) (*Video, error)

Extracts video information from given video URL. Returns a new 'Video' struct and any errors encountered.

type Playlist

type Playlist struct {
	ID       string   `json:"playlist_id"`    // The playlist ID.
	Title    string   `json:"playlist_title"` // The playlist title.
	Uploader *Channel `json:""`               // The uploader of the playlist.
	Videos   Videos   `json:"entries"`        // The videos in the playlist.
}

This holds basic information about a playlist.

type Stream

type Stream struct {
	URL        string  `json:"url"`         // The URL of the stream.
	Extension  string  `json:"ext"`         // The file extension of the stream.
	FileSize   int     `json:"filesize"`    // The file size of the stream.
	ASR        float32 `json:"asr"`         // The audio sample rate used.
	TBR        float32 `json:"tbr"`         // I don't know. But it's there and sure useful for someone.
	VBR        float32 `json:"vbr"`         // The video bit rate used.
	Quality    int     `json:"quality"`     // The quality of the stream. This corresponds to the quality setting when watching youtube videos.
	ACodec     string  `json:"acodec"`      // The audio codec used.
	VCodec     string  `json:"vcodec"`      // The video codec used.
	Height     int     `json:"height"`      // The height of the video.
	Width      int     `json:"width"`       // The width of the video.
	FPS        float32 `json:"fps"`         // The frames per second of the video.
	FormatID   string  `json:"format_id"`   // The Format ID of the stream. See https://gist.github.com/AgentOak/34d47c65b1d28829bb17c24c04a0096f for more.
	FormatNote string  `json:"format_note"` // The format note of the stream.
}

This holds all important (and not so important) information about a video stream.

func (*Stream) Download

func (s *Stream) Download(destPath string, destFile string) error

Downloads the stream file to the specified Path\File. File extension is automatically added. File is overwritten if it already exists. Returns any errors encountered.

func (*Stream) HasAudio

func (s *Stream) HasAudio() bool

Returns true if the stream contains audio data.

func (*Stream) HasVideo

func (s *Stream) HasVideo() bool

Returns true if the stream contains video data.

func (*Stream) IsDash

func (s *Stream) IsDash() bool

Returns true if the stream is a dash stream.

type Streams

type Streams []*Stream

func (Streams) Filtered

func (s Streams) Filtered(predicate func(s *Stream) bool) Streams

Returns a list of streams that match the specified filter function. It does not modify the original list.

func (Streams) OrderedBy

func (s Streams) OrderedBy(property string) Streams

Returns a list of streams sorted by the specified property. It does not modify the original list. It panics if the property is not found.

type Thumbnail

type Thumbnail struct {
	ID     int    `json:"id"`     // The thumbnail ID.
	URL    string `json:"url"`    // The thumbnail URL.
	Height int    `json:"height"` // The thumbnail height.
	Width  int    `json:"width"`  // The thumbnail width.
}

This holds all information about a thumbnail.

type Thumbnails

type Thumbnails []*Thumbnail

func (Thumbnails) Filtered

func (t Thumbnails) Filtered(predicate func(t *Thumbnail) bool) Thumbnails

Returns a list of thumbnails that match the specified filter function. It does not modify the original list.

func (Thumbnails) OrderedBy

func (t Thumbnails) OrderedBy(property string) Thumbnails

Returns a list of thumbnails sorted by the specified property. It does not modify the original list. It panics if the property is not found.

type Video

type Video struct {
	ID            string     `json:"id"`             // The video ID.
	URL           string     `json:"webpage_url"`    // The video URL.
	Title         string     `json:"title"`          // The video title.
	AltTitle      string     `json:"alt_title"`      // The video alternative title.
	Description   string     `json:"description"`    // The video description.
	Tags          []string   `json:"tags"`           // The video tags.
	ViewCount     int        `json:"view_count"`     // The number of views.
	LikeCount     int        `json:"like_count"`     // The number of likes.
	Duration      float32    `json:"duration"`       // The video duration in seconds.
	UploadDate    string     `json:"upload_date"`    // The upload date in unix time.
	AgeLimit      int        `json:"age_limit"`      // The age limit of the video.
	IsLive        bool       `json:"is_live"`        // If the video is live.
	PlaylistIndex int        `json:"playlist_index"` // The index of the video in the playlist.
	Uploader      *Channel   `json:""`               // The uploader of the video.
	Thumbnails    Thumbnails `json:"thumbnails"`     // The thumbnails of the video.
	Streams       Streams    `json:"formats"`        // The streams of the video.

}

This holds all important information about a video.

func (*Video) IsAgeRestricted

func (v *Video) IsAgeRestricted() bool

Returns true if the video is age restricted.

type Videos

type Videos []*Video