api

Aug 17, 2026

Changes in this version

+ type GB28181ByeSender interface

+ ByeChannelByID func(channelID string) error

+ type GB28181CascadeStatus interface

+ ForwardCount func() int

+ Online func() bool

+ RegistrationSince func() (time.Duration, bool)

+ type GB28181DeviceMedia interface

+ GB28181Alarms func(deviceID string) []event.GB28181AlarmEvent

+ GB28181Positions func(deviceID string) []gb28181.GBPosition

+ PlaybackControl func(channelID, action string, scale, position float64) error

+ PlaybackStatusFor func(channelID string) (gb28181.PlaybackInfo, bool)

+ QueryChannelRecords func(deviceID, channelID string, start, end time.Time) ([]manscdp.RecordItem, error)

+ StartPlayback func(deviceID, channelID string, start, end time.Time) error

+ StartTalk func(cameraID, deviceID, channelID string) error

+ StopPlayback func(channelID string) error

+ StopTalk func(channelID string) error

+ TalkStatusFor func(cameraID string) gb28181.TalkStatus

+ WriteTalkAudio func(channelID string, alaw []byte)

+ type GB28181InviteSender interface

+ InviteChannel func(deviceID, channelID string) error

type Handler

+ func (h *Handler) SetAPIKeyStore(s *middleware.APIKeyStore)

+ func (h *Handler) SetGB28181ByeSender(s GB28181ByeSender)

+ func (h *Handler) SetGB28181Cascade(s GB28181CascadeStatus)

+ func (h *Handler) SetGB28181Catalog(c *gb28181.CatalogController)

+ func (h *Handler) SetGB28181DeviceMedia(s GB28181DeviceMedia)

+ func (h *Handler) SetGB28181Inviter(s GB28181InviteSender)

+ func (h *Handler) SetGB28181PTZ(ptz *gb28181.PTZController)

+ func (h *Handler) SetGB28181Timezone(loc *time.Location)

+ func (h *Handler) SetVisionCoordinator(mgr *vision.Coordinator)

type HealthResponse

+ DeviceID string

+ DeviceName string

Aug 8, 2026

Changes in this version

+ var SupportedTimelapseMergeDurations = []string

+ func SetUpdateChecker(c *update.Checker)

type Handler

+ func (h *Handler) Close()

Jul 18, 2026

Changes in this version

+ func WriteError(w http.ResponseWriter, status int, msg string)

type Handler

+ func (h *Handler) SetRollingMergeMgr(mgr *merge.RollingMergeCoordinator)

Jun 30, 2026

Changes in this version

+ func SetAPIMetrics(m *metrics.Metrics)

type Handler

+ func (h *Handler) SetRelayManager(mgr *relay.Manager)

Jun 15, 2026

Changes in this version

+ type AIHandler struct

+ func NewAIHandler(mgr *ai.Manager, cfg *config.Config, configPath string) *AIHandler

type Handler

+ func (h *Handler) SetAIHandler(ah *AIHandler)

+ type MJPEGStreamHandler struct

+ func (h *MJPEGStreamHandler) CanHandle(codec model.Format) bool

+ func (h *MJPEGStreamHandler) Name() string

+ func (h *MJPEGStreamHandler) StartStream(camID string, rec model.Recorder, opts StreamStartOptions) error

+ func (h *MJPEGStreamHandler) StopStream(camID string) error

Jun 14, 2026

Changes in this version

type Handler

+ func (h *Handler) SetTimelapseDailyMgr(mgr *timelapse.DailyMergeManager)

+ func (h *Handler) SetTimelapseMergeMgr(mgr *timelapse.RollingMergeManager)

Jun 5, 2026

Changes in this version

+ type AIDetector interface

+ DisableCamera func(camID string)

+ EnableCamera func(camID string, hub *model.StreamHub) error

+ EnabledCameras func() []string

+ IsEnabled func(camID string) bool

+ OnDetection func(cb engine.OnDetectionFunc) string

+ StopAll func()

+ UnregisterCallback func(id string) bool

+ type AIEngine interface

+ IsAvailable func() bool

+ ModelPath func() string

+ Name func() string

type Handler

