stream

Documentation

Overview

Package stream contains the Stream object.

Index

• type ReadFunc
• type Reader
• type Stream
  • func New(writeQueueSize int, udpMaxPayloadSize int, desc *description.Session, ...) (*Stream, error)
  • func (s *Stream) AddReader(reader Reader, medi *description.Media, forma format.Format, cb ReadFunc)
  • func (s *Stream) BytesReceived() uint64
  • func (s *Stream) BytesSent() uint64
  • func (s *Stream) Close()
  • func (s *Stream) Desc() *description.Session
  • func (s *Stream) RTSPSStream(server *gortsplib.Server) *gortsplib.ServerStream
  • func (s *Stream) RTSPStream(server *gortsplib.Server) *gortsplib.ServerStream
  • func (s *Stream) ReaderError(reader Reader) chan error
  • func (s *Stream) ReaderFormats(reader Reader) []format.Format
  • func (s *Stream) RemoveReader(reader Reader)
  • func (s *Stream) StartReader(reader Reader)
  • func (s *Stream) WaitRunningReader()
  • func (s *Stream) WriteRTPPacket(medi *description.Media, forma format.Format, pkt *rtp.Packet, ntp time.Time, ...)
  • func (s *Stream) WriteUnit(medi *description.Media, forma format.Format, u unit.Unit)

Types

type ReadFunc

type ReadFunc func(unit.Unit) error

ReadFunc is the callback passed to AddReader().

type Reader

type Reader interface {
	logger.Writer
}

Reader is a stream reader.

type Stream

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

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

func New

func New(
	writeQueueSize int,
	udpMaxPayloadSize int,
	desc *description.Session,
	generateRTPPackets bool,
	decodeErrLogger logger.Writer,
) (*Stream, error)

New allocates a Stream.

func (*Stream) AddReader

func (s *Stream) AddReader(reader Reader, medi *description.Media, forma format.Format, cb ReadFunc)

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

func (*Stream) BytesReceived

func (s *Stream) BytesReceived() uint64

BytesReceived returns received bytes.

func (*Stream) BytesSent

func (s *Stream) BytesSent() uint64

BytesSent returns sent bytes.

func (*Stream) Close

func (s *Stream) Close()

Close closes all resources of the stream.

func (*Stream) Desc

func (s *Stream) Desc() *description.Session

Desc returns the description of the stream.

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) ReaderError

func (s *Stream) ReaderError(reader Reader) chan error

ReaderError returns whenever there's an error.

func (*Stream) ReaderFormats

func (s *Stream) ReaderFormats(reader Reader) []format.Format

ReaderFormats returns all formats that a reader is reading.

func (*Stream) RemoveReader

func (s *Stream) RemoveReader(reader Reader)

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

func (*Stream) StartReader

func (s *Stream) StartReader(reader Reader)

StartReader starts a reader. Used by all protocols except RTSP.

func (*Stream) WaitRunningReader

func (s *Stream) WaitRunningReader()

WaitRunningReader waits for a running reader.

func (*Stream) WriteRTPPacket

func (s *Stream) WriteRTPPacket(
	medi *description.Media,
	forma format.Format,
	pkt *rtp.Packet,
	ntp time.Time,
	pts int64,
)

WriteRTPPacket writes a RTP packet.

func (*Stream) WriteUnit

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

WriteUnit writes a Unit.