AgsRecallID

AgsRecallID — The object specifies run context.

Synopsis

#include <ags/audio/ags_recall_id.h>

struct              AgsRecallID;
struct              AgsRecallIDClass;
enum                AgsRecallIDFlags;
GList *             ags_recall_id_add                   (GList *recall_id_list,
                                                         AgsRecallID *recall_id);
AgsRecallID *       ags_recall_id_find_parent_recycling_container
                                                        (GList *recall_id_list,
                                                         AgsRecyclingContainer *parent_recycling_container);
AgsRecallID *       ags_recall_id_find_recycling_container
                                                        (GList *recall_id_list,
                                                         AgsRecyclingContainer *recycling_container);
gboolean            ags_recall_id_get_run_stage         (AgsRecallID *id,
                                                         gint stage);
AgsRecallID *       ags_recall_id_new                   (AgsRecycling *recycling);
void                ags_recall_id_set_run_stage         (AgsRecallID *recall_id,
                                                         gint stage);
void                ags_recall_id_unset_run_stage       (AgsRecallID *recall_id,
                                                         gint stage);

Description

AgsRecallID acts as dynamic context identifier.

Details

struct AgsRecallID

struct AgsRecallID {
  GObject object;
  
  guint flags;

  GObject *recycling;
  AgsRecyclingContainer *recycling_container;
};

struct AgsRecallIDClass

struct AgsRecallIDClass {
  GObjectClass object;
};

enum AgsRecallIDFlags

typedef enum {
  AGS_RECALL_ID_PLAYBACK          = 1,
  AGS_RECALL_ID_SEQUENCER         = 1 << 1,
  AGS_RECALL_ID_NOTATION          = 1 << 2,
  AGS_RECALL_ID_DUPLICATE         = 1 << 3,
  AGS_RECALL_ID_RESOLVE           = 1 << 4,
  AGS_RECALL_ID_INIT_PRE          = 1 << 5,
  AGS_RECALL_ID_INIT_INTER        = 1 << 6,
  AGS_RECALL_ID_INIT_POST         = 1 << 7,
  AGS_RECALL_ID_PRE               = 1 << 8,
  AGS_RECALL_ID_INTER             = 1 << 9,
  AGS_RECALL_ID_POST              = 1 << 10,
  AGS_RECALL_ID_CANCEL            = 1 << 11,
} AgsRecallIDFlags;

ags_recall_id_add ()

GList *             ags_recall_id_add                   (GList *recall_id_list,
                                                         AgsRecallID *recall_id);

Adds an AgsRecallID with given properties to the passed GList.

recall_id_list :

the GList the new AgsRecallID should be added

recall_id :

the AgsRecallID to add

Returns :

the newly allocated GList which is the new start of the GList, too.

Since 0.4


ags_recall_id_find_parent_recycling_container ()

AgsRecallID *       ags_recall_id_find_parent_recycling_container
                                                        (GList *recall_id_list,
                                                         AgsRecyclingContainer *parent_recycling_container);

Retrieve recall id by recycling container.

recall_id_list :

a GList containing AgsRecallID

recycling_container :

the AgsRecyclingContainer to match

Returns :

Matching recall id.

Since 0.4


ags_recall_id_find_recycling_container ()

AgsRecallID *       ags_recall_id_find_recycling_container
                                                        (GList *recall_id_list,
                                                         AgsRecyclingContainer *recycling_container);

Retrieve recall id by recycling container.

recall_id_list :

a GList containing AgsRecallID

recycling_container :

the AgsRecyclingContainer to match

Returns :

Matching recall id.

Since 0.4


ags_recall_id_get_run_stage ()

gboolean            ags_recall_id_get_run_stage         (AgsRecallID *id,
                                                         gint stage);

Check if a run stage already has been passed for current run. This function is intended to handle AGS_AUDIO_ASYNC correctly.

id :

the AgsRecallID to check

stage :

the current run stage to check against

Returns :

TRUE if the stage isn't run yet otherwise FALSE

Since 0.3


ags_recall_id_new ()

AgsRecallID *       ags_recall_id_new                   (AgsRecycling *recycling);

Creates a AgsRecallID, assigned to recycling

Returns :

a new AgsRecallID

Since 0.3


ags_recall_id_set_run_stage ()

void                ags_recall_id_set_run_stage         (AgsRecallID *recall_id,
                                                         gint stage);

Marks the run stage to be passed for audio channel.

recall_id :

the AgsRecallID which has been passed

stage :

the run stage the networked channels are in

Since 0.3


ags_recall_id_unset_run_stage ()

void                ags_recall_id_unset_run_stage       (AgsRecallID *recall_id,
                                                         gint stage);

Unmarks the run stage to be passed for audio channel.

recall_id :

the AgsRecallID which has been passed

stage :

the run stage the networked channels are in

Since 0.3