GstRTSPStream: GStreamer RTSP Server Reference Manual

## GstRTSPStream GstRTSPStream |

## Functions

GstRTSPStream * | gst_rtsp_stream_new ()
guint | gst_rtsp_stream_get_index ()
GstPad * | gst_rtsp_stream_get_srcpad ()
gchar * | gst_rtsp_stream_get_control ()
void | gst_rtsp_stream_set_control ()
gboolean | gst_rtsp_stream_has_control ()
guint | gst_rtsp_stream_get_mtu ()
void | gst_rtsp_stream_set_mtu ()
gint | gst_rtsp_stream_get_dscp_qos ()
void | gst_rtsp_stream_set_dscp_qos ()
void | gst_rtsp_stream_set_profiles ()
GstRTSPProfile | gst_rtsp_stream_get_profiles ()
GstRTSPLowerTrans | gst_rtsp_stream_get_protocols ()
void | gst_rtsp_stream_set_protocols ()
GstClockTime | gst_rtsp_stream_get_retransmission_time ()
void | gst_rtsp_stream_set_retransmission_time ()
void | gst_rtsp_stream_set_buffer_size ()
guint | gst_rtsp_stream_get_buffer_size ()
void | gst_rtsp_stream_set_seqnum_offset ()
guint16 | gst_rtsp_stream_get_current_seqnum ()
gboolean | gst_rtsp_stream_is_transport_supported ()
GstRTSPAddressPool * | gst_rtsp_stream_get_address_pool ()
void | gst_rtsp_stream_set_address_pool ()
GstRTSPAddress * | gst_rtsp_stream_reserve_address ()
gboolean | gst_rtsp_stream_join_bin ()
gboolean | gst_rtsp_stream_leave_bin ()
void | gst_rtsp_stream_get_server_port ()
GstRTSPAddress * | gst_rtsp_stream_get_multicast_address ()
GObject * | gst_rtsp_stream_get_rtpsession ()
void | gst_rtsp_stream_get_ssrc ()
gboolean | gst_rtsp_stream_get_rtpinfo ()
GstCaps * | gst_rtsp_stream_get_caps ()
guint | gst_rtsp_stream_get_pt ()
GstFlowReturn | gst_rtsp_stream_recv_rtcp ()
GstFlowReturn | gst_rtsp_stream_recv_rtp ()
gboolean | gst_rtsp_stream_add_transport ()
gboolean | gst_rtsp_stream_remove_transport ()
GSocket * | gst_rtsp_stream_get_rtp_socket ()
GSocket * | gst_rtsp_stream_get_rtcp_socket ()
gboolean | gst_rtsp_stream_set_blocked ()
gboolean | gst_rtsp_stream_is_blocking ()
gboolean | gst_rtsp_stream_query_stop ()
gboolean | gst_rtsp_stream_query_position ()
gboolean | gst_rtsp_stream_update_crypto ()
void | gst_rtsp_stream_set_pt_map ()
GstElement * | gst_rtsp_stream_request_aux_sender ()
GstRTSPFilterResult | (*GstRTSPStreamTransportFilterFunc) ()
GList * | gst_rtsp_stream_transport_filter ()

## Properties

gchar * | control | Read / Write
GstRTSPProfile | profiles | Read / Write
GstRTSPLowerTrans | protocols | Read / Write

## Signals

void | new-rtcp-encoder | Run Last
void | new-rtp-encoder | Run Last

## Types and Values

struct | GstRTSPStream
struct | GstRTSPStreamClass

## Object Hierarchy

        GObject
        ╰── GstRTSPStream

## Description

## Functions

### gst_rtsp_stream_new ()

    GstRTSPStream *
    gst_rtsp_stream_new (guint idx,
                         GstElement *payloader,
                         GstPad *pad);

### gst_rtsp_stream_get_index ()

    guint
    gst_rtsp_stream_get_index (GstRTSPStream *stream);

### gst_rtsp_stream_get_srcpad ()

    GstPad *
    gst_rtsp_stream_get_srcpad (GstRTSPStream *stream);

### gst_rtsp_stream_get_control ()

    gchar *
    gst_rtsp_stream_get_control (GstRTSPStream *stream);

### gst_rtsp_stream_set_control ()

    void
    gst_rtsp_stream_set_control (GstRTSPStream *stream,
                                 const gchar *control);

### gst_rtsp_stream_has_control ()

    gboolean
    gst_rtsp_stream_has_control (GstRTSPStream *stream,
                                 const gchar *control);

