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

Class NativeKinesisVideoProducerStream

java.lang.Object

com.amazonaws.kinesisvideo.internal.producer.jni.NativeKinesisVideoProducerStream

All Implemented Interfaces:

KinesisVideoProducerStream, StreamCallbacks

public class NativeKinesisVideoProducerStream
extends Object
implements KinesisVideoProducerStream

Implementation of KinesisVideoProducerStream

Field Summary

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

READY_TIMEOUT_IN_MILLISECONDS, STOPPED_TIMEOUT_IN_MILLISECONDS

Constructor Summary

Constructors

Constructor	Description
NativeKinesisVideoProducerStream(NativeKinesisVideoProducerJni kinesisVideoProducerJni, StreamInfo streamInfo, long streamHandle, org.apache.logging.log4j.Logger log, StreamCallbacks streamCallbacks, DeviceInfo deviceInfo)

Method Summary

Modifier and Type	Method	Description
void	awaitReady()	Deprecated.
void	awaitReady(Set<Long> readyStreamHandles)
void	awaitStopped()
void	bufferDurationOverflowPressure(long remainDuration)	Stream temporal buffer pressure.
void	droppedFragmentReport(long fragmentTimecode)	Reports a dropped fragment for the stream.
void	droppedFrameReport(long frameTimecode)	Reports a dropped frame for the stream.
void	fragmentAck(long uploadHandle, KinesisVideoFragmentAck kinesisVideoFragmentAck)	Reports an ACK for a fragment.
void	fragmentAckReceived(long uploadHandle, KinesisVideoFragmentAck fragmentAck)	Reports the received ACK.
InputStream	getDataStream(long uploadHandle)	Returns the input stream to retrieve the data from.
KinesisVideoStreamMetrics	getMetrics()	Returns stream specific metrics.
void	getStreamData(long uploadHandle, byte[] fillBuffer, int offset, int length, ReadResult readResult)	Get stream data from the buffer.
long	getStreamHandle()	Returns the underlying native stream handle
StreamInfo	getStreamInfo()
String	getStreamName()	Returns the stream name
void	parseFragmentAck(long uploadHandle, String kinesisVideoFragmentAck)	Parses and processes a response which can contain partial/multiple fragment ACK.
void	putEventMetadata(int event, StreamEventMetadata streamEventMetadata)	Puts an event metadata into the stream.
void	putFragmentMetadata(String metadataName, String metadataValue, boolean persistent)	Puts a fragment metadata into the stream.
void	putFrame(KinesisVideoFrame kinesisVideoFrame)	Puts a frame into the stream.
void	resetConnection()	Create a new connection to continue sending data in current buffer
void	stopStream()	Stops the Kinesis Video stream.
void	stopStreamSync()	Stops the Kinesis Video stream and awaits for the stream stopped notification in a sync call.
void	streamClosed(long uploadHandle)	Stream has been closed.
void	streamConnectionStale(long lastAckDuration)	Reports the stream staleness when the data is read and sent but no ACKs are received.
void	streamDataAvailable(long uploadHandle, long duration, long availableSize)	New data is available for the stream.
void	streamErrorReport(long uploadHandle, long fragmentTimecode, long statusCode)	Reports an error for the stream.
void	streamFormatChanged(byte[] codecPrivateData, int trackId)	Indicates that the stream format has changed.
void	streamFreed()	Free the Kinesis Video stream.
void	streamLatencyPressure(long duration)	Reports the stream latency pressure.
void	streamReady()	Ready to stream data.
void	streamTerminated(long uploadHandle, int statusCode)	Reports an abnormal stream termination
void	streamUnderflowReport()	Reports the stream underflow.

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeKinesisVideoProducerStream

public NativeKinesisVideoProducerStream(@Nonnull
                                        NativeKinesisVideoProducerJni kinesisVideoProducerJni,
                                        @Nonnull
                                        StreamInfo streamInfo,
                                        long streamHandle,
                                        @Nonnull
                                        org.apache.logging.log4j.Logger log,
                                        @Nullable
                                        StreamCallbacks streamCallbacks,
                                        @Nullable
                                        DeviceInfo deviceInfo)

Method Detail

getDataStream

public InputStream getDataStream(long uploadHandle)
                          throws ProducerException

Description copied from interface: KinesisVideoProducerStream

Returns the input stream to retrieve the data from. NOTE: The returned stream should ideally be buffered like BufferedInputStream IMPORTANT: During the streaming token rotation or when the underlying stream gets closed the stream returned by this function will also close. The caller then should re-acquire a new stream by calling this API again.

