AgsMachine

AgsMachine — visualize audio object.

Functions

Properties

AgsAudio * audio Read / Write
gchar * machine-name Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBin
                        ╰── GtkHandleBox
                            ╰── AgsMachine
                                ├── AgsDrum
                                ├── AgsDssiBridge
                                ├── AgsFFPlayer
                                ├── AgsLadspaBridge
                                ├── AgsLiveDssiBridge
                                ├── AgsLiveLv2Bridge
                                ├── AgsLv2Bridge
                                ├── AgsMatrix
                                ├── AgsMixer
                                ├── AgsPanel
                                ├── AgsSyncsynth
                                ╰── AgsSynth

Implemented Interfaces

AgsMachine implements AtkImplementorIface, GtkBuildable, AgsConnectable and AgsPlugin.

Includes

#include <ags/X/ags_machine.h>

Description

AgsMachine is a composite widget to act as base class to visualize AgsAudio.

Functions

ags_machine_resize_audio_channels ()

void
ags_machine_resize_audio_channels (AgsMachine *machine,
                                   guint new_size,
                                   guint old_size);

Resize audio channel allocation.

Parameters

machine

the AgsMachine

 

new_size

new allocation

 

old_size

old allocation

 

Since: 1.0.0


ags_machine_resize_pads ()

void
ags_machine_resize_pads (AgsMachine *machine,
                         GType channel_type,
                         guint new_size,
                         guint old_size);

Resize pad allocation.

Parameters

machine

the AgsMachine

 

channel_type

the channel GType

 

new_size

new allocation

 

old_size

old allocation

 

Since: 1.0.0


ags_machine_map_recall ()

void
ags_machine_map_recall (AgsMachine *machine);

You may want the machine to add its default recall.

Parameters

machine

the AgsMachine to add its default recall.

 

ags_machine_find_port ()

GList *
ags_machine_find_port (AgsMachine *machine);

Parameters

machine

the AgsMachine

 

Returns

an GList containing all related AgsPort

Lookup ports of associated recalls.

Since: 1.0.0


ags_machine_add_default_recalls ()

void
ags_machine_add_default_recalls (AgsMachine *machine);

ags_machine_add_default_recalls is deprecated and should not be used in newly-written code.


ags_machine_find_by_name ()

AgsMachine *
ags_machine_find_by_name (GList *list,
                          char *name);

Find the specified by name machine.

Parameters

list

a GList of AgsMachine

 

name

the name of machine

 

Returns

the matching AgsMachine, or NULL

Since: 1.0.0


ags_machine_set_run ()

void
ags_machine_set_run (AgsMachine *machine,
                     gboolean run);

Start/stop playback of machine .

Parameters

machine

the AgsMachine

 

run

if TRUE playback is started, otherwise stopped

 

Since: 1.0.0


ags_machine_set_run_extended ()

void
ags_machine_set_run_extended (AgsMachine *machine,
                              gboolean run,
                              gboolean sequencer,
                              gboolean notation);

Start/stop playback of machine .

Parameters

machine

the AgsMachine

 

run

if TRUE playback is started, otherwise stopped

 

sequencer

if doing sequencer

 

notation

if doing notation

 

Since: 1.0.0


ags_machine_get_possible_links ()

GtkListStore *
ags_machine_get_possible_links (AgsMachine *machine);

Find links suitable for machine .

Parameters

machine

the AgsMachine

 

Returns

a GtkListStore containing one column with a string representing machines by its type and name.

Since: 1.0.0


ags_machine_get_possible_audio_output_connections ()

GtkListStore *
ags_machine_get_possible_audio_output_connections
                               (AgsMachine *machine);

Find audio output connections suitable for machine .

Parameters

machine

the AgsMachine

 

Returns

a GtkListStore containing one column with a string representing machines by its type and name.

Since: 1.0.0


ags_machine_file_chooser_dialog_new ()

GtkFileChooserDialog *
ags_machine_file_chooser_dialog_new (AgsMachine *machine);

Creates a new machine file chooser dialog in order to open audio files.

Parameters

machine

the AgsMachine

 

Returns

a new GtkFileChooserDialog

Since: 1.0.0


ags_machine_open_files ()

void
ags_machine_open_files (AgsMachine *machine,
                        GSList *filenames,
                        gboolean overwrite_channels,
                        gboolean create_channels);

Opens audio files and modifies or creates new channels if wished.

Parameters

machine

the AgsMachine

 

filenames

the filenames

 

overwrite_channels

reset channels

 

create_channels

instantiate new channels

 

Since: 1.0.0


ags_machine_copy_pattern ()

void
ags_machine_copy_pattern (AgsMachine *machine);

ags_machine_popup_add_edit_options ()

void
ags_machine_popup_add_edit_options (AgsMachine *machine,
                                    guint edit_options);

Add options to edit submenu

Parameters

machine

the assigned machine.

 

