org.freedesktop.gstreamer.webrtc

Class WebRTCBin

java.lang.Object

org.freedesktop.gstreamer.glib.NativeObject

org.freedesktop.gstreamer.glib.RefCountedObject

org.freedesktop.gstreamer.glib.GObject

org.freedesktop.gstreamer.GstObject

org.freedesktop.gstreamer.Element

org.freedesktop.gstreamer.Bin

org.freedesktop.gstreamer.webrtc.WebRTCBin

All Implemented Interfaces:

AutoCloseable

@Gst.Since(minor=14)
public class WebRTCBin
extends Bin

WebRTCBin is an abstraction over gstreamers webrtcbin element It is structured to mimic the RTCPeerConnection API that is available in web browsers

See Also:

https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection, available since Gstreamer 1.14

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WebRTCBin.CREATE_ANSWER Signal emitted when this WebRTCBin creates an answer
static interface	WebRTCBin.CREATE_OFFER Signal emitted when this WebRTCBin creates an offer
static interface	WebRTCBin.ON_ICE_CANDIDATE
static interface	WebRTCBin.ON_NEGOTIATION_NEEDED Signal emitted when this WebRTCBin is ready to do negotiation to setup a WebRTC connection Good starting point to have the WebRTCBin send an offer to potential clients

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.Bin

Bin.DebugGraphDetails, Bin.DEEP_ELEMENT_ADDED, Bin.DEEP_ELEMENT_REMOVED, Bin.DO_LATENCY, Bin.ELEMENT_ADDED, Bin.ELEMENT_REMOVED

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.Element

Element.NO_MORE_PADS, Element.PAD_ADDED, Element.PAD_REMOVED

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.GObject

GObject.GCallback, GObject.GInterface

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject

NativeObject.Initializer, NativeObject.TypeProvider, NativeObject.TypeRegistration<T extends NativeObject>

Field Summary

Fields

Modifier and Type	Field and Description
static String	GST_NAME
static String	GTYPE_NAME

Constructor Summary

Constructors

Constructor and Description
WebRTCBin(String name)

Method Summary

Modifier and Type	Method and Description
void	addIceCandidate(int sdpMLineIndex, String candidate) Adds a remote ice candidate to the bin
void	connect(WebRTCBin.ON_ICE_CANDIDATE listener) Adds a listener for the on-ice-candidate signal.
void	connect(WebRTCBin.ON_NEGOTIATION_NEEDED listener) Adds a listener for the on-negotiation-needed signal.
void	createAnswer(WebRTCBin.CREATE_ANSWER listener) Create an answer in response to an offer received in order for the WebRTC signaling protocol to start.
void	createOffer(WebRTCBin.CREATE_OFFER listener) Create an offer that can be sent to other clients to setup a WebRTC connection.
WebRTCPeerConnectionState	getConnectionState() Retrieve the connection state this WebRTCBin is currently in
WebRTCICEGatheringState	getICEGatheringState() Retrieve ICE gathering state this WebRTCBin is currently in
WebRTCSessionDescription	getLocalDescription() Retrieve the local description for this WebRTCBin
WebRTCSessionDescription	getRemoteDescription() Retrieve the remote description for this WebRTCBin
String	getStunServer() Retrieves the STUN server that is used.
String	getTurnServer() Retrieves the TURN server that is used.
void	setLocalDescription(WebRTCSessionDescription description) Sets the local description for the WebRTC connection.
void	setRemoteDescription(WebRTCSessionDescription description) Sets the remote description for the WebRTC connection.
void	setStunServer(String server) Sets the stun-server property for this WebRTCBin which is use to gather ICE data
void	setTurnServer(String server) Sets the turn-server property for this WebRTCBin which is used whenever a direct peer-to-peer connection can be established

Methods inherited from class org.freedesktop.gstreamer.Bin

add, addMany, connect, connect, connect, connect, connect, debugToDotFile, debugToDotFileWithTS, disconnect, disconnect, disconnect, disconnect, disconnect, getElementByName, getElementByNameRecurseUp, getElements, getElementsRecursive, getElementsSorted, getSinks, getSources, remove, removeMany

Methods inherited from class org.freedesktop.gstreamer.Element

addPad, connect, connect, connect, disconnect, disconnect, disconnect, getBaseTime, getBus, getClock, getContext, getFactory, getPads, getRequestPad, getSinkPads, getSrcPads, getStartTime, getState, getState, getState, getState, getStaticPad, isPlaying, link, linkFiltered, linkMany, linkPads, linkPadsFiltered, makeRawElement, pause, play, postMessage, query, queryDuration, queryPosition, ready, releaseRequestPad, removePad, seek, seekSimple, sendEvent, setBaseTime, setCaps, setContext, setLockedState, setStartTime, setState, stop, syncStateWithParent, unlink, unlinkMany, unlinkPads

