DexterPluginSampler

DexterPluginSampler — GObject base class for Libdexter samplers

Synopsis

#include <dexterplugin.h>

#define             DEXTERPLUGIN_SAMPLER_ERROR
enum                DexterPluginSamplerError;

                    DexterPluginSampler;
struct              DexterPluginSamplerClass;

void                (*DexterPluginSamplerDataCallback)  (gpointer sampler,
                                                         gpointer sampler_data);

Object Hierarchy

  GObject
   +----DexterPluginSampler

Known Derived Interfaces

DexterPluginSampler is required by DexterPluginISampler.

Properties

  "private1"                 GObject*              : Write / Construct Only
  "private2"                 gpointer              : Write / Construct Only
  "private3"                 gpointer              : Write / Construct Only
  "private4"                 guint                 : Write / Construct Only

Description

GObject base class from which all Libdexter samplers must be derived.

This abstract base class is the foundation class of Libdexter samplers. Plugin sampler services must derive from this class to be operable within Libdexter. Helper macros are provided to simplify defining sampler services that derive from this class.

Details

DEXTERPLUGIN_SAMPLER_ERROR

#define DEXTERPLUGIN_SAMPLER_ERROR dexterplugin_sampler_error_quark()

The error domain of the libdexterplugin sampler subsystem.

enum DexterPluginSamplerError

typedef enum {
  DEXTERPLUGIN_SAMPLER_ERROR_FAILED
} DexterPluginSamplerError;

Error codes for DexterPluginSampler operations.

DEXTERPLUGIN_SAMPLER_ERROR_FAILED

 general failure.

DexterPluginSampler

typedef struct _DexterPluginSampler DexterPluginSampler;

Definition of base type for sampler services.

struct DexterPluginSamplerClass

struct DexterPluginSamplerClass {
  GObjectClass parent_class;
};

Definition of base class type for sampler services.

GObjectClass parent_class;

 parent class.

DexterPluginSamplerDataCallback ()

void                (*DexterPluginSamplerDataCallback)  (gpointer sampler,
                                                         gpointer sampler_data);

Signature of callbacks executed by plugin samplers to notify users of data changes after sampling.

sampler :

 gpointer to sampler that generated the callback.

sampler_data :

 gpointer to sampler data as defined by the plugin.

Property Details

The "private1" property

  "private1"                 GObject*              : Write / Construct Only

This property is private to the library.

The "private2" property

  "private2"                 gpointer              : Write / Construct Only

This property is private to the library.

The "private3" property

  "private3"                 gpointer              : Write / Construct Only

This property is private to the library.

The "private4" property

  "private4"                 guint                 : Write / Construct Only

This property is private to the library.

Default value: 0

Generated by GTK-Doc V1.18