multiudpsink

multiudpsink — Send data over the network via UDP

Synopsis




                    GstUDPClient;
                    GstMultiUDPSink;

Object Hierarchy


  GObject
   +----GstObject
         +----GstOsxAudioSink
               +----GstMultiUDPSink

Properties


  "bytes-served"             guint64               : Read
  "bytes-to-serve"           guint64               : Read

Signals


  "add"                                            : Run Last
  "clear"                                          : Run Last
  "client-added"                                   : Run Last
  "client-removed"                                 : Run Last
  "get-stats"                                      : Run Last
  "remove"                                         : Run Last

Description

Element Information

plugin udp
author Wim Taymans <wim@fluendo.com>
class Sink/Network

Details

GstUDPClient

typedef struct {
  int *sock;

  struct sockaddr_in theiraddr;
  struct ip_mreq multi_addr;

  gchar *host;
  gint port;

  /* Per-client stats */
  guint64 bytes_sent;
  guint64 packets_sent;
  guint64 connect_time;
  guint64 disconnect_time;
} GstUDPClient;

GstMultiUDPSink

typedef struct _GstMultiUDPSink GstMultiUDPSink;

Property Details

The "bytes-served" property

  "bytes-served"             guint64               : Read

Total number of bytes send to all clients.

Default value: 0

The "bytes-to-serve" property

  "bytes-to-serve"           guint64               : Read

Number of bytes received to serve to clients.

Default value: 0

Signal Details

The "add" signal

void                user_function                      (GstMultiUDPSink *gstmultiudpsink,
                                                        gchar           *host,
                                                        gint             port,
                                                        gpointer         user_data)            : Run Last

Add a client with destination host and port to the list of clients.

gstmultiudpsink : the sink on which the signal is emitted
host : the hostname/IP address of the client to add
port : the port of the client to add
user_data : user data set when the signal handler was connected.

The "clear" signal

void                user_function                      (GstMultiUDPSink *gstmultiudpsink,
                                                        gpointer         user_data)            : Run Last

Clear the list of clients.

gstmultiudpsink : the sink on which the signal is emitted
user_data : user data set when the signal handler was connected.

The "client-added" signal

void                user_function                      (GstMultiUDPSink *gstmultiudpsink,
                                                        gchar           *host,
                                                        gint             port,
                                                        gpointer         user_data)            : Run Last

Signal emited when a new client is added to the list of clients.

gstmultiudpsink : the sink emitting the signal
host : the hostname/IP address of the added client
port : the port of the added client
user_data : user data set when the signal handler was connected.

The "client-removed" signal

void                user_function                      (GstMultiUDPSink *gstmultiudpsink,
                                                        gchar           *host,
                                                        gint             port,
                                                        gpointer         user_data)            : Run Last

Signal emited when a client is removed from the list of clients.

gstmultiudpsink : the sink emitting the signal
host : the hostname/IP address of the removed client
port : the port of the removed client
user_data : user data set when the signal handler was connected.

The "get-stats" signal

GValueArray*        user_function                      (GstMultiUDPSink *gstmultiudpsink,
                                                        gchar           *host,
                                                        gint             port,
                                                        gpointer         user_data)            : Run Last

Get the statistics of the client with destination host and port.

gstmultiudpsink : the sink on which the signal is emitted
host : the hostname/IP address of the client to get stats on
port : the port of the client to get stats on
user_data : user data set when the signal handler was connected.
Returns : a GValueArray of uint64: bytes_sent, packets_sent, connect_time (in epoch seconds), disconnect_time (in epoch seconds)

The "remove" signal

void                user_function                      (GstMultiUDPSink *gstmultiudpsink,
                                                        gchar           *host,
                                                        gint             port,
                                                        gpointer         user_data)            : Run Last

Remove the client with destination host and port from the list of clients.

gstmultiudpsink : the sink on which the signal is emitted
host : the hostname/IP address of the client to remove
port : the port of the client to remove
user_data : user data set when the signal handler was connected.