Settings API Reference Membrane Core v0.10.2

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 pipeline when a crash group is down.

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

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

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 of the bin when it changes playback state

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

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

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

Describes capabilities of some pad.

Module that allows to specify valid caps and verify that they match specification.

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

Struct describing child entry of a parent.

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.ParentSpec.

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 receiving information about new caps for given pad.

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.

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 of the element when it changes playback state

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

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

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.

Generic event for requesting a key frame.

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

A notification is a message sent from Membrane.Element to a parent via action Membrane.Element.Action.notify_t/0 returned from any callback.

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

Structure representing the topology of a pipeline/bin.

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 bin when a crash group is down.

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

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

Structure representing a context that is passed to the callback of the pipeline when it changes its playback state

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

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

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

Playback states describe the state of an element or a pipeline. There are following playback states

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

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 changes its playback state

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

Message sent when the pipeline gracefully terminates.

Membrane.RemoteControlled.Pipeline is a 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.

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.

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

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 state changes and received notifications.

@deprecated Structure representing options passed to testing pipeline.

Structure representing state.

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.