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

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.

Summary

Types

t()

The Membrane event, based on the Membrane.EventProtocol.

Types

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

The Membrane event, based on the Membrane.EventProtocol.

Functions

See Membrane.EventProtocol.async?/1.

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

Checks if the given argument is a Membrane event.

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

See Membrane.EventProtocol.sticky?/1.