stream-webrtc-android/org.webrtc/RtpTransceiver

RtpTransceiver

Java wrapper for a C++ RtpTransceiverInterface.

The RTCRtpTransceiver maps to the RTCRtpTransceiver defined by the WebRTC specification. A transceiver represents a combination of an RTCRtpSender and an RTCRtpReceiver that share a common mid. As defined in JSEP, an RTCRtpTransceiver is said to be associated with a media description if its mid property is non-nil; otherwise, it is said to be disassociated. JSEP: https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-24

Note that RTCRtpTransceivers are only supported when using RTCPeerConnection with Unified Plan SDP.

WebRTC specification for RTCRtpTransceiver, the JavaScript analog: https://w3c.github.io/webrtc-pc/#dom-rtcrtptransceiver

Types

RtpTransceiverDirection

enum RtpTransceiverDirection

Java version of webrtc::RtpTransceiverDirection - the ordering must be kept in sync.

RtpTransceiverInit

class RtpTransceiverInit

Tracks webrtc::RtpTransceiverInit.

Functions

dispose

open fun dispose()

getCurrentDirection

open fun getCurrentDirection(): RtpTransceiver.RtpTransceiverDirection

The current_direction attribute indicates the current direction negotiated for this transceiver.

getDirection

open fun getDirection(): RtpTransceiver.RtpTransceiverDirection

The direction attribute indicates the preferred direction of this transceiver, which will be used in calls to CreateOffer and CreateAnswer.

getMediaType

open fun getMediaType(): MediaStreamTrack.MediaType

Media type of the transceiver.

getMid

open fun getMid(): String

The mid attribute is the mid negotiated and present in the local and remote descriptions.

getReceiver

open fun getReceiver(): RtpReceiver

The receiver attribute exposes the RtpReceiver corresponding to the RTP media that may be received with the transceiver's mid.

getSender

open fun getSender(): RtpSender

The sender attribute exposes the RtpSender corresponding to the RTP media that may be sent with the transceiver's mid.

isStopped

open fun isStopped(): Boolean

The stopped attribute indicates that the sender of this transceiver will no longer send, and that the receiver will no longer receive.

setCodecPreferences

open fun setCodecPreferences(codecs: List<RtpCapabilities.CodecCapability>)

setDirection

open fun setDirection(rtpTransceiverDirection: RtpTransceiver.RtpTransceiverDirection): Boolean

Sets the preferred direction of this transceiver.

stop

open fun stop()

The Stop method will for the time being call the StopInternal method.

stopInternal

open fun stopInternal()

The StopInternal method stops the RtpTransceiver, like Stop, but goes immediately to Stopped state.

stopStandard

open fun stopStandard()

The StopStandard method irreversibly stops the RtpTransceiver.