API Docs for:
Show:

rtc.PeerConnection Class

Extends events.EventEmitter
Defined in: src/peer_connection.coffee:12
Module: rtc

Wrapper around native RTCPeerConnection

Provides events for new streams and data channels. Signaling information has to be forwarded from events emitted by this object to the remote PeerConnection.

Constructor

rtc.PeerConnection

(
  • offering
  • options
)

Defined in src/peer_connection.coffee:12

Parameters:

  • offering Boolean

    True if the local peer should initiate the connection

  • options Object

    Options object passed on from Room

Methods

_connectError

(
  • err
)
private

Defined in src/peer_connection.coffee:217

Mark connection attempt as failed

Parameters:

  • err Error

    Error causing connection to fail

_oaOptions

() Object private

Defined in src/peer_connection.coffee:139

Returns the options for the offer/answer

Returns:

Object:

_offer

() private

Defined in src/peer_connection.coffee:168

Create offer, set it on local description and emit it

_offer

() private

Defined in src/peer_connection.coffee:182

Create answer, set it on local description and emit it

_processLocalSdp

(
  • sdp
)
Promise private

Defined in src/peer_connection.coffee:196

Set local description and emit it

Parameters:

  • sdp Object

    The local SDP

Returns:

Promise:

Promise which will be resolved once the local description was set successfully

_setRemoteDescription

(
  • sdp
)
Promise private

Defined in src/peer_connection.coffee:155

Set the remote description

Parameters:

  • sdp Object

    The remote SDP

Returns:

Promise:

Promise which will be resolved once the remote description was set successfully

addDataChannel

(
  • name
  • desc
)

Defined in src/peer_connection.coffee:248

Add DataChannel. Will only actually do something if offering is true.

Parameters:

  • name String

    Name of the data channel

  • desc Object

    Options passed to RTCPeerConnection.createDataChannel()

addIceCandidate

(
  • desc
)

Defined in src/peer_connection.coffee:125

Add a remote ICE candidate

Parameters:

  • desc Object

    The candidate

addStream

(
  • stream
)

Defined in src/peer_connection.coffee:230

Add local stream

Parameters:

close

()

Defined in src/peer_connection.coffee:287

Close the connection to the remote peer

connect

() Promise

Defined in src/peer_connection.coffee:268

Establish connection with remote peer. Connection will be established once both peers have called this functio

Returns:

Promise:

Promise which will be resolved once the connection is established

removeStream

(
  • stream
)

Defined in src/peer_connection.coffee:239

Remove local stream

Parameters:

signaling

(
  • data
)

Defined in src/peer_connection.coffee:110

Add new signaling information received from remote peer

Parameters:

  • data Object

    The signaling information

Events

closed

()

Defined in src/peer_connection.coffee:52

The PeerConnection was closed

data_channel_ready

(
  • channel
)

Defined in src/peer_connection.coffee:40

New DataChannel to the remote peer is ready to be used

Parameters:

ice_candiate

(
  • candidate
)

Defined in src/peer_connection.coffee:28

New local ICE candidate which should be signaled to remote peer

Parameters:

  • candidate Object

    The ice candidate

signaling

(
  • obj
)

Defined in src/peer_connection.coffee:46

New offer or answer which should be signaled to the remote peer

Parameters:

  • obj Object

    The signaling message

stream_added

(
  • stream
)

Defined in src/peer_connection.coffee:34

New remote stream was added to the PeerConnection

Parameters: