udpsink

udpsink is a network sink that sends UDP packets to the network. It can be combined with RTP payloaders to implement RTP streaming.

Examples

 gst-launch-1.0 -v audiotestsrc ! udpsink

Hierarchy

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstElement
                ╰──GstBaseSink
                    ╰──GstMultiUDPSink
                        ╰──udpsink

Factory details

Authors: – Wim Taymans

Classification:Sink/Network

Rank – none

Plugin – gstudp

Package – GStreamer Good Plug-ins

Pad Templates

sink

ANY

Presencealways

Directionsink

Object typeGstPad


Signals

add

add_callback (GstElement * param_0,
              gchararray arg0,
              gint arg1,
              gpointer udata)
def add_callback (param_0, arg0, arg1, udata):
    #python callback for the 'add' signal
function add_callback(param_0: GstElement * param_0, arg0: gchararray arg0, arg1: gint arg1, udata: gpointer udata): {
    // javascript callback for the 'add' signal
}

Parameters:

param_0
No description available
arg0
No description available
arg1
No description available
udata
No description available

Flags: Run Last / Action


clear

clear_callback (GstElement * param_0,
                gpointer udata)
def clear_callback (param_0, udata):
    #python callback for the 'clear' signal
function clear_callback(param_0: GstElement * param_0, udata: gpointer udata): {
    // javascript callback for the 'clear' signal
}

Parameters:

param_0
No description available
udata
No description available

Flags: Run Last / Action


client-added

client_added_callback (GstElement * param_0,
                       gchararray arg0,
                       gint arg1,
                       gpointer udata)
def client_added_callback (param_0, arg0, arg1, udata):
    #python callback for the 'client-added' signal
function client_added_callback(param_0: GstElement * param_0, arg0: gchararray arg0, arg1: gint arg1, udata: gpointer udata): {
    // javascript callback for the 'client-added' signal
}

Parameters:

param_0
No description available
arg0
No description available
arg1
No description available
udata
No description available

Flags: Run Last


client-removed

client_removed_callback (GstElement * param_0,
                         gchararray arg0,
                         gint arg1,
                         gpointer udata)
def client_removed_callback (param_0, arg0, arg1, udata):
    #python callback for the 'client-removed' signal
function client_removed_callback(param_0: GstElement * param_0, arg0: gchararray arg0, arg1: gint arg1, udata: gpointer udata): {
    // javascript callback for the 'client-removed' signal
}

Parameters:

param_0
No description available
arg0
No description available
arg1
No description available
udata
No description available

Flags: Run Last


get-stats

GstStructure *
get_stats_callback (GstElement * param_0,
                    gchararray arg0,
                    gint arg1,
                    gpointer udata)
def get_stats_callback (param_0, arg0, arg1, udata):
    #python callback for the 'get-stats' signal
function get_stats_callback(param_0: GstElement * param_0, arg0: gchararray arg0, arg1: gint arg1, udata: gpointer udata): {
    // javascript callback for the 'get-stats' signal
}

Parameters:

param_0
No description available
arg0
No description available
arg1
No description available
udata
No description available
Returns ( GstStructure * ) –
No description available

Flags: Run Last / Action


remove

remove_callback (GstElement * param_0,
                 gchararray arg0,
                 gint arg1,
                 gpointer udata)
def remove_callback (param_0, arg0, arg1, udata):
    #python callback for the 'remove' signal
function remove_callback(param_0: GstElement * param_0, arg0: gchararray arg0, arg1: gint arg1, udata: gpointer udata): {
    // javascript callback for the 'remove' signal
}

Parameters:

param_0
No description available
arg0
No description available
arg1
No description available
udata
No description available

Flags: Run Last / Action


Properties

async

“async” gboolean

Go asynchronously to PAUSED

Flags : Read / Write

Default value : true


auto-multicast

“auto-multicast” gboolean

Automatically join/leave the multicast groups, FALSE means user has to do it himself

Flags : Read / Write

Default value : true


bind-address

“bind-address” gchararray

Address to bind the socket to

Flags : Read / Write

Default value : NULL


