yt

type BrowseQuery ¶

type BrowseQuery struct {
	BrowseID string       `json:"browseId"`
	Context  QueryContext `json:"context"`
	Param    Param        `json:"params,omitempty"`
}

BrowseQuery is the data sent to the YouTube browse endpoint (https://www.youtube.com/youtubei/v1/browse) after being JSON-encoded.

type Caption ¶

type Caption struct {
	Name         string
	LanguageCode string
	BaseURL      string
}

type Channel ¶

type Channel struct {
	SimpleChannel

	Links        map[string]string
	Banner       []Thumbnail
	TVBanner     []Thumbnail
	MobileBanner []Thumbnail

	TotalVideos int
	Videos      []SimpleVideo

	IsFamilySafe       bool
	AvailableCountries []string
}

Channel is a representation of the more complete data for a channel retrieved from the channel page on YouTube.

func GetChannel(id string) (Channel, error)

type ClientContext ¶

type ClientContext struct {
	ClientName    string `json:"clientName"`
	ClientVersion string `json:"clientVersion"`
	SDKVersion    int    `json:"androidSdkVersion,omitempty"`
	Language      string `json:"hl,omitempty"`
}

ClientContext is a struct for wrapping client information for video queries.

type ContentPlaybackContext ¶

type ContentPlaybackContext struct {
	SignatureTimestamp int `json:"signatureTimestamp"`
}

type DecipherFunctionData ¶

type DecipherFunctionData struct {
	DecipherFunction string `json:"function"`
	DecipherObject   string `json:"object"`
}

DecipherFunctionData is the data necessary for deciphering a "signature cipher" for a video and is the format for the data is cached.

type MusicParam ¶

type MusicParam Param

SearchParam and MusicParam specify search type for YouTube and YouTube Music, respectively.

const (
	MusicParamSongs              MusicParam = "EgWKAQIIAWoMEAMQBBAOEAoQCRAF"
	MusicParamVideos             MusicParam = "EgWKAQIQAWoMEAMQBBAOEAoQCRAF"
	MusicParamAlbums             MusicParam = "EgWKAQIYAWoMEAMQBBAOEAoQCRAF"
	MusicParamArtists            MusicParam = "EgWKAQIgAWoMEAMQBBAOEAoQCRAF"
	MusicParamFeaturedPlaylists  MusicParam = "EgeKAQQoADgBagwQAxAEEA4QChAJEAU="
	MusicParamCommunityPlaylists MusicParam = "EgeKAQQoAEABagwQAxAEEA4QChAJEAU="
)

type MusicSearchResults ¶

type MusicSearchResults struct {
	Songs              *[]SimpleVideo
	Videos             *[]SimpleVideo
	Albums             *[]SimpleAlbumPlaylist
	Artists            *[]SimpleArtistChannel
	FeaturedPlaylists  *[]SimplePlaylist
	CommunityPlaylists *[]SimplePlaylist
}

MusicSearchResults is a representation of search results returned from YouTube Music search.

func GetMusicSearchResults(query string, param MusicParam, lang string) (MusicSearchResults, error)

type Param ¶

type Param string

Param is a representation of the parameters supplied for specifying search types.

type PlaybackContext ¶

type PlaybackContext struct {
	ContentPlaybackContext ContentPlaybackContext `json:"contentPlaybackContext"`
}

type Playlist ¶

type Playlist struct {
	SimplePlaylist

	Views          int
	Description    string
	LastUpdateDate time.Time

	Videos []SimpleVideo
}

Playlist is a representation of the more complete data for a playlist retrieved from the playlist page on YouTube.

func GetPlaylist(id string) (Playlist, error)

type QueryContext ¶

type QueryContext struct {
	Client ClientContext `json:"client"`
}

QueryContext is a struct for wrapping the ClientContext struct for video queries.

type SearchParam ¶

type SearchParam Param

SearchParam and MusicParam specify search type for YouTube and YouTube Music, respectively.

const (
	SearchParamVideo    SearchParam = "EgIQAQ=="
	SearchParamChannel  SearchParam = "EgIQAg=="
	SearchParamPlaylist SearchParam = "EgIQAw=="
	SearchParamMovie    SearchParam = "EgIQBA=="
)

type SearchQuery ¶

type SearchQuery struct {
	Context QueryContext `json:"context"`
	Query   string       `json:"query"`
	Param   Param        `json:"params"`
}

SearchQuery is the data sent to the YouTube search endpoint (https://www.youtube.com/youtubei/v1/search) after being JSON-encoded.

type SearchResults ¶

type SearchResults struct {
	Videos    *[]SimpleVideoSearchResult
	Playlists *[]SimplePlaylist
	Channels  *[]SimpleChannel
}

SearchResults is a representation of search results returned from YouTube search.

func GetSearchResults(query string, param SearchParam, lang string) (SearchResults, error)

type SimpleAlbumPlaylist ¶

type SimpleAlbumPlaylist struct {
	ID    string
	Title string

	IsExplicit  bool
	ReleaseYear int
	AlbumType   string

	ArtistChannelID   string
	ArtistChannelName string

	Thumbnails []Thumbnail
}

SimpleAlbumPlaylist is a representation of the data retrieved from search results for an album on YouTube Music.

type SimpleArtistChannel ¶

type SimpleArtistChannel struct {
	ID          string
	Name        string
	Subscribers int

	Thumbnails []Thumbnail
}

SimpleArtistChannel is a representation of the data retrieved from search results for an artist on YouTube Music.

type SimpleChannel ¶

type SimpleChannel struct {
	ID       string
	Name     string
	Username string

	Avatars []Thumbnail

	ShortDescription string
	Subscribers      int
	IsVerified       bool
}

SimpleArtistChannel is a representation of data retrieved from search results for an artist on YouTube Music.

type SimplePlaylist ¶

type SimplePlaylist struct {
	ID          string
	Title       string
	VideoNumber int

	CreatorChannelID   string
	CreatorChannelName string

	Thumbnails []Thumbnail
}

SimplePlaylist is a representation of the data retrieved from search results for a playlist on YouTube.

type SimpleVideo ¶

type SimpleVideo struct {
	ID       string
	Title    string
	Duration time.Duration

	ChannelID   string
	ChannelName string

	Thumbnails []Thumbnail
}

SimpleVideo is a representation of the simplified data retrieved for videos on YouTube on channel pages and some search results.

func GetFrontPageVideos() ([]SimpleVideo, error)

func GetTrendingVideos() ([]SimpleVideo, error)

type SimpleVideoSearchResult ¶

type SimpleVideoSearchResult struct {
	SimpleVideo

	ShortDescription    string
	RelativePublishDate string
	Views               int
}

SimpleVideoSearchResult is a representation of the data retrieved from search results for a video on YouTube.

type StreamFormat ¶

type StreamFormat struct {
	ITag     int
	URL      string
	MimeType string
	Bitrate  int
}

StreamFormat is a representation of the data present for a stream format for a YouTube video.

type StreamingFormats ¶

type StreamingFormats struct {
	StaticFormats   []StreamFormat
	AdaptiveFormats []StreamFormat
}

StreamingFormats is a representation of the data present for streaming formats for a YouTube video.

type ThirdPartyEmbed ¶

type ThirdPartyEmbed struct {
	EmbedURL string `json:"embedUrl"`
}

ThirdPartyEmbed is a struct for wrapping the embed URL for video queries.

type Thumbnail ¶

type Thumbnail struct {
	URL    string
	Width  int
	Height int
}

Thumbnail is a representation of the data present for thumbnails.

type Video ¶

type Video struct {
	SimpleVideo

	Views       int
	UploadDate  time.Time
	PublishDate time.Time

	Description string
	Tags        []string
	Category    string

	AvailableCountries []string
	RatingsAllowed     bool
	IsCrawlable        bool
	IsLive             bool
	IsPrivate          bool
	IsRestricted       bool
	IsUnlisted         bool

	StreamingData StreamingFormats
	CaptionData   []Caption
}

Video is a representation of the more complete data for a video retrieved from the video page on YouTube.

func GetVideo(id string) (Video, error)

type VideoQuery ¶

type VideoQuery struct {
	VideoID         string          `json:"videoId"`
	Context         QueryContext    `json:"context"`
	ThirdParty      ThirdPartyEmbed `json:"thirdParty,omitempty"`
	PlaybackContext PlaybackContext `json:"playbackContext,omitempty"`
}

VideoQuery is the data sent to the YouTube player endpoint (https://www.youtube.com/youtubei/v1/player) after being JSON-encoded.