Specified by:

getDataStream in interface KinesisVideoProducerStream

Parameters:

uploadHandle - Client stream upload handle.

Returns:

InputStream for retrieving the data

Throws:

ProducerException

getStreamData

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

Description copied from interface: KinesisVideoProducerStream

Get stream data from the buffer.

Specified by:

getStreamData in interface KinesisVideoProducerStream

Parameters:

uploadHandle - Client stream upload handle.

fillBuffer - The buffer to fill

offset - The start of the buffer

length - The number of bytes to fill

readResult - The result of the read

Throws:

ProducerException

putFrame

public void putFrame(@Nonnull
                     KinesisVideoFrame kinesisVideoFrame)
              throws ProducerException

Description copied from interface: KinesisVideoProducerStream

Puts a frame into the stream.

Specified by:

putFrame in interface KinesisVideoProducerStream

Throws:

ProducerException

putFragmentMetadata

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

Description copied from interface: KinesisVideoProducerStream

Puts a fragment metadata into the stream.

Specified by:

putFragmentMetadata in interface KinesisVideoProducerStream

Throws:

ProducerException

putEventMetadata

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

Description copied from interface: KinesisVideoProducerStream

Puts an event metadata into the stream.

Specified by:

putEventMetadata in interface KinesisVideoProducerStream

Throws:

ProducerException

fragmentAck

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

Description copied from interface: KinesisVideoProducerStream

Reports an ACK for a fragment.

Specified by:

fragmentAck in interface KinesisVideoProducerStream

Parameters:

uploadHandle - Client stream upload handle.

kinesisVideoFragmentAck - ACK string returned from the service.

Throws:

ProducerException

parseFragmentAck

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

Description copied from interface: KinesisVideoProducerStream

Parses and processes a response which can contain partial/multiple fragment ACK.

Specified by:

parseFragmentAck in interface KinesisVideoProducerStream

Parameters:

uploadHandle - Client stream upload handle.

kinesisVideoFragmentAck - ACK string returned from the service.

Throws:

ProducerException

streamFormatChanged

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

Description copied from interface: KinesisVideoProducerStream

Indicates that the stream format has changed. NOTE: CPD is @Nullable - specifying a null will remove the CPD. NOTE: currently, only Codec Private Data is supported while not streaming.

Specified by:

streamFormatChanged in interface KinesisVideoProducerStream

Throws:

ProducerException

streamTerminated

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

Description copied from interface: KinesisVideoProducerStream

Reports an abnormal stream termination

Specified by:

streamTerminated in interface KinesisVideoProducerStream

Parameters:

uploadHandle - - Client stream upload handle.

statusCode - - Status code of the termination.

Throws:

ProducerException

stopStream

public void stopStream()
                throws ProducerException

Description copied from interface: KinesisVideoProducerStream

Stops the Kinesis Video stream. This simply kicks off stop stream operation but doesn't await for the resulting stream stopped notification.

Specified by:

stopStream in interface KinesisVideoProducerStream

Throws:

ProducerException

stopStreamSync

public void stopStreamSync()
                    throws ProducerException

Description copied from interface: KinesisVideoProducerStream

Stops the Kinesis Video stream and awaits for the stream stopped notification in a sync call.

Specified by:

stopStreamSync in interface KinesisVideoProducerStream

Throws:

ProducerException

getMetrics

@Nonnull
public KinesisVideoStreamMetrics getMetrics()
                                     throws ProducerException

Description copied from interface: KinesisVideoProducerStream

Returns stream specific metrics.

Specified by:

getMetrics in interface KinesisVideoProducerStream

Returns:

Stream metrics

Throws:

ProducerException

getStreamName

public String getStreamName()

Description copied from interface: KinesisVideoProducerStream

Returns the stream name

Specified by:

getStreamName in interface KinesisVideoProducerStream

getStreamHandle

public long getStreamHandle()

Description copied from interface: KinesisVideoProducerStream

Returns the underlying native stream handle

Specified by:

getStreamHandle in interface KinesisVideoProducerStream

Returns:

streamFreed

public void streamFreed()
                 throws ProducerException

Description copied from interface: KinesisVideoProducerStream

Free the Kinesis Video stream.

Specified by:

streamFreed in interface KinesisVideoProducerStream

Throws:

ProducerException

streamUnderflowReport

public void streamUnderflowReport()
                           throws ProducerException

