com.amazonaws.services.kinesisvideowebrtcstorage

Interface AmazonKinesisVideoWebRTCStorage

All Known Subinterfaces:

AmazonKinesisVideoWebRTCStorageAsync

All Known Implementing Classes:

AbstractAmazonKinesisVideoWebRTCStorage, AbstractAmazonKinesisVideoWebRTCStorageAsync, AmazonKinesisVideoWebRTCStorageAsyncClient, AmazonKinesisVideoWebRTCStorageClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKinesisVideoWebRTCStorage

Interface for accessing Amazon Kinesis Video WebRTC Storage.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKinesisVideoWebRTCStorage instead.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
JoinStorageSessionResult	joinStorageSession(JoinStorageSessionRequest joinStorageSessionRequest) 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 this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

joinStorageSession

JoinStorageSessionResult joinStorageSession(JoinStorageSessionRequest joinStorageSessionRequest)

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.

Parameters:

joinStorageSessionRequest -

Returns:

Result of the JoinStorageSession operation returned by the service.

Throws:

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException - The value for this input parameter is invalid.

AccessDeniedException - You do not have required permissions to perform this operation.

ResourceNotFoundException - The specified resource is not found.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.