MIRAGE_FInterface_AUDIO interface

## MIRAGE_FInterface_AUDIO interface MIRAGE_FInterface_AUDIO interface — AUDIO Fragment interface |

## Synopsis

    #include <mirage.h>

                        MIRAGE_FInterface_AUDIO;
    gboolean            mirage_finterface_audio_set_file    (MIRAGE_FInterface_AUDIO *self,
                                                             gchar *filename,
                                                             GError **error);
    gboolean            mirage_finterface_audio_get_file    (MIRAGE_FInterface_AUDIO *self,
                                                             gchar **filename,
                                                             GError **error);
    gboolean            mirage_finterface_audio_set_offset  (MIRAGE_FInterface_AUDIO *self,
                                                             gint offset,
                                                             GError **error);
    gboolean            mirage_finterface_audio_get_offset  (MIRAGE_FInterface_AUDIO *self,
                                                             gint *offset,
                                                             GError **error);

## Description

MIRAGE_FInterface_AUDIO is AUDIO Fragment interface that can be implemented by a MIRAGE_Fragment implementation.

## Details

### MIRAGE_FInterface_AUDIO

    typedef struct _MIRAGE_FInterface_AUDIO MIRAGE_FInterface_AUDIO;

Dummy interface structure.

### mirage_finterface_audio_set_file ()

    gboolean            mirage_finterface_audio_set_file    (MIRAGE_FInterface_AUDIO *self,
                                                             gchar *filename,
                                                             GError **error);

Sets audio file to `filename`.

`self` : | a MIRAGE_FInterface_AUDIO
`filename` : | filename
`error` : | location to store error, or `NULL`
Returns : | `TRUE` on success, `FALSE` on failure

### mirage_finterface_audio_get_file ()

    gboolean            mirage_finterface_audio_get_file    (MIRAGE_FInterface_AUDIO *self,
                                                             gchar **filename,
                                                             GError **error);

Retrieves filename of audio file. A copy of filename is stored to `filename`; it should be freed with `g_free()` when no longer needed.

`self` : | a MIRAGE_FInterface_AUDIO
`filename` : | location to store filename
`error` : | location to store error, or `NULL`
Returns : | `TRUE` on success, `FALSE` on failure

### mirage_finterface_audio_set_offset ()

    gboolean            mirage_finterface_audio_set_offset  (MIRAGE_FInterface_AUDIO *self,
                                                             gint offset,
                                                             GError **error);

Sets offset within audio file, in sectors.

`self` : | a MIRAGE_FInterface_AUDIO
`offset` : | offset
`error` : | location to store error, or `NULL`
Returns : | `TRUE` on success, `FALSE` on failure

### mirage_finterface_audio_get_offset ()

    gboolean            mirage_finterface_audio_get_offset  (MIRAGE_FInterface_AUDIO *self,
                                                             gint *offset,
                                                             GError **error);

Retrieves offset within audio file, in sectors.

`self` : | a MIRAGE_FInterface_AUDIO
`offset` : | location to store offset
`error` : | location to store error, or `NULL`
Returns : | `TRUE` on success, `FALSE` on failure

## See Also

MIRAGE_Fragment