### gst_rtsp_stream_get_mtu ()

    guint
    gst_rtsp_stream_get_mtu (GstRTSPStream *stream);

### gst_rtsp_stream_set_mtu ()

    void
    gst_rtsp_stream_set_mtu (GstRTSPStream *stream,
                             guint mtu);

### gst_rtsp_stream_get_dscp_qos ()

    gint
    gst_rtsp_stream_get_dscp_qos (GstRTSPStream *stream);

### gst_rtsp_stream_set_dscp_qos ()

    void
    gst_rtsp_stream_set_dscp_qos (GstRTSPStream *stream,
                                  gint dscp_qos);

### gst_rtsp_stream_set_profiles ()

    void
    gst_rtsp_stream_set_profiles (GstRTSPStream *stream,
                                  GstRTSPProfile profiles);

### gst_rtsp_stream_get_profiles ()

    GstRTSPProfile
    gst_rtsp_stream_get_profiles (GstRTSPStream *stream);

### gst_rtsp_stream_get_protocols ()

    GstRTSPLowerTrans
    gst_rtsp_stream_get_protocols (GstRTSPStream *stream);

### gst_rtsp_stream_set_protocols ()

    void
    gst_rtsp_stream_set_protocols (GstRTSPStream *stream,
                                   GstRTSPLowerTrans protocols);

### gst_rtsp_stream_get_retransmission_time ()

    GstClockTime
    gst_rtsp_stream_get_retransmission_time
                                   (GstRTSPStream *stream);

### gst_rtsp_stream_set_retransmission_time ()

    void
    gst_rtsp_stream_set_retransmission_time
                                   (GstRTSPStream *stream,
                                    GstClockTime time);

### gst_rtsp_stream_set_buffer_size ()

    void
    gst_rtsp_stream_set_buffer_size (GstRTSPStream *stream,
                                     guint size);

### gst_rtsp_stream_get_buffer_size ()

    guint
    gst_rtsp_stream_get_buffer_size (GstRTSPStream *stream);

### gst_rtsp_stream_set_seqnum_offset ()

    void
    gst_rtsp_stream_set_seqnum_offset (GstRTSPStream *stream,
                                       guint16 seqnum);

### gst_rtsp_stream_get_current_seqnum ()

    guint16
    gst_rtsp_stream_get_current_seqnum (GstRTSPStream *stream);

### gst_rtsp_stream_is_transport_supported ()

    gboolean
    gst_rtsp_stream_is_transport_supported
                                   (GstRTSPStream *stream,
                                    GstRTSPTransport *transport);

### gst_rtsp_stream_get_address_pool ()

    GstRTSPAddressPool *
    gst_rtsp_stream_get_address_pool (GstRTSPStream *stream);

### gst_rtsp_stream_set_address_pool ()

    void
    gst_rtsp_stream_set_address_pool (GstRTSPStream *stream,
                                      GstRTSPAddressPool *pool);

### gst_rtsp_stream_reserve_address ()

    GstRTSPAddress *
    gst_rtsp_stream_reserve_address (GstRTSPStream *stream,
                                     const gchar *address,
                                     guint port,
                                     guint n_ports,
                                     guint ttl);

### gst_rtsp_stream_join_bin ()

    gboolean
    gst_rtsp_stream_join_bin (GstRTSPStream *stream,
                              GstBin *bin,
                              GstElement *rtpbin,
                              GstState state);

### gst_rtsp_stream_leave_bin ()

    gboolean
    gst_rtsp_stream_leave_bin (GstRTSPStream *stream,
                               GstBin *bin,
                               GstElement *rtpbin);

### gst_rtsp_stream_get_server_port ()

    void
    gst_rtsp_stream_get_server_port (GstRTSPStream *stream,
                                     GstRTSPRange *server_port,
                                     GSocketFamily family);

### gst_rtsp_stream_get_multicast_address ()

    GstRTSPAddress *
    gst_rtsp_stream_get_multicast_address (GstRTSPStream *stream,
                                           GSocketFamily family);

### gst_rtsp_stream_get_rtpsession ()

    GObject *
    gst_rtsp_stream_get_rtpsession (GstRTSPStream *stream);

### gst_rtsp_stream_get_ssrc ()

    void
    gst_rtsp_stream_get_ssrc (GstRTSPStream *stream,
                              guint *ssrc);

### gst_rtsp_stream_get_rtpinfo ()

    gboolean
    gst_rtsp_stream_get_rtpinfo (GstRTSPStream *stream,
                                 guint *rtptime,
                                 guint *seq,
                                 guint *clock_rate,
                                 GstClockTime *running_time);

