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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringcreateStream(String streamName, String deviceName, String contentType, String kmsKeyId, long retentionPeriodInHours, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)Create a stream on KinesisVideo frontendvoiddeleteStream(String streamName, String version, Date creationTime, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)Delete stream with name and versionStreamDescriptiondescribeStream(String streamName, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)Describe the status of a streamstatic com.amazonaws.services.kinesisvideo.AmazonKinesisVideogetAmazonKinesisVideoClient(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, com.amazonaws.regions.Region region, String endpoint, int timeoutInMillis)StringgetDataEndpoint(String streamName, String apiName, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)Get data endpoint to be used by PutMedia for the specified stream.voidinitialize(KinesisVideoClientConfiguration kinesisVideoClientConfiguration)Initialize with the network configuration.voidputMedia(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.voidtagStream(String streamArn, Map<String,String> tags, long timeoutInMillis, KinesisVideoCredentialsProvider credentialsProvider)Tag a stream of a specified ARN with a list of tags.StringtoString()
-
-
-
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:KinesisVideoServiceClientInitialize with the network configuration.- Specified by:
initializein interfaceKinesisVideoServiceClient- 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:KinesisVideoServiceClientCreate a stream on KinesisVideo frontend- Specified by:
createStreamin interfaceKinesisVideoServiceClient- Parameters:
streamName- - Name of stream to createdeviceName- - Device name of stream to createcontentType- - Content type of stream to createkmsKeyId- - KMS Key IdretentionPeriodInHours- - Stream retention period in hourstimeoutInMillis- - Timeout in millisecondscredentialsProvider- - 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:KinesisVideoServiceClientDescribe the status of a stream- Specified by:
describeStreamin interfaceKinesisVideoServiceClient- Parameters:
streamName- - Name of stream to describetimeoutInMillis- - Timeout in millisecondscredentialsProvider- - 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:KinesisVideoServiceClientDelete stream with name and version- Specified by:
deleteStreamin interfaceKinesisVideoServiceClient- Parameters:
streamName- - Name of stream to deleteversion- - Version of stream to deletecreationTime- - Creation time of stream to deletetimeoutInMillis- - Timeout in millisecondscredentialsProvider- - 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:KinesisVideoServiceClientTag a stream of a specified ARN with a list of tags.- Specified by:
tagStreamin interfaceKinesisVideoServiceClient- Parameters:
streamArn- - ARN of the stream to be taggedtags- - Map of key-value pairtimeoutInMillis- - Timeout in millisecondscredentialsProvider- - 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:KinesisVideoServiceClientGet data endpoint to be used by PutMedia for the specified stream.- Specified by:
getDataEndpointin interfaceKinesisVideoServiceClient- Parameters:
streamName- - Name of the streamapiName- - Api name to calltimeoutInMillis- - Timeout in millisecondscredentialsProvider- - 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:KinesisVideoServiceClientPuts 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:
putMediain interfaceKinesisVideoServiceClient- Parameters:
streamName- - Name of the streamcontainerType- - Container typestreamStartTimeInMillis- - Stream start timeabsoluteFragmentTimes- - Whether to use absolute fragment timesackRequired- - Whether acks are requireddataEndpoint- - The data endpoint to usetimeoutInMillis- - Timeout in millisecondscredentialsProvider- - Credentials to usedataInputStream- - DataInputStreamacksConsumer- - Consumer of the ACK input streamcompletionCallback- - Consumer of an Exception for reporting stream termination- Throws:
KinesisVideoException
-
-