Blame docs/plugins/html/gst-plugins-good-plugins-rtspsrc.html

Packit 1f69a5
Packit 1f69a5
<html>
Packit 1f69a5
<head>
Packit 1f69a5
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 1f69a5
<title>rtspsrc: GStreamer Good Plugins 1.0 Plugins Reference Manual</title>
Packit 1f69a5
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 1f69a5
<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
Packit 1f69a5
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
Packit 1f69a5
<link rel="prev" href="gst-plugins-good-plugins-rtpxqtdepay.html" title="rtpxqtdepay">
Packit 1f69a5
<link rel="next" href="gst-plugins-good-plugins-sbcparse.html" title="sbcparse">
Packit 1f69a5
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit 1f69a5
<link rel="stylesheet" href="style.css" type="text/css">
Packit 1f69a5
</head>
Packit 1f69a5
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Top  | 
Packit 1f69a5
                  Description  | 
Packit 1f69a5
                  Object Hierarchy  | 
Packit 1f69a5
                  Implemented Interfaces  | 
Packit 1f69a5
                  Properties  | 
Packit 1f69a5
                  Signals
Packit 1f69a5
Packit 1f69a5
Home
Packit 1f69a5
Up
Packit 1f69a5
Prev
Packit 1f69a5
Next
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

rtspsrc

Packit 1f69a5

rtspsrc

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Properties

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
debug
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gchar *
Packit 1f69a5
location
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GstRTSPLowerTrans
Packit 1f69a5
protocols
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
guint
Packit 1f69a5
retry
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
guint64
Packit 1f69a5
timeout
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
guint
Packit 1f69a5
latency
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
guint64
Packit 1f69a5
tcp-timeout
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
guint64
Packit 1f69a5
connection-speed
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GstRTSPNatMethod
Packit 1f69a5
nat-method
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
do-rtcp
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gchar *
Packit 1f69a5
proxy
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
guint
Packit 1f69a5
rtp-blocksize
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gchar *
Packit 1f69a5
user-id
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gchar *
Packit 1f69a5
user-pw
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GstRTSPSrcBufferMode
Packit 1f69a5
buffer-mode
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gchar *
Packit 1f69a5
port-range
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gint
Packit 1f69a5
udp-buffer-size
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
short-header
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
do-rtsp-keep-alive
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
drop-on-latency
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
guint
Packit 1f69a5
probation
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
udp-reconnect
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gchar *
Packit 1f69a5
proxy-id
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gchar *
Packit 1f69a5
proxy-pw
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gchar *
Packit 1f69a5
multicast-iface
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
ntp-sync
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
use-pipeline-clock
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GstStructure *
Packit 1f69a5
sdes
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GTlsDatabase *
Packit 1f69a5
tls-database
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GTlsCertificateFlags
Packit 1f69a5
tls-validation-flags
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
do-retransmission
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GTlsInteraction *
Packit 1f69a5
tls-interaction
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GstRTSPSrcNtpTimeSource
Packit 1f69a5
ntp-time-source
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gchar *
Packit 1f69a5
user-agent
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gint
Packit 1f69a5
max-rtcp-rtp-time-diff
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
rfc7273-sync
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GstRTSPVersion
Packit 1f69a5
default-rtsp-version
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gint64
Packit 1f69a5
max-ts-offset
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
guint64
Packit 1f69a5
max-ts-offset-adjustment
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GstRTSPBackchannel
Packit 1f69a5
backchannel
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Signals

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
void
Packit 1f69a5
handle-request
Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
void
Packit 1f69a5
on-sdp
Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
select-stream
Packit 1f69a5
Run First
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
void
Packit 1f69a5
new-manager
Packit 1f69a5
Run First
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GstCaps*
Packit 1f69a5
request-rtcp-key
Packit 1f69a5
Run Last
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
accept-certificate
Packit 1f69a5
Run Last
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
gboolean
Packit 1f69a5
before-send
Packit 1f69a5
Run First
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
GstFlowReturn
Packit 1f69a5
push-backchannel-buffer
Packit 1f69a5
Action
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Types and Values

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
struct
Packit 1f69a5
GstRTSPSrc
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Object Hierarchy

