com.amazonaws.services.kinesisvideowebrtcstorage.AmazonKinesisVideoWebRTCStorage Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesisvideowebrtcstorage Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kinesisvideowebrtcstorage;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.kinesisvideowebrtcstorage.model.*;
/**
* Interface for accessing Amazon Kinesis Video WebRTC Storage.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.kinesisvideowebrtcstorage.AbstractAmazonKinesisVideoWebRTCStorage} instead.
*
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKinesisVideoWebRTCStorage {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "kinesisvideo";
/**
*
* 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.
*
*
*
* @param joinStorageSessionRequest
* @return 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.
* @throws InvalidArgumentException
* The value for this input parameter is invalid.
* @throws AccessDeniedException
* You do not have required permissions to perform this operation.
* @throws ResourceNotFoundException
* The specified resource is not found.
* @sample AmazonKinesisVideoWebRTCStorage.JoinStorageSession
* @see AWS API Documentation
*/
JoinStorageSessionResult joinStorageSession(JoinStorageSessionRequest joinStorageSessionRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}