AgsOpenFile

AgsOpenFile — open file task

Functions

Properties

AgsAudio * audio Read / Write
gboolean create-channels Read / Write
gpointer filenames Read / Write
gboolean overwrite-channels Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsTask
        ╰── AgsOpenFile

Implemented Interfaces

AgsOpenFile implements AgsConnectable.

Includes

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

Description

The AgsOpenFile task opens files.

Functions

ags_open_file_new ()

AgsOpenFile *
ags_open_file_new (AgsAudio *audio,
                   GSList *filenames,
                   gboolean overwrite_channels,
                   gboolean create_channels);

Creates an AgsOpenFile.

Parameters

audio

the AgsAudio

 

filenames

the filenames to be opened

 

overwrite_channels

reset existing AgsInput

 

create_channels

inistantiate new AgsInput, if overwrite_channell as needed else for sure

 

Returns

an new AgsOpenFile.

Since: 1.0.0


AGS_IS_OPEN_FILE()

#define AGS_IS_OPEN_FILE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_OPEN_FILE))

AGS_OPEN_FILE()

#define AGS_OPEN_FILE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_OPEN_FILE, AgsOpenFile))

AGS_OPEN_FILE_CLASS()

#define AGS_OPEN_FILE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_OPEN_FILE, AgsOpenFileClass))

AGS_OPEN_FILE_GET_CLASS()

#define AGS_OPEN_FILE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_OPEN_FILE, AgsOpenFileClass))

ags_open_file_get_type ()

GType
ags_open_file_get_type ();

Types and Values

AGS_TYPE_OPEN_FILE

#define AGS_TYPE_OPEN_FILE                (ags_open_file_get_type())

struct AgsOpenFile

struct AgsOpenFile;

struct AgsOpenFileClass

struct AgsOpenFileClass {
  AgsTaskClass task;
};

Property Details

The “audio” property

  “audio”                    AgsAudio *

The assigned AgsAudio

Flags: Read / Write

Since: 1.0.0


The “create-channels” property

  “create-channels”          gboolean

As open files create AgsChannel.

Flags: Read / Write

Default value: FALSE

Since: 1.0.0


The “filenames” property

  “filenames”                gpointer

The assigned GSList providing filenames as string

Flags: Read / Write

Since: 1.0.0


The “overwrite-channels” property

  “overwrite-channels”       gboolean

As open files overwrite AgsChannel.

Flags: Read / Write

Default value: FALSE

Since: 1.0.0