Packages

membrane_core

1.2.2
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)

HexDocs

Current section

Files

Jump to
Readme
65 Versions
4 Dependencies
136 Dependants
Files
Activity
membrane_core lib membrane core bin state.ex
Raw

lib/membrane/core/bin/state.ex 

defmodule Membrane.Core.Bin.State do

  @moduledoc false



  # Structure representing state of a bin. It is a part of the private API.

  # It does not represent state of bins you construct, it's a state used

  # internally in Membrane.



  use Bunch

  use Bunch.Access



  alias Membrane.{Child, Clock, Sync}

  alias Membrane.Core.Child.PadModel

  alias Membrane.Core.Parent.ChildLifeController

  alias Membrane.Core.Parent.{ChildrenModel, CrashGroup, Link}

  alias Membrane.Core.Timer



  @type t :: %__MODULE__{

          internal_state: Membrane.Bin.state() | nil,

          module: module(),

          children: ChildrenModel.children(),

          subprocess_supervisor: pid(),

          name: Membrane.Bin.name() | nil,

          pads_info: PadModel.pads_info() | nil,

          pads_data: PadModel.pads_data() | nil,

          parent_pid: pid(),

          links: %{Link.id() => Link.t()},

          crash_groups: %{CrashGroup.name() => CrashGroup.t()},

          synchronization: %{

            timers: %{Timer.id() => Timer.t()},

            parent_clock: Clock.t(),

            latency: Membrane.Time.non_neg(),

            stream_sync: Sync.t(),

            clock: Clock.t() | nil,

            clock_proxy: Clock.t(),

            clock_provider: %{

              clock: Clock.t() | nil,

              provider: Child.name() | nil

            }

          },

          children_log_metadata: Keyword.t(),

          pending_specs: ChildLifeController.pending_specs(),

          playback: Membrane.Playback.t(),

          initialized?: boolean(),

          terminating?: boolean(),

          resource_guard: Membrane.ResourceGuard.t(),

          setup_incomplete_returned?: boolean(),

          stalker: Membrane.Core.Stalker.t()

        }



  # READ THIS BEFORE ADDING NEW FIELD!!!



  # Fields of this structure will be inspected in the same order, in which they occur in the

  # list passed to `defstruct`. Take a look at lib/membrane/core/inspect.ex to get more info.

  # If you want to add a new field to the state, place it at the spot corresponding to its

  # importance and possibly near other related fields. It is suggested, to keep `:pads_data`

  # as the last item in the list, because sometimes it is so big, that everything after it

  # might be truncated during the inspection.



  defstruct module: nil,

            name: nil,

            parent_pid: nil,

            playback: :stopped,

            internal_state: nil,

            pads_info: nil,

            children: %{},

            links: %{},

            crash_groups: %{},

            pending_specs: %{},

            synchronization: nil,

            initialized?: false,

            terminating?: false,

            setup_incomplete_returned?: false,

            stalker: nil,

            resource_guard: nil,

            subprocess_supervisor: nil,

            children_log_metadata: [],

            pads_data: nil

end