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 and Description
static class	StreamInfo.NalAdaptationFlags NAL adaptation types enum.
static class	StreamInfo.StreamingType Streaming types that must correspond to the native counterparts

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and 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, 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)

Method Summary

Modifier and Type	Method and 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()
byte[]	getCodecPrivateData()
long	getConnectionStalenessDuration()
String	getContentType()
long	getFragmentDuration()
int	getFrameRate()
String	getKmsKeyId()
long	getMaxLatency()
int	getNalAdaptationFlags()
String	getName()
long	getReplayDuration()
long	getRetentionPeriod()
int	getStreamingType()
Tag[]	getTags()
long	getTimecodeScale()
String	getTrackName()
int	getVersion()
boolean	isAbsoluteFragmentTimes()
boolean	isAdaptive()
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)

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

public int getVersion()

getName

@Nullable
public String getName()

getStreamingType

public int getStreamingType()

getContentType

@NonNull
public String getContentType()

getKmsKeyId

@Nullable
public String getKmsKeyId()

getRetentionPeriod

public long getRetentionPeriod()

isAdaptive

public boolean isAdaptive()

getMaxLatency

public long getMaxLatency()

getFragmentDuration

public long getFragmentDuration()

isKeyFrameFragmentation

public boolean isKeyFrameFragmentation()

isFrameTimecodes

public boolean isFrameTimecodes()

isAbsoluteFragmentTimes

public boolean isAbsoluteFragmentTimes()

isFragmentAcks

public boolean isFragmentAcks()

isRecoverOnError

public boolean isRecoverOnError()

getCodecId

@Nullable
public String getCodecId()

getTrackName

@Nullable
public String getTrackName()

getAvgBandwidthBps

public int getAvgBandwidthBps()

getFrameRate

public int getFrameRate()

getBufferDuration

public long getBufferDuration()

getReplayDuration

public long getReplayDuration()

getConnectionStalenessDuration

public long getConnectionStalenessDuration()

getTimecodeScale

public long getTimecodeScale()

isRecalculateMetrics

public boolean isRecalculateMetrics()

getCodecPrivateData

@Nullable
public byte[] getCodecPrivateData()

getTags

@Nullable
public Tag[] getTags()

getNalAdaptationFlags

@NonNull
public int getNalAdaptationFlags()