AgsRecycling

AgsRecycling — A container of audio signals

Functions

Properties

AgsAudioSignal * audio-signal Read / Write
AgsChannel * channel Read / Write
AgsRecycling * next Read / Write
AgsRecycling * parent Read / Write
AgsRecycling * prev Read / Write
GObject * soundcard Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── AgsRecycling

Implemented Interfaces

AgsRecycling implements AgsConnectable and AgsConcurrentTree.

Includes

#include <ags/audio/ags_recycling.h>

Description

AgsRecycling forms the nested tree of AgsChannel. Ever channel having own audio signal contains therefor an AgsRecycling

Functions

ags_recycling_set_soundcard ()

void
ags_recycling_set_soundcard (AgsRecycling *recycling,
                             GObject *soundcard);

Sets GObject to recycling.

Parameters

recycling

an AgsRecycling

 

soundcard

the GObject to set

 

Since: 1.0.0


ags_recycling_add_audio_signal ()

void
ags_recycling_add_audio_signal (AgsRecycling *recycling,
                                AgsAudioSignal *audio_signal);

Add AgsAudioSignal to recycling.

Parameters

recycling

an AgsRecycling

 

audio_signal

the AgsAudioSignal to add

 

Since: 1.0.0


ags_recycling_remove_audio_signal ()

void
ags_recycling_remove_audio_signal (AgsRecycling *recycling,
                                   AgsAudioSignal *audio_signal);

Remove AgsAudioSignal of recycling.

Parameters

recycling

an AgsRecycling

 

audio_signal

the AgsAudioSignal to remove

 

Since: 1.0.0


ags_recycling_create_audio_signal_with_defaults ()

void
ags_recycling_create_audio_signal_with_defaults
                               (AgsRecycling *recycling,
                                AgsAudioSignal *audio_signal,
                                gdouble delay,
                                guint attack);

Create audio signal with defaults.

Parameters

recycling

an AgsRecycling

 

audio_signal

the AgsAudioSignal to apply defaults

 

delay

the delay

 

attack

the attack

 

Since: 1.0.0


ags_recycling_create_audio_signal_with_frame_count ()

void
ags_recycling_create_audio_signal_with_frame_count
                               (AgsRecycling *recycling,
                                AgsAudioSignal *audio_signal,
                                guint frame_count,
                                gdouble delay,
                                guint attack);

Create audio signal with frame count.

Parameters

recycling

an AgsRecycling

 

audio_signal

the AgsAudioSignal to apply defaults

 

frame_count

the audio data size

 

delay

the delay

 

attack

the attack

 

Since: 1.0.0


ags_recycling_position ()

gint
ags_recycling_position (AgsRecycling *start_region,
                        AgsRecycling *end_region,
                        AgsRecycling *recycling);

Retrieve position of recycling.

Parameters

start_region

boundary start

 

end_region

boundary end

 

recycling

matching recycling

 

Returns

position within boundary.

Since: 1.0.0


ags_recycling_find_next_channel ()

AgsRecycling *
ags_recycling_find_next_channel (AgsRecycling *start_region,
                                 AgsRecycling *end_region,
                                 GObject *prev_channel);

Retrieve next recycling with different channel.

Parameters

start_region

boundary start

 

end_region

boundary end

 

prev_channel

previous channel

 

Returns

Matching recycling.

Since: 1.0.0


ags_recycling_is_active ()

gboolean
ags_recycling_is_active (AgsRecycling *start_region,
                         AgsRecycling *end_region,
                         GObject *recall_id);

Check if is active.

Parameters

start_region

boundary start

 

end_region

boundary end

 

recall_id

the AgsRecallID

 

Returns

TRUE if related audio signal to recall id is available, otherwise FALSE

Since: 1.0.0.9


ags_recycling_new ()

AgsRecycling *
ags_recycling_new (GObject *soundcard);

Creates a AgsRecycling, with defaults of soundcard .

Parameters

soundcard

the GObject

 

Returns

a new AgsRecycling

Since: 1.0.0


AGS_IS_RECYCLING()

#define AGS_IS_RECYCLING(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_RECYCLING))

AGS_RECYCLING()

#define AGS_RECYCLING(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_RECYCLING, AgsRecycling))

AGS_RECYCLING_CLASS()

#define AGS_RECYCLING_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_RECYCLING, AgsRecyclingClass))

AGS_RECYCLING_GET_CLASS()

#define AGS_RECYCLING_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_RECYCLING, AgsRecyclingClass))

ags_recycling_get_type ()

GType
ags_recycling_get_type (void);

Types and Values

enum AgsRecyclingFlags

Enum values to control the behavior or indicate internal state of AgsRecycling by enable/disable as flags.

Members

AGS_RECYCLING_CONNECTED

indicates the port was connected by calling AgsConnectable::connect()

 

AGS_RECYCLING_MUTED

recycling is muted

 

AGS_TYPE_RECYCLING

#define AGS_TYPE_RECYCLING                (ags_recycling_get_type())

struct AgsRecycling

struct AgsRecycling;

struct AgsRecyclingClass

struct AgsRecyclingClass {
  GObjectClass object;

  void (*add_audio_signal)(AgsRecycling *recycling,
			   AgsAudioSignal *audio_signal);
  void (*remove_audio_signal)(AgsRecycling *recycling,
			      AgsAudioSignal *audio_signal);
};

Property Details

The “audio-signal” property

  “audio-signal”             AgsAudioSignal *

The containing AgsAudioSignal.

Flags: Read / Write

Since: 1.0.0


The “channel” property

  “channel”                  AgsChannel *

The assigned AgsChannel.

Flags: Read / Write

Since: 1.0.0


The “next” property

  “next”                     AgsRecycling *

The assigned next AgsRecycling.

Flags: Read / Write

Since: 1.0.0


The “parent” property

  “parent”                   AgsRecycling *

The assigned parent AgsRecycling.

Flags: Read / Write

Since: 1.0.0


The “prev” property

  “prev”                     AgsRecycling *

The assigned prev AgsRecycling.

Flags: Read / Write

Since: 1.0.0


The “soundcard” property

  “soundcard”                GObject *

The assigned GObject acting as default sink.

Flags: Read / Write

Since: 1.0.0

Signal Details

The “add-audio-signal” signal

void
user_function (AgsRecycling *recycling,
               GObject      *audio_signal,
               gpointer      user_data)

The ::add-audio-signal signal is emited as adding AgsAudioSignal

Parameters

recycling

an AgsRecycling

 

audio_signal

the AgsAudioSignal to add

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “remove-audio-signal” signal

void
user_function (AgsRecycling *recycling,
               GObject      *audio_signal,
               gpointer      user_data)

The ::remove-audio-signal signal is emited as removing AgsAudioSignal

Parameters

recycling

an AgsRecycling

 

audio_signal

the AgsAudioSignal to remove

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last