RmPhone

RmPhone — High level phone functions

Stability Level

Stable, unless otherwise indicated

Functions

Types and Values

struct RmPhone

Description

Abstraction between application an phone plugins. Offers convenient phone function which hides all complexity.

Functions

RM_PHONE()

#define RM_PHONE(x) (RmPhone*)(x)

Cast x to RmPhone

Parameters

x

a RmPhone

 

rm_phone_register ()

void
rm_phone_register (RmPhone *phone);

Register phone plugin

Parameters

phone

a RmPhone

 

rm_phone_unregister ()

void
rm_phone_unregister (RmPhone *phone);

Unregister phone plugin

Parameters

phone

a RmPhone

 

rm_phone_get_plugins ()

GList *
rm_phone_get_plugins (void);

Retrieves GList of phone plugins

Returns

a list of phone plugins


rm_phone_get ()

RmPhone *
rm_phone_get (const gchar *name);

Find phone as requested by name.

Parameters

name

name of phone to lookup

 

Returns

a RmPhone, or NULL on error


rm_phone_get_name ()

gchar *
rm_phone_get_name (RmPhone *phone);

Get name of phone device

Parameters

phone

a RmPhone

 

Returns

phone name


rm_phone_mute ()

void
rm_phone_mute (RmPhone *phone,
               RmConnection *connection,
               gboolean mute);

Un/Mutes connection .

Parameters

phone

a RmPhone

 

connection

a RmConnection

 

mute

flag to un/mute connection

 

rm_phone_record ()

void
rm_phone_record (RmPhone *phone,
                 RmConnection *connection,
                 gboolean record);

Start/Stops recording of active connection

Parameters

phone

a RmPhone

 

connection

a RmConnection

 

record

Flag to start/stop recording

 

rm_phone_hold ()

void
rm_phone_hold (RmPhone *phone,
               RmConnection *connection,
               gboolean hold);

Holds/Releases active connection .

Parameters

phone

a RmPhone

 

connection

a RmConnection

 

hold

flag to hold/release connection

 

rm_phone_dtmf ()

void
rm_phone_dtmf (RmPhone *phone,
               RmConnection *connection,
               guchar code);

Send dtmf code on connection

Parameters

phone

a RmPhone

 

connection

a RmConnection

 

code

code to send

 

rm_phone_hangup ()

void
rm_phone_hangup (RmConnection *connection);

Hangup an active connection .

Parameters

connection

a RmConnection

 

rm_phone_pickup ()

gint
rm_phone_pickup (RmConnection *connection);

Pickup incoming call of connection .

Parameters

connection

a RmConnection

 

Returns

Status flag


rm_phone_dial ()

RmConnection *
rm_phone_dial (RmPhone *phone,
               const gchar *target,
               gboolean anonymous);

Dial target phone number.

Parameters

phone

a RmPhone

 

target

target number

 

anonymous

flag to indicate anonymous dial

 

Returns

a RmConnection or NULL on error

Types and Values

struct RmPhone

struct RmPhone {
};

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