Packages
membrane_core
1.2.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.7
1.2.6
1.2.5
retired
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc1
1.1.2
1.1.1
1.1.0
1.1.0-rc1
1.1.0-rc0
1.0.1
1.0.0
1.0.0-rc1
1.0.0-rc0
0.12.9
0.12.8
0.12.7
0.12.6
0.12.5
0.12.4
0.12.3
0.12.2
0.12.1
0.12.0
retired
0.11.5
0.11.4
0.11.3
0.11.2
0.11.1
0.11.0
0.10.2
0.10.1
0.10.0
0.9.0
0.8.2
0.8.1
0.8.0
0.7.0
0.6.1
0.6.0
0.5.3
0.5.2
0.5.1
0.5.0
0.4.3
0.4.2
0.4.1
0.4.0
0.3.2
0.3.1
0.3.0
0.2.2
0.2.1
0.2.0
0.1.1
0.1.0
Membrane Multimedia Framework (Core)
Retired package: Release invalid - This release is broken and doesn't compile, please use 1.2.6 instead
Current section
Files
Jump to
Current section
Files
lib/membrane/bin/callback_context.ex
defmodule Membrane.Bin.CallbackContext do
@moduledoc """
Module describing context passed to the `Membrane.Bin` callbacks.
"""
@typedoc """
Type describing context passed to the `Membrane.Bin` callbacks.
Field `:pad_options` is present only in `c:Membrane.Bin.handle_pad_added/3`
and `c:Membrane.Bin.handle_pad_removed/3`.
Field `:start_of_stream_received?` is present only in
`c:Membrane.Bin.handle_element_end_of_stream/4`.
Field `:crash_initiator` is only present in `c:Membrane.Bin.handle_child_terminated/3`
and `c:Membrane.Bin.handle_crash_group_down/3`.
Fields `:members` and `:crash_reason` are present only in
`c:Membrane.Bin.handle_crash_group_down/3`.
Fields `:exit_reason` and `:group_name` are present only in
`c:Membrane.Bin.handle_child_terminated/3`.
"""
@type t :: %{
:children => %{Membrane.Child.name() => Membrane.ChildEntry.t()},
:clock => Membrane.Clock.t(),
:parent_clock => Membrane.Clock.t(),
:module => module(),
:name => Membrane.Bin.name(),
:pads => %{Membrane.Pad.ref() => Membrane.Bin.PadData.t()},
:playback => Membrane.Playback.t(),
:resource_guard => Membrane.ResourceGuard.t(),
:utility_supervisor => Membrane.UtilitySupervisor.t(),
optional(:pad_options) => map(),
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
}
end