@aws-sdk/client-ivs-realtime

Description

AWS SDK for JavaScript IVSRealTime Client for Node.js, Browser and React Native.

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
including errors.

Key Concepts

• 
  

  
  Stage — A virtual space where participants can exchange video in real time.

  
  


• 
  

  
  Participant token — A token that authenticates a participant when they join a stage.

  
  


• 
  

  
  Participant object — 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.

  
  

For server-side composition:

• 
  

  
  Composition process — Composites participants
  of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
  Composition operations support this process.

  
  


• 
  

  
  Composition — Controls the look of the outputs,
  including how participants are positioned in the video.

  
  

For participant replication:

• 
  

  
  Source stage — The stage where the participant originally joined, which is used as the source for
  replication.

  
  


• 
  

  
  Destination stage — The stage to which the participant is replicated.
  

  
  


• 
  

  
  Replicated participant — A participant in a stage that is replicated to one or more destination stages.
  

  
  


• 
  

  
  Replica participant — A participant in a destination stage that is replicated from another stage
  (the source stage).

  
  

For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag
comprises a key and a value, both set by you. For
example, you might set a tag as topic:nature to label a particular video
category. See Best practices and strategies
in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming
limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the
same tag for different resources to indicate that they are related. You can also use tags to
manage access (see Access Tags).

The Amazon IVS real-time API has these tag-related operations: TagResource, UntagResource, and
ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

Installing

To install this package, simply type add or install @aws-sdk/client-ivs-realtime
using your favorite package manager:
- npm install @aws-sdk/client-ivs-realtime
- yarn add @aws-sdk/client-ivs-realtime
- pnpm add @aws-sdk/client-ivs-realtime

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the IVSRealTimeClient and
the commands you need, for example ListStagesCommand:

``js
// ES5 example
const { IVSRealTimeClient, ListStagesCommand } = require("@aws-sdk/client-ivs-realtime");
`

`ts
// ES6+ example
import { IVSRealTimeClient, ListStagesCommand } from "@aws-sdk/client-ivs-realtime";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new IVSRealTimeClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListStagesCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-ivs-realtime";
const client = new AWS.IVSRealTime({ region: "REGION" });

// async/await.
try {
const data = await client.listStages(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listStages(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listStages(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-ivs-realtime` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CreateEncoderConfiguration

Command API Reference / Input / Output

CreateIngestConfiguration

Command API Reference / Input / Output

CreateParticipantToken

Command API Reference / Input / Output

CreateStage

Command API Reference / Input / Output

CreateStorageConfiguration

Command API Reference / Input / Output

DeleteEncoderConfiguration

Command API Reference / Input / Output

DeleteIngestConfiguration

Command API Reference / Input / Output

DeletePublicKey

Command API Reference / Input / Output

DeleteStage

Command API Reference / Input / Output

DeleteStorageConfiguration

Command API Reference / Input / Output

DisconnectParticipant

Command API Reference / Input / Output

GetComposition

Command API Reference / Input / Output

GetEncoderConfiguration

Command API Reference / Input / Output

GetIngestConfiguration

Command API Reference / Input / Output

GetParticipant

Command API Reference / Input / Output

GetPublicKey

Command API Reference / Input / Output

GetStage

Command API Reference / Input / Output

GetStageSession

Command API Reference / Input / Output

GetStorageConfiguration

Command API Reference / Input / Output

ImportPublicKey

Command API Reference / Input / Output

ListCompositions

Command API Reference / Input / Output

ListEncoderConfigurations

Command API Reference / Input / Output

ListIngestConfigurations

Command API Reference / Input / Output

ListParticipantEvents

Command API Reference / Input / Output

ListParticipantReplicas

Command API Reference / Input / Output

ListParticipants

Command API Reference / Input / Output

ListPublicKeys

Command API Reference / Input / Output

ListStages

Command API Reference / Input / Output

ListStageSessions

Command API Reference / Input / Output

ListStorageConfigurations

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

StartComposition

Command API Reference / Input / Output

StartParticipantReplication

Command API Reference / Input / Output

StopComposition

Command API Reference / Input / Output

StopParticipantReplication

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateIngestConfiguration

Command API Reference / Input / Output

UpdateStage

Command API Reference / Input / Output