Membrane.Element.UDP.Source (Membrane Element: UDP v0.6.1) View Source

Element that reads packets from a UDP socket and sends their payloads through the output pad.

Element options

Passed via struct Membrane.Element.UDP.Source.t/0

  • local_port_no

    pos_integer

    Default value: 5000
    A UDP port number used when opening a receiving socket.

  • local_address

    :inet.socket_address()

    Default value: :any
    An IP Address on which the socket will listen. It allows to choose which network interface to use if there's more than one.

  • recv_buffer_size

    pos_integer

    Default value: 16384
    Size of the receive buffer. Packages of size greater than this buffer will be truncated

Pads

:output

Availability:always
CapsMembrane.RemoteStream, restrictions:<br />&nbsp;&nbsp;type: :packetized
Direction:output
Mode:push
Name:output

Link to this section Summary

Types

t()

Struct containing options for Membrane.Element.UDP.Source

Functions

Returns pads descriptions for Membrane.Element.UDP.Source

Returns description of options available for this module

Link to this section Types

Specs

t() :: %Membrane.Element.UDP.Source{
  local_address: :inet.socket_address(),
  local_port_no: pos_integer(),
  recv_buffer_size: pos_integer()
}

Struct containing options for Membrane.Element.UDP.Source

Link to this section Functions

Specs

membrane_pads() :: [{Membrane.Pad.name_t(), Membrane.Pad.description_t()}]

Returns pads descriptions for Membrane.Element.UDP.Source

Specs

options() :: keyword()

Returns description of options available for this module