Serialized Form (AWS Java SDK for Amazon Kinesis Video Streams 1.11.767 API)

Package com.amazonaws.services.kinesisvideo.model
- Class com.amazonaws.services.kinesisvideo.model.AccessDeniedException extends AmazonKinesisVideoException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesisvideo.model.AccountChannelLimitExceededException extends AmazonKinesisVideoException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesisvideo.model.AccountStreamLimitExceededException extends AmazonKinesisVideoException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesisvideo.model.AckEvent extends Object implements Serializable
  - Serialized Fields
    - ackEventType
```
AckEventType ackEventType
```
    - fragmentTimecode
```
Long fragmentTimecode
```
    - fragmentNumber
```
String fragmentNumber
```
    - errorCode
```
AckErrorCode errorCode
```
    - errorId
```
Integer errorId
```
- Class com.amazonaws.services.kinesisvideo.model.AmazonKinesisVideoException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesisvideo.model.ChannelInfo extends Object implements Serializable
  - Serialized Fields
    - channelName
```
String channelName
```
      The name of the signaling channel.
    - channelARN
```
String channelARN
```
      The ARN of the signaling channel.
    - channelType
```
String channelType
```
      The type of the signaling channel.
    - channelStatus
```
String channelStatus
```
      Current status of the signaling channel.
    - creationTime
```
Date creationTime
```
      The time at which the signaling channel was created.
    - singleMasterConfiguration
```
SingleMasterConfiguration singleMasterConfiguration
```
      A structure that contains the configuration for the SINGLE_MASTER channel type.
    - version
```
String version
```
      The current version of the signaling channel.
- Class com.amazonaws.services.kinesisvideo.model.ChannelNameCondition extends Object implements Serializable
  - Serialized Fields
    - comparisonOperator
```
String comparisonOperator
```
      A comparison operator. Currently, you can only specify the BEGINS_WITH operator, which finds signaling channels whose names begin with a given prefix.
    - comparisonValue
```
String comparisonValue
```
      A value to compare.
- Class com.amazonaws.services.kinesisvideo.model.ClientLimitExceededException extends AmazonKinesisVideoException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesisvideo.model.ConnectionLimitExceededException extends AmazonKinesisVideoException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesisvideo.model.CreateSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelName
```
String channelName
```
      A name for the signaling channel that you are creating. It must be unique for each account and region.
    - channelType
```
String channelType
```
      A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.
    - singleMasterConfiguration
```
SingleMasterConfiguration singleMasterConfiguration
```
      A structure containing the configuration for the SINGLE_MASTER channel type.
    - tags
```
List<E> tags
```
      A set of tags (key/value pairs) that you want to associate with this channel.
- Class com.amazonaws.services.kinesisvideo.model.CreateSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - channelARN
```
String channelARN
```
      The ARN of the created channel.
- Class com.amazonaws.services.kinesisvideo.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceName
```
String deviceName
```
      The name of the device that is writing to the stream.
      
      In the current implementation, Kinesis Video Streams does not use this name.
    - streamName
```
String streamName
```
      A name for the stream that you are creating.
      
      The stream name is an identifier for the stream, and must be unique for each account and region.
    - mediaType
```
String mediaType
```
      The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.
      
      Example valid values include "video/h264" and "video/h264,audio/aac".
      
      This parameter is optional; the default value is null (or empty in JSON).
    - kmsKeyId
```
String kmsKeyId
```
      The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.
      
      If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.
      
      For more information, see DescribeKey.
    - dataRetentionInHours
```
Integer dataRetentionInHours
```
      The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
      
      The default value is 0, indicating that the stream does not persist data.
      
      When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.
    - tags
```
Map<K,V> tags
```
      A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
- Class com.amazonaws.services.kinesisvideo.model.CreateStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - streamARN
```
String streamARN
```
      The Amazon Resource Name (ARN) of the stream.
- Class com.amazonaws.services.kinesisvideo.model.DASHFragmentSelector extends Object implements Serializable
  - Serialized Fields
    - fragmentSelectorType
