AgsAudioFile

AgsAudioFile — Audio file input/output

Functions

gboolean ags_audio_file_open ()
gboolean ags_audio_file_open_from_data ()
gboolean ags_audio_file_rw_open ()
void ags_audio_file_close ()
void ags_audio_file_read_audio_signal ()
void ags_audio_file_seek ()
void ags_audio_file_write ()
void ags_audio_file_flush ()
AgsAudioFile * ags_audio_file_new ()

Includes

#include <ags/audio/file/ags_audio_file.h>

Description

AgsAudioFile is the base object to read/write audio data.

Functions

ags_audio_file_open ()

gboolean
ags_audio_file_open (AgsAudioFile *audio_file);

Open the AgsAudioFile in read mode.

Parameters

audio_file

the AgsAudioFile

  

Returns

Since 0.3

ags_audio_file_open_from_data ()

gboolean
ags_audio_file_open_from_data (AgsAudioFile *audio_file,
                               gchar *data);

Open AgsAudioFile using virtual functions.

Parameters

audio_file

the AgsAudioFile

  

data

the audio data

  

Returns

Since 0.4

ags_audio_file_rw_open ()

gboolean
ags_audio_file_rw_open (AgsAudioFile *audio_file,
                        gboolean create);

Open the AgsAudioFile in read/write mode.

Parameters

audio_file

the AgsAudioFile

  

create

create the file

  

Returns

Since 0.4

ags_audio_file_close ()

void
ags_audio_file_close (AgsAudioFile *audio_file);

Close the AgsAudioFile.

Parameters

audio_file

the AgsAudioFile

  

Since 0.3

ags_audio_file_read_audio_signal ()

void
ags_audio_file_read_audio_signal (AgsAudioFile *audio_file);

Convert the AgsAudioFile to a GList of buffers.

Parameters

audio_file

the AgsAudioFile

  

Since 0.3

ags_audio_file_seek ()

void
ags_audio_file_seek (AgsAudioFile *audio_file,
                     guint frames,
                     gint whence);

Position the AgsAudioFile's internal data address.

Parameters

audio_file

the AgsAudioFile

  

frames

number of frames to seek

  

whence

SEEK_SET, SEEK_CUR, or SEEK_END

  

Since 0.4

ags_audio_file_write ()

void
ags_audio_file_write (AgsAudioFile *audio_file,
                      signed short *buffer,
                      guint buffer_size);

Write the buffer to AgsAudioFile.

Parameters

audio_file

the AgsAudioFile

  

buffer

the audio data

  

buffer_size

the count of frames to write

  

Since 0.4

ags_audio_file_flush ()

void
ags_audio_file_flush (AgsAudioFile *audio_file);

Flushes the AgsAudioFile's internal buffer.

Parameters

audio_file

the AgsAudioFile

  

Since 0.4

ags_audio_file_new ()

AgsAudioFile *
ags_audio_file_new (gchar *name,
                    AgsDevout *devout,
                    guint start_channel,
                    guint audio_channels);

Creates an AgsAudioFile.

Parameters

name

the filename

  

devout

defaults of AgsDevout

  

start_channel

ommited channels

  

audio_channels

number of channels to read

  

Returns

an empty AgsAudioFile.

Since 0.3

Types and Values

Generated by GTK-Doc V1.21