From b39fc9a80d106b1978c4f5d812858fac4ed012c7 Mon Sep 17 00:00:00 2001 From: Santiago Souto Date: Mon, 15 Jan 2024 19:34:34 +0100 Subject: [PATCH] Remove deprecated options from the docs (#303) --- packages/millicast-sdk/src/Director.js | 8 ++------ packages/millicast-sdk/src/Signaling.js | 8 ++------ packages/millicast-sdk/src/types/index.d.ts | 16 ++++------------ 3 files changed, 8 insertions(+), 24 deletions(-) diff --git a/packages/millicast-sdk/src/Director.js b/packages/millicast-sdk/src/Director.js index ecf93af9..1c4ed4cd 100644 --- a/packages/millicast-sdk/src/Director.js +++ b/packages/millicast-sdk/src/Director.js @@ -84,9 +84,7 @@ export default class Director { /** * Get publisher connection data. - * @param {DirectorPublisherOptions | String} options - Millicast options or *Deprecated Millicast Publishing Token.* - * @param {String} [streamName] - *Deprecated, use options parameter instead* Millicast Stream Name. - * @param {("WebRtc" | "Rtmp")} [streamType] - *Deprecated, use options parameter instead* Millicast Stream Type. + * @param {DirectorPublisherOptions} options - Millicast options. * @returns {Promise} Promise object which represents the result of getting the publishing connection path. * @example const response = await Director.getPublisher(options) * @example @@ -136,9 +134,7 @@ export default class Director { /** * Get subscriber connection data. - * @param {DirectorSubscriberOptions | String} options - Millicast options or *Deprecated Millicast publisher Stream Name.* - * @param {String} [streamAccountId] - *Deprecated, use options parameter instead* Millicast Account ID. - * @param {String} [subscriberToken] - *Deprecated, use options parameter instead* Token to subscribe to secure streams. If you are subscribing to an unsecure stream, you can omit this param. + * @param {DirectorSubscriberOptions} options - Millicast options. * @returns {Promise} Promise object which represents the result of getting the subscribe connection data. * @example const response = await Director.getSubscriber(options) * @example diff --git a/packages/millicast-sdk/src/Signaling.js b/packages/millicast-sdk/src/Signaling.js index e380f554..fbae6dae 100644 --- a/packages/millicast-sdk/src/Signaling.js +++ b/packages/millicast-sdk/src/Signaling.js @@ -180,9 +180,7 @@ export default class Signaling extends EventEmitter { /** * Establish WebRTC connection with Millicast Server as Subscriber role. * @param {String} sdp - The SDP information created by your offer. - * @param {SignalingSubscribeOptions | Boolean} options - Signaling Subscribe Options or *Deprecated Enable VAD multiplexing for secondary sources.* - * @param {String} pinnedSourceId - *Deprecated, use options parameter instead* Id of the main source that will be received by the default MediaStream. - * @param {Array} excludedSourceIds - *Deprecated, use options parameter instead* Do not receive media from the these source ids. + * @param {SignalingSubscribeOptions} options - Signaling Subscribe Options. * @example const response = await millicastSignaling.subscribe(sdp) * @return {Promise} Promise object which represents the SDP command response. */ @@ -224,9 +222,7 @@ export default class Signaling extends EventEmitter { /** * Establish WebRTC connection with Millicast Server as Publisher role. * @param {String} sdp - The SDP information created by your offer. - * @param {SignalingPublishOptions | VideoCodec} options - Signaling Publish Options or *Deprecated Codec for publish stream (h264 default).* - * @param {Boolean} [record] - *Deprecated, use options parameter instead* Enable stream recording. If record is not provided, use default Token configuration. **Only available in Tokens with recording enabled.** - * @param {String} [sourceId] - *Deprecated, use options parameter instead* Source unique id. **Only available in Tokens with multisource enabled.*** + * @param {SignalingPublishOptions} options - Signaling Publish Options. * @example const response = await millicastSignaling.publish(sdp, {codec: 'h264'}) * @return {Promise} Promise object which represents the SDP command response. */ diff --git a/packages/millicast-sdk/src/types/index.d.ts b/packages/millicast-sdk/src/types/index.d.ts index 3c72fa89..a98e4e9d 100644 --- a/packages/millicast-sdk/src/types/index.d.ts +++ b/packages/millicast-sdk/src/types/index.d.ts @@ -436,9 +436,7 @@ declare module '@millicast/sdk' { /** * Establish WebRTC connection with Millicast Server as Subscriber role. * @param {String} sdp - The SDP information created by your offer. - * @param {SignalingSubscribeOptions | Boolean} options - Signaling Subscribe Options or *Deprecated Enable VAD multiplexing for secondary sources.* - * @param {String} pinnedSourceId - *Deprecated, use options parameter instead* Id of the main source that will be received by the default MediaStream. - * @param {Array} excludedSourceIds - *Deprecated, use options parameter instead* Do not receive media from the these source ids. + * @param {SignalingSubscribeOptions} options - Signaling Subscribe Options. * @example const response = await millicastSignaling.subscribe(sdp) * @return {Promise} Promise object which represents the SDP command response. */ @@ -446,9 +444,7 @@ declare module '@millicast/sdk' { /** * Establish WebRTC connection with Millicast Server as Publisher role. * @param {String} sdp - The SDP information created by your offer. - * @param {SignalingPublishOptions | VideoCodec} options - Signaling Publish Options or *Deprecated Codec for publish stream (h264 default).* - * @param {Boolean} [record] - *Deprecated, use options parameter instead* Enable stream recording. If record is not provided, use default Token configuration. **Only available in Tokens with recording enabled.** - * @param {String} [sourceId] - *Deprecated, use options parameter instead* Source unique id. **Only available in Tokens with multisource enabled.*** + * @param {SignalingPublishOptions} options - Signaling Publish Options. * @example const response = await millicastSignaling.publish(sdp, {codec: 'h264'}) * @return {Promise} Promise object which represents the SDP command response. */ @@ -765,9 +761,7 @@ declare module '@millicast/sdk' { static getLiveDomain(): string; /** * Get publisher connection data. - * @param {DirectorPublisherOptions | String} options - Millicast options or *Deprecated Millicast Publishing Token.* - * @param {String} [streamName] - *Deprecated, use options parameter instead* Millicast Stream Name. - * @param {("WebRtc" | "Rtmp")} [streamType] - *Deprecated, use options parameter instead* Millicast Stream Type. + * @param {DirectorPublisherOptions} options - Millicast options. * @returns {Promise} Promise object which represents the result of getting the publishing connection path. * @example const response = await Director.getPublisher(options) * @example @@ -795,9 +789,7 @@ declare module '@millicast/sdk' { static getPublisher(options: DirectorPublisherOptions | string, streamName?: string, streamType?: ("WebRtc" | "Rtmp")): Promise; /** * Get subscriber connection data. - * @param {DirectorSubscriberOptions | String} options - Millicast options or *Deprecated Millicast publisher Stream Name.* - * @param {String} [streamAccountId] - *Deprecated, use options parameter instead* Millicast Account ID. - * @param {String} [subscriberToken] - *Deprecated, use options parameter instead* Token to subscribe to secure streams. If you are subscribing to an unsecure stream, you can omit this param. + * @param {DirectorSubscriberOptions | String} options - Millicast options. * @returns {Promise} Promise object which represents the result of getting the subscribe connection data. * @example const response = await Director.getSubscriber(options) * @example