#include <call.hpp>

Data Fields
pjsua_dtmf_method	method

unsigned	timestamp

string	digit

unsigned	duration

unsigned	flags

Detailed Description

This structure contains parameters for Call::onDtmfEvent() callback.

Field Documentation

◆ method

pjsua_dtmf_method pj::OnDtmfEventParam::method

DTMF sending method.

◆ timestamp

unsigned pj::OnDtmfEventParam::timestamp

The timestamp identifying the begin of the event. Timestamp units are expressed in milliseconds. Note that this value should only be used to compare multiple events received via the same method relatively to each other, as the time-base is randomized.

◆ digit

string pj::OnDtmfEventParam::digit

DTMF ASCII digit.

◆ duration

unsigned pj::OnDtmfEventParam::duration

DTMF signal duration in milliseconds. Interpretation of the duration depends on the flag PJMEDIA_STREAM_DTMF_IS_END. depends on the method. If the method is PJSUA_DTMF_METHOD_SIP_INFO, this contains the total duration of the DTMF signal or PJSUA_UNKNOWN_DTMF_DURATION if no signal duration was indicated. If the method is PJSUA_DTMF_METHOD_RFC2833, this contains the total duration of the DTMF signal received up to this point in time.

◆ flags

unsigned pj::OnDtmfEventParam::flags

Flags indicating additional information about the DTMF event. If PJMEDIA_STREAM_DTMF_IS_UPDATE is set, the event was already indicated earlier. The new indication contains an updated event duration. If PJMEDIA_STREAM_DTMF_IS_END is set, the event has ended and this indication contains the final event duration. Note that end indications might get lost. Hence it is not guaranteed to receive an event with PJMEDIA_STREAM_DTMF_IS_END for every event.

The documentation for this struct was generated from the following file:

call.hpp