Description copied from interface: StreamCallbacks

Reports the stream underflow.

Specified by:

streamUnderflowReport in interface StreamCallbacks

Throws:

ProducerException

streamLatencyPressure

public void streamLatencyPressure(long duration)
                           throws ProducerException

Description copied from interface: StreamCallbacks

Reports the stream latency pressure.

Specified by:

streamLatencyPressure in interface StreamCallbacks

Parameters:

duration - The buffer duration in 100ns.

Throws:

ProducerException

streamConnectionStale

public void streamConnectionStale(long lastAckDuration)
                           throws ProducerException

Description copied from interface: StreamCallbacks

Reports the stream staleness when the data is read and sent but no ACKs are received.

Specified by:

streamConnectionStale in interface StreamCallbacks

Parameters:

lastAckDuration - The duration of time window when the last "buffering" ACK is received in 100ns.

Throws:

ProducerException

fragmentAckReceived

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

Description copied from interface: StreamCallbacks

Reports the received ACK.

Specified by:

fragmentAckReceived in interface StreamCallbacks

Parameters:

uploadHandle - The client stream upload handle.

fragmentAck - The received fragment ACK.

Throws:

ProducerException

droppedFrameReport

public void droppedFrameReport(long frameTimecode)
                        throws ProducerException

Description copied from interface: StreamCallbacks

Reports a dropped frame for the stream.

Specified by:

droppedFrameReport in interface StreamCallbacks

Parameters:

frameTimecode - Frame time code of the dropped frame.

Throws:

ProducerException

droppedFragmentReport

public void droppedFragmentReport(long fragmentTimecode)
                           throws ProducerException

Description copied from interface: StreamCallbacks

Reports a dropped fragment for the stream.

Specified by:

droppedFragmentReport in interface StreamCallbacks

Parameters:

fragmentTimecode - Fragment time code of the dropped fragment.

Throws:

ProducerException

streamErrorReport

public void streamErrorReport(long uploadHandle,
                              long fragmentTimecode,
                              long statusCode)
                       throws ProducerException

Description copied from interface: StreamCallbacks

Reports an error for the stream. The client should terminate the connection as the inlet host would have/has already terminated the connection.

Specified by:

streamErrorReport in interface StreamCallbacks

Parameters:

uploadHandle - The client stream upload handle.

fragmentTimecode - Fragment time code of the errored fragment.

statusCode - Status code of the failure.

Throws:

ProducerException

streamDataAvailable

public void streamDataAvailable(long uploadHandle,
                                long duration,
                                long availableSize)
                         throws ProducerException

Description copied from interface: StreamCallbacks

New data is available for the stream.

Specified by:

streamDataAvailable in interface StreamCallbacks

Parameters:

uploadHandle - The client stream upload handle.

duration - The duration of content available in the stream.

availableSize - The size of the content available in the stream.

Throws:

ProducerException

streamReady

public void streamReady()
                 throws ProducerException

Description copied from interface: StreamCallbacks

Ready to stream data.

Specified by:

streamReady in interface StreamCallbacks

Throws:

ProducerException

streamClosed

public void streamClosed(long uploadHandle)
                  throws ProducerException

Description copied from interface: StreamCallbacks

Stream has been closed.

Specified by:

streamClosed in interface StreamCallbacks

Parameters:

uploadHandle - The client stream upload handle.

Throws:

ProducerException

bufferDurationOverflowPressure

public void bufferDurationOverflowPressure(long remainDuration)
                                    throws ProducerException

Description copied from interface: StreamCallbacks

Stream temporal buffer pressure.

Specified by:

bufferDurationOverflowPressure in interface StreamCallbacks

Parameters:

remainDuration - Remaining duration in the buffer in hundreds of nanos.

Throws:

ProducerException

resetConnection

public void resetConnection()
                     throws ProducerException

Create a new connection to continue sending data in current buffer

Specified by:

resetConnection in interface KinesisVideoProducerStream

Throws:

ProducerException

awaitReady

@Deprecated
public void awaitReady()
                throws ProducerException

Deprecated.

Throws:

ProducerException

awaitReady

public void awaitReady(@Nonnull
                       Set<Long> readyStreamHandles)
                throws ProducerException

Throws:

ProducerException

awaitStopped

public void awaitStopped()
                  throws ProducerException

Throws:

ProducerException

getStreamInfo

@Nonnull
public StreamInfo getStreamInfo()

Specified by:

getStreamInfo in interface KinesisVideoProducerStream