RmVox

RmVox — Vox playback

Stability Level

Stable, unless otherwise indicated

Functions

RmVoxPlayback * rm_vox_init ()
gboolean rm_vox_play ()
gboolean rm_vox_shutdown ()
gboolean rm_vox_set_pause ()
gboolean rm_vox_seek ()
gint rm_vox_get_fraction ()
gfloat rm_vox_get_seconds ()
void rm_vox_use_ringtone_audio ()

Types and Values

Description

FRITZ!Box voice box playback function (speex)

Functions

rm_vox_init ()

RmVoxPlayback *
rm_vox_init (gconstpointer data,
             gsize len,
             GError **error);

Initialize vox playback structure.

Parameters

data

voice data

 

len

length of voice data

 

error

a GError

 

Returns

new RmVoxPlayback


rm_vox_play ()

gboolean
rm_vox_play (RmVoxPlayback *playback);

Play voicebox message file.

Parameters

playback

a RmVoxPlayback

 

Returns

TRUE on playback started, FALSE otherwise


rm_vox_shutdown ()

gboolean
rm_vox_shutdown (RmVoxPlayback *playback);

Stop vox playback if it is still running

Parameters

playback

a RmVoxPlayback

 

Returns

TRUE if playback has been stop, FALSE on error


rm_vox_set_pause ()

gboolean
rm_vox_set_pause (RmVoxPlayback *playback,
                  gboolean state);

Toggle pause state. TRUE = pause, FALSE = unpause.

Parameters

playback

a RmVoxPlayback

 

pause

pause state

 

Returns

TRUE if successful


rm_vox_seek ()

gboolean
rm_vox_seek (RmVoxPlayback *playback,
             gdouble pos);

Seek within vox stream.

Parameters

playback

a RmVoxPlayback

 

pos

position fraction

 

Returns

TRUE on seek success, FALSE on error


rm_vox_get_fraction ()

gint
rm_vox_get_fraction (RmVoxPlayback *playback);

Get current fraction of playback slider.

Parameters

playback

a RmVoxPlayback

 

Returns

current fraction


rm_vox_get_seconds ()

gfloat
rm_vox_get_seconds (RmVoxPlayback *playback);

Get current seconds of playback.

Parameters

playback

a RmVoxPlayback

 

Returns

current seconds


rm_vox_use_ringtone_audio ()

void
rm_vox_use_ringtone_audio (RmVoxPlayback *playback,
                           gboolean ringtone);

Sets usage of ringtone device.

Parameters

ringtone

ringtone flag

 

Types and Values

RmVoxPlayback

typedef struct _RmVoxPlayback RmVoxPlayback;