diff --git a/src/sdk/conference/channel.js b/src/sdk/conference/channel.js index 0d8cc3e2..03a417d1 100644 --- a/src/sdk/conference/channel.js +++ b/src/sdk/conference/channel.js @@ -54,6 +54,7 @@ export class ConferencePeerConnectionChannel extends EventDispatcher { * @desc Received a message from conference portal. Defined in client-server protocol. * @param {string} notification Notification type. * @param {object} message Message received. + * @private */ onMessage(notification, message) { switch (notification) { diff --git a/src/sdk/conference/client.js b/src/sdk/conference/client.js index dbde7d8b..6237482a 100644 --- a/src/sdk/conference/client.js +++ b/src/sdk/conference/client.js @@ -121,6 +121,7 @@ export const ConferenceClient = function(config, signalingImpl) { * @desc Received a message from conference portal. Defined in client-server protocol. * @param {string} notification Notification type. * @param {object} data Data received. + * @private */ function onSignalingMessage(notification, data) { if (notification === 'soac' || notification === 'progress') { diff --git a/src/sdk/conference/error.js b/src/sdk/conference/error.js index 8da11fd7..e21a45f5 100644 --- a/src/sdk/conference/error.js +++ b/src/sdk/conference/error.js @@ -7,7 +7,7 @@ /** * @class ConferenceError * @classDesc The ConferenceError object represents an error in conference mode. - * @memberOf Oms.Conference + * @memberOf Owt.Conference * @hideconstructor */ export class ConferenceError extends Error { diff --git a/src/sdk/conference/streamutils.js b/src/sdk/conference/streamutils.js index 5843e967..40207cd0 100644 --- a/src/sdk/conference/streamutils.js +++ b/src/sdk/conference/streamutils.js @@ -17,7 +17,7 @@ import * as SubscriptionModule from './subscription.js'; * @function extractBitrateMultiplier * @desc Extract bitrate multiplier from a string like "x0.2". * @return {Promise} The float number after "x". - * @private. + * @private */ function extractBitrateMultiplier(input) { if (typeof input !== 'string' || !input.startsWith('x')) { @@ -44,7 +44,7 @@ function sortResolutions(x, y) { /** * @function convertToPublicationSettings * @desc Convert mediaInfo received from server to PublicationSettings. - * @private. + * @private */ export function convertToPublicationSettings(mediaInfo) { let audio; @@ -89,7 +89,7 @@ export function convertToPublicationSettings(mediaInfo) { /** * @function convertToSubscriptionCapabilities * @desc Convert mediaInfo received from server to SubscriptionCapabilities. - * @private. + * @private */ export function convertToSubscriptionCapabilities(mediaInfo) { let audio; let video; diff --git a/src/sdk/p2p/error.js b/src/sdk/p2p/error.js index 0db88fac..91357b8b 100644 --- a/src/sdk/p2p/error.js +++ b/src/sdk/p2p/error.js @@ -88,7 +88,8 @@ export const errors = { * @function getErrorByCode * @desc Get error object by error code. * @param {string} errorCode Error code. - * @return {Oms.P2P.Error} Error object + * @return {Owt.P2P.Error} Error object + * @private */ export function getErrorByCode(errorCode) { const codeErrorMap = { @@ -115,7 +116,7 @@ export function getErrorByCode(errorCode) { /** * @class P2PError * @classDesc The P2PError object represents an error in P2P mode. - * @memberOf Oms.P2P + * @memberOf Owt.P2P * @hideconstructor */ export class P2PError extends Error { diff --git a/src/sdk/p2p/peerconnection-channel.js b/src/sdk/p2p/peerconnection-channel.js index e4fd2e87..e3a4b90a 100644 --- a/src/sdk/p2p/peerconnection-channel.js +++ b/src/sdk/p2p/peerconnection-channel.js @@ -20,8 +20,9 @@ import * as SdpUtils from '../base/sdputils.js'; /** * @class P2PPeerConnectionChannelEvent * @desc Event for Stream. - * @private. - */ + * @memberOf Owt.P2P + * @private + * */ export class P2PPeerConnectionChannelEvent extends Event { /* eslint-disable-next-line require-jsdoc */ constructor(init) { @@ -53,7 +54,8 @@ const sysInfo = Utils.sysInfo(); /** * @class P2PPeerConnectionChannel * @desc A P2PPeerConnectionChannel handles all interactions between this endpoint and a remote endpoint. - * @private. + * @memberOf Owt.P2P + * @private */ class P2PPeerConnectionChannel extends EventDispatcher { // |signaling| is an object has a method |sendSignalingMessage|. @@ -96,6 +98,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function publish * @desc Publish a stream to the remote endpoint. + * @private */ publish(stream) { if (!(stream instanceof StreamModule.LocalStream)) { @@ -136,6 +139,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function send * @desc Send a message to the remote endpoint. + * @private */ send(message) { if (!(typeof message === 'string')) { @@ -176,6 +180,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function stop * @desc Stop the connection with remote endpoint. + * @private */ stop() { this._stop(undefined, true); @@ -184,6 +189,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function getStats * @desc Get stats for a specific MediaStream. + * @private */ getStats(mediaStream) { if (this._pc) { @@ -216,6 +222,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function onMessage * @desc This method is called by P2PClient when there is new signaling message arrived. + * @private */ onMessage(message) { this._SignalingMesssageHandler(message); @@ -267,6 +274,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function _tracksAddedHandler * @desc Handle track added event from remote side. + * @private */ _tracksAddedHandler(ids) { // Currently, |ids| contains all track IDs of a MediaStream. Following algorithm also handles |ids| is a part of a MediaStream's tracks. @@ -324,6 +332,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function _tracksRemovedHandler * @desc Handle track removed event from remote side. + * @private */ _tracksRemovedHandler(ids) { // Currently, |ids| contains all track IDs of a MediaStream. Following algorithm also handles |ids| is a part of a MediaStream's tracks. @@ -342,6 +351,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function _dataReceivedHandler * @desc Handle data received event from remote side. + * @private */ _dataReceivedHandler(id) { if (!this._sendDataPromises.has(id)) { @@ -355,6 +365,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function _sdpHandler * @desc Handle SDP received event from remote side. + * @private */ _sdpHandler(sdp) { if (sdp.type === 'offer') { @@ -369,6 +380,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function _trackSourcesHandler * @desc Received track source information from remote side. + * @private */ _trackSourcesHandler(data) { for (const info of data) { @@ -379,6 +391,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function _streamInfoHandler * @desc Received stream information from remote side. + * @private */ _streamInfoHandler(data) { if (!data) { @@ -397,6 +410,7 @@ class P2PPeerConnectionChannel extends EventDispatcher { /** * @function _chatClosedHandler * @desc Received chat closed event from remote side. + * @private */ _chatClosedHandler(data) { this._disposed = true;