gstelementmetadata.h 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. /* GStreamer
  2. * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
  3. * 2000,2004 Wim Taymans <wim@fluendo.com>
  4. *
  5. * gstelementmetadata.h: Metadata for GstElement classes
  6. *
  7. * This library is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Library General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2 of the License, or (at your option) any later version.
  11. *
  12. * This library is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Library General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Library General Public
  18. * License along with this library; if not, write to the
  19. * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20. * Boston, MA 02110-1301, USA.
  21. */
  22. #ifndef __GST_ELEMENT_METADATA_H__
  23. #define __GST_ELEMENT_METADATA_H__
  24. #include <glib.h>
  25. G_BEGIN_DECLS
  26. /**
  27. * GST_ELEMENT_METADATA_LONGNAME:
  28. *
  29. * The long English name of the element. E.g. "File Sink"
  30. */
  31. #define GST_ELEMENT_METADATA_LONGNAME "long-name"
  32. /**
  33. * GST_ELEMENT_METADATA_KLASS:
  34. *
  35. * String describing the type of element, as an unordered list
  36. * separated with slashes ('/'). See draft-klass.txt of the design docs
  37. * for more details and common types. E.g: "Sink/File"
  38. */
  39. #define GST_ELEMENT_METADATA_KLASS "klass"
  40. /**
  41. * GST_ELEMENT_METADATA_DESCRIPTION:
  42. *
  43. * Sentence describing the purpose of the element.
  44. * E.g: "Write stream to a file"
  45. */
  46. #define GST_ELEMENT_METADATA_DESCRIPTION "description"
  47. /**
  48. * GST_ELEMENT_METADATA_AUTHOR:
  49. *
  50. * Name and contact details of the author(s). Use \n to separate
  51. * multiple author details.
  52. * E.g: "Joe Bloggs &lt;joe.blogs at foo.com&gt;"
  53. */
  54. #define GST_ELEMENT_METADATA_AUTHOR "author"
  55. /**
  56. * GST_ELEMENT_METADATA_DOC_URI:
  57. *
  58. * Set uri pointing to user documentation. Applications can use this to show
  59. * help for e.g. effects to users.
  60. */
  61. #define GST_ELEMENT_METADATA_DOC_URI "doc-uri"
  62. /**
  63. * GST_ELEMENT_METADATA_ICON_NAME:
  64. *
  65. * Elements that bridge to certain other products can include an icon of that
  66. * used product. Application can show the icon in menus/selectors to help
  67. * identifying specific elements.
  68. */
  69. #define GST_ELEMENT_METADATA_ICON_NAME "icon-name"
  70. G_END_DECLS
  71. #endif /* __GST_ELEMENT_METADATA_H__ */