doc/PAMI-Message-Event-RTCPSentEvent.md
PAMI\Message\Event\RTCPSentEvent
===============
Event triggered when exchanging rtp stats.
PHP Version 5
* Class name: RTCPSentEvent
* Namespace: PAMI\Message\Event
* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md)
Constants
----------
### EOL
const EOL = "\r\n"
### EOM
const EOM = "\r\n\r\n"
Properties
----------
### $rawContent
protected string $rawContent
Holds original message.
* Visibility: **protected**
### $channelVariables
protected array<mixed,string> $channelVariables
Metadata. Specific channel variables.
* Visibility: **protected**
### $lines
protected array<mixed,string> $lines
Message content, line by line. This is what it gets sent
or received literally.
* Visibility: **protected**
### $variables
protected array<mixed,string> $variables
Metadata. Message variables (key/value).
* Visibility: **protected**
### $keys
protected array<mixed,string> $keys
Metadata. Message "keys" i.e: Action: login
* Visibility: **protected**
### $createdDate
protected integer $createdDate
Created date (unix timestamp).
* Visibility: **protected**
Methods
-------
### getPrivilege
string PAMI\Message\Event\RTCPSentEvent::getPrivilege()
Returns key: 'Privilege'.
* Visibility: **public**
### getTo
string PAMI\Message\Event\RTCPSentEvent::getTo()
Returns key: 'To'.
* Visibility: **public**
### getOurSSRC
string PAMI\Message\Event\RTCPSentEvent::getOurSSRC()
Returns key: 'OurSSRC'.
* Visibility: **public**
### getSentNTP
string PAMI\Message\Event\RTCPSentEvent::getSentNTP()
Returns key: 'SentNTP'.
* Visibility: **public**
### getSentRTP
string PAMI\Message\Event\RTCPSentEvent::getSentRTP()
Returns key: 'SentRTP'.
* Visibility: **public**
### getSentPackets
string PAMI\Message\Event\RTCPSentEvent::getSentPackets()
Returns key: 'SentPackets'.
* Visibility: **public**
### getSentOctets
string PAMI\Message\Event\RTCPSentEvent::getSentOctets()
Returns key: 'SentOctets'.
* Visibility: **public**
### getReportBlock
string PAMI\Message\Event\RTCPSentEvent::getReportBlock()
Returns key: 'ReportBlock'.
* Visibility: **public**
### getFractionLost
string PAMI\Message\Event\RTCPSentEvent::getFractionLost()
Returns key: 'FractionLost'.
* Visibility: **public**
### getCumulativeLoss
string PAMI\Message\Event\RTCPSentEvent::getCumulativeLoss()
Returns key: 'CumulativeLoss'.
* Visibility: **public**
### getIAJitter
string PAMI\Message\Event\RTCPSentEvent::getIAJitter()
Returns key: 'IAJitter'.
* Visibility: **public**
### getTheirLastSR
string PAMI\Message\Event\RTCPSentEvent::getTheirLastSR()
Returns key: 'TheirLastSR'.
* Visibility: **public**
### getDLSR
string PAMI\Message\Event\RTCPSentEvent::getDLSR()
Returns key: 'DLSR'.
* Visibility: **public**
### getName
string PAMI\Message\Event\EventMessage::getName()
Returns key 'Event'.
* Visibility: **public**
* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md)
### __sleep
array<mixed,string> PAMI\Message\Message::__sleep()
Serialize function.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
### getEventList
string PAMI\Message\IncomingMessage::getEventList()
Returns key 'EventList'. In respones, this will surely be a "start". In
events, should be a "complete".
* Visibility: **public**
* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md)
### getRawContent
string PAMI\Message\IncomingMessage::getRawContent()
Returns the original message content without parsing.
* Visibility: **public**
* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md)
### getAllChannelVariables
array PAMI\Message\IncomingMessage::getAllChannelVariables()
Returns the channel variables for all reported channels.
https://github.com/marcelog/PAMI/issues/85
The channel names will be lowercased.
* Visibility: **public**
* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md)
### getChannelVariables
array PAMI\Message\IncomingMessage::getChannelVariables(string $channel)
Returns the channel variables for the given channel.
https://github.com/marcelog/PAMI/issues/85
* Visibility: **public**
* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md)
#### Arguments
* $channel **string** - <p>Channel name. If not given, will return variables
for the "current" channel.</p>
### __construct
void PAMI\Message\Message::__construct()
Constructor.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
### getCreatedDate
integer PAMI\Message\Message::getCreatedDate()
Returns created date.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
### setVariable
void PAMI\Message\Message::setVariable(string $key, string $value)
Adds a variable to this message.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
#### Arguments
* $key **string** - <p>Variable name.</p>
* $value **string** - <p>Variable value.</p>
### getVariable
string PAMI\Message\Message::getVariable(string $key)
Returns a variable by name.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
#### Arguments
* $key **string** - <p>Variable name.</p>
### setKey
void PAMI\Message\Message::setKey(string $key, string $value)
Adds a variable to this message.
* Visibility: **protected**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
#### Arguments
* $key **string** - <p>Key name (i.e: Action).</p>
* $value **string** - <p>Key value.</p>
### getKey
string PAMI\Message\Message::getKey(string $key)
Returns a key by name.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
#### Arguments
* $key **string** - <p>Key name (i.e: Action).</p>
### getKeys
array<mixed,string> PAMI\Message\Message::getKeys()
Returns all keys for this message.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
### getVariables
array<mixed,string> PAMI\Message\Message::getVariables()
Returns all variabels for this message.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
### finishMessage
string PAMI\Message\Message::finishMessage($message)
Returns the end of message token appended to the end of a given message.
* Visibility: **protected**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
#### Arguments
* $message **mixed**
### serializeVariable
string PAMI\Message\Message::serializeVariable(string $key, string $value)
Returns the string representation for an ami action variable.
* Visibility: **private**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
#### Arguments
* $key **string**
* $value **string**
### serialize
string PAMI\Message\Message::serialize()
Gives a string representation for this message, ready to be sent to
ami.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)
### getActionID
string PAMI\Message\Message::getActionID()
Returns key: 'ActionID'.
* Visibility: **public**
* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)