webstream

Documentation

Overview

Package webstream provides controls for streaming from the web server.

Index

• type BackoffTuningOptions
  • func (opts *BackoffTuningOptions) GetSleepTimeFromErrorCount(errorCount int) time.Duration
• type Server
  • func NewServer(robot robot.Robot, streamConfig gostream.StreamConfig, logger logging.Logger) *Server
  • func (server *Server) AddNewStreams(ctx context.Context) error
  • func (server *Server) AddStream(ctx context.Context, req *streampb.AddStreamRequest) (*streampb.AddStreamResponse, error)
  • func (server *Server) Close() error
  • func (server *Server) ListStreams(ctx context.Context, req *streampb.ListStreamsRequest) (*streampb.ListStreamsResponse, error)
  • func (server *Server) NewStream(config gostream.StreamConfig) (gostream.Stream, error)
  • func (server *Server) RemoveStream(ctx context.Context, req *streampb.RemoveStreamRequest) (*streampb.RemoveStreamResponse, error)
• type StreamAlreadyRegisteredError
  • func (e *StreamAlreadyRegisteredError) Error() string

Types

type BackoffTuningOptions

type BackoffTuningOptions struct {
	// BaseSleep sets the initial amount of time to wait after an error.
	BaseSleep time.Duration
	// MaxSleep determines the maximum amount of time that streamSource is
	// permitted to a sleep after receiving a single error.
	MaxSleep time.Duration
	// Cooldown sets how long since the last error that we can reset our backoff. This
	// should be greater than MaxSleep. This prevents a scenario where we haven't made
	// a call to read for a long time and the error may go away sooner.
	Cooldown time.Duration
}

BackoffTuningOptions represents a set of parameters for determining exponential backoff when receiving multiple simultaneous errors.

BaseSleep is the duration to wait after receiving a new error. After that, the wait time doubles for every subsequent, consecutive error of the same type, until the wait duration reaches the MaxSleep duration.

func (*BackoffTuningOptions) GetSleepTimeFromErrorCount

func (opts *BackoffTuningOptions) GetSleepTimeFromErrorCount(errorCount int) time.Duration

GetSleepTimeFromErrorCount returns a sleep time from an error count.

type Server

type Server struct {
	streampb.UnimplementedStreamServiceServer
	// contains filtered or unexported fields
}

Server implements the gRPC audio/video streaming service.

func NewServer

func NewServer(
	robot robot.Robot,
	streamConfig gostream.StreamConfig,
	logger logging.Logger,
) *Server

NewServer returns a server that will run on the given port and initially starts with the given stream.

func (*Server) AddNewStreams

func (server *Server) AddNewStreams(ctx context.Context) error

AddNewStreams adds new video and audio streams to the server using the updated set of video and audio sources. It refreshes the sources, checks for a valid stream configuration, and starts the streams if applicable.

func (*Server) AddStream

func (server *Server) AddStream(ctx context.Context, req *streampb.AddStreamRequest) (*streampb.AddStreamResponse, error)

AddStream implements part of the StreamServiceServer.

func (*Server) Close

func (server *Server) Close() error

Close closes the Server and waits for spun off goroutines to complete.

func (*Server) ListStreams

func (server *Server) ListStreams(ctx context.Context, req *streampb.ListStreamsRequest) (*streampb.ListStreamsResponse, error)

ListStreams implements part of the StreamServiceServer.

func (*Server) NewStream

func (server *Server) NewStream(config gostream.StreamConfig) (gostream.Stream, error)

NewStream informs the stream server of new streams that are capable of being streamed.

func (*Server) RemoveStream

func (server *Server) RemoveStream(ctx context.Context, req *streampb.RemoveStreamRequest) (*streampb.RemoveStreamResponse, error)

RemoveStream implements part of the StreamServiceServer.

type StreamAlreadyRegisteredError

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

StreamAlreadyRegisteredError indicates that a stream has a name that is already registered on the stream server.

func (*StreamAlreadyRegisteredError) Error

func (e *StreamAlreadyRegisteredError) Error() string