| Top |  |
 |
 |
 |
Properties
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── GstObject ╰── GstElement ╰── GstBin ╰── GstRTSPSrc
Description
Makes a connection to an RTSP server and read the data. rtspsrc strictly follows RFC 2326 and therefore does not (yet) support RealMedia/Quicktime/Microsoft extensions.
RTSP supports transport over TCP or UDP in unicast or multicast mode. By default rtspsrc will negotiate a connection in the following order: UDP unicast/UDP multicast/TCP. The order cannot be changed but the allowed protocols can be controlled with the “protocols” property.
rtspsrc currently understands SDP as the format of the session description. For each stream listed in the SDP a new rtp_stream%d pad will be created with caps derived from the SDP media description. This is a caps of mime type "application/x-rtp" that can be connected to any available RTP depayloader element.
rtspsrc will internally instantiate an RTP session manager element that will handle the RTCP messages to and from the server, jitter removal, packet reordering along with providing a clock for the pipeline. This feature is implemented using the gstrtpbin element.
rtspsrc acts like a live source and will therefore only generate data in the PLAYING state.
Example launch line
1 |
gst-launch-1.0 rtspsrc location=rtsp://some.server/url ! fakesink |
Synopsis
Element Information
plugin |
rtsp |
author |
Wim Taymans <wim@fluendo.com>, Thijs Vermeir <thijs.vermeir@barco.com>, Lutz Mueller <lutz@topfrose.de> |
class |
Source/Network |
Property Details
The “debug” property
“debug” gboolean
Dump request and response messages to stdout(DEPRECATED: Printed all RTSP message to gstreamer log as 'log' level).
Flags: Read / Write
Default value: FALSE
The “location” property
“location” gchar *
Location of the RTSP url to read.
Flags: Read / Write
Default value: NULL
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
The “retry” property
“retry” guint
Max number of retries when allocating RTP ports.
Flags: Read / Write
Allowed values: <= 65535
Default value: 20
The “timeout” property
“timeout” guint64
Retry TCP transport after UDP timeout microseconds (0 = disabled).
Flags: Read / Write
Default value: 5000000
The “latency” property
“latency” guint
Amount of ms to buffer.
Flags: Read / Write
Default value: 2000
The “tcp-timeout” property
“tcp-timeout” guint64
Fail after timeout microseconds on TCP connections (0 = disabled).
Flags: Read / Write
Default value: 20000000
The “connection-speed” property
“connection-speed” guint64
Network connection speed in kbps (0 = unknown).
Flags: Read / Write
Allowed values: <= 18446744073709551
Default value: 0
The “nat-method” property
“nat-method” GstRTSPNatMethod
Method to use for traversing firewalls and NAT.
Flags: Read / Write
Default value: Send Dummy packets
The “do-rtcp” property
“do-rtcp” gboolean
Enable RTCP support. Some old server don't like RTCP and then this property needs to be set to FALSE.
Flags: Read / Write
Default value: TRUE
The “proxy” property
“proxy” gchar *
Set the proxy parameters. This has to be a string of the format http://host[:port].
Flags: Read / Write
Default value: NULL
The “rtp-blocksize” property
“rtp-blocksize” guint
RTP package size to suggest to server.
Flags: Read / Write
Allowed values: <= 65536
Default value: 0
The “user-id” property
“user-id” gchar *
RTSP location URI user id for authentication.
Flags: Read / Write
Default value: NULL
The “user-pw” property
“user-pw” gchar *
RTSP location URI user password for authentication.
Flags: Read / Write
Default value: NULL
The “buffer-mode” property
“buffer-mode” GstRTSPSrcBufferMode
Control the buffering and timestamping mode used by the jitterbuffer.
Flags: Read / Write
Default value: Choose mode depending on stream live
The “port-range” property
“port-range” gchar *
Configure the client port numbers that can be used to recieve RTP and RTCP.
Flags: Read / Write
Default value: NULL
The “udp-buffer-size” property
“udp-buffer-size” gint
Size of the kernel UDP receive buffer in bytes.
Flags: Read / Write
Allowed values: >= 0
Default value: 524288
The “short-header” property
“short-header” gboolean
Only send the basic RTSP headers for broken encoders.
Flags: Read / Write
Default value: FALSE
The “do-rtsp-keep-alive” property
“do-rtsp-keep-alive” gboolean
Enable RTSP keep alive support. Some old server don't like RTSP keep alive and then this property needs to be set to FALSE.
Flags: Read / Write
Default value: TRUE
The “drop-on-latency” property
“drop-on-latency” gboolean
Tells the jitterbuffer to never exceed the given latency in size.
Flags: Read / Write
Default value: FALSE
The “probation” property
“probation” guint
Consecutive packet sequence numbers to accept the source.
Flags: Read / Write
Default value: 2
The “udp-reconnect” property
“udp-reconnect” gboolean
Reconnect to the server if RTSP connection is closed when doing UDP.
Flags: Read / Write
Default value: TRUE
The “proxy-id” property
“proxy-id” gchar *
Sets the proxy URI user id for authentication. If the URI set via the "proxy" property contains a user-id already, that will take precedence.
Flags: Read / Write
Default value: ""
Since: 1.2
The “proxy-pw” property
“proxy-pw” gchar *
Sets the proxy URI password for authentication. If the URI set via the "proxy" property contains a password already, that will take precedence.
Flags: Read / Write
Default value: ""
Since: 1.2
The “multicast-iface” property
“multicast-iface” gchar *
The network interface on which to join the multicast group.
Flags: Read / Write
Default value: NULL
The “ntp-sync” property
“ntp-sync” gboolean
Synchronize received streams to the NTP clock.
Flags: Read / Write
Default value: FALSE
The “use-pipeline-clock” property
“use-pipeline-clock” gboolean
Use the pipeline running-time to set the NTP time in the RTCP SR messages(DEPRECATED: Use ntp-time-source property).
Flags: Read / Write
Default value: FALSE
The “tls-database” property
“tls-database” GTlsDatabase *
TLS database with anchor certificate authorities used to validate the server certificate.
Flags: Read / Write
The “tls-validation-flags” property
“tls-validation-flags” GTlsCertificateFlags
TLS certificate validation flags used to validate the server certificate.
Flags: Read / Write
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
The “do-retransmission” property
“do-retransmission” gboolean
Ask the server to retransmit lost packets.
Flags: Read / Write
Default value: TRUE
The “tls-interaction” property
“tls-interaction” GTlsInteraction *
A GTlsInteraction object to promt the user for password or certificate.
Flags: Read / Write
The “ntp-time-source” property
“ntp-time-source” GstRTSPSrcNtpTimeSource
NTP time source for RTCP packets.
Flags: Read / Write
Default value: NTP time based on realtime clock
The “user-agent” property
“user-agent” gchar *
The User-Agent string to send to the server.
Flags: Read / Write
Default value: "GStreamer/1.14.0"
The “max-rtcp-rtp-time-diff” property
“max-rtcp-rtp-time-diff” gint
Maximum amount of time in ms that the RTP time in RTCP SRs is allowed to be ahead (-1 disabled).
Flags: Read / Write
Allowed values: >= G_MAXULONG
Default value: 1000
The “rfc7273-sync” property
“rfc7273-sync” gboolean
Synchronize received streams to the RFC7273 clock (requires clock and offset to be provided).
Flags: Read / Write
Default value: FALSE
The “default-rtsp-version” property
“default-rtsp-version” GstRTSPVersion
The preferred RTSP version to use while negotiating the version with the server.
Flags: Read / Write
Default value: GST_RTSP_VERSION_1_0
Since: 1.14
The “max-ts-offset” property
“max-ts-offset” gint64
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).
Flags: Read / Write
Allowed values: >= 0
Default value: 3000000000
The “max-ts-offset-adjustment” property
“max-ts-offset-adjustment” guint64
Syncing time stamps to NTP time adds a time offset. This parameter specifies the maximum number of nanoseconds per frame that this time offset may be adjusted with. This is used to avoid sudden large changes to time stamps.
Flags: Read / Write
Default value: 0
Signal Details
The “handle-request” signal
void user_function (GstRTSPSrc *rtspsrc, gpointer request, gpointer response, gpointer user_data)
Handle a server request in request
and prepare response
.
This signal is called from the streaming thread, you should therefore not
do any state changes on rtspsrc
because this might deadlock. If you want
to modify the state as a result of this signal, post a
GST_MESSAGE_REQUEST_STATE message on the bus or signal the main thread
in some other way.
Since: 1.2
The “on-sdp” signal
void user_function (GstRTSPSrc *rtspsrc, GstSDPMessage *sdp, gpointer user_data)
Emited when the client has retrieved the SDP and before it configures the
streams in the SDP. sdp
can be inspected and modified.
This signal is called from the streaming thread, you should therefore not
do any state changes on rtspsrc
because this might deadlock. If you want
to modify the state as a result of this signal, post a
GST_MESSAGE_REQUEST_STATE message on the bus or signal the main thread
in some other way.
Since: 1.2
The “select-stream” signal
gboolean user_function (GstRTSPSrc *rtspsrc, guint num, GstCaps *caps, gpointer user_data)
Emited before the client decides to configure the stream num
with
caps
.
Parameters
rtspsrc |
||
num |
the stream number |
|
caps |
the stream caps |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
Since: 1.2
The “new-manager” signal
void user_function (GstRTSPSrc *rtspsrc, GstElement *manager, gpointer user_data)
Emited after a new manager (like rtpbin) was created and the default properties were configured.
Flags: Run First
Since: 1.4
The “request-rtcp-key” signal
GstCaps* user_function (GstRTSPSrc *rtspsrc, guint num, gpointer user_data)
Signal emited to get the crypto parameters relevant to the RTCP stream. User should provide the key and the RTCP encryption ciphers and authentication, and return them wrapped in a GstCaps.
Parameters
rtspsrc |
||
num |
the stream number |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.4
The “accept-certificate” signal
gboolean user_function (GstRTSPSrc *rtspsrc, GTlsConnection *peer_cert, GTlsCertificate *errors, GTlsCertificateFlags user_data, gpointer user_data)
This will directly map to GTlsConnection 's "accept-certificate" signal and be performed after the default checks of GstRTSPConnection (checking against the GTlsDatabase with the given GTlsCertificateFlags) have failed. If no GTlsDatabase is set on this connection, only this signal will be emitted.
Parameters
rtspsrc |
||
peer_cert |
the peer's GTlsCertificate |
|
errors |
the problems with |
|
user_data |
user data set when the signal handler was connected. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.14
The “before-send” signal
gboolean user_function (GstRTSPSrc *gstrtspsrc, GstRTSPMessage *arg1, gpointer user_data)
Flags: Run First
The “push-backchannel-buffer” signal
GstFlowReturn user_function (GstRTSPSrc *rtspsrc, guint buffer, GstBuffer *arg2, gpointer user_data)
Parameters
rtspsrc |
||
buffer |
RTP buffer to send back |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action