Settings API Reference Membrane Core v0.11.3

Bins, similarly to pipelines, are containers for elements. However, at the same time, they can be placed and linked within pipelines. Although bin is a separate Membrane entity, it can be perceived as a pipeline within an element. Bins can also be nested within one another.

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

Structure representing a context that is passed to the callback when bin receives child notification.

Structure representing a context that is passed to the pipeline when a crash group is down.

Structure representing a context that is passed to the callback when bin receives unrecognized message.

Callback context for Membrane.Bin.handle_init/2.

Structure representing a context that is passed to the bin when a new dynamic pad instance added is created

Structure representing a context that is passed to the bin when a dynamic pad is removed

Structure representing a context that is passed to the callback when bin receives parent notification.

Structure representing a context that is passed to the Membrane.Bin.handle_playing/2 callback.

Structure representing a context that is passed to the Membrane.Bin.handle_setup/2 callback.

Structure representing a context that is passed to the callback of the bin when it instantiates children and links them according to Membrane.ChildrenSpec

Structure representing a context that is passed to the bin when handling start and end of stream events.

Callback context for Membrane.Bin.handle_terminate_request/2.

Structure representing a context that is passed to the callback when bin handles timer tick.

Struct describing current pad state.

Structure representing a single chunk of data that flows between elements.

Specifies API for metrics that analyze data in terms of a given unit

Implementation of Membrane.Buffer.Metric for the :bytes unit

Implementation of Membrane.Buffer.Metric for the :buffers unit

Module that keeps track of types used by both elements and bins

Struct describing child entry of a parent.

A child notification is a message sent from Membrane.Element or Membrane.Bin to a parent via action t:Membrane.Element.Action.notify_parent_t or t:Membrane.Bin.Action.notify_parent_t returned from any callback.

A module with functionalities that allow to represent a topology of a pipeline/bin.

Clock is a Membrane utility that allows elements to measure time according to a particular clock, which can be e.g. a soundcard hardware clock.

Traces element's path inside a pipeline. Path is a list consisted of following pipeline/bin/element names down the assembled pipeline. Information is being stored in a process dictionary and can be set/appended to.

Module containing types and functions for operating on crash groups. Crash groups can be used through Membrane.ChildrenSpec.

Module containing types and functions for operating on elements.

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

Module defining behaviour common to all elements.

Structure representing a context that is passed to the element when processing incoming demand.

Structure representing a context that is passed to the element when handling event.

Structure representing a context that is passed to the callback when element receives unrecognized message.

Callback context for Membrane.Element.Base.handle_init/2.

Structure representing a context that is passed to the element when a new dynamic pad instance is created

Structure representing a context that is passed to the element when a dynamic pad is removed

Structure representing a context that is passed to the callback when element receives parent notification.

Structure representing a context that is passed to the Membrane.Element.Base.handle_playing/2 callback.

Structure representing a context that is passed to the element when new buffer arrives.

Structure representing a context that is passed to the Membrane.Element.Base.handle_setup/2 callback.

Structure representing a context that is passed to the element when receiving information about new stream format for given pad.

Structure representing a context that is passed to the element when handling start and end of stream events.

Callback context for Membrane.Element.Base.handle_terminate_request/2.

Structure representing a context that is passed to the callback when element handles timer tick.

Structure representing a context that is passed to the element when new buffer arrives to the sink or the endpoint.

Struct describing current pad state.

Module defining behaviour for sink, filter and endpoint elements.

Module defining behaviour for source and filter elements.

Module defining behaviour for endpoints - elements consuming and producing data.

Event is an entity that can be sent between elements.

Generic discontinuity event.

Generic underrun event.

Protocol that allows to configure behaviour of Membrane.Events.

Default implementation of Membrane.EventProtocol.

Module defining behaviour for filters - elements processing data.

An element allowing to aggregate many filters within one Elixir process.

Generic event for requesting a key frame.

Wrapper around the Elixir logger. Adds Membrane prefixes and handles verbose logging.

Pads are units defined by elements and bins, allowing them to be linked with their siblings. This module consists of pads typespecs and utils.

A parent notification is a message sent from Membrane.Parent or Membrane.Bin to a child via action t:Membrane.Pipeline.Action.notify_parent_t or t:Membrane.Bin.Action.notify_child_t returned from any callback.

This protocol describes actions common to all payload types.

Behaviour that should be implemented by every module that has Membrane.Payload protocol implementation.

Membrane.Payload.Behaviour implementation for binary payload. Complements Membrane.Payload protocol implementation.

Module containing functions for constructing and supervising pipelines.

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

Structure representing a context that is passed to the callback when the pipeline is called with a synchronous call.

Structure representing a context that is passed to the callback when pipeline receives a child notification.

Structure representing a context that is passed to the bin when a crash group is down.

Structure representing a context that is passed to the callback when pipeline receives an unrecognized message.

Callback context for Membrane.Pipeline.handle_init/2.

Structure representing a context that is passed to the Membrane.Pipeline.handle_playing/2 callback.

Structure representing a context that is passed to the Membrane.Pipeline.handle_setup/2 callback.

Structure representing a context that is passed to the callback of the pipeline when it instantiates children and links them according to Membrane.ChildrenSpec

Structure representing a context that is passed to the pipeline when handling start and end of stream events.

Callback context for Membrane.Pipeline.handle_terminate_request/2.

Structure representing a context that is passed to the callback when pipeline handles timer tick.

Playback defines whether media is processed within a pipeline (:playing) or not (:stopped).

An abstract module aggregating all the messages that can be sent by the RemoteControlled.Pipeline.

Message sent when some element of the pipeline receives the start of stream event on some pad.

Message sent when the some element of the pipeline receives a notification.

Message sent when the pipeline starts playing

Message sent when some element of the pipeline receives the start of stream event on some pad.

Message sent when the pipeline gracefully terminates.

Basic Membrane.Pipeline implementation that can be controlled by a controlling process.

Format describing an unparsed data stream. It should be used whenever outputting or accepting an unknown stream (not to be confused with any stream, which can have well-specified format either), or a stream whose format can't/shouldn't be created at that stage.

Utility for handling resources that must be cleaned up after use.

Module defining behaviour for sinks - elements consuming data.

Module that should be used in sources - elements producing data. Declares appropriate behaviours implementation and provides default callbacks implementation.

Describes capabilities of some pad.

Sync allows to synchronize multiple processes, so that they could perform their jobs at the same time.

Defines basic telemetry event types used by Membrane's Core.

This module contains a set of assertion functions and macros.

Testing Element for supplying data based on generator function or payloads passed through options. It is very similar to Membrane.Testing.Source but is has dynamic pad instead of static.

Membrane element.

Empty event that can be used in tests

Mock for Membrane.ResourceGuard.

This Pipeline was created to reduce testing boilerplate and ease communication with its children. It also provides a utility for informing testing process about playback changes and received notifications.

Sink Element that notifies the pipeline about buffers and events it receives.

Testing Element for supplying data based on generator function or payloads passed through options.

Module containing functions needed to perform handling of time.

A supervisor that allows to start utility processes under the pipeline's supervision tree.