Function

AgsAudioFxFactorycreate

since: 3.3.0

Declaration [src]

GList*
ags_fx_factory_create (
  AgsAudio* audio,
  AgsRecallContainer* play_container,
  AgsRecallContainer* recall_container,
  gchar* plugin_name,
  gchar* filename,
  gchar* effect,
  guint start_audio_channel,
  guint stop_audio_channel,
  guint start_pad,
  guint stop_pad,
  gint position,
  AgsFxFactoryCreateFlags create_flags,
  AgsRecallFlags recall_flags
)

Description [src]

Instantiate AgsRecall by this factory.

Available since: 3.3.0

Parameters

audio

Type: AgsAudio

An AgsAudio that should keep the recalls.

The data is owned by the caller of the function.
play_container

Type: AgsRecallContainer

An AgsRecallContainer to indetify what recall to use.

The data is owned by the caller of the function.
recall_container

Type: AgsRecallContainer

An AgsRecallContainer to indetify what recall to use.

The data is owned by the caller of the function.
plugin_name

Type: gchar*

The plugin identifier to instantiate.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
filename

Type: gchar*

The plugin filename.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
effect

Type: gchar*

The plugin effect.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
start_audio_channel

Type: guint

The first audio channel to apply.

stop_audio_channel

Type: guint

The last audio channel to apply.

start_pad

Type: guint

The first pad to apply.

stop_pad

Type: guint

The last pad to apply.

position

Type: gint

The position to insert the recall.

create_flags

Type: AgsFxFactoryCreateFlags

Modify the behaviour of this function.

recall_flags

Type: AgsRecallFlags

Flags to be set for AgsRecall.

Return value

Type: A list of None

The GList-struct containing AgsRecall.

The caller of the function takes ownership of the data, and is responsible for freeing it.