View Source Membrane.HTTPAdaptiveStream.Storage behaviour (Membrane HTTP Adaptive Stream plugin v0.18.4)

Behaviour for storing manifests and stream segments.

Summary

Types

callback_result_t()
config_t()
header()
metadata_t()
parent_t()

The identifier of a parent that the resource belongs to (the track identifier).

partial_segment_metadata()
segment_metadata_t()
segments()
state_t()
t()

Callbacks

init(config_t)

Generates the storage state based on the configuration struct.

remove(parent_id, resource_name, context, state_t)

Removes the resource.

store(parent_id, resource_name, content, metadata, context, state_t)

Stores the resource on a storage.

Functions

apply_track_changeset(storage, track_id, changeset)

Stores a new segment and removes stale ones.

clean_all_tracks(storage, segments_per_track, header_per_track)

Removes all segments grouped by track.

cleanup(storage, id, segments, header)

Removes all the saved segments and manifest for given id.

clear_cache(storage)

Clears the manifest cache.

new(storage_config, opts \\ [])

Initializes the storage.

store_header(storage, track_id, name, payload)

Stores stream header file.

store_manifests(storage, map)

Stores serialized manifest files

Types

Link to this type

callback_result_t()

View Source 
@type callback_result_t() :: :ok | {:error, reason :: any()}
Link to this type

config_t()

View Source 
@type config_t() :: struct()
Link to this type

header()

View Source 
@type header() :: String.t()
Link to this type

metadata_t()

View Source 
@type metadata_t() :: segment_metadata_t() | partial_segment_metadata() | %{}
Link to this type

parent_t()

View Source 
@type parent_t() :: any()

The identifier of a parent that the resource belongs to (the track identifier).

It can either be a master or secondary playlist (a track playlist). In case of master playlist the identifier will be :master while for tracks it can be an arbitrary value.

Link to this type

partial_segment_metadata()

View Source 
@type partial_segment_metadata() :: %{
  duration: Membrane.Time.t(),
  independent: boolean(),
  byte_offset: non_neg_integer()
}
Link to this type

segment_metadata_t()

View Source 
@type segment_metadata_t() :: %{duration: Membrane.Time.t()}
Link to this type

segments()

View Source 
@type segments() :: [String.t()]
Link to this type

state_t()

View Source 
@type state_t() :: any()
Link to this opaque

t()

View Source (opaque) 
@opaque t()

Callbacks

Link to this callback

init(config_t)

View Source 
@callback init(config_t()) :: state_t()

Generates the storage state based on the configuration struct.

Link to this callback

remove(parent_id, resource_name, context, state_t)

View Source 
@callback remove(
  parent_id :: parent_t(),
  resource_name :: String.t(),
  context :: %{type: :manifest | :header | :segment},
  state_t()
) :: {callback_result_t(), state :: state_t()}

Removes the resource.

In case of removing a segment the storage should make sure to remove all previous partial segments with the same name. It is the user's responsibility to remember and distinguish between the partial segments.

Link to this callback

store(parent_id, resource_name, content, metadata, context, state_t)

View Source 
@callback store(
  parent_id :: parent_t(),
  resource_name :: String.t(),
  content :: String.t() | binary(),
  metadata :: metadata_t(),
  context :: %{
    type: :manifest | :header | :segment | :partial_segment,
    mode: :text | :binary
  },
  state_t()
) :: {callback_result_t(), state :: state_t()}

Stores the resource on a storage.

Gets the mode that should be used when writing to a file and type of the resource

Functions

Link to this function

apply_track_changeset(storage, track_id, changeset)

View Source 
@spec apply_track_changeset(
  t(),
  track_id :: term(),
  Membrane.HTTPAdaptiveStream.Manifest.Changeset.t()
) :: {callback_result_t(), t()}

Stores a new segment and removes stale ones.

Link to this function

clean_all_tracks(storage, segments_per_track, header_per_track)

View Source 
@spec clean_all_tracks(t(), %{required(id :: any()) => segments()}, %{
  required(id :: any()) => header()
}) ::
  {callback_result_t(), t()}

Removes all segments grouped by track.

Link to this function

cleanup(storage, id, segments, header)

View Source 
@spec cleanup(t(), id :: any(), segments :: segments(), header :: header() | nil) ::
  {callback_result_t(), t()}

Removes all the saved segments and manifest for given id.

Link to this function

clear_cache(storage)

View Source 
@spec clear_cache(t()) :: t()

Clears the manifest cache.

Link to this function

new(storage_config, opts \\ [])

View Source 
@spec new(config_t(), [{:enable_cache, boolean()}]) :: t()

Initializes the storage.

Accepts the following options:

  • enable_cache - if true (default), manifests will be stored only if they've been changed
Link to this function

store_header(storage, track_id, name, payload)

View Source 
@spec store_header(t(), track_id :: term(), name :: String.t(), payload :: binary()) ::
  {callback_result_t(), t()}

Stores stream header file.

Link to this function

store_manifests(storage, map)

View Source 
@spec store_manifests(
  t(),
  Membrane.HTTPAdaptiveStream.Manifest.serialized_manifests_t()
) ::
  {callback_result_t(), t()}

Stores serialized manifest files