@aws-sdk/client-kinesis-video-webrtc-storage 3.623.0 → 3.624.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/README.md CHANGED
@@ -6,6 +6,8 @@
6
6
 
7
7
  AWS SDK for JavaScript KinesisVideoWebRTCStorage Client for Node.js, Browser and React Native.
8
8
 
9
+ <fullname>webrtc</fullname>
10
+
9
11
  <p>
10
12
  </p>
11
13
 
@@ -218,3 +220,11 @@ JoinStorageSession
218
220
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis-video-webrtc-storage/command/JoinStorageSessionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-video-webrtc-storage/Interface/JoinStorageSessionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-video-webrtc-storage/Interface/JoinStorageSessionCommandOutput/)
219
221
 
220
222
  </details>
223
+ <details>
224
+ <summary>
225
+ JoinStorageSessionAsViewer
226
+ </summary>
227
+
228
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis-video-webrtc-storage/command/JoinStorageSessionAsViewerCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-video-webrtc-storage/Interface/JoinStorageSessionAsViewerCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-video-webrtc-storage/Interface/JoinStorageSessionAsViewerCommandOutput/)
229
+
230
+ </details>
package/dist-cjs/index.js CHANGED
@@ -21,10 +21,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
21
21
  // src/index.ts
22
22
  var src_exports = {};
