tcpserversink

Example launch line (server):

 gst-launch-1.0 fdsrc fd=1 ! tcpserversink port=3000

Example launch line (client):

 gst-launch-1.0 tcpclientsrc port=3000 ! fdsink fd=2

Hierarchy

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstElement
                ╰──GstBaseSink
                    ╰──GstMultiHandleSink
                        ╰──GstMultiSocketSink
                            ╰──tcpserversink

Factory details

Authors: – Thomas Vander Stichele

Classification:Sink/Network

Rank – none

Plugin – gsttcp

Package – GStreamer Base Plug-ins

Pad Templates

sink

ANY

Presencealways

Directionsink

Object typeGstPad


Signals

add

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

Parameters:

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

Flags: Run Last / Action


add-full

add_full_callback (GstElement * param_0,
                   GSocket * arg0,
                   GstMultiHandleSinkSyncMethod * arg1,
                   GstFormat * arg2,
                   guint64 arg3,
                   GstFormat * arg4,
                   guint64 arg5,
                   gpointer udata)
def add_full_callback (param_0, arg0, arg1, arg2, arg3, arg4, arg5, udata):
    #python callback for the 'add-full' signal
function add_full_callback(param_0: GstElement * param_0, arg0: GSocket * arg0, arg1: GstMultiHandleSinkSyncMethod * arg1, arg2: GstFormat * arg2, arg3: guint64 arg3, arg4: GstFormat * arg4, arg5: guint64 arg5, udata: gpointer udata): {
    // javascript callback for the 'add-full' signal
}

Parameters:

param_0
No description available
arg0
No description available
arg1
No description available
arg2
No description available
arg3
No description available
arg4
No description available
arg5
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,
                       GObject * arg0,
                       gpointer udata)
def client_added_callback (param_0, arg0, udata):
    #python callback for the 'client-added' signal
function client_added_callback(param_0: GstElement * param_0, arg0: GObject * arg0, udata: gpointer udata): {
    // javascript callback for the 'client-added' signal
}

Parameters:

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

Flags: Run Last


client-removed

