me.kevingleason.pnwebrtc

Class PnRTCClient

java.lang.Object

me.kevingleason.pnwebrtc.PnRTCClient

public class PnRTCClient
extends java.lang.Object

Main WebRTC Signaling class, holds all functions to set up PeerConnection

 Author:  Kevin Gleason - Boston College '16
 File:    PnRTCClient.java
 Date:    7/20/15
 Use:     PubNub WebRTC Signaling
 © 2009 - 2015 PubNub, Inc.
 

Constructor Summary

Constructors

Constructor and Description
PnRTCClient(java.lang.String pubKey, java.lang.String subKey) Minimal constructor.
PnRTCClient(java.lang.String pubKey, java.lang.String subKey, java.lang.String UUID) Slightly more verbose constructor.

Method Summary

Modifier and Type	Method and Description
void	attachLocalMediaStream(org.webrtc.MediaStream mediaStream) Need to attach mediaStream before you can connect.
void	attachRTCListener(PnRTCListener listener) Attach custom listener for callbacks!
org.webrtc.MediaConstraints	audioConstraints() Return the PnRTCClient audio constraints.
void	closeAllConnections() Close all peer connections.
void	closeConnection(java.lang.String userId) Close a single peer connection.
void	connect(java.lang.String userId) Connect with another user by their ID.
com.pubnub.api.Pubnub	getPubNub() Return the PnRTCClient Pubnub instance.
java.lang.String	getUUID() Return the UUID (username) of the PnRTCClient.
void	listenOn(java.lang.String channel) Subscribe to a channel using PubNub to listen for calls.
void	onDestroy() Call this method in Activity.onDestroy() to clost all open connections and clean up instance for garbage collection.
org.webrtc.MediaConstraints	pcConstraints() Return the PnRTCClient peer connection constraints.
void	setMaxConnections(int max) Set the maximum simultaneous connections allowed
void	setSignalParams(PnSignalingParams signalParams) Set the signaling parameters.
void	transmit(java.lang.String userId, JSONObject message) Send a custom JSONObject user message to a single peer.
void	transmitAll(JSONObject message) Send a custom JSONObject user message to all peers.
org.webrtc.MediaConstraints	videoConstraints() Return the PnRTCClient video constraints.

Methods inherited from class java.lang.Object

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

Constructor Detail

PnRTCClient

public PnRTCClient(java.lang.String pubKey,
                   java.lang.String subKey)

Minimal constructor. Requires a valid Pub and Sub key. Get your Pub/Sub keys for free at https://admin.pubnub.com/#/register and find keys on developer portal. No UUID provided so a random phone number will be generated with this constructor (XXX-XXXX).

Parameters:

pubKey - PubNub Pub Key

subKey - PubNub Sub Key

PnRTCClient

public PnRTCClient(java.lang.String pubKey,
                   java.lang.String subKey,
                   java.lang.String UUID)

Slightly more verbose constructor. Requires a valid Pub and Sub key. Get your Pub/Sub keys for free at https://admin.pubnub.com/#/register and find keys on developer portal.

Parameters:

pubKey - PubNub Pub Key

subKey - PubNub Sub Key

UUID - Any UUID to be used as a username

Method Detail

pcConstraints

public org.webrtc.MediaConstraints pcConstraints()

Return the PnRTCClient peer connection constraints.

Returns:

Peer Connection Constrains

videoConstraints

public org.webrtc.MediaConstraints videoConstraints()

Return the PnRTCClient video constraints.

Returns:

Video Constrains

audioConstraints

public org.webrtc.MediaConstraints audioConstraints()

Return the PnRTCClient audio constraints.

Returns:

Audio Constrains

getPubNub

public com.pubnub.api.Pubnub getPubNub()

Return the PnRTCClient Pubnub instance.

Returns:

The PnRTCClient's Pubnub instance

getUUID

public java.lang.String getUUID()

Return the UUID (username) of the PnRTCClient. If not provided by the constructor, a random phone number is generated and can be retrieived with this method

Returns:

The UUID username of the client

setSignalParams

public void setSignalParams(PnSignalingParams signalParams)

Set the signaling parameters. This includes MediaConstraints for PeerConnection, Video, and Audio, as well as a list of possible PeerConnection.IceServer candidates.

Parameters:

signalParams - Parameters for WebRTC Signaling

attachLocalMediaStream

public void attachLocalMediaStream(org.webrtc.MediaStream mediaStream)

Need to attach mediaStream before you can connect.

Parameters:

mediaStream - Not null local media stream

attachRTCListener

public void attachRTCListener(PnRTCListener listener)

Attach custom listener for callbacks!

Parameters:

listener - The listener which extends PnRTCListener to implement callbacks

setMaxConnections

public void setMaxConnections(int max)

Set the maximum simultaneous connections allowed

Parameters:

max - Max simultaneous connections

listenOn

public void listenOn(java.lang.String channel)

Subscribe to a channel using PubNub to listen for calls.

Parameters:

channel - The channel to listen on, your "phone number"

connect

public void connect(java.lang.String userId)

Connect with another user by their ID.

Parameters:

userId - The user to establish a WebRTC connection with

closeConnection

public void closeConnection(java.lang.String userId)

Close a single peer connection. Send a PubNub hangup signal as well

Parameters:

userId - User to close a connection with

closeAllConnections

public void closeAllConnections()

Close all peer connections. Send a PubNub hangup signal as well.

transmit

public void transmit(java.lang.String userId,
                     JSONObject message)

Send a custom JSONObject user message to a single peer.

Parameters:

userId - user to send a message to

message - the JSON message to pass to a peer.

transmitAll

public void transmitAll(JSONObject message)

Send a custom JSONObject user message to all peers.

Parameters:

message - the JSON message to pass to all peers.

onDestroy

public void onDestroy()

Call this method in Activity.onDestroy() to clost all open connections and clean up instance for garbage collection.