@dolbyio/dolbyio-rest-apis-client 1.0.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -121
- package/README.md +19 -2
- package/dist/communications/authentication.d.ts +2 -2
- package/dist/communications/authentication.js +2 -2
- package/dist/communications/conference.d.ts +31 -6
- package/dist/communications/conference.js +69 -7
- package/dist/communications/conference.js.map +1 -1
- package/dist/communications/index.js +5 -1
- package/dist/communications/index.js.map +1 -1
- package/dist/communications/monitor/conferences.d.ts +6 -6
- package/dist/communications/monitor/conferences.js +6 -6
- package/dist/communications/monitor/index.js +5 -1
- package/dist/communications/monitor/index.js.map +1 -1
- package/dist/communications/monitor/recordings.d.ts +9 -9
- package/dist/communications/monitor/recordings.js +9 -9
- package/dist/communications/monitor/webhooks.d.ts +2 -2
- package/dist/communications/monitor/webhooks.js +2 -2
- package/dist/communications/streaming.d.ts +10 -8
- package/dist/communications/streaming.js +10 -8
- package/dist/communications/streaming.js.map +1 -1
- package/dist/communications/types/recordings.d.ts +2 -2
- package/dist/communications/types/spatialAudio.d.ts +18 -0
- package/dist/communications/types/spatialAudio.js +3 -0
- package/dist/communications/types/spatialAudio.js.map +1 -0
- package/dist/index.d.ts +2 -1
- package/dist/index.js +8 -2
- package/dist/index.js.map +1 -1
- package/dist/media/analyze.d.ts +43 -0
- package/dist/media/analyze.js +82 -0
- package/dist/media/analyze.js.map +1 -0
- package/dist/media/analyzeSpeech.d.ts +37 -0
- package/dist/media/analyzeSpeech.js +76 -0
- package/dist/media/analyzeSpeech.js.map +1 -0
- package/dist/media/diagnose.d.ts +39 -0
- package/dist/media/diagnose.js +78 -0
- package/dist/media/diagnose.js.map +1 -0
- package/dist/media/enhance.d.ts +34 -0
- package/dist/media/enhance.js +73 -0
- package/dist/media/enhance.js.map +1 -0
- package/dist/media/index.d.ts +10 -0
- package/dist/media/index.js +45 -0
- package/dist/media/index.js.map +1 -0
- package/dist/media/internal/httpHelpers.d.ts +46 -0
- package/dist/media/internal/httpHelpers.js +114 -0
- package/dist/media/internal/httpHelpers.js.map +1 -0
- package/dist/media/io.d.ts +32 -0
- package/dist/media/io.js +74 -0
- package/dist/media/io.js.map +1 -0
- package/dist/media/jobs.d.ts +35 -0
- package/dist/media/jobs.js +116 -0
- package/dist/media/jobs.js.map +1 -0
- package/dist/media/platform.d.ts +15 -0
- package/dist/media/platform.js +44 -0
- package/dist/media/platform.js.map +1 -0
- package/dist/media/transcode.d.ts +30 -0
- package/dist/media/transcode.js +69 -0
- package/dist/media/transcode.js.map +1 -0
- package/dist/media/types/analyze.d.ts +6 -0
- package/dist/media/types/analyze.js +3 -0
- package/dist/media/types/analyze.js.map +1 -0
- package/dist/media/types/analyzeSpeech.d.ts +6 -0
- package/dist/media/types/analyzeSpeech.js +3 -0
- package/dist/media/types/analyzeSpeech.js.map +1 -0
- package/dist/media/types/diagnose.d.ts +6 -0
- package/dist/media/types/diagnose.js +3 -0
- package/dist/media/types/diagnose.js.map +1 -0
- package/dist/media/types/enhance.d.ts +6 -0
- package/dist/media/types/enhance.js +3 -0
- package/dist/media/types/enhance.js.map +1 -0
- package/dist/media/types/jobResults.d.ts +12 -0
- package/dist/media/types/jobResults.js +3 -0
- package/dist/media/types/jobResults.js.map +1 -0
- package/dist/media/types/jobs.d.ts +29 -0
- package/dist/media/types/jobs.js +3 -0
- package/dist/media/types/jobs.js.map +1 -0
- package/dist/media/types/jwtToken.d.ts +6 -0
- package/dist/media/types/jwtToken.js +3 -0
- package/dist/media/types/jwtToken.js.map +1 -0
- package/dist/media/types/transcode.d.ts +6 -0
- package/dist/media/types/transcode.js +3 -0
- package/dist/media/types/transcode.js.map +1 -0
- package/dist/media/types/webhooks.d.ts +21 -0
- package/dist/media/types/webhooks.js +3 -0
- package/dist/media/types/webhooks.js.map +1 -0
- package/dist/media/webhooks.d.ts +46 -0
- package/dist/media/webhooks.js +129 -0
- package/dist/media/webhooks.js.map +1 -0
- package/package.json +7 -7
|
@@ -5,7 +5,7 @@ import { GetRecordingsOptions, GetAllRecordingsOptions, GetRecordingsResponse, R
|
|
|
5
5
|
* This API checks only the recordings that have ended during a specific time range.
|
|
6
6
|
* Recordings are indexed based on the ending time.
|
|
7
7
|
*
|
|
8
|
-
* @link https://docs.dolby.io/
|
|
8
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-recordings
|
|
9
9
|
*
|
|
10
10
|
* @param accessToken Access token to use for authentication.
|
|
11
11
|
* @param options Options to request the recordings.
|
|
@@ -18,7 +18,7 @@ export declare const getRecordings: (accessToken: JwtToken, options: GetRecordin
|
|
|
18
18
|
* This API checks only the recordings that have ended during a specific time range.
|
|
19
19
|
* Recordings are indexed based on the ending time.
|
|
20
20
|
*
|
|
21
|
-
* @link https://docs.dolby.io/
|
|
21
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-recordings
|
|
22
22
|
*
|
|
23
23
|
* @param accessToken Access token to use for authentication.
|
|
24
24
|
* @param options Options to request the recordings.
|
|
@@ -31,7 +31,7 @@ export declare const getAllRecordings: (accessToken: JwtToken, options: GetAllRe
|
|
|
31
31
|
* This API checks the recordings that have ended during a specific time range.
|
|
32
32
|
* Recordings are indexed based on the ending time.
|
|
33
33
|
*
|
|
34
|
-
* @link https://docs.dolby.io/
|
|
34
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conference-recordings
|
|
35
35
|
*
|
|
36
36
|
* @param accessToken Access token to use for authentication.
|
|
37
37
|
* @param options Options to request the webhooks.
|
|
@@ -44,7 +44,7 @@ export declare const getRecording: (accessToken: JwtToken, options: GetRecording
|
|
|
44
44
|
*
|
|
45
45
|
* **Warning**: After deleting the recording, it is not possible to restore the recording data.
|
|
46
46
|
*
|
|
47
|
-
* @link https://docs.dolby.io/
|
|
47
|
+
* @link https://docs.dolby.io/communications-apis/reference/delete-conference-recordings
|
|
48
48
|
*
|
|
49
49
|
* @param accessToken Access token to use for authentication.
|
|
50
50
|
* @param confId Identifier of the conference.
|
|
@@ -54,7 +54,7 @@ export declare const deleteRecording: (accessToken: JwtToken, confId: string) =>
|
|
|
54
54
|
* Get details of all Dolby Voice-based audio recordings, and associated split recordings,
|
|
55
55
|
* for a given conference and download the conference recording in the MP3 audio format.
|
|
56
56
|
*
|
|
57
|
-
* @link https://docs.dolby.io/
|
|
57
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-dolby-voice-audio-recordings
|
|
58
58
|
*
|
|
59
59
|
* @param accessToken Access token to use for authentication.
|
|
60
60
|
* @param confId Identifier of the conference.
|
|
@@ -64,9 +64,9 @@ export declare const deleteRecording: (accessToken: JwtToken, confId: string) =>
|
|
|
64
64
|
export declare const getDolbyVoiceRecording: (accessToken: JwtToken, confId: string) => Promise<DolbyVoiceRecording>;
|
|
65
65
|
/**
|
|
66
66
|
* Download the conference recording in the MP4 video format.
|
|
67
|
-
* For more information, see the [Recording](https://docs.dolby.io/
|
|
67
|
+
* For more information, see the [Recording](https://docs.dolby.io/communications-apis/docs/guides-recording-mechanisms) document.
|
|
68
68
|
*
|
|
69
|
-
* @link https://docs.dolby.io/
|
|
69
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-mp4-recording
|
|
70
70
|
*
|
|
71
71
|
* @param accessToken Access token to use for authentication.
|
|
72
72
|
* @param confId Identifier of the conference.
|
|
@@ -75,9 +75,9 @@ export declare const getDolbyVoiceRecording: (accessToken: JwtToken, confId: str
|
|
|
75
75
|
export declare const downloadMp4Recording: (accessToken: JwtToken, confId: string, filepath: string) => Promise<void>;
|
|
76
76
|
/**
|
|
77
77
|
* Download the conference recording in the MP3 audio format.
|
|
78
|
-
* For more information, see the [Recording](https://docs.dolby.io/
|
|
78
|
+
* For more information, see the [Recording](https://docs.dolby.io/communications-apis/docs/guides-recording-mechanisms) document.
|
|
79
79
|
*
|
|
80
|
-
* @link https://docs.dolby.io/
|
|
80
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-mp3-recording
|
|
81
81
|
*
|
|
82
82
|
* @param accessToken Access token to use for authentication.
|
|
83
83
|
* @param confId Identifier of the conference.
|
|
@@ -17,7 +17,7 @@ const httpHelpers_2 = require("../internal/httpHelpers");
|
|
|
17
17
|
* This API checks only the recordings that have ended during a specific time range.
|
|
18
18
|
* Recordings are indexed based on the ending time.
|
|
19
19
|
*
|
|
20
|
-
* @link https://docs.dolby.io/
|
|
20
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-recordings
|
|
21
21
|
*
|
|
22
22
|
* @param accessToken Access token to use for authentication.
|
|
23
23
|
* @param options Options to request the recordings.
|
|
@@ -57,7 +57,7 @@ exports.getRecordings = getRecordings;
|
|
|
57
57
|
* This API checks only the recordings that have ended during a specific time range.
|
|
58
58
|
* Recordings are indexed based on the ending time.
|
|
59
59
|
*
|
|
60
|
-
* @link https://docs.dolby.io/
|
|
60
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-recordings
|
|
61
61
|
*
|
|
62
62
|
* @param accessToken Access token to use for authentication.
|
|
63
63
|
* @param options Options to request the recordings.
|
|
@@ -93,7 +93,7 @@ exports.getAllRecordings = getAllRecordings;
|
|
|
93
93
|
* This API checks the recordings that have ended during a specific time range.
|
|
94
94
|
* Recordings are indexed based on the ending time.
|
|
95
95
|
*
|
|
96
|
-
* @link https://docs.dolby.io/
|
|
96
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conference-recordings
|
|
97
97
|
*
|
|
98
98
|
* @param accessToken Access token to use for authentication.
|
|
99
99
|
* @param options Options to request the webhooks.
|
|
@@ -133,7 +133,7 @@ exports.getRecording = getRecording;
|
|
|
133
133
|
*
|
|
134
134
|
* **Warning**: After deleting the recording, it is not possible to restore the recording data.
|
|
135
135
|
*
|
|
136
|
-
* @link https://docs.dolby.io/
|
|
136
|
+
* @link https://docs.dolby.io/communications-apis/reference/delete-conference-recordings
|
|
137
137
|
*
|
|
138
138
|
* @param accessToken Access token to use for authentication.
|
|
139
139
|
* @param confId Identifier of the conference.
|
|
@@ -154,7 +154,7 @@ exports.deleteRecording = deleteRecording;
|
|
|
154
154
|
* Get details of all Dolby Voice-based audio recordings, and associated split recordings,
|
|
155
155
|
* for a given conference and download the conference recording in the MP3 audio format.
|
|
156
156
|
*
|
|
157
|
-
* @link https://docs.dolby.io/
|
|
157
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-dolby-voice-audio-recordings
|
|
158
158
|
*
|
|
159
159
|
* @param accessToken Access token to use for authentication.
|
|
160
160
|
* @param confId Identifier of the conference.
|
|
@@ -176,9 +176,9 @@ const getDolbyVoiceRecording = (accessToken, confId) => __awaiter(void 0, void 0
|
|
|
176
176
|
exports.getDolbyVoiceRecording = getDolbyVoiceRecording;
|
|
177
177
|
/**
|
|
178
178
|
* Download the conference recording in the MP4 video format.
|
|
179
|
-
* For more information, see the [Recording](https://docs.dolby.io/
|
|
179
|
+
* For more information, see the [Recording](https://docs.dolby.io/communications-apis/docs/guides-recording-mechanisms) document.
|
|
180
180
|
*
|
|
181
|
-
* @link https://docs.dolby.io/
|
|
181
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-mp4-recording
|
|
182
182
|
*
|
|
183
183
|
* @param accessToken Access token to use for authentication.
|
|
184
184
|
* @param confId Identifier of the conference.
|
|
@@ -198,9 +198,9 @@ const downloadMp4Recording = (accessToken, confId, filepath) => __awaiter(void 0
|
|
|
198
198
|
exports.downloadMp4Recording = downloadMp4Recording;
|
|
199
199
|
/**
|
|
200
200
|
* Download the conference recording in the MP3 audio format.
|
|
201
|
-
* For more information, see the [Recording](https://docs.dolby.io/
|
|
201
|
+
* For more information, see the [Recording](https://docs.dolby.io/communications-apis/docs/guides-recording-mechanisms) document.
|
|
202
202
|
*
|
|
203
|
-
* @link https://docs.dolby.io/
|
|
203
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-mp3-recording
|
|
204
204
|
*
|
|
205
205
|
* @param accessToken Access token to use for authentication.
|
|
206
206
|
* @param confId Identifier of the conference.
|
|
@@ -3,7 +3,7 @@ import { GetWebhooksOptions, GetAllWebhooksOptions, GetWebHookResponse, WebHook
|
|
|
3
3
|
/**
|
|
4
4
|
* Gets a list of Webhook events sent, during a specific time range. The list includes associated endpoint response codes and headers.
|
|
5
5
|
*
|
|
6
|
-
* @link https://docs.dolby.io/
|
|
6
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-webhooks
|
|
7
7
|
*
|
|
8
8
|
* @param accessToken Access token to use for authentication.
|
|
9
9
|
* @param options Options to request the webhooks.
|
|
@@ -14,7 +14,7 @@ export declare const getEvents: (accessToken: JwtToken, options: GetWebhooksOpti
|
|
|
14
14
|
/**
|
|
15
15
|
* Gets a list of all Webhook events sent, during a specific time range. The list includes associated endpoint response codes and headers.
|
|
16
16
|
*
|
|
17
|
-
* @link https://docs.dolby.io/
|
|
17
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-webhooks
|
|
18
18
|
*
|
|
19
19
|
* @param accessToken Access token to use for authentication.
|
|
20
20
|
* @param options Options to request the webhooks.
|
|
@@ -15,7 +15,7 @@ const httpHelpers_2 = require("../internal/httpHelpers");
|
|
|
15
15
|
/**
|
|
16
16
|
* Gets a list of Webhook events sent, during a specific time range. The list includes associated endpoint response codes and headers.
|
|
17
17
|
*
|
|
18
|
-
* @link https://docs.dolby.io/
|
|
18
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-webhooks
|
|
19
19
|
*
|
|
20
20
|
* @param accessToken Access token to use for authentication.
|
|
21
21
|
* @param options Options to request the webhooks.
|
|
@@ -61,7 +61,7 @@ exports.getEvents = getEvents;
|
|
|
61
61
|
/**
|
|
62
62
|
* Gets a list of all Webhook events sent, during a specific time range. The list includes associated endpoint response codes and headers.
|
|
63
63
|
*
|
|
64
|
-
* @link https://docs.dolby.io/
|
|
64
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-webhooks
|
|
65
65
|
*
|
|
66
66
|
* @param accessToken Access token to use for authentication.
|
|
67
67
|
* @param options Options to request the webhooks.
|
|
@@ -4,7 +4,7 @@ import JwtToken from './types/jwtToken';
|
|
|
4
4
|
* a `Stream.Rtmp.InProgress` Webhook event will be sent. You must use this API if the conference is protected
|
|
5
5
|
* using enhanced conference access control.
|
|
6
6
|
*
|
|
7
|
-
* @link https://docs.dolby.io/
|
|
7
|
+
* @link https://docs.dolby.io/communications-apis/reference/start-rtmp
|
|
8
8
|
*
|
|
9
9
|
* @param accessToken Access token to use for authentication.
|
|
10
10
|
* @param conferenceId Identifier of the conference.
|
|
@@ -16,7 +16,7 @@ export declare const startRtmp: (accessToken: JwtToken, conferenceId: string, rt
|
|
|
16
16
|
* Starts an RTMP live stream. Once the Dolby.io Communication API service started streaming to the target url,
|
|
17
17
|
* a `Stream.Rtmp.InProgress` Webhook event will be sent.
|
|
18
18
|
*
|
|
19
|
-
* @link https://docs.dolby.io/
|
|
19
|
+
* @link https://docs.dolby.io/communications-apis/reference/start-rtmp-v1
|
|
20
20
|
*
|
|
21
21
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
22
22
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -27,7 +27,7 @@ export declare const startRtmpBasicAuth: (consumerKey: string, consumerSecret: s
|
|
|
27
27
|
/**
|
|
28
28
|
* Stops an RTMP stream. You must use this API if the conference is protected using enhanced conference access control.
|
|
29
29
|
*
|
|
30
|
-
* @link https://docs.dolby.io/
|
|
30
|
+
* @link https://docs.dolby.io/communications-apis/reference/stop-rtmp
|
|
31
31
|
*
|
|
32
32
|
* @param accessToken Access token to use for authentication.
|
|
33
33
|
* @param conferenceId Identifier of the conference.
|
|
@@ -37,7 +37,7 @@ export declare const stopRtmp: (accessToken: JwtToken, conferenceId: string) =>
|
|
|
37
37
|
* @deprecated
|
|
38
38
|
* Stops an RTMP stream.
|
|
39
39
|
*
|
|
40
|
-
* @link https://docs.dolby.io/
|
|
40
|
+
* @link https://docs.dolby.io/communications-apis/reference/stop-rtmp-v1
|
|
41
41
|
*
|
|
42
42
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
43
43
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -45,10 +45,11 @@ export declare const stopRtmp: (accessToken: JwtToken, conferenceId: string) =>
|
|
|
45
45
|
*/
|
|
46
46
|
export declare const stopRtmpBasicAuth: (consumerKey: string, consumerSecret: string, conferenceId: string) => Promise<void>;
|
|
47
47
|
/**
|
|
48
|
+
* @deprecated
|
|
48
49
|
* Starts an HTTP Live Stream (HLS). The HLS URL is included in the Stream.Hls.InProgress Webhook event.
|
|
49
50
|
* You must use this API if the conference is protected using enhanced conference access control.
|
|
50
51
|
*
|
|
51
|
-
* @link https://docs.dolby.io/
|
|
52
|
+
* @link https://docs.dolby.io/communications-apis/reference/start-hls
|
|
52
53
|
*
|
|
53
54
|
* @param accessToken Access token to use for authentication.
|
|
54
55
|
* @param conferenceId Identifier of the conference.
|
|
@@ -58,7 +59,7 @@ export declare const startHls: (accessToken: JwtToken, conferenceId: string) =>
|
|
|
58
59
|
* @deprecated
|
|
59
60
|
* Starts an HTTP Live Stream (HLS). The HLS URL is included in the Stream.Hls.InProgress Webhook event.
|
|
60
61
|
*
|
|
61
|
-
* @link https://docs.dolby.io/
|
|
62
|
+
* @link https://docs.dolby.io/communications-apis/reference/start-hls-v1
|
|
62
63
|
*
|
|
63
64
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
64
65
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -66,9 +67,10 @@ export declare const startHls: (accessToken: JwtToken, conferenceId: string) =>
|
|
|
66
67
|
*/
|
|
67
68
|
export declare const startHlsBasicAuth: (consumerKey: string, consumerSecret: string, conferenceId: string) => Promise<void>;
|
|
68
69
|
/**
|
|
70
|
+
* @deprecated
|
|
69
71
|
* Stops an HTTP Live Stream (HLS). You must use this API if the conference is protected using enhanced conference access control.
|
|
70
72
|
*
|
|
71
|
-
* @link https://docs.dolby.io/
|
|
73
|
+
* @link https://docs.dolby.io/communications-apis/reference/stop-hls
|
|
72
74
|
*
|
|
73
75
|
* @param accessToken Access token to use for authentication.
|
|
74
76
|
* @param conferenceId Identifier of the conference.
|
|
@@ -78,7 +80,7 @@ export declare const stopHls: (accessToken: JwtToken, conferenceId: string) => P
|
|
|
78
80
|
* @deprecated
|
|
79
81
|
* Stops an HTTP Live Stream (HLS).
|
|
80
82
|
*
|
|
81
|
-
* @link https://docs.dolby.io/
|
|
83
|
+
* @link https://docs.dolby.io/communications-apis/reference/stop-hls-v1
|
|
82
84
|
*
|
|
83
85
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
84
86
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -16,7 +16,7 @@ const httpHelpers_1 = require("../internal/httpHelpers");
|
|
|
16
16
|
* a `Stream.Rtmp.InProgress` Webhook event will be sent. You must use this API if the conference is protected
|
|
17
17
|
* using enhanced conference access control.
|
|
18
18
|
*
|
|
19
|
-
* @link https://docs.dolby.io/
|
|
19
|
+
* @link https://docs.dolby.io/communications-apis/reference/start-rtmp
|
|
20
20
|
*
|
|
21
21
|
* @param accessToken Access token to use for authentication.
|
|
22
22
|
* @param conferenceId Identifier of the conference.
|
|
@@ -42,7 +42,7 @@ exports.startRtmp = startRtmp;
|
|
|
42
42
|
* Starts an RTMP live stream. Once the Dolby.io Communication API service started streaming to the target url,
|
|
43
43
|
* a `Stream.Rtmp.InProgress` Webhook event will be sent.
|
|
44
44
|
*
|
|
45
|
-
* @link https://docs.dolby.io/
|
|
45
|
+
* @link https://docs.dolby.io/communications-apis/reference/start-rtmp-v1
|
|
46
46
|
*
|
|
47
47
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
48
48
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -68,7 +68,7 @@ exports.startRtmpBasicAuth = startRtmpBasicAuth;
|
|
|
68
68
|
/**
|
|
69
69
|
* Stops an RTMP stream. You must use this API if the conference is protected using enhanced conference access control.
|
|
70
70
|
*
|
|
71
|
-
* @link https://docs.dolby.io/
|
|
71
|
+
* @link https://docs.dolby.io/communications-apis/reference/stop-rtmp
|
|
72
72
|
*
|
|
73
73
|
* @param accessToken Access token to use for authentication.
|
|
74
74
|
* @param conferenceId Identifier of the conference.
|
|
@@ -90,7 +90,7 @@ exports.stopRtmp = stopRtmp;
|
|
|
90
90
|
* @deprecated
|
|
91
91
|
* Stops an RTMP stream.
|
|
92
92
|
*
|
|
93
|
-
* @link https://docs.dolby.io/
|
|
93
|
+
* @link https://docs.dolby.io/communications-apis/reference/stop-rtmp-v1
|
|
94
94
|
*
|
|
95
95
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
96
96
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -111,10 +111,11 @@ const stopRtmpBasicAuth = (consumerKey, consumerSecret, conferenceId) => __await
|
|
|
111
111
|
});
|
|
112
112
|
exports.stopRtmpBasicAuth = stopRtmpBasicAuth;
|
|
113
113
|
/**
|
|
114
|
+
* @deprecated
|
|
114
115
|
* Starts an HTTP Live Stream (HLS). The HLS URL is included in the Stream.Hls.InProgress Webhook event.
|
|
115
116
|
* You must use this API if the conference is protected using enhanced conference access control.
|
|
116
117
|
*
|
|
117
|
-
* @link https://docs.dolby.io/
|
|
118
|
+
* @link https://docs.dolby.io/communications-apis/reference/start-hls
|
|
118
119
|
*
|
|
119
120
|
* @param accessToken Access token to use for authentication.
|
|
120
121
|
* @param conferenceId Identifier of the conference.
|
|
@@ -136,7 +137,7 @@ exports.startHls = startHls;
|
|
|
136
137
|
* @deprecated
|
|
137
138
|
* Starts an HTTP Live Stream (HLS). The HLS URL is included in the Stream.Hls.InProgress Webhook event.
|
|
138
139
|
*
|
|
139
|
-
* @link https://docs.dolby.io/
|
|
140
|
+
* @link https://docs.dolby.io/communications-apis/reference/start-hls-v1
|
|
140
141
|
*
|
|
141
142
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
142
143
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -157,9 +158,10 @@ const startHlsBasicAuth = (consumerKey, consumerSecret, conferenceId) => __await
|
|
|
157
158
|
});
|
|
158
159
|
exports.startHlsBasicAuth = startHlsBasicAuth;
|
|
159
160
|
/**
|
|
161
|
+
* @deprecated
|
|
160
162
|
* Stops an HTTP Live Stream (HLS). You must use this API if the conference is protected using enhanced conference access control.
|
|
161
163
|
*
|
|
162
|
-
* @link https://docs.dolby.io/
|
|
164
|
+
* @link https://docs.dolby.io/communications-apis/reference/stop-hls
|
|
163
165
|
*
|
|
164
166
|
* @param accessToken Access token to use for authentication.
|
|
165
167
|
* @param conferenceId Identifier of the conference.
|
|
@@ -181,7 +183,7 @@ exports.stopHls = stopHls;
|
|
|
181
183
|
* @deprecated
|
|
182
184
|
* Stops an HTTP Live Stream (HLS).
|
|
183
185
|
*
|
|
184
|
-
* @link https://docs.dolby.io/
|
|
186
|
+
* @link https://docs.dolby.io/communications-apis/reference/stop-hls-v1
|
|
185
187
|
*
|
|
186
188
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
187
189
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"streaming.js","sourceRoot":"","sources":["../../src/communications/streaming.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAmD;AAGnD;;;;;;;;;;GAUG;AACI,MAAM,SAAS,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAE,QAAgC,EAAiB,EAAE;IAC5H,MAAM,GAAG,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAE1C,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,uBAAuB,YAAY,aAAa;QACtD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAfW,QAAA,SAAS,aAepB;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,kBAAkB,GAAG,CAC9B,WAAmB,EACnB,cAAsB,EACtB,YAAoB,EACpB,QAAgC,EACnB,EAAE;IACf,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,IAAI,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACjF,MAAM,GAAG,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAE1C,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,oBAAoB;QAC9B,IAAI,EAAE,2BAA2B,YAAY,aAAa;QAC1D,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,SAAS,KAAK,EAAE;SAClC;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AArBW,QAAA,kBAAkB,sBAqB7B;AAEF;;;;;;;GAOG;AACI,MAAM,QAAQ,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAiB,EAAE;IACzF,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,uBAAuB,YAAY,YAAY;QACrD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAZW,QAAA,QAAQ,YAYnB;AAEF;;;;;;;;;GASG;AACI,MAAM,iBAAiB,GAAG,CAAO,WAAmB,EAAE,cAAsB,EAAE,YAAoB,EAAiB,EAAE;IACxH,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,IAAI,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEjF,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,oBAAoB;QAC9B,IAAI,EAAE,2BAA2B,YAAY,YAAY;QACzD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,SAAS,KAAK,EAAE;SAClC;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAdW,QAAA,iBAAiB,qBAc5B;AAEF
|
|
1
|
+
{"version":3,"file":"streaming.js","sourceRoot":"","sources":["../../src/communications/streaming.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAmD;AAGnD;;;;;;;;;;GAUG;AACI,MAAM,SAAS,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAE,QAAgC,EAAiB,EAAE;IAC5H,MAAM,GAAG,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAE1C,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,uBAAuB,YAAY,aAAa;QACtD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAfW,QAAA,SAAS,aAepB;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,kBAAkB,GAAG,CAC9B,WAAmB,EACnB,cAAsB,EACtB,YAAoB,EACpB,QAAgC,EACnB,EAAE;IACf,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,IAAI,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACjF,MAAM,GAAG,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAE1C,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,oBAAoB;QAC9B,IAAI,EAAE,2BAA2B,YAAY,aAAa;QAC1D,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,SAAS,KAAK,EAAE;SAClC;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AArBW,QAAA,kBAAkB,sBAqB7B;AAEF;;;;;;;GAOG;AACI,MAAM,QAAQ,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAiB,EAAE;IACzF,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,uBAAuB,YAAY,YAAY;QACrD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAZW,QAAA,QAAQ,YAYnB;AAEF;;;;;;;;;GASG;AACI,MAAM,iBAAiB,GAAG,CAAO,WAAmB,EAAE,cAAsB,EAAE,YAAoB,EAAiB,EAAE;IACxH,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,IAAI,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEjF,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,oBAAoB;QAC9B,IAAI,EAAE,2BAA2B,YAAY,YAAY;QACzD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,SAAS,KAAK,EAAE;SAClC;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAdW,QAAA,iBAAiB,qBAc5B;AAEF;;;;;;;;;GASG;AACI,MAAM,QAAQ,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAiB,EAAE;IACzF,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,uBAAuB,YAAY,YAAY;QACrD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAZW,QAAA,QAAQ,YAYnB;AAEF;;;;;;;;;GASG;AACI,MAAM,iBAAiB,GAAG,CAAO,WAAmB,EAAE,cAAsB,EAAE,YAAoB,EAAiB,EAAE;IACxH,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,IAAI,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEjF,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,oBAAoB;QAC9B,IAAI,EAAE,2BAA2B,YAAY,YAAY;QACzD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,SAAS,KAAK,EAAE;SAClC;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAdW,QAAA,iBAAiB,qBAc5B;AAEF;;;;;;;;GAQG;AACI,MAAM,OAAO,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAiB,EAAE;IACxF,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,uBAAuB,YAAY,WAAW;QACpD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAZW,QAAA,OAAO,WAYlB;AAEF;;;;;;;;;GASG;AACI,MAAM,gBAAgB,GAAG,CAAO,WAAmB,EAAE,cAAsB,EAAE,YAAoB,EAAiB,EAAE;IACvH,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,IAAI,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEjF,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,oBAAoB;QAC9B,IAAI,EAAE,2BAA2B,YAAY,WAAW;QACxD,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,SAAS,KAAK,EAAE;SAClC;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAdW,QAAA,gBAAgB,oBAc3B"}
|
|
@@ -10,9 +10,9 @@ export interface GetRecordingOptions extends PagedOptions, GetRecordingsOptionsB
|
|
|
10
10
|
confId: string;
|
|
11
11
|
}
|
|
12
12
|
export interface MixRecording {
|
|
13
|
-
/** The size of the MP4 recording (in bytes). The MP4 recording is available only if you have requested the MP4 format in the recording settings. For more information, see the [Recording](https://docs.dolby.io/
|
|
13
|
+
/** The size of the MP4 recording (in bytes). The MP4 recording is available only if you have requested the MP4 format in the recording settings. For more information, see the [Recording](https://docs.dolby.io/communications-apis/docs/guides-recording-mechanisms) document. */
|
|
14
14
|
mp4: number;
|
|
15
|
-
/** The size of the MP3 recording (in bytes). The MP3 recording is available only if you have requested the MP3 format in the recording settings. For more information, see the [Recording](https://docs.dolby.io/
|
|
15
|
+
/** The size of the MP3 recording (in bytes). The MP3 recording is available only if you have requested the MP3 format in the recording settings. For more information, see the [Recording](https://docs.dolby.io/communications-apis/docs/guides-recording-mechanisms) document. */
|
|
16
16
|
mp3: number;
|
|
17
17
|
/** The region code in which the mix recording took place. */
|
|
18
18
|
region: string;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export interface CartesianCoordinates {
|
|
2
|
+
x: number;
|
|
3
|
+
y: number;
|
|
4
|
+
z: number;
|
|
5
|
+
}
|
|
6
|
+
export interface SpatialEnvironment {
|
|
7
|
+
scale: CartesianCoordinates;
|
|
8
|
+
forward: CartesianCoordinates;
|
|
9
|
+
up: CartesianCoordinates;
|
|
10
|
+
right: CartesianCoordinates;
|
|
11
|
+
}
|
|
12
|
+
export interface SpatialListener {
|
|
13
|
+
position: CartesianCoordinates;
|
|
14
|
+
direction: CartesianCoordinates;
|
|
15
|
+
}
|
|
16
|
+
export interface SpatialUsers {
|
|
17
|
+
[externalId: string]: CartesianCoordinates;
|
|
18
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"spatialAudio.js","sourceRoot":"","sources":["../../../src/communications/types/spatialAudio.ts"],"names":[],"mappings":""}
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
3
|
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
5
9
|
}) : (function(o, m, k, k2) {
|
|
6
10
|
if (k2 === undefined) k2 = k;
|
|
7
11
|
o[k2] = m[k];
|
|
@@ -19,7 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
19
23
|
return result;
|
|
20
24
|
};
|
|
21
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
22
|
-
exports.communications = void 0;
|
|
26
|
+
exports.media = exports.communications = void 0;
|
|
23
27
|
const communications = __importStar(require("./communications"));
|
|
24
28
|
exports.communications = communications;
|
|
29
|
+
const media = __importStar(require("./media"));
|
|
30
|
+
exports.media = media;
|
|
25
31
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AAG1C,wCAAc;AAFvB,+CAAiC;AAER,sBAAK"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import JwtToken from './types/jwtToken';
|
|
2
|
+
import { AnalyzeJob } from './types/analyze';
|
|
3
|
+
/**
|
|
4
|
+
* Starts analyzing to learn about your media.
|
|
5
|
+
*
|
|
6
|
+
* The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
|
|
7
|
+
*
|
|
8
|
+
* This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
|
|
9
|
+
*
|
|
10
|
+
* There are additional optional parameters that can be provided to identify the type of content and additional loudness or validation requirements. See the samples for examples of what requests and responses look like.
|
|
11
|
+
*
|
|
12
|
+
* @link https://docs.dolby.io/media-apis/reference/media-analyze-post
|
|
13
|
+
*
|
|
14
|
+
* Beta API
|
|
15
|
+
* This API is being made available as an early preview.
|
|
16
|
+
* If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
|
|
17
|
+
* https://dolby.io/contact
|
|
18
|
+
*
|
|
19
|
+
* Content Length
|
|
20
|
+
*
|
|
21
|
+
* Media content with duration less than 2 seconds will not be processed. The API will return an ERROR in this case.
|
|
22
|
+
*
|
|
23
|
+
* @param auth Your Dolby.io Media API Key or a JWT Token.
|
|
24
|
+
* @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-analyze-post
|
|
25
|
+
*
|
|
26
|
+
* @returns The job identifier through a `Promise`.
|
|
27
|
+
*/
|
|
28
|
+
export declare const start: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
|
|
29
|
+
/**
|
|
30
|
+
* Gets Analyze Status.
|
|
31
|
+
*
|
|
32
|
+
* For a given job_id, this method will check the job status.
|
|
33
|
+
*
|
|
34
|
+
* When `status==Success` you'll be able to retrieve your result from the output location you provided in the original POST.
|
|
35
|
+
*
|
|
36
|
+
* @link https://docs.dolby.io/media-apis/reference/media-analyze-get
|
|
37
|
+
*
|
|
38
|
+
* @param auth Your Dolby.io Media API Key or a JWT Token.
|
|
39
|
+
* @param jobId Identifier of the job to retrieve.
|
|
40
|
+
*
|
|
41
|
+
* @returns The `AnalyzeJob` object through a `Promise`.
|
|
42
|
+
*/
|
|
43
|
+
export declare const getResults: (auth: string | JwtToken, jobId: string) => Promise<AnalyzeJob>;
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.getResults = exports.start = void 0;
|
|
13
|
+
const httpHelpers_1 = require("./internal/httpHelpers");
|
|
14
|
+
/**
|
|
15
|
+
* Starts analyzing to learn about your media.
|
|
16
|
+
*
|
|
17
|
+
* The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
|
|
18
|
+
*
|
|
19
|
+
* This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
|
|
20
|
+
*
|
|
21
|
+
* There are additional optional parameters that can be provided to identify the type of content and additional loudness or validation requirements. See the samples for examples of what requests and responses look like.
|
|
22
|
+
*
|
|
23
|
+
* @link https://docs.dolby.io/media-apis/reference/media-analyze-post
|
|
24
|
+
*
|
|
25
|
+
* Beta API
|
|
26
|
+
* This API is being made available as an early preview.
|
|
27
|
+
* If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
|
|
28
|
+
* https://dolby.io/contact
|
|
29
|
+
*
|
|
30
|
+
* Content Length
|
|
31
|
+
*
|
|
32
|
+
* Media content with duration less than 2 seconds will not be processed. The API will return an ERROR in this case.
|
|
33
|
+
*
|
|
34
|
+
* @param auth Your Dolby.io Media API Key or a JWT Token.
|
|
35
|
+
* @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-analyze-post
|
|
36
|
+
*
|
|
37
|
+
* @returns The job identifier through a `Promise`.
|
|
38
|
+
*/
|
|
39
|
+
const start = (auth, jobContent) => __awaiter(void 0, void 0, void 0, function* () {
|
|
40
|
+
const requestOptions = {
|
|
41
|
+
hostname: 'api.dolby.com',
|
|
42
|
+
path: '/media/analyze',
|
|
43
|
+
headers: {},
|
|
44
|
+
auth,
|
|
45
|
+
body: jobContent,
|
|
46
|
+
};
|
|
47
|
+
const response = yield (0, httpHelpers_1.sendPost)(requestOptions);
|
|
48
|
+
if (response.hasOwnProperty('job_id')) {
|
|
49
|
+
return response['job_id'];
|
|
50
|
+
}
|
|
51
|
+
return null;
|
|
52
|
+
});
|
|
53
|
+
exports.start = start;
|
|
54
|
+
/**
|
|
55
|
+
* Gets Analyze Status.
|
|
56
|
+
*
|
|
57
|
+
* For a given job_id, this method will check the job status.
|
|
58
|
+
*
|
|
59
|
+
* When `status==Success` you'll be able to retrieve your result from the output location you provided in the original POST.
|
|
60
|
+
*
|
|
61
|
+
* @link https://docs.dolby.io/media-apis/reference/media-analyze-get
|
|
62
|
+
*
|
|
63
|
+
* @param auth Your Dolby.io Media API Key or a JWT Token.
|
|
64
|
+
* @param jobId Identifier of the job to retrieve.
|
|
65
|
+
*
|
|
66
|
+
* @returns The `AnalyzeJob` object through a `Promise`.
|
|
67
|
+
*/
|
|
68
|
+
const getResults = (auth, jobId) => __awaiter(void 0, void 0, void 0, function* () {
|
|
69
|
+
const requestOptions = {
|
|
70
|
+
hostname: 'api.dolby.com',
|
|
71
|
+
path: '/media/analyze',
|
|
72
|
+
params: {
|
|
73
|
+
job_id: jobId,
|
|
74
|
+
},
|
|
75
|
+
headers: {},
|
|
76
|
+
auth,
|
|
77
|
+
};
|
|
78
|
+
const response = yield (0, httpHelpers_1.sendGet)(requestOptions);
|
|
79
|
+
return response;
|
|
80
|
+
});
|
|
81
|
+
exports.getResults = getResults;
|
|
82
|
+
//# sourceMappingURL=analyze.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"analyze.js","sourceRoot":"","sources":["../../src/media/analyze.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAA+E;AAI/E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,MAAM,KAAK,GAAG,CAAO,IAAuB,EAAE,UAAkB,EAA0B,EAAE;IAC/F,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,EAAE;QACX,IAAI;QACJ,IAAI,EAAE,UAAU;KACnB,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAQ,EAAC,cAAc,CAAC,CAAC;IAChD,IAAI,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QACnC,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAC7B;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAA,CAAC;AAfW,QAAA,KAAK,SAehB;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,UAAU,GAAG,CAAO,IAAuB,EAAE,KAAa,EAAuB,EAAE;IAC5F,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,gBAAgB;QACtB,MAAM,EAAE;YACJ,MAAM,EAAE,KAAK;SAChB;QACD,OAAO,EAAE,EAAE;QACX,IAAI;KACP,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,qBAAO,EAAC,cAAc,CAAC,CAAC;IAC/C,OAAO,QAAsB,CAAC;AAClC,CAAC,CAAA,CAAC;AAbW,QAAA,UAAU,cAarB"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import JwtToken from './types/jwtToken';
|
|
2
|
+
import { AnalyzeSpeechJob } from './types/analyzeSpeech';
|
|
3
|
+
/**
|
|
4
|
+
* Starts analyzing to learn about speech in your media.
|
|
5
|
+
*
|
|
6
|
+
* The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
|
|
7
|
+
*
|
|
8
|
+
* This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
|
|
9
|
+
*
|
|
10
|
+
* @link https://docs.dolby.io/media-apis/reference/media-analyze-speech-post
|
|
11
|
+
*
|
|
12
|
+
* Beta API
|
|
13
|
+
* This API is being made available as an early preview.
|
|
14
|
+
* If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
|
|
15
|
+
* https://dolby.io/contact
|
|
16
|
+
*
|
|
17
|
+
* @param auth Your Dolby.io Media API Key or a JWT Token.
|
|
18
|
+
* @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-analyze-speech-post
|
|
19
|
+
*
|
|
20
|
+
* @returns The job identifier through a `Promise`.
|
|
21
|
+
*/
|
|
22
|
+
export declare const start: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
|
|
23
|
+
/**
|
|
24
|
+
* Gets Speech Analytics Status.
|
|
25
|
+
*
|
|
26
|
+
* For a given job_id, this method will check if the processing task has completed.
|
|
27
|
+
*
|
|
28
|
+
* When `status` is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original `POST`.
|
|
29
|
+
*
|
|
30
|
+
* @link https://docs.dolby.io/media-apis/reference/media-analyze-speech-get
|
|
31
|
+
*
|
|
32
|
+
* @param auth Your Dolby.io Media API Key or a JWT Token.
|
|
33
|
+
* @param jobId Identifier of the job to retrieve.
|
|
34
|
+
*
|
|
35
|
+
* @returns The `AnalyzeSpeechJob` object through a `Promise`.
|
|
36
|
+
*/
|
|
37
|
+
export declare const getResults: (auth: string | JwtToken, jobId: string) => Promise<AnalyzeSpeechJob>;
|