gst/gsttagsetter.h

   1 /* GStreamer
   2  * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   3  *
   4  * gsttagsetter.h: Interfaces for tagging
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef __GST_TAG_SETTER_H__
  23 #define __GST_TAG_SETTER_H__
  24
  25 #include <gst/gst.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GST_TYPE_TAG_SETTER             (gst_tag_setter_get_type ())
  30 #define GST_TAG_SETTER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_TAG_SETTER, GstTagSetter))
  31 #define GST_IS_TAG_SETTER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_TAG_SETTER))
  32 #define GST_TAG_SETTER_GET_IFACE(obj)   (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_TAG_SETTER, GstTagSetterIFace))
  33
  34 /**
  35  * GstTagSetter:
  36  *
  37  * Opaque #GstTagSetter data structure.
  38  */
  39 typedef struct _GstTagSetter                    GstTagSetter; /* Dummy typedef */
  40 typedef struct _GstTagSetterIFace               GstTagSetterIFace;
  41
  42 /**
  43  * GstTagSetterIFace:
  44  * @g_iface: parent interface type.
  45  *
  46  * #GstTagSetterIFace interface.
  47  */
  48 /* use an empty interface here to allow detection of elements using user-set
  49    tags */
  50 struct _GstTagSetterIFace
  51 {
  52   GTypeInterface g_iface;
  53
  54   /* signals */
  55
  56   /* virtual table */
  57 };
  58
  59 GType           gst_tag_setter_get_type             (void);
  60
  61 void            gst_tag_setter_reset_tags             (GstTagSetter * setter);
  62
  63 void            gst_tag_setter_merge_tags           (GstTagSetter *     setter,
  64                                                      const GstTagList * list,
  65                                                      GstTagMergeMode    mode);
  66 void            gst_tag_setter_add_tags             (GstTagSetter *     setter,
  67                                                      GstTagMergeMode    mode,
  68                                                      const gchar *      tag,
  69                                                      ...) G_GNUC_NULL_TERMINATED;
  70
  71 void            gst_tag_setter_add_tag_values       (GstTagSetter *     setter,
  72                                                      GstTagMergeMode    mode,
  73                                                      const gchar *      tag,
  74                                                      ...) G_GNUC_NULL_TERMINATED;
  75
  76 void            gst_tag_setter_add_tag_valist       (GstTagSetter *     setter,
  77                                                      GstTagMergeMode    mode,
  78                                                      const gchar *      tag,
  79                                                      va_list            var_args);
  80
  81 void            gst_tag_setter_add_tag_valist_values(GstTagSetter *     setter,
  82                                                      GstTagMergeMode    mode,
  83                                                      const gchar *      tag,
  84                                                      va_list            var_args);
  85
  86 G_CONST_RETURN GstTagList *
  87                 gst_tag_setter_get_tag_list          (GstTagSetter *    setter);
  88
  89 void            gst_tag_setter_set_tag_merge_mode    (GstTagSetter *    setter,
  90                                                       GstTagMergeMode   mode);
  91 GstTagMergeMode gst_tag_setter_get_tag_merge_mode    (GstTagSetter *    setter);
  92
  93 G_END_DECLS
  94
  95 #endif /* __GST_TAG_SETTER_H__ */