public

package
v0.9.8 Latest Latest
Warning

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

 Go to latest Published: May 18, 2025 License: GPL-3.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types 

type BreadcrumbRepo interface {
	Find(c echo.Context) error
	VideoBreadcrumb(c echo.Context) error
	GetSeriesBreadcrumb(c echo.Context) error
}

Repos encapsulates the dependency

type CustomSettingRepo added in v0.9.8 

type CustomSettingRepo interface {
	GetCustomSettingPublic(c echo.Context) error
}

Repos encapsulates the dependency

type PlaylistRepo added in v0.9.6 

type PlaylistRepo interface {
	GetPlaylist(c echo.Context) error
	GetPlaylistPopularByAllTime(c echo.Context) error
	GetPlaylistPopularByPastYear(c echo.Context) error
	GetPlaylistPopularByPastMonth(c echo.Context) error
	GetPlaylistRandom(c echo.Context) error
}

Repos encapsulates the dependency

type Repos 

type Repos interface {
	BreadcrumbRepo
	PlaylistRepo
	SeriesRepo
	StreamRepo
	TeamRepo
	VideoRepo
	CustomSettingRepo
}

Repos encapsulates the dependency

func NewRepos 

func NewRepos(db *sqlx.DB, cdnEndpoint string) Repos

NewRepos creates our data store

type SearchInput added in v0.7.0 

type SearchInput struct {
	Query string `json:"query"`
}

type SeriesRepo added in v0.9.6 

type SeriesRepo interface {
	GetSeriesByID(c echo.Context) error
	GetSeriesByYear(c echo.Context) error
	Search(c echo.Context) error
}

Repos encapsulates the dependency

type Store added in v0.9.6 

type Store struct {
	// contains filtered or unexported fields
}

Repos encapsulates the dependency

func (*Store) Find added in v0.9.6 

func (s *Store) Find(c echo.Context) error

Find handles converting an 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 (*Store) GetChannel added in v0.9.6 

func (s *Store) GetChannel(c echo.Context) error

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 (*Store) GetCustomSettingPublic added in v0.9.8 

func (s *Store) GetCustomSettingPublic(c echo.Context) error

GetCustomSettingPublic handles getting a single setting value that is public

@Summary Provides a single public setting @Description Contains a single setting value in string format @ID get-public-custom-setting @Tags public-custom-settings @Param settingid path string true "Setting id" @Produce json @Success 200 {object} public.CustomSetting @Router /v1/public/custom-setting/{settingid} [get]

func (*Store) GetPlaylist added in v0.9.6 

func (s *Store) GetPlaylist(c echo.Context) error

GetPlaylist handles returning a playlist with a list of videos and metadata

@Summary Provides a playlist @Description Returns a playlist object, includes videos (not video files) 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 (*Store) GetPlaylistPopularByAllTime added in v0.9.6 

func (s *Store) GetPlaylistPopularByAllTime(c echo.Context) error

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 (*Store) GetPlaylistPopularByPastMonth added in v0.9.6 

func (s *Store) GetPlaylistPopularByPastMonth(c echo.Context) error

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 (*Store) GetPlaylistPopularByPastYear added in v0.9.6 

func (s *Store) GetPlaylistPopularByPastYear(c echo.Context) error

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 (*Store) GetPlaylistRandom added in v0.9.6 

func (s *Store) GetPlaylistRandom(c echo.Context) error

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 (*Store) GetSeriesBreadcrumb added in v0.9.6 

func (s *Store) GetSeriesBreadcrumb(c echo.Context) error

GetSeriesBreadcrumb 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 (*Store) GetSeriesByID added in v0.9.6 

func (s *Store) GetSeriesByID(c echo.Context) error

GetSeriesByID returns a series with its 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 (*Store) GetSeriesByYear added in v0.9.6 

func (s *Store) GetSeriesByYear(c echo.Context) error

GetSeriesByYear 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 (*Store) GetTeamByEmail added in v0.9.6 

func (s *Store) GetTeamByEmail(c echo.Context) error

GetTeamByEmail handles getting a selected team

@Summary Provides the team of that year from email alias @Description Contains members and a range of descriptions @ID get-public-team-by-email @Tags public-teams @Param emailAlias path string true "emailAlias" @Produce json @Success 200 {object} public.Team @Router /v1/public/teams/email/{emailAlias} [get]

