Package com.amazonaws.kinesisvideo.java.service

Class JavaKinesisVideoServiceClient

java.lang.Object

com.amazonaws.kinesisvideo.java.service.JavaKinesisVideoServiceClient

All Implemented Interfaces:

KinesisVideoServiceClient

public final class JavaKinesisVideoServiceClient
extends Object
implements KinesisVideoServiceClient

Constructor Summary

Constructors

Constructor	Description
JavaKinesisVideoServiceClient()
JavaKinesisVideoServiceClient(org.apache.logging.log4j.Logger log)	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	createStream(String streamName, String deviceName, String contentType, String kmsKeyId, long retentionPeriodInHours, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)	Create a stream on KinesisVideo frontend
void	deleteStream(String streamName, String version, Date creationTime, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)	Delete stream with name and version
StreamDescription	describeStream(String streamName, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)	Describe the status of a stream
static com.amazonaws.services.kinesisvideo.AmazonKinesisVideo	getAmazonKinesisVideoClient(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, com.amazonaws.regions.Region region, String endpoint, int timeoutInMillis)
String	getDataEndpoint(String streamName, String apiName, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)	Get data endpoint to be used by PutMedia for the specified stream.
void	initialize(KinesisVideoClientConfiguration kinesisVideoClientConfiguration)	Initialize with the network configuration.
void	putMedia(String streamName, String containerType, long streamStartTimeInMillis, boolean absoluteFragmentTimes, boolean ackRequired, String dataEndpoint, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider, InputStream dataInputStream, Consumer<InputStream> acksConsumer, Consumer<Exception> completionCallback)	Puts media as a long-running operation.
void	tagStream(String streamArn, Map<String,String> tags, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)	Tag a stream of a specified ARN with a list of tags.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JavaKinesisVideoServiceClient

public JavaKinesisVideoServiceClient()

JavaKinesisVideoServiceClient

@Deprecated
public JavaKinesisVideoServiceClient(@Nonnull
                                     org.apache.logging.log4j.Logger log)

Deprecated.

Method Detail

getAmazonKinesisVideoClient

@Nonnull
public static com.amazonaws.services.kinesisvideo.AmazonKinesisVideo getAmazonKinesisVideoClient(@Nonnull
                                                                                                 com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
                                                                                                 @Nonnull
                                                                                                 com.amazonaws.regions.Region region,
                                                                                                 @Nonnull
                                                                                                 String endpoint,
                                                                                                 int timeoutInMillis)
                                                                                          throws KinesisVideoException

Throws:

KinesisVideoException

initialize

public void initialize(@Nonnull
                       KinesisVideoClientConfiguration kinesisVideoClientConfiguration)
                throws KinesisVideoException

Description copied from interface: KinesisVideoServiceClient

Initialize with the network configuration.

Specified by:

initialize in interface KinesisVideoServiceClient

Parameters:

kinesisVideoClientConfiguration - - Client configuration to initialize with

Throws:

KinesisVideoException

createStream

public String createStream(@Nonnull
                           String streamName,
                           @Nonnull
                           String deviceName,
                           @Nonnull
                           String contentType,
                           @Nullable
                           String kmsKeyId,
                           long retentionPeriodInHours,
                           long timeoutInMillis,
                           @Nullable
                           KinesisVideoCredentialsProvider credentialsProvider)
                    throws KinesisVideoException

Description copied from interface: KinesisVideoServiceClient

Create a stream on KinesisVideo frontend

Specified by:

createStream in interface KinesisVideoServiceClient

Parameters:

streamName - - Name of stream to create

deviceName - - Device name of stream to create

contentType - - Content type of stream to create

kmsKeyId - - KMS Key Id

retentionPeriodInHours - - Stream retention period in hours

timeoutInMillis - - Timeout in milliseconds

credentialsProvider - - Credentials to use

Returns:

StreamArn of stream just created

Throws:

KinesisVideoException

describeStream

