AgsRemoveRecall

AgsRemoveRecall — remove recall object from context

Functions

Properties

GObject * context Read / Write
gboolean is-play Read / Write
AgsRecall * recall Read / Write
gboolean remove-all Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsTask
        ╰── AgsRemoveRecall

Implemented Interfaces

AgsRemoveRecall implements AgsConnectable.

Includes

#include <ags/audio/task/ags_remove_recall.h>

Description

The AgsRemoveRecall task removes AgsRecall from context.

Functions

ags_remove_recall_new ()

AgsRemoveRecall *
ags_remove_recall_new (GObject *context,
                       AgsRecall *recall,
                       gboolean is_play,
                       gboolean remove_all);

Creates an AgsRemoveRecall.

Parameters

context

may be AgsAudio, AgsChannel or AgsRecall

 

recall

the AgsRecall to remove

 

is_play

if TRUE non-complex recall

 

remove_all

if TRUE all related will be removed

 

Returns

an new AgsRemoveRecall.

Since: 1.0.0


AGS_IS_REMOVE_RECALL()

#define AGS_IS_REMOVE_RECALL(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_REMOVE_RECALL))

AGS_REMOVE_RECALL()

#define AGS_REMOVE_RECALL(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_REMOVE_RECALL, AgsRemoveRecall))

AGS_REMOVE_RECALL_CLASS()

#define AGS_REMOVE_RECALL_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_REMOVE_RECALL, AgsRemoveRecallClass))

AGS_REMOVE_RECALL_GET_CLASS()

#define AGS_REMOVE_RECALL_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_REMOVE_RECALL, AgsRemoveRecallClass))

ags_remove_recall_get_type ()

GType
ags_remove_recall_get_type ();

Types and Values

AGS_TYPE_REMOVE_RECALL

#define AGS_TYPE_REMOVE_RECALL                (ags_remove_recall_get_type())

struct AgsRemoveRecall

struct AgsRemoveRecall;

struct AgsRemoveRecallClass

struct AgsRemoveRecallClass {
  AgsTaskClass task;
};

Property Details

The “context” property

  “context”                  GObject *

The assigned AgsContext

Flags: Read / Write

Since: 1.0.0


The “is-play” property

  “is-play”                  gboolean

The recall's context is-play.

Flags: Read / Write

Default value: FALSE

Since: 1.0.0


The “recall” property

  “recall”                   AgsRecall *

The assigned AgsRecall

Flags: Read / Write

Since: 1.0.0


The “remove-all” property

  “remove-all”               gboolean

Do remove-all related recalls.

Flags: Read / Write

Default value: FALSE

Since: 1.0.0