func (*Store) GetTeamByID added in v0.9.6 

func (s *Store) GetTeamByID(c echo.Context) error

GetTeamByID handles getting a selected team

@Summary Provides the team of that year from id @Description Contains members and a range of descriptions @ID get-public-team-by-id @Tags public-teams @Param teamid path int true "teamid" @Produce json @Success 200 {object} public.Team @Router /v1/public/teams/teamid/{teamid} [get]

func (*Store) GetTeamByStartEndYearByEmail added in v0.9.6 

func (s *Store) GetTeamByStartEndYearByEmail(c echo.Context) error

GetTeamByStartEndYearByEmail handles getting teams by educational year

@Summary Provides the team of a selected year @Description Get the team and their members of that year @ID get-public-team-start-end-year-by-email @Tags public-teams @Param emailAlias path string true "emailAlias" @Param startYear path int true "startYear" @Param endYear path int true "endYear" @Produce json @Success 200 {object} public.Team @Router /v1/public/teams/email/{emailAlias}/{startYear}/{endYear} [get]

func (*Store) GetTeamByStartEndYearByID added in v0.9.6 

func (s *Store) GetTeamByStartEndYearByID(c echo.Context) error

GetTeamByStartEndYearByID handles getting teams by educational year

@Summary Provides the team of a selected year @Description Get the team and their members of that year @ID get-public-team-start-end-year-by-id @Tags public-teams @Param teamid path int true "teamid" @Param startYear path int true "startYear" @Param endYear path int true "endYear" @Produce json @Success 200 {object} public.Team @Router /v1/public/teams/teamid/{teamid}/{startYear}/{endYear} [get]

func (*Store) GetTeamByYearByEmail added in v0.9.6 

func (s *Store) GetTeamByYearByEmail(c echo.Context) error

GetTeamByYearByEmail 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-by-email @Tags public-teams @Param emailAlias path string true "emailAlias" @Param year path int true "year" @Produce json @Success 200 {object} public.Team @Router /v1/public/teams/email/{emailAlias}/{year} [get]

func (*Store) GetTeamByYearByID added in v0.9.6 

func (s *Store) GetTeamByYearByID(c echo.Context) error

GetTeamByYearByID 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-by-id @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/{teamid}/{year} [get]

func (*Store) GetVideo added in v0.9.6 

func (s *Store) GetVideo(c echo.Context) error

GetVideo handles a video item, providing info

@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 (*Store) ListChannels added in v0.9.6 

func (s *Store) ListChannels(c echo.Context) error

ListChannels handles listing all channels

@Summary Provides the visible channels @Description Lists the publicly 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 (*Store) ListOfficers added in v0.9.6 

func (s *Store) ListOfficers(c echo.Context) error

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 (*Store) ListTeams added in v0.9.6 

func (s *Store) ListTeams(c echo.Context) error

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 (*Store) ListVideos added in v0.9.6 

func (s *Store) ListVideos(c echo.Context) error

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 (*Store) Search added in v0.9.6 

func (s *Store) Search(c echo.Context) error

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 (*Store) VideoBreadcrumb added in v0.9.6 

func (s *Store) VideoBreadcrumb(c echo.Context) error

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 StreamRepo added in v0.9.6 

type StreamRepo interface {
	ListChannels(c echo.Context) error
	GetChannel(c echo.Context) error
}

Repos encapsulates the dependency

type TeamRepo added in v0.9.6 

type TeamRepo interface {
	ListTeams(c echo.Context) error
	GetTeamByEmail(c echo.Context) error
	GetTeamByID(c echo.Context) error
	GetTeamByYearByEmail(c echo.Context) error
	GetTeamByYearByID(c echo.Context) error
	GetTeamByStartEndYearByEmail(c echo.Context) error
	GetTeamByStartEndYearByID(c echo.Context) error
	ListOfficers(c echo.Context) error
}

Repos encapsulates the dependency

type VideoRepo added in v0.9.6 

type VideoRepo interface {
	GetVideo(c echo.Context) error
	ListVideos(c echo.Context) error
}

Repos encapsulates the dependency

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.