Membrane Core v0.5.0 Membrane.Parent.Action View Source

Common types' definitions for bin and pipeline.

Link to this section Summary

Types

Action that sends a message to a child identified by name.

Action that stops, unlinks and removes specified child/children from their parent.

Action that instantiates children and links them according to Membrane.ParentSpec.

t()

Type describing actions that can be returned from parent callbacks.

Link to this section Types

Link to this type

forward_action_t()

View Source
forward_action_t() ::
  {:forward, {Membrane.Child.name_t(), Membrane.Notification.t()}}

Action that sends a message to a child identified by name.

Link to this type

remove_child_action_t()

View Source
remove_child_action_t() ::
  {:remove_child, Membrane.Child.name_t() | [Membrane.Child.name_t()]}

Action that stops, unlinks and removes specified child/children from their parent.

Link to this type

spec_action_t()

View Source
spec_action_t() :: {:spec, Membrane.ParentSpec.t()}

Action that instantiates children and links them according to Membrane.ParentSpec.

Children's playback state is changed to the current parent state. Membrane.Parent.handle_spec_started/2 callback is executed once it happens.

Type describing actions that can be returned from parent callbacks.

Returning actions is a way of pipeline/bin interaction with its children and other parts of framework.