youtube

package

Go to main page

Versions in this module

v0

v0.4.1

Jun 21, 2026

Changes in this version

type Client

+ func (c *Client) DownloadToFileWithUserAgent(ctx context.Context, rawURL, dst string, total int64, workers int, ...) error

type InnerTubeClient

+ func (it *InnerTubeClient) WebSafariPlayer(ctx context.Context, videoID, visitorData string, signatureTimestamp int) (map[string]any, error)

type Stream

+ func (s Stream) UserAgent() string

v0.4.0

Jun 15, 2026

Changes in this version

+ func EdgeHelp() string

type Client

+ func (c *Client) Walk(ctx context.Context, seeds []Seed, opts WalkOptions, emit func(*Node) error) error

+ type Edge string

+ const EdgeChannel

+ const EdgeCommenter

+ const EdgeComments

+ const EdgeCommunity

+ const EdgeItems

+ const EdgeOwner

+ const EdgePlaylists

+ const EdgeRelated

+ const EdgeUploads

+ func (e Edge) Target() NodeKind

+ type EdgeSet map[Edge]bool

+ func DefaultEdges() EdgeSet

+ func ParseEdges(spec string) (EdgeSet, error)

+ func (s EdgeSet) Has(e Edge) bool

+ func (s EdgeSet) List() []Edge

+ func (s EdgeSet) String() string

+ type Node struct

+ Channel *Channel

+ Comment *Comment

+ Depth int

+ Kind NodeKind

+ Parent string

+ Playlist *Playlist

+ Post *CommunityPost

+ Via Edge

+ Video *Video

+ func (n *Node) Endpoint() string

+ type NodeKind string

+ const KindChannel

+ const KindComment

+ const KindPlaylist

+ const KindPost

+ const KindVideo

+ type Seed struct

+ Kind NodeKind

+ Ref string

+ func ParseSeed(ref string) (Seed, error)

type Store

+ func (s *Store) UpsertEdge(src, dst, kind string) error

+ func (s *Store) UpsertNode(n *Node) error

+ type WalkOptions struct

+ Depth int

+ Edges EdgeSet

+ Fanout int

+ Max int

+ Note func(string)

+ OnEdge func(src, dst string, edge Edge)

+ type Walker struct

+ func NewWalker(g grapher) *Walker

+ func (w *Walker) Walk(ctx context.Context, seeds []Seed, opts WalkOptions, emit func(*Node) error) error

v0.3.2

Jun 14, 2026

v0.3.1

Jun 14, 2026

v0.3.0

Jun 14, 2026

v0.2.0

Jun 14, 2026

Changes in this version

+ type Domain struct

+ func (Domain) Classify(input string) (uriType, id string, err error)

+ func (Domain) Info() kit.DomainInfo

+ func (Domain) Locate(uriType, id string) (string, error)

+ func (Domain) Register(app *kit.App)

+ type Suggestion struct

+ Text string

v0.1.1

Jun 13, 2026

v0.1.0

Jun 13, 2026

Changes in this version

+ const BaseURL

+ const DefaultDelay

+ const DefaultMaxResults

+ const DefaultRetries

+ const DefaultTimeout

+ const DefaultWorkers

+ const EntityChannel

+ const EntityComments

+ const EntityCommunity

+ const EntityHashtag

+ const EntityPlaylist

+ const EntitySearch

+ const EntityVideo

+ const MusicBaseURL

+ var AllSponsorCategories = []string

+ var ErrCommentsRestricted = errors.New("comments hidden by Restricted Mode")

+ var ErrFFmpegMissing = errors.New(...)

+ var ErrStop = errors.New("youtube: stop iteration")

+ func CommentsRestricted(root any) bool

+ func Crawl(ctx context.Context, c *Client, store *Store, opt CrawlOptions, ...) error

+ func EmbedThumbnail(ctx context.Context, ffmpeg, media, image, out string) error

+ func Export(store *Store, channel, outDir string) error

+ func ExtractAudio(ctx context.Context, ffmpeg, in, out, codec, quality string) error

+ func ExtractHashtags(text string) []string

+ func ExtractPlaylistID(input string) string

+ func ExtractVideoID(input string) string

+ func FFmpeg(explicit string) string

+ func FindCommentsToken(root any) string

