AgsPad

AgsPad — A composite widget to visualize a bunch of AgsChannel

Stability Level

Stable, unless otherwise indicated

Functions

Types and Values

Includes

#include <ags/app/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_test_flags ()

gboolean
ags_pad_test_flags (AgsPad *pad,
                    guint flags);

Test flags of pad .

Parameters

pad

the AgsPad

 

flags

the flags

 

Returns

TRUE if flags is set, otherwise FALSE

Since: 4.5.0


ags_pad_set_flags ()

void
ags_pad_set_flags (AgsPad *pad,
                   guint flags);

Set flags of pad .

Parameters

pad

the AgsPad

 

flags

the flags

 

Since: 4.5.0


ags_pad_unset_flags ()

void
ags_pad_unset_flags (AgsPad *pad,
                     guint flags);

Unset flags of pad .

Parameters

pad

the AgsPad

 

flags

the flags

 

Since: 4.5.0


ags_pad_samplerate_changed ()

void
ags_pad_samplerate_changed (AgsPad *pad,
                            guint samplerate,
                            guint old_samplerate);

Notify about samplerate changed.

Parameters

pad

the AgsPad

 

samplerate

the samplerate

 

old_samplerate

the old samplerate

 

Since: 3.0.0


ags_pad_buffer_size_changed ()

void
ags_pad_buffer_size_changed (AgsPad *pad,
                             guint buffer_size,
                             guint old_buffer_size);

Notify about buffer_size changed.

Parameters

pad

the AgsPad

 

buffer_size

the buffer_size

 

old_buffer_size

the old buffer_size

 

Since: 3.0.0


ags_pad_format_changed ()

void
ags_pad_format_changed (AgsPad *pad,
                        guint format,
                        guint old_format);

Notify about format changed.

Parameters

pad

the AgsPad

 

format

the format

 

old_format

the old format

 

Since: 3.0.0


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: 3.0.0


ags_pad_get_line ()

GList *
ags_pad_get_line (AgsPad *pad);

Get line of pad .

Parameters

pad

the AgsPad

 

Returns

the GList containing AgsLine

Since: 4.0.0


ags_pad_add_line ()

void
ags_pad_add_line (AgsPad *pad,
                  AgsLine *line,
                  guint x,
                  guint y,
                  guint width,
                  guint height);

Add line to pad .

Parameters

pad

the AgsPad

 

line

the AgsLine

 

x

the x position

 

y

the y position

 

width

the width

 

height

the height

 

Since: 4.0.0


ags_pad_remove_line ()

void
ags_pad_remove_line (AgsPad *pad,
                     AgsLine *line);

Remove line from pad .

Parameters

pad

the AgsPad

 

line

the AgsLine

 

Since: 4.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: 3.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: 3.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: 3.0.0


ags_pad_refresh_port ()

void
ags_pad_refresh_port (AgsPad *pad);

Notify about to refresh ports.

Parameters

pad

the AgsPad

 

Since: 4.2.2


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: 3.0.0

Types and Values

AGS_PAD_DEFAULT_VERSION

#define AGS_PAD_DEFAULT_VERSION "4.5.0"

AGS_PAD_DEFAULT_BUILD_ID

#define AGS_PAD_DEFAULT_BUILD_ID "Tue Mar 28 06:49:41 UTC 2023"

enum AgsPadFlags

Members

AGS_PAD_SHOW_GROUP

   

AGS_PAD_SHOW_MUTE

   

AGS_PAD_SHOW_SOLO

   

AGS_PAD_SHOW_PLAY

   

AGS_PAD_GROUP_ALL

   

AGS_PAD_GROUP_LINE

   

AGS_PAD_MAPPED_RECALL

   

AGS_PAD_PREMAPPED_RECALL

   

AGS_PAD_BLOCK_PLAY

   

AGS_PAD_BLOCK_STOP