rtsp-server: Add since marker for adjust_error_code
authorPeter Stensson <petest@axis.com>
Tue, 11 Oct 2022 12:55:48 +0000 (14:55 +0200)
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Wed, 12 Oct 2022 08:08:27 +0000 (08:08 +0000)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3157>

subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-client.h

index ad1a024..42e2e02 100644 (file)
@@ -178,6 +178,19 @@ struct _GstRTSPClientClass {
   GstRTSPStatusCode (*pre_announce_request)      (GstRTSPClient *client, GstRTSPContext *ctx);
   GstRTSPStatusCode (*pre_record_request)        (GstRTSPClient *client, GstRTSPContext *ctx);
 
+  /**
+   * GstRTSPClientClass::adjust_error_code:
+   * @client: a #GstRTSPClient
+   * @ctx: a #GstRTSPContext
+   * @code: a #GstRTSPStatusCode
+   *
+   * Called before sending error response to give the application the
+   * possibility to adjust the error code.
+   *
+   * Returns: a #GstRTSPStatusCode, containing the adjusted error code.
+   *
+   * Since: 1.22
+   */
   GstRTSPStatusCode (*adjust_error_code)         (GstRTSPClient *client, GstRTSPContext *ctx, GstRTSPStatusCode code);
 
   /*< private >*/