## nautilus-burn-recorder

nautilus-burn-recorder

## Synopsis

    #define             NAUTILUS_BURN_RECORDER_ERROR
    GQuark              nautilus_burn_recorder_error_quark  (void);
    enum                NautilusBurnRecorderError;
    void                (*CancelFunc)                       (gpointer data);
    enum                NautilusBurnRecorderResult;
    enum                NautilusBurnRecorderResponse;
    enum                NautilusBurnRecorderTrackType;
    typedef             NautilusBurnRecorderTrack;
    enum                NautilusBurnRecorderWriteFlags;
    enum                NautilusBurnRecorderBlankFlags;
    enum                NautilusBurnRecorderBlankType;
    typedef             NautilusBurnRecorder;
    typedef             NautilusBurnRecorderClass;
    typedef             NautilusBurnRecorderPrivate;
    enum                NautilusBurnRecorderActions;
    enum                NautilusBurnRecorderMedia;
    void                progress_changed                    (NautilusBurnRecorder *recorder,
                                                             gdouble fraction,
                                                             long seconds );
    void                action_changed                      (NautilusBurnRecorder *recorder,
                                                             NautilusBurnRecorderActions action,
                                                             NautilusBurnRecorderMedia media);
    void                animation_changed                   (NautilusBurnRecorder *recorder,
                                                             gboolean spinning);
    gboolean            insert_cd_request                   (NautilusBurnRecorder *recorder,
                                                             gboolean is_reload,
                                                             gboolean can_rewrite,
                                                             gboolean busy);
    int                 warn_data_loss                      (NautilusBurnRecorder *recorder);
    NautilusBurnRecorder* nautilus_burn_recorder_new        (void);
    int                 nautilus_burn_recorder_write_tracks (NautilusBurnRecorder *recorder,
                                                             NautilusBurnDrive *drive,
                                                             GList *tracks,
                                                             int speed,
                                                             NautilusBurnRecorderWriteFlags flags,
                                                             GError **error);
    int                 nautilus_burn_recorder_blank_disc   (NautilusBurnRecorder *recorder,
                                                             NautilusBurnDrive *drive,
                                                             NautilusBurnRecorderBlankType type,
                                                             NautilusBurnRecorderBlankFlags flags,
                                                             GError **error);
    gboolean            nautilus_burn_recorder_cancel       (NautilusBurnRecorder *recorder,
                                                             gboolean skip_if_dangerous);
    void                nautilus_burn_recorder_track_free   (NautilusBurnRecorderTrack *track);

## Object Hierarchy

      GObject
       +----NautilusBurnRecorder

## Signals

      "action-changed"                                 : Run Last
      "animation-changed"                              : Run Last
      "insert-media-request"                           : Run Last
      "progress-changed"                               : Run Last
      "warn-data-loss"                                 : Run Last

## Description

## Details

### NAUTILUS_BURN_RECORDER_ERROR

    #define NAUTILUS_BURN_RECORDER_ERROR nautilus_burn_recorder_error_quark ()

### nautilus_burn_recorder_error_quark ()

    GQuark              nautilus_burn_recorder_error_quark  (void);

Returns : |

### enum NautilusBurnRecorderError

    typedef enum {
            NAUTILUS_BURN_RECORDER_ERROR_INTERNAL,
            NAUTILUS_BURN_RECORDER_ERROR_GENERAL
    } NautilusBurnRecorderError;

### CancelFunc ()

    void                (*CancelFunc)                       (gpointer data);

`data` : |

### enum NautilusBurnRecorderResult

    typedef enum {
            NAUTILUS_BURN_RECORDER_RESULT_ERROR     = -1,
            NAUTILUS_BURN_RECORDER_RESULT_CANCEL    = -2,
            NAUTILUS_BURN_RECORDER_RESULT_FINISHED  = -3,
            NAUTILUS_BURN_RECORDER_RESULT_RETRY     = -4
    } NautilusBurnRecorderResult;

### enum NautilusBurnRecorderResponse

    typedef enum {
            NAUTILUS_BURN_RECORDER_RESPONSE_NONE   =  0,
            NAUTILUS_BURN_RECORDER_RESPONSE_CANCEL = -1,
            NAUTILUS_BURN_RECORDER_RESPONSE_ERASE  = -2,
            NAUTILUS_BURN_RECORDER_RESPONSE_RETRY  = -3
    } NautilusBurnRecorderResponse;

