AgsRecallContainer

AgsRecallContainer — Container to group recalls

Functions

Properties

Types and Values

Object Hierarchy

    GObject
    ╰── AgsRecallContainer

Implemented Interfaces

AgsRecallContainer implements AgsConnectable.

Includes

#include <ags/audio/ags_recall_container.h>

Description

AgsRecallContainer groups recalls of different context.

Functions

ags_recall_container_get_recall_audio ()

AgsRecall *
ags_recall_container_get_recall_audio (AgsRecallContainer *container);

Retrieve recall audio of container.

Parameters

container

the AgsRecallContainer

 

Returns

the AgsRecallAudio

Since: 1.0.0


ags_recall_container_get_recall_audio_run ()

GList *
ags_recall_container_get_recall_audio_run
                               (AgsRecallContainer *container);

Retrieve recall audio run of container.

Parameters

container

the AgsRecallContainer

 

Returns

the AgsRecallAudioRun as list

Since: 1.0.0


ags_recall_container_get_recall_channel ()

GList *
ags_recall_container_get_recall_channel
                               (AgsRecallContainer *container);

Retrieve the recall channel of container.

Parameters

container

the AgsRecallContainer

 

Returns

the AgsRecallChannel

Since: 1.0.0


ags_recall_container_get_recall_channel_run ()

GList *
ags_recall_container_get_recall_channel_run
                               (AgsRecallContainer *container);

Retrieve the recall channel run of container.

Parameters

container

the AgsRecallContainer

 

Returns

the AgsRecall

Since: 1.0.0


ags_recall_container_find ()

GList *
ags_recall_container_find (GList *recall_container,
                           GType type,
                           guint find_flags,
                           AgsRecallID *recall_id);

Finds AgsRecall for appropriate search criteria.

Parameters

recall_container

the AgsRecallContainer

 

type

recall type

 

find_flags

search mask

 

recall_id

an AgsRecallID

 

Returns

the matching recalls

Since: 1.0.0


ags_recall_container_new ()

AgsRecallContainer *
ags_recall_container_new ();

Creates an AgsRecallContainer

Returns

a new AgsRecallContainer

Since: 1.0.0


AGS_IS_RECALL_CONTAINER()

#define AGS_IS_RECALL_CONTAINER(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_RECALL_CONTAINER))

AGS_RECALL_CONTAINER()

#define AGS_RECALL_CONTAINER(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_RECALL_CONTAINER, AgsRecallContainer))

AGS_RECALL_CONTAINER_CLASS()

#define AGS_RECALL_CONTAINER_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_RECALL_CONTAINER, AgsRecallContainerClass))

AGS_RECALL_CONTAINER_GET_CLASS()

#define AGS_RECALL_CONTAINER_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_RECALL_CONTAINER, AgsRecallContainerClass))

ags_recall_container_get_type ()

GType
ags_recall_container_get_type ();

Types and Values

enum AgsRecallContainerFlags

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

Members

AGS_RECALL_CONTAINER_PLAY

bound to play context

 

enum AgsRecallContainerFindFlags

Enum values to specify find criteria.

Members

AGS_RECALL_CONTAINER_FIND_TYPE

find type

 

AGS_RECALL_CONTAINER_FIND_TEMPLATE

find template

 

AGS_RECALL_CONTAINER_FIND_RECALL_ID

find recall id

 

AGS_TYPE_RECALL_CONTAINER

#define AGS_TYPE_RECALL_CONTAINER                (ags_recall_container_get_type())

struct AgsRecallContainer

struct AgsRecallContainer;

struct AgsRecallContainerClass

struct AgsRecallContainerClass {
  GObjectClass object;
};

Property Details

The “recall-audio” property

  “recall-audio”             AgsRecallAudio *

The associated recall within audio context.

Flags: Write

Since: 1.0.0


The “recall-audio-run” property

  “recall-audio-run”         AgsRecallAudioRun *

The associated recall within dynamic audio context.

Flags: Write

Since: 1.0.0


The “recall-audio-run-type” property

  “recall-audio-run-type”    GType *

The associated recall type within dynamic audio context.

Flags: Read / Write

Allowed values: void

Since: 1.0.0


The “recall-audio-type” property

  “recall-audio-type”        GType *

The associated recall type within audio context.

Flags: Read / Write

Allowed values: void

Since: 1.0.0


The “recall-channel” property

  “recall-channel”           AgsRecallChannel *

The associated recall within channel context.

Flags: Write

Since: 1.0.0


The “recall-channel-run” property

  “recall-channel-run”       AgsRecallChannelRun *

The associated recall within dynamic channel context.

Flags: Write

Since: 1.0.0


The “recall-channel-run-type” property

  “recall-channel-run-type”  GType *

The associated recall type within dynamic channel context.

Flags: Read / Write

Allowed values: void

Since: 1.0.0


The “recall-channel-type” property

  “recall-channel-type”      GType *

The associated recall type within channel context.

Flags: Read / Write

Allowed values: void

Since: 1.0.0