Package com.amazonaws.kinesisvideo.internal.producer

Interface KinesisVideoProducer

All Known Implementing Classes:

NativeKinesisVideoProducerJni

public interface KinesisVideoProducer

Interface to the Kinesis Video Producer functionality

Field Summary

Fields

Modifier and Type	Field	Description
static long	READY_TIMEOUT_IN_MILLISECONDS	Ready timeout value in milliseconds for the sync API

Method Summary

Modifier and Type	Method	Description
void	create(DeviceInfo deviceInfo)	Creates the underlying producer client.
void	createDeviceResult(long customData, String deviceArn, int httpStatusCode)	CreateDevice result event
KinesisVideoProducerStream	createStream(StreamInfo streamInfo, StreamCallbacks streamCallbacks)	Creates Kinesis Video stream
void	createStreamResult(KinesisVideoProducerStream stream, String streamArn, int httpStatusCode)	CreateStream result event
KinesisVideoProducerStream	createStreamSync(StreamInfo streamInfo, StreamCallbacks streamCallbacks)	Creates Kinesis Video stream synchronously
void	createSync(DeviceInfo deviceInfo)	Creates the underlying producer client synchronously.
void	describeStreamResult(KinesisVideoProducerStream stream, long streamHandle, StreamDescription streamDescription, int httpStatusCode)	DescribeStream result event
void	deviceCertToTokenResult(long customData, byte[] token, long expiration, int httpStatusCode)	DeviceCertToToken result event
void	free()	Stops the streams and frees/releases the underlying object
void	freeStream(KinesisVideoProducerStream stream)	Frees the specified stream
void	freeStreams()	Frees all of the underlying streams
KinesisVideoMetrics	getMetrics()
void	getStreamingEndpointResult(KinesisVideoProducerStream stream, long streamHandle, String endpoint, int httpStatusCode)	GetStreamingEndpoint result event
void	getStreamingTokenResult(KinesisVideoProducerStream stream, long streamHandle, byte[] token, long expiration, int httpStatusCode)	GetStreamingToken result event
boolean	isInitialized()	Returns whether the client has been initialized
boolean	isReady()	Returns whether the client has been initialized and ready for the stream to be created.
void	putStreamResult(KinesisVideoProducerStream stream, long uploadHandle, int httpStatusCode)	PutStream result event
void	stopStreams()	Stops all the streams
void	tagResourceResult(KinesisVideoProducerStream stream, long streamHandle, int httpStatusCode)	TagResource result event

Field Detail

READY_TIMEOUT_IN_MILLISECONDS

static final long READY_TIMEOUT_IN_MILLISECONDS

Ready timeout value in milliseconds for the sync API

See Also:

Constant Field Values

Method Detail

isInitialized

boolean isInitialized()

Returns whether the client has been initialized

isReady

boolean isReady()

Returns whether the client has been initialized and ready for the stream to be created.

create

void create(@Nonnull
            DeviceInfo deviceInfo)
     throws ProducerException

Creates the underlying producer client.

Parameters:

deviceInfo - DeviceInfo object

Throws:

ProducerException

createSync

void createSync(@Nonnull
                DeviceInfo deviceInfo)
         throws ProducerException

Creates the underlying producer client synchronously.

Parameters:

deviceInfo - DeviceInfo object

Throws:

ProducerException

free

void free()
   throws ProducerException

Stops the streams and frees/releases the underlying object

Throws:

ProducerException

freeStreams

void freeStreams()
          throws ProducerException

Frees all of the underlying streams

Throws:

ProducerException

stopStreams

void stopStreams()
          throws ProducerException

Stops all the streams

Throws:

ProducerException

createStream

@Nonnull
KinesisVideoProducerStream createStream(@Nonnull
                                        StreamInfo streamInfo,
                                        @Nullable
                                        StreamCallbacks streamCallbacks)
                                 throws ProducerException

Creates Kinesis Video stream

Parameters:

streamInfo - Stream information StreamInfo object

streamCallbacks - Optional stream callnbacks StreamCallbacks

Returns:

The newly created stream

Throws:

ProducerException

createStreamSync