Packit 1f69a5
    GObject
Packit 1f69a5
    ╰── GInitiallyUnowned
Packit 1f69a5
        ╰── GstObject
Packit 1f69a5
            ╰── GstElement
Packit 1f69a5
                ╰── GstBin
Packit 1f69a5
                    ╰── GstRTSPSrc
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Implemented Interfaces

Packit 1f69a5

Packit 1f69a5
GstRTSPSrc implements
Packit 1f69a5
 GstChildProxy and  GstURIHandler.

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Description

Packit 1f69a5

Makes a connection to an RTSP server and read the data.

Packit 1f69a5
rtspsrc strictly follows RFC 2326 and therefore does not (yet) support
Packit 1f69a5
RealMedia/Quicktime/Microsoft extensions.

Packit 1f69a5

RTSP supports transport over TCP or UDP in unicast or multicast mode. By

Packit 1f69a5
default rtspsrc will negotiate a connection in the following order:
Packit 1f69a5
UDP unicast/UDP multicast/TCP. The order cannot be changed but the allowed
Packit 1f69a5
protocols can be controlled with the “protocols” property.

Packit 1f69a5

rtspsrc currently understands SDP as the format of the session description.

Packit 1f69a5
For each stream listed in the SDP a new rtp_stream%d pad will be created
Packit 1f69a5
with caps derived from the SDP media description. This is a caps of mime type
Packit 1f69a5
"application/x-rtp" that can be connected to any available RTP depayloader
Packit 1f69a5
element.

Packit 1f69a5

rtspsrc will internally instantiate an RTP session manager element

Packit 1f69a5
that will handle the RTCP messages to and from the server, jitter removal,
Packit 1f69a5
packet reordering along with providing a clock for the pipeline.
Packit 1f69a5
This feature is implemented using the gstrtpbin element.

Packit 1f69a5

rtspsrc acts like a live source and will therefore only generate data in the

Packit 1f69a5
PLAYING state.

Packit 1f69a5
Packit 1f69a5

Example launch line

Packit 1f69a5
Packit 1f69a5
  
Packit 1f69a5
    
Packit 1f69a5
      
Packit 1f69a5
        
1
Packit 1f69a5
        
gst-launch-1.0 rtspsrc location=rtsp://some.server/url ! fakesink
Packit 1f69a5
      
Packit 1f69a5
    
Packit 1f69a5
  
Packit 1f69a5
Packit 1f69a5
 Establish a connection to an RTSP server and send the raw RTP packets to a
Packit 1f69a5
fakesink.
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Synopsis

Packit 1f69a5
Packit 1f69a5

Element Information

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

plugin

Packit 1f69a5
Packit 1f69a5
            rtsp
Packit 1f69a5
          
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

author

Packit 1f69a5
Wim Taymans <wim@fluendo.com>, Thijs Vermeir <thijs.vermeir@barco.com>, Lutz Mueller <lutz@topfrose.de>
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

class

Packit 1f69a5
Source/Network
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

Element Pads

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

name

Packit 1f69a5
stream_%u
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

direction

Packit 1f69a5
source
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

presence

Packit 1f69a5
sometimes
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

details

Packit 1f69a5
application/x-rtp
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
 application/x-rdt
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Functions

Packit 1f69a5

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Types and Values

Packit 1f69a5
Packit 1f69a5

struct GstRTSPSrc

Packit 1f69a5
struct GstRTSPSrc;
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Property Details

Packit 1f69a5
Packit 1f69a5

The “debug” property

Packit 1f69a5
  “debug”                    gboolean
Packit 1f69a5

Dump request and response messages to stdout(DEPRECATED: Printed all RTSP message to gstreamer log as 'log' level).

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: FALSE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “location” property

Packit 1f69a5
  “location”                 gchar *
Packit 1f69a5

Location of the RTSP url to read.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: NULL

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “protocols” property

Packit 1f69a5
  “protocols”                GstRTSPLowerTrans
