com.amazonaws.services.kinesisvideowebrtcstorage.AmazonKinesisVideoWebRTCStorageAsync Maven / Gradle / Ivy

Go to download
/*
 * 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.services.kinesisvideowebrtcstorage.model.*;

/**
 * Interface 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 {@code AsyncHandler} can be
 * used to receive notification when an asynchronous operation completes.
 * 
 * Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
 * {@link com.amazonaws.services.kinesisvideowebrtcstorage.AbstractAmazonKinesisVideoWebRTCStorageAsync} instead.
 * 
 * 
 * 

 * 
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKinesisVideoWebRTCStorageAsync extends AmazonKinesisVideoWebRTCStorage {

    /**
     * 
     * 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 A Java Future containing the result of the JoinStorageSession operation returned by the service.
     * @sample AmazonKinesisVideoWebRTCStorageAsync.JoinStorageSession
     * @see AWS API Documentation
     */
    java.util.concurrent.Future joinStorageSessionAsync(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.
     * 
     * 
     * 
     * @param joinStorageSessionRequest
     * @param 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.
     * @return A Java Future containing the result of the JoinStorageSession operation returned by the service.
     * @sample AmazonKinesisVideoWebRTCStorageAsyncHandler.JoinStorageSession
     * @see AWS API Documentation
     */
    java.util.concurrent.Future joinStorageSessionAsync(JoinStorageSessionRequest joinStorageSessionRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

}