@Nonnull
KinesisVideoProducerStream createStreamSync(@Nonnull
                                            StreamInfo streamInfo,
                                            @Nullable
                                            StreamCallbacks streamCallbacks)
                                     throws ProducerException

Creates Kinesis Video stream synchronously

Parameters:

streamInfo - Stream information StreamInfo object

streamCallbacks - Optional stream callnbacks StreamCallbacks

Returns:

The newly created stream

Throws:

ProducerException

freeStream

void freeStream(@Nonnull
                KinesisVideoProducerStream stream)
         throws ProducerException

Frees the specified stream

Parameters:

stream - Stream to free

Throws:

ProducerException

createStreamResult

void createStreamResult(@Nonnull
                        KinesisVideoProducerStream stream,
                        @Nullable
                        String streamArn,
                        int httpStatusCode)
                 throws ProducerException

CreateStream result event

Parameters:

stream - Stream object for the result event callback

streamArn - Newly create stream ARN on success

httpStatusCode - HTTP status code

Throws:

ProducerException

describeStreamResult

void describeStreamResult(@Nonnull
                          KinesisVideoProducerStream stream,
                          long streamHandle,
                          @Nullable
                          StreamDescription streamDescription,
                          int httpStatusCode)
                   throws ProducerException

DescribeStream result event

Parameters:

stream - Stream object for the result event callback

streamHandle - Stream handle returned by PIC

streamDescription - Stream description object

httpStatusCode - HTTP status code

Throws:

ProducerException

getStreamingEndpointResult

void getStreamingEndpointResult(@Nonnull
                                KinesisVideoProducerStream stream,
                                long streamHandle,
                                @Nullable
                                String endpoint,
                                int httpStatusCode)
                         throws ProducerException

GetStreamingEndpoint result event

Parameters:

stream - Stream object for the result event callback

streamHandle - Stream handle returned by PIC

endpoint - Streaming endpoint if successful

httpStatusCode - HTTP status code

Throws:

ProducerException

getStreamingTokenResult

void getStreamingTokenResult(@Nonnull
                             KinesisVideoProducerStream stream,
                             long streamHandle,
                             @Nullable
                             byte[] token,
                             long expiration,
                             int httpStatusCode)
                      throws ProducerException

GetStreamingToken result event

Parameters:

stream - Stream object for the result event callback

streamHandle - Stream handle returned by PIC

token - Streaming token if successful

expiration - Streaming token expiration in absolute time in 100ns

httpStatusCode - HTTP status code

Throws:

ProducerException

putStreamResult

void putStreamResult(@Nonnull
                     KinesisVideoProducerStream stream,
                     long uploadHandle,
                     int httpStatusCode)
              throws ProducerException

PutStream result event

Parameters:

stream - Stream object for the result event callback

uploadHandle - A stream upload handle identifier from the client side

httpStatusCode - HTTP status code

Throws:

ProducerException

tagResourceResult

void tagResourceResult(@Nonnull
                       KinesisVideoProducerStream stream,
                       long streamHandle,
                       int httpStatusCode)
                throws ProducerException

TagResource result event

Parameters:

stream - Stream object for the result event callback

streamHandle - Stream handle returned by PIC

httpStatusCode - HTTP status code

Throws:

ProducerException

createDeviceResult

void createDeviceResult(long customData,
                        @Nullable
                        String deviceArn,
                        int httpStatusCode)
                 throws ProducerException

CreateDevice result event

Parameters:

customData - Used for the result event callback

deviceArn - Newly create device ARN on success

httpStatusCode - HTTP status code

Throws:

ProducerException

deviceCertToTokenResult

void deviceCertToTokenResult(long customData,
                             @Nullable
                             byte[] token,
                             long expiration,
                             int httpStatusCode)
                      throws ProducerException

DeviceCertToToken result event

Parameters:

customData - Used for the result event callback

token - Security token if successful

expiration - Streaming token expiration in absolute time in 100ns

httpStatusCode - HTTP status code

Throws:

ProducerException

getMetrics

@Nonnull
KinesisVideoMetrics getMetrics()
                        throws ProducerException

Throws:

ProducerException