service

package
v0.0.0-...-ad8d7c7 Latest Latest
Warning

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

Go to latest
Published: May 8, 2023 License: AGPL-3.0 Imports: 5 Imported by: 0

README

Services

Services are at their most basic form authentication mechanisms for streaming.

Examples:

  1. Glimesh
  2. Generic REST

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Service

type Service interface {
	SetLogger(log logrus.FieldLogger)

	// Name of the service, eg: Glimesh
	Name() string
	// Connect to the service
	Connect() error
	// GetHmacKey Get the private HMAC key for a given channel ID
	GetHmacKey(channelID types.ChannelID) ([]byte, error)
	// StartStream Starts a stream for a given channel
	StartStream(channelID types.ChannelID) (types.StreamID, error)
	// EndStream Marks the given stream ID as ended on the service
	EndStream(streamID types.StreamID) error
	// UpdateStreamMetadata Updates the service with additional metadata about a stream
	UpdateStreamMetadata(streamID types.StreamID, metadata types.StreamMetadata) error
	// SendJpegPreviewImage Sends a JPEG preview image of a stream to the service
	SendJpegPreviewImage(streamID types.StreamID, img []byte) error
}

func New

func New(cfg config.Config, logger *logrus.Logger) Service

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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