state

Documentation

Overview

Package state controls the source of the RTP packets being written to the stream's subscribers and ensures there is only one active at a time while there are peer connections to receive RTP packets.

Index

• Variables
• type StreamState
  • func New(stream gostream.Stream, r robot.Robot, logger logging.Logger) *StreamState
  • func (state *StreamState) Close() error
  • func (state *StreamState) Decrement() error
  • func (state *StreamState) Increment() error
  • func (state *StreamState) Reset() error
  • func (state *StreamState) Resize() error

Variables

var ErrClosed = errors.New("StreamState already closed")

ErrClosed indicates that the StreamState is already closed.

Types

type StreamState

type StreamState struct {
	// Stream is the StreamState's stream
	Stream gostream.Stream
	// contains filtered or unexported fields
}

StreamState controls the source of the RTP packets being written to the stream's subscribers and ensures there is only one active at a time while there are subsribers.

func New

func New(
	stream gostream.Stream,
	r robot.Robot,
	logger logging.Logger,
) *StreamState

New returns a new *StreamState. rtpPassthroughSource is allowed to be nil if the camere does not implement rtppassthrough.Source.

func (*StreamState) Close

func (state *StreamState) Close() error

Close closes the StreamState.

func (*StreamState) Decrement

func (state *StreamState) Decrement() error

Decrement decrements the peer connections subscribed to the stream.

func (*StreamState) Increment

func (state *StreamState) Increment() error

Increment increments the peer connections subscribed to the stream.

func (*StreamState) Reset

func (state *StreamState) Reset() error

Reset notifies that the gostream source has been reset to the original resolution. This will restart the passthrough stream if it is supported.

func (*StreamState) Resize

func (state *StreamState) Resize() error

Resize notifies that the gostream source has been resized. This will stop and prevent the use of the passthrough stream if it is supported.