Package com.amazonaws.kinesisvideo.internal.producer.jni

Class NativeKinesisVideoProducerJni

java.lang.Object

com.amazonaws.kinesisvideo.internal.producer.jni.NativeKinesisVideoProducerJni

All Implemented Interfaces:

KinesisVideoProducer

@ThreadSafe
public class NativeKinesisVideoProducerJni
extends Object
implements KinesisVideoProducer

JNI interface to the native Producer SDK library wrapper

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXPECTED_LIBRARY_VERSION	The expected library version.
static long	INVALID_CLIENT_HANDLE_VALUE	Specifying invalid client handle value
static long	INVALID_STREAM_HANDLE_VALUE	Specifying invalid stream handle value
static String	PRODUCER_NATIVE_LIBRARY_NAME	Name of the native library

Fields inherited from interface com.amazonaws.kinesisvideo.internal.producer.KinesisVideoProducer

READY_TIMEOUT_IN_MILLISECONDS

Constructor Summary

Constructors

Constructor	Description
NativeKinesisVideoProducerJni(AuthCallbacks authCallbacks, StorageCallbacks storageCallbacks, ServiceCallbacks serviceCallbacks)	Public constructor.
NativeKinesisVideoProducerJni(AuthCallbacks authCallbacks, StorageCallbacks storageCallbacks, ServiceCallbacks serviceCallbacks, org.apache.logging.log4j.Logger log)	Public constructor
NativeKinesisVideoProducerJni(AuthCallbacks authCallbacks, StorageCallbacks storageCallbacks, ServiceCallbacks serviceCallbacks, org.apache.logging.log4j.Logger log, CountDownLatch readyLatch)	Public constructor
NativeKinesisVideoProducerJni(AuthCallbacks authCallbacks, StorageCallbacks storageCallbacks, ServiceCallbacks serviceCallbacks, org.apache.logging.log4j.Logger log, CountDownLatch readyLatch, boolean isTrackingMallocs)	Public constructor

Method Summary

Modifier and Type	Method	Description
void	create(DeviceInfo deviceInfo)	Creates the underlying Kinesis Video client object
void	create(DeviceInfo deviceInfo, String nativeLibraryPath)	Creates the underlying Kinesis Video client object.
void	createDeviceResult(long customData, String deviceArn, int httpStatusCode)	CreateDevice result event
KinesisVideoProducerStream	createStream(StreamInfo streamInfo, StreamCallbacks streamCallbacks)	Creates a Kinesis Video stream
void	createStreamResult(KinesisVideoProducerStream stream, String streamArn, int httpStatusCode)	CreateStream result event
KinesisVideoProducerStream	createStreamSync(StreamInfo streamInfo, StreamCallbacks streamCallbacks)	Creates an Kinesis Video stream synchronously
void	createSync(DeviceInfo deviceInfo)	Creates the underlying Kinesis Video client object synchronously
void	createSync(DeviceInfo deviceInfo, String nativeLibraryPath)	Creates the underlying Kinesis Video client object 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	fragmentAck(long streamHandle, long uploadHandle, KinesisVideoFragmentAck kinesisVideoFragmentAck)	Report an ACK for a fragment
void	free()	Frees the underlying Kinesis Video object.
void	freeStream(KinesisVideoProducerStream stream)	Frees the specified stream
void	freeStreams()	Frees all of the underlying streams
long	getCurrentAllocationBytes()	Return the current value of the allocated memory.
KinesisVideoMetrics	getMetrics()
void	getStreamData(long streamHandle, long uploadHandle, byte[] fillBuffer, int offset, int length, ReadResult readResult)	Get stream data from the buffer for specific upload Handle.
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
void	getStreamMetrics(long streamHandle, KinesisVideoStreamMetrics streamMetrics)	Fills in the stream metrics object
boolean	isInitialized()	Returns whether the object has been initialized
boolean	isReady()	Returns whether the object is ready
void	logPrint(int level, String tag, String picFmt, String message)	Logs PIC logs
void	parseFragmentAck(long streamHandle, long uploadHandle, String kinesisVideoFragmentAck)	Parses and processes an ACK string
void	putEventMetadata(long streamHandle, int event, StreamEventMetadata streamEventMetadata)	Put an event metadata.
void	putFragmentMetadata(long streamHandle, String metadataName, String metadataValue, boolean persistent)	Put a fragment metadata.
void	putFrame(long streamHandle, KinesisVideoFrame kinesisVideoFrame)	Put a frame.
void	putStreamResult(KinesisVideoProducerStream stream, long clientStreamHandle, int httpStatusCode)	PutStream result event
static void	setupInstrumentedAllocators()	Overrides malloc and free with a custom one for tracking purposes.
void	stopStream(long streamHandle)	Stops an Kinesis Video stream.
void	stopStreams()	Stops all Kinesis Video streams.
void	streamFormatChanged(long streamHandle, byte[] codecPrivateData, long trackId)	Stream format has changed.
void	streamTerminated(long streamHandle, long uploadHandle, int statusCode)	Reports an abnormal stream termination event.
void	tagResourceResult(KinesisVideoProducerStream stream, long streamHandle, int httpStatusCode)	TagResource result event

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_CLIENT_HANDLE_VALUE

