View Source Membrane.Pipeline.CallbackContext (Membrane Core v1.2.3)
Module describing context passed to the Membrane.Pipeline
callbacks.
Summary
Types
Type describing context passed to the Membrane.Pipeline
callbacks.
Types
@type t() :: %{ :children => %{required(Membrane.Child.name()) => Membrane.ChildEntry.t()}, :clock => Membrane.Clock.t(), :module => module(), :playback => Membrane.Playback.t(), :resource_guard => Membrane.ResourceGuard.t(), :utility_supervisor => Membrane.UtilitySupervisor.t(), optional(:from) => [GenServer.from()], optional(:members) => [Membrane.Child.name()], optional(:crash_initiator) => Membrane.Child.name() | nil, optional(:crash_reason) => :normal | :shutdown | {:shutdown, term()} | term(), optional(:start_of_stream_received?) => boolean(), optional(:exit_reason) => :normal | :shutdown | {:shutdown, term()} | term(), optional(:group_name) => Membrane.Child.group() | nil }
Type describing context passed to the Membrane.Pipeline
callbacks.
Field :from
is present only in Membrane.Pipeline.handle_call/3
.
Field :start_of_stream_received?
is present only in
Membrane.Pipeline.handle_element_end_of_stream/4
.
Field :crash_initiator
is only present in Membrane.Pipeline.handle_child_terminated/3
and Membrane.Pipeline.handle_crash_group_down/3
.
Fields :members
and :crash_reason
are present only in
Membrane.Pipeline.handle_crash_group_down/3
.
Fields :exit_reason
and :group_name
are present only in
Membrane.Pipeline.handle_child_terminated/3
.