Update docs for gst_pad_create_stream_id_printf()

To indicate that format strings should be alpha sortable.
This commit is contained in:
David Schleef 2013-03-25 18:11:54 -07:00
parent 7b00fd3701
commit 700be18f11

View file

@ -3699,6 +3699,10 @@ gst_pad_create_stream_id_printf (GstPad * pad, GstElement * parent,
* handler interface should ideally generate a unique, deterministic * handler interface should ideally generate a unique, deterministic
* stream-id manually instead. * stream-id manually instead.
* *
* Since stream IDs are sorted alphabetically, any numbers in the
* stream ID should be printed with a fixed number of characters,
* preceded by 0's, such as by using the format %%03u instead of %%u.
*
* Returns: A stream-id for @pad. g_free() after usage. * Returns: A stream-id for @pad. g_free() after usage.
*/ */
gchar * gchar *