Packit 1f69a5

Allowed lower transport protocols.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: GST_RTSP_LOWER_TRANS_UDP|GST_RTSP_LOWER_TRANS_UDP_MCAST|GST_RTSP_LOWER_TRANS_TCP

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “retry” property

Packit 1f69a5
  “retry”                    guint
Packit 1f69a5

Max number of retries when allocating RTP ports.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Allowed values: <= 65535

Packit 1f69a5

Default value: 20

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “timeout” property

Packit 1f69a5
  “timeout”                  guint64
Packit 1f69a5

Retry TCP transport after UDP timeout microseconds (0 = disabled).

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: 5000000

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “latency” property

Packit 1f69a5
  “latency”                  guint
Packit 1f69a5

Amount of ms to buffer.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: 2000

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “tcp-timeout” property

Packit 1f69a5
  “tcp-timeout”              guint64
Packit 1f69a5

Fail after timeout microseconds on TCP connections (0 = disabled).

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: 20000000

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “connection-speed” property

Packit 1f69a5
  “connection-speed”         guint64
Packit 1f69a5

Network connection speed in kbps (0 = unknown).

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Allowed values: <= 18446744073709551

Packit 1f69a5

Default value: 0

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “nat-method” property

Packit 1f69a5
  “nat-method”               GstRTSPNatMethod
Packit 1f69a5

Method to use for traversing firewalls and NAT.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: Send Dummy packets

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “do-rtcp” property

Packit 1f69a5
  “do-rtcp”                  gboolean
Packit 1f69a5

Enable RTCP support. Some old server don't like RTCP and then this property

Packit 1f69a5
needs to be set to FALSE.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: TRUE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “proxy” property

Packit 1f69a5
  “proxy”                    gchar *
Packit 1f69a5

Set the proxy parameters. This has to be a string of the format

Packit 1f69a5
http://host[:port].

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: NULL

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “rtp-blocksize” property

Packit 1f69a5
  “rtp-blocksize”            guint
Packit 1f69a5

RTP package size to suggest to server.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Allowed values: <= 65536

Packit 1f69a5

Default value: 0

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “user-id” property

Packit 1f69a5
  “user-id”                  gchar *
Packit 1f69a5

RTSP location URI user id for authentication.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: NULL

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “user-pw” property

Packit 1f69a5
  “user-pw”                  gchar *
Packit 1f69a5

RTSP location URI user password for authentication.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: NULL

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “buffer-mode” property

Packit 1f69a5
  “buffer-mode”              GstRTSPSrcBufferMode
Packit 1f69a5

Control the buffering and timestamping mode used by the jitterbuffer.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: Choose mode depending on stream live

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “port-range” property

Packit 1f69a5
  “port-range”               gchar *
Packit 1f69a5

Configure the client port numbers that can be used to recieve RTP and

Packit 1f69a5
RTCP.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: NULL

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “udp-buffer-size” property

Packit 1f69a5
  “udp-buffer-size”          gint
Packit 1f69a5

Size of the kernel UDP receive buffer in bytes.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Allowed values: >= 0

Packit 1f69a5

Default value: 524288

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “short-header” property

Packit 1f69a5
  “short-header”             gboolean
Packit 1f69a5

Only send the basic RTSP headers for broken encoders.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: FALSE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “do-rtsp-keep-alive” property

Packit 1f69a5
  “do-rtsp-keep-alive”       gboolean
Packit 1f69a5

Enable RTSP keep alive support. Some old server don't like RTSP

Packit 1f69a5
keep alive and then this property needs to be set to FALSE.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: TRUE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “drop-on-latency” property

Packit 1f69a5
  “drop-on-latency”          gboolean
Packit 1f69a5

Tells the jitterbuffer to never exceed the given latency in size.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: FALSE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “probation” property

Packit 1f69a5
  “probation”                guint
Packit 1f69a5

Consecutive packet sequence numbers to accept the source.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: 2

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “udp-reconnect” property

Packit 1f69a5
  “udp-reconnect”            gboolean
Packit 1f69a5

