@dolbyio/dolbyio-rest-apis-client 6.2.2 → 6.3.0

package/dist/index.js

@@ -34,4 +34,4 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
 // Expose the logger to control when/where to log
 
 /** Gets the version of this library. */
-var version = exports.version = "6.2.2";
+var version = exports.version = "6.3.0";

package/dist/streaming/types/monitoring.d.ts

@@ -50,6 +50,113 @@ export interface StreamSummary {
     /** Viewer count. */
     viewerCount: number;
 }
+/** Represents a Feed object. */
+export interface Feed {
+    /** Identifier of the stream. */
+    streamId: string;
+    /** Identifier of the feed. */
+    feedId: string;
+    /** Identifier of the cluster. */
+    clusterId: string;
+    /** Identifier of the source. */
+    sourceId: string;
+    /** Simulcast ID. */
+    simulcastId: string;
+    /** Server ID. */
+    serverId: string;
+    /** Is the feed active. */
+    active: boolean;
+    /** Stream publishing start time. */
+    startTime: string;
+    /** Stream publishing end time. */
+    endTime?: string;
+    /** Is recording allowed for this stream. */
+    isRecordingAllowed: boolean;
+    /** Packet loss percentage over last five minutes. */
+    packetLoss: number;
+    /** Is the feed redundant. */
+    isRedundant?: boolean;
+    /** Feed priority. */
+    priority?: number;
+    /** Framerate. */
+    frameRate: number;
+    /** Feed type. */
+    type: string;
+    /** Identifier of the token. */
+    tokenId: number;
+    /** Client. */
+    client: {
+        /** Country. */
+        country: string;
+        /** City. */
+        city: string;
+        /** Continent. */
+        continent: string;
+        /** coordinates. */
+        coordinates: number[];
+        /** Sub. */
+        sub: string[];
+        /** IP Address. */
+        ip: string;
+    };
+    /** Restream information. */
+    restreams: Restream[];
+    /** Feed statistics. */
+    feedStats: FeedStats[];
+    /** Details for all tracks. */
+    trackDetails: TrackDetails[];
+}
+/** Represents the details of a track object. */
+export interface TrackDetails {
+    /** Idenitfier of the track. */
+    trackId: string;
+    /** Encoding details. */
+    encodingDetails: EncodingDetails[];
+}
+/** Represents the encoding details of a track. */
+export interface EncodingDetails {
+    /** Encoding ID. */
+    encodingId: string;
+    /** I-frame rate. */
+    iFrameRate: number;
+    /** B-frame rate. */
+    bFrameRate: number;
+    /** P-frame rate. */
+    pFrameRate: number;
+    /** Encoding statistics. */
+    encodingStats: EncodingStats[];
+}
+/** Represents the encoding statistic of a track. */
+export interface EncodingStats {
+    /** Timestamp of the entry. */
+    timestamp: string;
+    /** Timestamp of the entry. */
+    resolution: {
+        /** Height of the frame. */
+        height: number;
+        /** Width of the frame. */
+        width: number;
+    };
+    /** Bitrate. */
+    bitRate: {
+        /** Audio bitrate. */
+        audioBitrate: number;
+        /** Video bitrate. */
+        videoBitrate: number;
+    };
+    /** Video codec. */
+    videoCodec: number;
+    /** Audio codec. */
+    audioCodec: number;
+    /** Frames. */
+    frames?: number;
+    /** RTT. */
+    rtt?: number;
+    /** Buffer Time. */
+    bufferTime?: number;
+    /** B-frames. */
+    bFrames?: number;
+}
 /** Represents a stream details. */
 export interface StreamDetails extends StreamSummary {
     /** Has redundant stream. */
@@ -57,106 +164,7 @@ export interface StreamDetails extends StreamSummary {
     /** Restreaming enabled. */
     restreaming: boolean;
     /** Feeds. */
-    feeds: {
-        /** Identifier of the stream. */
-        streamId: string;
-        /** Identifier of the feed. */
-        feedId: string;
-        /** Identifier of the cluster. */
-        clusterId: string;
-        /** Identifier of the source. */
-        sourceId: string;
-        /** Simulcast ID. */
-        simulcastId: string;
-        /** Server ID. */
-        serverId: string;
-        /** Is the feed active. */
-        active: boolean;
-        /** Stream publishing start time. */
-        startTime: string;
-        /** Stream publishing end time. */
-        endTime?: string;
-        /** Is recording allowed for this stream. */
-        isRecordingAllowed: boolean;
-        /** Packet loss percentage over last five minutes. */
-        packetLoss: number;
-        /** Is the feed redundant. */
-        isRedundant?: boolean;
-        /** Feed priority. */
-        priority?: number;
-        /** Framerate. */
-        frameRate: number;
-        /** Feed type. */
-        type: string;
-        /** Identifier of the token. */
-        tokenId: number;
-        /** Client. */
-        client: {
-            /** Country. */
-            country: string;
-            /** City. */
-            city: string;
-            /** Continent. */
-            continent: string;
-            /** coordinates. */
-            coordinates: number[];
-            /** Sub. */
-            sub: string[];
-            /** IP Address. */
-            ip: string;
-        };
-        /** Restream information. */
-        restreams: Restream[];
-        /** Feed statistics. */
-        feedStats: FeedStats[];
-        /** Details for all tracks. */
-        trackDetails: {
-            /** Idenitfier of the track. */
-            trackId: string;
-            /** Encoding details. */
-            encodingDetails: {
-                /** Encoding ID. */
-                encodingId: string;
-                /** I-frame rate. */
-                iFrameRate: number;
-                /** B-frame rate. */
-                bFrameRate: number;
-                /** P-frame rate. */
-                pFrameRate: number;
-                /** Encoding statistics. */
-                encodingStats: {
-                    /** Timestamp of the entry. */
-                    timestamp: string;
-                    /** Timestamp of the entry. */
-                    resolution: {
-                        /** Height of the frame. */
-                        height: number;
-                        /** Width of the frame. */
-                        width: number;
-                    };
-                    /** Bitrate. */
-                    bitRate: {
-                        /** Audio bitrate. */
-                        audioBitrate: number;
-                        /** Video bitrate. */
-                        videoBitrate: number;
-                    };
-                    /** Video codec. */
-                    videoCodec: number;
-                    /** Audio codec. */
-                    audioCodec: number;
-                    /** Frames. */
-                    frames?: number;
-                    /** RTT. */
-                    rtt?: number;
-                    /** Buffer Time. */
-                    bufferTime?: number;
-                    /** B-frames. */
-                    bFrames?: number;
-                }[];
-            }[];
-        }[];
-    }[];
+    feeds: Feed[];
 }
 /** Represents the restream information. */
 export interface Restream {

package/dist/streaming/types/webhooks.d.ts

@@ -8,8 +8,6 @@ export interface Webhook {
     secret: string;
     /** If `true` sends webhook events on feeds `start/stop`. */
     isFeedHooks: boolean;
-    /** If `true` sends webhook events on recording `start/error/complete/deleted`. */
-    isRecordingHooks: boolean;
     /** If `true` sends webhook events on thumbnail generation. */
     isThumbnailHooks: boolean;
     /** If `true` sends webhook events on transcoder instance updates. */
@@ -46,8 +44,6 @@ export interface UpdateWebhookRequest {
     refreshSecret?: boolean;
     /** Set to `true` to send webhook events on feeds `start/stop`. */
     isFeedHooks?: boolean;
-    /** Set to `true` to send webhook events on recording `start/error/complete/deleted`. */
-    isRecordingHooks?: boolean;
     /** Set to `true` to send webhook events on thumbnail generation. */
     isThumbnailHooks?: boolean;
     /** Set to `true` to send webhook events on transcoder instance updates. */
@@ -109,5 +105,14 @@ export interface AddWebhookRequest {
      */
     filter?: string;
 }
+/** Represents a webhook test request. */
+export interface TestWebhookRequest {
+    /** Type of webhook event to test. */
+    webhookType: WebhookType;
+    /** StreamName to include in test webhook payload. If not provided a default value will be used. */
+    streamName?: string;
+    /** TranscoderName to include in test webhook payload. If not provided a default value will be used.. */
+    transcoderName?: string;
+}
 /** Types of webhook events. */
-export type WebhookType = 'Recordings' | 'Thumbnail' | 'Transcoder' | 'Media' | 'Feeds' | 'ViewerConnection';
+export type WebhookType = 'Thumbnail' | 'Transcoder' | 'Media' | 'Feeds' | 'ViewerConnection';

package/dist/streaming/webhooks.d.ts

@@ -1,4 +1,4 @@
-import { Webhook, UpdateWebhookRequest, ListWebhooksRequest, AddWebhookRequest, WebhookType } from './types/webhooks';
+import { Webhook, UpdateWebhookRequest, ListWebhooksRequest, AddWebhookRequest, TestWebhookRequest } from './types/webhooks';
 /**
  * Gets the specified webhook.
  *
@@ -61,8 +61,8 @@ export declare const add: (apiSecret: string, webhook: AddWebhookRequest) => Pro
  * @see {@link https://optiview.dolby.com/docs/millicast/api/webhooks-test-webhook/}
  *
  * @param apiSecret The API Secret used to authenticate this request.
- * @param webhookType Type of webhook to test.
+ * @param testRequest Test request for the webhook.
  *
  * @returns A {@link !Promise Promise} whose fulfillment handler receives a flag indicating if the operation was successful or not.
  */
-export declare const test: (apiSecret: string, webhookType: WebhookType) => Promise<boolean>;
+export declare const test: (apiSecret: string, testRequest: TestWebhookRequest) => Promise<boolean>;

package/dist/streaming/webhooks.js

@@ -214,24 +214,28 @@ var add = exports.add = /*#__PURE__*/function () {
  * @see {@link https://optiview.dolby.com/docs/millicast/api/webhooks-test-webhook/}
  *
  * @param apiSecret The API Secret used to authenticate this request.
- * @param webhookType Type of webhook to test.
+ * @param testRequest Test request for the webhook.
  *
  * @returns A {@link !Promise Promise} whose fulfillment handler receives a flag indicating if the operation was successful or not.
  */
 var test = exports.test = /*#__PURE__*/function () {
-  var _ref6 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6(apiSecret, webhookType) {
+  var _ref6 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6(apiSecret, testRequest) {
     var options;
     return _regenerator().w(function (_context6) {
       while (1) switch (_context6.n) {
         case 0:
           options = {
             hostname: Urls.getRtsHostname(),
-            path: "/api/webhooks/test/".concat(webhookType),
+            path: "/api/webhooks/test/".concat(testRequest.webhookType),
             headers: {
               Accept: 'application/json',
               'Content-Type': 'application/json',
               Authorization: "Bearer ".concat(apiSecret)
-            }
+            },
+            body: JSON.stringify({
+              streamName: testRequest.streamName,
+              transcoderName: testRequest.transcoderName
+            })
           };
           _context6.n = 1;
           return (0, _httpHelpers.sendPost)(options);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dolbyio/dolbyio-rest-apis-client",
-    "version": "6.2.2",
+    "version": "6.3.0",
     "description": "Node.JS wrapper for the Dolby OptiView REST APIs",
     "main": "dist/index.js",
     "scripts": {