api

package

v1.11.0 Latest Latest Go to latest Published: Oct 17, 2026 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/TUM-Dev/gocast

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api is what is left of the v1 REST API. The SPA and every other first-party caller moved to apiv2 (Protobuf/Connect), and the shared code that used to live here (worker and voice gRPC, search, live state, section images) moved to pkg/. These routes remain because something that cannot speak apiv2 calls them:

POST /api/selfstream/onPublish: the mediamtx ingest server's authHTTPAddress webhook (ingest/mediamtx.yml), asked to approve every RTMP publish.
POST /api/token/proxy/:token: rtmp-proxy/publish.sh, which swaps a lecturer's token for the stream key of their next stream.
GET /api/stream/live: API users authenticating with an admin token (scripts, monitoring); the token middleware is not part of apiv2.
GET /api/schedule.ics: calendar clients subscribed to the lecture hall feed by URL.

The old course calendar URL (/api/download_ics/...) is still answered, but by apiv2: see RegisterLegacyCalendar, wired in cmd/tumlive.

Do not add routes here: new API work belongs in apiv2.

Index ¶

func ConfigGinRouter(router *gin.Engine, manager *runner_manager.Manager)
type OnStartReq
type SafeStreamStructStream

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ConfigGinRouter ¶

func ConfigGinRouter(
	router *gin.Engine,
	manager *runner_manager.Manager,
)

ConfigGinRouter registers the remaining v1 routes.

Types ¶

type OnStartReq ¶ added in v1.5.7

type OnStartReq struct {
	Ip       string `json:"ip"`
	User     string `json:"user"`
	Password string `json:"password"`
	Path     string `json:"path"`
	Protocol string `json:"protocol"`
	Id       string `json:"id"`
	Action   string `json:"action"`
	Query    string `json:"query"`
}

type SafeStreamStructStream ¶ added in v1.5.7

type SafeStreamStructStream struct {
	Ip        string
	StreamKey string
	Slug      string
	Retries   int
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL