reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
resip::DtmfPayloadContents::DtmfPayload Class Reference

#include <DtmfPayloadContents.hxx>

Public Member Functions

 DtmfPayload (char button, int duration)
 
 DtmfPayload ()
 
 DtmfPayload (const DtmfPayload &rhs)
 
DtmfPayload & operator= (const DtmfPayload &rhs)
 
void parse (ParseBuffer &pb)
 
EncodeStream & encode (EncodeStream &) const
 
char getButton () const
 obtain representation of the button as a character
 
unsigned short getEventCode () const
 obtain representation of the button as event code
 
int getDuration () const
 obtain duration in milliseconds
 

Friends

class DtmfPayloadContents
 

Detailed Description

Definition at line 23 of file DtmfPayloadContents.hxx.

Constructor & Destructor Documentation

◆ DtmfPayload() [1/3]

DtmfPayloadContents::DtmfPayload::DtmfPayload ( char  button,
int  duration 
)

Definition at line 79 of file DtmfPayloadContents.cxx.

◆ DtmfPayload() [2/3]

resip::DtmfPayloadContents::DtmfPayload::DtmfPayload ( )
inline

Definition at line 28 of file DtmfPayloadContents.hxx.

◆ DtmfPayload() [3/3]

DtmfPayloadContents::DtmfPayload::DtmfPayload ( const DtmfPayload &  rhs)

Definition at line 84 of file DtmfPayloadContents.cxx.

Member Function Documentation

◆ encode()

EncodeStream & DtmfPayloadContents::DtmfPayload::encode ( EncodeStream &  s) const

Definition at line 198 of file DtmfPayloadContents.cxx.

◆ getButton()

char resip::DtmfPayloadContents::DtmfPayload::getButton ( ) const
inline

obtain representation of the button as a character

Returns
the ASCII symbol for the button pressed

Definition at line 39 of file DtmfPayloadContents.hxx.

◆ getDuration()

int resip::DtmfPayloadContents::DtmfPayload::getDuration ( ) const
inline

obtain duration in milliseconds

Returns
the number of milliseconds the button was pressed

Definition at line 54 of file DtmfPayloadContents.hxx.

◆ getEventCode()

unsigned short DtmfPayloadContents::DtmfPayload::getEventCode ( ) const

obtain representation of the button as event code

RFC 4733 provides a list of integer event codes for DTMF symbols.

Returns
the event code corresponding to the button pressed

Definition at line 169 of file DtmfPayloadContents.cxx.

◆ operator=()

DtmfPayloadContents::DtmfPayload & DtmfPayloadContents::DtmfPayload::operator= ( const DtmfPayload &  rhs)

Definition at line 90 of file DtmfPayloadContents.cxx.

◆ parse()

void DtmfPayloadContents::DtmfPayload::parse ( ParseBuffer &  pb)

Definition at line 117 of file DtmfPayloadContents.cxx.

Friends And Related Symbol Documentation

◆ DtmfPayloadContents

friend class DtmfPayloadContents
friend

Definition at line 62 of file DtmfPayloadContents.hxx.


The documentation for this class was generated from the following files: