Membrane Core
v1.0.1

View Source Membrane.Event (Membrane Core v1.0.1)

Event is an entity that can be sent between elements.

Events can flow either downstream or upstream - they can be sent with Membrane.Element.Action.event/0, and can be handled in Membrane.Element.Base.handle_event/4. Each event is to implement Membrane.EventProtocol, which allows to configure its behaviour.

Summary

Types

t()

Event is an entity that can be sent between elements.

Functions

async?(event)

See Membrane.EventProtocol.async?/1.

event?(event)
sticky?(event)

See Membrane.EventProtocol.sticky?/1.

Types

Link to this type

t()

View Source 
@type t() :: Membrane.EventProtocol.t()

Event is an entity that can be sent between elements.

Events can flow either downstream or upstream - they can be sent with Membrane.Element.Action.event/0, and can be handled in Membrane.Element.Base.handle_event/4. Each event is to implement Membrane.EventProtocol, which allows to configure its behaviour.

Functions

Link to this function

async?(event)

View Source

See Membrane.EventProtocol.async?/1.

Link to this function

event?(event)

View Source 
@spec event?(t()) :: boolean()
Link to this function

sticky?(event)

View Source

See Membrane.EventProtocol.sticky?/1.