+ func (h *Handler) HandleTelemetry(w http.ResponseWriter, r *http.Request)

+ func (h *Handler) SetAIComponents(eng AIEngine, det AIDetector)

+ func (h *Handler) SetEventBus(bus *event.EventBus)

+ func (h *Handler) SetWSManager(mgr *wsstream.Manager)

+ type WSStreamHandler struct

+ func (h *WSStreamHandler) CanHandle(codec model.Format) bool

+ func (h *WSStreamHandler) Name() string

+ func (h *WSStreamHandler) StartStream(camID string, rec model.Recorder, opts StreamStartOptions) error

+ func (h *WSStreamHandler) StopStream(camID string) error

May 30, 2026

Changes in this version

type Handler

+ func (h *Handler) SetDownloader(d TranscodeDownloader)

+ func (h *Handler) SetTranscodeManager(mgr TranscodeManagerAPI)

+ type TranscodeDownloader interface

+ DownloadFFmpeg func(ctx context.Context) error

+ FFmpegPath func() string

+ GetFFmpegStatus func() transcoding.DownloadStatus

+ type TranscodeManagerAPI interface

+ GetStatus func() transcoding.ManagerStatus

+ Queue func() transcoding.QueueAPI

May 25, 2026

Changes in this version

+ type CameraHealthDetail struct

+ ID string

+ Name string

+ Score int

+ Status string

+ type CameraHealthSummary struct

+ Details []CameraHealthDetail

+ Error int

+ Offline int

+ Reconnecting int

+ Recording int

+ Total int

type CloudAuthProxy

+ CheckVendor func(ctx context.Context, did string) (string, error)

+ type ConditionalHandler interface

+ SupportedCodec func(codec model.Format) bool

+ UnavailabilityReason func(codec model.Format) string

type Handler

+ func (h *Handler) SetHealthManager(mgr HealthManager)

+ func (h *Handler) SetStabilityProvider(p StabilityProvider)

+ type HealthManager interface

+ GetAllHealth func() map[string]*model.CameraHealth

+ GetCameraHealth func(cameraID string) *model.CameraHealth

type HealthResponse

+ Cameras *CameraHealthSummary

+ SetupRequired bool

+ type LLHLSStreamHandler struct

+ LowLatencyEnabled bool

+ func (h *LLHLSStreamHandler) CanHandle(codec model.Format) bool

+ func (h *LLHLSStreamHandler) Name() string

+ func (h *LLHLSStreamHandler) SupportedCodec(codec model.Format) bool

+ func (h *LLHLSStreamHandler) UnavailabilityReason(_ model.Format) string

type LocalXiaomiAuth

+ func (a *LocalXiaomiAuth) CheckVendor(_ context.Context, did string) (string, error)

+ type ProtocolDetail struct

+ Available bool

+ Protocol string

+ Reason string

+ type StabilityProvider interface

+ GetAllStability func() map[string]*health.StabilityData

+ GetStability func(cameraID string) *health.StabilityData

type StreamRegistry

+ func (r *StreamRegistry) ProtocolsDetailForCodec(codec model.Format) []ProtocolDetail

May 21, 2026

Changes in this version

+ type FLVStreamHandler struct

+ func (h *FLVStreamHandler) CanHandle(codec model.Format) bool

+ func (h *FLVStreamHandler) Name() string

+ func (h *FLVStreamHandler) StartStream(camID string, rec model.Recorder, opts StreamStartOptions) error

+ func (h *FLVStreamHandler) StopStream(camID string) error

+ type HLSStreamHandler struct

+ Mgr *hls.Manager

+ func (h *HLSStreamHandler) CanHandle(codec model.Format) bool

+ func (h *HLSStreamHandler) Name() string

+ func (h *HLSStreamHandler) StartStream(camID string, rec model.Recorder, opts StreamStartOptions) error

+ func (h *HLSStreamHandler) StopStream(camID string) error

+ func (h *HLSStreamHandler) StopStreamWithRecorder(camID string, rec model.Recorder) error

type Handler

+ func (h *Handler) SetFLVManager(mgr *flv.Manager)

+ func (h *Handler) SetStreamRegistry(reg *StreamRegistry)

