struct TpDTMFPlayer

struct TpDTMFPlayer;

An object to convert a string of characters representing DTMF tones into timed start and stop events.

Typically, a connection manager should instantiate one TpDTMFPlayer for each StreamedMedia or Call channel that supports DTMF.

The "started-tone" and "stopped-tone" signals should be connected to some way to play a tone, either directly or by emitting signals from the StreamHandler interface.

The "tones-deferred" signal should trigger emission of TonesDeferred.

The "finished" signal indicates that the current sequence of tones has finished.

Since 0.13.3

tp_dtmf_player_new ()

TpDTMFPlayer *      tp_dtmf_player_new                  (void);

Since 0.13.3

tp_dtmf_player_play ()

gboolean            tp_dtmf_player_play                 (TpDTMFPlayer *self,
                                                         const gchar *tones,
                                                         guint tone_ms,
                                                         guint gap_ms,
                                                         guint pause_ms,
                                                         GError **error);

Start to play a sequence of tones, by emitting the "started-tone" and "stopped-tone" signals.

If tp_dtmf_player_is_active() would return TRUE, this method raises TP_ERROR_SERVICE_BUSY and does not play anything, and the previous sequence continues to play.

The recognised characters are 0-9, A-D, # and * (which play the corresponding DTMF event), P, X and comma (which each pause for pause_ms milliseconds), and W (which stops interpretation of the string and emits "tones-deferred" with the rest of the string). The corresponding lower-case letters are also allowed. If tones contains any other characters, this method raises TP_ERROR_INVALID_ARGUMENT and does not play anything.

Since 0.13.3

tp_dtmf_player_cancel ()

void                tp_dtmf_player_cancel               (TpDTMFPlayer *self);

If tones were being played, stop the current tone (if any), stop playing subsequent tones, and emit "finished".

Otherwise, do nothing.

Since 0.13.3

tp_dtmf_player_is_active ()

gboolean            tp_dtmf_player_is_active            (TpDTMFPlayer *self);

Since 0.13.3

The "finished" signal

void                user_function                      (TpDTMFPlayer *self,
                                                        gboolean      cancelled,
                                                        gpointer      user_data)      : Run Last

Emitted when playback stops, either because the end of the sequence was reached, tp_dtmf_player_cancel() was called, or a 'W' or 'w' character was encountered.

Since 0.13.3

The "started-tone" signal

void                user_function                      (TpDTMFPlayer *self,
                                                        guint         event,
                                                        gpointer      user_data)      : Run Last

Emitted at the beginning of each tone.

The "stopped-tone" signal

void                user_function                      (TpDTMFPlayer *self,
                                                        gpointer      user_data)      : Run Last

Emitted at the end of each tone.

Since 0.13.3

The "tones-deferred" signal

void                user_function                      (TpDTMFPlayer *self,
                                                        gchar        *tones,
                                                        gpointer      user_data)      : Run Last

Emitted just before "finished" if a 'W' or 'w' character is encountered before the end of a dial string. The connection manager is expected to wait for the user to confirm, then call tp_dtmf_player_play() again, using this signal's argument as the new dial string.

Since 0.13.3