### enum NautilusBurnRecorderTrackType

    typedef enum {
            NAUTILUS_BURN_RECORDER_TRACK_TYPE_UNKNOWN,
            NAUTILUS_BURN_RECORDER_TRACK_TYPE_AUDIO,
            NAUTILUS_BURN_RECORDER_TRACK_TYPE_DATA,
            NAUTILUS_BURN_RECORDER_TRACK_TYPE_CUE,
            NAUTILUS_BURN_RECORDER_TRACK_TYPE_GRAFT_LIST
    } NautilusBurnRecorderTrackType;

### NautilusBurnRecorderTrack

    typedef struct NautilusBurnRecorderTrack NautilusBurnRecorderTrack;

### enum NautilusBurnRecorderWriteFlags

    typedef enum {
            NAUTILUS_BURN_RECORDER_WRITE_NONE               = 0,
            NAUTILUS_BURN_RECORDER_WRITE_EJECT              = 1 << 0,
            NAUTILUS_BURN_RECORDER_WRITE_BLANK              = 1 << 1,
            NAUTILUS_BURN_RECORDER_WRITE_DUMMY_WRITE        = 1 << 2,
            NAUTILUS_BURN_RECORDER_WRITE_DISC_AT_ONCE       = 1 << 3,
            NAUTILUS_BURN_RECORDER_WRITE_DEBUG              = 1 << 4,
            NAUTILUS_BURN_RECORDER_WRITE_OVERBURN           = 1 << 5,
            NAUTILUS_BURN_RECORDER_WRITE_BURNPROOF          = 1 << 6,
            NAUTILUS_BURN_RECORDER_WRITE_JOLIET             = 1 << 7,
            NAUTILUS_BURN_RECORDER_WRITE_UDF                = 1 << 8
    } NautilusBurnRecorderWriteFlags;

### enum NautilusBurnRecorderBlankFlags

    typedef enum {
            NAUTILUS_BURN_RECORDER_BLANK_NONE               = 0,
            NAUTILUS_BURN_RECORDER_BLANK_DUMMY_WRITE        = 1 << 1,
            NAUTILUS_BURN_RECORDER_BLANK_DEBUG              = 1 << 2,
    } NautilusBurnRecorderBlankFlags;

### enum NautilusBurnRecorderBlankType

    typedef enum {
            NAUTILUS_BURN_RECORDER_BLANK_FAST,
            NAUTILUS_BURN_RECORDER_BLANK_FULL
    } NautilusBurnRecorderBlankType;

### NautilusBurnRecorder

    typedef struct NautilusBurnRecorder                NautilusBurnRecorder;

### NautilusBurnRecorderClass

    typedef struct NautilusBurnRecorderClass           NautilusBurnRecorderClass;

### NautilusBurnRecorderPrivate

    typedef struct NautilusBurnRecorderPrivate         NautilusBurnRecorderPrivate;

### enum NautilusBurnRecorderActions

    typedef enum {
            NAUTILUS_BURN_RECORDER_ACTION_PREPARING_WRITE,
            NAUTILUS_BURN_RECORDER_ACTION_WRITING,
            NAUTILUS_BURN_RECORDER_ACTION_FIXATING,
            NAUTILUS_BURN_RECORDER_ACTION_BLANKING
    } NautilusBurnRecorderActions;

### enum NautilusBurnRecorderMedia

    typedef enum {
            NAUTILUS_BURN_RECORDER_MEDIA_CD,
            NAUTILUS_BURN_RECORDER_MEDIA_DVD,
    } NautilusBurnRecorderMedia;

### progress_changed ()

    void                progress_changed                    (NautilusBurnRecorder *recorder,
                                                             gdouble fraction,
                                                             long seconds );

`recorder` : |
`fraction` : |
`Param3` : |

### action_changed ()

    void                action_changed                      (NautilusBurnRecorder *recorder,
                                                             NautilusBurnRecorderActions action,
                                                             NautilusBurnRecorderMedia media);

`recorder` : |
`action` : |
`media` : |

### animation_changed ()

    void                animation_changed                   (NautilusBurnRecorder *recorder,
                                                             gboolean spinning);

`recorder` : |
`spinning` : |