### gst_rtsp_stream_get_caps ()

    GstCaps *
    gst_rtsp_stream_get_caps (GstRTSPStream *stream);

### gst_rtsp_stream_get_pt ()

    guint
    gst_rtsp_stream_get_pt (GstRTSPStream *stream);

### gst_rtsp_stream_recv_rtcp ()

    GstFlowReturn
    gst_rtsp_stream_recv_rtcp (GstRTSPStream *stream,
                               GstBuffer *buffer);

### gst_rtsp_stream_recv_rtp ()

    GstFlowReturn
    gst_rtsp_stream_recv_rtp (GstRTSPStream *stream,
                              GstBuffer *buffer);

### gst_rtsp_stream_add_transport ()

    gboolean
    gst_rtsp_stream_add_transport (GstRTSPStream *stream,
                                   GstRTSPStreamTransport *trans);

### gst_rtsp_stream_remove_transport ()

    gboolean
    gst_rtsp_stream_remove_transport (GstRTSPStream *stream,
                                      GstRTSPStreamTransport *trans);

### gst_rtsp_stream_get_rtp_socket ()

    GSocket *
    gst_rtsp_stream_get_rtp_socket (GstRTSPStream *stream,
                                    GSocketFamily family);

### gst_rtsp_stream_get_rtcp_socket ()

    GSocket *
    gst_rtsp_stream_get_rtcp_socket (GstRTSPStream *stream,
                                     GSocketFamily family);

### gst_rtsp_stream_set_blocked ()

    gboolean
    gst_rtsp_stream_set_blocked (GstRTSPStream *stream,
                                 gboolean blocked);

### gst_rtsp_stream_is_blocking ()

    gboolean
    gst_rtsp_stream_is_blocking (GstRTSPStream *stream);

### gst_rtsp_stream_query_stop ()

    gboolean
    gst_rtsp_stream_query_stop (GstRTSPStream *stream,
                                gint64 *stop);

### gst_rtsp_stream_query_position ()

    gboolean
    gst_rtsp_stream_query_position (GstRTSPStream *stream,
                                    gint64 *position);

### gst_rtsp_stream_update_crypto ()

    gboolean
    gst_rtsp_stream_update_crypto (GstRTSPStream *stream,
                                   guint ssrc,
                                   GstCaps *crypto);

### gst_rtsp_stream_set_pt_map ()

    void
    gst_rtsp_stream_set_pt_map (GstRTSPStream *stream,
                                guint pt,
                                GstCaps *caps);

### gst_rtsp_stream_request_aux_sender ()

    GstElement *
    gst_rtsp_stream_request_aux_sender (GstRTSPStream *stream,
                                        guint sessid);

### GstRTSPStreamTransportFilterFunc ()

    GstRTSPFilterResult
    (*GstRTSPStreamTransportFilterFunc) (GstRTSPStream *stream,
                                         GstRTSPStreamTransport *trans,
                                         gpointer user_data);

### gst_rtsp_stream_transport_filter ()

    GList *
    gst_rtsp_stream_transport_filter (GstRTSPStream *stream,
                                      GstRTSPStreamTransportFilterFunc func,
                                      gpointer user_data);

## Types and Values

### struct GstRTSPStream

    struct GstRTSPStream;

### struct GstRTSPStreamClass

    struct GstRTSPStreamClass {
      GObjectClass parent_class;
    };

## Property Details

### The `“control”` property

      “control”                  gchar *

The control string for this stream.

Flags: Read / Write

Default value: NULL

### The `“profiles”` property

      “profiles”                 GstRTSPProfile

Allowed transfer profiles.

Flags: Read / Write

Default value: GST_RTSP_PROFILE_AVP

### The `“protocols”` property

      “protocols”                GstRTSPLowerTrans

Allowed lower transport protocols.

Flags: Read / Write

Default value: GST_RTSP_LOWER_TRANS_UDP | GST_RTSP_LOWER_TRANS_UDP_MCAST | GST_RTSP_LOWER_TRANS_TCP

## Signal Details

### The `“new-rtcp-encoder”` signal

    void
    user_function (GstRTSPStream *gstrtspstream,
                   GstElement    *arg1,
                   gpointer       user_data)

Flags: Run Last

### The `“new-rtp-encoder”` signal

    void
    user_function (GstRTSPStream *gstrtspstream,
                   GstElement    *arg1,
                   gpointer       user_data)

Flags: Run Last