RB.PlayerGstFilter¶

Implementations:: None

Methods¶

	`add_filter` (element)
	`remove_filter` (element)

Virtual Methods¶

	`do_add_filter` (element)
	`do_filter_inserted` (filter)
	`do_filter_pre_remove` (filter)
	`do_remove_filter` (element)

Properties¶

None

Signals¶

Name	Short Description
`filter-inserted`	The ‘filter-inserted’ signal is emitted when the tee element has been inserted into the pipeline and fully linked
`filter-pre-remove`	The ‘filter-pre-remove’ signal is emitted immediately before the element is unlinked and removed from the pipeline

Fields¶

None

Class Details¶

class RB.PlayerGstFilter¶

Bases:: GObject.GInterface
Structure:: RB.PlayerGstFilterIface

add_filter(element)¶

Parameters:: element (Gst.Element) – new filter element (or bin) to add
Returns:: True if the filter will be added
Return type:: bool

Adds a new filter to the playback pipeline. The filter may not be inserted immediately. The ‘filter-inserted’ signal will be emitted when this actually happens.

remove_filter(element)¶

Parameters:: element (Gst.Element) – the filter element (or bin) to remove
Returns:: True if the filter was found and will be removed
Return type:: bool

Removes a filter from the playback pipeline. The filter may not be removed immediately. The ‘filter-pre-remove’ signal will be emitted immediately before this actually happens.

do_add_filter(element) virtual¶

Parameters:: element (Gst.Element) – new filter element (or bin) to add
Returns:: True if the filter will be added
Return type:: bool

Adds a new filter to the playback pipeline. The filter may not be inserted immediately. The ‘filter-inserted’ signal will be emitted when this actually happens.

do_filter_inserted(filter) virtual¶

Parameters:: filter (Gst.Element) –

do_filter_pre_remove(filter) virtual¶

Parameters:: filter (Gst.Element) –

do_remove_filter(element) virtual¶

Parameters:: element (Gst.Element) – the filter element (or bin) to remove
Returns:: True if the filter was found and will be removed
Return type:: bool

Removes a filter from the playback pipeline. The filter may not be removed immediately. The ‘filter-pre-remove’ signal will be emitted immediately before this actually happens.

Signal Details¶

RB.PlayerGstFilter.signals.filter_inserted(player_gst_filter, filter)¶

Signal Name:

filter-inserted

Flags:

RUN_LAST, NO_RECURSE

Parameters:

player_gst_filter (RB.PlayerGstFilter) – The object which received the signal
filter (GObject.Object) – the element which has been inserted

The ‘filter-inserted’ signal is emitted when the tee element has been inserted into the pipeline and fully linked

RB.PlayerGstFilter.signals.filter_pre_remove(player_gst_filter, filter)¶

Signal Name:

filter-pre-remove

Flags:

RUN_LAST, NO_RECURSE

Parameters:

player_gst_filter (RB.PlayerGstFilter) – The object which received the signal
filter (GObject.Object) – the element which is about to be removed

The ‘filter-pre-remove’ signal is emitted immediately before the element is unlinked and removed from the pipeline