Sink for generating HTTP streaming manifests.

Uses Membrane.HTTPAdaptiveStream.Manifest for manifest serialization and Membrane.HTTPAdaptiveStream.Storage for saving files.

Notifications

• {:track_playable, input_pad_id} - sent when the first segment of a track is stored, and thus the track is ready to be played
• {:cleanup, cleanup_function :: (()-> :ok)} - sent when playback changes from playing to prepared. Invoking cleanup_function lambda results in removing all the files that remain after the streaming

Examples

The following configuration:

%Membrane.HTTPAdaptiveStream.Sink{
  manifest_name: "manifest",
  manifest_module: Membrane.HTTPAdaptiveStream.HLS,
  storage: %Membrane.HTTPAdaptiveStream.Storages.FileStorage{directory: "output"}
}

will generate a HLS manifest in the output directory, playable from output/manifest.m3u8 file.

Element options

Passed via struct Membrane.HTTPAdaptiveStream.Sink.t/0

• manifest_name

  String.t()

  Default value: "index"
  Name of the main manifest file

• manifest_module

  module

  Required
  Implementation of the Membrane.HTTPAdaptiveStream.Manifest behaviour.

• storage

  Storage.config_t()

  Required
  Storage configuration. May be one of Membrane.HTTPAdaptiveStream.Storages.*. See Membrane.HTTPAdaptiveStream.Storage behaviour.

• target_window_duration

  pos_integer | :infinity

  Default value: 5 |> Membrane.Time.seconds()
  Manifest duration is keept above that time, while the oldest segments are removed whenever possible.

• persist?

  any

  Default value: false
  If true, stale segments are removed from the manifest only. Once playback finishes, they are put back into the manifest.

• target_segment_duration

  Time.t()

  Default value: 0 |> Membrane.Time.days()
  Expected length of each segment. Setting it is not necessary, but may help players achieve better UX.

Pads

:input