Testing Element for supplying data based on generator function or payloads passed through options.

example-usage

Example usage

As mentioned earlier you can use this element in one of two ways, providing either a generator function or an Enumerable.t.

If you provide an Enumerable.t with payloads, then each of those payloads will be wrapped in a Membrane.Buffer and sent through :output pad.

%Source{output: [0xA1, 0xB2, 0xC3, 0xD4]}

In order to specify Membrane.Testing.Source with generator function you need to provide initial state and function that matches generator/0 type. This function should take state and demand size as its arguments and return a tuple consisting of actions that element will return during the Membrane.Element.WithOutputPads.handle_demand/5 callback and new state.

generator_function = fn state, size ->
  #generate some buffers
  {actions, state + 1}
end
%Source{output: {1, generator_function}}

element-options

Element options

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

• output

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

  Default value: {0, &Membrane.Testing.Source.default_buf_gen/2}
  If output is an Enumerable, then each element of it will be sent through the :output pad, followed by Membrane.Element.Action.end_of_stream/0. Each element of the Enumerable must be either Membrane.Buffer.t/0 or Membrane.Payload.t/0. In the latter case, it will be automatically wrapped into Membrane.Buffer.t/0 before sending.

  Otherwise, 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}
  StreamFormat to be sent before the output.

pads

Pads

output

:output

Accepted formats:

_any