Reconnect to the server if RTSP connection is closed when doing UDP.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: TRUE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “proxy-id” property

Packit 1f69a5
  “proxy-id”                 gchar *
Packit 1f69a5

Sets the proxy URI user id for authentication. If the URI set via the

Packit 1f69a5
"proxy" property contains a user-id already, that will take precedence.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: ""

Packit 1f69a5

Since: 1.2

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “proxy-pw” property

Packit 1f69a5
  “proxy-pw”                 gchar *
Packit 1f69a5

Sets the proxy URI password for authentication. If the URI set via the

Packit 1f69a5
"proxy" property contains a password already, that will take precedence.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: ""

Packit 1f69a5

Since: 1.2

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “multicast-iface” property

Packit 1f69a5
  “multicast-iface”          gchar *
Packit 1f69a5

The network interface on which to join the multicast group.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: NULL

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “ntp-sync” property

Packit 1f69a5
  “ntp-sync”                 gboolean
Packit 1f69a5

Synchronize received streams to the NTP clock.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: FALSE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “use-pipeline-clock” property

Packit 1f69a5
  “use-pipeline-clock”       gboolean
Packit 1f69a5

Use the pipeline running-time to set the NTP time in the RTCP SR messages(DEPRECATED: Use ntp-time-source property).

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: FALSE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “sdes” property

Packit 1f69a5
  “sdes”                     GstStructure *
Packit 1f69a5

The SDES items of this session.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “tls-database” property

Packit 1f69a5
  “tls-database”             GTlsDatabase *
Packit 1f69a5

TLS database with anchor certificate authorities used to validate the server certificate.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “tls-validation-flags” property

Packit 1f69a5
  “tls-validation-flags”     GTlsCertificateFlags
Packit 1f69a5

TLS certificate validation flags used to validate the server certificate.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: G_TLS_CERTIFICATE_UNKNOWN_CA|G_TLS_CERTIFICATE_BAD_IDENTITY|G_TLS_CERTIFICATE_NOT_ACTIVATED|G_TLS_CERTIFICATE_EXPIRED|G_TLS_CERTIFICATE_REVOKED|G_TLS_CERTIFICATE_INSECURE|G_TLS_CERTIFICATE_GENERIC_ERROR

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “do-retransmission” property

Packit 1f69a5
  “do-retransmission”        gboolean
Packit 1f69a5

Ask the server to retransmit lost packets.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: TRUE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “tls-interaction” property

Packit 1f69a5
  “tls-interaction”          GTlsInteraction *
Packit 1f69a5

A GTlsInteraction object to promt the user for password or certificate.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “ntp-time-source” property

Packit 1f69a5
  “ntp-time-source”          GstRTSPSrcNtpTimeSource
Packit 1f69a5

NTP time source for RTCP packets.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: NTP time based on realtime clock

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “user-agent” property

Packit 1f69a5
  “user-agent”               gchar *
Packit 1f69a5

The User-Agent string to send to the server.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: "GStreamer/1.14.1"

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “max-rtcp-rtp-time-diff” property

Packit 1f69a5
  “max-rtcp-rtp-time-diff”   gint
Packit 1f69a5

Maximum amount of time in ms that the RTP time in RTCP SRs is allowed to be ahead (-1 disabled).

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Allowed values: >= G_MAXULONG

Packit 1f69a5

Default value: 1000

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “rfc7273-sync” property

Packit 1f69a5
  “rfc7273-sync”             gboolean
Packit 1f69a5

Synchronize received streams to the RFC7273 clock (requires clock and offset to be provided).

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: FALSE

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “default-rtsp-version” property

Packit 1f69a5
  “default-rtsp-version”     GstRTSPVersion
Packit 1f69a5

The preferred RTSP version to use while negotiating the version with the server.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: GST_RTSP_VERSION_1_0

Packit 1f69a5

Since: 1.14

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “max-ts-offset” property

Packit 1f69a5
  “max-ts-offset”            gint64
Packit 1f69a5

The maximum absolute value of the time offset in (nanoseconds). Note, if the ntp-sync parameter is set the default value is changed to 0 (no limit).

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Allowed values: >= 0

