AgsEffectBridge

AgsEffectBridge — A composite widget to visualize a bunch of AgsChannel

Stability Level

Stable, unless otherwise indicated

Functions

Properties

AgsAudio * audio Read / Write
guint buffer-size Read / Write
guint format Read / Write
guint samplerate Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBox
                    ╰── AgsEffectBridge
                        ├── AgsFFPlayerBridge
                        ╰── AgsMatrixBridge

Implemented Interfaces

AgsEffectBridge implements AtkImplementorIface, GtkBuildable, GtkOrientable and AgsConnectable.

Includes

#include <ags/X/ags_effect_bridge.h>

Description

AgsEffectBridge is a composite widget containing AgsEffectBulk or AgsEffectPad. It should be packed by an AgsMachine.

Functions

ags_effect_bridge_samplerate_changed ()

void
ags_effect_bridge_samplerate_changed (AgsEffectBridge *effect_bridge,
                                      guint samplerate,
                                      guint old_samplerate);

Notify about samplerate changed.

Parameters

effect_bridge

the AgsEffectBridge

 

samplerate

the samplerate

 

old_samplerate

the old samplerate

 

Since: 3.0.0


ags_effect_bridge_buffer_size_changed ()

void
ags_effect_bridge_buffer_size_changed (AgsEffectBridge *effect_bridge,
                                       guint buffer_size,
                                       guint old_buffer_size);

Notify about buffer_size changed.

Parameters

effect_bridge

the AgsEffectBridge

 

buffer_size

the buffer_size

 

old_buffer_size

the old buffer_size

 

Since: 3.0.0


ags_effect_bridge_format_changed ()

void
ags_effect_bridge_format_changed (AgsEffectBridge *effect_bridge,
                                  guint format,
                                  guint old_format);

Notify about format changed.

Parameters

effect_bridge

the AgsEffectBridge

 

format

the format

 

old_format

the old format

 

Since: 3.0.0


ags_effect_bridge_resize_audio_channels ()

void
ags_effect_bridge_resize_audio_channels
                               (AgsEffectBridge *effect_bridge,
                                guint new_size,
                                guint old_size);

Resize audio channel allocation.

Parameters

effect_bridge

the AgsEffectBridge

 

new_size

new allocation

 

old_size

old allocation

 

Since: 3.0.0


ags_effect_bridge_resize_pads ()

void
ags_effect_bridge_resize_pads (AgsEffectBridge *effect_bridge,
                               GType channel_type,
                               guint new_size,
                               guint old_size);

Resize pad allocation.

Parameters

effect_bridge

the AgsEffectBridge

 

channel_type

the channel GType

 

new_size

new allocation

 

old_size

old allocation

 

Since: 3.0.0


ags_effect_bridge_map_recall ()

void
ags_effect_bridge_map_recall (AgsEffectBridge *effect_bridge);

You may want the effect_bridge to add its default recall.

Parameters

effect_bridge

the AgsEffectBridge to add its default recall.

 

Since: 3.0.0


ags_effect_bridge_find_port ()

GList *
ags_effect_bridge_find_port (AgsEffectBridge *effect_bridge);

Parameters

effect_bridge

the AgsEffectBridge

 

Returns

an GList containing all related AgsPort

Lookup ports of associated recalls.

Since: 3.0.0


ags_effect_bridge_new ()

AgsEffectBridge *
ags_effect_bridge_new (AgsAudio *audio);

Creates an AgsEffectBridge

Parameters

audio

the AgsAudio to visualize

 

Returns

a new AgsEffectBridge

Since: 3.0.0


AGS_EFFECT_BRIDGE()

#define AGS_EFFECT_BRIDGE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_EFFECT_BRIDGE, AgsEffectBridge))

AGS_EFFECT_BRIDGE_CLASS()

#define AGS_EFFECT_BRIDGE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_EFFECT_BRIDGE, AgsEffectBridgeClass))

AGS_EFFECT_BRIDGE_GET_CLASS()

#define AGS_EFFECT_BRIDGE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_EFFECT_BRIDGE, AgsEffectBridgeClass))

AGS_IS_EFFECT_BRIDGE()

#define AGS_IS_EFFECT_BRIDGE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_EFFECT_BRIDGE))

AGS_IS_EFFECT_BRIDGE_CLASS()

#define AGS_IS_EFFECT_BRIDGE_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE((class), AGS_TYPE_EFFECT_BRIDGE))

ags_effect_bridge_get_type ()

GType
ags_effect_bridge_get_type (void);

Types and Values

AGS_EFFECT_BRIDGE_DEFAULT_VERSION

#define AGS_EFFECT_BRIDGE_DEFAULT_VERSION "0.7.8"

AGS_EFFECT_BRIDGE_DEFAULT_BUILD_ID

#define AGS_EFFECT_BRIDGE_DEFAULT_BUILD_ID "CEST 01-03-2016 00:23"

AGS_EFFECT_BRIDGE_MAX_COLUMNS

