Create a new #GstRTSPMedia instance. element is the bin element that
provides the different streams. The #GstRTSPMedia object contains the
element to produce RTP data for one or more related (audio/video/..)
streams.
Ownership is taken of element.
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
Find all payloader elements, they should be named pay%d in the
element of media, and create #GstRTSPStreams for them.
Collect all dynamic elements, named dynpay%d, and add them to the list of dynamic elements.
Find all depayloader elements, they should be named depay%d in the
element of media, and create #GstRTSPStreams for them.
Add a receiver and sender parts to the pipeline based on the transport from SETUP.
a list of #GstRTSPTransport
Create a new stream in media that provides RTP data on pad.
pad should be a pad of an element inside media->element.
Find a stream in media with control as the control uri.
the control of the stream
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 media.
Get the base_time that is used by the pipeline in media.
media must be prepared before this method returns a valid base_time.
Get the kernel UDP buffer size.
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 of attached media.
Get the latency that is used for receiving media.
Get the the maximum time-to-live value of outgoing multicast packets.
Get the multicast interface used for media.
Get the permissions object from media.
Get the allowed profiles of media.
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 media.
Gets if and how the media 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
Get the current range as a string. media must be prepared with
gst_rtsp_media_prepare ().
for the PLAY request
the unit to use for the string
Get the rate and applied_rate of the current segment.
Get the amount of time to store retransmission data.
Get the status of media. When media is busy preparing, this function waits
until media is prepared or in error.
Retrieve the stream with index idx from media.
the stream index
Get how media will be suspended.
Get the #GstNetTimeProvider for the clock used by media. The time provider
will listen on address and port for client time requests.
an address or %NULL
a port or 0
Check if the pipeline for media can be used for PLAY or RECORD methods.
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
Configure an SDP on media for receiving streams
a #GstSDPMessage
See gst_rtsp_stream_is_complete(), gst_rtsp_stream_is_sender().
Check if multicast sockets are configured to be bound to multicast addresses.
Check if the pipeline for media will send an EOS down the pipeline before
unpreparing.
Checks whether object has a [floating][floating-ref] reference.
Check if the pipeline for media can be reused after an unprepare.
Check if the pipeline for media can be shared between multiple clients.
Check if the pipeline for media will be stopped when a client disconnects
without sending TEARDOWN.
Check if media can provide a #GstNetTimeProvider for its pipeline clock.
Use gst_rtsp_media_get_time_provider() to get the network clock.
Lock the entire media. This is needed by callers such as rtsp_client to protect the media when it is shared by many clients. The lock prevents that concurrent clients alters the shared media, while one client already is working with it. Typically the lock is taken in external RTSP API calls that uses shared media such as DESCRIBE, SETUP, ANNOUNCE, TEARDOWN, PLAY, PAUSE.
As best practice take the lock as soon as the function get hold of a shared media object. Release the lock right before the function returns.
Get the number of streams in this media.
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.
Prepare media for streaming. This function will create the objects
to manage the streaming. A pipeline must have been set on media with
gst_rtsp_media_take_pipeline().
It will preroll the pipeline and collect vital information about the streams such as the duration.
a #GstRTSPThread to run the bus handler or %NULL
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().
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Seek the pipeline of media to range. media must be prepared with
gst_rtsp_media_prepare().
a #GstRTSPTimeRange
Seek the pipeline of media to range with the given flags.
media must be prepared with gst_rtsp_media_prepare().
a #GstRTSPTimeRange
The minimal set of #GstSeekFlags to use
Seek the pipeline of media to range with the given flags and rate,
and trickmode_interval.
media must be prepared with gst_rtsp_media_prepare().
In order to perform the seek operation, the pipeline must contain all
needed transport parts (transport sinks).
a #GstRTSPTimeRange
The minimal set of #GstSeekFlags to use
the rate to use in the seek
The trickmode interval to use for KEY_UNITS trick mode
Check if the pipeline for media seek and up to what point in time,
it can seek.
configure pool to be used as the address pool of media.
a #GstRTSPAddressPool
Decide whether the multicast socket should be bound to a multicast address or INADDR_ANY.
the new value
Set the kernel UDP buffer size.
the new value
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
Set whether retransmission requests will be sent
Configure the dscp qos of attached streams to dscp_qos.
a new dscp qos value (0-63, or -1 to disable)
Set or unset if an EOS event will be sent to the pipeline for media before
it is unprepared.
the new value
Configure the latency used for receiving media.
latency in milliseconds
Set the maximum time-to-live value of outgoing multicast packets.
the new multicast ttl value
configure multicast_iface to be used for media.
a multicast interface name
Set permissions on media.
a #GstRTSPPermissions
Configure the allowed lower transport for media.
the new flags
Sets a property on an object.
the name of the property to set
the value
Configure the allowed lower transport for media.
the new flags
Sets if and how the media clock should be published according to RFC7273.
the clock publish mode
Define whether media will follow the Rate-Control=no behaviour as specified
in the ONVIF replay spec.
Set the amount of time to store retransmission packets.
the new value
Set or unset if the pipeline for media can be reused after the pipeline has
been unprepared.
the new value
Set or unset if the pipeline for media can be shared will multiple clients.
When shared is %TRUE, client requests for this media will share the media
pipeline.
the new value
Set the state of media to state and for the transports in transports.
media must be prepared with gst_rtsp_media_prepare();
the target state of the media
a #GPtrArray of #GstRTSPStreamTransport pointers
Set or unset if the pipeline for media should be stopped when a
client disconnects without sending TEARDOWN.
the new value
Control how @ media will be suspended after the SDP has been generated and after a PAUSE request has been performed.
Media must be unprepared when setting the suspend mode.
the new #GstRTSPSuspendMode
Sets if the media pipeline can work in PLAY or RECORD mode
the new value
Add media specific info to sdp. info is used to configure the connection
information in the SDP.
a #GstSDPMessage
a #GstSDPInfo
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
Suspend media. The state of the pipeline managed by media is set to
GST_STATE_NULL but all streams are kept. media can be prepared again
with gst_rtsp_media_unsuspend()
media must be prepared with gst_rtsp_media_prepare();
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.
Unlock the media.
Unprepare media. After this call, the media should be prepared again before
it can be used again. If the media is set to be non-reusable, a new instance
must be created.
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.
Unsuspend media if it was in a suspended state. This method does nothing
when the media was not in the suspended state.
Set media to provide a #GstNetTimeProvider.
if a #GstNetTimeProvider should be used
Configure an SDP on media for receiving streams
a #GstSDPMessage
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.
Prepare media for streaming. This function will create the objects
to manage the streaming. A pipeline must have been set on media with
gst_rtsp_media_take_pipeline().
It will preroll the pipeline and collect vital information about the streams such as the duration.
a #GstRTSPThread to run the bus handler or %NULL
Add media specific info to sdp. info is used to configure the connection
information in the SDP.
a #GstSDPMessage
a #GstSDPInfo
Suspend media. The state of the pipeline managed by media is set to
GST_STATE_NULL but all streams are kept. media can be prepared again
with gst_rtsp_media_unsuspend()
media must be prepared with gst_rtsp_media_prepare();
Unprepare media. After this call, the media should be prepared again before
it can be used again. If the media is set to be non-reusable, a new instance
must be created.
Unsuspend media if it was in a suspended state. This method does nothing
when the media was not in the suspended state.
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 #GstRTSPMedia instance. element is the bin element that
provides the different streams. The #GstRTSPMedia object contains the
element to produce RTP data for one or more related (audio/video/..)
streams.
Ownership is taken of element.
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
A class that contains the GStreamer element along with a list of #GstRTSPStream objects that can produce data.
This object is usually created from a #GstRTSPMediaFactory.