cli

package
v0.6.23 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 18, 2025 License: MIT Imports: 29 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrVideoHasNoPosterThumbnail = errors.New("video has no poster thumbnails")
)
View Source 
var (
	GitTag string
)

Functions

func AddChannel added in v0.5.33 

func AddChannel(rdx redux.Writeable, channelId string, opt *ChannelOptions) error

func AddChannelHandler added in v0.5.33 

func AddChannelHandler(u *url.URL) error

func AddPlaylist added in v0.5.0 

func AddPlaylist(rdx redux.Writeable, playlistId string, opt *PlaylistOptions) error

func AddPlaylistHandler added in v0.5.0 

func AddPlaylistHandler(u *url.URL) error

func AddVideo added in v0.5.0 

func AddVideo(rdx redux.Writeable, videoId string, opt *VideoOptions) error

func AddVideoHandler added in v0.5.0 

func AddVideoHandler(u *url.URL) error

func Backup added in v0.2.39 

func Backup() error

func BackupHandler added in v0.2.39 

func BackupHandler(_ *url.URL) error

func CleanupEndedVideos added in v0.5.61 

func CleanupEndedVideos(now bool, rdx redux.Writeable) error

CleanupEndedVideos removes downloads for Ended videos that match the following conditions: - video download has not been downloaded earlier - at least 48 hours have passed since the ended date (unless no-delay was set) Additionally CleanupEndedVideos will remove video properties (except for title) for ended videos

func CleanupEndedVideosHandler added in v0.5.61 

func CleanupEndedVideosHandler(u *url.URL) error

func DehydratePosters added in v0.6.0 

func DehydratePosters(force bool) error

func DehydratePostersHandler added in v0.6.0 

func DehydratePostersHandler(u *url.URL) error

func DownloadVideo added in v0.5.0 

func DownloadVideo(rdx redux.Writeable, opt *VideoOptions, videoIds ...string) error

func DownloadVideoHandler added in v0.5.0 

func DownloadVideoHandler(u *url.URL) error

func GetCaptions added in v0.1.61 

func GetCaptions(force bool, videoIds ...string) error

func GetCaptionsHandler added in v0.1.61 

func GetCaptionsHandler(u *url.URL) error

func GetChannelsMetadata added in v0.5.33 

func GetChannelsMetadata(rdx redux.Writeable, opt *ChannelOptions, channelIds ...string) error

func GetChannelsMetadataHandler added in v0.5.33 

func GetChannelsMetadataHandler(u *url.URL) error

func GetPlaylistsMetadata added in v0.5.33 

func GetPlaylistsMetadata(rdx redux.Writeable, opt *PlaylistOptions, playlistIds ...string) error

func GetPlaylistsMetadataHandler added in v0.5.33 

func GetPlaylistsMetadataHandler(u *url.URL) error

func GetPoster added in v0.1.32 

func GetPoster(force bool, videoIds ...string) error

func GetPosterHandler added in v0.1.32 

func GetPosterHandler(u *url.URL) error

func GetRuTubeVideo added in v0.3.93 

func GetRuTubeVideo(force bool, urls ...string) error

func GetRuTubeVideoHandler added in v0.3.93 

func GetRuTubeVideoHandler(u *url.URL) error

func GetVideoMetadata added in v0.1.82 

func GetVideoMetadata(rdx redux.Writeable, opt *VideoOptions, videoIds ...string) error

func GetVideoMetadataHandler added in v0.1.82 

func GetVideoMetadataHandler(u *url.URL) error

func Migrate added in v0.3.98 

func Migrate() error

func MigrateHandler added in v0.3.98 

func MigrateHandler(_ *url.URL) error

func ProcessQueue added in v0.5.56 

func ProcessQueue(rdx redux.Writeable, opt *VideoOptions) error

ProcessQueue processes download queue using the following rules: - download has not been completed after queue time - download is not in progress since queue time and less than 48 hours ago

func ProcessQueueHandler added in v0.5.56 

func ProcessQueueHandler(u *url.URL) error

func QueueChannelsDownloads added in v0.5.33 

func QueueChannelsDownloads(rdx redux.Writeable) error

func QueueChannelsDownloadsHandler added in v0.5.33 

func QueueChannelsDownloadsHandler(u *url.URL) error

func QueuePlaylistsDownloads added in v0.5.0 

