Package com.amazonaws.kinesisvideo.producer

Class StreamInfo

java.lang.Object

com.amazonaws.kinesisvideo.producer.StreamInfo

public class StreamInfo
extends Object

Stream information class.

NOTE: This should follow the structure defined in /client/Include.h StreamCaps in https://github.com/awslabs/amazon-kinesis-video-streams-producer-sdk-cpp/blob/master/kinesis-video-pic/src/client/include/com/amazonaws/kinesis/video/client/Include.h

NOTE: Suppressing Findbug to eliminate unnecessary mem copy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamInfo.NalAdaptationFlags	NAL adaptation types enum.
static class	StreamInfo.StorePressurePolicy	Storage pressure policy that must correspond to the native counterparts
static class	StreamInfo.StreamingType	Streaming types that must correspond to the native counterparts

Field Summary

Fields

Modifier and Type	Field	Description
static int	STREAM_INFO_CURRENT_VERSION	StreamInfo structure current version.

Constructor Summary

Constructors

Constructor	Description
StreamInfo(int version, String name, StreamInfo.StreamingType streamingType, String contentType, String kmsKeyId, long retentionPeriod, boolean adaptive, long maxLatency, long fragmentDuration, boolean keyFrameFragmentation, boolean frameTimecodes, boolean absoluteFragmentTimes, boolean fragmentAcks, boolean recoverOnError, int avgBandwidthBps, int frameRate, long bufferDuration, long replayDuration, long connectionStalenessDuration, long timecodeScale, boolean recalculateMetrics, Tag[] tags, StreamInfo.NalAdaptationFlags nalAdaptationFlags, UUID segmentUuid, TrackInfo[] trackInfoList, boolean allowStreamCreation)
StreamInfo(int version, String name, StreamInfo.StreamingType streamingType, String contentType, String kmsKeyId, long retentionPeriod, boolean adaptive, long maxLatency, long fragmentDuration, boolean keyFrameFragmentation, boolean frameTimecodes, boolean absoluteFragmentTimes, boolean fragmentAcks, boolean recoverOnError, int avgBandwidthBps, int frameRate, long bufferDuration, long replayDuration, long connectionStalenessDuration, long timecodeScale, boolean recalculateMetrics, Tag[] tags, StreamInfo.NalAdaptationFlags nalAdaptationFlags, UUID segmentUuid, TrackInfo[] trackInfoList, FrameOrderMode frameOrderMode, boolean allowStreamCreation)
StreamInfo(int version, String name, StreamInfo.StreamingType streamingType, String contentType, String kmsKeyId, long retentionPeriod, boolean adaptive, long maxLatency, long fragmentDuration, boolean keyFrameFragmentation, boolean frameTimecodes, boolean absoluteFragmentTimes, boolean fragmentAcks, boolean recoverOnError, int avgBandwidthBps, int frameRate, long bufferDuration, long replayDuration, long connectionStalenessDuration, long timecodeScale, boolean recalculateMetrics, Tag[] tags, StreamInfo.NalAdaptationFlags nalAdaptationFlags, UUID segmentUuid, TrackInfo[] trackInfoList, FrameOrderMode frameOrderMode, StreamInfo.StorePressurePolicy storePressurePolicy, boolean allowStreamCreation)
StreamInfo(int version, String name, StreamInfo.StreamingType streamingType, String contentType, String kmsKeyId, long retentionPeriod, boolean adaptive, long maxLatency, long fragmentDuration, boolean keyFrameFragmentation, boolean frameTimecodes, boolean absoluteFragmentTimes, boolean fragmentAcks, boolean recoverOnError, String codecId, String trackName, int avgBandwidthBps, int frameRate, long bufferDuration, long replayDuration, long connectionStalenessDuration, long timecodeScale, boolean recalculateMetrics, byte[] codecPrivateData, Tag[] tags, StreamInfo.NalAdaptationFlags nalAdaptationFlags, boolean allowStreamCreation)

Method Summary

Modifier and Type	Method	Description
static String	codecIdFromContentType(String contentType)
static String	createTrackName(String contentType)	Generates a track name from a content type
int	getAvgBandwidthBps()
long	getBufferDuration()
String	getCodecId()
String	getCodecId(int trackIndex)
byte[]	getCodecPrivateData()
byte[]	getCodecPrivateData(int trackIndex)
long	getConnectionStalenessDuration()
String	getContentType()
long	getFragmentDuration()
int	getFrameOrderMode()
int	getFrameRate()
String	getKmsKeyId()
long	getMaxLatency()
int	getNalAdaptationFlags()
String	getName()
long	getReplayDuration()
long	getRetentionPeriod()
UUID	getSegmentUuid()
byte[]	getSegmentUuidBytes()
int	getStorePressurePolicy()
int	getStreamingType()
String	getSummary()	This is like a toString method except it doesn't print the full representation of this StreamInfo.
Tag[]	getTags()
long	getTimecodeScale()
long	getTrackId(int trackIndex)
int	getTrackInfoCount()
TrackInfo[]	getTrackInfoList()
int	getTrackInfoType(int trackIndex)
int	getTrackInfoVersion(int trackIndex)
String	getTrackName()
String	getTrackName(int trackIndex)
int	getVersion()
boolean	isAbsoluteFragmentTimes()
boolean	isAdaptive()
boolean	isAllowStreamCreation()
boolean	isFragmentAcks()
boolean	isFrameTimecodes()
boolean	isKeyFrameFragmentation()
boolean	isRecalculateMetrics()
boolean	isRecoverOnError()

