View Source Membrane.Pipeline.Action (Membrane Core v0.12.9)

This module contains type specifications of actions that can be returned from pipeline callbacks.

Returning actions is a way of pipeline interaction with other components and parts of framework. Each action may be returned by any callback unless explicitly stated otherwise.

Summary

Types

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

Action that stops, unlinks and removes specified child/children from the pipeline.

Action that removes link, which relates to specified child and pad.

Action that replies to a Membrane.Pipeline.call/3. Can be returned only from the Membrane.Pipeline.handle_call/3 callback, in which context the caller reference is available, under the :from key.

Action that replies to a Membrane.Pipeline.call/3. Useful when one does not want to reply in Membrane.Pipeline.handle_call/3 callback. A caller reference is required to be passed, so one needs to save this reference from the Membrane.Pipeline.CallbackContext.Call, where it is available under the :from key.

Action that manages the end of the component setup.

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

Starts a timer that will invoke Membrane.Pipeline.handle_tick/3 callback every interval according to the given clock.

Stops a timer started with start_timer/0 action.

t()

Type describing actions that can be returned from pipeline callbacks.

Terminates the pipeline with given reason.

Changes interval of a timer started with start_timer/0.

Types

@type notify_child() ::
  {:notify_child, {Membrane.Child.name(), Membrane.ParentNotification.t()}}

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

@type playback() :: {:playback, :playing, :stopped, :prepared}
@type remove_child() ::
  {:remove_child,
   Membrane.Child.name()
   | [Membrane.Child.name()]
   | Membrane.Child.group()
   | [Membrane.Child.group()]}
@type remove_children() ::
  {:remove_children,
   Membrane.Child.name()
   | [Membrane.Child.name()]
   | Membrane.Child.group()
   | [Membrane.Child.group()]}

Action that stops, unlinks and removes specified child/children from the pipeline.

A child name, list of children names, children group id or a list of children group ids can be specified as an argument.

@type remove_link() :: {:remove_link, {Membrane.Child.name(), Membrane.Pad.ref()}}

Action that removes link, which relates to specified child and pad.

Removed link has to have dynamic pads on both ends.

@type reply() :: {:reply, message :: any()}

Action that replies to a Membrane.Pipeline.call/3. Can be returned only from the Membrane.Pipeline.handle_call/3 callback, in which context the caller reference is available, under the :from key.

@type reply_to() :: {:reply_to, {GenServer.from(), message :: any()}}

Action that replies to a Membrane.Pipeline.call/3. Useful when one does not want to reply in Membrane.Pipeline.handle_call/3 callback. A caller reference is required to be passed, so one needs to save this reference from the Membrane.Pipeline.CallbackContext.Call, where it is available under the :from key.

@type setup() :: {:setup, :incomplete | :complete}

Action that manages the end of the component setup.

By default, component setup ends with the end of Membrane.Pipeline.handle_setup/2 callback. If {:setup, :incomplete} is returned there, setup lasts until {:setup, :complete} is returned from antoher callback.

Untils the setup lasts, the component won't enter :playing playback.

@type spec() :: {:spec, Membrane.ChildrenSpec.t()}

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

Children's playback is changed to the current pipeline state. Membrane.Pipeline.handle_spec_started/3 callback is executed once it happens.

@type start_timer() ::
  {:start_timer,
   {timer_id :: any(),
    interval :: Ratio.t() | Membrane.Time.non_neg() | :no_interval}
   | {timer_id :: any(),
      interval :: Ratio.t() | Membrane.Time.non_neg() | :no_interval,
      clock :: Membrane.Clock.t()}}

Starts a timer that will invoke Membrane.Pipeline.handle_tick/3 callback every interval according to the given clock.

The timer's id is passed to the Membrane.Pipeline.handle_tick/3 callback and can be used for changing its interval via timer_interval/0 or stopping it via stop_timer/0.

If interval is set to :no_interval, the timer won't issue any ticks until the interval is set with timer_interval/0 action.

If no clock is passed, pipeline clock is chosen.

Timers use Process.send_after/3 under the hood.

@type stop_timer() :: {:stop_timer, timer_id :: any()}

Stops a timer started with start_timer/0 action.

This action is atomic: stopping timer guarantees that no ticks will arrive from it.

Type describing actions that can be returned from pipeline callbacks.

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

@type terminate() ::
  {:terminate, reason :: :normal | :shutdown | {:shutdown, term()} | term()}

Terminates the pipeline with given reason.

Termination reason follows the OTP semantics:

  • Use :normal for graceful termination. If the pipeline has no children, it terminates immediately. Otherwise, it switches to the zombie mode, requests all the children to terminate, waits for them to terminate and then terminates itself. In the zombie mode, no pipeline callbacks are called and all messages and calls to the pipeline are ignored (apart from Membrane internal messages)
  • If the reason is other than :normal, the pipeline terminates immediately. The pipeline supervisor terminates all the children with the reason :shutdown
  • If the reason is neither :normal, :shutdown nor {:shutdown, term}, an error is logged
@type timer_interval() ::
  {:timer_interval,
   {timer_id :: any(),
    interval :: Ratio.t() | Membrane.Time.non_neg() | :no_interval}}

Changes interval of a timer started with start_timer/0.

Permitted only from Membrane.Pipeline.handle_tick/3, unless the interval was previously set to :no_interval.

If the interval is :no_interval, the timer won't issue any ticks until another timer_interval/0 action. Otherwise, the timer will issue ticks every new interval. The next tick after interval change is scheduled at new_interval + previous_time, where previous_time is the time of the latest tick or the time of returning start_timer/0 action if no tick has been sent yet. Note that if current_time - previous_time > new_interval, a burst of div(current_time - previous_time, new_interval) ticks is issued immediately.