-
Notifications
You must be signed in to change notification settings - Fork 581
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-kinesis-video-webrtc-storage): Add JoinStorageSessionAsVi…
…ewer API
- Loading branch information
awstools
committed
Aug 5, 2024
1 parent
6da4252
commit 36c7cdd
Showing
10 changed files
with
342 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
...nts/client-kinesis-video-webrtc-storage/src/commands/JoinStorageSessionAsViewerCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| // smithy-typescript generated code | ||
| import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
| import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
| import { Command as $Command } from "@smithy/smithy-client"; | ||
| import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
|
||
| import { commonParams } from "../endpoint/EndpointParameters"; | ||
| import { | ||
| KinesisVideoWebRTCStorageClientResolvedConfig, | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes, | ||
| } from "../KinesisVideoWebRTCStorageClient"; | ||
| import { JoinStorageSessionAsViewerInput } from "../models/models_0"; | ||
| import { de_JoinStorageSessionAsViewerCommand, se_JoinStorageSessionAsViewerCommand } from "../protocols/Aws_restJson1"; | ||
|
|
||
| /** | ||
| * @public | ||
| */ | ||
| export type { __MetadataBearer }; | ||
| export { $Command }; | ||
| /** | ||
| * @public | ||
| * | ||
| * The input for {@link JoinStorageSessionAsViewerCommand}. | ||
| */ | ||
| export interface JoinStorageSessionAsViewerCommandInput extends JoinStorageSessionAsViewerInput {} | ||
| /** | ||
| * @public | ||
| * | ||
| * The output of {@link JoinStorageSessionAsViewerCommand}. | ||
| */ | ||
| export interface JoinStorageSessionAsViewerCommandOutput extends __MetadataBearer {} | ||
|
|
||
| /** | ||
| * <p> | ||
| * Join the ongoing one way-video and/or multi-way audio WebRTC session as | ||
| * a viewer for an input channel. If there’s | ||
| * no existing session for the channel, create a new streaming session and provide | ||
| * the Amazon Resource Name (ARN) of the signaling channel (<code>channelArn</code>) | ||
| * and client id (<code>clientId</code>). | ||
| * </p> | ||
| * <p>Currently for <code>SINGLE_MASTER</code> type, a video producing device | ||
| * is able to ingest both audio and video media into a stream, while viewers | ||
| * can only ingest audio. Both a video producing device and viewers can join | ||
| * a session first and wait for other participants. While participants are having peer to peer conversations through WebRTC, | ||
| * the ingested media session will be stored into the Kinesis Video Stream. | ||
| * Multiple viewers are able to playback real-time media. | ||
| * </p> | ||
| * <p>Customers can also use existing Kinesis Video Streams features like | ||
| * <code>HLS</code> or <code>DASH</code> playback, Image generation, and more | ||
| * with ingested WebRTC media. If there’s an existing session with the same | ||
| * <code>clientId</code> that's found in the join session request, the new request takes precedence.</p> | ||
| * @example | ||
| * Use a bare-bones client and the command you need to make an API call. | ||
| * ```javascript | ||
| * import { KinesisVideoWebRTCStorageClient, JoinStorageSessionAsViewerCommand } from "@aws-sdk/client-kinesis-video-webrtc-storage"; // ES Modules import | ||
| * // const { KinesisVideoWebRTCStorageClient, JoinStorageSessionAsViewerCommand } = require("@aws-sdk/client-kinesis-video-webrtc-storage"); // CommonJS import | ||
| * const client = new KinesisVideoWebRTCStorageClient(config); | ||
| * const input = { // JoinStorageSessionAsViewerInput | ||
| * channelArn: "STRING_VALUE", // required | ||
| * clientId: "STRING_VALUE", // required | ||
| * }; | ||
| * const command = new JoinStorageSessionAsViewerCommand(input); | ||
| * const response = await client.send(command); | ||
| * // {}; | ||
| * | ||
| * ``` | ||
| * | ||
| * @param JoinStorageSessionAsViewerCommandInput - {@link JoinStorageSessionAsViewerCommandInput} | ||
| * @returns {@link JoinStorageSessionAsViewerCommandOutput} | ||
| * @see {@link JoinStorageSessionAsViewerCommandInput} for command's `input` shape. | ||
| * @see {@link JoinStorageSessionAsViewerCommandOutput} for command's `response` shape. | ||
| * @see {@link KinesisVideoWebRTCStorageClientResolvedConfig | config} for KinesisVideoWebRTCStorageClient's `config` shape. | ||
| * | ||
| * @throws {@link AccessDeniedException} (client fault) | ||
| * <p>You do not have required permissions to perform this operation.</p> | ||
| * | ||
| * @throws {@link ClientLimitExceededException} (client fault) | ||
| * <p> | ||
| * Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. | ||
| * </p> | ||
| * | ||
| * @throws {@link InvalidArgumentException} (client fault) | ||
| * <p>The value for this input parameter is invalid.</p> | ||
| * | ||
| * @throws {@link ResourceNotFoundException} (client fault) | ||
| * <p>The specified resource is not found.</p> | ||
| * | ||
| * @throws {@link KinesisVideoWebRTCStorageServiceException} | ||
| * <p>Base exception class for all service exceptions from KinesisVideoWebRTCStorage service.</p> | ||
| * | ||
| * @public | ||
| */ | ||
| export class JoinStorageSessionAsViewerCommand extends $Command | ||
| .classBuilder< | ||
| JoinStorageSessionAsViewerCommandInput, | ||
| JoinStorageSessionAsViewerCommandOutput, | ||
| KinesisVideoWebRTCStorageClientResolvedConfig, | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes | ||
| >() | ||
| .ep({ | ||
| ...commonParams, | ||
| }) | ||
| .m(function (this: any, Command: any, cs: any, config: KinesisVideoWebRTCStorageClientResolvedConfig, o: any) { | ||
| return [ | ||
| getSerdePlugin(config, this.serialize, this.deserialize), | ||
| getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
| ]; | ||
| }) | ||
| .s("AWSAcuityRoutingServiceLambda", "JoinStorageSessionAsViewer", {}) | ||
| .n("KinesisVideoWebRTCStorageClient", "JoinStorageSessionAsViewerCommand") | ||
| .f(void 0, void 0) | ||
| .ser(se_JoinStorageSessionAsViewerCommand) | ||
| .de(de_JoinStorageSessionAsViewerCommand) | ||
| .build() {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
clients/client-kinesis-video-webrtc-storage/src/commands/index.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| export * from "./JoinStorageSessionAsViewerCommand"; | ||
| // smithy-typescript generated code | ||
| export * from "./JoinStorageSessionCommand"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.