AgsCancelAudio

AgsCancelAudio — cancel audio task

Functions

Properties

AgsAudio * audio Read / Write
gboolean do-notation Read / Write
gboolean do-playback Read / Write
gboolean do-sequencer Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsTask
        ╰── AgsCancelAudio

Implemented Interfaces

AgsCancelAudio implements AgsConnectable.

Includes

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

Description

The AgsCancelAudio task cancels AgsAudio playback.

Functions

ags_cancel_audio_new ()

AgsCancelAudio *
ags_cancel_audio_new (AgsAudio *audio,
                      gboolean do_playback,
                      gboolean do_sequencer,
                      gboolean do_notation);

Creates an AgsCancelAudio.

Parameters

audio

the AgsAudio to cancel

 

do_playback

if TRUE playback is canceld

 

do_sequencer

if TRUE sequencer is canceld

 

do_notation

if TRUE notation is canceld

 

Returns

an new AgsCancelAudio.

Since: 1.0.0


AGS_CANCEL_AUDIO()

#define AGS_CANCEL_AUDIO(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_CANCEL_AUDIO, AgsCancelAudio))

AGS_CANCEL_AUDIO_CLASS()

#define AGS_CANCEL_AUDIO_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_CANCEL_AUDIO, AgsCancelAudioClass))

AGS_CANCEL_AUDIO_GET_CLASS()

#define AGS_CANCEL_AUDIO_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_CANCEL_AUDIO, AgsCancelAudioClass))

AGS_IS_CANCEL_AUDIO()

#define AGS_IS_CANCEL_AUDIO(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_CANCEL_AUDIO))

ags_cancel_audio_get_type ()

GType
ags_cancel_audio_get_type ();

Types and Values

AGS_TYPE_CANCEL_AUDIO

#define AGS_TYPE_CANCEL_AUDIO                (ags_cancel_audio_get_type())

struct AgsCancelAudio

struct AgsCancelAudio;

struct AgsCancelAudioClass

struct AgsCancelAudioClass {
  AgsTaskClass task;
};

Property Details

The “audio” property

  “audio”                    AgsAudio *

The assigned AgsAudio

Flags: Read / Write

Since: 1.0.0


The “do-notation” property

  “do-notation”              gboolean

The effects do-notation.

Flags: Read / Write

Default value: FALSE

Since: 1.0.0


The “do-playback” property

  “do-playback”              gboolean

The effects do-playback.

Flags: Read / Write

Default value: FALSE

Since: 1.0.0


The “do-sequencer” property

  “do-sequencer”             gboolean

The effects do-sequencer.

Flags: Read / Write

Default value: FALSE

Since: 1.0.0