AgsCancelChannel

AgsCancelChannel — cancel channel task

Functions

Properties

AgsChannel * channel Read / Write
AgsPlayback * playback Read / Write
AgsRecallID * recall-id Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsTask
        ╰── AgsCancelChannel

Implemented Interfaces

AgsCancelChannel implements AgsConnectable.

Includes

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

Description

The AgsCancelChannel task cancels AgsChannel playback.

Functions

ags_cancel_channel_new ()

AgsCancelChannel *
ags_cancel_channel_new (AgsChannel *channel,
                        AgsRecallID *recall_id,
                        GObject *playback);

Creates an AgsCancelChannel.

Parameters

channel

the AgsChannel to cancel

 

recall_id

the AgsRecallID to cancel

 

playback

the AgsPlayback

 

Returns

an new AgsCancelChannel.

Since: 1.0.0


AGS_CANCEL_CHANNEL()

#define AGS_CANCEL_CHANNEL(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_CANCEL_CHANNEL, AgsCancelChannel))

AGS_CANCEL_CHANNEL_CLASS()

#define AGS_CANCEL_CHANNEL_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_CANCEL_CHANNEL, AgsCancelChannelClass))

AGS_CANCEL_CHANNEL_GET_CLASS()

#define AGS_CANCEL_CHANNEL_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_CANCEL_CHANNEL, AgsCancelChannelClass))

AGS_IS_CANCEL_CHANNEL()

#define AGS_IS_CANCEL_CHANNEL(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_CANCEL_CHANNEL))

ags_cancel_channel_get_type ()

GType
ags_cancel_channel_get_type ();

Types and Values

AGS_TYPE_CANCEL_CHANNEL

#define AGS_TYPE_CANCEL_CHANNEL                (ags_cancel_channel_get_type())

struct AgsCancelChannel

struct AgsCancelChannel;

struct AgsCancelChannelClass

struct AgsCancelChannelClass {
  AgsTaskClass task;
};

Property Details

The “channel” property

  “channel”                  AgsChannel *

The assigned AgsChannel

Flags: Read / Write

Since: 1.0.0


The “playback” property

  “playback”                 AgsPlayback *

The assigned AgsPlayback

Flags: Read / Write

Since: 1.0.0


The “recall-id” property

  “recall-id”                AgsRecallID *

The assigned AgsRecallID

Flags: Read / Write

Since: 1.0.0