AgsPad

AgsPad — A composite widget to visualize a bunch of AgsChannel

Functions

void ags_pad_set_channel ()
void ags_pad_resize_lines ()
void ags_pad_map_recall ()
GList * ags_pad_find_port ()
void ags_pad_play ()
AgsPad * ags_pad_new ()
#define AGS_IS_PAD()
#define AGS_PAD()
#define AGS_PAD_CLASS()
#define AGS_PAD_GET_CLASS()
GType ags_pad_get_type ()

Properties

AgsChannel * channel Read / Write

Signals

gpointer find-port Run Last
void map-recall Run Last
void resize-lines Run Last
void set-channel Run Last

Types and Values

#define AGS_PAD_DEFAULT_VERSION
#define AGS_PAD_DEFAULT_BUILD_ID
enum AgsPadFlags
#define AGS_TYPE_PAD
struct AgsPad
struct AgsPadClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBox
                        ╰── GtkVBox
                            ╰── AgsPad
                                ├── AgsDrumInputPad
                                ├── AgsDrumOutputPad
                                ├── AgsMixerInputPad
                                ├── AgsPanelInputPad
                                ╰── AgsSynthInputPad

Implemented Interfaces

AgsPad implements AtkImplementorIface, GtkBuildable, GtkOrientable, AgsConnectable and AgsPlugin.

Includes

#include <ags/X/ags_pad.h>

Description

AgsPad is a composite widget to visualize a bunch of AgsChannel. It should be packed by an AgsMachine.

Functions

ags_pad_set_channel ()

void
ags_pad_set_channel (AgsPad *pad,
                     AgsChannel *channel);

Is emitted as channel gets modified.

Parameters

pad

an AgsPad

  

channel

the AgsChannel to set

  

Since: 1.0.0

ags_pad_resize_lines ()

void
ags_pad_resize_lines (AgsPad *pad,
                      GType line_type,
                      guint audio_channels,
                      guint audio_channels_old);

Resize the count of AgsLine packe by AgsPad.

Parameters

pad

the AgsPad to resize

  

line_type

channel type, either AGS_TYPE_INPUT or AGS_TYPE_OUTPUT

  

audio_channels

count of lines

  

audio_channels_old

old count of lines

  

Since: 1.0.0

ags_pad_map_recall ()

void
ags_pad_map_recall (AgsPad *pad,
                    guint output_pad_start);

Start of output pad

Parameters

pad

the AgsPad to resize

  

output_pad_start

start of output pad

  

Since: 1.0.0

ags_pad_find_port ()

GList *
ags_pad_find_port (AgsPad *pad);

Lookup ports of assigned recalls.

Parameters

pad

an AgsPad

  

Returns

an GList containing all related AgsPort

Since: 1.0.0

ags_pad_play ()

void
ags_pad_play (AgsPad *pad);

ags_pad_new ()

AgsPad *
ags_pad_new (AgsChannel *channel);

Creates an AgsPad

Parameters

channel

the bunch of channel to visualize

  

Returns

a new AgsPad

Since: 1.0.0

AGS_IS_PAD()

#define AGS_IS_PAD(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_PAD))

AGS_PAD()

#define AGS_PAD(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PAD, AgsPad))

AGS_PAD_CLASS()

#define AGS_PAD_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_PAD, AgsPadClass))

AGS_PAD_GET_CLASS()

#define AGS_PAD_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_PAD, AgsPadClass))

ags_pad_get_type ()

GType
ags_pad_get_type (void);

Types and Values

AGS_PAD_DEFAULT_VERSION

#define AGS_PAD_DEFAULT_VERSION "0.4.2\0"

AGS_PAD_DEFAULT_BUILD_ID

#define AGS_PAD_DEFAULT_BUILD_ID "CEST 02-10-2014 19:36\0"

enum AgsPadFlags

Members

AGS_PAD_CONNECTED

    

AGS_PAD_SHOW_GROUPING

    

AGS_PAD_GROUP_ALL

    

AGS_PAD_GROUP_LINE

    

AGS_PAD_MAPPED_RECALL

    

AGS_PAD_PREMAPPED_RECALL

    

AGS_TYPE_PAD

#define AGS_TYPE_PAD                (ags_pad_get_type())

struct AgsPad

struct AgsPad;

struct AgsPadClass

struct AgsPadClass {
  GtkVBoxClass vbox;

  void (*set_channel)(AgsPad *pad, AgsChannel *channel);

  void (*resize_lines)(AgsPad *pad, GType line_type,
		       guint audio_channels, guint audio_channels_old);
  void (*map_recall)(AgsPad *pad,
		     guint output_pad_start);
  GList* (*find_port)(AgsPad *pad);
};

Property Details

The “channel” property

  “channel”                  AgsChannel *

The start of a bunch of AgsChannel to visualize.

Flags: Read / Write

Since: 1.0.0

Signal Details

The “find-port” signal

gpointer
user_function (AgsPad  *pad,
               gpointer user_data)

Parameters

pad

the AgsPad to resize

  

user_data

user data set when the signal handler was connected.

  

Returns

a GList with associated ports

The ::find-port retrieves all associated ports

Flags: Run Last

The “map-recall” signal

void
user_function (AgsPad  *pad,
               guint    output_pad_start,
               gpointer user_data)

The ::map-recall as recall should be mapped

Parameters

pad

the AgsPad to resize

  

output_pad_start

start of output pad

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

The “resize-lines” signal

void
user_function (AgsPad  *pad,
               gulong   line_type,
               guint    audio_channels,
               guint    audio_channels_old,
               gpointer user_data)

The ::resize-lines is emitted as count of lines pack is modified.

Parameters

pad

the AgsPad to resize

  

line_type

the channel type

  

audio_channels

count of lines

  

audio_channels_old

old count of lines

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

The “set-channel” signal

void
user_function (AgsPad  *pad,
               GObject *channel,
               gpointer user_data)

The ::set-channel signal notifies about changed channel.

Parameters

pad

the AgsPad to modify

  

channel

the AgsChannel to set

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

Generated by GTK-Doc V1.25