WebRTC support helpers

SympleSignaller

SignallingInterface implementation using the Symple call protocol.

#include <icy/webrtc/support/symplesignaller.h>

class SympleSignaller

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:34

Speaks the call:init, call:accept, call:reject, call:offer, call:answer, call:candidate, and call:hangup envelope over a connected Symple client.

The remote peer identifier on this signalling boundary is the full Symple address string (user|id).

List of all members

NameKindOwner
SympleSignallerfunctionDeclared here
~SympleSignallerfunctionDeclared here
SympleSignallerfunctionDeclared here
operator=functionDeclared here
sendSdpfunctionDeclared here
sendCandidatefunctionDeclared here
sendControlfunctionDeclared here
_clientvariableDeclared here
onMessagefunctionDeclared here
sendfunctionDeclared here
SdpReceivedvariableInherited from SignallingInterface
CandidateReceivedvariableInherited from SignallingInterface
ControlReceivedvariableInherited from SignallingInterface
~SignallingInterfacefunctionInherited from SignallingInterface
sendSdpfunctionInherited from SignallingInterface
sendCandidatefunctionInherited from SignallingInterface
sendControlfunctionInherited from SignallingInterface

Inherited from SignallingInterface

KindNameDescription
variableSdpReceivedFires when an SDP offer or answer arrives from a remote peer. Parameters: peerId, type ("offer"/"answer"), sdp.
variableCandidateReceivedFires when an ICE candidate arrives from a remote peer. Parameters: peerId, candidate, mid.
variableControlReceivedFires when a control message arrives from a remote peer. Parameters: peerId, type ("init"/"accept"/"reject"/"hangup"), reason.
function~SignallingInterface virtualDefaulted destructor.
functionsendSdp virtualSend an SDP offer or answer to the remote peer.
functionsendCandidate virtualSend an ICE candidate to the remote peer.
functionsendControl virtualSend a control message to the remote peer.

Public Methods

ReturnNameDescription
SympleSignaller explicit
~SympleSignaller override
SympleSignallerDeleted constructor.
SympleSignaller &operator=Deleted assignment operator.
voidsendSdp virtual overrideSend an SDP offer or answer to the remote peer.
voidsendCandidate virtual overrideSend an ICE candidate to the remote peer.
voidsendControl virtual overrideSend a control message to the remote peer.

SympleSignaller

explicit

explicit SympleSignaller(smpl::Client & client)

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:37


~SympleSignaller

override

~SympleSignaller() override

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:38


SympleSignaller

SympleSignaller(const SympleSignaller &) = delete

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:40

Deleted constructor.


operator=

SympleSignaller & operator=(const SympleSignaller &) = delete

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:41

Deleted assignment operator.


sendSdp

virtual override

virtual void sendSdp(const std::string & peerId, const std::string & type, const std::string & sdp) override

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:43

Send an SDP offer or answer to the remote peer.

Reimplements

Parameters

ParameterTypeDescription
peerIdconst std::string &Remote peer identifier.
typeconst std::string &"offer" or "answer".
sdpconst std::string &The SDP string.

sendCandidate

virtual override

virtual void sendCandidate(const std::string & peerId, const std::string & candidate, const std::string & mid) override

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:47

Send an ICE candidate to the remote peer.

Reimplements

Parameters

ParameterTypeDescription
peerIdconst std::string &Remote peer identifier.
candidateconst std::string &The candidate string (from RTCIceCandidate).
midconst std::string &The sdpMid value.

sendControl

virtual override

virtual void sendControl(const std::string & peerId, const std::string & type, const std::string & reason = {}) override

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:51

Send a control message to the remote peer.

Reimplements

Parameters

ParameterTypeDescription
peerIdconst std::string &Remote peer identifier.
typeconst std::string &Control type: "init", "accept", "reject", "hangup".
reasonconst std::string &Optional reason string (for reject/hangup).

Private Attributes

ReturnNameDescription
smpl::Client &_client

_client

smpl::Client & _client

Type: smpl::Client &

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:61

Private Methods

ReturnNameDescription
voidonMessage
voidsend

onMessage

void onMessage(smpl::Message & msg)

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:56


send

void send(const std::string & action, const std::string & to, const json::Value & data = {})

Defined in src/webrtc/support/include/icy/webrtc/support/symplesignaller.h:57