stream

Documentation

Overview

Package stream contains the Stream object.

Index

• type OnDataFunc
• type Reader
  • func (r *Reader) Error() chan error
  • func (r *Reader) Formats() []format.Format
  • func (r *Reader) OnData(medi *description.Media, forma format.Format, cb OnDataFunc)
  • func (r *Reader) OutboundFramesDiscarded() uint64
• type Stream
  • func (s *Stream) AddReader(r *Reader)
  • func (s *Stream) Close()
  • func (s *Stream) InboundBytes() uint64
  • func (s *Stream) InboundFramesInError() uint64
  • func (s *Stream) Initialize() error
  • func (s *Stream) OutboundBytes() uint64
  • func (s *Stream) RTSPSStream(server *gortsplib.Server) *gortsplib.ServerStream
  • func (s *Stream) RTSPStream(server *gortsplib.Server) *gortsplib.ServerStream
  • func (s *Stream) RemoveReader(r *Reader)
  • func (s *Stream) StartOfflineSubStream() error
  • func (s *Stream) WaitForReaders()
• type SubStream
  • func (ss *SubStream) Initialize() error
  • func (ss *SubStream) WriteUnit(medi *description.Media, forma format.Format, u *unit.Unit)

Types

type OnDataFunc

type OnDataFunc func(*unit.Unit) error

OnDataFunc is the callback passed to OnData().

type Reader

type Reader struct {
	SkipOutboundBytes bool
	Parent            logger.Writer
	// contains filtered or unexported fields
}

Reader is a stream reader.

func (*Reader) Error

func (r *Reader) Error() chan error

error returns whenever there's an error. It can be called only after stream.AddReader().

func (*Reader) Formats

func (r *Reader) Formats() []format.Format

Formats returns all formats for which the reader has registered a OnData callback.

func (*Reader) OnData

func (r *Reader) OnData(medi *description.Media, forma format.Format, cb OnDataFunc)

OnData registers a callback that is called when data from given format is available.

func (*Reader) OutboundFramesDiscarded

func (r *Reader) OutboundFramesDiscarded() uint64

OutboundFramesDiscarded returns the number of frames discarded because the reader is too slow.

type Stream

type Stream struct {
	Desc                  *description.Session
	AlwaysAvailable       bool
	AlwaysAvailableTracks []conf.AlwaysAvailableTrack
	AlwaysAvailableFile   string
	WriteQueueSize        int
	RTPMaxPayloadSize     int
	ReplaceNTP            bool
	Parent                logger.Writer
	// contains filtered or unexported fields
}

Stream is a media stream. It stores tracks, readers and allows to write data to readers, remuxing it when needed.

func (*Stream) AddReader

func (s *Stream) AddReader(r *Reader)

AddReader adds a reader. Used by all protocols except RTSP.

func (*Stream) Close

func (s *Stream) Close()

Close closes all resources of the stream.

func (*Stream) InboundBytes

func (s *Stream) InboundBytes() uint64

InboundBytes returns received bytes.

func (*Stream) InboundFramesInError

func (s *Stream) InboundFramesInError() uint64

InboundFramesInError returns the number of frames received with processing errors.

func (*Stream) Initialize

func (s *Stream) Initialize() error

Initialize initializes a Stream.

func (*Stream) OutboundBytes

func (s *Stream) OutboundBytes() uint64

OutboundBytes returns sent bytes.

func (*Stream) RTSPSStream

func (s *Stream) RTSPSStream(server *gortsplib.Server) *gortsplib.ServerStream

RTSPSStream returns the RTSPS stream.

func (*Stream) RTSPStream

func (s *Stream) RTSPStream(server *gortsplib.Server) *gortsplib.ServerStream

RTSPStream returns the RTSP stream.

func (*Stream) RemoveReader

func (s *Stream) RemoveReader(r *Reader)

RemoveReader removes a reader. Used by all protocols except RTSP.

func (*Stream) StartOfflineSubStream

func (s *Stream) StartOfflineSubStream() error

StartOfflineSubStream starts the offline substream.

func (*Stream) WaitForReaders

func (s *Stream) WaitForReaders()

WaitForReaders waits for the stream to have at least one reader.

type SubStream

type SubStream struct {
	Stream        *Stream
	CurDesc       *description.Session
	UseRTPPackets bool
	// contains filtered or unexported fields
}

SubStream is a Stream without interruptions.

func (*SubStream) Initialize

func (ss *SubStream) Initialize() error

Initialize initializes the SubStream.

func (*SubStream) WriteUnit

func (ss *SubStream) WriteUnit(medi *description.Media, forma format.Format, u *unit.Unit)

WriteUnit writes a Unit.