client_removed_callback (GstElement * param_0,
                         GSocket * arg0,
                         GstMultiHandleSinkClientStatus * 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: GSocket * arg0, arg1: GstMultiHandleSinkClientStatus * 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


client-socket-removed

client_socket_removed_callback (GstElement * param_0,
                                GSocket * arg0,
                                gpointer udata)
def client_socket_removed_callback (param_0, arg0, udata):
    #python callback for the 'client-socket-removed' signal
function client_socket_removed_callback(param_0: GstElement * param_0, arg0: GSocket * arg0, udata: gpointer udata): {
    // javascript callback for the 'client-socket-removed' signal
}

Parameters:

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

Flags: Run Last


get-stats

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

Parameters:

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

Flags: Run Last / Action


remove

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

Parameters:

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

Flags: Run Last / Action


remove-flush

remove_flush_callback (GstElement * param_0,
                       GSocket * arg0,
                       gpointer udata)
def remove_flush_callback (param_0, arg0, udata):
    #python callback for the 'remove-flush' signal
function remove_flush_callback(param_0: GstElement * param_0, arg0: GSocket * arg0, udata: gpointer udata): {
    // javascript callback for the 'remove-flush' signal
}

Parameters:

param_0
No description available
arg0
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


blocksize

“blocksize” guint

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

Flags : Read / Write

Default value : 4096


buffers-max

“buffers-max” gint

max number of buffers to queue for a client (-1 = no limit)

Flags : Read / Write

Default value : -1


buffers-min

“buffers-min” gint

min number of buffers to queue (-1 = as few as possible)

Flags : Read / Write

Default value : -1


buffers-queued

“buffers-queued” guint

Number of buffers currently queued

Flags : Read

Default value : 0


buffers-soft-max

“buffers-soft-max” gint

Recover client when going over this limit (-1 = no limit)

Flags : Read / Write

Default value : -1


burst-format

“burst-format” GstFormat *

The format of the burst units (when sync-method is burst[[-with]-keyframe])

Flags : Read / Write

Default value : undefined (0)


burst-value

“burst-value” guint64

The amount of burst expressed in burst-format

Flags : Read / Write

Default value : 0


bytes-min

“bytes-min” gint

min number of bytes to queue (-1 = as little as possible)

Flags : Read / Write

Default value : -1


bytes-served

“bytes-served” guint64

Total number of bytes send 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


current-port

“current-port” gint

The port number the socket is currently bound to. Applications can use this property to retrieve the port number actually bound to in case the port requested was 0 (=allocate a random available port).

Flags : Read

Default value : 0


enable-last-sample

“enable-last-sample” gboolean

Enable the last-sample property

Flags : Read / Write

Default value : true


host

“host” gchararray

The host/IP to listen on

Flags : Read / Write

Default value : localhost


last-sample

“last-sample” GstSample *

The last sample received in the sink

Flags : Read


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


num-handles

“num-handles” guint

The current number of client handles

Flags : Read

Default value : 0


port

“port” gint

The port to listen to (0=random available port)

Flags : Read / Write

Default value : 4953


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


recover-policy

“recover-policy” GstMultiHandleSinkRecoverPolicy *

How to recover when client reaches the soft max

Flags : Read / Write

Default value : none (0)


render-delay

“render-delay” guint64

Additional render delay of the sink in nanoseconds

Flags : Read / Write

Default value : 0


resend-streamheader

“resend-streamheader” gboolean

Resend the streamheader if it changes in the caps

Flags : Read / Write

Default value : true


send-dispatched

“send-dispatched” gboolean

If GstNetworkMessageDispatched events should be pushed

Flags : Read / Write

Default value : false


send-messages

“send-messages” gboolean

If GstNetworkMessage events should be pushed

Flags : Read / Write

Default value : false


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


sync-method

“sync-method” GstMultiHandleSinkSyncMethod *

How to sync new clients to the stream

Flags : Read / Write

Default value : latest (0)


throttle-time

“throttle-time” guint64

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

Flags : Read / Write

Default value : 0


time-min

“time-min” gint64

min amount of time to queue (in nanoseconds) (-1 = as little as possible)

Flags : Read / Write

Default value : 18446744073709551615


timeout

“timeout” guint64

Maximum inactivity timeout in nanoseconds for a client (0 = no limit)

Flags : Read / Write

Default value : 0


ts-offset

“ts-offset” gint64

Timestamp offset in nanoseconds

Flags : Read / Write

Default value : 0


unit-format

“unit-format” GstFormat *

The unit to measure the max/soft-max/queued properties

Flags : Read / Write

Default value : buffers (4)


units-max

“units-max” gint64

max number of units to queue (-1 = no limit)

Flags : Read / Write

Default value : 18446744073709551615


units-soft-max

“units-soft-max” gint64

Recover client when going over this limit (-1 = no limit)

Flags : Read / Write

Default value : 18446744073709551615


Named constants

GstMultiHandleSinkClientStatus

Members

ok (0) – ok
closed (1) – Closed
removed (2) – Removed
slow (3) – Too slow
error (4) – Error
duplicate (5) – Duplicate
flushing (6) – Flushing

GstMultiHandleSinkRecoverPolicy

Members

none (0) – Do not try to recover
latest (1) – Resync client to latest buffer
soft-limit (2) – Resync client to soft limit
keyframe (3) – Resync client to most recent keyframe

GstMultiHandleSinkSyncMethod

Members

latest (0) – Serve starting from the latest buffer
next-keyframe (1) – Serve starting from the next keyframe
latest-keyframe (2) – Serve everything since the latest keyframe (burst)
burst (3) – Serve burst-value data to client
burst-keyframe (4) – Serve burst-value data starting on a keyframe
burst-with-keyframe (5) – Serve burst-value data preferably starting on a keyframe

The results of the search are