public static final long INVALID_CLIENT_HANDLE_VALUE

Specifying invalid client handle value

See Also:

Constant Field Values

INVALID_STREAM_HANDLE_VALUE

public static final long INVALID_STREAM_HANDLE_VALUE

Specifying invalid stream handle value

See Also:

Constant Field Values

PRODUCER_NATIVE_LIBRARY_NAME

public static final String PRODUCER_NATIVE_LIBRARY_NAME

Name of the native library

See Also:

Constant Field Values

EXPECTED_LIBRARY_VERSION

public static final String EXPECTED_LIBRARY_VERSION

The expected library version.

See Also:

Constant Field Values

Constructor Detail

NativeKinesisVideoProducerJni

public NativeKinesisVideoProducerJni(@Nonnull
                                     AuthCallbacks authCallbacks,
                                     @Nonnull
                                     StorageCallbacks storageCallbacks,
                                     @Nonnull
                                     ServiceCallbacks serviceCallbacks)
                              throws ProducerException

Public constructor.

Parameters:

authCallbacks - Authentication callbacks

storageCallbacks - Storage callbacks

serviceCallbacks - Service call callbacks

Throws:

ProducerException

NativeKinesisVideoProducerJni

public NativeKinesisVideoProducerJni(@Nonnull
                                     AuthCallbacks authCallbacks,
                                     @Nonnull
                                     StorageCallbacks storageCallbacks,
                                     @Nonnull
                                     ServiceCallbacks serviceCallbacks,
                                     @Nonnull
                                     org.apache.logging.log4j.Logger log)
                              throws ProducerException

Public constructor

Parameters:

authCallbacks - Authentication callbacks

storageCallbacks - Storage callbacks

serviceCallbacks - Service call callbacks

log - logger object to use for logging

Throws:

ProducerException

NativeKinesisVideoProducerJni

public NativeKinesisVideoProducerJni(@Nonnull
                                     AuthCallbacks authCallbacks,
                                     @Nonnull
                                     StorageCallbacks storageCallbacks,
                                     @Nonnull
                                     ServiceCallbacks serviceCallbacks,
                                     @Nonnull
                                     org.apache.logging.log4j.Logger log,
                                     @Nonnull
                                     CountDownLatch readyLatch)
                              throws ProducerException

Public constructor

Parameters:

authCallbacks - Authentication callbacks

storageCallbacks - Storage callbacks

serviceCallbacks - Service call callbacks

log - log object to use for logging

readyLatch - Ready latch for synch creation

Throws:

ProducerException

NativeKinesisVideoProducerJni

public NativeKinesisVideoProducerJni(@Nonnull
                                     AuthCallbacks authCallbacks,
                                     @Nonnull
                                     StorageCallbacks storageCallbacks,
                                     @Nonnull
                                     ServiceCallbacks serviceCallbacks,
                                     @Nonnull
                                     org.apache.logging.log4j.Logger log,
                                     @Nonnull
                                     CountDownLatch readyLatch,
                                     boolean isTrackingMallocs)
                              throws ProducerException

Public constructor

Parameters:

authCallbacks - Authentication callbacks

storageCallbacks - Storage callbacks

serviceCallbacks - Service call callbacks

log - log object to use for logging

readyLatch - Ready latch for synch creation

isTrackingMallocs - Whether to set up PIC's instrumented allocators

Throws:

ProducerException

Method Detail

create

public void create(@Nonnull
                   DeviceInfo deviceInfo)
            throws ProducerException

Creates the underlying Kinesis Video client object

Specified by:

create in interface KinesisVideoProducer

Parameters:

deviceInfo - DeviceInfo object

Throws:

ProducerException

createSync

public void createSync(@Nonnull
                       DeviceInfo deviceInfo)
                throws ProducerException

Creates the underlying Kinesis Video client object synchronously

Specified by:

createSync in interface KinesisVideoProducer

Parameters:

deviceInfo - DeviceInfo object

Throws:

ProducerException

create

public void create(@Nonnull
                   DeviceInfo deviceInfo,
                   @Nonnull
                   String nativeLibraryPath)
            throws ProducerException

Creates the underlying Kinesis Video client object.

Parameters:

deviceInfo - DeviceInfo object

nativeLibraryPath - Native library path

Throws:

ProducerException

createSync

public void createSync(@Nonnull
                       DeviceInfo deviceInfo,
                       @Nonnull
                       String nativeLibraryPath)
                throws ProducerException

Creates the underlying Kinesis Video client object synchronously.

Parameters:

deviceInfo - DeviceInfo object

nativeLibraryPath - Native library path

Throws:

ProducerException

isInitialized

public boolean isInitialized()

Returns whether the object has been initialized

Specified by:

isInitialized in interface KinesisVideoProducer

Returns:

whether initialized

isReady

public boolean isReady()

Returns whether the object is ready

Specified by:

isReady in interface KinesisVideoProducer

Returns:

whether the object is ready

getMetrics

@Nonnull
public KinesisVideoMetrics getMetrics()
                               throws ProducerException

Specified by:

getMetrics in interface KinesisVideoProducer

Throws:

ProducerException

free

public void free()
          throws ProducerException

Frees the underlying Kinesis Video object. This call is prompt and will terminate the ongoing transmission and drop the buffers.

Specified by:

free in interface KinesisVideoProducer

Throws:

ProducerException

createStream

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

Creates a Kinesis Video stream

Specified by:

createStream in interface KinesisVideoProducer

Parameters:

streamInfo - Stream information StreamInfo object

streamCallbacks - Optional stream callbacks StreamCallbacks

Returns:

Newly create Kinesis Video stream

Throws:

ProducerException

createStreamSync

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

Creates an Kinesis Video stream synchronously

Specified by:

createStreamSync in interface KinesisVideoProducer

Parameters:

streamInfo - Stream information StreamInfo object

streamCallbacks - Optional stream callnbacks StreamCallbacks

Returns:

Newly created Kinesis Video stream

Throws:

ProducerException

stopStreams

public void stopStreams()
                 throws ProducerException

Stops all Kinesis Video streams. This is an async operation and the buffers will continue draining.

Specified by:

stopStreams in interface KinesisVideoProducer

Throws:

ProducerException

stopStream

public void stopStream(long streamHandle)
                throws ProducerException

Stops an Kinesis Video stream. This is an async operation and the buffers will continue draining until streamStopped event is received.

Parameters:

streamHandle - the handle of the stream

Throws:

ProducerException

freeStreams

public void freeStreams()
                 throws ProducerException

Description copied from interface: KinesisVideoProducer

Frees all of the underlying streams

Specified by:

freeStreams in interface KinesisVideoProducer

Throws:

ProducerException

freeStream

public void freeStream(@Nonnull
                       KinesisVideoProducerStream stream)
                throws ProducerException

Description copied from interface: KinesisVideoProducer

Frees the specified stream

Specified by:

freeStream in interface KinesisVideoProducer

Parameters:

stream - Stream to free

Throws:

ProducerException

streamTerminated

public void streamTerminated(long streamHandle,
                             long uploadHandle,
                             int statusCode)
                      throws ProducerException

Reports an abnormal stream termination event.

Parameters:

streamHandle - the handle of the stream

uploadHandle - the client stream upload handle

statusCode - the status code of the termination event.

Throws:

ProducerException

getStreamMetrics

public void getStreamMetrics(long streamHandle,
                             @Nonnull
                             KinesisVideoStreamMetrics streamMetrics)
                      throws ProducerException

Fills in the stream metrics object

Parameters:

streamHandle - the handle of the stream

streamMetrics - stream metrics to fill in

Throws:

ProducerException

putFrame

public void putFrame(long streamHandle,
                     @Nonnull
                     KinesisVideoFrame kinesisVideoFrame)
              throws ProducerException

Put a frame.

Parameters:

streamHandle - the handle of the stream

kinesisVideoFrame - an KinesisVideoFrame object

Throws:

ProducerException

putFragmentMetadata

public void putFragmentMetadata(long streamHandle,
                                @Nonnull
                                String metadataName,
                                @Nonnull
                                String metadataValue,
                                boolean persistent)
                         throws ProducerException

Put a fragment metadata.

Parameters:

streamHandle - the handle of the stream

metadataName - metadata name

metadataValue - metadata value

persistent - whether this is persistent metadata or not

Throws:

ProducerException

putEventMetadata

public void putEventMetadata(long streamHandle,
                             int event,
                             @Nullable
                             StreamEventMetadata streamEventMetadata)
                      throws ProducerException

Put an event metadata.

Parameters:

streamHandle - The handle of the stream.

event - The type of event(s), a value from the StreamEventType enum. If you want to submit multiple events in one call it is suggested to use bit-wise OR combination from StreamEventType enum.