Packit 1f69a5

Default value: 3000000000

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “max-ts-offset-adjustment” property

Packit 1f69a5
  “max-ts-offset-adjustment” guint64
Packit 1f69a5

Syncing time stamps to NTP time adds a time offset. This parameter

Packit 1f69a5
specifies the maximum number of nanoseconds per frame that this time offset
Packit 1f69a5
may be adjusted with. This is used to avoid sudden large changes to time
Packit 1f69a5
stamps.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: 0

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “backchannel” property

Packit 1f69a5
  “backchannel”              GstRTSPBackchannel
Packit 1f69a5

The type of backchannel to setup. Default is 'none'.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Default value: No backchannel

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Signal Details

Packit 1f69a5
Packit 1f69a5

The “handle-request” signal

Packit 1f69a5
void
Packit 1f69a5
user_function (GstRTSPSrc *rtspsrc,
Packit 1f69a5
               gpointer    request,
Packit 1f69a5
               gpointer    response,
Packit 1f69a5
               gpointer    user_data)
Packit 1f69a5

Handle a server request in request

Packit 1f69a5
 and prepare response
Packit 1f69a5
.

Packit 1f69a5

This signal is called from the streaming thread, you should therefore not

Packit 1f69a5
do any state changes on rtspsrc
Packit 1f69a5
 because this might deadlock. If you want
Packit 1f69a5
to modify the state as a result of this signal, post a
Packit 1f69a5
GST_MESSAGE_REQUEST_STATE message on the bus or signal the main thread
Packit 1f69a5
in some other way.

Packit 1f69a5
Packit 1f69a5

Parameters

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

rtspsrc

Packit 1f69a5

a GstRTSPSrc

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

request

Packit 1f69a5

a GstRTSPMessage

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

response

Packit 1f69a5

a GstRTSPMessage

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

user_data

Packit 1f69a5

user data set when the signal handler was connected.

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Since: 1.2

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “on-sdp” signal

Packit 1f69a5
void
Packit 1f69a5
user_function (GstRTSPSrc    *rtspsrc,
Packit 1f69a5
               GstSDPMessage *sdp,
Packit 1f69a5
               gpointer       user_data)
Packit 1f69a5

Emited when the client has retrieved the SDP and before it configures the

Packit 1f69a5
streams in the SDP. sdp
Packit 1f69a5
 can be inspected and modified.

Packit 1f69a5

This signal is called from the streaming thread, you should therefore not

Packit 1f69a5
do any state changes on rtspsrc
Packit 1f69a5
 because this might deadlock. If you want
Packit 1f69a5
to modify the state as a result of this signal, post a
Packit 1f69a5
GST_MESSAGE_REQUEST_STATE message on the bus or signal the main thread
Packit 1f69a5
in some other way.

Packit 1f69a5
Packit 1f69a5

Parameters

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

rtspsrc

Packit 1f69a5

a GstRTSPSrc

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

sdp

Packit 1f69a5

a GstSDPMessage

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

user_data

Packit 1f69a5

user data set when the signal handler was connected.

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Since: 1.2

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “select-stream” signal

Packit 1f69a5
gboolean
Packit 1f69a5
user_function (GstRTSPSrc *rtspsrc,
Packit 1f69a5
               guint       num,
Packit 1f69a5
               GstCaps    *caps,
Packit 1f69a5
               gpointer    user_data)
Packit 1f69a5

Emited before the client decides to configure the stream num

Packit 1f69a5
 with
Packit 1f69a5
caps
Packit 1f69a5
.

Packit 1f69a5
Packit 1f69a5

Parameters

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

rtspsrc

Packit 1f69a5

a GstRTSPSrc

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

num

Packit 1f69a5

the stream number

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

caps

Packit 1f69a5

the stream caps

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

user_data

Packit 1f69a5

user data set when the signal handler was connected.

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Returns

Packit 1f69a5

TRUE when the stream should be selected, FALSE when the stream

Packit 1f69a5
is to be ignored.

