appsink: Adjust annotations of pull- signals

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4629>
This commit is contained in:
Philippe Normand 2023-05-14 13:29:23 +01:00 committed by GStreamer Marge Bot
parent ebd5ff73be
commit a0ac1cccbf
2 changed files with 8 additions and 6 deletions

View file

@ -870,7 +870,7 @@ If an EOS event was received before any buffers, this function returns
This function blocks until a preroll sample or EOS is received or the appsink This function blocks until a preroll sample or EOS is received or the appsink
element is set to the READY/NULL state.</doc> element is set to the READY/NULL state.</doc>
<return-value transfer-ownership="full" nullable="1"> <return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/app/gstappsink.c">a #GstSample or NULL when the appsink is stopped or EOS.</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/app/gstappsink.c">a #GstSample or %NULL when the appsink is stopped or EOS.</doc>
<type name="Gst.Sample"/> <type name="Gst.Sample"/>
</return-value> </return-value>
</glib:signal> </glib:signal>
@ -890,7 +890,7 @@ the "drop" and "max-buffers" properties.
If an EOS event was received before any buffers, this function returns If an EOS event was received before any buffers, this function returns
%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc> %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
<return-value transfer-ownership="full" nullable="1"> <return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/app/gstappsink.c">a #GstSample or NULL when the appsink is stopped or EOS.</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/app/gstappsink.c">a #GstSample or %NULL when the appsink is stopped or EOS.</doc>
<type name="Gst.Sample"/> <type name="Gst.Sample"/>
</return-value> </return-value>
</glib:signal> </glib:signal>
@ -949,7 +949,8 @@ condition.
This function blocks until a preroll sample or EOS is received, the appsink This function blocks until a preroll sample or EOS is received, the appsink
element is set to the READY/NULL state, or the timeout expires.</doc> element is set to the READY/NULL state, or the timeout expires.</doc>
<return-value transfer-ownership="full" nullable="1"> <return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/app/gstappsink.c">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/app/gstappsink.c">a #GstSample or %NULL when the appsink
is stopped or EOS or the timeout expires.</doc>
<type name="Gst.Sample"/> <type name="Gst.Sample"/>
</return-value> </return-value>
<parameters> <parameters>

View file

@ -405,7 +405,7 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* This function blocks until a preroll sample or EOS is received or the appsink * This function blocks until a preroll sample or EOS is received or the appsink
* element is set to the READY/NULL state. * element is set to the READY/NULL state.
* *
* Returns: (nullable): a #GstSample or NULL when the appsink is stopped or EOS. * Returns: (nullable) (transfer full): a #GstSample or %NULL when the appsink is stopped or EOS.
*/ */
gst_app_sink_signals[SIGNAL_PULL_PREROLL] = gst_app_sink_signals[SIGNAL_PULL_PREROLL] =
g_signal_new ("pull-preroll", G_TYPE_FROM_CLASS (klass), g_signal_new ("pull-preroll", G_TYPE_FROM_CLASS (klass),
@ -430,7 +430,7 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* If an EOS event was received before any buffers, this function returns * If an EOS event was received before any buffers, this function returns
* %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. * %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
* *
* Returns: (nullable): a #GstSample or NULL when the appsink is stopped or EOS. * Returns: (nullable) (transfer full): a #GstSample or %NULL when the appsink is stopped or EOS.
*/ */
gst_app_sink_signals[SIGNAL_PULL_SAMPLE] = gst_app_sink_signals[SIGNAL_PULL_SAMPLE] =
g_signal_new ("pull-sample", G_TYPE_FROM_CLASS (klass), g_signal_new ("pull-sample", G_TYPE_FROM_CLASS (klass),
@ -462,7 +462,8 @@ gst_app_sink_class_init (GstAppSinkClass * klass)
* This function blocks until a preroll sample or EOS is received, the appsink * This function blocks until a preroll sample or EOS is received, the appsink
* element is set to the READY/NULL state, or the timeout expires. * element is set to the READY/NULL state, or the timeout expires.
* *
* Returns: (nullable): a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. * Returns: (nullable) (transfer full): a #GstSample or %NULL when the appsink
* is stopped or EOS or the timeout expires.
* *
* Since: 1.10 * Since: 1.10
*/ */