EnhancerProxy

Object Hierarchy:

Description:

[ CCode ( type_id = "clapper_enhancer_proxy_get_type ()" ) ]
[ Version ( since = "0.10" ) ]
public class EnhancerProxy : Object

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 [func@Clapper.get_global_enhancer_proxies] or [property@Clapper.Player:enhancer-proxies] property to access a [ class@Clapper.EnhancerProxyList] 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 [ method@Clapper.EnhancerProxy.set_locally] function.

Namespace: Clapper

Package: clapper-0.0

Content:

Properties:

public string description { get; }
Description from enhancer plugin info file.
public string friendly_name { get; }
Name from enhancer plugin info file.
public string module_dir { get; }
Module directory.
public string module_name { get; }
Module name from enhancer plugin info file.
public bool target_creation_allowed { get; set; }
Whether to allow instances of proxy target to be created.
public string version { get; }
Version from enhancer plugin info file.

Creation methods:

protected EnhancerProxy ()

Methods:

public bool extra_data_lists_value (string key, string value)
A convenience function to check whether this plugin file has an extra data field with key that among separated list of values includes value (works on single value lists too).
public unowned string? get_description ()
Get description from enhancer plugin info file.
public unowned string? get_extra_data (string key)
Get extra data from enhancer plugin info file specified by key.
public unowned string get_friendly_name ()
Get a name from enhancer plugin info file.
public unowned string get_module_dir ()
Get a path to the directory from which enhancer is loaded.
public unowned string get_module_name ()
Get name of the module from enhancer plugin info file.
public Settings? get_settings ()
Get Settings of an enhancer.
public bool get_target_creation_allowed ()
Get whether it is allowed to create instances of enhancer that this proxy targets.
public unowned Type[]? get_target_interfaces ()
Get an array of interfaces that target enhancer implements.
public unowned ParamSpec[]? get_target_properties ()
Get an array of properties in target enhancer.
public unowned string? get_version ()
Get version string from enhancer plugin info file.
public void set_locally_with_table (HashTable<string,Value?> table)
Same as [method@Clapper.
public void set_target_creation_allowed (bool allowed)
Set whether to allow instances of proxy target to be created.
public bool target_has_interface (Type iface_type)
A convenience function to check if target enhancer implements given interface.

Inherited Members:

All known members inherited from class Gst.Object

All known members inherited from class GLib.Object