-
Notifications
You must be signed in to change notification settings - Fork 2
/
Conference.js
145 lines (110 loc) · 3.89 KB
/
Conference.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/**
* Creates a Conference object with the given name and properties.
* @param name name of the conference.
* @param options Object with properties / settings related to the conference that will be created.
* @constructor
*/
function Conference(name, options) {
}
/**
* Joins the conference.
*/
Conference.prototype.join = function () {
}
/**
* Leaves the conference.
*/
Conference.prototype.leave = function () {
}
/**
* Creates the media streams and returns them via the callback.
* @param options Object with properties / settings defining which streams(Stream.AUDIO, Stream.VIDEO, Stream.DESKTOP)
* should be created or some additional configurations about resolution for example.
* @param successCallback callback that will receive the streams.
* @param errorCallback callback that will be called if accessing the media streams fail.
*/
Conference.prototype.createMediaStreams = function (options, successCallback, errorCallback) {
}
/**
* Attaches a handler for events(For example - "participant joined".) in the conference. All possible event are defined
* in ConferenceEvents.
* @param eventId the event ID.
* @param handler handler for the event.
*/
Conference.prototype.addEventListener = function (eventId, handler) {
}
/**
* Removes event listener
* @param eventId the event ID.
*/
Conference.prototype.removeEventListener = function (eventId) {
}
/**
* Receives notifications from another participants for commands / custom events(send by sendPresenceCommand method).
* @param command {String} the name of the command
* @param handler {Function} handler for the command
*/
Conference.prototype.addPresenceCommandListener = function (command, handler) {
}
/**
* Removes command listener
* @param command {String} the name of the command
*/
Conference.prototype.removePresenceCommandListener = function (command) {
}
/**
* Sends local streams to the server side.
* @param stream the stream object.
* @param successCallback callback that will be called when the stream is sending is successfull.
* @param errorCallback callback that will be called if something go wrong.
*/
Conference.prototype.sendStream = function (stream, successCallback, errorCallback) {
}
/**
* Sends text message to the other participants in the conference
* @param message the text message.
*/
Conference.prototype.sendTextMessage = function (message) {
}
/**
* Send presence command.
* @param name the name of the command.
* @param values Object with keys and values that will be send.
* @param persistent if false the command will be sent only one time
* otherwise it will be sent with every system message sent to the other participants.
* @param successCallback will be called when the command is successfully send.
* @param errorCallback will be called when the command is not sent successfully.
*/
Conference.prototype.sendPresenceCommand = function (name, values, persistent, successCallback, errorCallback) {
}
/**
* Sets the display name for this conference.
* @param name the display name to set
*/
Conference.prototype.setDisplayName = function(name) {
}
/**
* Start desktop sharing. This will replace the video stream with the desktop sharing stream.
* @return Stream stream of type DESKTOP
*/
Conference.prototype.startDesktopSharing = function() {
}
/**
* Stop desktop sharing. This will replace the desktop stream with the video stream.
* @return Stream stream of type VIDEO
*/
Conference.prototype.endDesktopSharing = function() {
}
/**
* Elects the participant with the given id to be the selected participant or the speaker.
* @param id the identifier of the participant
*/
Conference.prototype.selectParticipant = function(participantId) {
}
/**
* Returns the list of participants for this conference.
* @return Object a list of participant identifiers containing all conference participants.
*/
Conference.prototype.getParticipants = function() {
}
module.exports = Conference;