Package com.amazonaws.kinesisvideo.internal.producer

Class KinesisVideoStreamMetrics

java.lang.Object

com.amazonaws.kinesisvideo.internal.producer.KinesisVideoStreamMetrics

public class KinesisVideoStreamMetrics
extends Object

Kinesis Video stream object metrics provided by the native codebase. NOTE: The interesting aspect of this class is that it has a setter method to set all the values instead of individual ones or a constructor. This is done for the performance optimization reasons.

Constructor Summary

Constructors

Constructor	Description
KinesisVideoStreamMetrics()

Method Summary

Modifier and Type	Method	Description
double	getCurrentFrameRate()	Returns the current frame rate in frames per second
long	getCurrentTransferRate()	Returns the current transfer rate in bytes per second
long	getCurrentViewDurationInMillis()	Returns the duration in milliseconds from current to head
long	getCurrentViewDurationInTimeUnits()	Returns the duration from current to head in 100ns
long	getCurrentViewSize()	Returns the byte size of all allocations from current to head
long	getOverallViewDurationInMillis()	Returns the entire content view duration in milliseconds
long	getOverallViewDurationInTimeUnits()	Returns the entire content view duration in 100ns
long	getOverallViewSize()	Returns the byte size of all allocations in the content view
void	setMetrics(long overallViewSize, long currentViewSize, long overallViewDuration, long currentViewDuration, double currentFrameRate, long currentTransferRate)	Sets the metrics - will be called from the native code

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisVideoStreamMetrics

public KinesisVideoStreamMetrics()

Method Detail

setMetrics

@CalledByNativeCode
public void setMetrics(long overallViewSize,
                       long currentViewSize,
                       long overallViewDuration,
                       long currentViewDuration,
                       double currentFrameRate,
                       long currentTransferRate)

Sets the metrics - will be called from the native code

Parameters:

overallViewSize - byte size of allocations in the entire content view

currentViewSize - byte size of allocations from current to head

overallViewDuration - duration of the entire vontent view

currentViewDuration - duration from the current to head

currentFrameRate - current frame rate

currentTransferRate - current transfer rate in bytes per second

getCurrentViewDurationInTimeUnits

public long getCurrentViewDurationInTimeUnits()

Returns the duration from current to head in 100ns

Returns:

duration from current to head

getCurrentViewDurationInMillis

public long getCurrentViewDurationInMillis()

Returns the duration in milliseconds from current to head

Returns:

duration from current to head

getOverallViewDurationInTimeUnits

public long getOverallViewDurationInTimeUnits()

Returns the entire content view duration in 100ns

Returns:

content view duration

getOverallViewDurationInMillis

public long getOverallViewDurationInMillis()

Returns the entire content view duration in milliseconds

Returns:

content view duration

getCurrentViewSize

public long getCurrentViewSize()

Returns the byte size of all allocations from current to head

Returns:

allocated from current to head

getOverallViewSize

public long getOverallViewSize()

Returns the byte size of all allocations in the content view

Returns:

allocated in the content view

getCurrentFrameRate

public double getCurrentFrameRate()

Returns the current frame rate in frames per second

Returns:

current frame rate frames per second

getCurrentTransferRate

public long getCurrentTransferRate()

Returns the current transfer rate in bytes per second

Returns:

current bytes per second transfer rate