#define AGS_EFFECT_BRIDGE_MAX_COLUMNS (2)

enum AgsEffectBridgeFlags

Members

AGS_EFFECT_BRIDGE_MAPPED_RECALL

   

AGS_EFFECT_BRIDGE_PREMAPPED_RECALL

   

AGS_EFFECT_BRIDGE_CONNECTED

   

AGS_EFFECT_BRIDGE_DISPLAY_INPUT

   

AGS_EFFECT_BRIDGE_BULK_OUTPUT

   

AGS_EFFECT_BRIDGE_DISPLAY_OUTPUT

   

AGS_EFFECT_BRIDGE_BULK_INPUT

   

AGS_TYPE_EFFECT_BRIDGE

#define AGS_TYPE_EFFECT_BRIDGE                (ags_effect_bridge_get_type())

struct AgsEffectBridge

struct AgsEffectBridge;

struct AgsEffectBridgeClass

struct AgsEffectBridgeClass {
  GtkBoxClass box;

  void (*samplerate_changed)(AgsEffectBridge *effect_bridge,
			     guint samplerate, guint old_samplerate);
  void (*buffer_size_changed)(AgsEffectBridge *effect_bridge,
			      guint buffer_size, guint old_buffer_size);
  void (*format_changed)(AgsEffectBridge *effect_bridge,
			 guint format, guint old_format);

  void (*resize_audio_channels)(AgsEffectBridge *effect_bridge,
				guint new_size, guint old_size);
  void (*resize_pads)(AgsEffectBridge *effect_bridge,
		      GType channel_type,
		      guint new_size, guint old_size);

  void (*map_recall)(AgsEffectBridge *effect_bridge);
  GList* (*find_port)(AgsEffectBridge *effect_bridge);
};

Property Details

The “audio” property

  “audio”                    AgsAudio *

The start of a bunch of AgsAudio to visualize.

Owner: AgsEffectBridge

Flags: Read / Write

Since: 3.0.0


The “buffer-size” property

  “buffer-size”              guint

The buffer length.

Owner: AgsEffectBridge

Flags: Read / Write

Default value: 1024

Since: 3.0.0


The “format” property

  “format”                   guint

The format.

Owner: AgsEffectBridge

Flags: Read / Write

Default value: 16

Since: 3.0.0


The “samplerate” property

  “samplerate”               guint

The samplerate.

Owner: AgsEffectBridge

Flags: Read / Write

Default value: 48000

Since: 3.0.0

Signal Details

The “buffer-size-changed” signal

void
user_function (AgsEffectBridge *effect_bridge,
               guint            buffer_size,
               guint            old_buffer_size,
               gpointer         user_data)

The ::buffer-size-changed signal notifies about changed buffer size.

Parameters

effect_bridge

the AgsEffectBridge

 

buffer_size

the buffer size

 

old_buffer_size

the old buffer size

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “find-port” signal

gpointer
user_function (AgsEffectBridge *effect_bridge,
               gpointer         user_data)

Parameters

effect_bridge

the AgsEffectBridge to resize

 

user_data

user data set when the signal handler was connected.

 

Returns

a GList with associated ports

The ::find-port as recall should be mapped

Flags: Run Last

Since: 3.0.0


The “format-changed” signal

void
user_function (AgsEffectBridge *effect_bridge,
               guint            format,
               guint            old_format,
               gpointer         user_data)

The ::format-changed signal notifies about changed format.

Parameters

effect_bridge

the AgsEffectBridge

 

format

the format

 

old_format

the old format

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “map-recall” signal

void
user_function (AgsEffectBridge *effect_bridge,
               gpointer         user_data)

The ::map-recall should be used to add the effect_bridge's default recall.

Parameters

effect_bridge

the AgsEffectBridge

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “resize-audio-channels” signal

void
user_function (AgsEffectBridge *effect_bridge,
               guint            channel,
               guint            new_size,
               gpointer         user_data)

The ::resize-audio-channels signal notifies about changed channel allocation within audio.

Parameters

effect_bridge

the AgsEffectBridge to modify

 

channel

the AgsChannel to set

 

new_size

the new size

 

old_size

the old size

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “resize-pads” signal

void
user_function (AgsEffectBridge *effect_bridge,
               gulong           channel,
               guint            channel_type,
               guint            new_size,
               gpointer         user_data)

The ::resize-pads signal notifies about changed channel allocation within audio.

Parameters

effect_bridge

the AgsEffectBridge to modify

 

channel

the AgsChannel to set

 

channel_type

either AGS_TYPE_INPUT or AGS_TYPE_OUTPUT

 

new_size

the new size

 

old_size

the old size

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “samplerate-changed” signal

void
user_function (AgsEffectBridge *effect_bridge,
               guint            samplerate,
               guint            old_samplerate,
               gpointer         user_data)

The ::samplerate-changed signal notifies about changed samplerate.

Parameters

effect_bridge

the AgsEffectBridge

 

samplerate

the samplerate

 

old_samplerate

the old samplerate

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0