+ func (h *Handler) SetWebRTCManager(mgr *webrtc.Manager)

+ type StreamHandler interface

+ CanHandle func(codec model.Format) bool

+ Name func() string

+ StartStream func(camID string, rec model.Recorder, opts StreamStartOptions) error

+ StopStream func(camID string) error

+ type StreamRegistry struct

+ func NewStreamRegistry() *StreamRegistry

+ func (r *StreamRegistry) Handler(name string) StreamHandler

+ func (r *StreamRegistry) HandlersForCodec(codec model.Format) []StreamHandler

+ func (r *StreamRegistry) ProtocolsForCodec(codec model.Format) []string

+ func (r *StreamRegistry) Register(h StreamHandler)

+ type StreamStartOptions struct

+ MaxFPS int

+ SubStreamURL string

+ type WebRTCStreamHandler struct

+ func (h *WebRTCStreamHandler) CanHandle(codec model.Format) bool

+ func (h *WebRTCStreamHandler) Name() string

+ func (h *WebRTCStreamHandler) StartStream(camID string, rec model.Recorder, opts StreamStartOptions) error

+ func (h *WebRTCStreamHandler) StopStream(camID string) error

May 20, 2026

Changes in this version

+ type CloudAuthProxy interface

+ ListDevices func(ctx context.Context) ([]CloudDeviceInfo, error)

+ SetCloudConfig func(ctx context.Context, userID, token, region string) error

+ SignIn func(ctx context.Context, username, password, region string) (*CloudAuthResult, *CloudVerificationRequired, error)

+ SubmitCaptcha func(ctx context.Context, sessionID, captchaCode string) (*CloudAuthResult, *CloudVerificationRequired, error)

+ SubmitVerify func(ctx context.Context, sessionID, ticket string) (*CloudAuthResult, *CloudVerificationRequired, error)

+ type CloudAuthResult struct

+ PassToken string

+ Region string

+ UserID string

+ type CloudDeviceInfo struct

+ DID string

+ IP string

+ IsOnline bool

+ MAC string

+ Model string

+ Name string

+ type CloudVerificationRequired struct

+ Captcha []byte

+ CaptchaSessionID string

+ VerifyEmail string

+ VerifyPhone string

+ type LocalXiaomiAuth struct

+ func NewLocalXiaomiAuth(cfg *config.Config) *LocalXiaomiAuth

+ func (a *LocalXiaomiAuth) ListDevices(_ context.Context) ([]CloudDeviceInfo, error)

+ func (a *LocalXiaomiAuth) SetCloudConfig(_ context.Context, userID, token, region string) error

+ func (a *LocalXiaomiAuth) SignIn(_ context.Context, username, password, region string) (*CloudAuthResult, *CloudVerificationRequired, error)

+ func (a *LocalXiaomiAuth) SubmitCaptcha(_ context.Context, sessionID, captchaCode string) (*CloudAuthResult, *CloudVerificationRequired, error)

+ func (a *LocalXiaomiAuth) SubmitVerify(_ context.Context, sessionID, ticket string) (*CloudAuthResult, *CloudVerificationRequired, error)

May 5, 2026

Changes in this version

+ type CPUStats struct

+ Idle uint64

+ Total uint64

+ type Handler struct

+ func NewHandler(db *storage.DB, store *storage.Manager, authMW func(http.Handler) http.Handler, ...) *Handler

+ func TestHandler(db *storage.DB, store *storage.Manager) *Handler

+ func TestHandlerWithAuth(db *storage.DB, store *storage.Manager, username, passwordHash string) *Handler

+ func (h *Handler) Routes() http.Handler

+ type HealthCheck struct

+ Message string

+ Status string

+ type HealthResponse struct

+ Checks map[string]HealthCheck

+ Status string

+ Uptime string

+ type MemoryStats struct

+ Available uint64

+ ProcessRSS uint64

+ Total uint64

+ type NetworkStats struct

+ BytesRecv uint64

+ BytesSent uint64

+ type SystemStats struct

+ CPU CPUStats

+ Memory MemoryStats

+ Network NetworkStats

+ Timestamp int64

+ Uptime string