api

Documentation

Index

• Constants
• Variables
• func BroadcastStats(streamsDao dao.StreamsDao)
• func CollectStats(daoWrapper dao.DaoWrapper) func()
• func ConfigChatRouter(router *gin.RouterGroup)
• func ConfigGinRouter(router *gin.Engine)
• func ConfigRealtimeRouter(router *gin.RouterGroup)
• func CreateStreamRequest(daoWrapper dao.DaoWrapper, stream model.Stream, course model.Course, ...)
• func DeleteVideoSectionImage(workerDao dao.WorkerDao, path string) error
• func FetchLivePreviews(daoWrapper dao.DaoWrapper) func()
• func GenerateVideoSectionImages(daoWrapper dao.DaoWrapper, parameters *generateVideoSectionImagesParameters) error
• func NotifyLiveUpdateCourseWentLive(courseId uint)
• func NotifyViewersLiveState(streamId uint, live bool)
• func NotifyWorkers(daoWrapper dao.DaoWrapper) func()
• func NotifyWorkersToStopStream(stream model.Stream, discardVoD bool, daoWrapper dao.DaoWrapper)
• func RegenerateThumbs(daoWrapper dao.DaoWrapper, file model.File, stream *model.Stream, ...) error
• func RegisterLiveUpdateRealtimeChannel()
• func RegisterRealtimeChatChannel()
• func ServeWorkerGRPC()
• type AddBookmarkRequest
  • func (r AddBookmarkRequest) ToBookmark(userID uint) model.Bookmark
• type CalendarEntry
• type GetBookmarksQuery
• type MailTmpl
• type SubtitleGeneratorClient
  • func GetSubtitleGeneratorClient() (SubtitleGeneratorClient, error)
  • func (s SubtitleGeneratorClient) CloseConn()
• type UpdateBookmarkRequest
  • func (r UpdateBookmarkRequest) ToBookmark(id uint) model.Bookmark
• type UpdateVideoSectionRequest

Constants

const (
	POLL_START_MSG         = "start_poll"
	POLL_CLOSE_MSG         = "close_active_poll"
	POLL_PARTICIPATION_MSG = "submit_poll_option_vote"
)

const (
	WorkerHTTPPort = "8060"
	CutOffLength   = 256
)

const (
	LiveUpdateRoomName       = "live-update"
	UpdateTypeCourseWentLive = "course_went_live"
)

const (
	TypeServerInfo = "info"
	TypeServerWarn = "warn"
	TypeServerErr  = "error"
)

const (
	ChatRoomName = "chat/:streamID"
)

const (
	MAX_FILE_SIZE = 1000 * 1000 * 50 // 50 MB
)

Variables

var RealtimeInstance = realtime.New(connector.NewMelodyConnector())

Functions

func BroadcastStats

func BroadcastStats(streamsDao dao.StreamsDao)

func CollectStats

func CollectStats(daoWrapper dao.DaoWrapper) func()

func ConfigChatRouter

func ConfigChatRouter(router *gin.RouterGroup)

ConfigChatRouter configure gin router for chat (without gzip)

func ConfigGinRouter

func ConfigGinRouter(router *gin.Engine)

ConfigGinRouter for non ws endpoints

func ConfigRealtimeRouter

func ConfigRealtimeRouter(router *gin.RouterGroup)

ConfigRealtimeRouter configure gin router for live-updates (without gzip)

func CreateStreamRequest

func CreateStreamRequest(daoWrapper dao.DaoWrapper, stream model.Stream, course model.Course, workers []model.Worker, sourceType string, source string)

func DeleteVideoSectionImage

func DeleteVideoSectionImage(workerDao dao.WorkerDao, path string) error

func FetchLivePreviews

func FetchLivePreviews(daoWrapper dao.DaoWrapper) func()

FetchLivePreviews gets a live thumbnail from a worker.

func GenerateVideoSectionImages

func GenerateVideoSectionImages(daoWrapper dao.DaoWrapper, parameters *generateVideoSectionImagesParameters) error

func NotifyLiveUpdateCourseWentLive

func NotifyLiveUpdateCourseWentLive(courseId uint)

func NotifyViewersLiveState

func NotifyViewersLiveState(streamId uint, live bool)

func NotifyWorkers

func NotifyWorkers(daoWrapper dao.DaoWrapper) func()

NotifyWorkers collects all streams that are due to stream (starts in the next 10 minutes from a lecture hall) and invokes the corresponding calls at the workers with the least workload via gRPC

func NotifyWorkersToStopStream

func NotifyWorkersToStopStream(stream model.Stream, discardVoD bool, daoWrapper dao.DaoWrapper)

NotifyWorkersToStopStream notifies all workers for a given stream to quit encoding

func RegenerateThumbs

func RegenerateThumbs(daoWrapper dao.DaoWrapper, file model.File, stream *model.Stream, course *model.Course) error

RegenerateThumbs regenerates the thumbnails for the timeline. This is useful for video with faulty thumbnails and for VoDs that were created before the thumbnail feature.

func RegisterLiveUpdateRealtimeChannel

func RegisterLiveUpdateRealtimeChannel()

func RegisterRealtimeChatChannel

func RegisterRealtimeChatChannel()

func ServeWorkerGRPC

func ServeWorkerGRPC()

ServeWorkerGRPC initializes a gRPC server on port 50052

Types

type AddBookmarkRequest

type AddBookmarkRequest struct {
	StreamID    uint   `json:"streamID"`
	Description string `json:"description"`
	Hours       uint   `json:"hours"`
	Minutes     uint   `json:"minutes"`
	Seconds     uint   `json:"seconds"`
}

func (AddBookmarkRequest) ToBookmark

func (r AddBookmarkRequest) ToBookmark(userID uint) model.Bookmark

type CalendarEntry

type CalendarEntry struct {
	CreatedAt   string
	Start       string
	End         string
	ID          string
	Url         string
	Location    string
	Summary     string
	Description string
}

type GetBookmarksQuery

type GetBookmarksQuery struct {
	StreamID uint `form:"streamID" binding:"required"`
}

type MailTmpl

type MailTmpl struct {
	Name   string
	OptIn  bool
	Course model.Course
	Users  []*model.User
}

type SubtitleGeneratorClient

type SubtitleGeneratorClient struct {
	pb.SubtitleGeneratorClient
	*grpc.ClientConn
}

func GetSubtitleGeneratorClient

func GetSubtitleGeneratorClient() (SubtitleGeneratorClient, error)

func (SubtitleGeneratorClient) CloseConn

func (s SubtitleGeneratorClient) CloseConn()

type UpdateBookmarkRequest

type UpdateBookmarkRequest struct {
	Description string `json:"description"`
	Hours       uint   `json:"hours"`
	Minutes     uint   `json:"minutes"`
	Seconds     uint   `json:"seconds"`
}

func (UpdateBookmarkRequest) ToBookmark

func (r UpdateBookmarkRequest) ToBookmark(id uint) model.Bookmark

type UpdateVideoSectionRequest

type UpdateVideoSectionRequest struct {
	Description  string `json:"description"`
	StartHours   uint   `json:"startHours"`
	StartMinutes uint   `json:"startMinutes"`
	StartSeconds uint   `json:"startSeconds"`
}