Membrane Core v0.3.0 API Reference
Modules
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
Buffer that is attached to the :input
pad when working in a :pull
mode
Module containing functions spawning, shutting down, inspecting and controlling playback of elements
This module contains type specifications of actions that can be returned from element callbacks
Modules in this namespace contain behaviours, default callback implementations and other stuff useful when creating elements
Module defining behaviour for filters - elements processing data
Module defining behaviour common to all elements
Module defining behaviour for sink and filter elements
Module defining behaviour for source and filter elements
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
Parent module for all contexts passed to callbacks
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 when new pad added is created
Structure representing a context that is passed to the element when when new pad added is created
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 new buffer arrives to the sink
Pads are units defined by each element, allowing it to be linked with another elements. This module consists of pads typespecs and utils
Struct describing current pad state
Event is an entity that can be sent between elements
Generic discontinuity event
Generic End of Stream event
Generic Start of Stream event
Generic underrun event
Protocol that allows to configure behaviour of Membrane.Event
s
Default implementation of Membrane.EventProtocol
Mixin for logging using simple functions such as info/1, debug/1 in other modules
Module containing functions spawning, shutting down, and handling messages sent to logger
This is a base module used by all logger implementations
Defines a router that dispatches logs to instances of Membrane.Log.Logger.Base
Module responsible for supervising router_level loggers. It is also responsible for receiving and routing log messages to appropriate loggers
A notification is a message sent from Membrane.Element
to a Membrane.Pipeline
via action Membrane.Element.Action.notify_t/0
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
Structure representing topology of a pipeline
Testing Element for supplying data from list passed through options
Empty event that can be used in tests
This Pipeline was created to reduce testing boilerplate and ease communication with it's elements.
It also provides utility for receiving messages when Pipeline
playback state changes
and notifications it receives
Assertions that can be used with Membrane.Testing.Pipeline
in tests
Structure representing options
passed to testing pipeline
Sink Element that will send every buffer it receives to the pid passed as argument
Testing Element for supplying data based on generator function passed through options
Module containing functions needed to perform handling of time