downloader

Documentation

Index

• type DownloadOption
  • func (opt *DownloadOption) Validate() error
• type Downloader
  • func NewDownloader(conf *conf.DownloaderConfig) (*Downloader, error)
  • func (d *Downloader) Download(ctx context.Context, opt *DownloadOption) (*Result, error)
  • func (d *Downloader) TryStart(ctx context.Context, next func() *dao.Content, ...)
• type Result

Types

type DownloadOption

type DownloadOption struct {
	ContentCredit string // content credit
	Format        string // download format
	Force         bool   // force download, delete the existing file
}

func (*DownloadOption) Validate

func (opt *DownloadOption) Validate() error

type Downloader

type Downloader struct {
	// contains filtered or unexported fields
}

Downloader is responsible for downloading contents using youtube-dl. @see https://github.com/yt-dlp/yt-dlp

func NewDownloader

func NewDownloader(conf *conf.DownloaderConfig) (*Downloader, error)

NewDownloader creates a new Downloader instance and ensures the necessary binaries and directories are set up.

func (*Downloader) Download

func (d *Downloader) Download(ctx context.Context, opt *DownloadOption) (*Result, error)

Download downloads a content based on the provided DownloadOption and returns the Result.

func (*Downloader) TryStart

func (d *Downloader) TryStart(ctx context.Context, next func() *dao.Content, update func(dao.Content, *Result))

type Result

type Result struct {
	Finished   bool    // download finished
	Progress   float64 // download progress
	ContentURL string  // content url
	Output     string  // absolute output file path
}