krähemann.com

AgsCancelAudio

AgsCancelAudio — cancel audio task

Properties

AgsAudio * audio Read / Write
gint sound-scope Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsTask
        ╰── AgsCancelAudio

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,
                      gint sound_scope);

Create a new instance of AgsCancelAudio.

Parameters

audio

the AgsAudio to cancel

 

sound_scope

the AgsSoundScope or -1 for all

 

Returns

the new AgsCancelAudio.

Since: 3.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_IS_CANCEL_AUDIO_CLASS()

#define AGS_IS_CANCEL_AUDIO_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE((class), 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

Owner: AgsCancelAudio

Flags: Read / Write

Since: 3.0.0


The “sound-scope” property

  “sound-scope”              gint

The effects sound-scope.

Owner: AgsCancelAudio

Flags: Read / Write

Allowed values: [-1,5]

Default value: -1

Since: 3.0.0