AgsPreset

AgsPreset — presets

Functions

GQuark ags_preset_error_quark ()
GList * ags_preset_find_scope ()
GList * ags_preset_find_name ()
gboolean ags_preset_add_parameter ()
void ags_preset_remove_parameter ()
void ags_preset_get_parameter ()
AgsPreset * ags_preset_new ()
#define AGS_IS_PRESET()
#define AGS_PRESET()
#define AGS_PRESET_CLASS()
#define AGS_PRESET_GET_CLASS()
GType ags_preset_get_type ()

Properties

GObject * audio Read / Write
guint audio-channel-end Read / Write
guint audio-channel-start Read / Write
guint pad-end Read / Write
guint pad-start Read / Write
gchar * preset-name Read / Write
gchar * scope Read / Write
guint x-end Read / Write
guint x-start Read / Write

Types and Values

enum AgsPresetFlags
#define AGS_PRESET_ERROR
enum AgsPresetError
#define AGS_TYPE_PRESET
struct AgsPreset
struct AgsPresetClass

Object Hierarchy

    GObject
    ╰── AgsPreset

Includes

#include <ags/audio/ags_preset.h>

Description

The AgsPreset stores presets.

Functions

ags_preset_error_quark ()

GQuark
ags_preset_error_quark ();

ags_preset_find_scope ()

GList *
ags_preset_find_scope (GList *preset,
                       gchar *scope);

Find preset's scope in preset .

Parameters

preset

the GList containing AgsPreset

  

scope

the preset's scope

  

Returns

the next matching AgsPreset

Since: 1.0.0

ags_preset_find_name ()

GList *
ags_preset_find_name (GList *preset,
                      gchar *preset_name);

Find preset name in preset .

Parameters

preset

the GList containing AgsPreset

  

preset_name

the preset's name

  

Returns

the next matching AgsPreset

Since: 1.0.0

ags_preset_add_parameter ()

gboolean
ags_preset_add_parameter (AgsPreset *preset,
                          gchar *param_name,
                          GValue *value);

Add parameter to preset .

Parameters

preset

the AgsPreset

  

param_name

the parameter name

  

value

the value to add

  

Since: 1.0.0

ags_preset_remove_parameter ()

void
ags_preset_remove_parameter (AgsPreset *preset,
                             guint nth);

Remove parameter of preset .

Parameters

preset

the AgsPreset

  

nth

the nth parameter to remove

  

Since: 1.0.0

ags_preset_get_parameter ()

void
ags_preset_get_parameter (AgsPreset *preset,
                          gchar *param_name,
                          GValue *value,
                          GError **error);

Get parameter specified by param_name . If parameter not available the error is set to indicate the failure.

Parameters

preset

the AgsPreset

  

param_name

the parameter name

  

value

the return location of value

  

error

the GError

  

Since: 1.0.0

ags_preset_new ()

AgsPreset *
ags_preset_new ();

Creates an AgsPreset

Returns

a new AgsPreset

Since: 1.0.0

AGS_IS_PRESET()

#define AGS_IS_PRESET(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_PRESET))

AGS_PRESET()

#define AGS_PRESET(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PRESET, AgsPreset))

AGS_PRESET_CLASS()

#define AGS_PRESET_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_PRESET, AgsPresetClass))

AGS_PRESET_GET_CLASS()

#define AGS_PRESET_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_PRESET, AgsPresetClass))

ags_preset_get_type ()

GType
ags_preset_get_type ();

Types and Values

enum AgsPresetFlags

Enum values to control the behavior or indicate internal state of AgsPreset by enable/disable as flags.

Members

AGS_PRESET_CONNECTED

indicates the playback was connected by calling AgsConnectable::connect()

  

AGS_PRESET_ERROR

#define AGS_PRESET_ERROR (ags_preset_error_quark())

enum AgsPresetError

Members

AGS_PRESET_ERROR_NO_SUCH_PARAMETER

    

AGS_TYPE_PRESET

#define AGS_TYPE_PRESET                (ags_preset_get_type())

struct AgsPreset

struct AgsPreset;

struct AgsPresetClass

struct AgsPresetClass {
  GObjectClass gobject;
};

Property Details

The “audio” property

  “audio”                    GObject *

The AgsAudio belonging to.

Flags: Read / Write

Since: 1.0.0

The “audio-channel-end” property

  “audio-channel-end”        guint

The end audio channel to apply.

Flags: Read / Write

Default value: 0

Since: 1.0.0

The “audio-channel-start” property

  “audio-channel-start”      guint

The start audio channel to apply.

Flags: Read / Write

Default value: 0

Since: 1.0.0

The “pad-end” property

  “pad-end”                  guint

The end pad to apply.

Flags: Read / Write

Default value: 0

Since: 1.0.0

The “pad-start” property

  “pad-start”                guint

The start pad to apply.

Flags: Read / Write

Default value: 0

Since: 1.0.0

The “preset-name” property

  “preset-name”              gchar *

The preset name.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

The “scope” property

  “scope”                    gchar *

The preset's scope.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

The “x-end” property

  “x-end”                    guint

The end x to apply.

Flags: Read / Write

Default value: 0

Since: 1.0.0

The “x-start” property

  “x-start”                  guint

The start x to apply.

Flags: Read / Write

Default value: 0

Since: 1.0.0

Generated by GTK-Doc V1.27