Skip to content

Commit

Permalink
feat(client-ivs-realtime): This release introduces server side compos…
Browse files Browse the repository at this point in the history 
…ition and recording for stages.
  • Loading branch information
awstools committed Nov 16, 2023
1 parent 95a1b14 commit 4e07828
Show file tree
Hide file tree
Showing 25 changed files with 7,723 additions and 678 deletions.
189 changes: 184 additions & 5 deletions clients/client-ivs-realtime/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,20 @@ including errors.
<p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
</li>
<li>
<p>A <i>participant object</i> represents participants
(people) in the stage and contains information about them. When a token is created, it
includes a participant ID; when a participant uses that token to join a stage, the
participant is associated with that participant ID There is a 1:1 mapping between
participant tokens and participants.</p>
<p>A <i>participant object</i> represents participants (people) in the stage and
contains information about them. When a token is created, it includes a participant ID;
when a participant uses that token to join a stage, the participant is associated with
that participant ID. There is a 1:1 mapping between participant tokens and
participants.</p>
</li>
<li>
<p>Server-side composition: The <i>composition</i> process composites participants
of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
Composition endpoints support this process.</p>
</li>
<li>
<p>Server-side composition: A <i>composition</i> controls the look of the outputs,
including how participants are positioned in the video.</p>
</li>
</ul>
<p>
Expand Down Expand Up @@ -112,6 +121,80 @@ session.</p>
</li>
</ul>
<p>
<b>Composition Endpoints</b>
</p>
<ul>
<li>
<p>
<a>GetComposition</a> — Gets information about the specified
Composition resource.</p>
</li>
<li>
<p>
<a>ListCompositions</a> — Gets summary information about all
Compositions in your account, in the AWS region where the API request is processed.</p>
</li>
<li>
<p>
<a>StartComposition</a> — Starts a Composition from a stage based on
the configuration provided in the request.</p>
</li>
<li>
<p>
<a>StopComposition</a> — Stops and deletes a Composition resource.
Any broadcast from the Composition resource is stopped.</p>
</li>
</ul>
<p>
<b>EncoderConfiguration Endpoints</b>
</p>
<ul>
<li>
<p>
<a>CreateEncoderConfiguration</a> — Creates an EncoderConfiguration object.</p>
</li>
<li>
<p>
<a>DeleteEncoderConfiguration</a> — Deletes an EncoderConfiguration
resource. Ensures that no Compositions are using this template; otherwise, returns an
error.</p>
</li>
<li>
<p>
<a>GetEncoderConfiguration</a> — Gets information about the specified
EncoderConfiguration resource.</p>
</li>
<li>
<p>
<a>ListEncoderConfigurations</a> — Gets summary information about all
EncoderConfigurations in your account, in the AWS region where the API request is
processed.</p>
</li>
</ul>
<p>
<b>StorageConfiguration Endpoints</b>
</p>
<ul>
<li>
<p>
<a>CreateStorageConfiguration</a> — Creates a new storage configuration, used to enable
recording to Amazon S3.</p>
</li>
<li>
<p>
<a>DeleteStorageConfiguration</a> — Deletes the storage configuration for the specified ARN.</p>
</li>
<li>
<p>
<a>GetStorageConfiguration</a> — Gets the storage configuration for the specified ARN.</p>
</li>
<li>
<p>
<a>ListStorageConfigurations</a> — Gets summary information about all storage configurations in your
account, in the AWS region where the API request is processed.</p>
</li>
</ul>
<p>
<b>Tags Endpoints</b>
</p>
<ul>
Expand Down Expand Up @@ -327,6 +410,14 @@ see LICENSE for more information.

## Client Commands (Operations List)

<details>
<summary>
CreateEncoderConfiguration
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/createencoderconfigurationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/createencoderconfigurationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/createencoderconfigurationcommandoutput.html)

</details>
<details>
<summary>
CreateParticipantToken
Expand All @@ -342,6 +433,22 @@ CreateStage

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/createstagecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/createstagecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/createstagecommandoutput.html)

</details>
<details>
<summary>
CreateStorageConfiguration
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/createstorageconfigurationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/createstorageconfigurationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/createstorageconfigurationcommandoutput.html)

</details>
<details>
<summary>
DeleteEncoderConfiguration
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/deleteencoderconfigurationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/deleteencoderconfigurationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/deleteencoderconfigurationcommandoutput.html)

</details>
<details>
<summary>
Expand All @@ -350,6 +457,14 @@ DeleteStage

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/deletestagecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/deletestagecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/deletestagecommandoutput.html)

</details>
<details>
<summary>
DeleteStorageConfiguration
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/deletestorageconfigurationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/deletestorageconfigurationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/deletestorageconfigurationcommandoutput.html)

</details>
<details>
<summary>
Expand All @@ -358,6 +473,22 @@ DisconnectParticipant

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/disconnectparticipantcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/disconnectparticipantcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/disconnectparticipantcommandoutput.html)

</details>
<details>
<summary>
GetComposition
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/getcompositioncommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/getcompositioncommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/getcompositioncommandoutput.html)

</details>
<details>
<summary>
GetEncoderConfiguration
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/getencoderconfigurationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/getencoderconfigurationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/getencoderconfigurationcommandoutput.html)

</details>
<details>
<summary>
Expand All @@ -382,6 +513,30 @@ GetStageSession

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/getstagesessioncommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/getstagesessioncommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/getstagesessioncommandoutput.html)

</details>
<details>
<summary>
GetStorageConfiguration
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/getstorageconfigurationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/getstorageconfigurationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/getstorageconfigurationcommandoutput.html)

</details>
<details>
<summary>
ListCompositions
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/listcompositionscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/listcompositionscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/listcompositionscommandoutput.html)

</details>
<details>
<summary>
ListEncoderConfigurations
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/listencoderconfigurationscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/listencoderconfigurationscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/listencoderconfigurationscommandoutput.html)

</details>
<details>
<summary>
Expand Down Expand Up @@ -414,6 +569,14 @@ ListStageSessions

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/liststagesessionscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/liststagesessionscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/liststagesessionscommandoutput.html)

</details>
<details>
<summary>
ListStorageConfigurations
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/liststorageconfigurationscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/liststorageconfigurationscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/liststorageconfigurationscommandoutput.html)

</details>
<details>
<summary>
Expand All @@ -422,6 +585,22 @@ ListTagsForResource

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/listtagsforresourcecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/listtagsforresourcecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/listtagsforresourcecommandoutput.html)

</details>
<details>
<summary>
StartComposition
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/startcompositioncommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/startcompositioncommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/startcompositioncommandoutput.html)

</details>
<details>
<summary>
StopComposition
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/classes/stopcompositioncommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/stopcompositioncommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ivs-realtime/interfaces/stopcompositioncommandoutput.html)

</details>
<details>
<summary>
Expand Down
4 changes: 3 additions & 1 deletion clients/client-ivs-realtime/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,14 @@
"@smithy/util-endpoints": "^1.0.4",
"@smithy/util-retry": "^2.0.6",
"@smithy/util-utf8": "^2.0.2",
"tslib": "^2.5.0"
"tslib": "^2.5.0",
"uuid": "^8.3.2"
},
"devDependencies": {
"@smithy/service-client-documentation-generator": "^2.0.0",
"@tsconfig/node14": "1.0.3",
"@types/node": "^14.14.31",
"@types/uuid": "^8.3.0",
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
Expand Down
Loading

0 comments on commit 4e07828

Please sign in to comment.