Methods inherited from class org.freedesktop.gstreamer.GstObject

addControlBinding, getAsString, getControlBinding, getName, getParent, hasActiveControlBindings, removeControlBinding, setAsString, setControlBindingDisabled, setControlBindingsDisabled, setName, suggestNextSync, syncValues, toString

Methods inherited from class org.freedesktop.gstreamer.glib.GObject

addCallback, connect, connect, disconnect, dispose, emit, emit, get, getPropertyDefaultValue, getPropertyMaximumValue, getPropertyMinimumValue, getRefCount, getTypeName, invalidate, listPropertyNames, removeCallback, set

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject

close, disown, equals, getPointer, getRawPointer, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GST_NAME

public static final String GST_NAME

See Also:

Constant Field Values

GTYPE_NAME

public static final String GTYPE_NAME

See Also:

Constant Field Values

Constructor Detail

WebRTCBin

public WebRTCBin(String name)

Method Detail

connect

public void connect(WebRTCBin.ON_NEGOTIATION_NEEDED listener)

Adds a listener for the on-negotiation-needed signal.

Parameters:

listener -

connect

public void connect(WebRTCBin.ON_ICE_CANDIDATE listener)

Adds a listener for the on-ice-candidate signal.

Parameters:

listener -

createOffer

public void createOffer(WebRTCBin.CREATE_OFFER listener)

Create an offer that can be sent to other clients to setup a WebRTC connection.

In most cases setLocalDescription(org.freedesktop.gstreamer.webrtc.WebRTCSessionDescription) should be called after an answer is created

Parameters:

listener - callback that is called when a offer is created

createAnswer

public void createAnswer(WebRTCBin.CREATE_ANSWER listener)

Create an answer in response to an offer received in order for the WebRTC signaling protocol to start.

Should be called after setRemoteDescription(org.freedesktop.gstreamer.webrtc.WebRTCSessionDescription) is called

In most cases setLocalDescription(org.freedesktop.gstreamer.webrtc.WebRTCSessionDescription) should be called after an answer is created

Parameters:

listener - callback that is called when an answer is created.

addIceCandidate

public void addIceCandidate(int sdpMLineIndex,
                            String candidate)

Adds a remote ice candidate to the bin

Parameters:

sdpMLineIndex - the zero-based index of the m-line attribute within the SDP to which the candidate should be associated to

candidate - the ICE candidate

setLocalDescription

public void setLocalDescription(WebRTCSessionDescription description)

Sets the local description for the WebRTC connection. Should be called after createOffer(org.freedesktop.gstreamer.webrtc.WebRTCBin.CREATE_OFFER) or #createAnser is called.

Parameters:

description - the WebRTCSessionDescription to set for the local description

setRemoteDescription

public void setRemoteDescription(WebRTCSessionDescription description)

Sets the remote description for the WebRTC connection. Shoud be called after receiving an offer or answer from other clients.

Parameters:

description - the WebRTCSessionDescription to set for the remote description

setStunServer

public void setStunServer(String server)

Sets the stun-server property for this WebRTCBin which is use to gather ICE data

Parameters:

server - STUN server url

getStunServer

public String getStunServer()

Retrieves the STUN server that is used.

Returns:

the url for the STUN server

setTurnServer

public void setTurnServer(String server)

Sets the turn-server property for this WebRTCBin which is used whenever a direct peer-to-peer connection can be established

Parameters:

server - TURN server url

getTurnServer

public String getTurnServer()

Retrieves the TURN server that is used.

Returns:

the url for the TURN server

getConnectionState

public WebRTCPeerConnectionState getConnectionState()

Retrieve the connection state this WebRTCBin is currently in

Returns:

a WebRTCPeerConnectionState describing the connection state

getICEGatheringState

public WebRTCICEGatheringState getICEGatheringState()

Retrieve ICE gathering state this WebRTCBin is currently in

Returns:

a WebRTCICEGatheringState describing gathering state

getLocalDescription

public WebRTCSessionDescription getLocalDescription()

Retrieve the local description for this WebRTCBin

Returns:

the local WebRTCSessionDescription

getRemoteDescription

public WebRTCSessionDescription getRemoteDescription()

Retrieve the remote description for this WebRTCBin

Returns:

the remote WebRTCSessionDescription