Skip to content
This repository was archived by the owner on Oct 25, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/sdk/base/codec.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

'use strict';

/**
* @class AudioCodec
* @memberOf Owt.Base
* @classDesc Audio codec enumeration.
* @hideconstructor
*/
export const AudioCodec = {
PCMU: 'pcmu',
PCMA: 'pcma',
Expand All @@ -28,7 +34,7 @@ export class AudioCodecParameters {
* @member {string} name
* @memberof Owt.Base.AudioCodecParameters
* @instance
* @desc Name of a codec. Please a value in Owt.Base.AudioCodec. However, some functions do not support all the values in Owt.Base.AudioCodec.
* @desc Name of a codec. Please use a value in Owt.Base.AudioCodec. However, some functions do not support all the values in Owt.Base.AudioCodec.
*/
this.name = name;
/**
Expand Down Expand Up @@ -93,7 +99,7 @@ export class VideoCodecParameters {
* @member {string} name
* @memberof Owt.Base.VideoCodecParameters
* @instance
* @desc Name of a codec. Please a value in Owt.Base.AudioCodec. However, some functions do not support all the values in Owt.Base.AudioCodec.
* @desc Name of a codec. Please use a value in Owt.Base.VideoCodec. However, some functions do not support all the values in Owt.Base.AudioCodec.
*/
this.name = name;
/**
Expand Down
9 changes: 6 additions & 3 deletions src/sdk/base/mediaformat.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

'use strict';
/**
* Source info about an audio track. Values: 'mic', 'screen-cast', 'file', 'mixed'.
* @class AudioSourceInfo
* @classDesc Source info about an audio track. Values: 'mic', 'screen-cast', 'file', 'mixed'.
* @memberOf Owt.Base
* @readonly
* @enum {string}
Expand All @@ -17,7 +18,8 @@ export const AudioSourceInfo = {
};

/**
* Source info about a video track. Values: 'camera', 'screen-cast', 'file', 'mixed'.
* @class VideoSourceInfo
* @classDesc Source info about a video track. Values: 'camera', 'screen-cast', 'file', 'mixed'.
* @memberOf Owt.Base
* @readonly
* @enum {string}
Expand All @@ -30,7 +32,8 @@ export const VideoSourceInfo = {
};

/**
* Kind of a track. Values: 'audio' for audio track, 'video' for video track, 'av' for both audio and video tracks.
* @class TrackKind
* @classDesc Kind of a track. Values: 'audio' for audio track, 'video' for video track, 'av' for both audio and video tracks.
* @memberOf Owt.Base
* @readonly
* @enum {string}
Expand Down
3 changes: 3 additions & 0 deletions src/sdk/base/publication.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ export class VideoPublicationSettings {
/**
* @member {?number} frameRates
* @instance
* @classDesc Frames per second.
* @memberof Owt.Base.VideoPublicationSettings
*/
this.frameRate=frameRate;
Expand All @@ -62,6 +63,7 @@ export class VideoPublicationSettings {
/**
* @member {?number} keyFrameIntervals
* @instance
* @classDesc The time interval between key frames. Unit: second.
* @memberof Owt.Base.VideoPublicationSettings
*/
this.keyFrameInterval=keyFrameInterval;
Expand Down Expand Up @@ -94,6 +96,7 @@ export class PublicationSettings {

/**
* @class Publication
* @extends Owt.Base.EventDispatcher
* @memberOf Owt.Base
* @classDesc Publication represents a sender for publishing a stream. It
* handles the actions on a LocalStream published to a conference.
Expand Down
4 changes: 2 additions & 2 deletions src/sdk/conference/mixedstream.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {OwtEvent} from '../base/event.js';
*
* | Event Name | Argument Type | Fired when |
* | -----------------------| ---------------- | ---------------- |
* | activeaudioinputchange | Event | Audio activeness of input stream(of the mixed stream) is changed. |
* | activeaudioinputchange | Event | Audio activeness of input stream (of the mixed stream) is changed. |
* | layoutchange | Event | Video's layout has been changed. It usually happens when a new video is mixed into the target mixed stream or an existing video has been removed from mixed stream. |
*
* @memberOf Owt.Conference
Expand All @@ -40,7 +40,7 @@ export class RemoteMixedStream extends StreamModule.RemoteStream {

/**
* @class ActiveAudioInputChangeEvent
* @classDesc Class ActiveInputChangeEvent represents an active audio input change event.
* @classDesc Class ActiveAudioInputChangeEvent represents an active audio input change event.
* @memberof Owt.Conference
* @hideconstructor
*/
Expand Down
14 changes: 7 additions & 7 deletions src/sdk/conference/subscription.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export class VideoSubscriptionCapabilities {
*/
this.codecs = codecs;
/**
* @member {Array.<Owt.Base.Resolution>} resolution
* @member {Array.<Owt.Base.Resolution>} resolutions
* @instance
* @memberof Owt.Conference.VideoSubscriptionCapabilities
*/
Expand Down Expand Up @@ -79,13 +79,13 @@ export class SubscriptionCapabilities {
// eslint-disable-next-line require-jsdoc
constructor(audio, video) {
/**
* @member {?AudioSubscriptionCapabilities} audio
* @member {?Owt.Conference.AudioSubscriptionCapabilities} audio
* @instance
* @memberof Owt.Conference.SubscriptionCapabilities
*/
this.audio = audio;
/**
* @member {?VideoSubscriptionCapabilities} video
* @member {?Owt.Conference.VideoSubscriptionCapabilities} video
* @instance
* @memberof Owt.Conference.SubscriptionCapabilities
*/
Expand Down Expand Up @@ -133,28 +133,28 @@ export class VideoSubscriptionConstraints {
* @member {?Owt.Base.Resolution} resolution
* @instance
* @memberof Owt.Conference.VideoSubscriptionConstraints
* @desc Only resolutions listed in VideoSubscriptionCapabilities are allowed.
* @desc Only resolutions listed in Owt.Conference.VideoSubscriptionCapabilities are allowed.
*/
this.resolution = resolution;
/**
* @member {?number} frameRate
* @instance
* @memberof Owt.Conference.VideoSubscriptionConstraints
* @desc Only frameRates listed in VideoSubscriptionCapabilities are allowed.
* @desc Only frameRates listed in Owt.Conference.VideoSubscriptionCapabilities are allowed.
*/
this.frameRate = frameRate;
/**
* @member {?number} bitrateMultiplier
* @instance
* @memberof Owt.Conference.VideoSubscriptionConstraints
* @desc Only bitrateMultipliers listed in VideoSubscriptionCapabilities are allowed.
* @desc Only bitrateMultipliers listed in Owt.Conference.VideoSubscriptionCapabilities are allowed.
*/
this.bitrateMultiplier = bitrateMultiplier;
/**
* @member {?number} keyFrameInterval
* @instance
* @memberof Owt.Conference.VideoSubscriptionConstraints
* @desc Only keyFrameIntervals listed in VideoSubscriptionCapabilities are allowed.
* @desc Only keyFrameIntervals listed in Owt.Conference.VideoSubscriptionCapabilities are allowed.
*/
this.keyFrameInterval = keyFrameInterval;
}
Expand Down
4 changes: 2 additions & 2 deletions src/sdk/p2p/p2pclient.js
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@ const P2PClient = function(configuration, signalingChannel) {
* @desc Publish a stream to a remote endpoint.
* @memberof Owt.P2P.P2PClient
* @param {string} remoteId Remote endpoint's ID.
* @param {LocalStream} stream A LocalStream to be published.
* @return {Promise<Publication, Error>} A promised resolved when remote side received the certain stream. However, remote endpoint may not display this stream, or ignore it.
* @param {Owt.Base.LocalStream} stream An Owt.Base.LocalStream to be published.
* @return {Promise<Owt.Base.Publication, Error>} A promised that resolves when remote side received the certain stream. However, remote endpoint may not display this stream, or ignore it.
*/
this.publish = function(remoteId, stream) {
if (state !== ConnectionState.CONNECTED) {
Expand Down