Skip to content

Commit 623d39f

Browse files
committed
Update docs to warn devs Chrome only features
1 parent cf32916 commit 623d39f

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

packages/millicast-sdk-js/src/MillicastPublish.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ export default class MillicastPublish extends EventEmitter {
4545
* @param {Boolean} [options.disableVideo = false] - Disable the opportunity to send video stream.
4646
* @param {Boolean} [options.disableAudio = false] - Disable the opportunity to send audio stream.
4747
* @param {MillicastVideoCodec} options.codec - Codec for publish stream.
48-
* @param {Boolean} options.simulcast - Enable simulcast.
48+
* @param {Boolean} options.simulcast - Enable simulcast. **Only available in Google Chrome and with H.264 or VP8 video codecs.**
4949
* @param {String} options.scalabilityMode - Selected scalability mode. You can get the available capabilities using <a href="MillicastWebRTC#.getCapabilities">MillicastWebRTC.getCapabilities</a> method.
50+
* **Only available in Google Chrome.**
5051
* @returns {Promise<void>} Promise object which resolves when the broadcast started successfully.
5152
* @fires MillicastWebRTC#connectionStateChange
5253
* @example await millicastPublish.broadcast(options)

packages/millicast-sdk-js/src/MillicastWebRTC.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,10 @@ export default class MillicastWebRTC extends EventEmitter {
134134
* @param {Boolean} options.stereo - True to modify SDP for support stereo. Otherwise False.
135135
* @param {MediaStream|Array<MediaStreamTrack>} options.mediaStream - MediaStream to offer in a stream. This object must have
136136
* 1 audio track and 1 video track, or at least one of them. Alternative you can provide both tracks in an array.
137-
* @param {'h264'|'vp8'|'vp9'|'av1'} options.codec - Selected codec for support simulcast.
138-
* @param {Boolean} options.simulcast - True to modify SDP for support simulcast.
137+
* @param {MillicastVideoCodec} options.codec - Selected codec for support simulcast.
138+
* @param {Boolean} options.simulcast - True to modify SDP for support simulcast. **Only available in Google Chrome and with H.264 or VP8 video codecs.**
139139
* @param {String} options.scalabilityMode - Selected scalability mode. You can get the available capabilities using <a href="MillicastWebRTC#.getCapabilities">MillicastWebRTC.getCapabilities</a> method.
140+
* **Only available in Google Chrome.**
140141
* @returns {Promise<String>} Promise object which represents the SDP information of the created offer.
141142
*/
142143
async getRTCLocalSDP (options = {

packages/millicast-sdk-js/src/utils/SdpParser.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const logger = MillicastLogger.get('SdpParser')
1212
export default class SdpParser {
1313
/**
1414
* Parse SDP for support simulcast.
15+
*
16+
* **Only available in Google Chrome.**
1517
* @param {String} sdp - Current SDP.
1618
* @param {String} codec - Codec.
1719
* @returns {String} SDP parsed with simulcast support.
@@ -158,6 +160,8 @@ export default class SdpParser {
158160

159161
/**
160162
* Parse SDP for support multiopus.
163+
*
164+
* **Only available in Google Chrome.**
161165
* @param {String} sdp - Current SDP.
162166
* @returns {String} SDP parsed with multiopus support.
163167
* @example SdpParser.setMultiopus(sdp)

0 commit comments

Comments
 (0)