Package com.amazonaws.kinesisvideo.internal.producer

Interface KinesisVideoProducerStream

All Superinterfaces:

StreamCallbacks

All Known Implementing Classes:

NativeKinesisVideoProducerStream, PendingCreationKinesisVideoStream

public interface KinesisVideoProducerStream
extends StreamCallbacks

KinesisVideo stream interface

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
void	fragmentAck(long uploadHandle, KinesisVideoFragmentAck kinesisVideoFragmentAck)	Reports an ACK for a fragment.
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()	Reset current connection of producer stream
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	streamFormatChanged(byte[] codecPrivateData, int trackId)	Indicates that the stream format has changed.
void	streamFreed()	Free the Kinesis Video stream.
void	streamTerminated(long uploadHandle, int statusCode)	Reports an abnormal stream termination

Methods inherited from interface com.amazonaws.kinesisvideo.producer.StreamCallbacks

bufferDurationOverflowPressure, droppedFragmentReport, droppedFrameReport, fragmentAckReceived, streamClosed, streamConnectionStale, streamDataAvailable, streamErrorReport, streamLatencyPressure, streamReady, streamUnderflowReport

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

STOPPED_TIMEOUT_IN_MILLISECONDS

static final long STOPPED_TIMEOUT_IN_MILLISECONDS

Stopped timeout value in milliseconds for the sync API

See Also:

Constant Field Values

Method Detail

getDataStream

@Nonnull
InputStream getDataStream(long uploadHandle)
                   throws ProducerException

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.

Parameters:

uploadHandle - Client stream upload handle.

Returns:

InputStream for retrieving the data

Throws:

ProducerException

getStreamData

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

Get stream data from the buffer.

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

void putFrame(@Nonnull
              KinesisVideoFrame kinesisVideoFrame)
       throws ProducerException

Puts a frame into the stream.

Throws:

ProducerException

putFragmentMetadata

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

Puts a fragment metadata into the stream.

Throws:

ProducerException

putEventMetadata

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

Puts an event metadata into the stream.

Throws:

ProducerException

fragmentAck

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

Reports an ACK for a fragment.

Parameters:

uploadHandle - Client stream upload handle.

kinesisVideoFragmentAck - ACK string returned from the service.

Throws:

ProducerException

parseFragmentAck

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

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

Parameters:

uploadHandle - Client stream upload handle.

kinesisVideoFragmentAck - ACK string returned from the service.

Throws:

ProducerException

streamFormatChanged

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

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.

Throws:

ProducerException

getStreamHandle

long getStreamHandle()

Returns the underlying native stream handle

Returns:

getStreamName

@Nonnull
String getStreamName()

Returns the stream name

stopStream

void stopStream()
         throws ProducerException

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

Throws:

ProducerException

stopStreamSync

void stopStreamSync()
             throws ProducerException

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

Throws:

ProducerException

streamTerminated

void streamTerminated(long uploadHandle,
                      int statusCode)
               throws ProducerException

Reports an abnormal stream termination

Parameters:

uploadHandle - - Client stream upload handle.

statusCode - - Status code of the termination.

Throws:

ProducerException

getMetrics

@Nonnull
KinesisVideoStreamMetrics getMetrics()
                              throws ProducerException

Returns stream specific metrics.

Returns:

Stream metrics

Throws:

ProducerException

streamFreed

void streamFreed()
          throws ProducerException

Free the Kinesis Video stream.

Throws:

ProducerException

resetConnection

void resetConnection()
              throws ProducerException

Reset current connection of producer stream

Throws:

ProducerException

getStreamInfo

@Nonnull
StreamInfo getStreamInfo()