```
String fragmentSelectorType
```
      The source of the timestamps for the requested media.
      
      When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In addition, the fragments with producer timestamps within the TimestampRange ingested immediately following the first fragment (up to the GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are included.
      
      Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the MPEG-DASH manifest will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned.
      
      When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are included in the MPEG-DASH manifest. This means that even if fragments ingested in the past have producer timestamps with values now, they are not included in the HLS media playlist.
      
      The default is SERVER_TIMESTAMP.
    - timestampRange
```
DASHTimestampRange timestampRange
```
      The start and end of the timestamp range for the requested media.
      
      This value should not be present if PlaybackType is LIVE.
- Class com.amazonaws.services.kinesisvideo.model.DASHTimestampRange extends Object implements Serializable
  - Serialized Fields
    - startTimestamp
```
Date startTimestamp
```
      The start of the timestamp range for the requested media.
      
      If the DASHTimestampRange value is specified, the StartTimestamp value is required.
      
      This value is inclusive. Fragments that start before the StartTimestamp and continue past it are included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.
    - endTimestamp
```
Date endTimestamp
```
      The end of the timestamp range for the requested media. This value must be within 3 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value.
      
      If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.
      
      The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to include newly ingested fragments until the session expires.
      
      This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.
- Class com.amazonaws.services.kinesisvideo.model.DeleteSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelARN
```
String channelARN
```
      The ARN of the signaling channel that you want to delete.
    - currentVersion
```
String currentVersion
```
      The current version of the signaling channel that you want to delete. You can obtain the current version by invoking the DescribeSignalingChannel or ListSignalingChannels APIs.
- Class com.amazonaws.services.kinesisvideo.model.DeleteSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.kinesisvideo.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamARN
```
String streamARN
```
      The Amazon Resource Name (ARN) of the stream that you want to delete.
    - currentVersion
```
String currentVersion
```
      Optional: The version of the stream that you want to delete.
      
      Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API.
      
      If not specified, only the CreationTime is checked before deleting the stream.
- Class com.amazonaws.services.kinesisvideo.model.DeleteStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.kinesisvideo.model.DescribeSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelName
```
String channelName
```
      The name of the signaling channel that you want to describe.
    - channelARN
```
String channelARN
```
      The ARN of the signaling channel that you want to describe.
- Class com.amazonaws.services.kinesisvideo.model.DescribeSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - channelInfo
```
ChannelInfo channelInfo
```
      A structure that encapsulates the specified signaling channel's metadata and properties.
- Class com.amazonaws.services.kinesisvideo.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream.
    - streamARN
```
String streamARN
```
      The Amazon Resource Name (ARN) of the stream.
- Class com.amazonaws.services.kinesisvideo.model.DescribeStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - streamInfo
```
StreamInfo streamInfo
```
      An object that describes the stream.
- Class com.amazonaws.services.kinesisvideo.model.DeviceStreamLimitExceededException extends AmazonKinesisVideoException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesisvideo.model.Fragment extends Object implements Serializable
  - Serialized Fields
    - fragmentNumber
```
String fragmentNumber
```
      The unique identifier of the fragment. This value monotonically increases based on the ingestion order.
    - fragmentSizeInBytes
```
Long fragmentSizeInBytes
```
      The total fragment size, including information about the fragment and contained media data.
    - producerTimestamp
```
Date producerTimestamp
```
      The timestamp from the producer corresponding to the fragment.
    - serverTimestamp
```
Date serverTimestamp
```
      The timestamp from the AWS server corresponding to the fragment.
    - fragmentLengthInMilliseconds
```
Long fragmentLengthInMilliseconds
```
      The playback duration or other time value associated with the fragment.
- Class com.amazonaws.services.kinesisvideo.model.FragmentSelector extends Object implements Serializable
  - Serialized Fields
    - fragmentSelectorType
```
String fragmentSelectorType
```
      The origin of the timestamps to use (Server or Producer).
    - timestampRange
```
TimestampRange timestampRange
```
      The range of timestamps to return.
- Class com.amazonaws.services.kinesisvideo.model.GetDASHStreamingSessionURLRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream for which to retrieve the MPEG-DASH manifest URL.
      
      You must specify either the StreamName or the StreamARN.
    - streamARN
```
String streamARN
```
      The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.
      
      You must specify either the StreamName or the StreamARN.
    - playbackMode
```
String playbackMode
```
      Whether to retrieve live, live replay, or archived, on-demand data.
      
      Features of the three types of sessions include the following:
      
      LIVE : For sessions of this type, the MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.
      
      In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled.
      
      LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated for LIVE mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.
      
      ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified in MaxMediaPlaylistFragmentResults. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.
      
      In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.
      
      The default is LIVE.
    - displayFragmentTimestamp
```
String displayFragmentTimestamp
```
      Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.
      
      The default value is NEVER. When DASHFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when DASHFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.
    - displayFragmentNumber
```
String displayFragmentNumber
```
      Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.
      
      The default value is NEVER.
    - dASHFragmentSelector
```
DASHFragmentSelector dASHFragmentSelector
```
      The time range of the requested fragment and the source of the timestamps.
      
      This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode isLIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

Serialized Form

Package com.amazonaws.services.kinesisvideo.model

Class com.amazonaws.services.kinesisvideo.model.AccessDeniedException extends AmazonKinesisVideoException implements Serializable

Class com.amazonaws.services.kinesisvideo.model.AccountChannelLimitExceededException extends AmazonKinesisVideoException implements Serializable

Class com.amazonaws.services.kinesisvideo.model.AccountStreamLimitExceededException extends AmazonKinesisVideoException implements Serializable

Class com.amazonaws.services.kinesisvideo.model.AckEvent extends Object implements Serializable

Serialized Fields

ackEventType

fragmentTimecode

fragmentNumber

errorCode

errorId

Class com.amazonaws.services.kinesisvideo.model.AmazonKinesisVideoException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.kinesisvideo.model.ChannelInfo extends Object implements Serializable

Serialized Fields

channelName

channelARN

channelType

channelStatus

creationTime

singleMasterConfiguration

version

Class com.amazonaws.services.kinesisvideo.model.ChannelNameCondition extends Object implements Serializable

Serialized Fields

comparisonOperator

comparisonValue

Class com.amazonaws.services.kinesisvideo.model.ClientLimitExceededException extends AmazonKinesisVideoException implements Serializable

Class com.amazonaws.services.kinesisvideo.model.ConnectionLimitExceededException extends AmazonKinesisVideoException implements Serializable

Class com.amazonaws.services.kinesisvideo.model.CreateSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelName

channelType

singleMasterConfiguration

tags

Class com.amazonaws.services.kinesisvideo.model.CreateSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

channelARN

Class com.amazonaws.services.kinesisvideo.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceName

streamName

mediaType

kmsKeyId

dataRetentionInHours

tags

Class com.amazonaws.services.kinesisvideo.model.CreateStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

streamARN

Class com.amazonaws.services.kinesisvideo.model.DASHFragmentSelector extends Object implements Serializable

Serialized Fields

fragmentSelectorType

timestampRange

Class com.amazonaws.services.kinesisvideo.model.DASHTimestampRange extends Object implements Serializable

Serialized Fields

startTimestamp

endTimestamp

Class com.amazonaws.services.kinesisvideo.model.DeleteSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelARN

currentVersion

Class com.amazonaws.services.kinesisvideo.model.DeleteSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.kinesisvideo.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamARN

currentVersion

Class com.amazonaws.services.kinesisvideo.model.DeleteStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.kinesisvideo.model.DescribeSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelName

channelARN

Class com.amazonaws.services.kinesisvideo.model.DescribeSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

channelInfo

Class com.amazonaws.services.kinesisvideo.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

streamARN

Class com.amazonaws.services.kinesisvideo.model.DescribeStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

streamInfo