Top |
AgsEffectLineAgsEffectLine — A composite widget to visualize a bunch of AgsChannel |
guint | buffer-size | Read / Write |
AgsChannel * | channel | Read / Write |
guint | format | Read / Write |
guint | samplerate | Read / Write |
void | add-plugin | Run Last |
void | buffer-size-changed | Run Last |
void | done | Run Last |
gpointer | find-port | Run Last |
void | format-changed | Run Last |
void | map-recall | Run Last |
void | refresh-port | Run Last |
void | remove-plugin | Run Last |
void | samplerate-changed | Run Last |
void | set-channel | Run Last |
#define | AGS_EFFECT_LINE_DEFAULT_VERSION |
#define | AGS_EFFECT_LINE_DEFAULT_BUILD_ID |
#define | AGS_EFFECT_LINE_COLUMNS_COUNT |
#define | AGS_EFFECT_LINE_SEPARATOR_FILENAME |
#define | AGS_EFFECT_LINE_SEPARATOR_EFFECT |
enum | AgsEffectLineFlags |
struct | AgsEffectLinePlugin |
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkBox ╰── AgsEffectLine ╰── AgsFFPlayerInputLine
AgsEffectLine is a composite widget to visualize one AgsChannel. It should be packed by an AgsEffectLine.
gboolean ags_effect_line_test_flags (AgsEffectLine *effect_line
,guint flags
);
Test flags
of effect_line
.
Since: 4.5.0
void ags_effect_line_set_flags (AgsEffectLine *effect_line
,guint flags
);
Set flags
of effect_line
.
Since: 4.5.0
void ags_effect_line_unset_flags (AgsEffectLine *effect_line
,guint flags
);
Unset flags
of effect_line
.
Since: 4.5.0
AgsEffectLinePlugin * ags_effect_line_plugin_alloc (AgsRecallContainer *play_container
,AgsRecallContainer *recall_container
,gchar *plugin_name
,gchar *filename
,gchar *effect
);
Allocate AgsEffectLinePlugin.
play_container |
||
recall_container |
||
plugin_name |
the plugin name |
|
filename |
the filename as string |
|
effect |
the effect as string |
Since: 3.3.0
void
ags_effect_line_plugin_free (AgsEffectLinePlugin *effect_line_plugin
);
Free effect_line_plugin
.
Since: 3.3.0
void ags_effect_line_samplerate_changed (AgsEffectLine *effect_line
,guint samplerate
,guint old_samplerate
);
Notify about samplerate changed.
effect_line |
the AgsEffectLine |
|
samplerate |
the samplerate |
|
old_samplerate |
the old samplerate |
Since: 3.0.0
void ags_effect_line_buffer_size_changed (AgsEffectLine *effect_line
,guint buffer_size
,guint old_buffer_size
);
Notify about buffer_size changed.
effect_line |
the AgsEffectLine |
|
buffer_size |
the buffer_size |
|
old_buffer_size |
the old buffer_size |
Since: 3.0.0
void ags_effect_line_format_changed (AgsEffectLine *effect_line
,guint format
,guint old_format
);
Notify about format changed.
Since: 3.0.0
void ags_effect_line_set_channel (AgsEffectLine *effect_line
,AgsChannel *channel
);
Is emitted as channel gets modified.
Since: 3.0.0
GList *
ags_effect_line_get_line_member (AgsEffectLine *effect_line
);
Get line member of effect_line
.
Since: 4.0.0
void ags_effect_line_add_line_member (AgsEffectLine *effect_line
,AgsLineMember *line_member
,guint x
,guint y
,guint width
,guint height
);
Add line_member
to effect_line
.
effect_line |
the AgsEffectLine |
|
line_member |
the AgsLineMember |
|
x |
the x position |
|
y |
the y position |
|
width |
the width |
|
height |
the height |
Since: 4.0.0
void ags_effect_line_remove_line_member (AgsEffectLine *effect_line
,AgsLineMember *line_member
);
Remove line_member
from effect_line
.
Since: 4.0.0
GList *
ags_effect_line_get_effect_separator (AgsEffectLine *effect_line
);
Get effect_line member of effect_line
.
Since: 4.2.14
void ags_effect_line_add_effect_separator (AgsEffectLine *effect_line
,AgsEffectSeparator *effect_separator
,guint x
,guint y
,guint width
,guint height
);
Add effect_separator
to effect_line
.
effect_line |
the AgsEffectLine |
|
effect_separator |
||
x |
the x position |
|
y |
the y position |
|
width |
the width |
|
height |
the height |
Since: 4.2.14
void ags_effect_line_remove_effect_separator (AgsEffectLine *effect_line
,AgsEffectSeparator *effect_separator
);
Remove effect_separator
from effect_line
.
Since: 4.2.14
void ags_effect_line_add_plugin (AgsEffectLine *effect_line
,GList *control_type_name
,AgsRecallContainer *play_container
,AgsRecallContainer *recall_container
,gchar *plugin_name
,gchar *filename
,gchar *effect
,guint start_audio_channel
,guint stop_audio_channel
,guint start_pad
,guint stop_pad
,gint position
,guint create_flags
,guint recall_flags
);
Add an effect by its filename and effect specifier.
effect_line |
the AgsEffectLine to modify |
|
control_type_name |
the GList containing string representation of a GType |
|
play_container |
an AgsRecallContainer to indetify what recall to use |
|
recall_container |
an AgsRecallContainer to indetify what recall to use |
|
plugin_name |
the plugin identifier |
|
filename |
the effect's filename |
|
effect |
the effect's name |
|
start_audio_channel |
the first audio channel to apply |
|
stop_audio_channel |
the last audio channel to apply |
|
start_pad |
the first pad to apply |
|
stop_pad |
the last pad to apply |
|
position |
the position to insert the recall |
|
create_flags |
modify the behaviour of this function |
|
recall_flags |
flags to be set for AgsRecall |
Since: 3.3.0
void ags_effect_line_remove_plugin (AgsEffectLine *effect_line
,guint nth
);
Remove an effect by its position.
Since: 3.3.0
void ags_effect_line_map_recall (AgsEffectLine *effect_line
,guint output_pad_start
);
You may want the effect_line
to add its default recall. This function
may call ags_effect_line_find_port()
.
effect_line |
the AgsEffectLine to add its default recall. |
|
output_pad_start |
the start channel's index |
Since: 3.0.0
GList *
ags_effect_line_find_port (AgsEffectLine *effect_line
);
Lookup ports of associated recalls.
Since: 3.0.0
void ags_effect_line_done (AgsEffectLine *effect_line
,GObject *recall_id
);
Notify about to stop playback of recall_id
.
Since: 3.0.0
void
ags_effect_line_refresh_port (AgsEffectLine *effect_line
);
Notify about to refresh ports.
Since: 4.2.2
GList *
ags_effect_line_find_next_grouped (GList *effect_line
);
Retrieve next grouped effect_line.
Since: 3.0.0
void
ags_effect_line_check_message (AgsEffectLine *effect_line
);
Check message queue for message envelopes.
Since: 3.0.0
gboolean
ags_effect_line_indicator_queue_draw_timeout
(GtkWidget *widget
);
Queue draw widget
Since: 3.0.0
AgsEffectLine *
ags_effect_line_new (AgsChannel *channel
);
Create a new instance of AgsEffectLine
Since: 3.0.0
#define AGS_EFFECT_LINE_DEFAULT_BUILD_ID "Tue Mar 28 06:49:41 UTC 2023"
#define AGS_EFFECT_LINE_SEPARATOR_FILENAME "ags-effect-line-separator-filename"
#define AGS_EFFECT_LINE_SEPARATOR_EFFECT "ags-effect-line-separator-effect"
“buffer-size”
property“buffer-size” guint
The buffer length.
Owner: AgsEffectLine
Flags: Read / Write
Default value: 1024
Since: 3.0.0
“channel”
property“channel” AgsChannel *
The start of a bunch of AgsChannel to visualize.
Owner: AgsEffectLine
Flags: Read / Write
Since: 3.0.0
“format”
property“format” guint
The format.
Owner: AgsEffectLine
Flags: Read / Write
Default value: 16
Since: 3.0.0
“samplerate”
property“samplerate” guint
The samplerate.
Owner: AgsEffectLine
Flags: Read / Write
Default value: 48000
Since: 3.0.0
“add-plugin”
signalvoid user_function (AgsEffectLine *effect_line, gpointer effect, GObject *arg2, GObject *arg3, char *arg4, char *arg5, char *arg6, guint arg7, guint arg8, guint arg9, guint arg10, int arg11, guint arg12, guint arg13, gpointer user_data)
The ::add-plugin signal notifies about added effect.
effect_line |
the AgsEffectLine to modify |
|
effect |
the effect's name |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.3.0
“buffer-size-changed”
signalvoid user_function (AgsEffectLine *effect_line, guint buffer_size, guint old_buffer_size, gpointer user_data)
The ::buffer-size-changed signal notifies about changed buffer size.
effect_line |
the AgsEffectLine |
|
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
“done”
signalvoid user_function (AgsEffectLine *effect_line, GObject *recall_id, gpointer user_data)
The ::done signal gets emited as audio stops playback.
effect_line |
the AgsEffectLine |
|
recall_id |
the AgsRecallID |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.0.0
“find-port”
signalgpointer user_function (AgsEffectLine *effect_line, gpointer user_data)
The ::find-port as recall should be mapped
effect_line |
the AgsEffectLine to resize |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.0.0
“format-changed”
signalvoid user_function (AgsEffectLine *effect_line, guint format, guint old_format, gpointer user_data)
The ::format-changed signal notifies about changed format.
effect_line |
the AgsEffectLine |
|
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
“map-recall”
signalvoid user_function (AgsEffectLine *effect_line, guint output_pad_start, gpointer user_data)
The ::map-recall should be used to add the effect_line's default recall. This function
may call ags_effect_line_find_port()
.
effect_line |
the AgsEffectLine |
|
output_pad_start |
the channel's start pad |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.0.0
“refresh-port”
signalvoid user_function (AgsEffectLine *effect_line, gpointer user_data)
The ::refresh-port signal.
effect_line |
the AgsEffectLine |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 4.2.2
“remove-plugin”
signalvoid user_function (AgsEffectLine *effect_line, guint nth, gpointer user_data)
The ::remove-plugin signal notifies about removed effect.
effect_line |
the AgsEffectLine to modify |
|
nth |
the nth effect |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.3.0
“samplerate-changed”
signalvoid user_function (AgsEffectLine *effect_line, guint samplerate, guint old_samplerate, gpointer user_data)
The ::samplerate-changed signal notifies about changed samplerate.
effect_line |
the AgsEffectLine |
|
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
“set-channel”
signalvoid user_function (AgsEffectLine *effect_line, GObject *channel, gpointer user_data)
The ::set-channel signal notifies about changed channel.
effect_line |
the AgsEffectLine to modify |
|
channel |
the AgsChannel to set |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.0.0