func QueuePlaylistsDownloads(rdx redux.Writeable) error

func QueuePlaylistsDownloadsHandler added in v0.5.0 

func QueuePlaylistsDownloadsHandler(_ *url.URL) error

func RefreshChannelsMetadata added in v0.5.33 

func RefreshChannelsMetadata(rdx redux.Writeable) error

func RefreshChannelsMetadataHandler added in v0.5.33 

func RefreshChannelsMetadataHandler(_ *url.URL) error

func RefreshPlaylistsMetadata added in v0.5.0 

func RefreshPlaylistsMetadata(rdx redux.Writeable) error

func RefreshPlaylistsMetadataHandler added in v0.5.0 

func RefreshPlaylistsMetadataHandler(_ *url.URL) error

func RemoveChannel added in v0.5.33 

func RemoveChannel(rdx redux.Writeable, channelId string, opt *ChannelOptions) error

func RemoveChannelHandler added in v0.5.33 

func RemoveChannelHandler(u *url.URL) error

func RemovePlaylist added in v0.5.0 

func RemovePlaylist(rdx redux.Writeable, playlistId string, opt *PlaylistOptions) error

func RemovePlaylistHandler added in v0.5.0 

func RemovePlaylistHandler(u *url.URL) error

func RemoveVideos added in v0.1.82 

func RemoveVideos(rdx redux.Writeable, videoId string, opt *VideoOptions) error

func RemoveVideosHandler added in v0.1.82 

func RemoveVideosHandler(u *url.URL) error

func ScrubDepositionProperties added in v0.5.63 

func ScrubDepositionProperties(rdx redux.Writeable) error

ScrubDepositionProperties will remove all accumulated property depositions: - search results - older channel and playlist videos properties To do that we start by identifying all critical videos: - part of current channel, playlist data - downloaded, not-ended videos Then we iterate over all non-preserved properties and remove data for all non-critical videos

func ScrubDepositionPropertiesHandler added in v0.5.63 

func ScrubDepositionPropertiesHandler(u *url.URL) error

func ScrubEndedProperties added in v0.5.63 

func ScrubEndedProperties(rdx redux.Writeable) error

ScrubEndedProperties will remove all non-preserved properties for ended videos. Preserved properties are required for core functionality - history, cleanup, etc.

func ScrubEndedPropertiesHandler added in v0.5.63 

func ScrubEndedPropertiesHandler(_ *url.URL) error

func Serve added in v0.1.22 

func Serve(port int, stderr bool) error

func ServeHandler added in v0.1.22 

func ServeHandler(u *url.URL) error

func Sync added in v0.2.12 

func Sync(rdx redux.Writeable, opt *VideoOptions) error

func SyncHandler added in v0.2.12 

func SyncHandler(u *url.URL) error

func UpdateYtDlp added in v0.5.75 

func UpdateYtDlp(force bool) error

func UpdateYtDlpHandler added in v0.5.75 

func UpdateYtDlpHandler(u *url.URL) error

func VersionHandler 

func VersionHandler(_ *url.URL) error

Types

type ChannelOptions added in v0.5.0 

type ChannelOptions struct {
	Playlists      bool
	AutoRefresh    bool
	AutoDownload   bool
	DownloadPolicy data.DownloadPolicy
	Expand         bool
	Force          bool
}

func DefaultChannelOptions added in v0.5.0 

func DefaultChannelOptions() *ChannelOptions

type PlaylistOptions added in v0.5.0 

type PlaylistOptions struct {
	AutoRefresh    bool
	AutoDownload   bool
	DownloadPolicy data.DownloadPolicy
	Expand         bool
	Force          bool
}

func DefaultPlaylistOptions added in v0.5.0 

func DefaultPlaylistOptions() *PlaylistOptions

type VideoOptions added in v0.5.0 

type VideoOptions struct {
	Favorite      bool
	DownloadQueue bool
	Progress      bool
	Ended         bool
	Reason        data.VideoEndedReason
	Force         bool
}

func ApplyVideoDownloadOptions added in v0.5.0 

func ApplyVideoDownloadOptions(opt *VideoOptions, videoId string, rdx redux.Readable) *VideoOptions

func DefaultVideoOptions added in v0.5.0 

func DefaultVideoOptions() *VideoOptions

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.