| AWS SDK for C++AWS SDK for C++ Version 1.11.679 | 
#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 60 of file IvsrealtimeClient.h.
Definition at line 63 of file IvsrealtimeClient.h.
Definition at line 67 of file IvsrealtimeClient.h.
Definition at line 68 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 141 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 131 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 170 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 160 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 200 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 191 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 227 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 218 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 259 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 249 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 289 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 279 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 320 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 310 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 348 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 339 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 376 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 367 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 409 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 399 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 439 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 430 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 465 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 456 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 492 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 483 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 520 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 511 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 547 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 538 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 572 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 563 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 597 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 588 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 623 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 614 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 650 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 641 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 677 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 668 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 704 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 695 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 734 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 724 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 763 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 753 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 791 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 782 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 818 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 809 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 846 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 837 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 872 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 863 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 925 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 916 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 899 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 890 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 955 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 945 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 983 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 974 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 1018 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 1009 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 1047 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 1037 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 1074 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 1065 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 1102 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 1092 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 1129 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 1120 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 1155 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 1146 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 1184 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 1174 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 1210 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 1201 of file IvsrealtimeClient.h.
Definition at line 1216 of file IvsrealtimeClient.h.