View Source Membrane.Event (Membrane Core v0.12.8)

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.

Link to this section 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.

Link to this section Types

t()

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

Link to this section Functions

async?(event)

See Membrane.EventProtocol.async?/1.

event?(event)

@spec event?(t()) :: boolean()

sticky?(event)

See Membrane.EventProtocol.sticky?/1.