Membrane HTTP Adaptive Stream plugin v0.8.0

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

Behaviour for storing manifests and stream segments.

Link to this section Summary

Types

callback_result_t()
config_t()
state_t()
t()

Callbacks

init(config_t)

Generates the storage state based on the configuration struct.

remove( resource_name, context, state_t )

Removes the resource.

store( resource_name, content, context, state_t )

Stores the resource on a storage.

Functions

apply_segment_changeset(storage, arg, payload)

Stores a new segment and removes stale ones.

cleanup(storage, segments)

Removes all the saved segments and manifests.

clear_cache(storage)

Clears the manifest cache.

new(storage_config, opts \\ [])

Initializes the storage.

store_header(storage, name, payload)

Stores stream header file.

store_manifests(storage, manifests)

Stores serialized manifest files

Link to this section 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

state_t()

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

t()

View Source (opaque) 
@opaque t()

Link to this section 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( resource_name, context, state_t )

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

Removes the resource.

Link to this callback

store( resource_name, content, context, state_t )

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

Stores the resource on a storage.

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

Link to this section Functions

Link to this function

apply_segment_changeset(storage, arg, payload)

View Source 
@spec apply_segment_changeset(
  t(),
  {to_add :: String.t(), to_remove :: [String.t()]},
  payload :: binary()
) :: {callback_result_t(), t()}

Stores a new segment and removes stale ones.

Link to this function

cleanup(storage, segments)

View Source 
@spec cleanup(t(), segments :: [String.t()]) :: {callback_result_t(), t()}

Removes all the saved segments and manifests.

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, name, payload)

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

Stores stream header file.

Link to this function

store_manifests(storage, manifests)

View Source 
@spec store_manifests(t(), [{name :: String.t(), content :: String.t()}]) ::
  {callback_result_t(), t()}

Stores serialized manifest files