View Source Membrane.Payload protocol (Membrane Core v1.1.1)

This protocol describes actions common to all payload types.

The most basic payload type is simply a binary for which Elixir.Membrane.Payload is implemented by the Membrane Core.

Summary

Types

t()

A type describing all the types that implement Membrane.Payload protocol.

Functions

concat(left, right)

Concatenates the contents of two payloads.

drop(payload, n)

Drops first n bytes of payload.

module(payload)

Returns a module responsible for this type of payload and implementing Membrane.Payload.Behaviour

size(payload)

Returns total size of payload in bytes

split_at(payload, at_pos)

Splits the payload at given position (1st part has the size equal to at_pos argument)

to_binary(payload)

Converts payload into binary

Types

t()

@type t() :: any()

A type describing all the types that implement Membrane.Payload protocol.

Functions

concat(left, right)

@spec concat(left :: t(), right :: t()) :: t()

Concatenates the contents of two payloads.

drop(payload, n)

@spec drop(payload :: t(), n :: non_neg_integer()) :: t()

Drops first n bytes of payload.

module(payload)

@spec module(t()) :: module()

Returns a module responsible for this type of payload and implementing Membrane.Payload.Behaviour

size(payload)

@spec size(payload :: t()) :: non_neg_integer()

Returns total size of payload in bytes

split_at(payload, at_pos)

@spec split_at(payload :: t(), at_pos :: pos_integer()) :: {t(), t()}

Splits the payload at given position (1st part has the size equal to at_pos argument)

at_pos has to be greater than 0 and smaller than the size of payload, otherwise an error is raised. This guarantees returned payloads are never empty.

to_binary(payload)

@spec to_binary(t()) :: binary()

Converts payload into binary