View Source Membrane.UDP.Endpoint (Membrane UDP plugin v0.13.0)

Element that sends buffers received on the input pad over a UDP socket and reads packets from a UDP socket and sends their payloads through the output pad.

Element options

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

  • destination_address

    :inet.ip_address()

    Required
    An IP Address that the packets will be sent to.

  • destination_port_no

    :inet.port_number()

    Required
    A UDP port number of a target.

  • local_address

    :inet.socket_address()

    Default value: :any
    This address is used in two cases:

    • An IP Address set for a UDP socket used to sent packets.
    • An IP Address on which the socket will listen. In both cases, it allows to choose which network interface to use if there's more than one.
  • local_port_no

    :inet.port_number()

    Default value: 0
    A UDP port number used when opening a receiving socket and for sending packets.

  • recv_buffer_size

    pos_integer()

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

Pads

:input

Accepted formats:

_any
Direction::input
Availability::always
Flow control::auto

:output

Accepted formats:

%RemoteStream{type: :packetized}
Direction::output
Availability::always
Flow control::push

Summary

Types

t()

Struct containing options for Membrane.UDP.Endpoint

Functions

Returns description of options available for this module

Types

@type t() :: %Membrane.UDP.Endpoint{
  destination_address: :inet.ip_address(),
  destination_port_no: :inet.port_number(),
  local_address: :inet.socket_address(),
  local_port_no: :inet.port_number(),
  recv_buffer_size: pos_integer()
}

Struct containing options for Membrane.UDP.Endpoint

Functions

@spec options() :: keyword()

Returns description of options available for this module