AgsFxPlaybackAudio

AgsFxPlaybackAudio — fx playback audio

Stability Level

Stable, unless otherwise indicated

Functions

Types and Values

Includes

#include <ags/audio/fx/ags_fx_playback_audio.h>

Description

The AgsFxPlaybackAudio class provides ports to the effect processor.

Functions

ags_fx_playback_audio_test_flags ()

gboolean
ags_fx_playback_audio_test_flags (AgsFxPlaybackAudio *fx_playback_audio,
                                  guint flags);

Test flags of fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

flags

the flags

 

Returns

TRUE on success, otherwise FALSE

Since: 3.3.0


ags_fx_playback_audio_set_flags ()

void
ags_fx_playback_audio_set_flags (AgsFxPlaybackAudio *fx_playback_audio,
                                 guint flags);

Set flags of fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

flags

the flags

 

Since: 3.3.0


ags_fx_playback_audio_unset_flags ()

void
ags_fx_playback_audio_unset_flags (AgsFxPlaybackAudio *fx_playback_audio,
                                   guint flags);

Unset flags of fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

flags

the flags

 

Since: 3.3.0


ags_fx_playback_audio_get_feed_audio_signal ()

GList *
ags_fx_playback_audio_get_feed_audio_signal
                               (AgsFxPlaybackAudio *fx_playback_audio);

Get feed audio_signal of fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

Returns

the GList containing feed audio_signal.

[element-type AgsAudio.AudioSignal][transfer full]

Since: 3.3.0


ags_fx_playback_audio_add_feed_audio_signal ()

void
ags_fx_playback_audio_add_feed_audio_signal
                               (AgsFxPlaybackAudio *fx_playback_audio,
                                AgsAudioSignal *audio_signal);

Add audio_signal to fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

audio_signal

the AgsAudioSignal

 

Since: 3.3.0


ags_fx_playback_audio_remove_feed_audio_signal ()

void
ags_fx_playback_audio_remove_feed_audio_signal
                               (AgsFxPlaybackAudio *fx_playback_audio,
                                AgsAudioSignal *audio_signal);

Remove audio_signal from fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

audio_signal

the AgsAudioSignal

 

Since: 3.3.0


ags_fx_playback_audio_get_master_audio_signal ()

GList *
ags_fx_playback_audio_get_master_audio_signal
                               (AgsFxPlaybackAudio *fx_playback_audio);

Get master audio_signal of fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

Returns

the GList containing master audio_signal.

[element-type AgsAudio.AudioSignal][transfer full]

Since: 3.3.0


ags_fx_playback_audio_add_master_audio_signal ()

void
ags_fx_playback_audio_add_master_audio_signal
                               (AgsFxPlaybackAudio *fx_playback_audio,
                                AgsAudioSignal *audio_signal);

Add audio_signal to fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

audio_signal

the AgsAudioSignal

 

Since: 3.3.0


ags_fx_playback_audio_remove_master_audio_signal ()

void
ags_fx_playback_audio_remove_master_audio_signal
                               (AgsFxPlaybackAudio *fx_playback_audio,
                                AgsAudioSignal *audio_signal);

Remove audio_signal from fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

audio_signal

the AgsAudioSignal

 

Since: 3.3.0


ags_fx_playback_audio_open_audio_file ()

void
ags_fx_playback_audio_open_audio_file (AgsFxPlaybackAudio *fx_playback_audio);

Open audio file of fx_playback_audio .

Parameters

fx_playback_audio

the AgsFxPlaybackAudio

 

Since: 3.3.0


ags_fx_playback_audio_new ()

AgsFxPlaybackAudio *
ags_fx_playback_audio_new (AgsAudio *audio);

Create a new instance of AgsFxPlaybackAudio

Parameters

audio

the AgsAudio

 

Returns

the new AgsFxPlaybackAudio

Since: 3.3.0

Types and Values

AGS_FX_PLAYBACK_AUDIO_DEFAULT_LOOP_START

#define AGS_FX_PLAYBACK_AUDIO_DEFAULT_LOOP_START (0)

AGS_FX_PLAYBACK_AUDIO_DEFAULT_LOOP_END

#define AGS_FX_PLAYBACK_AUDIO_DEFAULT_LOOP_END (64)

enum AgsFxPlaybackAudioFlags

Enum values to enable specific feature of AgsFxPlaybackAudio.

Members

AGS_FX_PLAYBACK_AUDIO_PLAY

do play sound

 

AGS_FX_PLAYBACK_AUDIO_RECORD

do record sound

 

AGS_FX_PLAYBACK_AUDIO_FEED

do feed audio signal

 

AGS_FX_PLAYBACK_AUDIO_MASTER

do master audio signal

 

enum AgsFxPlaybackAudioCaptureMode

Enum values to specify capture mode of AgsFxPlaybackAudio.

Members

AGS_FX_PLAYBACK_AUDIO_CAPTURE_MODE_DISCARD

discard capture

 

AGS_FX_PLAYBACK_AUDIO_CAPTURE_MODE_NONE

capture none and preserve data

 

AGS_FX_PLAYBACK_AUDIO_CAPTURE_MODE_REPLACE

capture replace any sound

 

AGS_FX_PLAYBACK_AUDIO_CAPTURE_MODE_MIX

capture mix with existing sound