+ func MergeAV(ctx context.Context, ffmpeg, videoPath, audioPath, out string) error

+ func NormalizeChannelID(input string) string

+ func NormalizeChannelURL(input string) string

+ func NormalizePlaylistURL(input string) string

+ func NormalizeVideoURL(input string) string

+ func ParseChannelNumericCounts(data map[string]any, ch *Channel)

+ func ParseChannelPage(data *PageData, pageURL string) (*Channel, []Video, string, error)

+ func ParseContinuationPlaylistVideos(data map[string]any, playlistID string) ([]Video, []PlaylistVideo, string)

+ func ParseInnerTubeSearchResults(data map[string]any) ([]Video, []Channel, []Playlist, string)

+ func ParseMicroformat(playerResp map[string]any, v *Video)

+ func ParsePlaylistPage(data *PageData, pageURL string) (*Playlist, []PlaylistVideo, []Video, string, error)

+ func ParseSearchPage(data *PageData, query string) ([]SearchResult, []Video, []Channel, []Playlist, string, error)

+ func ParseVideoPage(data *PageData, pageURL string) (*Video, []CaptionTrack, []RelatedVideo, string, error)

+ func RenderOutputTemplate(tmpl string, f OutputFields) string

+ func RenderSubtitles(segs []TranscriptSegment, format SubtitleFormat) string

+ func SponsorChapters(segs []SponsorSegment) string

+ type Album struct

+ AlbumID string

+ AlbumType string

+ ArtistID string

+ ArtistName string

+ AudioPlaylistID string

+ Description string

+ DurationText string

+ FetchedAt time.Time

+ ThumbnailURL string

+ Title string

+ TrackCount int

+ URL string

+ Year string

+ type AlbumTrack struct

+ AlbumID string

+ Position int

+ VideoID string

+ type Artist struct

+ ArtistID string

+ Description string

+ FetchedAt time.Time

+ Name string

+ SubscribersText string

+ ThumbnailURL string

+ URL string

+ type ArtistAlbum struct

+ AlbumID string

+ AlbumType string

+ ArtistID string

+ type CaptionTrack struct

+ BaseURL string

+ FetchedAt time.Time

+ IsAutoGenerated bool

+ Kind string

+ LanguageCode string

+ Name string

+ VideoID string

+ type Channel struct

+ AvatarURL string

+ BannerURL string

+ ChannelID string

+ Country string

+ Description string

+ FetchedAt time.Time

+ Handle string

+ IsVerified bool

+ JoinedDateText string

+ Keywords []string

+ SubscriberCount int64

+ SubscribersText string

+ Title string

+ TrailerVideoID string

+ URL string

+ UploadsPlaylistID string

+ VideoCount int64

+ VideosText string

+ ViewCount int64

+ ViewsText string

+ type Chapter struct

+ Position int

+ StartSeconds int

+ ThumbnailURL string

+ Title string

+ VideoID string

+ func ParseChapters(nextResp map[string]any, videoID string, description string) []Chapter

+ type Client struct

+ func NewClient(cfg Config) *Client

+ func (c *Client) Captions(ctx context.Context, idOrURL string) ([]CaptionTrack, error)

+ func (c *Client) DownloadThumbnail(ctx context.Context, videoID, dst string) (Thumbnail, error)

+ func (c *Client) DownloadToFile(ctx context.Context, rawURL, dst string, total int64, workers int, ...) error

+ func (c *Client) Fetch(ctx context.Context, url string) ([]byte, int, error)

+ func (c *Client) FetchAlbum(ctx context.Context, idOrURL string) (*Album, []Song, error)

+ func (c *Client) FetchArtist(ctx context.Context, idOrURL string) (*Artist, []Album, []Song, error)

+ func (c *Client) FetchChannel(ctx context.Context, idOrURL string) (*Channel, error)

+ func (c *Client) FetchHTML(ctx context.Context, url string) (*goquery.Document, int, error)

+ func (c *Client) FetchMusicPlaylist(ctx context.Context, idOrURL string) (*Album, []Song, error)

+ func (c *Client) FetchPageData(ctx context.Context, url string) (*PageData, int, error)

+ func (c *Client) FetchPlaylist(ctx context.Context, idOrURL string) (*Playlist, error)

+ func (c *Client) FetchSong(ctx context.Context, videoID string, withLyrics bool) (*Song, error)

