Clapper.EnhancerProxy
Description: Reference for Clapper.EnhancerProxy

### Class

# ClapperEnhancerProxy

since: 0.10

#### Description [src]

    final class Clapper.EnhancerProxy : Gst.Object
    {
      /* No available fields */
    }

An intermediary between player and enhancer plugin.

Applications can use this to inspect enhancer information, its properties and configure them.

Clapper player manages all enhancers internally, including creating when needed and destroying them later. Instead, it provides access to so called enhancer proxy objects which allow to browse available enhancer properties and store their config either globally or locally for each player instance.

Use `clapper_get_global_enhancer_proxies()` or `ClapperPlayer:enhancer-proxies` property to access a `ClapperEnhancerProxyList` of available enhancer proxies. While both lists include the same amount of proxies, the difference is which properties can be configured in which list. Only the latter allows tweaking of local (per player instance) properties using `clapper_enhancer_proxy_set_locally()` function.

Available since: 0.10

#### Hierarchy

#### Ancestors

- GstObject
- GInitiallyUnowned
- GObject

#### Instance methods

###### clapper_enhancer_proxy_extra_data_lists_value

A convenience function to check whether `proxy` plugin file has an extra data field with `key` that among separated list of values includes `value` (works on single value lists too).

since: 0.10

###### clapper_enhancer_proxy_get_description

Get description from enhancer plugin info file.

since: 0.10

###### clapper_enhancer_proxy_get_extra_data

Get extra data from enhancer plugin info file specified by `key`.

since: 0.10

###### clapper_enhancer_proxy_get_friendly_name

Get a name from enhancer plugin info file. Can be used for showing in UI and such.

since: 0.10

###### clapper_enhancer_proxy_get_module_dir

Get a path to the directory from which enhancer is loaded.

since: 0.10

###### clapper_enhancer_proxy_get_module_name

Get name of the module from enhancer plugin info file. This value is used to uniquely identify a particular plugin.

since: 0.10

###### clapper_enhancer_proxy_get_settings

Get `GSettings` of an enhancer.

since: 0.10

###### clapper_enhancer_proxy_get_target_creation_allowed

Get whether it is allowed to create instances of enhancer that this proxy targets.

since: 0.10

###### clapper_enhancer_proxy_get_target_interfaces

Get an array of interfaces that target enhancer implements.

since: 0.10

###### clapper_enhancer_proxy_get_target_properties

Get an array of properties in target enhancer.

since: 0.10

###### clapper_enhancer_proxy_get_version

Get version string from enhancer plugin info file.

since: 0.10

###### clapper_enhancer_proxy_set_locally

Configure one or more properties which have `CLAPPER_ENHANCER_PARAM_LOCAL` flag set on the target enhancer instance.

since: 0.10

###### clapper_enhancer_proxy_set_locally_with_table

Same as `clapper_enhancer_proxy_set_locally()`, but to configure uses `GHashTable` with string keys and `GValue` as their values.

since: 0.10

###### clapper_enhancer_proxy_set_target_creation_allowed

Set whether to allow instances of proxy target to be created.

since: 0.10

###### clapper_enhancer_proxy_target_has_interface

A convenience function to check if target enhancer implements given interface.

since: 0.10

##### Methods inherited from GstObject (27)

Please see GstObject for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Properties

###### Clapper.EnhancerProxy:description

Description from enhancer plugin info file.

since: 0.10

###### Clapper.EnhancerProxy:friendly-name

Name from enhancer plugin info file.

since: 0.10

###### Clapper.EnhancerProxy:module-dir

Module directory.

since: 0.10

###### Clapper.EnhancerProxy:module-name

Module name from enhancer plugin info file.

since: 0.10

###### Clapper.EnhancerProxy:target-creation-allowed

Whether to allow instances of proxy target to be created.

since: 0.10

###### Clapper.EnhancerProxy:version

Version from enhancer plugin info file.

since: 0.10

##### Properties inherited from GstObject (2)

###### Gst.Object:name

No description available.

###### Gst.Object:parent

The parent of the object. Please note, that when changing the ‘parent’ property, we don’t emit `GObject::notify` and `GstObject::deep-notify` signals due to locking issues. In some cases one can use `GstBin::element-added` or `GstBin::element-removed` signals on the parent to achieve a similar effect.

#### Signals

##### Signals inherited from GstObject (1)

###### GstObject::deep-notify

The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct ClapperEnhancerProxyClass {
      GstObjectClass parent_class;

    }

No description available.

###### Class members

`parent_class: GstObjectClass`

  No description available.