Create a new media stream with index idx
that handles RTP data on
pad
and has a payloader element payloader
if pad
is a source pad
or a depayloader element payloader
if pad
is a sink pad.
Add multicast client address to stream. At this point, the sockets that
will stream RTP and RTCP data to destination
are supposed to be
allocated.
a multicast address to add
RTP port
RTCP port
socket family
Add the transport in trans
to stream
. The media of stream
will
then also be send to the values configured in trans
. Adding the
same transport twice will not add it a second time.
stream
must be joined to a bin.
trans
must contain a valid #GstRTSPTransport.
a #GstRTSPStreamTransport
Allocates RTP and RTCP ports.
protocol family
transport method
Whether to use client settings or not
Creates a binding between source_property
on source
and target_property
on target
.
Whenever the source_property
is changed the target_property
is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags
contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property
on target
changes then the source_property
on source
will be updated as well.
The binding will automatically be removed when either the source
or the
target
instances are finalized. To remove the binding without affecting the
source
and the target
you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source
and target
are only used from a single thread and it
is clear that both source
and target
outlive the binding. Especially it
is not safe to rely on this if the binding, source
or target
can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
Creates a binding between source_property
on source
and target_property
on target,
allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source
to the target,
or %NULL to use the default
a #GClosure wrapping the transformation function from the target
to the source,
or %NULL to use the default
Add a receiver and sender part to the pipeline based on the transport from SETUP.
a #GstRTSPTransport
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object
. If the freeze count is
non-zero, the emission of "notify" signals on object
is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Get the #GstRTSPAddressPool used as the address pool of stream
.
Get the size of the UDP transmission buffer (in bytes)
Get the control string to identify this stream.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Get the configured DSCP QoS in of the outgoing sockets.
Get the stream index.
Get the the maximum time-to-live value of outgoing multicast packets.
Get the configured MTU in the payloader of stream
.
Get the multicast address of stream
for family
. The original
#GstRTSPAddress is cached and copy is returned, so freeing the return value
won't release the address from the pool.
the #GSocketFamily
Get all multicast client addresses that RTP data will be sent to
Get the multicast interface used for stream
.
Get the allowed profiles of stream
.
Gets a property of an object.
The value
can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
Get the allowed protocols of stream
.
Get the stream payload type.
Gets if and how the stream clock should be published according to RFC7273.
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Retrieve the current rate and/or applied_rate.
Get the payload-type used for retransmission of this stream
Get the amount of time to store retransmission data.
Get the multicast RTCP socket from stream
for a family
.
the socket family
Get the RTCP socket from stream
for a family
.
stream
must be joined to a bin.
the socket family
Get the multicast RTP socket from stream
for a family
.
the socket family
Get the RTP socket from stream
for a family
.
stream
must be joined to a bin.
the socket family
Retrieve the current rtptime, seq and running-time. This is used to construct a RTPInfo reply header.
Fill server_port
with the port pair used by the server. This function can
only be called when stream
has been joined.
the port family to get
Get the SSRC used by the RTP session of this stream. This function can only
be called when stream
has been joined.
Gets n_properties
properties for an object
.
Obtained properties will be set to values
. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Parse and handle a KeyMgmt header.
a keymgmt header
Check if stream
has the control string control
.
a control string
Check if multicast sockets are configured to be bound to multicast addresses.
Check if stream
is blocking on a #GstBuffer.
See gst_rtsp_stream_set_client_side()
Checks whether the stream is complete, contains the receiver and the sender parts. As the stream contains sink(s) element(s), it's possible to perform seek operations on it.
Checks whether object
has a [floating][floating-ref] reference.
Checks whether the stream is a receiver.
Checks whether the stream is a sender.
Check if transport
can be handled by stream
a #GstRTSPTransport
Join the #GstBin bin
that contains the element rtpbin
.
stream
will link to rtpbin,
which must be inside bin
. The elements
added to bin
will be set to the state given in state
.
a #GstBin to join
a rtpbin element in bin
the target state of the new elements
Emits a "notify" signal for the property property_name
on object
.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object
.
Emits a "notify" signal for the property specified by pspec
on object
.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object
.
Query the position of the stream in %GST_FORMAT_TIME. This only considers the RTP parts of the pipeline and not the RTCP parts.
Query the stop of the stream in %GST_FORMAT_TIME. This only considers the RTP parts of the pipeline and not the RTCP parts.
Handle an RTCP buffer for the stream. This method is usually called when a message has been received from a client using the TCP transport.
This function takes ownership of buffer
.
Handle an RTP buffer for the stream. This method is usually called when a message has been received from a client using the TCP transport.
This function takes ownership of buffer
.
Increase the reference count of object,
and possibly remove the
[floating][floating-ref] reference, if object
has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object
will be propagated to the return type
under the same conditions as for g_object_ref().
Remove the transport in trans
from stream
. The media of stream
will
not be sent to the values configured in trans
.
stream
must be joined to a bin.
trans
must contain a valid #GstRTSPTransport.
a #GstRTSPStreamTransport
Reserve address
and port
as the address and port of stream
. The original
#GstRTSPAddress is cached and copy is returned, so freeing the return value
won't release the address from the pool.
an address
a port
n_ports
a TTL
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Checks whether the individual stream
is seekable.
configure pool
to be used as the address pool of stream
.
a #GstRTSPAddressPool
Decide whether the multicast socket should be bound to a multicast address or INADDR_ANY.
the new value
Blocks or unblocks the dataflow on stream
.
boolean indicating we should block or unblock
Set the size of the UDP transmission buffer (in bytes) Needs to be set before the stream is joined to a bin.
the buffer size
Sets the #GstRTSPStream as a 'client side' stream - used for sending streams to an RTSP server via RECORD. This has the practical effect of changing which UDP port numbers are used when setting up the local side of the stream sending to be either the 'server' or 'client' pair of a configured UDP transport.
TRUE if this #GstRTSPStream is running on the 'client' side of an RTSP connection.
Set the control string in stream
.
a control string
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key
is converted to a #GQuark using g_quark_from_string().
This means a copy of key
is kept permanently (even after object
has been
finalized) — so it is recommended to only use a small, bounded set of values
for key
in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Configure the dscp qos of the outgoing sockets to dscp_qos
.
a new dscp qos value (0-63, or -1 to disable)
Set the maximum time-to-live value of outgoing multicast packets.
the new multicast ttl value
Configure the mtu in the payloader of stream
to mtu
.
a new MTU
configure multicast_iface
to be used for stream
.
a multicast interface name
Configure the allowed profiles for stream
.
the new profiles
Sets a property on an object.
the name of the property to set
the value
Configure the allowed lower transport for stream
.
the new flags
Sets if and how the stream clock should be published according to RFC7273.
the clock publish mode
Define whether stream
will follow the Rate-Control=no behaviour as specified
in the ONVIF replay spec.
Set the payload type (pt) for retransmission of this stream.
a #guint
Set the amount of time to store retransmission packets.
a #GstClockTime
Sets the amount of redundancy to apply when creating ULPFEC protection packets.
Set the payload type to be used for ULPFEC protection packets
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data
from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Call func
for each transport managed by stream
. The result value of func
determines what happens to the transport. func
will be called with stream
locked so no further actions on stream
can be performed from func
.
If func
returns #GST_RTSP_FILTER_REMOVE, the transport will be removed from
stream
.
If func
returns #GST_RTSP_FILTER_KEEP, the transport will remain in stream
.
If func
returns #GST_RTSP_FILTER_REF, the transport will remain in stream
but
will also be added with an additional ref to the result #GList of this
function..
When func
is %NULL, #GST_RTSP_FILTER_REF will be assumed for each transport.
a callback
Remove blocking probe from the RTCP source. When creating an UDP source for RTCP it is initially blocked until this function is called. This functions should be called once the pipeline is ready for handling RTCP packets.
Decreases the reference count of object
. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Update the new crypto information for ssrc
in stream
. If information
for ssrc
did not exist, it will be added. If information
for ssrc
existed, it will be replaced. If crypto
is %NULL, it will
be removed from stream
.
Check if the requested multicast ttl value is allowed.
a requested multicast ttl
This function essentially limits the life time of the closure
to
the life time of the object. That is, when the object is finalized,
the closure
is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure,
to ensure that an extra
reference count is held on object
during invocation of the
closure
. Usually, this function will be called on closures that
use this object
as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init
member of
#GTypeInfo.) It must not be called after after class_init
has
been called for any object types implementing this interface.
If pspec
is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface
will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Create a new media stream with index idx
that handles RTP data on
pad
and has a payloader element payloader
if pad
is a source pad
or a depayloader element payloader
if pad
is a sink pad.
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
The definition of a media stream.