@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
package/LICENSE
CHANGED
|
@@ -1,121 +1,21 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
the purpose of contributing to a commons of creative, cultural and
|
|
23
|
-
scientific works ("Commons") that the public can reliably and without fear
|
|
24
|
-
of later claims of infringement build upon, modify, incorporate in other
|
|
25
|
-
works, reuse and redistribute as freely as possible in any form whatsoever
|
|
26
|
-
and for any purposes, including without limitation commercial purposes.
|
|
27
|
-
These owners may contribute to the Commons to promote the ideal of a free
|
|
28
|
-
culture and the further production of creative, cultural and scientific
|
|
29
|
-
works, or to gain reputation or greater distribution for their Work in
|
|
30
|
-
part through the use and efforts of others.
|
|
31
|
-
|
|
32
|
-
For these and/or other purposes and motivations, and without any
|
|
33
|
-
expectation of additional consideration or compensation, the person
|
|
34
|
-
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
|
|
35
|
-
is an owner of Copyright and Related Rights in the Work, voluntarily
|
|
36
|
-
elects to apply CC0 to the Work and publicly distribute the Work under its
|
|
37
|
-
terms, with knowledge of his or her Copyright and Related Rights in the
|
|
38
|
-
Work and the meaning and intended legal effect of CC0 on those rights.
|
|
39
|
-
|
|
40
|
-
1. Copyright and Related Rights. A Work made available under CC0 may be
|
|
41
|
-
protected by copyright and related or neighboring rights ("Copyright and
|
|
42
|
-
Related Rights"). Copyright and Related Rights include, but are not
|
|
43
|
-
limited to, the following:
|
|
44
|
-
|
|
45
|
-
i. the right to reproduce, adapt, distribute, perform, display,
|
|
46
|
-
communicate, and translate a Work;
|
|
47
|
-
ii. moral rights retained by the original author(s) and/or performer(s);
|
|
48
|
-
iii. publicity and privacy rights pertaining to a person's image or
|
|
49
|
-
likeness depicted in a Work;
|
|
50
|
-
iv. rights protecting against unfair competition in regards to a Work,
|
|
51
|
-
subject to the limitations in paragraph 4(a), below;
|
|
52
|
-
v. rights protecting the extraction, dissemination, use and reuse of data
|
|
53
|
-
in a Work;
|
|
54
|
-
vi. database rights (such as those arising under Directive 96/9/EC of the
|
|
55
|
-
European Parliament and of the Council of 11 March 1996 on the legal
|
|
56
|
-
protection of databases, and under any national implementation
|
|
57
|
-
thereof, including any amended or successor version of such
|
|
58
|
-
directive); and
|
|
59
|
-
vii. other similar, equivalent or corresponding rights throughout the
|
|
60
|
-
world based on applicable law or treaty, and any national
|
|
61
|
-
implementations thereof.
|
|
62
|
-
|
|
63
|
-
2. Waiver. To the greatest extent permitted by, but not in contravention
|
|
64
|
-
of, applicable law, Affirmer hereby overtly, fully, permanently,
|
|
65
|
-
irrevocably and unconditionally waives, abandons, and surrenders all of
|
|
66
|
-
Affirmer's Copyright and Related Rights and associated claims and causes
|
|
67
|
-
of action, whether now known or unknown (including existing as well as
|
|
68
|
-
future claims and causes of action), in the Work (i) in all territories
|
|
69
|
-
worldwide, (ii) for the maximum duration provided by applicable law or
|
|
70
|
-
treaty (including future time extensions), (iii) in any current or future
|
|
71
|
-
medium and for any number of copies, and (iv) for any purpose whatsoever,
|
|
72
|
-
including without limitation commercial, advertising or promotional
|
|
73
|
-
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
|
|
74
|
-
member of the public at large and to the detriment of Affirmer's heirs and
|
|
75
|
-
successors, fully intending that such Waiver shall not be subject to
|
|
76
|
-
revocation, rescission, cancellation, termination, or any other legal or
|
|
77
|
-
equitable action to disrupt the quiet enjoyment of the Work by the public
|
|
78
|
-
as contemplated by Affirmer's express Statement of Purpose.
|
|
79
|
-
|
|
80
|
-
3. Public License Fallback. Should any part of the Waiver for any reason
|
|
81
|
-
be judged legally invalid or ineffective under applicable law, then the
|
|
82
|
-
Waiver shall be preserved to the maximum extent permitted taking into
|
|
83
|
-
account Affirmer's express Statement of Purpose. In addition, to the
|
|
84
|
-
extent the Waiver is so judged Affirmer hereby grants to each affected
|
|
85
|
-
person a royalty-free, non transferable, non sublicensable, non exclusive,
|
|
86
|
-
irrevocable and unconditional license to exercise Affirmer's Copyright and
|
|
87
|
-
Related Rights in the Work (i) in all territories worldwide, (ii) for the
|
|
88
|
-
maximum duration provided by applicable law or treaty (including future
|
|
89
|
-
time extensions), (iii) in any current or future medium and for any number
|
|
90
|
-
of copies, and (iv) for any purpose whatsoever, including without
|
|
91
|
-
limitation commercial, advertising or promotional purposes (the
|
|
92
|
-
"License"). The License shall be deemed effective as of the date CC0 was
|
|
93
|
-
applied by Affirmer to the Work. Should any part of the License for any
|
|
94
|
-
reason be judged legally invalid or ineffective under applicable law, such
|
|
95
|
-
partial invalidity or ineffectiveness shall not invalidate the remainder
|
|
96
|
-
of the License, and in such case Affirmer hereby affirms that he or she
|
|
97
|
-
will not (i) exercise any of his or her remaining Copyright and Related
|
|
98
|
-
Rights in the Work or (ii) assert any associated claims and causes of
|
|
99
|
-
action with respect to the Work, in either case contrary to Affirmer's
|
|
100
|
-
express Statement of Purpose.
|
|
101
|
-
|
|
102
|
-
4. Limitations and Disclaimers.
|
|
103
|
-
|
|
104
|
-
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
|
105
|
-
surrendered, licensed or otherwise affected by this document.
|
|
106
|
-
b. Affirmer offers the Work as-is and makes no representations or
|
|
107
|
-
warranties of any kind concerning the Work, express, implied,
|
|
108
|
-
statutory or otherwise, including without limitation warranties of
|
|
109
|
-
title, merchantability, fitness for a particular purpose, non
|
|
110
|
-
infringement, or the absence of latent or other defects, accuracy, or
|
|
111
|
-
the present or absence of errors, whether or not discoverable, all to
|
|
112
|
-
the greatest extent permissible under applicable law.
|
|
113
|
-
c. Affirmer disclaims responsibility for clearing rights of other persons
|
|
114
|
-
that may apply to the Work or any use thereof, including without
|
|
115
|
-
limitation any person's Copyright and Related Rights in the Work.
|
|
116
|
-
Further, Affirmer disclaims responsibility for obtaining any necessary
|
|
117
|
-
consents, permissions or other rights required for any use of the
|
|
118
|
-
Work.
|
|
119
|
-
d. Affirmer understands and acknowledges that Creative Commons is not a
|
|
120
|
-
party to this document and has no duty or obligation with respect to
|
|
121
|
-
this CC0 or use of the Work.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 Dolby Laboratories
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Dolby.io REST APIs
|
|
2
2
|
|
|
3
|
-
Node.JS wrapper for the dolby.io REST [Communications](https://docs.dolby.io/
|
|
3
|
+
Node.JS wrapper for the dolby.io REST [Communications](https://docs.dolby.io/communications-apis/reference/authentication-api) and [Media](https://docs.dolby.io/media-processing/reference/media-enhance-overview) APIs.
|
|
4
4
|
|
|
5
5
|
## Install this project
|
|
6
6
|
|
|
@@ -10,7 +10,7 @@ Run the npm command to install the package `@dolbyio/dolbyio-rest-apis-client` i
|
|
|
10
10
|
npm install @dolbyio/dolbyio-rest-apis-client --save
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
## Examples
|
|
13
|
+
## Communications Examples
|
|
14
14
|
|
|
15
15
|
### Authenticate
|
|
16
16
|
|
|
@@ -73,6 +73,23 @@ const conference = await dolbyio.communications.conference.createConference(jwt,
|
|
|
73
73
|
console.log(`Conference created: ${conference.conferenceId}`);
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
+
## Media Examples
|
|
77
|
+
|
|
78
|
+
### Authenticate
|
|
79
|
+
|
|
80
|
+
To get an access token, use the following code:
|
|
81
|
+
|
|
82
|
+
```javascript
|
|
83
|
+
const dolbyio = require('@dolbyio/dolbyio-rest-apis-client');
|
|
84
|
+
|
|
85
|
+
const API_KEY = 'YOUR_API_KEY';
|
|
86
|
+
const API_SECRET = 'YOUR_API_SECRET';
|
|
87
|
+
|
|
88
|
+
const at = await dolbyio.media.platform.getAccessToken(API_KEY, API_SECRET);
|
|
89
|
+
|
|
90
|
+
console.log(`Access Token: ${at.access_token}`);
|
|
91
|
+
```
|
|
92
|
+
|
|
76
93
|
## Build this project
|
|
77
94
|
|
|
78
95
|
To build the `dist` folder, run the command:
|
|
@@ -2,7 +2,7 @@ import JwtToken from './types/jwtToken';
|
|
|
2
2
|
/**
|
|
3
3
|
* Gets an access token to authenticate for API calls.
|
|
4
4
|
*
|
|
5
|
-
* @link https://docs.dolby.io/
|
|
5
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-bearer-token
|
|
6
6
|
*
|
|
7
7
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
8
8
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -14,7 +14,7 @@ export declare const getApiAccessToken: (consumerKey: string, consumerSecret: st
|
|
|
14
14
|
/**
|
|
15
15
|
* Gets a client access token to authenticate a session.
|
|
16
16
|
*
|
|
17
|
-
* @link https://docs.dolby.io/
|
|
17
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-client-access-token
|
|
18
18
|
*
|
|
19
19
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
20
20
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -37,7 +37,7 @@ const getAccessToken = (consumerKey, consumerSecret, hostname, path, expiresIn)
|
|
|
37
37
|
/**
|
|
38
38
|
* Gets an access token to authenticate for API calls.
|
|
39
39
|
*
|
|
40
|
-
* @link https://docs.dolby.io/
|
|
40
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-bearer-token
|
|
41
41
|
*
|
|
42
42
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
43
43
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -52,7 +52,7 @@ exports.getApiAccessToken = getApiAccessToken;
|
|
|
52
52
|
/**
|
|
53
53
|
* Gets a client access token to authenticate a session.
|
|
54
54
|
*
|
|
55
|
-
* @link https://docs.dolby.io/
|
|
55
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-client-access-token
|
|
56
56
|
*
|
|
57
57
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
58
58
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import { CreateConferenceOptions, Conference, UserTokens } from './types/conference';
|
|
2
|
+
import { SpatialEnvironment, SpatialListener, SpatialUsers } from './types/spatialAudio';
|
|
2
3
|
import JwtToken from './types/jwtToken';
|
|
3
4
|
import Participant from './types/participant';
|
|
4
5
|
/**
|
|
5
6
|
* Creates a conference.
|
|
6
7
|
*
|
|
7
|
-
* @link https://docs.dolby.io/
|
|
8
|
+
* @link https://docs.dolby.io/communications-apis/reference/create-conference
|
|
8
9
|
*
|
|
9
10
|
* @param accessToken Access token to use for authentication.
|
|
10
11
|
* @param ownerExternalId External ID of the owner of the conference.
|
|
@@ -16,7 +17,7 @@ export declare const createConference: (accessToken: JwtToken, options: CreateCo
|
|
|
16
17
|
/**
|
|
17
18
|
* Invites participants to an ongoing conference. This API can also be used to generate new conference access tokens for an ongoing conference. If the invite request includes participants that are already in the conference, a new conference access token is not generated and an invitation is not sent.
|
|
18
19
|
*
|
|
19
|
-
* @link https://docs.dolby.io/
|
|
20
|
+
* @link https://docs.dolby.io/communications-apis/reference/invite-to-conference
|
|
20
21
|
*
|
|
21
22
|
* @param accessToken Access token to use for authentication.
|
|
22
23
|
* @param conferenceId Identifier of the conference.
|
|
@@ -28,17 +29,41 @@ export declare const invite: (accessToken: JwtToken, conferenceId: string, parti
|
|
|
28
29
|
/**
|
|
29
30
|
* Kicks participants from an ongoing conference.
|
|
30
31
|
*
|
|
31
|
-
* @link https://docs.dolby.io/
|
|
32
|
+
* @link https://docs.dolby.io/communications-apis/reference/kick-from-conference
|
|
32
33
|
*
|
|
33
34
|
* @param accessToken Access token to use for authentication.
|
|
34
35
|
* @param conferenceId Identifier of the conference.
|
|
35
36
|
* @param externalIds External identifiers of the participants to kick our of the conference.
|
|
36
37
|
*/
|
|
37
38
|
export declare const kick: (accessToken: JwtToken, conferenceId: string, externalIds: Array<string>) => Promise<void>;
|
|
39
|
+
/**
|
|
40
|
+
* Sends a message to some or all participants in a conference.
|
|
41
|
+
*
|
|
42
|
+
* @link https://docs.dolby.io/communications-apis/reference/send-message
|
|
43
|
+
*
|
|
44
|
+
* @param accessToken Access token to use for authentication.
|
|
45
|
+
* @param conferenceId Identifier of the conference.
|
|
46
|
+
* @param fromExternalId The external ID of the author of the message.
|
|
47
|
+
* @param toExternalIds A list of external IDs that will receive the message. If empty, the message will be broadcasted to all participants in the conference.
|
|
48
|
+
* @param message The message to send.
|
|
49
|
+
*/
|
|
50
|
+
export declare const sendMessage: (accessToken: JwtToken, conferenceId: string, fromExternalId: string, toExternalIds: Array<string>, message: string) => Promise<void>;
|
|
51
|
+
/**
|
|
52
|
+
* Sets the spatial audio scene for all listeners in an ongoing conference. This sets the spatial audio environment, the position and direction for all listeners with the spatialAudio flag enabled. The calls are not cumulative, and each call sets all the spatial listener values. Participants who do not have a position set are muted.
|
|
53
|
+
*
|
|
54
|
+
* @link https://docs.dolby.io/communications-apis/reference/set-spatial-listeners-audio
|
|
55
|
+
*
|
|
56
|
+
* @param accessToken Access token to use for authentication.
|
|
57
|
+
* @param conferenceId Identifier of the conference.
|
|
58
|
+
* @param environment The spatial environment of an application, so the audio renderer understands which directions the application considers forward, up, and right and which units it uses for distance.
|
|
59
|
+
* @param listener The listener's audio position and direction, defined using Cartesian coordinates.
|
|
60
|
+
* @param users The users' audio positions, defined using Cartesian coordinates.
|
|
61
|
+
*/
|
|
62
|
+
export declare const setSpatialListenersAudio: (accessToken: JwtToken, conferenceId: string, environment: SpatialEnvironment, listener: SpatialListener, users: SpatialUsers) => Promise<void>;
|
|
38
63
|
/**
|
|
39
64
|
* Update permissions for participants in a conference. When a participant's permissions are updated, the new token is sent directly to the SDK. The SDK automatically receives, stores, and manages the new token and a `permissionsUpdated` event is sent.
|
|
40
65
|
*
|
|
41
|
-
* @link https://docs.dolby.io/
|
|
66
|
+
* @link https://docs.dolby.io/communications-apis/reference/update-permissions
|
|
42
67
|
*
|
|
43
68
|
* @param accessToken Access token to use for authentication.
|
|
44
69
|
* @param conferenceId Identifier of the conference.
|
|
@@ -50,7 +75,7 @@ export declare const updatePermissions: (accessToken: JwtToken, conferenceId: st
|
|
|
50
75
|
/**
|
|
51
76
|
* Terminates an ongoing conference and removes all remaining participants from the conference.
|
|
52
77
|
*
|
|
53
|
-
* @link https://docs.dolby.io/
|
|
78
|
+
* @link https://docs.dolby.io/communications-apis/reference/terminate-conference
|
|
54
79
|
*
|
|
55
80
|
* @param accessToken Access token to use for authentication.
|
|
56
81
|
* @param conferenceId Identifier of the conference.
|
|
@@ -60,7 +85,7 @@ export declare const terminate: (accessToken: JwtToken, conferenceId: string) =>
|
|
|
60
85
|
* @deprecated
|
|
61
86
|
* Destroys an ongoing conference and removes all remaining participants from the conference.
|
|
62
87
|
*
|
|
63
|
-
* @link https://docs.dolby.io/
|
|
88
|
+
* @link https://docs.dolby.io/communications-apis/reference/destroy-conference
|
|
64
89
|
*
|
|
65
90
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
66
91
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -9,13 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
9
9
|
});
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.destroy = exports.terminate = exports.updatePermissions = exports.kick = exports.invite = exports.createConference = void 0;
|
|
12
|
+
exports.destroy = exports.terminate = exports.updatePermissions = exports.setSpatialListenersAudio = exports.sendMessage = exports.kick = exports.invite = exports.createConference = void 0;
|
|
13
13
|
const httpHelpers_1 = require("../internal/httpHelpers");
|
|
14
14
|
const rtcpMode_1 = require("./types/rtcpMode");
|
|
15
15
|
/**
|
|
16
16
|
* Creates a conference.
|
|
17
17
|
*
|
|
18
|
-
* @link https://docs.dolby.io/
|
|
18
|
+
* @link https://docs.dolby.io/communications-apis/reference/create-conference
|
|
19
19
|
*
|
|
20
20
|
* @param accessToken Access token to use for authentication.
|
|
21
21
|
* @param ownerExternalId External ID of the owner of the conference.
|
|
@@ -70,7 +70,7 @@ exports.createConference = createConference;
|
|
|
70
70
|
/**
|
|
71
71
|
* Invites participants to an ongoing conference. This API can also be used to generate new conference access tokens for an ongoing conference. If the invite request includes participants that are already in the conference, a new conference access token is not generated and an invitation is not sent.
|
|
72
72
|
*
|
|
73
|
-
* @link https://docs.dolby.io/
|
|
73
|
+
* @link https://docs.dolby.io/communications-apis/reference/invite-to-conference
|
|
74
74
|
*
|
|
75
75
|
* @param accessToken Access token to use for authentication.
|
|
76
76
|
* @param conferenceId Identifier of the conference.
|
|
@@ -107,7 +107,7 @@ exports.invite = invite;
|
|
|
107
107
|
/**
|
|
108
108
|
* Kicks participants from an ongoing conference.
|
|
109
109
|
*
|
|
110
|
-
* @link https://docs.dolby.io/
|
|
110
|
+
* @link https://docs.dolby.io/communications-apis/reference/kick-from-conference
|
|
111
111
|
*
|
|
112
112
|
* @param accessToken Access token to use for authentication.
|
|
113
113
|
* @param conferenceId Identifier of the conference.
|
|
@@ -130,10 +130,72 @@ const kick = (accessToken, conferenceId, externalIds) => __awaiter(void 0, void
|
|
|
130
130
|
yield (0, httpHelpers_1.sendPost)(options);
|
|
131
131
|
});
|
|
132
132
|
exports.kick = kick;
|
|
133
|
+
/**
|
|
134
|
+
* Sends a message to some or all participants in a conference.
|
|
135
|
+
*
|
|
136
|
+
* @link https://docs.dolby.io/communications-apis/reference/send-message
|
|
137
|
+
*
|
|
138
|
+
* @param accessToken Access token to use for authentication.
|
|
139
|
+
* @param conferenceId Identifier of the conference.
|
|
140
|
+
* @param fromExternalId The external ID of the author of the message.
|
|
141
|
+
* @param toExternalIds A list of external IDs that will receive the message. If empty, the message will be broadcasted to all participants in the conference.
|
|
142
|
+
* @param message The message to send.
|
|
143
|
+
*/
|
|
144
|
+
const sendMessage = (accessToken, conferenceId, fromExternalId, toExternalIds, message) => __awaiter(void 0, void 0, void 0, function* () {
|
|
145
|
+
const body = {
|
|
146
|
+
from: fromExternalId,
|
|
147
|
+
message: message,
|
|
148
|
+
};
|
|
149
|
+
if (toExternalIds && toExternalIds.length > 0) {
|
|
150
|
+
body['to'] = toExternalIds;
|
|
151
|
+
}
|
|
152
|
+
const options = {
|
|
153
|
+
hostname: 'api.voxeet.com',
|
|
154
|
+
path: `/v2/conferences/${conferenceId}/message`,
|
|
155
|
+
headers: {
|
|
156
|
+
Accept: 'application/json',
|
|
157
|
+
'Content-Type': 'application/json',
|
|
158
|
+
Authorization: `${accessToken.token_type} ${accessToken.access_token}`,
|
|
159
|
+
},
|
|
160
|
+
body: JSON.stringify(body),
|
|
161
|
+
};
|
|
162
|
+
yield (0, httpHelpers_1.sendPost)(options);
|
|
163
|
+
});
|
|
164
|
+
exports.sendMessage = sendMessage;
|
|
165
|
+
/**
|
|
166
|
+
* Sets the spatial audio scene for all listeners in an ongoing conference. This sets the spatial audio environment, the position and direction for all listeners with the spatialAudio flag enabled. The calls are not cumulative, and each call sets all the spatial listener values. Participants who do not have a position set are muted.
|
|
167
|
+
*
|
|
168
|
+
* @link https://docs.dolby.io/communications-apis/reference/set-spatial-listeners-audio
|
|
169
|
+
*
|
|
170
|
+
* @param accessToken Access token to use for authentication.
|
|
171
|
+
* @param conferenceId Identifier of the conference.
|
|
172
|
+
* @param environment The spatial environment of an application, so the audio renderer understands which directions the application considers forward, up, and right and which units it uses for distance.
|
|
173
|
+
* @param listener The listener's audio position and direction, defined using Cartesian coordinates.
|
|
174
|
+
* @param users The users' audio positions, defined using Cartesian coordinates.
|
|
175
|
+
*/
|
|
176
|
+
const setSpatialListenersAudio = (accessToken, conferenceId, environment, listener, users) => __awaiter(void 0, void 0, void 0, function* () {
|
|
177
|
+
const body = JSON.stringify({
|
|
178
|
+
environment: environment,
|
|
179
|
+
listener: listener,
|
|
180
|
+
users: users,
|
|
181
|
+
});
|
|
182
|
+
const options = {
|
|
183
|
+
hostname: 'api.voxeet.com',
|
|
184
|
+
path: `/v2/conferences/${conferenceId}/spatial-listeners-audio`,
|
|
185
|
+
headers: {
|
|
186
|
+
Accept: 'application/json',
|
|
187
|
+
'Content-Type': 'application/json',
|
|
188
|
+
Authorization: `${accessToken.token_type} ${accessToken.access_token}`,
|
|
189
|
+
},
|
|
190
|
+
body,
|
|
191
|
+
};
|
|
192
|
+
yield (0, httpHelpers_1.sendPut)(options);
|
|
193
|
+
});
|
|
194
|
+
exports.setSpatialListenersAudio = setSpatialListenersAudio;
|
|
133
195
|
/**
|
|
134
196
|
* Update permissions for participants in a conference. When a participant's permissions are updated, the new token is sent directly to the SDK. The SDK automatically receives, stores, and manages the new token and a `permissionsUpdated` event is sent.
|
|
135
197
|
*
|
|
136
|
-
* @link https://docs.dolby.io/
|
|
198
|
+
* @link https://docs.dolby.io/communications-apis/reference/update-permissions
|
|
137
199
|
*
|
|
138
200
|
* @param accessToken Access token to use for authentication.
|
|
139
201
|
* @param conferenceId Identifier of the conference.
|
|
@@ -170,7 +232,7 @@ exports.updatePermissions = updatePermissions;
|
|
|
170
232
|
/**
|
|
171
233
|
* Terminates an ongoing conference and removes all remaining participants from the conference.
|
|
172
234
|
*
|
|
173
|
-
* @link https://docs.dolby.io/
|
|
235
|
+
* @link https://docs.dolby.io/communications-apis/reference/terminate-conference
|
|
174
236
|
*
|
|
175
237
|
* @param accessToken Access token to use for authentication.
|
|
176
238
|
* @param conferenceId Identifier of the conference.
|
|
@@ -192,7 +254,7 @@ exports.terminate = terminate;
|
|
|
192
254
|
* @deprecated
|
|
193
255
|
* Destroys an ongoing conference and removes all remaining participants from the conference.
|
|
194
256
|
*
|
|
195
|
-
* @link https://docs.dolby.io/
|
|
257
|
+
* @link https://docs.dolby.io/communications-apis/reference/destroy-conference
|
|
196
258
|
*
|
|
197
259
|
* @param consumerKey Your Dolby.io Consumer Key.
|
|
198
260
|
* @param consumerSecret Your Dolby.io Consumer Secret.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conference.js","sourceRoot":"","sources":["../../src/communications/conference.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"conference.js","sourceRoot":"","sources":["../../src/communications/conference.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAwE;AAKxE,+CAA4C;AAE5C;;;;;;;;;;GAUG;AACI,MAAM,gBAAgB,GAAG,CAAO,WAAqB,EAAE,OAAgC,EAAuB,EAAE;IACnH,MAAM,UAAU,GAAG;QACf,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI;QAC1D,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK;QACpE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,mBAAQ,CAAC,OAAO;KACnE,CAAC;IAEF,IAAI,OAAO,CAAC,OAAO;QAAE,UAAU,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAC7D,IAAI,OAAO,CAAC,GAAG;QAAE,UAAU,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IACjD,IAAI,OAAO,CAAC,UAAU;QAAE,UAAU,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;IAEtE,MAAM,IAAI,GAAG;QACT,eAAe,EAAE,OAAO,CAAC,eAAe;QACxC,UAAU,EAAE,UAAU;KACzB,CAAC;IACF,IAAI,OAAO,CAAC,KAAK;QAAE,IAAI,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;IAEjD,IAAI,OAAO,CAAC,YAAY,EAAE;QACtB,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAC9D,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAChD,gBAAgB,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG;gBACvC,WAAW,EAAE,WAAW,CAAC,WAAW;gBACpC,YAAY,EAAE,WAAW,CAAC,MAAM;aACnC,CAAC;SACL;QACD,IAAI,CAAC,cAAc,CAAC,GAAG,gBAAgB,CAAC;KAC3C;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAErC,MAAM,cAAc,GAAG;QACnB,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;QACD,IAAI,EAAE,OAAO;KAChB,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAQ,EAAC,cAAc,CAAC,CAAC;IAChD,OAAO,QAAsB,CAAC;AAClC,CAAC,CAAA,CAAC;AA5CW,QAAA,gBAAgB,oBA4C3B;AAEF;;;;;;;;;;GAUG;AACI,MAAM,MAAM,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAE,YAAgC,EAAuB,EAAE;IAC/H,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACtD,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACxC,gBAAgB,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG;YACvC,WAAW,EAAE,WAAW,CAAC,WAAW;YACpC,YAAY,EAAE,WAAW,CAAC,MAAM;SACnC,CAAC;KACL;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QACxB,YAAY,EAAE,gBAAgB;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,mBAAmB,YAAY,SAAS;QAC9C,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;QACD,IAAI;KACP,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;IACzC,OAAO,QAAsB,CAAC;AAClC,CAAC,CAAA,CAAC;AA3BW,QAAA,MAAM,UA2BjB;AAEF;;;;;;;;GAQG;AACI,MAAM,IAAI,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAE,WAA0B,EAAiB,EAAE;IACjH,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QACxB,WAAW,EAAE,WAAW;KAC3B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,mBAAmB,YAAY,OAAO;QAC5C,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;QACD,IAAI;KACP,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAjBW,QAAA,IAAI,QAiBf;AAEF;;;;;;;;;;GAUG;AACI,MAAM,WAAW,GAAG,CACvB,WAAqB,EACrB,YAAoB,EACpB,cAAsB,EACtB,aAA4B,EAC5B,OAAe,EACF,EAAE;IACf,MAAM,IAAI,GAAG;QACT,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,OAAO;KACnB,CAAC;IAEF,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC;KAC9B;IAED,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,mBAAmB,YAAY,UAAU;QAC/C,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;KAC7B,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AA5BW,QAAA,WAAW,eA4BtB;AAEF;;;;;;;;;;GAUG;AACI,MAAM,wBAAwB,GAAG,CACpC,WAAqB,EACrB,YAAoB,EACpB,WAA+B,EAC/B,QAAyB,EACzB,KAAmB,EACN,EAAE;IACf,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QACxB,WAAW,EAAE,WAAW;QACxB,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,mBAAmB,YAAY,0BAA0B;QAC/D,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;QACD,IAAI;KACP,CAAC;IAEF,MAAM,IAAA,qBAAO,EAAC,OAAO,CAAC,CAAC;AAC3B,CAAC,CAAA,CAAC;AAzBW,QAAA,wBAAwB,4BAyBnC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,iBAAiB,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAE,YAAgC,EAAuB,EAAE;IAC1I,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACtD,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACxC,gBAAgB,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG;YACvC,WAAW,EAAE,WAAW,CAAC,WAAW;YACpC,YAAY,EAAE,WAAW,CAAC,MAAM;SACnC,CAAC;KACL;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QACxB,YAAY,EAAE,gBAAgB;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,mBAAmB,YAAY,SAAS;QAC9C,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;QACD,IAAI;KACP,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;IACzC,OAAO,QAAsB,CAAC;AAClC,CAAC,CAAA,CAAC;AA3BW,QAAA,iBAAiB,qBA2B5B;AAEF;;;;;;;GAOG;AACI,MAAM,SAAS,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAiB,EAAE;IAC1F,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,gBAAgB;QAC1B,IAAI,EAAE,mBAAmB,YAAY,EAAE;QACvC,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,wBAAU,EAAC,OAAO,CAAC,CAAC;AAC9B,CAAC,CAAA,CAAC;AAZW,QAAA,SAAS,aAYpB;AAEF;;;;;;;;;GASG;AACI,MAAM,OAAO,GAAG,CAAO,WAAmB,EAAE,cAAsB,EAAE,YAAoB,EAAiB,EAAE;IAC9G,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,mBAAmB,YAAY,UAAU;QAC/C,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,OAAO,WAclB"}
|
|
@@ -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];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/communications/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/communications/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AAK1C,wCAAc;AAJvB,yDAA2C;AAIlB,gCAAU;AAHnC,uDAAyC;AAGJ,8BAAS;AAF9C,mDAAqC;AAEW,0BAAO"}
|
|
@@ -7,7 +7,7 @@ import { ListConferencesOptions, ListAllConferencesOptions, ListConferencesRespo
|
|
|
7
7
|
* **Note:** Only terminated conferences include a complete summary.
|
|
8
8
|
* The summary of ongoing conferences includes the following fields in the response: `confId`, `alias`, `region`, `dolbyVoice`, `start`, `live`, `owner`.
|
|
9
9
|
*
|
|
10
|
-
* @link https://docs.dolby.io/
|
|
10
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conferences
|
|
11
11
|
*
|
|
12
12
|
* @param accessToken Access token to use for authentication.
|
|
13
13
|
* @param options Options to request the conferences.
|
|
@@ -21,7 +21,7 @@ export declare const listConferences: (accessToken: JwtToken, options: ListConfe
|
|
|
21
21
|
* **Note:** Only terminated conferences include a complete summary.
|
|
22
22
|
* The summary of ongoing conferences includes the following fields in the response: `confId`, `alias`, `region`, `dolbyVoice`, `start`, `live`, `owner`.
|
|
23
23
|
*
|
|
24
|
-
* @link https://docs.dolby.io/
|
|
24
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conferences
|
|
25
25
|
*
|
|
26
26
|
* @param accessToken Access token to use for authentication.
|
|
27
27
|
* @param options Options to request the conferences.
|
|
@@ -35,7 +35,7 @@ export declare const listAllConferences: (accessToken: JwtToken, options: ListAl
|
|
|
35
35
|
* **Note:** Only terminated conferences include a complete summary.
|
|
36
36
|
* The summary of ongoing conferences includes the following fields in the response: `confId`, `alias`, `region`, `dolbyVoice`, `start`, `live`, `owner`.
|
|
37
37
|
*
|
|
38
|
-
* @link https://docs.dolby.io/
|
|
38
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conference-summary
|
|
39
39
|
*
|
|
40
40
|
* @param accessToken Access token to use for authentication.
|
|
41
41
|
* @param conferenceId The identifier of the conference.
|
|
@@ -49,7 +49,7 @@ export declare const getConference: (accessToken: JwtToken, conferenceId: string
|
|
|
49
49
|
*
|
|
50
50
|
* **Note:** Only terminated conferences include a complete summary.
|
|
51
51
|
*
|
|
52
|
-
* @link https://docs.dolby.io/
|
|
52
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conference-statistics
|
|
53
53
|
*
|
|
54
54
|
* @param accessToken Access token to use for authentication.
|
|
55
55
|
* @param conferenceId The identifier of the conference.
|
|
@@ -60,7 +60,7 @@ export declare const getConferenceStatistics: (accessToken: JwtToken, conference
|
|
|
60
60
|
/**
|
|
61
61
|
* Get statistics and connection details of all participants in a conference. Optionally limit the search result with a specific time range.
|
|
62
62
|
*
|
|
63
|
-
* @link https://docs.dolby.io/
|
|
63
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-info-conference-participants
|
|
64
64
|
*
|
|
65
65
|
* @param accessToken Access token to use for authentication.
|
|
66
66
|
* @param options Options to request the participants.
|
|
@@ -71,7 +71,7 @@ export declare const getConferenceParticipants: (accessToken: JwtToken, options:
|
|
|
71
71
|
/**
|
|
72
72
|
* Get statistics and connection details of all participants in a conference. Optionally limit the search result with a specific time range.
|
|
73
73
|
*
|
|
74
|
-
* @link https://docs.dolby.io/
|
|
74
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-info-conference-participants
|
|
75
75
|
*
|
|
76
76
|
* @param accessToken Access token to use for authentication.
|
|
77
77
|
* @param options Options to request the participants.
|
|
@@ -18,7 +18,7 @@ const httpHelpers_2 = require("../internal/httpHelpers");
|
|
|
18
18
|
* **Note:** Only terminated conferences include a complete summary.
|
|
19
19
|
* The summary of ongoing conferences includes the following fields in the response: `confId`, `alias`, `region`, `dolbyVoice`, `start`, `live`, `owner`.
|
|
20
20
|
*
|
|
21
|
-
* @link https://docs.dolby.io/
|
|
21
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conferences
|
|
22
22
|
*
|
|
23
23
|
* @param accessToken Access token to use for authentication.
|
|
24
24
|
* @param options Options to request the conferences.
|
|
@@ -69,7 +69,7 @@ exports.listConferences = listConferences;
|
|
|
69
69
|
* **Note:** Only terminated conferences include a complete summary.
|
|
70
70
|
* The summary of ongoing conferences includes the following fields in the response: `confId`, `alias`, `region`, `dolbyVoice`, `start`, `live`, `owner`.
|
|
71
71
|
*
|
|
72
|
-
* @link https://docs.dolby.io/
|
|
72
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conferences
|
|
73
73
|
*
|
|
74
74
|
* @param accessToken Access token to use for authentication.
|
|
75
75
|
* @param options Options to request the conferences.
|
|
@@ -116,7 +116,7 @@ exports.listAllConferences = listAllConferences;
|
|
|
116
116
|
* **Note:** Only terminated conferences include a complete summary.
|
|
117
117
|
* The summary of ongoing conferences includes the following fields in the response: `confId`, `alias`, `region`, `dolbyVoice`, `start`, `live`, `owner`.
|
|
118
118
|
*
|
|
119
|
-
* @link https://docs.dolby.io/
|
|
119
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conference-summary
|
|
120
120
|
*
|
|
121
121
|
* @param accessToken Access token to use for authentication.
|
|
122
122
|
* @param conferenceId The identifier of the conference.
|
|
@@ -142,7 +142,7 @@ exports.getConference = getConference;
|
|
|
142
142
|
*
|
|
143
143
|
* **Note:** Only terminated conferences include a complete summary.
|
|
144
144
|
*
|
|
145
|
-
* @link https://docs.dolby.io/
|
|
145
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-conference-statistics
|
|
146
146
|
*
|
|
147
147
|
* @param accessToken Access token to use for authentication.
|
|
148
148
|
* @param conferenceId The identifier of the conference.
|
|
@@ -165,7 +165,7 @@ exports.getConferenceStatistics = getConferenceStatistics;
|
|
|
165
165
|
/**
|
|
166
166
|
* Get statistics and connection details of all participants in a conference. Optionally limit the search result with a specific time range.
|
|
167
167
|
*
|
|
168
|
-
* @link https://docs.dolby.io/
|
|
168
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-info-conference-participants
|
|
169
169
|
*
|
|
170
170
|
* @param accessToken Access token to use for authentication.
|
|
171
171
|
* @param options Options to request the participants.
|
|
@@ -211,7 +211,7 @@ exports.getConferenceParticipants = getConferenceParticipants;
|
|
|
211
211
|
/**
|
|
212
212
|
* Get statistics and connection details of all participants in a conference. Optionally limit the search result with a specific time range.
|
|
213
213
|
*
|
|
214
|
-
* @link https://docs.dolby.io/
|
|
214
|
+
* @link https://docs.dolby.io/communications-apis/reference/get-info-conference-participants
|
|
215
215
|
*
|
|
216
216
|
* @param accessToken Access token to use for authentication.
|
|
217
217
|
* @param options Options to request the participants.
|
|
@@ -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];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/communications/monitor/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/communications/monitor/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAA6C;AAIpC,kCAAW;AAHpB,yDAA2C;AAGrB,gCAAU;AAFhC,qDAAuC;AAEL,4BAAQ"}
|