AgsRecallID

AgsRecallID — The object specifies run context.

Functions

Properties

GObject * recycling Read / Write
GObject * recycling-context Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsRecallID

Implemented Interfaces

AgsRecallID implements AgsConnectable.

Includes

#include <ags/audio/ags_recall_id.h>

Description

AgsRecallID acts as dynamic context identifier.

Functions

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.

Parameters

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: 1.0.0


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.

Parameters

recall_id

the AgsRecallID which has been passed

 

stage

the run stage the networked channels are in

 

Since: 1.0.0


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.

Parameters

recall_id

the AgsRecallID which has been passed

 

stage

the run stage the networked channels are in

 

Since: 1.0.0


ags_recall_id_find_recycling_context ()

AgsRecallID *
ags_recall_id_find_recycling_context (GList *recall_id_list,
                                      AgsRecyclingContext *recycling_context);

Retrieve recall id by recycling context.

Parameters

recall_id_list

a GList containing AgsRecallID

 

recycling_context

the AgsRecyclingContext to match

 

Returns

Matching recall id.

Since: 1.0.0


ags_recall_id_find_parent_recycling_context ()

AgsRecallID *
ags_recall_id_find_parent_recycling_context
                               (GList *recall_id_list,
                                AgsRecyclingContext *parent_recycling_context);

Retrieve recall id by recycling context.

Parameters

recall_id_list

a GList containing AgsRecallID

 

parent_recycling_context

the AgsRecyclingContext to match

 

Returns

Matching recall id.

Since: 1.0.0


ags_recall_id_new ()

AgsRecallID *
ags_recall_id_new (AgsRecycling *recycling);

Creates a AgsRecallID, assigned to recycling

Parameters

recycling

the assigned AgsRecycling

 

Returns

a new AgsRecallID

Since: 1.0.0


AGS_IS_RECALL_ID()

#define AGS_IS_RECALL_ID(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_RECALL_ID))

AGS_RECALL_ID()

#define AGS_RECALL_ID(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), AGS_TYPE_RECALL_ID, AgsRecallID))

AGS_RECALL_ID_CLASS()

#define AGS_RECALL_ID_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST ((class), AGS_TYPE_RECALL_ID, AgsRecallIDClass))

AGS_RECALL_ID_GET_CLASS()

#define AGS_RECALL_ID_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_RECALL_ID, AgsRecallIDClass))

ags_recall_id_get_type ()

GType
ags_recall_id_get_type (void);

Types and Values

enum AgsRecallIDFlags

Members

AGS_RECALL_ID_CONNECTED

   

AGS_RECALL_ID_PLAYBACK

   

AGS_RECALL_ID_SEQUENCER

   

AGS_RECALL_ID_NOTATION

   

AGS_RECALL_ID_DUPLICATE

   

AGS_RECALL_ID_RESOLVE

   

AGS_RECALL_ID_INIT_PRE

   

AGS_RECALL_ID_INIT_INTER

   

AGS_RECALL_ID_INIT_POST

   

AGS_RECALL_ID_PRE

   

AGS_RECALL_ID_INTER

   

AGS_RECALL_ID_POST

   

AGS_RECALL_ID_CANCEL

   

AGS_TYPE_RECALL_ID

#define AGS_TYPE_RECALL_ID                (ags_recall_id_get_type ())

struct AgsRecallID

struct AgsRecallID;

struct AgsRecallIDClass

struct AgsRecallIDClass {
  GObjectClass object;
};

Property Details

The “recycling” property

  “recycling”                GObject *

The assigned AgsRecycling.

Flags: Read / Write

Since: 1.0.0


The “recycling-context” property

  “recycling-context”        GObject *

The dynamic run context belonging to.

Flags: Read / Write

Since: 1.0.0