+ func (c *Client) FetchTimedText(ctx context.Context, url string) ([]byte, error)

+ func (c *Client) FetchVideo(ctx context.Context, idOrURL string, opt VideoOptions) (*VideoResult, error)

+ func (c *Client) Formats(ctx context.Context, idOrURL string) ([]VideoFormat, error)

+ func (c *Client) GL() string

+ func (c *Client) HL() string

+ func (c *Client) HTTP() *http.Client

+ func (c *Client) MusicSearch(ctx context.Context, query, typ string, opt PageOptions, emit func(any) error) error

+ func (c *Client) ResolveChannelID(ctx context.Context, input string) (string, error)

+ func (c *Client) ResolveStreamURL(ctx context.Context, m *StreamManifest, s *Stream) (string, error)

+ func (c *Client) Search(ctx context.Context, query string, f SearchFilters, opt PageOptions, ...) error

+ func (c *Client) SponsorSegments(ctx context.Context, videoID string, categories []string) ([]SponsorSegment, error)

+ func (c *Client) StreamChannelPlaylists(ctx context.Context, idOrURL string, opt PageOptions, ...) error

+ func (c *Client) StreamChannelTab(ctx context.Context, idOrURL, tab string, opt PageOptions, ...) error

+ func (c *Client) StreamComments(ctx context.Context, idOrURL string, opt CommentOptions, ...) error

+ func (c *Client) StreamCommunity(ctx context.Context, channel string, opt PageOptions, ...) error

+ func (c *Client) StreamHashtag(ctx context.Context, tag string, opt PageOptions, emit func(Video) error) error

+ func (c *Client) StreamManifest(ctx context.Context, idOrURL string) (*StreamManifest, error)

+ func (c *Client) StreamPlaylistItems(ctx context.Context, idOrURL string, opt PageOptions, ...) error

+ func (c *Client) Suggest(ctx context.Context, query string) ([]string, error)

+ func (c *Client) Transcript(ctx context.Context, idOrURL, lang string) (string, []TranscriptSegment, error)

+ func (c *Client) Trending(ctx context.Context, category string, opt PageOptions, emit func(Video) error) error

+ type Comment struct

+ AuthorChannelID string

+ AuthorDisplayName string

+ AuthorProfileImage string

+ FetchedAt time.Time

+ ID string

+ IsOwnerComment bool

+ LikeCount int64

+ ParentID string

+ PublishedAt time.Time

+ PublishedText string

+ ReplyCount int

+ TextDisplay string

+ UpdatedAt time.Time

+ VideoID string

+ func ParseCommentRenderer(m map[string]any, videoID, parentID string) *Comment

+ type CommentOptions struct

+ Max int

+ MaxPages int

+ Replies bool

+ Sort string

+ type CommunityPost struct

+ Attachments string

+ AuthorAvatar string

+ AuthorName string

+ ChannelID string

+ ContentText string

+ FetchedAt time.Time

+ LikeCount int64

+ PostID string

+ PublishedText string

+ ReplyCount int

+ VoteCount string

+ func ParseCommunityPost(m map[string]any, channelID string) *CommunityPost

+ type Config struct

+ Delay time.Duration

+ GL string

+ HL string

+ Retries int

+ Timeout time.Duration

+ Workers int

+ func DefaultConfig() Config

+ type CrawlOptions struct

+ Entity string

+ MaxPerItem int

+ Workers int

+ type DownloadArchive struct

+ func OpenArchive(path string) (*DownloadArchive, error)

+ func (a *DownloadArchive) Add(videoID string) error

+ func (a *DownloadArchive) Has(videoID string) bool

+ func (a *DownloadArchive) IDs() []string

+ type DownloadProgress struct

+ Downloaded int64

+ Total int64

+ type InnerTubeClient struct

+ func NewInnerTube(c *Client) *InnerTubeClient

+ func (it *InnerTubeClient) AndroidVRPlayer(ctx context.Context, videoID string) (map[string]any, error)

+ func (it *InnerTubeClient) Browse(ctx context.Context, browseID, params, continuation string) (map[string]any, error)

+ func (it *InnerTubeClient) BrowseContinuation(ctx context.Context, continuation string) (map[string]any, error)

+ func (it *InnerTubeClient) CommentContinuation(ctx context.Context, continuation string) (map[string]any, error)