### insert_cd_request ()

    gboolean            insert_cd_request                   (NautilusBurnRecorder *recorder,
                                                             gboolean is_reload,
                                                             gboolean can_rewrite,
                                                             gboolean busy);

`recorder` : |
`is_reload` : |
`can_rewrite` : |
`busy` : |
Returns : |

### warn_data_loss ()

    int                 warn_data_loss                      (NautilusBurnRecorder *recorder);

`recorder` : |
Returns : |

### nautilus_burn_recorder_new ()

    NautilusBurnRecorder* nautilus_burn_recorder_new        (void);

Create a new NautilusBurnRecorder.

Returns : | The new recorder.

### nautilus_burn_recorder_write_tracks ()

    int                 nautilus_burn_recorder_write_tracks (NautilusBurnRecorder *recorder,
                                                             NautilusBurnDrive *drive,
                                                             GList *tracks,
                                                             int speed,
                                                             NautilusBurnRecorderWriteFlags flags,
                                                             GError **error);

Write tracks to the specified drive.

`recorder` : | NautilusBurnRecorder
`drive` : | NautilusBurnDrive to write to
`tracks` : | list of tracks to write
`speed` : | speed at which to write data
`flags` : | NautilusBurnRecorderWriteFlags
`error` : | return location for errors
Returns : | NautilusBurnRecorderResult

### nautilus_burn_recorder_blank_disc ()

    int                 nautilus_burn_recorder_blank_disc   (NautilusBurnRecorder *recorder,
                                                             NautilusBurnDrive *drive,
                                                             NautilusBurnRecorderBlankType type,
                                                             NautilusBurnRecorderBlankFlags flags,
                                                             GError **error);

Blank the media in the specified drive.

`recorder` : | NautilusBurnRecorder
`drive` : | NautilusBurnDrive to use
`type` : | NautilusBurnRecorderBlankType
`flags` : | NautilusBurnRecorderBlankFlags
`error` : | return location for errors
Returns : | NautilusBurnRecorderResult

### nautilus_burn_recorder_cancel ()

    gboolean            nautilus_burn_recorder_cancel       (NautilusBurnRecorder *recorder,
                                                             gboolean skip_if_dangerous);

Cancel active writing process.

`recorder` : | NautilusBurnRecorder
`skip_if_dangerous` : |
Returns : | `TRUE` if succesfully cancelled, `FALSE` otherwise

### nautilus_burn_recorder_track_free ()

    void                nautilus_burn_recorder_track_free   (NautilusBurnRecorderTrack *track);

Free track data.

`track` : | NautilusBurnRecorderTrack

## Signal Details

### The `"action-changed"` signal

    void                user_function                      (NautilusBurnRecorder *nautilusburnrecorder,
                                                            gint                  arg1,
                                                            gint                  arg2,
                                                            gpointer              user_data)                 : Run Last

`nautilusburnrecorder` : | the object which received the signal.
`arg1` : |
`arg2` : |
`user_data` : | user data set when the signal handler was connected.

### The `"animation-changed"` signal

    void                user_function                      (NautilusBurnRecorder *nautilusburnrecorder,
                                                            gboolean              arg1,
                                                            gpointer              user_data)                 : Run Last

`nautilusburnrecorder` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.

### The `"insert-media-request"` signal

    gboolean            user_function                      (NautilusBurnRecorder *nautilusburnrecorder,
                                                            gboolean              arg1,
                                                            gboolean              arg2,
                                                            gboolean              arg3,
                                                            gpointer              user_data)                 : Run Last

`nautilusburnrecorder` : | the object which received the signal.
`arg1` : |
`arg2` : |
`arg3` : |
`user_data` : | user data set when the signal handler was connected.
Returns : |

### The `"progress-changed"` signal

    void                user_function                      (NautilusBurnRecorder *nautilusburnrecorder,
                                                            gdouble               arg1,
                                                            glong                 arg2,
                                                            gpointer              user_data)                 : Run Last

`nautilusburnrecorder` : | the object which received the signal.
`arg1` : |
`arg2` : |
`user_data` : | user data set when the signal handler was connected.

### The `"warn-data-loss"` signal

    gint                user_function                      (NautilusBurnRecorder *nautilusburnrecorder,
                                                            gpointer              user_data)                 : Run Last

`nautilusburnrecorder` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.
Returns : |