edit_options

the options to set

 

Since: 1.0.0


ags_machine_popup_add_connection_options ()

void
ags_machine_popup_add_connection_options
                               (AgsMachine *machine,
                                guint connection_options);

Add options to connection submenu

Parameters

machine

the assigned machine.

 

connection_options

the options to set

 

Since: 1.0.0


ags_machine_new ()

AgsMachine *
ags_machine_new (GObject *soundcard);

Creates an AgsMachine

Parameters

soundcard

the assigned soundcard.

 

Returns

a new AgsMachine

Since: 1.0.0


AGS_IS_MACHINE()

#define AGS_IS_MACHINE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_MACHINE))

AGS_MACHINE()

#define AGS_MACHINE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_MACHINE, AgsMachine))

AGS_MACHINE_CLASS()

#define AGS_MACHINE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_MACHINE, AgsMachineClass))

AGS_MACHINE_GET_CLASS()

#define AGS_MACHINE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_MACHINE, AgsMachineClass))

ags_machine_get_type ()

GType
ags_machine_get_type (void);

Types and Values

AGS_MACHINE_DEFAULT_VERSION

#define AGS_MACHINE_DEFAULT_VERSION "0.7.8\0"

AGS_MACHINE_DEFAULT_BUILD_ID

#define AGS_MACHINE_DEFAULT_BUILD_ID "CEST 01-03-2016 00:23\0"

enum AgsMachineFlags

Members

AGS_MACHINE_SOLO

   

AGS_MACHINE_IS_EFFECT

   

AGS_MACHINE_IS_SEQUENCER

   

AGS_MACHINE_IS_SYNTHESIZER

   

AGS_MACHINE_TAKES_FILE_INPUT

   

AGS_MACHINE_MAPPED_RECALL

   

AGS_MACHINE_PREMAPPED_RECALL

   

AGS_MACHINE_BLOCK_PLAY

   

AGS_MACHINE_BLOCK_STOP

   

AGS_MACHINE_CONNECTED

   

AGS_MACHINE_REVERSE_NOTATION

   

AGS_MACHINE_STICKY_CONTROLS

   

enum AgsMachineFileInputFlags

Members

AGS_MACHINE_ACCEPT_WAV

   

AGS_MACHINE_ACCEPT_OGG

   

AGS_MACHINE_ACCEPT_SOUNDFONT2

   

enum AgsMachineMappingFlags

Members

AGS_MACHINE_MONO

   

AGS_MACHINE_DISABLE_LINE_MEMBER

   

AGS_MACHINE_DISABLE_BULK_MEMBER

   

enum AgsMachineEditOptions

Members

AGS_MACHINE_POPUP_COPY_PATTERN

   

AGS_MACHINE_POPUP_PASTE_PATTERN

   

AGS_MACHINE_POPUP_ENVELOPE

   

enum AgsMachineConnectionOptions

Members

AGS_MACHINE_POPUP_CONNECTION_EDITOR

   

AGS_MACHINE_SHOW_AUDIO_OUTPUT_CONNECTION

   

AGS_MACHINE_SHOW_AUDIO_INPUT_CONNECTION

   

AGS_MACHINE_POPUP_MIDI_DIALOG

   

AGS_MACHINE_SHOW_MIDI_INPUT

   

AGS_MACHINE_SHOW_MIDI_OUTPUT

   

AGS_TYPE_MACHINE

#define AGS_TYPE_MACHINE                (ags_machine_get_type())

struct AgsMachine

struct AgsMachine;

struct AgsMachineClass

struct AgsMachineClass {
  GtkHandleBoxClass handle_box;

  void (*resize_audio_channels)(AgsMachine *machine,
				guint new_size, guint old_size);
  void (*resize_pads)(AgsMachine *machine,
		      GType channel_type,
		      guint new_size, guint old_size);
  
  void (*map_recall)(AgsMachine *machine);
  GList* (*find_port)(AgsMachine *machine);
};

Property Details

The “audio” property

  “audio”                    AgsAudio *

The assigned AgsAudio to visualize.

Flags: Read / Write

Since: 1.0.0


The “machine-name” property

  “machine-name”             gchar *

The machine's name.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

Signal Details

The “find-port” signal

gpointer
user_function (AgsMachine *machine,
               gpointer    user_data)

Parameters

machine

the AgsMachine 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


The “map-recall” signal

void
user_function (AgsMachine *machine,
               gpointer    user_data)

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

Parameters

machine

the AgsMachine

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “resize-audio-channels” signal

void
user_function (AgsMachine *machine,
               guint       channel,
               guint       new_size,
               gpointer    user_data)

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

Parameters

machine

the AgsMachine 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


The “resize-pads” signal

void
user_function (AgsMachine *machine,
               gulong      channel,
               guint       channel_type,
               guint       new_size,
               gpointer    user_data)

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

Parameters

machine

the AgsMachine 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