@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ChimeSdkMediaPipelinesAsyncClient extends SdkClient
builder() method.
The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines and capture audio, video, events, and data messages from Amazon Chime SDK meetings. For more information about media pipleines, see Amzon Chime SDK media pipelines.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static ChimeSdkMediaPipelinesAsyncClient create()
ChimeSdkMediaPipelinesAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ChimeSdkMediaPipelinesAsyncClientBuilder builder()
ChimeSdkMediaPipelinesAsyncClient.default CompletableFuture<CreateMediaCapturePipelineResponse> createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest)
Creates a media capture pipeline.
createMediaCapturePipelineRequest - default CompletableFuture<CreateMediaCapturePipelineResponse> createMediaCapturePipeline(Consumer<CreateMediaCapturePipelineRequest.Builder> createMediaCapturePipelineRequest)
Creates a media capture pipeline.
This is a convenience which creates an instance of the CreateMediaCapturePipelineRequest.Builder avoiding
the need to create one manually via CreateMediaCapturePipelineRequest.builder()
createMediaCapturePipelineRequest - A Consumer that will call methods on CreateMediaCapturePipelineRequest.Builder to create a
request.default CompletableFuture<DeleteMediaCapturePipelineResponse> deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest)
Deletes the media capture pipeline.
deleteMediaCapturePipelineRequest - default CompletableFuture<DeleteMediaCapturePipelineResponse> deleteMediaCapturePipeline(Consumer<DeleteMediaCapturePipelineRequest.Builder> deleteMediaCapturePipelineRequest)
Deletes the media capture pipeline.
This is a convenience which creates an instance of the DeleteMediaCapturePipelineRequest.Builder avoiding
the need to create one manually via DeleteMediaCapturePipelineRequest.builder()
deleteMediaCapturePipelineRequest - A Consumer that will call methods on DeleteMediaCapturePipelineRequest.Builder to create a
request.default CompletableFuture<GetMediaCapturePipelineResponse> getMediaCapturePipeline(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest)
Gets an existing media capture pipeline.
getMediaCapturePipelineRequest - default CompletableFuture<GetMediaCapturePipelineResponse> getMediaCapturePipeline(Consumer<GetMediaCapturePipelineRequest.Builder> getMediaCapturePipelineRequest)
Gets an existing media capture pipeline.
This is a convenience which creates an instance of the GetMediaCapturePipelineRequest.Builder avoiding
the need to create one manually via GetMediaCapturePipelineRequest.builder()
getMediaCapturePipelineRequest - A Consumer that will call methods on GetMediaCapturePipelineRequest.Builder to create a
request.default CompletableFuture<ListMediaCapturePipelinesResponse> listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest)
Returns a list of media capture pipelines.
listMediaCapturePipelinesRequest - default CompletableFuture<ListMediaCapturePipelinesResponse> listMediaCapturePipelines(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest)
Returns a list of media capture pipelines.
This is a convenience which creates an instance of the ListMediaCapturePipelinesRequest.Builder avoiding
the need to create one manually via ListMediaCapturePipelinesRequest.builder()
listMediaCapturePipelinesRequest - A Consumer that will call methods on ListMediaCapturePipelinesRequest.Builder to create a
request.default ListMediaCapturePipelinesPublisher listMediaCapturePipelinesPaginator(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest)
Returns a list of media capture pipelines.
This is a variant of
listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation.
listMediaCapturePipelinesRequest - default ListMediaCapturePipelinesPublisher listMediaCapturePipelinesPaginator(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest)
Returns a list of media capture pipelines.
This is a variant of
listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation.
This is a convenience which creates an instance of the ListMediaCapturePipelinesRequest.Builder avoiding
the need to create one manually via ListMediaCapturePipelinesRequest.builder()
listMediaCapturePipelinesRequest - A Consumer that will call methods on ListMediaCapturePipelinesRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to an Amazon Chime SDK media capture pipeline.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags applied to an Amazon Chime SDK media capture pipeline.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.Copyright © 2022. All rights reserved.