AgsRecyclingContainer

AgsRecyclingContainer — A container of recycling acting as dynamic context.

Functions

Includes

#include <ags/audio/ags_recycling_container.h>

Description

AgsRecyclingContainer organizes AgsRecycling objects as dynamic context within nested tree.

Functions

ags_recycling_container_replace ()

void
ags_recycling_container_replace (AgsRecyclingContainer *recycling_container,
                                 AgsRecycling *recycling,
                                 gint position);


ags_recycling_container_add ()

AgsRecyclingContainer *
ags_recycling_container_add (AgsRecyclingContainer *recycling_container,
                             AgsRecycling *recycling);

Removes a recycling to a container.

Parameters

recycling_container

the AgsRecyclingContainer

 

recycling

the AgsRecycling to remove

 

Returns

the new recycling container

Since 0.4


ags_recycling_container_remove ()

AgsRecyclingContainer *
ags_recycling_container_remove (AgsRecyclingContainer *recycling_container,
                                AgsRecycling *recycling);

Returns


ags_recycling_container_insert ()

AgsRecyclingContainer *
ags_recycling_container_insert (AgsRecyclingContainer *recycling_container,
                                AgsRecycling *recycling,
                                gint position);

Removes a recycling to a container.

Parameters

recycling_container

the AgsRecyclingContainer

 

recycling

the AgsRecycling to insert

 

position

the index to insert at

 

Returns

the new recycling container

Since 0.4


ags_recycling_container_get_toplevel ()

AgsRecyclingContainer *
ags_recycling_container_get_toplevel (AgsRecyclingContainer *recycling_container);

Iterates the tree up to highest level.

Parameters

recycling_container

the AgsRecyclingContainer

 

Returns

the topmost recycling container

Since 0.4


ags_recycling_container_find ()

gint
ags_recycling_container_find (AgsRecyclingContainer *recycling_container,
                              AgsRecycling *recycling);

Find position of recycling within array.

Parameters

recycling_container

the AgsRecyclingContainer

 

recycling

the AgsRecycling to look up

 

Returns

recycling array index

Since 0.4


ags_recycling_container_find_child ()

gint
ags_recycling_container_find_child (AgsRecyclingContainer *recycling_container,
                                    AgsRecycling *recycling);

Find position of recycling within arrays.

Parameters

recycling_container

the AgsRecyclingContainer

 

recycling

the AgsRecycling to look up

 

Returns

recycling array index

Since 0.4


ags_recycling_container_find_parent ()

gint
ags_recycling_container_find_parent (AgsRecyclingContainer *recycling_container,
                                     AgsRecycling *recycling);

Find position of recycling within array.

Parameters

recycling_container

the AgsRecyclingContainer

 

recycling

the AgsRecycling to look up

 

Returns

recycling array index

Since 0.4


ags_recycling_container_add_child ()

void
ags_recycling_container_add_child (AgsRecyclingContainer *parent,
                                   AgsRecyclingContainer *child);

Adds a recycling container as child.

Parameters

parent

the parental AgsRecyclingContainer

 

child

the child

 

Since 0.4


ags_recycling_container_remove_child ()

void
ags_recycling_container_remove_child (AgsRecyclingContainer *parent,
                                      AgsRecyclingContainer *child);

Removes a recycling container of its parent.

Parameters

parent

the AgsRecyclingContainer

 

child

the child to remove

 

Since 0.4


ags_recycling_container_get_child_recall_id ()

GList *
ags_recycling_container_get_child_recall_id
                               (AgsRecyclingContainer *recycling_container);

Retrieve all child recall ids.

Parameters

recycling_container

the AgsRecyclingContainer

 

Returns

the AgsRecallID as GList

Since 0.4


ags_recycling_container_reset_recycling ()

AgsRecyclingContainer *
ags_recycling_container_reset_recycling
                               (AgsRecyclingContainer *recycling_container,
                                AgsRecycling *old_first_recycling,
                                AgsRecycling *old_last_recycling,
                                AgsRecycling *new_first_recycling,
                                AgsRecycling *new_last_recycling);

Modify recycling of container.

Parameters

recycling_container

the AgsRecyclingContainer

 

old_first_recycling

the first recycling to replace

 

old_last_recycling

the last recycling to replace

 

new_first_recycling

the first recycling to insert

 

new_last_recycling

the last recycling to insert

 

Since 0.4


ags_recycling_container_new ()

AgsRecyclingContainer *
ags_recycling_container_new (gint length);

Creates a AgsRecyclingContainer, boundaries are specified by length

Parameters

length

array dimension of context

 

Returns

a new AgsRecyclingContainer

Since 0.4

Types and Values