streamEventMetadata - Optional metadata. This metadata will be applied to all events included in THIS function call.

Throws:

ProducerException

fragmentAck

public void fragmentAck(long streamHandle,
                        long uploadHandle,
                        @Nonnull
                        KinesisVideoFragmentAck kinesisVideoFragmentAck)
                 throws ProducerException

Report an ACK for a fragment

Parameters:

streamHandle - the handle of the stream

kinesisVideoFragmentAck - an KinesisVideoFragmentAck object

Throws:

ProducerException

parseFragmentAck

public void parseFragmentAck(long streamHandle,
                             long uploadHandle,
                             @Nonnull
                             String kinesisVideoFragmentAck)
                      throws ProducerException

Parses and processes an ACK string

Parameters:

streamHandle - the handle of the stream

kinesisVideoFragmentAck - string containing ACKs

Throws:

ProducerException

getStreamData

public void getStreamData(long streamHandle,
                          long uploadHandle,
                          @Nonnull
                          byte[] fillBuffer,
                          int offset,
                          int length,
                          @Nonnull
                          ReadResult readResult)
                   throws ProducerException

Get stream data from the buffer for specific upload Handle. Each uploadHandle correspond to a PutMedia connection to Kinesis Video Streams.

Parameters:

streamHandle - the handle of the stream

uploadHandle - the client stream upload handle

fillBuffer - The buffer to fill

offset - The start of the buffer

length - The number of bytes to fill

readResult - The read result to fill in

Throws:

ProducerException

streamFormatChanged

public void streamFormatChanged(long streamHandle,
                                @Nullable
                                byte[] codecPrivateData,
                                long trackId)
                         throws ProducerException

Stream format has changed. Currently, only supporting Codec Private Data

Parameters:

streamHandle - the handle of the stream

codecPrivateData - Codec Private Data or null to reset

Throws:

ProducerException

createStreamResult

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

Description copied from interface: KinesisVideoProducer

CreateStream result event

Specified by:

createStreamResult in interface KinesisVideoProducer

Parameters:

stream - Stream object for the result event callback

streamArn - Newly create stream ARN on success

httpStatusCode - HTTP status code

Throws:

ProducerException

describeStreamResult

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

Description copied from interface: KinesisVideoProducer

DescribeStream result event

Specified by:

describeStreamResult in interface KinesisVideoProducer

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

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

Description copied from interface: KinesisVideoProducer

GetStreamingEndpoint result event

Specified by:

getStreamingEndpointResult in interface KinesisVideoProducer

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

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

Description copied from interface: KinesisVideoProducer

GetStreamingToken result event

Specified by:

getStreamingTokenResult in interface KinesisVideoProducer

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

public void putStreamResult(KinesisVideoProducerStream stream,
                            long clientStreamHandle,
                            int httpStatusCode)
                     throws ProducerException

Description copied from interface: KinesisVideoProducer

PutStream result event

Specified by:

putStreamResult in interface KinesisVideoProducer

Parameters:

stream - Stream object for the result event callback

clientStreamHandle - A stream upload handle identifier from the client side

httpStatusCode - HTTP status code

Throws:

ProducerException

tagResourceResult

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

Description copied from interface: KinesisVideoProducer

TagResource result event

Specified by:

tagResourceResult in interface KinesisVideoProducer

Parameters:

stream - Stream object for the result event callback

streamHandle - Stream handle returned by PIC

httpStatusCode - HTTP status code

Throws:

ProducerException

createDeviceResult

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

Description copied from interface: KinesisVideoProducer

CreateDevice result event

Specified by:

createDeviceResult in interface KinesisVideoProducer

Parameters:

customData - Used for the result event callback

deviceArn - Newly create device ARN on success

httpStatusCode - HTTP status code

Throws:

ProducerException

deviceCertToTokenResult

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

Description copied from interface: KinesisVideoProducer

DeviceCertToToken result event

Specified by:

deviceCertToTokenResult in interface KinesisVideoProducer

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

logPrint

@CalledByNativeCode
public void logPrint(@Nonnull
                     int level,
                     @Nonnull
                     String tag,
                     @Nonnull
                     String picFmt,
                     @Nonnull
                     String message)

Logs PIC logs

Parameters:

level - - log level from PIC

tag - - tag from PIC

picFmt - - fmt from PIC

message - - the string to be logged

setupInstrumentedAllocators

public static void setupInstrumentedAllocators()

Overrides malloc and free with a custom one for tracking purposes.

getCurrentAllocationBytes

public long getCurrentAllocationBytes()

Return the current value of the allocated memory. Note: Due to lazy memory allocation, this may not accurately reflect the current RSS usage.

Returns:

the current memory currently malloc'd by the native codebase in bytes.