web

Documentation

Overview

Package web provides the HTTP server and WebSocket endpoint for remote control.

Index

• type Server
  • func NewServer(addr string, handler *events.Handler, ustreamerAddr string, videoDevice string) *Server
  • func (s *Server) Run(ctx context.Context) error
  • func (s *Server) Start() error
• type VideoSettings
  • func DefaultVideoSettings() VideoSettings

Types

type Server

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

Server represents the HTTP server with WebSocket support

func NewServer

func NewServer(
	addr string,
	handler *events.Handler,
	ustreamerAddr string,
	videoDevice string,
) *Server

NewServer creates a new web server

func (*Server) Run

func (s *Server) Run(ctx context.Context) error

Run starts the server with graceful shutdown support

func (*Server) Start

func (s *Server) Start() error

Start starts the HTTP server

type VideoSettings

type VideoSettings struct {
	Quality    int `json:"quality"`
	DesiredFPS int `json:"desiredFps"`
}

VideoSettings holds configurable ustreamer parameters

func DefaultVideoSettings

func DefaultVideoSettings() VideoSettings

DefaultVideoSettings returns the default video settings