net.java.sip.communicator.service.neomedia
Interface AudioMediaStream

All Superinterfaces:

MediaStream

All Known Implementing Classes:

AudioMediaStreamImpl

public interface AudioMediaStream
extends MediaStream

Extends the MediaStream interface and adds methods specific to audio streaming.

Author:

Emil Ivov

Field Summary

Fields inherited from interface net.java.sip.communicator.service.neomedia.MediaStream

PNAME_LOCAL_SSRC, PNAME_REMOTE_SSRC

Method Summary

void	addDTMFListener(DTMFListener listener) Registers a listener that would receive notification events if the remote party starts sending DTMF tones to us.
void	removeDTMFListener(DTMFListener listener) Removes listener from the list of DTMFListeners registered to receive events for incoming DTMF tones.
void	setCsrcAudioLevelListener(CsrcAudioLevelListener listener) Registers listener as the CsrcAudioLevelListener that will receive notifications for changes in the levels of conference participants that the remote party could be mixing.
void	setLocalUserAudioLevelListener(SimpleAudioLevelListener listener) Sets listener as the SimpleAudioLevelListener registered to receive notifications for changes in the levels of the audio that this stream is sending out.
void	setStreamAudioLevelListener(SimpleAudioLevelListener listener) Sets listener as the SimpleAudioLevelListener registered to receive notifications for changes in the levels of the party that's at the other end of this stream.
void	startSendingDTMF(DTMFTone tone, DTMFMethod dtmfMethod) Starts sending the specified DTMFTone until the stopSendingDTMF() method is called (Excepts for INBAND DTMF, which stops by itself this is why where there is no need to call the stopSendingDTMF).
void	stopSendingDTMF(DTMFMethod dtmfMethod) Interrupts transmission of a DTMFTone started with the startSendingDTMF method.

Methods inherited from interface net.java.sip.communicator.service.neomedia.MediaStream

addDynamicRTPPayloadType, addPropertyChangeListener, addRTPExtension, close, getActiveRTPExtensions, getDevice, getDirection, getDynamicRTPPayloadTypes, getFormat, getLocalSourceID, getMediaStreamStats, getName, getRemoteControlAddress, getRemoteDataAddress, getRemoteSourceID, getSrtpControl, getTarget, getTransportProtocol, isMute, isStarted, removePropertyChangeListener, setConnector, setDevice, setDirection, setFormat, setMute, setName, setRTPTranslator, setTarget, start, stop

Method Detail

setStreamAudioLevelListener

void setStreamAudioLevelListener(SimpleAudioLevelListener listener)

Sets listener as the SimpleAudioLevelListener registered to receive notifications for changes in the levels of the party that's at the other end of this stream.

Parameters:

listener - the SimpleAudioLevelListener that we'd like to register or null if we want to stop stream audio level measurements.

setCsrcAudioLevelListener

void setCsrcAudioLevelListener(CsrcAudioLevelListener listener)

Registers listener as the CsrcAudioLevelListener that will receive notifications for changes in the levels of conference participants that the remote party could be mixing.

Parameters:

listener - the CsrcAudioLevelListener that we'd like to register or null if we'd like to stop receiving notifications.

setLocalUserAudioLevelListener

void setLocalUserAudioLevelListener(SimpleAudioLevelListener listener)

Sets listener as the SimpleAudioLevelListener registered to receive notifications for changes in the levels of the audio that this stream is sending out.

Parameters:

listener - the SimpleAudioLevelListener that we'd like to register or null if we want to stop local audio level measurements.

startSendingDTMF

void startSendingDTMF(DTMFTone tone,
                      DTMFMethod dtmfMethod)

Starts sending the specified DTMFTone until the stopSendingDTMF() method is called (Excepts for INBAND DTMF, which stops by itself this is why where there is no need to call the stopSendingDTMF). Callers should keep in mind the fact that calling this method would most likely interrupt all audio transmission until the corresponding stop method is called. Also, calling this method successively without invoking the corresponding stop method between the calls will simply replace the DTMFTone from the first call with that from the second.

Parameters:

tone - the DTMFTone to start sending.

dtmfMethod - The kind of DTMF used (RTP, SIP-INOF or INBAND).

stopSendingDTMF

void stopSendingDTMF(DTMFMethod dtmfMethod)

Interrupts transmission of a DTMFTone started with the startSendingDTMF method. This method has no effect if no tone is being currently sent.

Parameters:

dtmfMethod - the DTMFMethod to stop sending.

addDTMFListener

void addDTMFListener(DTMFListener listener)

Registers a listener that would receive notification events if the remote party starts sending DTMF tones to us.

Parameters:

listener - the DTMFListener that we'd like to register.

removeDTMFListener

void removeDTMFListener(DTMFListener listener)

Removes listener from the list of DTMFListeners registered to receive events for incoming DTMF tones.

Parameters:

listener - the listener that we'd like to unregister