Gjsify LogoGjsify Logo

GStreamer element class. Override the vmethods to implement the element functionality.

record

Hierarchy

  • ElementClass

Index

Constructors

Properties

elementfactory: Gst.ElementFactory

the #GstElementFactory that creates these elements

field
metadata: object

metadata for elements of this class

field
numpadtemplates: number

the number of padtemplates

field
pad_templ_cookie: number

changed whenever the padtemplates change

field
padtemplates: object[]

a #GList of #GstPadTemplate

field
parent_class: Gst.ObjectClass

the parent class structure

field
name: string

Methods

  • add_metadata(klass: Function | GType<unknown> | Gst.Element, key: string, value: string): void
  • Adds a padtemplate to an element class. This is mainly used in the _class_init functions of classes. If a pad template with the same name as an already existing one is added the old one is replaced by the new one.

    templ's reference count will be incremented, and any floating reference will be removed (see gst_object_ref_sink())

    Parameters

    Returns void

  • add_static_metadata(klass: Function | GType<unknown> | Gst.Element, key: string, value: string): void
  • Set key with value as metadata in klass.

    Same as gst_element_class_add_metadata(), but value must be a static string or an inlined string, as it will not be copied. (GStreamer plugins will be made resident once loaded, so this function can be used even from dynamically loaded plugins.)

    Parameters

    • klass: Function | GType<unknown> | Gst.Element
    • key: string

      the key to set

    • value: string

      the value to set

    Returns void

  • Adds a pad template to an element class based on the static pad template templ. This is mainly used in the _class_init functions of element implementations. If a pad template with the same name already exists, the old one is replaced by the new one.

    Parameters

    Returns void

  • Adds a pad template to an element class based on the static pad template templ. This is mainly used in the _class_init functions of element implementations. If a pad template with the same name already exists, the old one is replaced by the new one.

    Parameters

    • klass: Function | GType<unknown> | Gst.Element
    • static_templ: Gst.StaticPadTemplate

      #GstStaticPadTemplate to add as pad template to the element class.

    • pad_type: GType<unknown>

      The #GType of the pad to create

    Returns void

  • get_metadata(klass: Function | GType<unknown> | Gst.Element, key: string): string
  • Retrieves a padtemplate from element_class with the given name.

    If you use this function in the #GInstanceInitFunc of an object class that has subclasses, make sure to pass the g_class parameter of the #GInstanceInitFunc here.

    Parameters

    • element_class: Function | GType<unknown> | Gst.Element
    • name: string

      the name of the #GstPadTemplate to get.

    Returns Gst.PadTemplate

  • Retrieves a list of the pad templates associated with element_class. The list must not be modified by the calling code.

    If you use this function in the #GInstanceInitFunc of an object class that has subclasses, make sure to pass the g_class parameter of the #GInstanceInitFunc here.

    Parameters

    Returns Gst.PadTemplate[]

  • set_metadata(klass: Function | GType<unknown> | Gst.Element, longname: string, classification: string, description: string, author: string): void
  • Sets the detailed information for a #GstElementClass.

    This function is for use in _class_init functions only.

    Parameters

    • klass: Function | GType<unknown> | Gst.Element
    • longname: string

      The long English name of the element. E.g. "File Sink"

    • classification: string

      String describing the type of element, as an unordered list separated with slashes ('/'). See draft-klass.txt of the design docs for more details and common types. E.g: "Sink/File"

    • description: string

      Sentence describing the purpose of the element. E.g: "Write stream to a file"

    • author: string

      Name and contact details of the author(s). Use \n to separate multiple author metadata. E.g: "Joe Bloggs <joe.blogs at foo.com>"

    Returns void

  • set_static_metadata(klass: Function | GType<unknown> | Gst.Element, longname: string, classification: string, description: string, author: string): void
  • Sets the detailed information for a #GstElementClass.

    This function is for use in _class_init functions only.

    Same as gst_element_class_set_metadata(), but longname, classification, description, and author must be static strings or inlined strings, as they will not be copied. (GStreamer plugins will be made resident once loaded, so this function can be used even from dynamically loaded plugins.)

    Parameters

    • klass: Function | GType<unknown> | Gst.Element
    • longname: string

      The long English name of the element. E.g. "File Sink"

    • classification: string

      String describing the type of element, as an unordered list separated with slashes ('/'). See draft-klass.txt of the design docs for more details and common types. E.g: "Sink/File"

    • description: string

      Sentence describing the purpose of the element. E.g: "Write stream to a file"

    • author: string

      Name and contact details of the author(s). Use \n to separate multiple author metadata. E.g: "Joe Bloggs <joe.blogs at foo.com>"

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method