docs: update docs
[platform/upstream/gstreamer.git] / gst / rtsp-server / rtsp-mount-points.h
1 /* GStreamer
2  * Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #include <gst/gst.h>
21
22 #include "rtsp-media-factory.h"
23
24 #ifndef __GST_RTSP_MOUNT_POINTS_H__
25 #define __GST_RTSP_MOUNT_POINTS_H__
26
27 G_BEGIN_DECLS
28
29 #define GST_TYPE_RTSP_MOUNT_POINTS              (gst_rtsp_mount_points_get_type ())
30 #define GST_IS_RTSP_MOUNT_POINTS(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MOUNT_POINTS))
31 #define GST_IS_RTSP_MOUNT_POINTS_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MOUNT_POINTS))
32 #define GST_RTSP_MOUNT_POINTS_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MOUNT_POINTS, GstRTSPMountPointsClass))
33 #define GST_RTSP_MOUNT_POINTS(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MOUNT_POINTS, GstRTSPMountPoints))
34 #define GST_RTSP_MOUNT_POINTS_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MOUNT_POINTS, GstRTSPMountPointsClass))
35 #define GST_RTSP_MOUNT_POINTS_CAST(obj)         ((GstRTSPMountPoints*)(obj))
36 #define GST_RTSP_MOUNT_POINTS_CLASS_CAST(klass) ((GstRTSPMountPointsClass*)(klass))
37
38 typedef struct _GstRTSPMountPoints GstRTSPMountPoints;
39 typedef struct _GstRTSPMountPointsClass GstRTSPMountPointsClass;
40 typedef struct _GstRTSPMountPointsPrivate GstRTSPMountPointsPrivate;
41
42 /**
43  * GstRTSPMountPoints:
44  * @parent: parent GObject
45  * @mounts: the mountpoints to mediafactory mapping
46  *
47  * Creates a #GstRTSPMediaFactory object for a given url.
48  */
49 struct _GstRTSPMountPoints {
50   GObject       parent;
51
52   GstRTSPMountPointsPrivate *priv;
53 };
54
55 /**
56  * GstRTSPMountPointsClass:
57  * @parent_class: parent GObject class
58  * @find_factory: Create or return a previously cached #GstRTSPMediaFactory object
59  *        for the given url. the default implementation will use the factory
60  *        added with gst_rtsp_mount_points_add_factory().
61  *
62  * The class for the media mounts object.
63  */
64 struct _GstRTSPMountPointsClass {
65   GObjectClass  parent_class;
66 };
67
68 GType                 gst_rtsp_mount_points_get_type       (void);
69
70 /* creating a mount points */
71 GstRTSPMountPoints *  gst_rtsp_mount_points_new            (void);
72
73 /* finding a media factory */
74 GstRTSPMediaFactory * gst_rtsp_mount_points_match          (GstRTSPMountPoints *mounts,
75                                                             const gchar *path,
76                                                             gint * matched);
77 /* managing media to a mount point */
78 void                  gst_rtsp_mount_points_add_factory    (GstRTSPMountPoints *mounts,
79                                                             const gchar *path,
80                                                             GstRTSPMediaFactory *factory);
81 void                  gst_rtsp_mount_points_remove_factory (GstRTSPMountPoints *mounts,
82                                                             const gchar *path);
83
84 G_END_DECLS
85
86 #endif /* __GST_RTSP_MOUNT_POINTS_H__ */