View Source Membrane.HTTPAdaptiveStream.Manifest.Track (Membrane HTTP Adaptive Stream plugin v0.18.4)

Struct representing a state of a single manifest track and functions to operate on it.

Summary

Types

id_t()

segment_duration_t()

segment_metadata()

segment_payload_t()

segment_size_t()

segments_t()

t()

The struct representing a track.

Functions

add_chunk(track, opts, attributes \\ [])

Recognizes if its regular or partial segment and then update the track appropriately. Returns Changeset.

all_segments(track)

Returns all segments present in the track, including stale segments.

default_header_naming_fun(track, counter)

default_partial_naming_fun(track, list)

default_segment_naming_fun(track)

discontinue(track)

Discontinue the track, indicating that parameters of the stream have changed.

finish(track)

Marks the track as finished and finalize last segment if needed. After this action, it won't be possible to add any new segments to the track.

from_beginning(track)

Return new track with all stale segments restored, resulting in playback of historic data. Only works with 'persist?' option enabled.

header(track)

Returns current header name

new(config)

persisted?(map)

supports_partial_segments?(track)

Tells whether the track is able to produce partial media segments.

Types

id_t()

@type id_t() :: any()

segment_duration_t()

@type segment_duration_t() :: Membrane.Time.t() | Ratio.t()

segment_metadata()

@type segment_metadata() :: %{
  payload: segment_payload_t(),
  complete?: boolean(),
  independent?: boolean(),
  last_chunk?: boolean(),
  duration: segment_duration_t(),
  size: segment_size_t()
}

segment_payload_t()

@type segment_payload_t() :: binary()

segment_size_t()

@type segment_size_t() :: non_neg_integer()

segments_t()

@type segments_t() :: Qex.t(Membrane.HTTPAdaptiveStream.Manifest.Segment.t())

t()

@type t() :: %Membrane.HTTPAdaptiveStream.Manifest.Track{
  awaiting_discontinuity: term(),
  content_type: :audio | :video | :muxed,
  current_discontinuity_seq_num: non_neg_integer(),
  current_seq_num: non_neg_integer(),
  discontinuities_counter: non_neg_integer(),
  encoding:
    [Membrane.HTTPAdaptiveStream.Manifest.Track.Config.encoding_t()] | [],
  finished?: boolean(),
  header_extension: String.t(),
  header_name: String.t(),
  header_naming_fun: (t(), counter :: non_neg_integer() -> String.t()),
  id: id_t(),
  max_framerate: term(),
  mode: term(),
  next_segment_id: non_neg_integer(),
  partial_naming_fun: term(),
  partial_segment_duration: segment_duration_t() | nil,
  persist?: boolean(),
  resolution: {non_neg_integer(), non_neg_integer()} | nil,
  segment_duration: Membrane.Time.t(),
  segment_extension: String.t(),
  segment_naming_fun: (t() -> String.t()),
  segment_sequencer: {msn :: non_neg_integer(), part_sn :: non_neg_integer()},
  segments: segments_t(),
  stale_headers: term(),
  stale_segments: segments_t(),
  target_window_duration: Membrane.Time.t() | :infinity,
  track_name: String.t(),
  window_duration: non_neg_integer()
}

The struct representing a track.

Consists of all the fields from Config.t and also:

header_name - name of the header file
current_seq_num - the number to identify the next segment
current_discontinuity_seq_num - number of current discontinuity sequence.
segments - segments' names and durations
stale_segments - stale segments' names and durations, kept empty unless persist? is set to true
stale_headers - stale headers' names, kept empty unless persist? is set to true
finished? - determines whether the track is finished
window_duration - current window duration
discontinuities_counter - the number of discontinuities that happened so far
next_segment_id - the sequence number of the next segment that will be generated
segment_sequencer - keeps track of the current sequence number of a segment.

Functions

add_chunk(track, opts, attributes \\ [])

@spec add_chunk(
  t(),
  segment_metadata(),
  [Membrane.HTTPAdaptiveStream.Manifest.SegmentAttribute.t()]
) :: {Membrane.HTTPAdaptiveStream.Manifest.Changeset.t(), t()}

Recognizes if its regular or partial segment and then update the track appropriately. Returns Changeset.

all_segments(track)

@spec all_segments(t()) :: [segment_name :: String.t()]

Returns all segments present in the track, including stale segments.

default_header_naming_fun(track, counter)

@spec default_header_naming_fun(t(), non_neg_integer()) :: String.t()

default_partial_naming_fun(track, list)

@spec default_partial_naming_fun(t(), Keyword.t()) :: String.t()

default_segment_naming_fun(track)

@spec default_segment_naming_fun(t()) :: String.t()

discontinue(track)

@spec discontinue(t()) :: {header_name :: String.t(), t()}

Discontinue the track, indicating that parameters of the stream have changed.

New header has to be stored under the returned filename. For details on discontinuity, please refer to RFC 8216.

finish(track)

@spec finish(t()) :: {Membrane.HTTPAdaptiveStream.Manifest.Changeset.t(), t()}

Marks the track as finished and finalize last segment if needed. After this action, it won't be possible to add any new segments to the track.

from_beginning(track)

@spec from_beginning(t()) :: t()

Return new track with all stale segments restored, resulting in playback of historic data. Only works with 'persist?' option enabled.

new(config)

@spec new(Membrane.HTTPAdaptiveStream.Manifest.Track.Config.t()) :: t()

persisted?(map)

@spec persisted?(t()) :: boolean()

supports_partial_segments?(track)

@spec supports_partial_segments?(t()) :: boolean()

Tells whether the track is able to produce partial media segments.