Membrane Core v0.11.2

View Source Membrane.Testing.Endpoint (Membrane Core v0.11.2)

Membrane element.

element-options

 Element options

Passed via struct Membrane.Testing.Endpoint.t/0

  • autodemand 

    boolean()

    Default value: true
    If true element will automatically make demands. If it is set to false demand has to be triggered manually by sending :make_demand message.

  • output 

    {initial_state :: any(), generator} | Enum.t()

    Default value: {0, &Membrane.Testing.Endpoint.default_buf_gen/2}
    If output is an enumerable with Membrane.Payload.t/0 then buffer containing those payloads will be sent through the :output pad and followed by Membrane.Element.Action.end_of_stream_t/0.

    If output is a {initial_state, function} tuple then the the function will be invoked each time handle_demand is called. It is an action generator that takes two arguments. The first argument is the state that is initially set to initial_state. The second one defines the size of the demand. Such function should return {actions, next_state} where actions is a list of actions that will be returned from handle_demand/4 and next_state is the value that will be used for the next call.

  • stream_format 

    struct()

    Default value: %Membrane.RemoteStream{content_format: nil, type: :bytestream}
    Stream format to be sent before the output.

pads

 Pads

input

 :input

Accepted formats:

_any
Direction::input
Availability::always
Mode::pull
Demand mode::manual
Demand unit::buffers

output

 :output

Accepted formats:

_any
Direction::output
Availability::always
Mode::pull
Demand mode::manual

Link to this section Summary

Types

generator()
t()

Struct containing options for Membrane.Testing.Endpoint

Functions

default_buf_gen(generator_state, size)
options()

Returns description of options available for this module

output_from_buffers(data)

Creates output with generator function from list of buffers.

Link to this section Types

Link to this type

generator()

View Source 
@type generator() ::
  (state :: any(), buffers_cnt :: pos_integer() ->
     {[Membrane.Element.Action.t()], state :: any()})
Link to this type

t()

View Source 
@type t() :: %Membrane.Testing.Endpoint{
  autodemand: boolean(),
  output: {initial_state :: any(), generator()} | Enum.t(),
  stream_format: struct()
}

Struct containing options for Membrane.Testing.Endpoint

Link to this section Functions

Link to this function

default_buf_gen(generator_state, size)

View Source 
@spec default_buf_gen(integer(), integer()) ::
  {[Membrane.Element.Action.t()], integer()}
Link to this function

options()

View Source 
@spec options() :: keyword()

Returns description of options available for this module

Link to this function

output_from_buffers(data)

View Source 
@spec output_from_buffers([Membrane.Buffer.t()]) ::
  {[Membrane.Buffer.t()], generator()}

Creates output with generator function from list of buffers.