Methods inherited from class java.lang.Object

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

Field Detail

STREAM_INFO_CURRENT_VERSION

public static final int STREAM_INFO_CURRENT_VERSION

StreamInfo structure current version. IMPORTANT: Must be kept in sync with the native counterpart.

See Also:

Constant Field Values

Constructor Detail

StreamInfo

public StreamInfo(int version,
                  @Nullable
                  String name,
                  @Nonnull
                  StreamInfo.StreamingType streamingType,
                  @Nonnull
                  String contentType,
                  @Nullable
                  String kmsKeyId,
                  long retentionPeriod,
                  boolean adaptive,
                  long maxLatency,
                  long fragmentDuration,
                  boolean keyFrameFragmentation,
                  boolean frameTimecodes,
                  boolean absoluteFragmentTimes,
                  boolean fragmentAcks,
                  boolean recoverOnError,
                  @Nullable
                  String codecId,
                  @Nullable
                  String trackName,
                  int avgBandwidthBps,
                  int frameRate,
                  long bufferDuration,
                  long replayDuration,
                  long connectionStalenessDuration,
                  long timecodeScale,
                  boolean recalculateMetrics,
                  @Nullable
                  byte[] codecPrivateData,
                  @Nullable
                  Tag[] tags,
                  @Nonnull
                  StreamInfo.NalAdaptationFlags nalAdaptationFlags,
                  boolean allowStreamCreation)

StreamInfo

public StreamInfo(int version,
                  @Nullable
                  String name,
                  @Nonnull
                  StreamInfo.StreamingType streamingType,
                  @Nonnull
                  String contentType,
                  @Nullable
                  String kmsKeyId,
                  long retentionPeriod,
                  boolean adaptive,
                  long maxLatency,
                  long fragmentDuration,
                  boolean keyFrameFragmentation,
                  boolean frameTimecodes,
                  boolean absoluteFragmentTimes,
                  boolean fragmentAcks,
                  boolean recoverOnError,
                  int avgBandwidthBps,
                  int frameRate,
                  long bufferDuration,
                  long replayDuration,
                  long connectionStalenessDuration,
                  long timecodeScale,
                  boolean recalculateMetrics,
                  @Nullable
                  Tag[] tags,
                  @Nonnull
                  StreamInfo.NalAdaptationFlags nalAdaptationFlags,
                  @Nullable
                  UUID segmentUuid,
                  @Nonnull
                  TrackInfo[] trackInfoList,
                  boolean allowStreamCreation)

StreamInfo

public StreamInfo(int version,
                  @Nullable
                  String name,
                  @Nonnull
                  StreamInfo.StreamingType streamingType,
                  @Nonnull
                  String contentType,
                  @Nullable
                  String kmsKeyId,
                  long retentionPeriod,
                  boolean adaptive,
                  long maxLatency,
                  long fragmentDuration,
                  boolean keyFrameFragmentation,
                  boolean frameTimecodes,
                  boolean absoluteFragmentTimes,
                  boolean fragmentAcks,
                  boolean recoverOnError,
                  int avgBandwidthBps,
                  int frameRate,
                  long bufferDuration,
                  long replayDuration,
                  long connectionStalenessDuration,
                  long timecodeScale,
                  boolean recalculateMetrics,
                  @Nullable
                  Tag[] tags,
                  @Nonnull
                  StreamInfo.NalAdaptationFlags nalAdaptationFlags,
                  @Nullable
                  UUID segmentUuid,
                  @Nonnull
                  TrackInfo[] trackInfoList,
                  FrameOrderMode frameOrderMode,
                  boolean allowStreamCreation)

StreamInfo