Packit 1f69a5
Packit 1f69a5

Flags: Run First

Packit 1f69a5

Since: 1.2

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “new-manager” signal

Packit 1f69a5
void
Packit 1f69a5
user_function (GstRTSPSrc *rtspsrc,
Packit 1f69a5
               GstElement *manager,
Packit 1f69a5
               gpointer    user_data)
Packit 1f69a5

Emited after a new manager (like rtpbin) was created and the default

Packit 1f69a5
properties were configured.

Packit 1f69a5
Packit 1f69a5

Parameters

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

rtspsrc

Packit 1f69a5

a GstRTSPSrc

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

manager

Packit 1f69a5

a GstElement

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

user_data

Packit 1f69a5

user data set when the signal handler was connected.

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Flags: Run First

Packit 1f69a5

Since: 1.4

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “request-rtcp-key” signal

Packit 1f69a5
GstCaps*
Packit 1f69a5
user_function (GstRTSPSrc *rtspsrc,
Packit 1f69a5
               guint       num,
Packit 1f69a5
               gpointer    user_data)
Packit 1f69a5

Signal emited to get the crypto parameters relevant to the RTCP

Packit 1f69a5
stream. User should provide the key and the RTCP encryption ciphers
Packit 1f69a5
and authentication, and return them wrapped in a GstCaps.

Packit 1f69a5
Packit 1f69a5

Parameters

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

rtspsrc

Packit 1f69a5

a GstRTSPSrc

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

num

Packit 1f69a5

the stream number

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

user_data

Packit 1f69a5

user data set when the signal handler was connected.

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Flags: Run Last

Packit 1f69a5

Since: 1.4

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “accept-certificate” signal

Packit 1f69a5
gboolean
Packit 1f69a5
user_function (GstRTSPSrc          *rtspsrc,
Packit 1f69a5
               GTlsConnection      *peer_cert,
Packit 1f69a5
               GTlsCertificate     *errors,
Packit 1f69a5
               GTlsCertificateFlags user_data,
Packit 1f69a5
               gpointer             user_data)
Packit 1f69a5

This will directly map to GTlsConnection 's "accept-certificate"

Packit 1f69a5
signal and be performed after the default checks of GstRTSPConnection
Packit 1f69a5
(checking against the GTlsDatabase with the given GTlsCertificateFlags)
Packit 1f69a5
have failed. If no GTlsDatabase is set on this connection, only this
Packit 1f69a5
signal will be emitted.

Packit 1f69a5
Packit 1f69a5

Parameters

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

rtspsrc

Packit 1f69a5

a GstRTSPSrc

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

peer_cert

Packit 1f69a5

the peer's GTlsCertificate

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

errors

Packit 1f69a5

the problems with peer_cert

Packit 1f69a5

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

user_data

Packit 1f69a5

user data set when the signal handler was connected.

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

user_data

Packit 1f69a5

user data set when the signal handler was connected.

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Flags: Run Last

Packit 1f69a5

Since: 1.14

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “before-send” signal

Packit 1f69a5
gboolean
Packit 1f69a5
user_function (GstRTSPSrc     *gstrtspsrc,
Packit 1f69a5
               GstRTSPMessage *arg1,
Packit 1f69a5
               gpointer        user_data)
Packit 1f69a5

Flags: Run First

Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

The “push-backchannel-buffer” signal

Packit 1f69a5
GstFlowReturn
Packit 1f69a5
user_function (GstRTSPSrc *rtspsrc,
Packit 1f69a5
               guint       buffer,
Packit 1f69a5
               GstBuffer  *arg2,
Packit 1f69a5
               gpointer    user_data)
Packit 1f69a5
Packit 1f69a5

Parameters

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

rtspsrc

Packit 1f69a5

a GstRTSPSrc

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

buffer

Packit 1f69a5

RTP buffer to send back

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

user_data

Packit 1f69a5

user data set when the signal handler was connected.

Packit 1f69a5
 
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Flags: Action

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Generated by GTK-Doc V1.27
Packit 1f69a5
</body>
Packit 1f69a5
</html>