mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-18 15:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Add documentation for GST_SEQNUM_INVALID

Browse source 
And link to it
This commit is contained in:
Edward Hervey 2017-12-05 18:20:34 +01:00 committed by Edward Hervey
parent e5c15f6b96
commit eb6ba249c4
3 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/gst/gstreamer-sections.txt
View file

@ -3571,6 +3571,7 @@ GFLOAT_FROM_LE
GFLOAT_SWAP_LE_BE
GFLOAT_TO_BE
GFLOAT_TO_LE
GST_SEQNUM_INVALID
GST_GROUP_ID_INVALID
gst_guint64_to_gdouble

2
gst/gstutils.c
View file

@ -788,7 +788,7 @@ gst_util_uint64_scale_int_ceil (guint64 val, gint num, gint denom)
* on a segment-done message to be the same as that of the last seek event, to
* indicate that event and the message correspond to the same segment.
*
* This function never returns GST_SEQNUM_INVALID (which is 0).
* This function never returns %GST_SEQNUM_INVALID (which is 0).
*
* Returns: A constantly incrementing 32-bit unsigned integer, which might
* overflow at some point. Use gst_util_seqnum_compare() to make sure

10
gst/gstutils.h
View file

@ -99,6 +99,16 @@ guint64 gst_util_uint64_scale_int_round (guint64 val, gint num, gint den
GST_EXPORT
guint64 gst_util_uint64_scale_int_ceil (guint64 val, gint num, gint denom);
/**
* GST_SEQNUM_INVALID:
*
* A value which is guaranteed to never be returned by
* gst_util_seqnum_next().
*
* Can be used as a default value in variables used to store seqnum.
*
* Since: 1.14
*/
#define GST_SEQNUM_INVALID (0)
GST_EXPORT