bind-port

“bind-port” gint

Port to bind the socket to

Flags : Read / Write

Default value : 0


blocksize

“blocksize” guint

Size in bytes to pull per buffer (0 = default)

Flags : Read / Write

Default value : 4096


buffer-size

“buffer-size” gint

Size of the kernel send buffer in bytes, 0=default

Flags : Read / Write

Default value : 0


bytes-served

“bytes-served” guint64

Total number of bytes sent to all clients

Flags : Read

Default value : 0


bytes-to-serve

“bytes-to-serve” guint64

Number of bytes received to serve to clients

Flags : Read

Default value : 0


clients

“clients” gchararray

A comma separated list of host:port pairs with destinations

Flags : Read / Write

Default value : localhost:5004


close-socket

“close-socket” gboolean

Close socket if passed as property on state change

Flags : Read / Write

Default value : true


enable-last-sample

“enable-last-sample” gboolean

Enable the last-sample property

Flags : Read / Write

Default value : true


force-ipv4

“force-ipv4” gboolean

Forcing the use of an IPv4 socket (DEPRECATED, has no effect anymore)

Flags : Read / Write

Default value : false


host

“host” gchararray

The host/IP/Multicast group to send the packets to

Flags : Read / Write

Default value : localhost


last-sample

“last-sample” GstSample *

The last sample received in the sink

Flags : Read


loop

“loop” gboolean

Used for setting the multicast loop parameter. TRUE = enable, FALSE = disable

Flags : Read / Write

Default value : true


max-bitrate

“max-bitrate” guint64

The maximum bits per second to render (0 = disabled)

Flags : Read / Write

Default value : 0


max-lateness

“max-lateness” gint64

Maximum number of nanoseconds that a buffer can be late before it is dropped (-1 unlimited)

Flags : Read / Write

Default value : 18446744073709551615


multicast-iface

“multicast-iface” gchararray

The network interface on which to join the multicast group

Flags : Read / Write

Default value : NULL


port

“port” gint

The port to send the packets to

Flags : Read / Write

Default value : 5004


processing-deadline

“processing-deadline” guint64

Maximum processing time for a buffer in nanoseconds

Flags : Read / Write

Default value : 20000000


qos

“qos” gboolean

Generate Quality-of-Service events upstream

Flags : Read / Write

Default value : false


qos-dscp

“qos-dscp” gint

Quality of Service, differentiated services code point (-1 default)

Flags : Read / Write

Default value : -1


render-delay

“render-delay” guint64

Additional render delay of the sink in nanoseconds

Flags : Read / Write

Default value : 0


send-duplicates

“send-duplicates” gboolean

When a distination/port pair is added multiple times, send packets multiple times as well

Flags : Read / Write

Default value : true


socket

“socket” GSocket *

Socket to use for UDP sending. (NULL == allocate)

Flags : Read / Write


socket-v6

“socket-v6” GSocket *

Socket to use for UDPv6 sending. (NULL == allocate)

Flags : Read / Write


stats

“stats” GstStructure *

Sink Statistics

Flags : Read

Default value :

application/x-gst-base-sink-stats, average-rate=(double)0, dropped=(guint64)0, rendered=(guint64)0;

sync

“sync” gboolean

Sync on the clock

Flags : Read / Write

Default value : true


throttle-time

“throttle-time” guint64

The time to keep between rendered buffers (0 = disabled)

Flags : Read / Write

Default value : 0


ts-offset

“ts-offset” gint64

Timestamp offset in nanoseconds

Flags : Read / Write

Default value : 0


ttl

“ttl” gint

Used for setting the unicast TTL parameter

Flags : Read / Write

Default value : 64


ttl-mc

“ttl-mc” gint

Used for setting the multicast TTL parameter

Flags : Read / Write

Default value : 1


used-socket

“used-socket” GSocket *

Socket currently in use for UDP sending. (NULL == no socket)

Flags : Read


used-socket-v6

“used-socket-v6” GSocket *

Socket currently in use for UDPv6 sending. (NULL == no socket)

Flags : Read


The results of the search are