Package com.amazonaws.kinesisvideo.producer

Interface StreamCallbacks

All Known Subinterfaces:

KinesisVideoProducerStream

All Known Implementing Classes:

DefaultStreamCallbacks, NativeKinesisVideoProducerStream, PendingCreationKinesisVideoStream

public interface StreamCallbacks

Interface to the Kinesis Video Producer Stream Callbacks functionality. These will be used to report various stream latency pressures and report dropped frames.

Method Summary

Modifier and Type	Method	Description
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	fragmentAckReceived(long uploadHandle, KinesisVideoFragmentAck fragmentAck)	Reports the received ACK.
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	streamLatencyPressure(long duration)	Reports the stream latency pressure.
void	streamReady()	Ready to stream data.
void	streamUnderflowReport()	Reports the stream underflow.

Method Detail

streamUnderflowReport

void streamUnderflowReport()
                    throws ProducerException

Reports the stream underflow.

Throws:

ProducerException

streamLatencyPressure

void streamLatencyPressure(long duration)
                    throws ProducerException

Reports the stream latency pressure.

Parameters:

duration - The buffer duration in 100ns.

Throws:

ProducerException

streamConnectionStale

void streamConnectionStale(long lastAckDuration)
                    throws ProducerException

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

Parameters:

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

Throws:

ProducerException

fragmentAckReceived

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

Reports the received ACK.

Parameters:

uploadHandle - The client stream upload handle.

fragmentAck - The received fragment ACK.

Throws:

ProducerException

droppedFrameReport

void droppedFrameReport(long frameTimecode)
                 throws ProducerException

Reports a dropped frame for the stream.

Parameters:

frameTimecode - Frame time code of the dropped frame.

Throws:

ProducerException

droppedFragmentReport

void droppedFragmentReport(long fragmentTimecode)
                    throws ProducerException

Reports a dropped fragment for the stream.

Parameters:

fragmentTimecode - Fragment time code of the dropped fragment.

Throws:

ProducerException

streamErrorReport

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

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

Parameters:

uploadHandle - The client stream upload handle.

fragmentTimecode - Fragment time code of the errored fragment.

statusCode - Status code of the failure.

Throws:

ProducerException

streamDataAvailable

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

New data is available for the stream.

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

void streamReady()
          throws ProducerException

Ready to stream data.

Throws:

ProducerException

streamClosed

void streamClosed(long uploadHandle)
           throws ProducerException

Stream has been closed.

Parameters:

uploadHandle - The client stream upload handle.

Throws:

ProducerException

bufferDurationOverflowPressure

void bufferDurationOverflowPressure(long remainDuration)
                             throws ProducerException

Stream temporal buffer pressure.

Parameters:

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

Throws:

ProducerException