Merge pull request #86 from millicast/develop

Release v0.1.8

Author: R-Delfino95

README.md

@@ -40,7 +40,10 @@ You will need a Millicast account and a valid publishing token that you can find
 ```javascript
 import { Director, Publish } from '@millicast/sdk'
 //Define callback for generate new tokens
-const tokenGenerator = () => Director.getPublisher('my-publishing-token', 'my-stream-name')
+const tokenGenerator = () => Director.getPublisher({
+    token: 'my-publishing-token', 
+    streamName: 'my-stream-name'
+  })
 
 //Create a new instance
 const millicastPublish = new Publish(streamName, tokenGenerator)
@@ -85,7 +88,10 @@ import { Director, View } from '@millicast/sdk'
 const video = document.getElementById('my-video')
 
 //Define callback for generate new token
-const tokenGenerator = () => Director.getSubscriber('my-stream-name', 'my-account-id')
+const tokenGenerator = () => Director.getSubscriber({
+    streamName: 'my-stream-name', 
+    streamAccountId: 'my-account-id'
+  })
 
 //Create a new instance
 const millicastView = new View(streamName, tokenGenerator, video)

packages/millicast-sdk/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@millicast/sdk",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "SDK for building a realtime broadcaster using the Millicast platform.",
   "keywords": [
     "sdk",

packages/millicast-sdk/package.json

@@ -1,5 +1,4 @@
 import axios from 'axios'
-import jwtDecode from 'jwt-decode'
 import Logger from './Logger'
 
 const logger = Logger.get('Director')
@@ -15,7 +14,20 @@ let apiEndpoint = defaultApiEndpoint
  * @typedef {Object} MillicastDirectorResponse
  * @property {Array<String>} urls - WebSocket available URLs.
  * @property {String} jwt - Access token for signaling initialization.
- * @property {Object} jwtDecoded - Access token decoded.
+ */
+
+/**
+ * @typedef {Object} DirectorPublisherOptions
+ * @property {String} token - Millicast Publishing Token.
+ * @property {String} streamName - Millicast Stream Name.
+ * @property {("WebRtc" | "Rtmp")} [streamType] - Millicast Stream Type.
+ */
+
+/**
+ * @typedef {Object} DirectorSubscriberOptions
+ * @property {String} streamName - Millicast publisher Stream Name.
+ * @property {String} streamAccountId - Millicast Account ID.
+ * @property {String} [subscriberToken] - Token to subscribe to secure streams. If you are subscribing to an unsecure stream, you can omit this param.
  */
 
 /**
@@ -49,18 +61,18 @@ export default class Director {
 
   /**
    * Get publisher connection data.
-   * @param {String} token - Millicast Publishing Token.
-   * @param {String} streamName - Millicast Stream Name.
-   * @param {("WebRtc" | "Rtmp")} [streamType] - Millicast Stream Type.
+   * @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.
    * @returns {Promise<MillicastDirectorResponse>} Promise object which represents the result of getting the publishing connection path.
-   * @example const response = await Director.getPublisher(token, streamName)
+   * @example const response = await Director.getPublisher(options)
    * @example
    * import { Publish, Director } from '@millicast/sdk'
    *
    * //Define getPublisher as callback for Publish
    * const streamName = "My Millicast Stream Name"
    * const token = "My Millicast publishing token"
-   * const tokenGenerator = () => Director.getPublisher(token, streamName)
+   * const tokenGenerator = () => Director.getPublisher({token, streamName})
    *
    * //Create a new instance
    * const millicastPublish = new Publish(streamName, tokenGenerator)
@@ -77,15 +89,16 @@ export default class Director {
    * await millicastPublish.connect(broadcastOptions)
    */
 
-  static async getPublisher (token, streamName, streamType = streamTypes.WEBRTC) {
-    logger.info('Getting publisher connection path for stream name: ', streamName)
-    const payload = { streamName, streamType }
-    const headers = { Authorization: `Bearer ${token}` }
+  static async getPublisher (options, streamName = null, streamType = streamTypes.WEBRTC) {
+    const optionsParsed = getPublisherOptions(options, streamName, streamType)
+    logger.info('Getting publisher connection path for stream name: ', optionsParsed.streamName)
+    const payload = { streamName: optionsParsed.streamName, streamType: optionsParsed.streamType }
+    const headers = { Authorization: `Bearer ${optionsParsed.token}` }
     const url = `${this.getEndpoint()}/api/director/publish`
     try {
       const { data } = await axios.post(url, payload, { headers })
       logger.debug('Getting publisher response: ', data)
-      return { ...data.data, jwtDecoded: jwtDecode(data.data.jwt).millicast }
+      return data.data
     } catch (e) {
       logger.error('Error while getting publisher connection path: ', e.response?.data)
       throw e
@@ -94,20 +107,20 @@ export default class Director {
 
   /**
    * Get subscriber connection data.
-   * @param {String} streamName - Millicast publisher Stream Name.
-   * @param {String} streamAccountId - Millicast Account ID.
-   * @param {String} [subscriberToken] - 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 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.
    * @returns {Promise<MillicastDirectorResponse>} Promise object which represents the result of getting the subscribe connection data.
-   * @example const response = await Director.getSubscriber(streamName, streamAccountId)
+   * @example const response = await Director.getSubscriber(options)
    * @example
    * import { View, Director } from '@millicast/sdk'
    *
    * //Define getSubscriber as callback for Subscribe
    * const streamName = "My Millicast Stream Name"
    * const accountId = "Millicast Publisher account Id"
-   * const tokenGenerator = () => Director.getSubscriber(streamName, accountId)
+   * const tokenGenerator = () => Director.getSubscriber({streamName, accountId})
    * //... or for an secure stream
-   * const tokenGenerator = () => Director.getSubscriber(streamName, accountId, '176949b9e57de248d37edcff1689a84a047370ddc3f0dd960939ad1021e0b744')
+   * const tokenGenerator = () => Director.getSubscriber({streamName, accountId, subscriberToken: '176949b9e57de248d37edcff1689a84a047370ddc3f0dd960939ad1021e0b744'})
    *
    * //Create a new instance
    * const millicastView = new View(streamName, tokenGenerator)
@@ -125,21 +138,47 @@ export default class Director {
    * await millicastView.connect(options)
    */
 
-  static async getSubscriber (streamName, streamAccountId, subscriberToken = null) {
-    logger.info(`Getting subscriber connection data for stream name: ${streamName} and account id: ${streamAccountId}`)
-    const payload = { streamAccountId, streamName }
+  static async getSubscriber (options, streamAccountId = null, subscriberToken = null) {
+    const optionsParsed = getSubscriberOptions(options, streamAccountId, subscriberToken)
+    logger.info(`Getting subscriber connection data for stream name: ${optionsParsed.streamName} and account id: ${optionsParsed.streamAccountId}`)
+
+    const payload = { streamAccountId: optionsParsed.streamAccountId, streamName: optionsParsed.streamName }
     let headers = {}
-    if (subscriberToken) {
-      headers = { Authorization: `Bearer ${subscriberToken}` }
+    if (optionsParsed.subscriberToken) {
+      headers = { Authorization: `Bearer ${optionsParsed.subscriberToken}` }
     }
     const url = `${this.getEndpoint()}/api/director/subscribe`
     try {
       const { data } = await axios.post(url, payload, { headers })
       logger.debug('Getting subscriber response: ', data)
-      return { ...data.data, jwtDecoded: jwtDecode(data.data.jwt).millicast }
+      return data.data
     } catch (e) {
       logger.error('Error while getting subscriber connection path: ', e.response?.data)
       throw e
     }
   }
 }
+
+const getPublisherOptions = (options, legacyStreamName, legacyStreamType) => {
+  let parsedOptions = (typeof options === 'object') ? options : {}
+  if (Object.keys(parsedOptions).length === 0) {
+    parsedOptions = {
+      token: options,
+      streamName: legacyStreamName,
+      streamType: legacyStreamType
+    }
+  }
+  return parsedOptions
+}
+
+const getSubscriberOptions = (options, legacyStreamAccountId, legacySubscriberToken) => {
+  let parsedOptions = (typeof options === 'object') ? options : {}
+  if (Object.keys(parsedOptions).length === 0) {
+    parsedOptions = {
+      streamName: options,
+      streamAccountId: legacyStreamAccountId,
+      subscriberToken: legacySubscriberToken
+    }
+  }
+  return parsedOptions
+}

packages/millicast-sdk/src/Director.js

@@ -212,7 +212,7 @@ export default class PeerConnection extends EventEmitter {
     }
 
     logger.info('Updating bitrate to value: ', bitrate)
-    this.peer = await this.getRTCPeer()
+    this.sessionDescription = await this.peer.createOffer()
     await this.peer.setLocalDescription(this.sessionDescription)
     const sdp = this.updateBandwidthRestriction(this.peer.remoteDescription.sdp, bitrate)
     await this.setRTCRemoteSDP(sdp)

packages/millicast-sdk/src/PeerConnection.js

@@ -1,3 +1,4 @@
+import jwtDecode from 'jwt-decode'
 import reemit from 're-emitter'
 import Logger from './Logger'
 import BaseWebRTC from './utils/BaseWebRTC'
@@ -103,6 +104,11 @@ export default class Publish extends BaseWebRTC {
       logger.error('Error while broadcasting. Publisher data required')
       throw new Error('Publisher data required')
     }
+    const recordingAvailable = jwtDecode(publisherData.jwt).millicast.record
+    if (this.options.record && !recordingAvailable) {
+      logger.error('Error while broadcasting. Record option detected but recording is not available')
+      throw new Error('Record option detected but recording is not available')
+    }
     this.signaling = new Signaling({
       streamName: this.streamName,
       url: `${publisherData.urls[0]}?token=${publisherData.jwt}`

packages/millicast-sdk/src/Publish.js

@@ -48,6 +48,14 @@ export default class BaseWebRTC extends EventEmitter {
     this.options = null
   }
 
+  /**
+  * Get current RTC peer connection.
+  * @returns {RTCPeerConnection} Object which represents the RTCPeerConnection.
+  */
+  getRTCPeerConnection () {
+    return this.webRTCPeer ? this.webRTCPeer.getRTCPeer() : null
+  }
+
   /**
    * Stops connection.
    */

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

@@ -0,0 +1,11 @@
+Feature: As a user I want to get the peer so I can use it
+
+  Scenario: Get existing RTC peer
+    Given I have a BaseWebRTC instanced and existing peer
+    When I want to get the peer
+    Then returns the peer
+
+  Scenario: Get no existing RTC peer
+    Given I have a BaseWebRTC instanced and no existing peer
+    When I want to get the peer
+    Then returns null

packages/millicast-sdk/tests/features/BaseWebRTC.feature

@@ -18,4 +18,9 @@ Feature: As a user I want to publish to a Millicast Stream so I can get a connec
   Scenario: Publish with an existing stream name and valid token using other API Endpoint
     Given I have a valid token and an existing stream name
     When I request a connection path to Director API
+    Then I get the publish connection path
+
+  Scenario: Publish with an existing stream name, valid token and options as object
+    Given I have a valid token and an existing stream name
+    When I request a connection path to Director API using options object
     Then I get the publish connection path

packages/millicast-sdk/tests/features/GetPublisherConnectionPath.feature

@@ -18,4 +18,9 @@ Feature: As a user I want to subscribe to a Millicast Stream so I can get a conn
   Scenario: Subscribe to an existing stream using other API Endpoint
     Given I have an existing stream name, accountId and no token
     When I request a connection path to Director API
+    Then I get the subscriber connection path
+
+  Scenario: Subscribe to an existing unrestricted stream, valid accountId, no token and options as object
+    Given I have an existing stream name, accountId and no token
+    When I request a connection path to Director API using options object
     Then I get the subscriber connection path