com.amazonaws.services.kinesisvideowebrtcstorage

Class AmazonKinesisVideoWebRTCStorageAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kinesisvideowebrtcstorage.AmazonKinesisVideoWebRTCStorageClient

com.amazonaws.services.kinesisvideowebrtcstorage.AmazonKinesisVideoWebRTCStorageAsyncClient

All Implemented Interfaces:

AmazonKinesisVideoWebRTCStorage, AmazonKinesisVideoWebRTCStorageAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonKinesisVideoWebRTCStorageAsyncClient
extends AmazonKinesisVideoWebRTCStorageClient
implements AmazonKinesisVideoWebRTCStorageAsync

Client for accessing Amazon Kinesis Video WebRTC Storage asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.kinesisvideowebrtcstorage.AmazonKinesisVideoWebRTCStorage

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonKinesisVideoWebRTCStorageAsyncClientBuilder	asyncBuilder()
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<JoinStorageSessionResult>	joinStorageSessionAsync(JoinStorageSessionRequest request) Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel.
Future<JoinStorageSessionResult>	joinStorageSessionAsync(JoinStorageSessionRequest request, AsyncHandler<JoinStorageSessionRequest,JoinStorageSessionResult> asyncHandler) Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.kinesisvideowebrtcstorage.AmazonKinesisVideoWebRTCStorageClient

builder, getCachedResponseMetadata, joinStorageSession

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.kinesisvideowebrtcstorage.AmazonKinesisVideoWebRTCStorage

getCachedResponseMetadata, joinStorageSession

Method Detail

asyncBuilder

public static AmazonKinesisVideoWebRTCStorageAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

joinStorageSessionAsync

public Future<JoinStorageSessionResult> joinStorageSessionAsync(JoinStorageSessionRequest request)

Description copied from interface: AmazonKinesisVideoWebRTCStorageAsync

Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel. If there’s no existing session for the channel, a new streaming session needs to be created, and the Amazon Resource Name (ARN) of the signaling channel must be provided.

Currently for the SINGLE_MASTER type, a video producing device is able to ingest both audio and video media into a stream, while viewers can only ingest audio. Both a video producing device and viewers can join the session first, and wait for other participants.

While participants are having peer to peer conversations through webRTC, the ingested media session will be stored into the Kinesis Video Stream. Multiple viewers are able to playback real-time media.

Customers can also use existing Kinesis Video Streams features like HLS or DASH playback, Image generation, and more with ingested WebRTC media.

Assume that only one video producing device client can be associated with a session for the channel. If more than one client joins the session of a specific channel as a video producing device, the most recent client request takes precedence.

Specified by:

joinStorageSessionAsync in interface AmazonKinesisVideoWebRTCStorageAsync

Returns:

A Java Future containing the result of the JoinStorageSession operation returned by the service.

See Also:

AWS API Documentation

joinStorageSessionAsync

public Future<JoinStorageSessionResult> joinStorageSessionAsync(JoinStorageSessionRequest request,
                                                                AsyncHandler<JoinStorageSessionRequest,JoinStorageSessionResult> asyncHandler)

Description copied from interface: AmazonKinesisVideoWebRTCStorageAsync

Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel. If there’s no existing session for the channel, a new streaming session needs to be created, and the Amazon Resource Name (ARN) of the signaling channel must be provided.

Currently for the SINGLE_MASTER type, a video producing device is able to ingest both audio and video media into a stream, while viewers can only ingest audio. Both a video producing device and viewers can join the session first, and wait for other participants.

While participants are having peer to peer conversations through webRTC, the ingested media session will be stored into the Kinesis Video Stream. Multiple viewers are able to playback real-time media.

Customers can also use existing Kinesis Video Streams features like HLS or DASH playback, Image generation, and more with ingested WebRTC media.

Assume that only one video producing device client can be associated with a session for the channel. If more than one client joins the session of a specific channel as a video producing device, the most recent client request takes precedence.

Specified by:

joinStorageSessionAsync in interface AmazonKinesisVideoWebRTCStorageAsync

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.

Returns:

A Java Future containing the result of the JoinStorageSession operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonKinesisVideoWebRTCStorage

Overrides:

shutdown in class AmazonKinesisVideoWebRTCStorageClient