public StreamInfo(int version,
                  @Nullable
                  String name,
                  @Nonnull
                  StreamInfo.StreamingType streamingType,
                  @Nonnull
                  String contentType,
                  @Nullable
                  String kmsKeyId,
                  long retentionPeriod,
                  boolean adaptive,
                  long maxLatency,
                  long fragmentDuration,
                  boolean keyFrameFragmentation,
                  boolean frameTimecodes,
                  boolean absoluteFragmentTimes,
                  boolean fragmentAcks,
                  boolean recoverOnError,
                  int avgBandwidthBps,
                  int frameRate,
                  long bufferDuration,
                  long replayDuration,
                  long connectionStalenessDuration,
                  long timecodeScale,
                  boolean recalculateMetrics,
                  @Nullable
                  Tag[] tags,
                  @Nonnull
                  StreamInfo.NalAdaptationFlags nalAdaptationFlags,
                  @Nullable
                  UUID segmentUuid,
                  @Nonnull
                  TrackInfo[] trackInfoList,
                  FrameOrderMode frameOrderMode,
                  StreamInfo.StorePressurePolicy storePressurePolicy,
                  boolean allowStreamCreation)

Method Detail

createTrackName

@Nonnull
public static String createTrackName(@Nonnull
                                     String contentType)

Generates a track name from a content type

Parameters:

contentType - Content type

Returns:

Generated track name.

codecIdFromContentType

@Nonnull
public static String codecIdFromContentType(@Nonnull
                                            String contentType)
                                     throws KinesisVideoException

Throws:

KinesisVideoException

getVersion

@CalledByNativeCode
public int getVersion()

getName

@Nullable
@CalledByNativeCode
public String getName()

getStreamingType

@CalledByNativeCode
public int getStreamingType()

getContentType

@Nonnull
@CalledByNativeCode
public String getContentType()

getKmsKeyId

@Nullable
@CalledByNativeCode
public String getKmsKeyId()

getRetentionPeriod

@CalledByNativeCode
public long getRetentionPeriod()

isAdaptive

@CalledByNativeCode
public boolean isAdaptive()

getMaxLatency

@CalledByNativeCode
public long getMaxLatency()

getFragmentDuration

@CalledByNativeCode
public long getFragmentDuration()

isKeyFrameFragmentation

@CalledByNativeCode
public boolean isKeyFrameFragmentation()

isFrameTimecodes

@CalledByNativeCode
public boolean isFrameTimecodes()

isAbsoluteFragmentTimes

@CalledByNativeCode
public boolean isAbsoluteFragmentTimes()

isFragmentAcks

@CalledByNativeCode
public boolean isFragmentAcks()

isRecoverOnError

@CalledByNativeCode
public boolean isRecoverOnError()

getAvgBandwidthBps

@CalledByNativeCode
public int getAvgBandwidthBps()

getFrameRate

@CalledByNativeCode
public int getFrameRate()

getBufferDuration

@CalledByNativeCode
public long getBufferDuration()

getReplayDuration

@CalledByNativeCode
public long getReplayDuration()

getConnectionStalenessDuration

@CalledByNativeCode
public long getConnectionStalenessDuration()

getTimecodeScale

@CalledByNativeCode
public long getTimecodeScale()

isRecalculateMetrics

@CalledByNativeCode
public boolean isRecalculateMetrics()

getSegmentUuid

@Nullable
public UUID getSegmentUuid()

getSegmentUuidBytes

@Nullable
@CalledByNativeCode
public byte[] getSegmentUuidBytes()

getTrackInfoList

@Nonnull
@CalledByNativeCode
public TrackInfo[] getTrackInfoList()

getTrackInfoCount

@CalledByNativeCode
public int getTrackInfoCount()

getCodecId

@Nullable
@CalledByNativeCode
public String getCodecId(int trackIndex)

getTrackName

@Nullable
@CalledByNativeCode
public String getTrackName(int trackIndex)

getCodecPrivateData

@Nullable
@CalledByNativeCode
public byte[] getCodecPrivateData()

getCodecId

@Nullable
@CalledByNativeCode
public String getCodecId()

getTrackName

@Nullable
@CalledByNativeCode
public String getTrackName()

getCodecPrivateData

@Nullable
@CalledByNativeCode
public byte[] getCodecPrivateData(int trackIndex)

getTrackId

@CalledByNativeCode
public long getTrackId(int trackIndex)

getTrackInfoType

@CalledByNativeCode
public int getTrackInfoType(int trackIndex)

getTrackInfoVersion

@CalledByNativeCode
public int getTrackInfoVersion(int trackIndex)

getTags

@Nullable
@CalledByNativeCode
public Tag[] getTags()

getNalAdaptationFlags

@Nonnull
@CalledByNativeCode
public int getNalAdaptationFlags()

getFrameOrderMode

@CalledByNativeCode
public int getFrameOrderMode()

getStorePressurePolicy

@CalledByNativeCode
public int getStorePressurePolicy()

isAllowStreamCreation

@CalledByNativeCode
public boolean isAllowStreamCreation()

getSummary

public String getSummary()

This is like a toString method except it doesn't print the full representation of this StreamInfo.

Returns:

A summarized version of this StreamInfo for logging purposes.