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

Represents a communication event, capable of flowing both downstream and upstream.

Events are dispatched using Membrane.Element.Action.event/0 and are handled via the Membrane.Element.Base.handle_event/4 callback. Each event must conform to the Membrane.EventProtocol to ensure the proper configuration of its behaviour.

Link to this section Summary

t()

The Membrane event, based on the Membrane.EventProtocol.

async?(event)

event?(event)

Checks if the given argument is a Membrane event.

sticky?(event)

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

The Membrane event, based on the Membrane.EventProtocol.

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

Checks if the given argument is a Membrane event.

Returns true if the event implements the Membrane.EventProtocol, otherwise false.