hls

Documentation

Index

• type ExtendedPacket
• type Publisher
  • func (p *Publisher) Close()
  • func (p *Publisher) Discontinuity()
  • func (p *Publisher) ServeHTTP(rw http.ResponseWriter, req *http.Request)
  • func (p *Publisher) WriteExtendedPacket(pkt ExtendedPacket) error
  • func (p *Publisher) WriteHeader(streams []av.CodecData) error
  • func (p *Publisher) WritePacket(pkt av.Packet) error
  • func (p *Publisher) WriteTrailer() error

Types

type ExtendedPacket

type ExtendedPacket struct {
	av.Packet
	// ProgramTime indicates the wall-clock time of a keyframe packet
	ProgramTime time.Time
}

ExtendedPacket holds a packet with additional metadata for the HLS playlist

type Publisher

type Publisher struct {
	// InitialDuration is a guess for the TARGETDURATION field in the playlist, used until the first segment is complete
	InitialDuration time.Duration
	// BufferLength is the approximate duration spanned by all the segments in the playlist. Old segments are removed until the playlist length is less than this value.
	BufferLength time.Duration
	// WorkDir is a temporary storage location for segments. Can be empty, in which case the default system temp dir is used.
	WorkDir string
	// Prefetch indicates that low-latency HLS (LHLS) tags should be used
	// https://github.com/video-dev/hlsjs-rfcs/blob/a6e7cc44294b83a7dba8c4f45df6d80c4bd13955/proposals/0001-lhls.md
	Prefetch  bool
	Precreate int
	// contains filtered or unexported fields
}

Publisher implements a live HLS stream server

func (*Publisher) Close

func (p *Publisher) Close()

Close frees resources associated with the publisher

func (*Publisher) Discontinuity

func (p *Publisher) Discontinuity()

Discontinuity inserts a marker into the playlist before the next segment indicating that the decoder should be reset

func (*Publisher) ServeHTTP

func (p *Publisher) ServeHTTP(rw http.ResponseWriter, req *http.Request)

serve the HLS playlist and segments

func (*Publisher) WriteExtendedPacket

func (p *Publisher) WriteExtendedPacket(pkt ExtendedPacket) error

WriteExtendedPacket publishes a packetw ith additional metadata

func (*Publisher) WriteHeader

func (p *Publisher) WriteHeader(streams []av.CodecData) error

WriteHeader initializes the streams' codec data and must be called before the first WritePacket

func (*Publisher) WritePacket

func (p *Publisher) WritePacket(pkt av.Packet) error

WritePacket publishes a single packet

func (*Publisher) WriteTrailer

func (p *Publisher) WriteTrailer() error

WriteTrailer does nothing