public StreamDescription describeStream(@Nonnull
                                        String streamName,
                                        long timeoutInMillis,
                                        @Nullable
                                        KinesisVideoCredentialsProvider credentialsProvider)
                                 throws KinesisVideoException

Description copied from interface: KinesisVideoServiceClient

Describe the status of a stream

Specified by:

describeStream in interface KinesisVideoServiceClient

Parameters:

streamName - - Name of stream to describe

timeoutInMillis - - Timeout in milliseconds

credentialsProvider - - Credentials to use

Returns:

Stream description

Throws:

KinesisVideoException

deleteStream

public void deleteStream(@Nonnull
                         String streamName,
                         @Nonnull
                         String version,
                         Date creationTime,
                         long timeoutInMillis,
                         @Nullable
                         KinesisVideoCredentialsProvider credentialsProvider)
                  throws KinesisVideoException

Description copied from interface: KinesisVideoServiceClient

Delete stream with name and version

Specified by:

deleteStream in interface KinesisVideoServiceClient

Parameters:

streamName - - Name of stream to delete

version - - Version of stream to delete

creationTime - - Creation time of stream to delete

timeoutInMillis - - Timeout in milliseconds

credentialsProvider - - Credentials to use

Throws:

KinesisVideoException

tagStream

public void tagStream(@Nonnull
                      String streamArn,
                      @Nullable
                      Map<String,String> tags,
                      long timeoutInMillis,
                      @Nullable
                      KinesisVideoCredentialsProvider credentialsProvider)
               throws KinesisVideoException

Description copied from interface: KinesisVideoServiceClient

Tag a stream of a specified ARN with a list of tags.

Specified by:

tagStream in interface KinesisVideoServiceClient

Parameters:

streamArn - - ARN of the stream to be tagged

tags - - Map of key-value pair

timeoutInMillis - - Timeout in milliseconds

credentialsProvider - - Credentials to use

Throws:

KinesisVideoException

getDataEndpoint

public String getDataEndpoint(@Nonnull
                              String streamName,
                              @Nonnull
                              String apiName,
                              long timeoutInMillis,
                              @Nullable
                              KinesisVideoCredentialsProvider credentialsProvider)
                       throws KinesisVideoException

Description copied from interface: KinesisVideoServiceClient

Get data endpoint to be used by PutMedia for the specified stream.

Specified by:

getDataEndpoint in interface KinesisVideoServiceClient

Parameters:

streamName - - Name of the stream

apiName - - Api name to call

timeoutInMillis - - Timeout in milliseconds

credentialsProvider - - Credentials to use

Returns:

endpoint to which PutMedia API is sent

Throws:

KinesisVideoException

putMedia

public void putMedia(@Nonnull
                     String streamName,
                     @Nonnull
                     String containerType,
                     long streamStartTimeInMillis,
                     boolean absoluteFragmentTimes,
                     boolean ackRequired,
                     @Nonnull
                     String dataEndpoint,
                     long timeoutInMillis,
                     @Nullable
                     KinesisVideoCredentialsProvider credentialsProvider,
                     @Nonnull
                     InputStream dataInputStream,
                     @Nonnull
                     Consumer<InputStream> acksConsumer,
                     @Nullable
                     Consumer<Exception> completionCallback)
              throws KinesisVideoException

Description copied from interface: KinesisVideoServiceClient

Puts media as a long-running operation.

NOTE: The call will be 'prompt' and will return the IO streams which will be used for the actual streaming.

Specified by:

putMedia in interface KinesisVideoServiceClient

Parameters:

streamName - - Name of the stream

containerType - - Container type

streamStartTimeInMillis - - Stream start time

absoluteFragmentTimes - - Whether to use absolute fragment times

ackRequired - - Whether acks are required

dataEndpoint - - The data endpoint to use

timeoutInMillis - - Timeout in milliseconds

credentialsProvider - - Credentials to use

dataInputStream - - Data InputStream

acksConsumer - - Consumer of the ACK input stream

completionCallback - - Consumer of an Exception for reporting stream termination

Throws:

KinesisVideoException

toString

public String toString()

Overrides:

toString in class Object