@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonIVSRealTimeAsyncClient extends AmazonIVSRealTimeClient implements AmazonIVSRealTimeAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Introduction
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.
Terminology:
A stage is a virtual space where participants can exchange video in real time.
A participant token is a token that authenticates a participant when they join a stage.
A 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.
Server-side composition: The composition 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.
Server-side composition: A composition controls the look of the outputs, including how participants are positioned in the video.
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
Stage — A stage is a virtual space where participants can exchange video in real time.
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 Tagging AWS Resources for more
information, 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 endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
Stages Endpoints
CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
CreateStage — Creates a new stage (and optionally participant tokens).
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
GetParticipant — Gets information about the specified participant token.
GetStage — Gets information for the specified stage.
GetStageSession — Gets information for the specified stage session.
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
ListParticipants — Lists all participants in a specified stage session.
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
ListStageSessions — Gets all sessions for a specified stage.
UpdateStage — Updates a stage’s configuration.
Composition Endpoints
GetComposition — Gets information about the specified Composition resource.
ListCompositions — Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
StartComposition — Starts a Composition from a stage based on the configuration provided in the request.
StopComposition — Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
EncoderConfiguration Endpoints
CreateEncoderConfiguration — Creates an EncoderConfiguration object.
DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
GetEncoderConfiguration — Gets information about the specified EncoderConfiguration resource.
ListEncoderConfigurations — Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
StorageConfiguration Endpoints
CreateStorageConfiguration — Creates a new storage configuration, used to enable recording to Amazon S3.
DeleteStorageConfiguration — Deletes the storage configuration for the specified ARN.
GetStorageConfiguration — Gets the storage configuration for the specified ARN.
ListStorageConfigurations — Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, createEncoderConfiguration, createParticipantToken, createStage, createStorageConfiguration, deleteEncoderConfiguration, deleteStage, deleteStorageConfiguration, disconnectParticipant, getCachedResponseMetadata, getComposition, getEncoderConfiguration, getParticipant, getStage, getStageSession, getStorageConfiguration, listCompositions, listEncoderConfigurations, listParticipantEvents, listParticipants, listStages, listStageSessions, listStorageConfigurations, listTagsForResource, startComposition, stopComposition, tagResource, untagResource, updateStage
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createEncoderConfiguration, createParticipantToken, createStage, createStorageConfiguration, deleteEncoderConfiguration, deleteStage, deleteStorageConfiguration, disconnectParticipant, getCachedResponseMetadata, getComposition, getEncoderConfiguration, getParticipant, getStage, getStageSession, getStorageConfiguration, listCompositions, listEncoderConfigurations, listParticipantEvents, listParticipants, listStages, listStageSessions, listStorageConfigurations, listTagsForResource, startComposition, stopComposition, tagResource, untagResource, updateStage
public static AmazonIVSRealTimeAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateEncoderConfigurationResult> createEncoderConfigurationAsync(CreateEncoderConfigurationRequest request)
AmazonIVSRealTimeAsync
Creates an EncoderConfiguration object.
createEncoderConfigurationAsync
in interface AmazonIVSRealTimeAsync
public Future<CreateEncoderConfigurationResult> createEncoderConfigurationAsync(CreateEncoderConfigurationRequest request, AsyncHandler<CreateEncoderConfigurationRequest,CreateEncoderConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsync
Creates an EncoderConfiguration object.
createEncoderConfigurationAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateParticipantTokenResult> createParticipantTokenAsync(CreateParticipantTokenRequest request)
AmazonIVSRealTimeAsync
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.
createParticipantTokenAsync
in interface AmazonIVSRealTimeAsync
public Future<CreateParticipantTokenResult> createParticipantTokenAsync(CreateParticipantTokenRequest request, AsyncHandler<CreateParticipantTokenRequest,CreateParticipantTokenResult> asyncHandler)
AmazonIVSRealTimeAsync
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.
createParticipantTokenAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStageResult> createStageAsync(CreateStageRequest request)
AmazonIVSRealTimeAsync
Creates a new stage (and optionally participant tokens).
createStageAsync
in interface AmazonIVSRealTimeAsync
public Future<CreateStageResult> createStageAsync(CreateStageRequest request, AsyncHandler<CreateStageRequest,CreateStageResult> asyncHandler)
AmazonIVSRealTimeAsync
Creates a new stage (and optionally participant tokens).
createStageAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStorageConfigurationResult> createStorageConfigurationAsync(CreateStorageConfigurationRequest request)
AmazonIVSRealTimeAsync
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.
createStorageConfigurationAsync
in interface AmazonIVSRealTimeAsync
public Future<CreateStorageConfigurationResult> createStorageConfigurationAsync(CreateStorageConfigurationRequest request, AsyncHandler<CreateStorageConfigurationRequest,CreateStorageConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsync
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.
createStorageConfigurationAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteEncoderConfigurationResult> deleteEncoderConfigurationAsync(DeleteEncoderConfigurationRequest request)
AmazonIVSRealTimeAsync
Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
deleteEncoderConfigurationAsync
in interface AmazonIVSRealTimeAsync
public Future<DeleteEncoderConfigurationResult> deleteEncoderConfigurationAsync(DeleteEncoderConfigurationRequest request, AsyncHandler<DeleteEncoderConfigurationRequest,DeleteEncoderConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsync
Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
deleteEncoderConfigurationAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest request)
AmazonIVSRealTimeAsync
Shuts down and deletes the specified stage (disconnecting all participants).
deleteStageAsync
in interface AmazonIVSRealTimeAsync
public Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest request, AsyncHandler<DeleteStageRequest,DeleteStageResult> asyncHandler)
AmazonIVSRealTimeAsync
Shuts down and deletes the specified stage (disconnecting all participants).
deleteStageAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStorageConfigurationResult> deleteStorageConfigurationAsync(DeleteStorageConfigurationRequest request)
AmazonIVSRealTimeAsync
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.
deleteStorageConfigurationAsync
in interface AmazonIVSRealTimeAsync
public Future<DeleteStorageConfigurationResult> deleteStorageConfigurationAsync(DeleteStorageConfigurationRequest request, AsyncHandler<DeleteStorageConfigurationRequest,DeleteStorageConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsync
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.
deleteStorageConfigurationAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest request)
AmazonIVSRealTimeAsync
Disconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantAsync
in interface AmazonIVSRealTimeAsync
public Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest request, AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)
AmazonIVSRealTimeAsync
Disconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCompositionResult> getCompositionAsync(GetCompositionRequest request)
AmazonIVSRealTimeAsync
Get information about the specified Composition resource.
getCompositionAsync
in interface AmazonIVSRealTimeAsync
public Future<GetCompositionResult> getCompositionAsync(GetCompositionRequest request, AsyncHandler<GetCompositionRequest,GetCompositionResult> asyncHandler)
AmazonIVSRealTimeAsync
Get information about the specified Composition resource.
getCompositionAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetEncoderConfigurationResult> getEncoderConfigurationAsync(GetEncoderConfigurationRequest request)
AmazonIVSRealTimeAsync
Gets information about the specified EncoderConfiguration resource.
getEncoderConfigurationAsync
in interface AmazonIVSRealTimeAsync
public Future<GetEncoderConfigurationResult> getEncoderConfigurationAsync(GetEncoderConfigurationRequest request, AsyncHandler<GetEncoderConfigurationRequest,GetEncoderConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets information about the specified EncoderConfiguration resource.
getEncoderConfigurationAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest request)
AmazonIVSRealTimeAsync
Gets information about the specified participant token.
getParticipantAsync
in interface AmazonIVSRealTimeAsync
public Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest request, AsyncHandler<GetParticipantRequest,GetParticipantResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets information about the specified participant token.
getParticipantAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStageResult> getStageAsync(GetStageRequest request)
AmazonIVSRealTimeAsync
Gets information for the specified stage.
getStageAsync
in interface AmazonIVSRealTimeAsync
public Future<GetStageResult> getStageAsync(GetStageRequest request, AsyncHandler<GetStageRequest,GetStageResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets information for the specified stage.
getStageAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest request)
AmazonIVSRealTimeAsync
Gets information for the specified stage session.
getStageSessionAsync
in interface AmazonIVSRealTimeAsync
public Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest request, AsyncHandler<GetStageSessionRequest,GetStageSessionResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets information for the specified stage session.
getStageSessionAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStorageConfigurationResult> getStorageConfigurationAsync(GetStorageConfigurationRequest request)
AmazonIVSRealTimeAsync
Gets the storage configuration for the specified ARN.
getStorageConfigurationAsync
in interface AmazonIVSRealTimeAsync
public Future<GetStorageConfigurationResult> getStorageConfigurationAsync(GetStorageConfigurationRequest request, AsyncHandler<GetStorageConfigurationRequest,GetStorageConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets the storage configuration for the specified ARN.
getStorageConfigurationAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListCompositionsResult> listCompositionsAsync(ListCompositionsRequest request)
AmazonIVSRealTimeAsync
Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
listCompositionsAsync
in interface AmazonIVSRealTimeAsync
public Future<ListCompositionsResult> listCompositionsAsync(ListCompositionsRequest request, AsyncHandler<ListCompositionsRequest,ListCompositionsResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
listCompositionsAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEncoderConfigurationsResult> listEncoderConfigurationsAsync(ListEncoderConfigurationsRequest request)
AmazonIVSRealTimeAsync
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
listEncoderConfigurationsAsync
in interface AmazonIVSRealTimeAsync
public Future<ListEncoderConfigurationsResult> listEncoderConfigurationsAsync(ListEncoderConfigurationsRequest request, AsyncHandler<ListEncoderConfigurationsRequest,ListEncoderConfigurationsResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
listEncoderConfigurationsAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest request)
AmazonIVSRealTimeAsync
Lists events for a specified participant that occurred during a specified stage session.
listParticipantEventsAsync
in interface AmazonIVSRealTimeAsync
public Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest request, AsyncHandler<ListParticipantEventsRequest,ListParticipantEventsResult> asyncHandler)
AmazonIVSRealTimeAsync
Lists events for a specified participant that occurred during a specified stage session.
listParticipantEventsAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest request)
AmazonIVSRealTimeAsync
Lists all participants in a specified stage session.
listParticipantsAsync
in interface AmazonIVSRealTimeAsync
public Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest request, AsyncHandler<ListParticipantsRequest,ListParticipantsResult> asyncHandler)
AmazonIVSRealTimeAsync
Lists all participants in a specified stage session.
listParticipantsAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest request)
AmazonIVSRealTimeAsync
Gets all sessions for a specified stage.
listStageSessionsAsync
in interface AmazonIVSRealTimeAsync
public Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest request, AsyncHandler<ListStageSessionsRequest,ListStageSessionsResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets all sessions for a specified stage.
listStageSessionsAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStagesResult> listStagesAsync(ListStagesRequest request)
AmazonIVSRealTimeAsync
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesAsync
in interface AmazonIVSRealTimeAsync
public Future<ListStagesResult> listStagesAsync(ListStagesRequest request, AsyncHandler<ListStagesRequest,ListStagesResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStorageConfigurationsResult> listStorageConfigurationsAsync(ListStorageConfigurationsRequest request)
AmazonIVSRealTimeAsync
Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
listStorageConfigurationsAsync
in interface AmazonIVSRealTimeAsync
public Future<ListStorageConfigurationsResult> listStorageConfigurationsAsync(ListStorageConfigurationsRequest request, AsyncHandler<ListStorageConfigurationsRequest,ListStorageConfigurationsResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
listStorageConfigurationsAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonIVSRealTimeAsync
Gets information about AWS tags for the specified ARN.
listTagsForResourceAsync
in interface AmazonIVSRealTimeAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonIVSRealTimeAsync
Gets information about AWS tags for the specified ARN.
listTagsForResourceAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartCompositionResult> startCompositionAsync(StartCompositionRequest request)
AmazonIVSRealTimeAsync
Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint 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.
startCompositionAsync
in interface AmazonIVSRealTimeAsync
public Future<StartCompositionResult> startCompositionAsync(StartCompositionRequest request, AsyncHandler<StartCompositionRequest,StartCompositionResult> asyncHandler)
AmazonIVSRealTimeAsync
Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint 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.
startCompositionAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopCompositionResult> stopCompositionAsync(StopCompositionRequest request)
AmazonIVSRealTimeAsync
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
stopCompositionAsync
in interface AmazonIVSRealTimeAsync
public Future<StopCompositionResult> stopCompositionAsync(StopCompositionRequest request, AsyncHandler<StopCompositionRequest,StopCompositionResult> asyncHandler)
AmazonIVSRealTimeAsync
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
stopCompositionAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonIVSRealTimeAsync
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceAsync
in interface AmazonIVSRealTimeAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonIVSRealTimeAsync
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonIVSRealTimeAsync
Removes tags from the resource with the specified ARN.
untagResourceAsync
in interface AmazonIVSRealTimeAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonIVSRealTimeAsync
Removes tags from the resource with the specified ARN.
untagResourceAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateStageResult> updateStageAsync(UpdateStageRequest request)
AmazonIVSRealTimeAsync
Updates a stage’s configuration.
updateStageAsync
in interface AmazonIVSRealTimeAsync
public Future<UpdateStageResult> updateStageAsync(UpdateStageRequest request, AsyncHandler<UpdateStageRequest,UpdateStageResult> asyncHandler)
AmazonIVSRealTimeAsync
Updates a stage’s configuration.
updateStageAsync
in interface AmazonIVSRealTimeAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonIVSRealTime
shutdown
in class AmazonIVSRealTimeClient