+ func (it *InnerTubeClient) CommentContinuationWEB(ctx context.Context, continuation, visitor string) (map[string]any, error)

+ func (it *InnerTubeClient) Community(ctx context.Context, browseID, params, continuation string) (map[string]any, error)

+ func (it *InnerTubeClient) DiscoverCommunityTabParams(ctx context.Context, browseID string) (string, error)

+ func (it *InnerTubeClient) MusicBrowse(ctx context.Context, browseID, params, continuation string) (map[string]any, error)

+ func (it *InnerTubeClient) MusicPlayer(ctx context.Context, videoID string) (map[string]any, error)

+ func (it *InnerTubeClient) MusicSearch(ctx context.Context, query, params, continuation string) (map[string]any, error)

+ func (it *InnerTubeClient) Next(ctx context.Context, videoID, continuation string) (map[string]any, error)

+ func (it *InnerTubeClient) NextMWEB(ctx context.Context, videoID string) (map[string]any, error)

+ func (it *InnerTubeClient) Player(ctx context.Context, videoID string) (map[string]any, error)

+ func (it *InnerTubeClient) ResolveHashtag(ctx context.Context, hashtag string) (string, string, error)

+ func (it *InnerTubeClient) Search(ctx context.Context, query string, filters SearchFilters, continuation string) (map[string]any, error)

+ func (it *InnerTubeClient) Suggest(ctx context.Context, input string) ([]string, error)

+ type ItemSelector struct

+ func ParseItemSelector(spec string) (*ItemSelector, error)

+ func (s *ItemSelector) Selects(index, total int) bool

+ type JobRecord struct

+ CompletedAt time.Time

+ JobID string

+ Name string

+ StartedAt time.Time

+ Status string

+ Type string

+ type OutputFields struct

+ Author string

+ ChannelID string

+ Duration int

+ Ext string

+ ID string

+ PlaylistIndex int

+ PlaylistTitle string

+ Resolution string

+ Title string

+ type PageData struct

+ APIKey string

+ ClientVersion string

+ HTML string

+ InitialData any

+ PlayerResp any

+ VisitorData string

+ YTCFG map[string]any

+ type PageOptions struct

+ Enrich bool

+ Max int

+ MaxPages int

+ type Playlist struct

+ ChannelID string

+ ChannelName string

+ Description string

+ FetchedAt time.Time

+ LastUpdatedText string

+ PlaylistID string

+ Title string

+ URL string

+ VideoCount int

+ ViewCountText string

+ func ParseContinuationPlaylists(data map[string]any) ([]Playlist, string)

+ type PlaylistVideo struct

+ PlaylistID string

+ Position int

+ VideoID string

+ type QueueItem struct

+ EntityType string

+ ID int64

+ Priority int

+ Status string

+ URL string

+ type RelatedVideo struct

+ Position int

+ RelatedVideoID string

+ VideoID string

+ func ParseContinuationRelatedVideos(data map[string]any, videoID string) ([]RelatedVideo, string)

+ type SearchFilters struct

+ CC bool

+ CreativeCommon bool

+ Duration string

+ FourK bool

+ HD bool

+ HDR bool

+ Live bool

+ Sort string

+ ThreeSixty bool

+ Type string

+ UploadDate string

+ VR180 bool

+ func (f SearchFilters) Encode() string

+ func (f SearchFilters) IsEmpty() bool

+ type SearchResult struct

+ EntityType string

+ ID string

+ Title string

+ URL string

+ type Selection struct

+ Audio *Stream

+ Video *Stream

+ func SelectFormat(streams []Stream, spec string) (Selection, error)

+ func (s Selection) NeedsMerge() bool

+ func (s Selection) Streams() []Stream

+ type Song struct

+ AlbumID string

+ AlbumName string

+ ArtistID string

+ ArtistName string

+ DurationSeconds int

+ DurationText string

+ FetchedAt time.Time

+ IsExplicit bool

+ Lyrics string

+ PlaysText string

+ ThumbnailURL string

+ Title string

+ URL string

+ VideoID string

+ VideoType string

+ type SponsorSegment struct

+ Action string

+ Category string

+ End float64

+ Start float64

+ UUID string

+ type Store struct

+ func OpenStore(path string) (*Store, error)

