ExHLS.Client (ExHLS v0.1.5)

Module providing functionality to read and demux HLS streams. It allows reading chunks from the stream, choosing variants, and managing media playlists.

Summary

Functions

choose_variant(client, variant_id)

generate_stream(client)

get_skipped_segments_cumulative_duration_ms(client)

get_tracks_info(client)

get_variants(client)

new(url, opts \\ [])

Starts the ExHLS client with the given URL.

Types

client()

@opaque client()

variant_description()

@type variant_description() :: %{
  id: integer(),
  name: String.t() | nil,
  frame_rate: number() | nil,
  resolution: {integer(), integer()} | nil,
  codecs: String.t() | nil,
  bandwidth: integer() | nil,
  uri: String.t() | nil
}

Functions

choose_variant(client, variant_id)

@spec choose_variant(client(), String.t()) :: client()

generate_stream(client)

@spec generate_stream(client()) :: Enumerable.t(ExHLS.Chunk.t())

get_skipped_segments_cumulative_duration_ms(client)

@spec get_skipped_segments_cumulative_duration_ms(client()) ::
  {:ok, non_neg_integer()} | no_return()

get_tracks_info(client)

@spec get_tracks_info(client()) ::
  {:ok, %{optional(integer()) => struct()}, client()}
  | {:error, reason :: any(), client()}

get_variants(client)

@spec get_variants(client()) :: %{optional(integer()) => variant_description()}

new(url, opts \\ [])

@spec new(String.t(),
  parent_process: pid(),
  how_much_to_skip_ms: non_neg_integer(),
  segment_format: :ts | :cmaf
) :: client()

Starts the ExHLS client with the given URL.

As options, you can pass :parent_process to specify the parent process that will be allowed to read media chunks when the HLS stream is in the Live mode. Parent process defaults to the process that created the client.

You can also pass :how_much_to_skip_ms option to specify how many milliseconds of the beginning of the stream should be skipped. This option is only supported when the HLS stream is in the VoD mode. Defaults to 0.

Apart from that you can also pass :segment_format to force treating HLS segments as either MPEG-TS or CMAF container files. If you don't provide this option, the client will treat HLS segments based on the extension in their name, falling back MPEG-TS if the cannot recognize the extension.

Note that there is no guarantee that exactly the specified amount of time will be skipped. The actual skipped duration may be slightly shorter, depending on the HLS segments durations. To get the actual skipped duration, you can use get_skipped_segments_cumulative_duration_ms/1 function.