RmFax

RmFax — Fax device implementation

Functions

void rm_fax_register ()
GSList * rm_fax_get_plugins ()
gchar * rm_fax_get_name ()
gboolean rm_fax_get_status ()
RmConnection * rm_fax_send ()
RmFax * rm_fax_get ()
void rm_fax_hangup ()

Types and Values

Description

Wrapper for fax device functions.

Functions

rm_fax_register ()

void
rm_fax_register (RmFax *fax);

Register fax plugin.

Parameters

fax

a RmFax

 

rm_fax_get_plugins ()

GSList *
rm_fax_get_plugins (void);

Return list of fax plugins

Returns

a list of fax plugins


rm_fax_get_name ()

gchar *
rm_fax_get_name (RmFax *fax);

Return name of fax device

Parameters

fax

a RmFax

 

Returns

fax name


rm_fax_get_status ()

gboolean
rm_fax_get_status (RmFax *fax,
                   RmConnection *connection,
                   RmFaxStatus *status);

Retrieve fax status in fax_status for given fax device fax with connection connection .

Parameters

fax

a RmFax

 

connection

a RmConnection

 

status

a RmFaxStatus

 

Returns

TRUE if status has been received, FALSE on error


rm_fax_send ()

RmConnection *
rm_fax_send (RmFax *fax,
             gchar *file,
             const gchar *target,
             gboolean anonymous);

Starts fax file transfer.

Parameters

fax

a RmFax device

 

file

file name to transfer

 

target

target phone number

 

anonymous

flag indicating if we should create an anonymous connection

 

Returns

a RmConnection for the fax transfer


rm_fax_get ()

RmFax *
rm_fax_get (gchar *name);

Retrieve fax device by name.

Parameters

name

Name of fax device

 

Returns

a RmFax device or NULL on error


rm_fax_hangup ()

void
rm_fax_hangup (RmFax *fax,
               RmConnection *connection);

Hangup fax connection on device fax .

Parameters

fax

a RmFax device

 

connection

a RmConnection

 

Types and Values

enum RmFaxPhase

Phase of a fax connection

Members

RM_FAX_PHASE_CALL

Calling

 

RM_FAX_PHASE_IDENTIFY

Identify remote fax

 

RM_FAX_PHASE_SIGNALLING

Signalling data

 

RM_FAX_PHASE_RELEASE

Releasing

 

RmFaxStatus

typedef struct {
} RmFaxStatus;

The RmFaxStatus contains only private fileds and should not be directly accessed.


RmFax

typedef struct {
} RmFax;

The RmFax contains only private fileds and should not be directly accessed.