GstAudio.AudioFilter

g GObject.InitiallyUnowned GObject.InitiallyUnowned Gst.Object Gst.Object GObject.InitiallyUnowned->Gst.Object GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gst.Element Gst.Element GstBase.BaseTransform GstBase.BaseTransform Gst.Element->GstBase.BaseTransform Gst.Object->Gst.Element GstAudio.AudioFilter GstAudio.AudioFilter GstBase.BaseTransform->GstAudio.AudioFilter

Subclasses:None

Fields

Inherited:Gst.Element (3), Gst.Object (1), GObject.Object (1)
Name Type Access Description
basetransform GstBase.BaseTransform r  
info GstAudio.AudioInfo r  

Class Details

class GstAudio.AudioFilter(**kwargs)
Bases:GstBase.BaseTransform
Abstract:Yes
Structure:GstAudio.AudioFilterClass

GstAudio.AudioFilter is a GstBase.BaseTransform -derived base class for simple audio filters, ie. those that output the same format that they get as input.

GstAudio.AudioFilter will parse the input format for you (with error checking) before calling your setup function. Also, elements deriving from GstAudio.AudioFilter may use GstAudio.AudioFilterClass.add_pad_templates() from their class_init function to easily configure the set of caps/formats that the element is able to handle.

Derived classes should override the GstAudio.AudioFilter.do_setup() and GstBase.BaseTransform.do_transform_ip() and/or GstBase.BaseTransform.do_transform() virtual functions in their class_init function.

classmethod add_pad_templates(allowed_caps)
Parameters:allowed_caps (Gst.Caps) – what formats the filter can handle, as Gst.Caps

Convenience function to add pad templates to this element class, with allowed_caps as the caps that can be handled.

This function is usually used from within a GObject.Object class_init function.

do_setup(info) virtual
Parameters:info (GstAudio.AudioInfo) –
Return type:bool