Membrane.HTTPAdaptiveStream.Manifest behaviour (Membrane HTTP Adaptive Stream plugin v0.4.0) View Source

t() :: %Membrane.HTTPAdaptiveStream.Manifest{
  module: module(),
  name: String.t(),
  tracks: %{
    required(id :: any()) => Membrane.HTTPAdaptiveStream.Manifest.Track.t()
  }
}

Link to this section Callbacks

serialize(t)

Specs

serialize(t()) :: [
  {manifest_name :: String.t(), manifest_content :: String.t()}
]

Link to this section Functions

add_segment(manifest, track_id, duration, bytes_size, attributes \\ [])

Specs

add_segment(
  t(),
  track_id :: Membrane.HTTPAdaptiveStream.Manifest.Track.id_t(),
  Membrane.HTTPAdaptiveStream.Manifest.Track.segment_duration_t(),
  Membrane.HTTPAdaptiveStream.Manifest.Track.segment_bytes_size_t(),
  [Membrane.HTTPAdaptiveStream.Manifest.SegmentAttribute.t()]
) ::
  {{to_add_name :: String.t(),
    to_remove_names ::
      Membrane.HTTPAdaptiveStream.Manifest.Track.to_remove_names_t()}, t()}

add_track(manifest, config)

Specs

add_track(t(), Membrane.HTTPAdaptiveStream.Manifest.Track.Config.t()) ::
  {header_name :: String.t(), t()}

Adds a track to the manifest.

Returns the name under which the header file should be stored.

all_segments(manifest)

Specs

all_segments(t()) :: [[track_name :: String.t()]]

Returns stale and current segments' names from all tracks

discontinue_track(manifest, track_id)

Specs

discontinue_track(t(), Membrane.HTTPAdaptiveStream.Manifest.Track.id_t()) ::
  {header_name :: String.t(), t()}

Append a discontinuity to the track.

This will inform the player that eg. the parameters of the encoder changed and allow you to provide a new MP4 header. For details on discontinuities refer to RFC 8216.

finish(manifest, track_id)

Specs

finish(t(), Membrane.HTTPAdaptiveStream.Manifest.Track.id_t()) :: t()

from_beginning(manifest)

Specs

from_beginning(t()) :: t()

Restores all the stale segments in all tracks.

All the tracks must be configured to be persisted beforehand, otherwise this function will raise

has_track?(manifest, track_id)

Specs

has_track?(t(), Membrane.HTTPAdaptiveStream.Manifest.Track.id_t()) :: boolean()

serialize(manifest)

Specs

serialize(t()) :: [{name :: String.t(), manifest :: String.t()}]