| OGMRip Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
#include <ogmrip-encoding-manager.h> struct OGMRipEncodingManager; struct OGMRipEncodingManagerClass; enum OGMRipCleanupType; OGMRipEncodingManager * ogmrip_encoding_manager_new (void); gint ogmrip_encoding_manager_run (OGMRipEncodingManager *manager,GError **error); void ogmrip_encoding_manager_cancel (OGMRipEncodingManager *manager); void ogmrip_encoding_manager_add (OGMRipEncodingManager *manager,OGMRipEncoding *encoding); void ogmrip_encoding_manager_remove (OGMRipEncodingManager *manager,OGMRipEncoding *encoding); gboolean ogmrip_encoding_manager_foreach (OGMRipEncodingManager *manager,OGMRipEncodingFunc func,gpointer data); OGMRipEncoding * ogmrip_encoding_manager_find (OGMRipEncodingManager *manager,OGMRipEncodingFunc func,gpointer data); OGMRipEncoding * ogmrip_encoding_manager_nth (OGMRipEncodingManager *manager,gint n); gint ogmrip_encoding_manager_get_cleanup (OGMRipEncodingManager *manager); void ogmrip_encoding_manager_set_cleanup (OGMRipEncodingManager *manager,OGMRipCleanupType type);
typedef enum {
OGMRIP_CLEANUP_REMOVE_ALL,
OGMRIP_CLEANUP_KEEP_ALL,
OGMRIP_CLEANUP_KEEP_LAST
} OGMRipCleanupType;
How to clean up the temporary files of the encodings.
OGMRipEncodingManager * ogmrip_encoding_manager_new (void);
Creates a new OGMRipEncodingManager.
Returns : |
The new OGMRipEncodingManager |
gint ogmrip_encoding_manager_run (OGMRipEncodingManager *manager,GError **error);
Performs all the encodings contained in manager.
|
An OGMRipEncodingManager |
|
A location to return an error of type OGMRIP_ENCODING_ERROR |
Returns : |
An OGMJobResultType |
void ogmrip_encoding_manager_cancel (OGMRipEncodingManager *manager);
Cancels all encodings.
|
An OGMRipEncodingManager |
void ogmrip_encoding_manager_add (OGMRipEncodingManager *manager,OGMRipEncoding *encoding);
Adds encoding to manager.
|
An OGMRipEncodingManager |
|
An OGMRipEncoding |
void ogmrip_encoding_manager_remove (OGMRipEncodingManager *manager,OGMRipEncoding *encoding);
Removes encoding from manager.
|
An OGMRipEncodingManager |
|
An OGMRipEncoding |
gboolean ogmrip_encoding_manager_foreach (OGMRipEncodingManager *manager,OGMRipEncodingFunc func,gpointer data);
Invokes func on each encoding of manager.
|
An OGMRipEncodingManager |
|
A callback |
|
Callback user data |
Returns : |
TRUE if func returned TRUE for all encodings, FALSE otherwise |
OGMRipEncoding * ogmrip_encoding_manager_find (OGMRipEncodingManager *manager,OGMRipEncodingFunc func,gpointer data);
Finds the encoding of manager Finds the element in a GList which contains the given data.
|
An OGMRipEncodingManager |
|
A function to call for each encoding. It should return TRUE when the desired encoding is found |
|
User data passed to the function |
Returns : |
The found encoding, or NULL. |
OGMRipEncoding * ogmrip_encoding_manager_nth (OGMRipEncodingManager *manager,gint n);
Gets the encoding at the given position.
|
An OGMRipEncodingManager |
|
The position of the encoding, counting from 0 |
Returns : |
The encoding, or NULL. |
gint ogmrip_encoding_manager_get_cleanup (OGMRipEncodingManager *manager);
Gets the cleanup method.
|
An OGMRipEncodingManager |
Returns : |
The cleanup type |
void ogmrip_encoding_manager_set_cleanup (OGMRipEncodingManager *manager,OGMRipCleanupType type);
Sets the cleanup method.
|
An OGMRipEncodingManager |
|
The cleanup type |