Skip to content

Commit

Permalink
Remove deprecated options from the docs (#303)
Browse files Browse the repository at this point in the history
  • Loading branch information
Santiago Souto authored Jan 15, 2024
1 parent d1f3b50 commit b39fc9a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 24 deletions.
8 changes: 2 additions & 6 deletions packages/millicast-sdk/src/Director.js
Original file line number Diff line number Diff line change
Expand Up @@ -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<MillicastDirectorResponse>} Promise object which represents the result of getting the publishing connection path.
* @example const response = await Director.getPublisher(options)
* @example
Expand Down Expand Up @@ -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<MillicastDirectorResponse>} Promise object which represents the result of getting the subscribe connection data.
* @example const response = await Director.getSubscriber(options)
* @example
Expand Down
8 changes: 2 additions & 6 deletions packages/millicast-sdk/src/Signaling.js
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>} 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<String>} Promise object which represents the SDP command response.
*/
Expand Down Expand Up @@ -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<String>} Promise object which represents the SDP command response.
*/
Expand Down
16 changes: 4 additions & 12 deletions packages/millicast-sdk/src/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -436,19 +436,15 @@ 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<String>} 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<String>} Promise object which represents the SDP command response.
*/
subscribe(sdp: string, options: SignalingSubscribeOptions | boolean, pinnedSourceId?: string, excludedSourceIds?: Array<string>): Promise<string>;
/**
* 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<String>} Promise object which represents the SDP command response.
*/
Expand Down Expand Up @@ -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<MillicastDirectorResponse>} Promise object which represents the result of getting the publishing connection path.
* @example const response = await Director.getPublisher(options)
* @example
Expand Down Expand Up @@ -795,9 +789,7 @@ declare module '@millicast/sdk' {
static getPublisher(options: DirectorPublisherOptions | string, streamName?: string, streamType?: ("WebRtc" | "Rtmp")): Promise<MillicastDirectorResponse>;
/**
* 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<MillicastDirectorResponse>} Promise object which represents the result of getting the subscribe connection data.
* @example const response = await Director.getSubscriber(options)
* @example
Expand Down

0 comments on commit b39fc9a

Please sign in to comment.