Module webrtc.java

Package dev.onvoid.webrtc

Class PeerConnectionFactory

java.lang.Object

dev.onvoid.webrtc.internal.NativeObject

dev.onvoid.webrtc.internal.DisposableNativeObject

dev.onvoid.webrtc.PeerConnectionFactory

public class PeerConnectionFactory
extends dev.onvoid.webrtc.internal.DisposableNativeObject

The PeerConnectionFactory is the main entry point for a WebRTC application. It provides factory methods for RTCPeerConnection and audio/video MediaStreamTracks.

Author:

Alex Andres

Constructor Summary

Constructors

Constructor	Description
PeerConnectionFactory()	Creates an instance of PeerConnectionFactory.
PeerConnectionFactory(AudioDeviceModule audioModule)	Creates an instance of PeerConnectionFactory with the provided audio module.

Method Summary

Modifier and Type	Method	Description
AudioSource	createAudioSource(AudioOptions options)	Creates an AudioSource.
AudioTrack	createAudioTrack(String label, AudioSource source)	Creates an new AudioTrack.
RTCPeerConnection	createPeerConnection(RTCConfiguration config, PeerConnectionObserver observer)	Creates a new RTCPeerConnection.
VideoTrack	createVideoTrack(String label, VideoSource source)	Creates a new VideoTrack.
void	dispose()	Invoke native object destructors and free native resources.
RTCRtpCapabilities	getRtpReceiverCapabilities(MediaType type)	Returns the capabilities of the system for receiving media of the given media type.
RTCRtpCapabilities	getRtpSenderCapabilities(MediaType type)	Returns the capabilities of the system for sending media of the given media type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeerConnectionFactory

public PeerConnectionFactory()

Creates an instance of PeerConnectionFactory.

PeerConnectionFactory

public PeerConnectionFactory(AudioDeviceModule audioModule)

Creates an instance of PeerConnectionFactory with the provided audio module.

Parameters:

audioModule - The custom audio module.

Method Detail

createAudioSource

public AudioSource createAudioSource(AudioOptions options)

Creates an AudioSource. The audio source may be used by one or more AudioTracks.

Parameters:

options - Audio options to control the audio processing.

Returns:

The created audio source.

createAudioTrack

public AudioTrack createAudioTrack(String label,
                                   AudioSource source)

Creates an new AudioTrack. The audio track can be added to the RTCPeerConnection using the addTrack or addTransceiver methods.

Parameters:

label - The identifier string of the audio track.

source - The audio source that provides audio data.

Returns:

The created audio track.

createVideoTrack

public VideoTrack createVideoTrack(String label,
                                   VideoSource source)

Creates a new VideoTrack. The video track can be added to the RTCPeerConnection using the addTrack or addTransceiver methods.

Parameters:

label - The identifier string of the video track.

source - The video source that provides video data.

Returns:

The created video track.

createPeerConnection

public RTCPeerConnection createPeerConnection(RTCConfiguration config,
                                              PeerConnectionObserver observer)

Creates a new RTCPeerConnection.

Parameters:

config - The peer connection configuration.

observer - The observer that receives peer connection state changes.

Returns:

The created peer connection.

getRtpReceiverCapabilities

public RTCRtpCapabilities getRtpReceiverCapabilities(MediaType type)

Returns the capabilities of the system for receiving media of the given media type.

Parameters:

type - The type value must be either AUDIO or VIDEO.

Returns:

The supported capabilities for an RTCRtpReceiver.

getRtpSenderCapabilities

public RTCRtpCapabilities getRtpSenderCapabilities(MediaType type)

Returns the capabilities of the system for sending media of the given media type.

Parameters:

type - The type value must be either AUDIO or VIDEO.

Returns:

The supported capabilities for an RTCRtpSender.

dispose

public void dispose()

Description copied from class: dev.onvoid.webrtc.internal.DisposableNativeObject

Invoke native object destructors and free native resources.

Specified by:

dispose in class dev.onvoid.webrtc.internal.DisposableNativeObject