AgsRecyclingContext: Advanced Gtk+ Sequencer Reference Manual

AgsRecyclingContext

AgsRecyclingContext — A context of recycling acting as dynamic context.

Properties

guint64	length	Read / Write
AgsRecyclingContext *	parent	Read / Write
AgsRecallID *	recall-id	Read / Write

Object Hierarchy

    GObject
    ╰── AgsRecyclingContext

Includes

#include <ags/audio/ags_recycling_context.h>

Description

AgsRecyclingContext organizes AgsRecycling objects as dynamic context within nested tree.

Functions

ags_recycling_context_replace ()

void
ags_recycling_context_replace (AgsRecyclingContext *recycling_context,
                               AgsRecycling *recycling,
                               gint position);

Replaces one recycling entry in a context.

Parameters

recycling_context	the AgsRecyclingContext
recycling	the AgsRecycling to add
position	the index of `recycling`

Since: 0.4

ags_recycling_context_add ()

AgsRecyclingContext *
ags_recycling_context_add (AgsRecyclingContext *recycling_context,
                           AgsRecycling *recycling);

Adds a recycling to a context.

Parameters

recycling_context	the AgsRecyclingContext
recycling	the AgsRecycling to add

Returns

the new recycling context

Since: 0.4

ags_recycling_context_remove ()

AgsRecyclingContext *
ags_recycling_context_remove (AgsRecyclingContext *recycling_context,
                              AgsRecycling *recycling);

Removes a recycling in a context.

Parameters

recycling_context	the AgsRecyclingContext
recycling	the AgsRecycling to remove

Returns

the new recycling context

Since: 0.4

ags_recycling_context_insert ()

AgsRecyclingContext *
ags_recycling_context_insert (AgsRecyclingContext *recycling_context,
                              AgsRecycling *recycling,
                              gint position);

Inserts a recycling to a context.

Parameters

recycling_context	the AgsRecyclingContext
recycling	the AgsRecycling to insert
position	the index to insert at

Returns

the new recycling context

Since: 0.4

ags_recycling_context_get_toplevel ()

AgsRecyclingContext *
ags_recycling_context_get_toplevel (AgsRecyclingContext *recycling_context);

Iterates the tree up to highest level.

Parameters

recycling_context

the AgsRecyclingContext

Returns

the topmost recycling context

Since: 0.4

ags_recycling_context_find ()

gint
ags_recycling_context_find (AgsRecyclingContext *recycling_context,
                            AgsRecycling *recycling);

Find position of recycling within array.

Parameters

recycling_context	the AgsRecyclingContext
recycling	the AgsRecycling to look up

Returns

recycling array index

Since: 0.4

ags_recycling_context_find_child ()

gint
ags_recycling_context_find_child (AgsRecyclingContext *recycling_context,
                                  AgsRecycling *recycling);

Find position of recycling within arrays.

Parameters

recycling_context	the AgsRecyclingContext
recycling	the AgsRecycling to look up

Returns

recycling array index

Since: 0.4

ags_recycling_context_find_parent ()

gint
ags_recycling_context_find_parent (AgsRecyclingContext *recycling_context,
                                   AgsRecycling *recycling);

Find position of recycling within array.

Parameters

recycling_context	the AgsRecyclingContext
recycling	the AgsRecycling to look up

Returns

recycling array index

Since: 0.4

ags_recycling_context_add_child ()

void
ags_recycling_context_add_child (AgsRecyclingContext *parent,
                                 AgsRecyclingContext *child);

Adds a recycling context as child.

Parameters

parent	the parental AgsRecyclingContext
child	the child

Since: 0.4

ags_recycling_context_remove_child ()

void
ags_recycling_context_remove_child (AgsRecyclingContext *parent,
                                    AgsRecyclingContext *child);

Removes a recycling context of its parent.

Parameters

parent	the AgsRecyclingContext
child	the child to remove

Since: 0.4

ags_recycling_context_get_child_recall_id ()

GList *
ags_recycling_context_get_child_recall_id
                               (AgsRecyclingContext *recycling_context);

Retrieve all child recall ids.

Parameters

recycling_context

the AgsRecyclingContext

Returns

the AgsRecallID as GList

Since: 0.4

ags_recycling_context_reset_recycling ()

AgsRecyclingContext *
ags_recycling_context_reset_recycling (AgsRecyclingContext *recycling_context,
                                       AgsRecycling *old_first_recycling,
                                       AgsRecycling *old_last_recycling,
                                       AgsRecycling *new_first_recycling,
                                       AgsRecycling *new_last_recycling);

Modify recycling of context.

Parameters

recycling_context	the AgsRecyclingContext
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

Returns

the new AgsRecyclingContext

Since: 0.4

ags_recycling_context_new ()

AgsRecyclingContext *
ags_recycling_context_new (gint length);

Creates a AgsRecyclingContext, boundaries are specified by length

Parameters

length

array dimension of context

Returns

a new AgsRecyclingContext

Since: 0.4

Types and Values

Property Details

The `“length”` property

  “length”                   guint64

The recycling array length.

Flags: Read / Write

Default value: 0

Since: 0.4.0

The `“parent”` property

  “parent”                   AgsRecyclingContext *

The context this one is packed into.

Flags: Read / Write

Since: 0.4.0

The `“recall-id”` property

  “recall-id”                AgsRecallID *

The recall id located in audio object as destiny.

Flags: Read / Write

Since: 0.4.0

void	ags_recycling_context_replace ()
AgsRecyclingContext *	ags_recycling_context_add ()
AgsRecyclingContext *	ags_recycling_context_remove ()
AgsRecyclingContext *	ags_recycling_context_insert ()
AgsRecyclingContext *	ags_recycling_context_get_toplevel ()
gint	ags_recycling_context_find ()
gint	ags_recycling_context_find_child ()
gint	ags_recycling_context_find_parent ()
void	ags_recycling_context_add_child ()
void	ags_recycling_context_remove_child ()
GList *	ags_recycling_context_get_child_recall_id ()
AgsRecyclingContext *	ags_recycling_context_reset_recycling ()
AgsRecyclingContext *	ags_recycling_context_new ()