AWS SDK for C++AWS SDK for C++ Version 1.11.778 |
#include <IvsrealtimeClient.h>
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.
Definition at line 62 of file IvsrealtimeClient.h.
Definition at line 67 of file IvsrealtimeClient.h.
Definition at line 71 of file IvsrealtimeClient.h.
Definition at line 72 of file IvsrealtimeClient.h.
Aws::ivsrealtime::IvsrealtimeClientConfiguration(),
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::ivsrealtime::IvsrealtimeClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::ivsrealtime::IvsrealtimeClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
{})
const
nullptr,
{}
An Async wrapper for CreateEncoderConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 145 of file IvsrealtimeClient.h.
{})
const
A Callable wrapper for CreateEncoderConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 135 of file IvsrealtimeClient.h.
Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
nullptr
An Async wrapper for CreateIngestConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 174 of file IvsrealtimeClient.h.
A Callable wrapper for CreateIngestConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 164 of file IvsrealtimeClient.h.
Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
nullptr
An Async wrapper for CreateParticipantToken that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 204 of file IvsrealtimeClient.h.
A Callable wrapper for CreateParticipantToken that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 195 of file IvsrealtimeClient.h.
{})
const
nullptr,
{}
An Async wrapper for CreateStage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 231 of file IvsrealtimeClient.h.
{})
const
A Callable wrapper for CreateStage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 222 of file IvsrealtimeClient.h.
Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.
nullptr
An Async wrapper for CreateStorageConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 263 of file IvsrealtimeClient.h.
A Callable wrapper for CreateStorageConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 253 of file IvsrealtimeClient.h.
Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
nullptr
An Async wrapper for DeleteEncoderConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 293 of file IvsrealtimeClient.h.
A Callable wrapper for DeleteEncoderConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 283 of file IvsrealtimeClient.h.
Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.
nullptr
An Async wrapper for DeleteIngestConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 324 of file IvsrealtimeClient.h.
A Callable wrapper for DeleteIngestConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 314 of file IvsrealtimeClient.h.
Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.
nullptr
An Async wrapper for DeletePublicKey that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 352 of file IvsrealtimeClient.h.
A Callable wrapper for DeletePublicKey that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 343 of file IvsrealtimeClient.h.
Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.
nullptr
An Async wrapper for DeleteStage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 380 of file IvsrealtimeClient.h.
A Callable wrapper for DeleteStage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 371 of file IvsrealtimeClient.h.
Deletes the storage configuration for the specified ARN.
If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.
nullptr
An Async wrapper for DeleteStorageConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 413 of file IvsrealtimeClient.h.
A Callable wrapper for DeleteStorageConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 403 of file IvsrealtimeClient.h.
Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.
nullptr
An Async wrapper for DisconnectParticipant that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 443 of file IvsrealtimeClient.h.
A Callable wrapper for DisconnectParticipant that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 434 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for GetComposition that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 469 of file IvsrealtimeClient.h.
A Callable wrapper for GetComposition that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 460 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for GetEncoderConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 496 of file IvsrealtimeClient.h.
A Callable wrapper for GetEncoderConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 487 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for GetIngestConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 524 of file IvsrealtimeClient.h.
A Callable wrapper for GetIngestConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 515 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for GetParticipant that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 551 of file IvsrealtimeClient.h.
A Callable wrapper for GetParticipant that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 542 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for GetPublicKey that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 576 of file IvsrealtimeClient.h.
A Callable wrapper for GetPublicKey that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 567 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for GetStage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 601 of file IvsrealtimeClient.h.
A Callable wrapper for GetStage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 592 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for GetStageSession that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 627 of file IvsrealtimeClient.h.
A Callable wrapper for GetStageSession that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 618 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for GetStorageConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 654 of file IvsrealtimeClient.h.
A Callable wrapper for GetStorageConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 645 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for ImportPublicKey that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 681 of file IvsrealtimeClient.h.
A Callable wrapper for ImportPublicKey that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 672 of file IvsrealtimeClient.h.
{})
const
Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
nullptr,
{}
An Async wrapper for ListCompositions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 708 of file IvsrealtimeClient.h.
{})
const
A Callable wrapper for ListCompositions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 699 of file IvsrealtimeClient.h.
{})
const
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
nullptr,
{}
An Async wrapper for ListEncoderConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 738 of file IvsrealtimeClient.h.
{})
const
A Callable wrapper for ListEncoderConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 728 of file IvsrealtimeClient.h.
{})
const
Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.
nullptr,
{}
An Async wrapper for ListIngestConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 767 of file IvsrealtimeClient.h.
{})
const
A Callable wrapper for ListIngestConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 757 of file IvsrealtimeClient.h.
Lists events for a specified participant that occurred during a specified stage session.
nullptr
An Async wrapper for ListParticipantEvents that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 795 of file IvsrealtimeClient.h.
A Callable wrapper for ListParticipantEvents that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 786 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for ListParticipantReplicas that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 822 of file IvsrealtimeClient.h.
A Callable wrapper for ListParticipantReplicas that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 813 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for ListParticipants that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 850 of file IvsrealtimeClient.h.
A Callable wrapper for ListParticipants that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 841 of file IvsrealtimeClient.h.
{})
const
Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
nullptr,
{}
An Async wrapper for ListPublicKeys that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 876 of file IvsrealtimeClient.h.
{})
const
A Callable wrapper for ListPublicKeys that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 867 of file IvsrealtimeClient.h.
{})
const
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
nullptr,
{}
An Async wrapper for ListStages that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 929 of file IvsrealtimeClient.h.
{})
const
A Callable wrapper for ListStages that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 920 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for ListStageSessions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 903 of file IvsrealtimeClient.h.
A Callable wrapper for ListStageSessions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 894 of file IvsrealtimeClient.h.
{})
const
Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
nullptr,
{}
An Async wrapper for ListStorageConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 959 of file IvsrealtimeClient.h.
{})
const
A Callable wrapper for ListStorageConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 949 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 987 of file IvsrealtimeClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 978 of file IvsrealtimeClient.h.
Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:
When StopComposition is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.
nullptr
An Async wrapper for StartComposition that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1022 of file IvsrealtimeClient.h.
A Callable wrapper for StartComposition that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1013 of file IvsrealtimeClient.h.
Starts replicating a publishing participant from a source stage to a destination stage.
nullptr
An Async wrapper for StartParticipantReplication that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1051 of file IvsrealtimeClient.h.
A Callable wrapper for StartParticipantReplication that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1041 of file IvsrealtimeClient.h.
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
nullptr
An Async wrapper for StopComposition that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1078 of file IvsrealtimeClient.h.
A Callable wrapper for StopComposition that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1069 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for StopParticipantReplication that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1106 of file IvsrealtimeClient.h.
A Callable wrapper for StopParticipantReplication that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1096 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1133 of file IvsrealtimeClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1124 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1159 of file IvsrealtimeClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1150 of file IvsrealtimeClient.h.
Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.
nullptr
An Async wrapper for UpdateIngestConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1188 of file IvsrealtimeClient.h.
A Callable wrapper for UpdateIngestConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1178 of file IvsrealtimeClient.h.
nullptr
An Async wrapper for UpdateStage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1214 of file IvsrealtimeClient.h.
A Callable wrapper for UpdateStage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1205 of file IvsrealtimeClient.h.
Definition at line 1220 of file IvsrealtimeClient.h.