QMediaRtpAudioStream Class Reference
[QtMediaModule]

Detailed Description

The QMediaRtpAudioStream class manages a single audio stream in an RTP session.

DTMF events may be sent over an audio stream as either tones added to the audio signal, or as separate RTP packets. To send DTMF events as RTP packets a valid payload with the encoding name telephone-event must be set with setTelephonyEventPayload(). If no such payload is set the DTMF tones will be added to the audio stream instead. If a stream supports DTMF RTP packets then a telephone-event payload will be included in the list supported audio payloads given by the QMediaRtpSession that created it.

Member Type Documentation

enum QMediaRtpAudioStream::DtmfTone

The event codes for DTMF tones.

Member Function Documentation

QMediaRtpAudioStream::QMediaRtpAudioStream ( Direction direction, QObject * parent = 0 )

Contructs a new RTP audio stream with the given parent which sends and/or receives data according to direction.

QMediaRtpAudioStream::~QMediaRtpAudioStream ()

Destroys an RTP audio stream.

void QMediaRtpAudioStream::setTelephonyEventPayload ( const QMediaRtpPayload & payload )   [pure virtual]

Sets the payload to be used for sending telephony events.

Returns true if the payload was successfully changed and false otherwise.

See also telephonyEventPayload().

void QMediaRtpAudioStream::startTelephonyEvent ( int event, int volume )   [pure virtual slot]

Starts sending a telephony event at the given volume on a stream.

Note: Telephony events can only be sent on Audio streams.

See also stopTelephonyEvent().

void QMediaRtpAudioStream::stopTelephonyEvent ()   [pure virtual slot]

Stops sending a telephony event.

See also startTelephonyEvent().

QMediaRtpPayload QMediaRtpAudioStream::telephonyEventPayload () const   [pure virtual]

Returns the payload used for sending telephony events.

See also setTelephonyEventPayload().