hls

Documentation

Overview

Package hls provides functions to download HLS streams.

Index

• Variables
• type Checkpoint
  • func DefaultCheckpoint() Checkpoint
• type Downloader
  • func NewDownloader(client *http.Client, log *zerolog.Logger, packetLossMax int, url string) *Downloader
  • func (hls *Downloader) GetFragmentURLs(ctx context.Context) ([]string, error)
  • func (hls *Downloader) Probe(ctx context.Context) (bool, error)
  • func (hls *Downloader) Read(ctx context.Context, writer io.Writer, checkpoint Checkpoint) (newCheckpoint Checkpoint, err error)

Variables

var (

	// ErrHLSForbidden is returned when the HLS download is stopped with a forbidden error.
	ErrHLSForbidden = errors.New("hls download stopped with forbidden error")
)

Types

type Checkpoint

type Checkpoint struct {
	LastFragmentName    string
	LastFragmentTime    time.Time
	UseTimeBasedSorting bool
}

Checkpoint is used to resume the download from the last fragment.

func DefaultCheckpoint

func DefaultCheckpoint() Checkpoint

DefaultCheckpoint returns a default checkpoint.

type Downloader

type Downloader struct {
	*http.Client
	// contains filtered or unexported fields
}

Downloader is used to download HLS streams.

func NewDownloader

func NewDownloader(
	client *http.Client,
	log *zerolog.Logger,
	packetLossMax int,
	url string,
) *Downloader

NewDownloader creates a new HLS downloader.

func (*Downloader) GetFragmentURLs

func (hls *Downloader) GetFragmentURLs(ctx context.Context) ([]string, error)

GetFragmentURLs fetches the fragment URLs from the HLS manifest.

func (*Downloader) Probe

func (hls *Downloader) Probe(ctx context.Context) (bool, error)

Probe checks if the stream is ready to be downloaded.

func (*Downloader) Read

func (hls *Downloader) Read(
	ctx context.Context,
	writer io.Writer,
	checkpoint Checkpoint,
) (newCheckpoint Checkpoint, err error)

Read reads the HLS stream and sends the data to the writer.

Read runs two threads:

1. A goroutine will continuously fetch the fragment URLs and send them to the urlsChan.
2. The main thread will download the fragments and write them to the writer.

The function will return when the context is canceled or when the stream ends.