Documentation
¶
Overview ¶
Package provider provides interfaces and types for metadata providers that fetch information about movies and TV shows.
Index ¶
- Variables
- func NewResponseBaseMovie() *responseBaseMovie
- func NewResponseBaseTV() *responseBaseTV
- func NewResponseBaseTVEpisode() *responseBaseTVEpisode
- func NewResponseBaseTVSeason() *responseBaseTVSeason
- type Interface
- type MediaType
- type NewFunc
- type Provider
- type ProviderFunc
- type Request
- type Response
- type ResponseBase
- type ResponseBaseMovie
- type ResponseBaseTV
- type ResponseBaseTVEpisode
- type ResponseBaseTVSeason
- type ResponseMovie
- type ResponseTV
- type ResponseTVEpisode
- type ResponseTVSeason
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrNoResults is returned when no results are found. ErrNoResult = fmt.Errorf("no result found") )
Functions ¶
func NewResponseBaseMovie ¶
func NewResponseBaseMovie() *responseBaseMovie
func NewResponseBaseTV ¶
func NewResponseBaseTV() *responseBaseTV
func NewResponseBaseTVEpisode ¶
func NewResponseBaseTVEpisode() *responseBaseTVEpisode
func NewResponseBaseTVSeason ¶
func NewResponseBaseTVSeason() *responseBaseTVSeason
Types ¶
type Interface ¶
type Interface interface {
Name() string
SearchMovie(Request) (ResponseMovie, float64, error)
SearchTV(Request) (ResponseTV, float64, error)
}
Interface is the interface that all providers must implement.
type MediaType ¶
type MediaType int
MediaType represents the type of media (movie, tv, person, etc).
type ProviderFunc ¶
type ProviderFunc func() Provider
ProviderFunc is a function that returns a Provider.
type Request ¶
type Request struct {
Query string
Year int
QueryLanguage string
DestinationLanguage string
Info parser.Info
Entry fs.DirEntry
Response Response
}
Request represents a search request to a provider.
type Response ¶
type Response interface {
// Commont methods for all media types.
GetID() int
GetName() string
GetDate() time.Time
GetPopularity() int
InLanguage(Request) (Response, error)
ResponseBase
}
Response represents a search response from a provider.
type ResponseBase ¶
type ResponseBaseMovie ¶
type ResponseBaseMovie interface {
ResponseBase
// contains filtered or unexported methods
}
type ResponseBaseTV ¶
type ResponseBaseTV interface {
ResponseBase
// contains filtered or unexported methods
}
type ResponseBaseTVEpisode ¶
type ResponseBaseTVEpisode interface {
ResponseBase
// contains filtered or unexported methods
}
type ResponseBaseTVSeason ¶
type ResponseBaseTVSeason interface {
ResponseBase
// contains filtered or unexported methods
}
type ResponseMovie ¶
type ResponseMovie interface {
Response
ResponseBaseMovie
}
type ResponseTV ¶
type ResponseTV interface {
Response
GetSeason(int) (ResponseTVSeason, error)
GetSeasons() []ResponseTVSeason
ResponseBaseTV
}
type ResponseTVEpisode ¶
type ResponseTVEpisode interface {
Response
GetEpisodeNumber() int
GetSeason() ResponseTVSeason
ResponseBaseTVEpisode
}
type ResponseTVSeason ¶
type ResponseTVSeason interface {
Response
GetShow() ResponseTV
GetSeasonNumber() int
GetEpisode(int) (ResponseTVEpisode, error)
GetEpisodes() []ResponseTVEpisode
ResponseBaseTVSeason
}
Click to show internal directories.
Click to hide internal directories.