Class Index | File Index

Classes


Class Participant

Participant class
Defined in: Participant.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
createMyself(identity, rtcEvtHandler, msgHandler, pcConfig, pcConstraints)
createMySelf
 
createRemotePeer(identity, myParticipant, contextId, rtcEvtHandler, msgHandler, pcConfig, pcConstraints)
createRemotePeer
 
getConnection
 
getStatus
 
leave(message)
leave The Participant leaves the Conversation removing all resources shared in the conversation.
 
sendMessage(message, type)
sendMessage
Class Detail
Participant()
Method Detail
createMyself(identity, rtcEvtHandler, msgHandler, pcConfig, pcConstraints)
createMySelf
Parameters:
{Identity} identity
: my own Identity
rtcEvtHandler
msgHandler
pcConfig
pcConstraints

createRemotePeer(identity, myParticipant, contextId, rtcEvtHandler, msgHandler, pcConfig, pcConstraints)
createRemotePeer
Parameters:
{Identity} identity
: Identity of the new remote peer
myParticipant
contextId
rtcEvtHandler
msgHandler
pcConfig
pcConstraints

getRTCPeerConnection()
getConnection
Returns:
PeerConnection ... gets the connection attribute for a participant

getStatus()
getStatus
Returns:
ParticipantStatus ... gets the status attribute for a participant

leave(message)
leave The Participant leaves the Conversation removing all resources shared in the conversation. Participant status is changed accordingly. This operation is only valid for local participants.
Parameters:
{Message} message Optional
: the Message to be sent when Participant leaves the conversation

sendMessage(message, type)
sendMessage
Parameters:
{Message} message
: the Message we want to send
type

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Dec 10 2013 17:00:57 GMT-0000 (GMT)