23
23
  __export(src_exports, {
24
- $Command: () => import_smithy_client.Command,
25
24
  AccessDeniedException: () => AccessDeniedException,
26
25
  ClientLimitExceededException: () => ClientLimitExceededException,
27
26
  InvalidArgumentException: () => InvalidArgumentException,
27
+ JoinStorageSessionAsViewerCommand: () => JoinStorageSessionAsViewerCommand,
28
28
  JoinStorageSessionCommand: () => JoinStorageSessionCommand,
29
29
  KinesisVideoWebRTCStorage: () => KinesisVideoWebRTCStorage,
30
30
  KinesisVideoWebRTCStorageClient: () => KinesisVideoWebRTCStorageClient,
@@ -174,7 +174,7 @@ var KinesisVideoWebRTCStorageClient = _KinesisVideoWebRTCStorageClient;
174
174
  // src/KinesisVideoWebRTCStorage.ts
175
175
 
176
176
 
177
- // src/commands/JoinStorageSessionCommand.ts
177
+ // src/commands/JoinStorageSessionAsViewerCommand.ts
178
178
 
179
179
  var import_middleware_serde = require("@smithy/middleware-serde");
180
180
 
@@ -284,6 +284,22 @@ var se_JoinStorageSessionCommand = /* @__PURE__ */ __name(async (input, context)
284
284
  b.m("POST").h(headers).b(body);
285
285
  return b.build();
286
286
  }, "se_JoinStorageSessionCommand");
287
+ var se_JoinStorageSessionAsViewerCommand = /* @__PURE__ */ __name(async (input, context) => {
288
+ const b = (0, import_core.requestBuilder)(input, context);
289
+ const headers = {
290
+ "content-type": "application/json"
291
+ };
292
+ b.bp("/joinStorageSessionAsViewer");
293
+ let body;
294
+ body = JSON.stringify(
295
+ (0, import_smithy_client.take)(input, {
296
+ channelArn: [],
297
+ clientId: []
298
+ })
299
+ );
300
+ b.m("POST").h(headers).b(body);
301
+ return b.build();
302
+ }, "se_JoinStorageSessionAsViewerCommand");
287
303
  var de_JoinStorageSessionCommand = /* @__PURE__ */ __name(async (output, context) => {
288
304
  if (output.statusCode !== 200 && output.statusCode >= 300) {
289
305
  return de_CommandError(output, context);
@@ -294,6 +310,16 @@ var de_JoinStorageSessionCommand = /* @__PURE__ */ __name(async (output, context
294
310
  await (0, import_smithy_client.collectBody)(output.body, context);
295
311
  return contents;
296
312
  }, "de_JoinStorageSessionCommand");
313
+ var de_JoinStorageSessionAsViewerCommand = /* @__PURE__ */ __name(async (output, context) => {
314
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
315
+ return de_CommandError(output, context);
316
+ }
317
+ const contents = (0, import_smithy_client.map)({
318
+ $metadata: deserializeMetadata(output)
319
+ });
320
+ await (0, import_smithy_client.collectBody)(output.body, context);
321
+ return contents;
322
+ }, "de_JoinStorageSessionAsViewerCommand");
297
323
  var de_CommandError = /* @__PURE__ */ __name(async (output, context) => {
298
324
  const parsedOutput = {
299
325
  ...output,
@@ -382,7 +408,23 @@ var deserializeMetadata = /* @__PURE__ */ __name((output) => ({
382
408
  cfId: output.headers["x-amz-cf-id"]
383
409
  }), "deserializeMetadata");
384
410
 
411
+ // src/commands/JoinStorageSessionAsViewerCommand.ts
412
+ var _JoinStorageSessionAsViewerCommand = class _JoinStorageSessionAsViewerCommand extends import_smithy_client.Command.classBuilder().ep({
413
+ ...commonParams
414
+ }).m(function(Command, cs, config, o) {
415
+ return [
416
+ (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
417
+ (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
418
+ ];
419
+ }).s("AWSAcuityRoutingServiceLambda", "JoinStorageSessionAsViewer", {}).n("KinesisVideoWebRTCStorageClient", "JoinStorageSessionAsViewerCommand").f(void 0, void 0).ser(se_JoinStorageSessionAsViewerCommand).de(de_JoinStorageSessionAsViewerCommand).build() {
420
+ };
421
+ __name(_JoinStorageSessionAsViewerCommand, "JoinStorageSessionAsViewerCommand");
422
+ var JoinStorageSessionAsViewerCommand = _JoinStorageSessionAsViewerCommand;
423
+
385
424
  // src/commands/JoinStorageSessionCommand.ts
425
+
426
+
427
+
386
428
  var _JoinStorageSessionCommand = class _JoinStorageSessionCommand extends import_smithy_client.Command.classBuilder().ep({
387
429
  ...commonParams
388
430
  }).m(function(Command, cs, config, o) {
@@ -397,7 +439,8 @@ var JoinStorageSessionCommand = _JoinStorageSessionCommand;
397
439
 
398
440
  // src/KinesisVideoWebRTCStorage.ts
399
441
  var commands = {
400
- JoinStorageSessionCommand
442
+ JoinStorageSessionCommand,
443
+ JoinStorageSessionAsViewerCommand
401
444
  };
402
445
  var _KinesisVideoWebRTCStorage = class _KinesisVideoWebRTCStorage extends KinesisVideoWebRTCStorageClient {
403
446
  };
@@ -412,6 +455,7 @@ var KinesisVideoWebRTCStorage = _KinesisVideoWebRTCStorage;
412
455
  KinesisVideoWebRTCStorageClient,
413
456
  KinesisVideoWebRTCStorage,
414
457
  $Command,
458
+ JoinStorageSessionAsViewerCommand,
415
459
  JoinStorageSessionCommand,
416
460
  AccessDeniedException,
417
461
  ClientLimitExceededException,
@@ -1,8 +1,10 @@
1
1
  import { createAggregatedClient } from "@smithy/smithy-client";
2
+ import { JoinStorageSessionAsViewerCommand, } from "./commands/JoinStorageSessionAsViewerCommand";
2
3
  import { JoinStorageSessionCommand, } from "./commands/JoinStorageSessionCommand";
3
4
  import { KinesisVideoWebRTCStorageClient, } from "./KinesisVideoWebRTCStorageClient";
4
5
  const commands = {
5
6
  JoinStorageSessionCommand,
7
+ JoinStorageSessionAsViewerCommand,
6
8
  };
7
9
  export class KinesisVideoWebRTCStorage extends KinesisVideoWebRTCStorageClient {
8
10
  }
@@ -0,0 +1,24 @@
1
+ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
2
+ import { getSerdePlugin } from "@smithy/middleware-serde";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { commonParams } from "../endpoint/EndpointParameters";
5
+ import { de_JoinStorageSessionAsViewerCommand, se_JoinStorageSessionAsViewerCommand } from "../protocols/Aws_restJson1";
6
+ export { $Command };
7
+ export class JoinStorageSessionAsViewerCommand extends $Command
8
+ .classBuilder()
9
+ .ep({
10
+ ...commonParams,
11
+ })
12
+ .m(function (Command, cs, config, o) {
13
+ return [
14
+ getSerdePlugin(config, this.serialize, this.deserialize),
15
+ getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
16
+ ];
17
+ })
18
+ .s("AWSAcuityRoutingServiceLambda", "JoinStorageSessionAsViewer", {})
19
+ .n("KinesisVideoWebRTCStorageClient", "JoinStorageSessionAsViewerCommand")
20
+ .f(void 0, void 0)
21
+ .ser(se_JoinStorageSessionAsViewerCommand)
22
+ .de(de_JoinStorageSessionAsViewerCommand)
23
+ .build() {
24
+ }
@@ -1 +1,2 @@
1
+ export * from "./JoinStorageSessionAsViewerCommand";
1
2
  export * from "./JoinStorageSessionCommand";
@@ -16,6 +16,20 @@ export const se_JoinStorageSessionCommand = async (input, context) => {
16
16
  b.m("POST").h(headers).b(body);
17
17
  return b.build();
18
18
  };
19
+ export const se_JoinStorageSessionAsViewerCommand = async (input, context) => {
20
+ const b = rb(input, context);
21
+ const headers = {
22
+ "content-type": "application/json",
23
+ };
24
+ b.bp("/joinStorageSessionAsViewer");
25
+ let body;
26
+ body = JSON.stringify(take(input, {
27
+ channelArn: [],
28
+ clientId: [],
29
+ }));
30
+ b.m("POST").h(headers).b(body);
31
+ return b.build();
32
+ };
19
33
  export const de_JoinStorageSessionCommand = async (output, context) => {
20
34
  if (output.statusCode !== 200 && output.statusCode >= 300) {
21
35
  return de_CommandError(output, context);
@@ -26,6 +40,16 @@ export const de_JoinStorageSessionCommand = async (output, context) => {
26
40
  await collectBody(output.body, context);
27
41
  return contents;
28
42
  };
43
+ export const de_JoinStorageSessionAsViewerCommand = async (output, context) => {
44
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
45
+ return de_CommandError(output, context);
46
+ }
47
+ const contents = map({
48
+ $metadata: deserializeMetadata(output),
49
+ });
50
+ await collectBody(output.body, context);
51
+ return contents;
52
+ };
29
53
  const de_CommandError = async (output, context) => {
30
54
  const parsedOutput = {
31
55
  ...output,
@@ -1,4 +1,5 @@
1
1
  import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
2
+ import { JoinStorageSessionAsViewerCommandInput, JoinStorageSessionAsViewerCommandOutput } from "./commands/JoinStorageSessionAsViewerCommand";
2
3
  import { JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput } from "./commands/JoinStorageSessionCommand";
3
4
  import { KinesisVideoWebRTCStorageClient } from "./KinesisVideoWebRTCStorageClient";
4
5
  export interface KinesisVideoWebRTCStorage {
@@ -8,9 +9,16 @@ export interface KinesisVideoWebRTCStorage {
8
9
  joinStorageSession(args: JoinStorageSessionCommandInput, options?: __HttpHandlerOptions): Promise<JoinStorageSessionCommandOutput>;
9
10
  joinStorageSession(args: JoinStorageSessionCommandInput, cb: (err: any, data?: JoinStorageSessionCommandOutput) => void): void;
10
11
  joinStorageSession(args: JoinStorageSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinStorageSessionCommandOutput) => void): void;
12
+ /**
13
+ * @see {@link JoinStorageSessionAsViewerCommand}
14
+ */
15
+ joinStorageSessionAsViewer(args: JoinStorageSessionAsViewerCommandInput, options?: __HttpHandlerOptions): Promise<JoinStorageSessionAsViewerCommandOutput>;
16
+ joinStorageSessionAsViewer(args: JoinStorageSessionAsViewerCommandInput, cb: (err: any, data?: JoinStorageSessionAsViewerCommandOutput) => void): void;
17
+ joinStorageSessionAsViewer(args: JoinStorageSessionAsViewerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinStorageSessionAsViewerCommandOutput) => void): void;
11
18
  }
12
19
  /**
13
- * <p>
20
+ * <fullname>webrtc</fullname>
21
+ * <p>
14
22
  * </p>
15
23
  * @public
16
24
  */
@@ -7,6 +7,7 @@ import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol
7
7
  import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
8
8
  import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
9
  import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
10
+ import { JoinStorageSessionAsViewerCommandInput, JoinStorageSessionAsViewerCommandOutput } from "./commands/JoinStorageSessionAsViewerCommand";
10
11
  import { JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput } from "./commands/JoinStorageSessionCommand";
11
12
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
12
13
  import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
@@ -14,11 +15,11 @@ export { __Client };
14
15
  /**
15
16
  * @public
16
17
  */
17
- export type ServiceInputTypes = JoinStorageSessionCommandInput;
18
+ export type ServiceInputTypes = JoinStorageSessionAsViewerCommandInput | JoinStorageSessionCommandInput;
18
19
  /**
19
20
  * @public
20
21
  */
21
- export type ServiceOutputTypes = JoinStorageSessionCommandOutput;
22
+ export type ServiceOutputTypes = JoinStorageSessionAsViewerCommandOutput | JoinStorageSessionCommandOutput;
22
23
  /**
23
24
  * @public
24
25
  */
@@ -152,7 +153,8 @@ export type KinesisVideoWebRTCStorageClientResolvedConfigType = __SmithyResolved
152
153
  export interface KinesisVideoWebRTCStorageClientResolvedConfig extends KinesisVideoWebRTCStorageClientResolvedConfigType {
153
154
  }
154
155
  /**
155
- * <p>
156
+ * <fullname>webrtc</fullname>
157
+ * <p>
156
158
  * </p>
157
159
  * @public
158
160
  */
@@ -0,0 +1,90 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { KinesisVideoWebRTCStorageClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoWebRTCStorageClient";
4
+ import { JoinStorageSessionAsViewerInput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link JoinStorageSessionAsViewerCommand}.
14
+ */
15
+ export interface JoinStorageSessionAsViewerCommandInput extends JoinStorageSessionAsViewerInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link JoinStorageSessionAsViewerCommand}.
21
+ */
22
+ export interface JoinStorageSessionAsViewerCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const JoinStorageSessionAsViewerCommand_base: {
25
+ new (input: JoinStorageSessionAsViewerCommandInput): import("@smithy/smithy-client").CommandImpl<JoinStorageSessionAsViewerCommandInput, JoinStorageSessionAsViewerCommandOutput, KinesisVideoWebRTCStorageClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: JoinStorageSessionAsViewerCommandInput): import("@smithy/smithy-client").CommandImpl<JoinStorageSessionAsViewerCommandInput, JoinStorageSessionAsViewerCommandOutput, KinesisVideoWebRTCStorageClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Join the ongoing one way-video and/or multi-way audio WebRTC session as
32
+ * a viewer for an input channel. If there’s
33
+ * no existing session for the channel, create a new streaming session and provide
34
+ * the Amazon Resource Name (ARN) of the signaling channel (<code>channelArn</code>)
35
+ * and client id (<code>clientId</code>).
36
+ * </p>
37
+ * <p>Currently for <code>SINGLE_MASTER</code> type, a video producing device
38
+ * is able to ingest both audio and video media into a stream, while viewers
39
+ * can only ingest audio. Both a video producing device and viewers can join
40
+ * a session first and wait for other participants. While participants are having peer to peer conversations through WebRTC,
41
+ * the ingested media session will be stored into the Kinesis Video Stream.
42
+ * Multiple viewers are able to playback real-time media.
43
+ * </p>
44
+ * <p>Customers can also use existing Kinesis Video Streams features like
45
+ * <code>HLS</code> or <code>DASH</code> playback, Image generation, and more
46
+ * with ingested WebRTC media. If there’s an existing session with the same
47
+ * <code>clientId</code> that's found in the join session request, the new request takes precedence.</p>
48
+ * @example
49
+ * Use a bare-bones client and the command you need to make an API call.
50
+ * ```javascript
51
+ * import { KinesisVideoWebRTCStorageClient, JoinStorageSessionAsViewerCommand } from "@aws-sdk/client-kinesis-video-webrtc-storage"; // ES Modules import
52
+ * // const { KinesisVideoWebRTCStorageClient, JoinStorageSessionAsViewerCommand } = require("@aws-sdk/client-kinesis-video-webrtc-storage"); // CommonJS import
53
+ * const client = new KinesisVideoWebRTCStorageClient(config);
54
+ * const input = { // JoinStorageSessionAsViewerInput
55
+ * channelArn: "STRING_VALUE", // required
56
+ * clientId: "STRING_VALUE", // required
57
+ * };
58
+ * const command = new JoinStorageSessionAsViewerCommand(input);
59
+ * const response = await client.send(command);
60
+ * // {};
61
+ *
62
+ * ```
63
+ *
64
+ * @param JoinStorageSessionAsViewerCommandInput - {@link JoinStorageSessionAsViewerCommandInput}
65
+ * @returns {@link JoinStorageSessionAsViewerCommandOutput}
66
+ * @see {@link JoinStorageSessionAsViewerCommandInput} for command's `input` shape.
67
+ * @see {@link JoinStorageSessionAsViewerCommandOutput} for command's `response` shape.
68
+ * @see {@link KinesisVideoWebRTCStorageClientResolvedConfig | config} for KinesisVideoWebRTCStorageClient's `config` shape.
69
+ *
70
+ * @throws {@link AccessDeniedException} (client fault)
71
+ * <p>You do not have required permissions to perform this operation.</p>
72
+ *
73
+ * @throws {@link ClientLimitExceededException} (client fault)
74
+ * <p>
75
+ * Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
76
+ * </p>
77
+ *
78
+ * @throws {@link InvalidArgumentException} (client fault)
79
+ * <p>The value for this input parameter is invalid.</p>
80
+ *
81
+ * @throws {@link ResourceNotFoundException} (client fault)
82
+ * <p>The specified resource is not found.</p>
83
+ *
84
+ * @throws {@link KinesisVideoWebRTCStorageServiceException}
85
+ * <p>Base exception class for all service exceptions from KinesisVideoWebRTCStorage service.</p>
86
+ *
87
+ * @public
88
+ */
89
+ export declare class JoinStorageSessionAsViewerCommand extends JoinStorageSessionAsViewerCommand_base {
90
+ }
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { KinesisVideoWebRTCStorageClientResolvedConfig } from "../KinesisVideoWebRTCStorageClient";
3
+ import { KinesisVideoWebRTCStorageClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoWebRTCStorageClient";
4
4
  import { JoinStorageSessionInput } from "../models/models_0";
5
5
  /**
6
6
  * @public
@@ -22,33 +22,66 @@ export interface JoinStorageSessionCommandInput extends JoinStorageSessionInput
22
22
  export interface JoinStorageSessionCommandOutput extends __MetadataBearer {
23
23
  }
24
24
  declare const JoinStorageSessionCommand_base: {
25
- new (input: JoinStorageSessionCommandInput): import("@smithy/smithy-client").CommandImpl<JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput, KinesisVideoWebRTCStorageClientResolvedConfig, JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput>;
26
- new (__0_0: JoinStorageSessionCommandInput): import("@smithy/smithy-client").CommandImpl<JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput, KinesisVideoWebRTCStorageClientResolvedConfig, JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput>;
25
+ new (input: JoinStorageSessionCommandInput): import("@smithy/smithy-client").CommandImpl<JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput, KinesisVideoWebRTCStorageClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: JoinStorageSessionCommandInput): import("@smithy/smithy-client").CommandImpl<JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput, KinesisVideoWebRTCStorageClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Join the ongoing one way-video and/or multi-way audio WebRTC session as
32
- * a video producing device for an input channel. If there’s no existing
33
- * session for the channel, a new streaming session needs to be created, and the
34
- * Amazon Resource Name (ARN) of the signaling channel must be provided.
35
- * </p>
30
+ * <note>
31
+ * <p>Before using this API, you must call the <code>GetSignalingChannelEndpoint</code> API to request the WEBRTC endpoint. You then specify the endpoint and region in your <code>JoinStorageSession</code> API request.</p>
32
+ * </note>
33
+ * <p>Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing
34
+ * device for an input channel. If there’s no existing session for the channel, a new streaming
35
+ * session needs to be created, and the Amazon Resource Name (ARN) of the signaling channel must
36
+ * be provided. </p>
36
37
  * <p>Currently for the <code>SINGLE_MASTER</code> type, a video producing
37
- * device is able to ingest both audio and video media into a stream,
38
- * while viewers can only ingest audio. Both a video producing device
39
- * and viewers can join the session first, and wait for other participants.</p>
40
- * <p>While participants are having peer to peer conversations through webRTC,
41
- * the ingested media session will be stored into the Kinesis Video Stream.
42
- * Multiple viewers are able to playback real-time media.</p>
43
- * <p>Customers can also use existing Kinesis Video Streams features like
44
- * <code>HLS</code> or <code>DASH</code> playback, Image generation, and more
38
+ * device is able to ingest both audio and video media into a stream. Only video producing devices can join the session and record media.</p>
39
+ * <important>
40
+ * <p>Both audio and video tracks are currently required for WebRTC ingestion.</p>
41
+ * <p>Current requirements:</p>
42
+ * <ul>
43
+ * <li>
44
+ * <p>Video track: H.264</p>
45
+ * </li>
46
+ * <li>
47
+ * <p>Audio track: Opus</p>
48
+ * </li>
49
+ * </ul>
50
+ * </important>
51
+ * <p>The resulting ingested video in the Kinesis video stream will have the following
52
+ * parameters: H.264 video and AAC audio.</p>
53
+ * <p>Once a master participant has negotiated a connection through WebRTC, the ingested media
54
+ * session will be stored in the Kinesis video stream. Multiple viewers are then able to play
55
+ * back real-time media through our Playback APIs.</p>
56
+ * <p>You can also use existing Kinesis Video Streams features like <code>HLS</code> or
57
+ * <code>DASH</code> playback, image generation via <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/gs-getImages.html">GetImages</a>, and more
45
58
  * with ingested WebRTC media.</p>
46
59
  * <note>
60
+ * <p>S3 image delivery and notifications are not currently supported.</p>
61
+ * </note>
62
+ * <note>
47
63
  * <p>Assume that only one video producing device client
48
64
  * can be associated with a session for the channel. If more than one
49
65
  * client joins the session of a specific channel as a video producing device,
50
66
  * the most recent client request takes precedence. </p>
51
67
  * </note>
68
+ * <p>
69
+ * <b>Additional information</b>
70
+ * </p>
71
+ * <ul>
72
+ * <li>
73
+ * <p>
74
+ * <b>Idempotent</b> - This API is not idempotent.</p>
75
+ * </li>
76
+ * <li>
77
+ * <p>
78
+ * <b>Retry behavior</b> - This is counted as a new API call.</p>
79
+ * </li>
80
+ * <li>
81
+ * <p>
82
+ * <b>Concurrent calls</b> - Concurrent calls are allowed. An offer is sent once per each call.</p>
83
+ * </li>
84
+ * </ul>
52
85
  * @example
53
86
  * Use a bare-bones client and the command you need to make an API call.
54
87
  * ```javascript
@@ -1 +1,2 @@
1
+ export * from "./JoinStorageSessionAsViewerCommand";
1
2
  export * from "./JoinStorageSessionCommand";
@@ -1,5 +1,6 @@
1
1
  /**
2
- * <p>
2
+ * <fullname>webrtc</fullname>
3
+ * <p>
3
4
  * </p>
4
5
  *
5
6
  * @packageDocumentation
@@ -62,3 +62,22 @@ export declare class ResourceNotFoundException extends __BaseException {
62
62
  */
63
63
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
64
64
  }
65
+ /**
66
+ * @public
67
+ */
68
+ export interface JoinStorageSessionAsViewerInput {
69
+ /**
70
+ * <p>
71
+ * The Amazon Resource Name (ARN) of the signaling channel.
72
+ * </p>
73
+ * @public
74
+ */
75
+ channelArn: string | undefined;
76
+ /**
77
+ * <p>
78
+ * The unique identifier for the sender client.
79
+ * </p>
80
+ * @public
81
+ */
82
+ clientId: string | undefined;
83
+ }
@@ -1,11 +1,20 @@
1
1
  import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
2
2
  import { SerdeContext as __SerdeContext } from "@smithy/types";
3
+ import { JoinStorageSessionAsViewerCommandInput, JoinStorageSessionAsViewerCommandOutput } from "../commands/JoinStorageSessionAsViewerCommand";
3
4
  import { JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput } from "../commands/JoinStorageSessionCommand";
4
5
  /**
5
6
  * serializeAws_restJson1JoinStorageSessionCommand
6
7
  */
7
8
  export declare const se_JoinStorageSessionCommand: (input: JoinStorageSessionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
9
+ /**
10
+ * serializeAws_restJson1JoinStorageSessionAsViewerCommand
11
+ */
12
+ export declare const se_JoinStorageSessionAsViewerCommand: (input: JoinStorageSessionAsViewerCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
8
13
  /**
9
14
  * deserializeAws_restJson1JoinStorageSessionCommand
10
15
  */
11
16
  export declare const de_JoinStorageSessionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<JoinStorageSessionCommandOutput>;
17
+ /**
18
+ * deserializeAws_restJson1JoinStorageSessionAsViewerCommand
19
+ */
20
+ export declare const de_JoinStorageSessionAsViewerCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<JoinStorageSessionAsViewerCommandOutput>;
@@ -1,4 +1,8 @@
1
1
  import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
2
+ import {
3
+ JoinStorageSessionAsViewerCommandInput,
4
+ JoinStorageSessionAsViewerCommandOutput,
5
+ } from "./commands/JoinStorageSessionAsViewerCommand";
2
6
  import {
3
7
  JoinStorageSessionCommandInput,
4
8
  JoinStorageSessionCommandOutput,
@@ -18,6 +22,19 @@ export interface KinesisVideoWebRTCStorage {
18
22
  options: __HttpHandlerOptions,
19
23
  cb: (err: any, data?: JoinStorageSessionCommandOutput) => void
20
24
  ): void;
25
+ joinStorageSessionAsViewer(
26
+ args: JoinStorageSessionAsViewerCommandInput,
27
+ options?: __HttpHandlerOptions
28
+ ): Promise<JoinStorageSessionAsViewerCommandOutput>;
29
+ joinStorageSessionAsViewer(
30
+ args: JoinStorageSessionAsViewerCommandInput,
31
+ cb: (err: any, data?: JoinStorageSessionAsViewerCommandOutput) => void
32
+ ): void;
33
+ joinStorageSessionAsViewer(
34
+ args: JoinStorageSessionAsViewerCommandInput,
35
+ options: __HttpHandlerOptions,
36
+ cb: (err: any, data?: JoinStorageSessionAsViewerCommandOutput) => void
37
+ ): void;
21
38
  }
22
39
  export declare class KinesisVideoWebRTCStorage
23
40
  extends KinesisVideoWebRTCStorageClient
@@ -45,6 +45,10 @@ import {
45
45
  HttpAuthSchemeInputConfig,
46
46
  HttpAuthSchemeResolvedConfig,
47
47
  } from "./auth/httpAuthSchemeProvider";
48
+ import {
49
+ JoinStorageSessionAsViewerCommandInput,
50
+ JoinStorageSessionAsViewerCommandOutput,
51
+ } from "./commands/JoinStorageSessionAsViewerCommand";
48
52
  import {
49
53
  JoinStorageSessionCommandInput,
50
54
  JoinStorageSessionCommandOutput,
@@ -56,8 +60,12 @@ import {
56
60
  } from "./endpoint/EndpointParameters";
57
61
  import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
58
62
  export { __Client };
59
- export type ServiceInputTypes = JoinStorageSessionCommandInput;
60
- export type ServiceOutputTypes = JoinStorageSessionCommandOutput;
63
+ export type ServiceInputTypes =
64
+ | JoinStorageSessionAsViewerCommandInput
65
+ | JoinStorageSessionCommandInput;
66
+ export type ServiceOutputTypes =
67
+ | JoinStorageSessionAsViewerCommandOutput
68
+ | JoinStorageSessionCommandOutput;
61
69
  export interface ClientDefaults
62
70
  extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
63
71
  requestHandler?: __HttpHandlerUserInput;
@@ -0,0 +1,36 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import {
4
+ KinesisVideoWebRTCStorageClientResolvedConfig,
5
+ ServiceInputTypes,
6
+ ServiceOutputTypes,
7
+ } from "../KinesisVideoWebRTCStorageClient";
8
+ import { JoinStorageSessionAsViewerInput } from "../models/models_0";
9
+ export { __MetadataBearer };
10
+ export { $Command };
11
+ export interface JoinStorageSessionAsViewerCommandInput
12
+ extends JoinStorageSessionAsViewerInput {}
13
+ export interface JoinStorageSessionAsViewerCommandOutput
14
+ extends __MetadataBearer {}
15
+ declare const JoinStorageSessionAsViewerCommand_base: {
16
+ new (
17
+ input: JoinStorageSessionAsViewerCommandInput
18
+ ): import("@smithy/smithy-client").CommandImpl<
19
+ JoinStorageSessionAsViewerCommandInput,
20
+ JoinStorageSessionAsViewerCommandOutput,
21
+ KinesisVideoWebRTCStorageClientResolvedConfig,
22
+ ServiceInputTypes,
23
+ ServiceOutputTypes
24
+ >;
25
+ new (
26
+ __0_0: JoinStorageSessionAsViewerCommandInput
27
+ ): import("@smithy/smithy-client").CommandImpl<
28
+ JoinStorageSessionAsViewerCommandInput,
29
+ JoinStorageSessionAsViewerCommandOutput,
30
+ KinesisVideoWebRTCStorageClientResolvedConfig,
31
+ ServiceInputTypes,
32
+ ServiceOutputTypes
33
+ >;
34
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
35
+ };
36
+ export declare class JoinStorageSessionAsViewerCommand extends JoinStorageSessionAsViewerCommand_base {}
@@ -1,6 +1,10 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { KinesisVideoWebRTCStorageClientResolvedConfig } from "../KinesisVideoWebRTCStorageClient";
3
+ import {
4
+ KinesisVideoWebRTCStorageClientResolvedConfig,
5
+ ServiceInputTypes,
6
+ ServiceOutputTypes,
7
+ } from "../KinesisVideoWebRTCStorageClient";
4
8
  import { JoinStorageSessionInput } from "../models/models_0";
5
9
  export { __MetadataBearer };
6
10
  export { $Command };
@@ -14,8 +18,8 @@ declare const JoinStorageSessionCommand_base: {
14
18
  JoinStorageSessionCommandInput,
15
19
  JoinStorageSessionCommandOutput,
16
20
  KinesisVideoWebRTCStorageClientResolvedConfig,
17
- JoinStorageSessionCommandInput,
18
- JoinStorageSessionCommandOutput
21
+ ServiceInputTypes,
22
+ ServiceOutputTypes
19
23
  >;
20
24
  new (
21
25
  __0_0: JoinStorageSessionCommandInput
@@ -23,8 +27,8 @@ declare const JoinStorageSessionCommand_base: {
23
27
  JoinStorageSessionCommandInput,
24
28
  JoinStorageSessionCommandOutput,
25
29
  KinesisVideoWebRTCStorageClientResolvedConfig,
26
- JoinStorageSessionCommandInput,
27
- JoinStorageSessionCommandOutput
30
+ ServiceInputTypes,
31
+ ServiceOutputTypes
28
32
  >;
29
33
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
30
34
  };
@@ -1 +1,2 @@
1
+ export * from "./JoinStorageSessionAsViewerCommand";
1
2
  export * from "./JoinStorageSessionCommand";
@@ -31,3 +31,7 @@ export declare class ResourceNotFoundException extends __BaseException {
31
31
  opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
32
32
  );
33
33
  }
34
+ export interface JoinStorageSessionAsViewerInput {
35
+ channelArn: string | undefined;
36
+ clientId: string | undefined;
37
+ }
@@ -3,6 +3,10 @@ import {
3
3
  HttpResponse as __HttpResponse,
4
4
  } from "@smithy/protocol-http";
5
5
  import { SerdeContext as __SerdeContext } from "@smithy/types";
6
+ import {
7
+ JoinStorageSessionAsViewerCommandInput,
8
+ JoinStorageSessionAsViewerCommandOutput,
9
+ } from "../commands/JoinStorageSessionAsViewerCommand";
6
10
  import {
7
11
  JoinStorageSessionCommandInput,
8
12
  JoinStorageSessionCommandOutput,
@@ -11,7 +15,15 @@ export declare const se_JoinStorageSessionCommand: (
11
15
  input: JoinStorageSessionCommandInput,
12
16
  context: __SerdeContext
13
17
  ) => Promise<__HttpRequest>;
18
+ export declare const se_JoinStorageSessionAsViewerCommand: (
19
+ input: JoinStorageSessionAsViewerCommandInput,
20
+ context: __SerdeContext
21
+ ) => Promise<__HttpRequest>;
14
22
  export declare const de_JoinStorageSessionCommand: (
15
23
  output: __HttpResponse,
16
24
  context: __SerdeContext
17
25
  ) => Promise<JoinStorageSessionCommandOutput>;
26
+ export declare const de_JoinStorageSessionAsViewerCommand: (
27
+ output: __HttpResponse,
28
+ context: __SerdeContext
29
+ ) => Promise<JoinStorageSessionAsViewerCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kinesis-video-webrtc-storage",
3
3
  "description": "AWS SDK for JavaScript Kinesis Video Webrtc Storage Client for Node.js, Browser and React Native",
4
- "version": "3.623.0",
4
+ "version": "3.624.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-kinesis-video-webrtc-storage",
@@ -20,10 +20,10 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.623.0",
24
- "@aws-sdk/client-sts": "3.623.0",
25
- "@aws-sdk/core": "3.623.0",
26
- "@aws-sdk/credential-provider-node": "3.623.0",
23
+ "@aws-sdk/client-sso-oidc": "3.624.0",
24
+ "@aws-sdk/client-sts": "3.624.0",
25
+ "@aws-sdk/core": "3.624.0",
26
+ "@aws-sdk/credential-provider-node": "3.624.0",
27
27
  "@aws-sdk/middleware-host-header": "3.620.0",
28
28
  "@aws-sdk/middleware-logger": "3.609.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.620.0",