Documentation
¶
Index ¶
- type Repos
- func (r *Repos) Find(c echo.Context) error
- func (r *Repos) GetChannel(c echo.Context) error
- func (r *Repos) GetPlaylist(c echo.Context) error
- func (r *Repos) GetPlaylistPopularByAllTime(c echo.Context) error
- func (r *Repos) GetPlaylistPopularByPastMonth(c echo.Context) error
- func (r *Repos) GetPlaylistPopularByPastYear(c echo.Context) error
- func (r *Repos) GetPlaylistRandom(c echo.Context) error
- func (r *Repos) GetTeam(c echo.Context) error
- func (r *Repos) GetTeamByYear(c echo.Context) error
- func (r *Repos) ListChannels(c echo.Context) error
- func (r *Repos) ListOfficers(c echo.Context) error
- func (r *Repos) ListTeams(c echo.Context) error
- func (r *Repos) ListVideos(c echo.Context) error
- func (r *Repos) Search(c echo.Context) error
- func (r *Repos) SeriesBreadcrumb(c echo.Context) error
- func (r *Repos) SeriesByID(c echo.Context) error
- func (r *Repos) SeriesByYear(c echo.Context) error
- func (r *Repos) Video(c echo.Context) error
- func (r *Repos) VideoBreadcrumb(c echo.Context) error
- type SearchInput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Repos ¶
type Repos struct {
// contains filtered or unexported fields
}
Repos encapsulates the dependency
func (*Repos) Find ¶
Find handles converting a url path to either a video or series
@Summary Converts a VOD url to either a series or video @Description Allows us to remain backwards compatible with the existing URLs @ID get-public-breadcrumb-find @Tags public-breadcrumb @Param url path string true "URL Path" @Produce json @Success 200 {object} public.BreadcrumbItem @Router /v1/public/find/{url} [get]
func (*Repos) GetChannel ¶ added in v0.8.0
GetChannel handles listing teams and their members and info
@Summary Provides a public or unlisted channel @ID get-public-stream-channel @Tags public-playout-channels @Param channelShortName path int true "Channel short name" @Produce json @Success 200 {object} public.Channel @Router /v1/public/playout/channel/{channelShortName} [get]
func (*Repos) GetPlaylist ¶ added in v0.7.0
GetPlaylist handles returning a playlist with a list of videos and metadata
@Summary Provides a playlist @Description Returns a playlist object, includes videos (not videofiles) and metadata. @ID get-public-playlist @Tags public-playlist @Param playlistid path int true "Playlist ID" @Produce json @Success 200 {object} public.Playlist @Router /v1/public/playlist/{seriesid} [get]
func (*Repos) GetPlaylistPopularByAllTime ¶ added in v0.7.0
GetPlaylistPopularByAllTime returns a fake playlist with a list of popular videos of all time
@Summary Provides a playlist of popular videos of all time @Description Provides a fake playlist, containing a list of popular videos @ID get-public-playlist-popular-by-all-time @Tags public-playlist @Produce json @Success 200 {object} public.Playlist @Router /v1/public/playlist/popular/all [get]
func (*Repos) GetPlaylistPopularByPastMonth ¶ added in v0.7.0
GetPlaylistPopularByPastMonth returns a fake playlist with a list of popular videos of past month
@Summary Provides a playlist of popular videos of past month @Description Provides a fake playlist, containing a list of popular videos @ID get-public-playlist-popular-by-past-month @Tags public-playlist @Produce json @Success 200 {object} public.Playlist @Router /v1/public/playlist/popular/month [get]
func (*Repos) GetPlaylistPopularByPastYear ¶ added in v0.7.0
GetPlaylistPopularByPastYear returns a fake playlist with a list of popular videos of past year
@Summary Provides a playlist of popular videos of past year @Description Provides a fake playlist, containing a list of popular videos @ID get-public-playlist-popular-by-past-year @Tags public-playlist @Produce json @Success 200 {object} public.Playlist @Router /v1/public/playlist/popular/year [get]
func (*Repos) GetPlaylistRandom ¶ added in v0.7.0
GetPlaylistRandom returns a fake playlist with a list of random videos
@Summary Provides a playlist of random videos @Description Provides a fake playlist, containing a list of random videos @ID get-public-playlist-random @Tags public-playlist @Produce json @Success 200 {object} public.Playlist @Router /v1/public/playlist/random [get]
func (*Repos) GetTeam ¶ added in v0.7.0
GetTeam handles getting a selected team
@Summary Provides the team of that year @Description Contains members and a range of descriptions @ID get-public-team @Tags public-teams @Param emailAlias path string true "emailAlias" @Produce json @Success 200 {object} public.Team @Router /v1/public/teams/{emailAlias} [get]
func (*Repos) GetTeamByYear ¶ added in v0.7.0
GetTeamByYear handles getting teams by calendar year
@Summary Provides the team of a selected year @Description Get the team and their members of that year @ID get-public-team-year @Tags public-teams @Param teamid path int true "teamid" @Param year path int true "year" @Produce json @Success 200 {object} public.Team @Router /v1/public/teams/{teamid}/{year} [get]
func (*Repos) ListChannels ¶ added in v0.7.0
ListChannels handles listing all channels
@Summary Provides the visible channels @Description Lists the publically visible channels @ID get-public-stream-channels @Tags public-playout-channels @Produce json @Success 200 {array} public.Channel @Router /v1/public/playout/channels [get]
func (*Repos) ListOfficers ¶ added in v0.7.0
ListOfficers handles listing the current officers
@Summary Provides the current officers @Description Lists the current officers, including their info @ID get-public-teams-officers-all @Tags public-teams @Produce json @Success 200 {array} public.TeamMember @Router /v1/public/teams/officers [get]
func (*Repos) ListTeams ¶
ListTeams handles listing teams and their members and info
@Summary Provides the current teams @Description Lists the teams, their members, and info @ID get-public-teams @Tags public-teams @Produce json @Success 200 {array} public.Team @Router /v1/public/teams [get]
func (*Repos) ListVideos ¶
ListVideos handles listing videos using an offset and page
@Summary Provides a list of videos @Description List of video meta's in order of broadcast date. @ID get-public-videos @Tags public-video @Param offset path int true "Offset" @Param page path int true "Page" @Produce json @Success 200 {array} public.VideoMeta @Router /v1/public/videos/{offset}/{page} [get]
func (*Repos) Search ¶ added in v0.7.0
Search returns a virtual series that contains relevant videos and series
@Summary Search the VOD library @Description Returns a virtual series that contains relevant videos and series @ID search-vod @Tags public-series @Param searchInput body SearchInput true "Search Input object" @Produce json @Success 200 {array} public.Series @Router /v1/public/search [post]
func (*Repos) SeriesBreadcrumb ¶
SeriesBreadcrumb returns the breadcrumb of a given series
@Summary Provides a breadcrumb for a series @Description Returns a path of series to a series @ID get-public-breadcrumb-series @Tags public-breadcrumb @Param seriesid path int true "Series ID" @Produce json @Success 200 {object} public.Breadcrumb @Router /v1/public/series/{seriesid}/breadcrumb [get]
func (*Repos) SeriesByID ¶
SeriesByID returns a series with it's immediate children with a SeriesID
@Summary Provides a series @Description Returns a series object, including the children videos and series. @ID get-public-series @Tags public-series @Param seriesid path int true "Series ID" @Produce json @Success 200 {object} public.Series @Router /v1/public/series/{seriesid} [get]
func (*Repos) SeriesByYear ¶ added in v0.7.0
SeriesByYear returns a virtual series containing series / videos made in that year
@Summary Series of a year @Description Returns a series array, virtual series that contains child series / videos @Description that were made in that year. @ID get-public-series-year @Tags public-series @Param year path int true "Year" @Produce json @Success 200 {array} public.Series @Router /v1/public/series/yearly/{year} [get]
func (*Repos) Video ¶
Video handles a video item, providing info vfiles
@Summary Provides a video item @Description Returns a video item. Including the video files. @ID get-public-video @Tags public-video @Param videoid path int true "Video ID" @Produce json @Success 200 {object} public.VideoItem @Router /v1/public/video/{videoid} [get]
func (*Repos) VideoBreadcrumb ¶
VideoBreadcrumb handles generating the breadcrumb of a video
@Summary Provides a breadcrumb for a video @Description Returns a path of series to a video @ID get-public-breadcrumb-video @Tags public-breadcrumb @Param videoid path int true "Video ID" @Produce json @Success 200 {object} public.Breadcrumb @Router /v1/public/video/{videoid}/breadcrumb [get]
type SearchInput ¶ added in v0.7.0
type SearchInput struct {
Query string `json:"query"`
}
Source Files