+ func (s *Store) Close() error

+ func (s *Store) Enqueue(url, entity string, priority int) error

+ func (s *Store) ListJobs(limit int) ([]JobRecord, error)

+ func (s *Store) ListQueue(status string, limit int) ([]QueueItem, error)

+ func (s *Store) MarkStatus(id int64, status string) error

+ func (s *Store) NextPending() (*QueueItem, error)

+ func (s *Store) Path() string

+ func (s *Store) Query(sqlText string) ([]string, [][]any, error)

+ func (s *Store) RecordJob(j JobRecord) error

+ func (s *Store) Reset() error

+ func (s *Store) SearchChannels(q string, limit int) ([]Channel, error)

+ func (s *Store) SearchVideos(q string, limit int) ([]Video, error)

+ func (s *Store) Stats() (map[string]int64, error)

+ func (s *Store) UpsertCaptionTrack(ct CaptionTrack) error

+ func (s *Store) UpsertChannel(c Channel) error

+ func (s *Store) UpsertChapter(ch Chapter) error

+ func (s *Store) UpsertComment(c Comment) error

+ func (s *Store) UpsertCommunityPost(p CommunityPost) error

+ func (s *Store) UpsertPlaylist(p Playlist) error

+ func (s *Store) UpsertPlaylistVideo(pv PlaylistVideo) error

+ func (s *Store) UpsertRelatedVideo(rv RelatedVideo) error

+ func (s *Store) UpsertVideo(v Video) error

+ func (s *Store) UpsertVideoFormat(f VideoFormat) error

+ func (s *Store) Vacuum() error

+ type Stream struct

+ AudioChannels int

+ AudioCodec string

+ AudioQuality string

+ AudioSampleRate int

+ Bitrate int64

+ Container string

+ ContentLength int64

+ FPS int

+ HasAudio bool

+ HasVideo bool

+ Height int

+ ITag int

+ IsAdaptive bool

+ MimeType string

+ Quality string

+ QualityLabel string

+ VideoCodec string

+ Width int

+ func (s Stream) AudioOnly() bool

+ func (s Stream) Ext() string

+ func (s Stream) Muxed() bool

+ func (s Stream) VideoOnly() bool

+ type StreamManifest struct

+ Author string

+ DASHURL string

+ Duration int

+ HLSURL string

+ IsLive bool

+ Streams []Stream

+ Title string

+ VideoID string

+ type SubtitleFormat string

+ const SubSRT

+ const SubText

+ const SubVTT

+ type Thumbnail struct

+ Height int

+ Name string

+ URL string

+ Width int

+ func Thumbnails(videoID string) []Thumbnail

+ type TranscriptSegment struct

+ DurSeconds float64

+ StartSeconds float64

+ Text string

+ type Video struct

+ AgeRestricted bool

+ AllowRatings bool

+ AvailableCountries []string

+ Category string

+ ChannelID string

+ ChannelName string

+ CommentCount int64

+ Description string

+ DurationSeconds int

+ DurationText string

+ EmbedURL string

+ FetchedAt time.Time

+ Hashtags []string

+ IsFamilySafe bool

+ IsLive bool

+ IsShort bool

+ LikeCount int64

+ LocationDescription string

+ PublishedAt time.Time

+ PublishedText string

+ Tags []string

+ ThumbnailURL string

+ Title string

+ Transcript string

+ TranscriptLanguage string

+ URL string

+ UploadDate string

+ VideoID string

+ ViewCount int64

+ func ParseContinuationVideos(data map[string]any) ([]Video, string)

+ func ParsePlayerDetails(data map[string]any, videoID string) *Video

+ type VideoFormat struct

+ AudioQuality string

+ Bitrate int64

+ ContentLength int64

+ FPS int

+ Height int

+ ITag int

+ IsAdaptive bool

+ MimeType string

+ Quality string

+ QualityLabel string

+ VideoID string

+ Width int

+ func ParseVideoFormats(playerResp map[string]any, videoID string) []VideoFormat

+ type VideoOptions struct

+ Lang string

+ Next bool

+ Player bool

+ Transcript bool

+ type VideoResult struct

+ Captions []CaptionTrack

+ Chapters []Chapter

+ CommentToken string

+ Formats []VideoFormat

+ Related []RelatedVideo

+ Video Video

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL