Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClientLimitExceededException

type ClientLimitExceededException struct {
	Message *string
}

    Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

    func (*ClientLimitExceededException) Error

    func (*ClientLimitExceededException) ErrorCode

    func (e *ClientLimitExceededException) ErrorCode() string

    func (*ClientLimitExceededException) ErrorFault

    func (*ClientLimitExceededException) ErrorMessage

    func (e *ClientLimitExceededException) ErrorMessage() string

    type ClipFragmentSelector

    type ClipFragmentSelector struct {
    
    	// The origin of the timestamps to use (Server or Producer).
    	//
    	// This member is required.
    	FragmentSelectorType ClipFragmentSelectorType
    
    	// The range of timestamps to return.
    	//
    	// This member is required.
    	TimestampRange *ClipTimestampRange
    }

      Describes the timestamp range and timestamp origin of a range of fragments. 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 clip 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.

      type ClipFragmentSelectorType

      type ClipFragmentSelectorType string
      const (
      	ClipFragmentSelectorTypeProducerTimestamp ClipFragmentSelectorType = "PRODUCER_TIMESTAMP"
      	ClipFragmentSelectorTypeServerTimestamp   ClipFragmentSelectorType = "SERVER_TIMESTAMP"
      )

        Enum values for ClipFragmentSelectorType

        func (ClipFragmentSelectorType) Values

          Values returns all known values for ClipFragmentSelectorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

          type ClipTimestampRange

          type ClipTimestampRange struct {
          
          	// 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. 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.
          	//
          	// This member is required.
          	EndTimestamp *time.Time
          
          	// The starting timestamp in the range of timestamps for which to return fragments.
          	// 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.
          	//
          	// This member is required.
          	StartTimestamp *time.Time
          }

            The range of timestamps for which to return fragments. The values in the ClipTimestampRange are inclusive. Fragments that begin before the start time but continue past it, or fragments that begin before the end time but continue past it, are included in the session.

            type ContainerFormat

            type ContainerFormat string
            const (
            	ContainerFormatFragmentedMp4 ContainerFormat = "FRAGMENTED_MP4"
            	ContainerFormatMpegTs        ContainerFormat = "MPEG_TS"
            )

              Enum values for ContainerFormat

              func (ContainerFormat) Values

              func (ContainerFormat) Values() []ContainerFormat

                Values returns all known values for ContainerFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                type DASHDisplayFragmentNumber

                type DASHDisplayFragmentNumber string
                const (
                	DASHDisplayFragmentNumberAlways DASHDisplayFragmentNumber = "ALWAYS"
                	DASHDisplayFragmentNumberNever  DASHDisplayFragmentNumber = "NEVER"
                )

                  Enum values for DASHDisplayFragmentNumber

                  func (DASHDisplayFragmentNumber) Values

                    Values returns all known values for DASHDisplayFragmentNumber. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                    type DASHDisplayFragmentTimestamp

                    type DASHDisplayFragmentTimestamp string
                    const (
                    	DASHDisplayFragmentTimestampAlways DASHDisplayFragmentTimestamp = "ALWAYS"
                    	DASHDisplayFragmentTimestampNever  DASHDisplayFragmentTimestamp = "NEVER"
                    )

                      Enum values for DASHDisplayFragmentTimestamp

                      func (DASHDisplayFragmentTimestamp) Values

                        Values returns all known values for DASHDisplayFragmentTimestamp. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                        type DASHFragmentSelector

                        type DASHFragmentSelector struct {
                        
                        	// 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.
                        	FragmentSelectorType DASHFragmentSelectorType
                        
                        	// The start and end of the timestamp range for the requested media. This value
                        	// should not be present if PlaybackType is LIVE.
                        	TimestampRange *DASHTimestampRange
                        }

                          Contains the range of timestamps for the requested media, and the source of the timestamps.

                          type DASHFragmentSelectorType

                          type DASHFragmentSelectorType string
                          const (
                          	DASHFragmentSelectorTypeProducerTimestamp DASHFragmentSelectorType = "PRODUCER_TIMESTAMP"
                          	DASHFragmentSelectorTypeServerTimestamp   DASHFragmentSelectorType = "SERVER_TIMESTAMP"
                          )

                            Enum values for DASHFragmentSelectorType

                            func (DASHFragmentSelectorType) Values

                              Values returns all known values for DASHFragmentSelectorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                              type DASHPlaybackMode

                              type DASHPlaybackMode string
                              const (
                              	DASHPlaybackModeLive       DASHPlaybackMode = "LIVE"
                              	DASHPlaybackModeLiveReplay DASHPlaybackMode = "LIVE_REPLAY"
                              	DASHPlaybackModeOnDemand   DASHPlaybackMode = "ON_DEMAND"
                              )

                                Enum values for DASHPlaybackMode

                                func (DASHPlaybackMode) Values

                                  Values returns all known values for DASHPlaybackMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                  type DASHTimestampRange

                                  type DASHTimestampRange struct {
                                  
                                  	// 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.
                                  	EndTimestamp *time.Time
                                  
                                  	// 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.
                                  	StartTimestamp *time.Time
                                  }

                                    The start and end of the timestamp range for the requested media. This value should not be present if PlaybackType is LIVE. The values in the DASHimestampRange are inclusive. Fragments that begin before the start time but continue past it, or fragments that begin before the end time but continue past it, are included in the session.

                                    type Fragment

                                    type Fragment struct {
                                    
                                    	// The playback duration or other time value associated with the fragment.
                                    	FragmentLengthInMilliseconds int64
                                    
                                    	// The unique identifier of the fragment. This value monotonically increases based
                                    	// on the ingestion order.
                                    	FragmentNumber *string
                                    
                                    	// The total fragment size, including information about the fragment and contained
                                    	// media data.
                                    	FragmentSizeInBytes int64
                                    
                                    	// The timestamp from the producer corresponding to the fragment.
                                    	ProducerTimestamp *time.Time
                                    
                                    	// The timestamp from the AWS server corresponding to the fragment.
                                    	ServerTimestamp *time.Time
                                    }

                                      Represents a segment of video or other time-delimited data.

                                      type FragmentSelector

                                      type FragmentSelector struct {
                                      
                                      	// The origin of the timestamps to use (Server or Producer).
                                      	//
                                      	// This member is required.
                                      	FragmentSelectorType FragmentSelectorType
                                      
                                      	// The range of timestamps to return.
                                      	//
                                      	// This member is required.
                                      	TimestampRange *TimestampRange
                                      }

                                        Describes the timestamp range and timestamp origin of a range of fragments. Only fragments with a start timestamp greater than or equal to the given start time and less than or equal to the end time are returned. For example, if a stream contains fragments with the following start timestamps:

                                        * 00:00:00

                                        * 00:00:02

                                        * 00:00:04

                                        * 00:00:06

                                        A fragment selector range with a start time of 00:00:01 and end time of 00:00:04 would return the fragments with start times of 00:00:02 and 00:00:04.

                                        type FragmentSelectorType

                                        type FragmentSelectorType string
                                        const (
                                        	FragmentSelectorTypeProducerTimestamp FragmentSelectorType = "PRODUCER_TIMESTAMP"
                                        	FragmentSelectorTypeServerTimestamp   FragmentSelectorType = "SERVER_TIMESTAMP"
                                        )

                                          Enum values for FragmentSelectorType

                                          func (FragmentSelectorType) Values

                                            Values returns all known values for FragmentSelectorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                            type HLSDiscontinuityMode

                                            type HLSDiscontinuityMode string
                                            const (
                                            	HLSDiscontinuityModeAlways          HLSDiscontinuityMode = "ALWAYS"
                                            	HLSDiscontinuityModeNever           HLSDiscontinuityMode = "NEVER"
                                            	HLSDiscontinuityModeOnDiscontinuity HLSDiscontinuityMode = "ON_DISCONTINUITY"
                                            )

                                              Enum values for HLSDiscontinuityMode

                                              func (HLSDiscontinuityMode) Values

                                                Values returns all known values for HLSDiscontinuityMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                type HLSDisplayFragmentTimestamp

                                                type HLSDisplayFragmentTimestamp string
                                                const (
                                                	HLSDisplayFragmentTimestampAlways HLSDisplayFragmentTimestamp = "ALWAYS"
                                                	HLSDisplayFragmentTimestampNever  HLSDisplayFragmentTimestamp = "NEVER"
                                                )

                                                  Enum values for HLSDisplayFragmentTimestamp

                                                  func (HLSDisplayFragmentTimestamp) Values

                                                    Values returns all known values for HLSDisplayFragmentTimestamp. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                    type HLSFragmentSelector

                                                    type HLSFragmentSelector struct {
                                                    
                                                    	// The source of the timestamps for the requested media. When FragmentSelectorType
                                                    	// is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$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
                                                    	// GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults 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 HLS media
                                                    	// playlists 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
                                                    	// GetHLSStreamingSessionURLInput$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 HLS media playlist.
                                                    	// 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.
                                                    	FragmentSelectorType HLSFragmentSelectorType
                                                    
                                                    	// The start and end of the timestamp range for the requested media. This value
                                                    	// should not be present if PlaybackType is LIVE.
                                                    	TimestampRange *HLSTimestampRange
                                                    }

                                                      Contains the range of timestamps for the requested media, and the source of the timestamps.

                                                      type HLSFragmentSelectorType

                                                      type HLSFragmentSelectorType string
                                                      const (
                                                      	HLSFragmentSelectorTypeProducerTimestamp HLSFragmentSelectorType = "PRODUCER_TIMESTAMP"
                                                      	HLSFragmentSelectorTypeServerTimestamp   HLSFragmentSelectorType = "SERVER_TIMESTAMP"
                                                      )

                                                        Enum values for HLSFragmentSelectorType

                                                        func (HLSFragmentSelectorType) Values

                                                          Values returns all known values for HLSFragmentSelectorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                          type HLSPlaybackMode

                                                          type HLSPlaybackMode string
                                                          const (
                                                          	HLSPlaybackModeLive       HLSPlaybackMode = "LIVE"
                                                          	HLSPlaybackModeLiveReplay HLSPlaybackMode = "LIVE_REPLAY"
                                                          	HLSPlaybackModeOnDemand   HLSPlaybackMode = "ON_DEMAND"
                                                          )

                                                            Enum values for HLSPlaybackMode

                                                            func (HLSPlaybackMode) Values

                                                            func (HLSPlaybackMode) Values() []HLSPlaybackMode

                                                              Values returns all known values for HLSPlaybackMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                              type HLSTimestampRange

                                                              type HLSTimestampRange struct {
                                                              
                                                              	// 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.
                                                              	EndTimestamp *time.Time
                                                              
                                                              	// The start of the timestamp range for the requested media. If the
                                                              	// HLSTimestampRange 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.
                                                              	StartTimestamp *time.Time
                                                              }

                                                                The start and end of the timestamp range for the requested media. This value should not be present if PlaybackType is LIVE. The values in the HLSTimestampRange are inclusive. Fragments that begin before the start time but continue past it, or fragments that begin before the end time but continue past it, are included in the session.

                                                                type InvalidArgumentException

                                                                type InvalidArgumentException struct {
                                                                	Message *string
                                                                }

                                                                  A specified parameter exceeds its restrictions, is not supported, or can't be used.

                                                                  func (*InvalidArgumentException) Error

                                                                  func (e *InvalidArgumentException) Error() string

                                                                  func (*InvalidArgumentException) ErrorCode

                                                                  func (e *InvalidArgumentException) ErrorCode() string

                                                                  func (*InvalidArgumentException) ErrorFault

                                                                  func (e *InvalidArgumentException) ErrorFault() smithy.ErrorFault

                                                                  func (*InvalidArgumentException) ErrorMessage

                                                                  func (e *InvalidArgumentException) ErrorMessage() string

                                                                  type InvalidCodecPrivateDataException

                                                                  type InvalidCodecPrivateDataException struct {
                                                                  	Message *string
                                                                  }

                                                                    The codec private data in at least one of the tracks of the video stream is not valid for this operation.

                                                                    func (*InvalidCodecPrivateDataException) Error

                                                                    func (*InvalidCodecPrivateDataException) ErrorCode

                                                                    func (*InvalidCodecPrivateDataException) ErrorFault

                                                                    func (*InvalidCodecPrivateDataException) ErrorMessage

                                                                    func (e *InvalidCodecPrivateDataException) ErrorMessage() string

                                                                    type InvalidMediaFrameException

                                                                    type InvalidMediaFrameException struct {
                                                                    	Message *string
                                                                    }

                                                                      One or more frames in the requested clip could not be parsed based on the specified codec.

                                                                      func (*InvalidMediaFrameException) Error

                                                                      func (*InvalidMediaFrameException) ErrorCode

                                                                      func (e *InvalidMediaFrameException) ErrorCode() string

                                                                      func (*InvalidMediaFrameException) ErrorFault

                                                                      func (*InvalidMediaFrameException) ErrorMessage

                                                                      func (e *InvalidMediaFrameException) ErrorMessage() string

                                                                      type MissingCodecPrivateDataException

                                                                      type MissingCodecPrivateDataException struct {
                                                                      	Message *string
                                                                      }

                                                                        No codec private data was found in at least one of tracks of the video stream.

                                                                        func (*MissingCodecPrivateDataException) Error

                                                                        func (*MissingCodecPrivateDataException) ErrorCode

                                                                        func (*MissingCodecPrivateDataException) ErrorFault

                                                                        func (*MissingCodecPrivateDataException) ErrorMessage

                                                                        func (e *MissingCodecPrivateDataException) ErrorMessage() string

                                                                        type NoDataRetentionException

                                                                        type NoDataRetentionException struct {
                                                                        	Message *string
                                                                        }

                                                                          A streaming session was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

                                                                          func (*NoDataRetentionException) Error

                                                                          func (e *NoDataRetentionException) Error() string

                                                                          func (*NoDataRetentionException) ErrorCode

                                                                          func (e *NoDataRetentionException) ErrorCode() string

                                                                          func (*NoDataRetentionException) ErrorFault

                                                                          func (e *NoDataRetentionException) ErrorFault() smithy.ErrorFault

                                                                          func (*NoDataRetentionException) ErrorMessage

                                                                          func (e *NoDataRetentionException) ErrorMessage() string

                                                                          type NotAuthorizedException

                                                                          type NotAuthorizedException struct {
                                                                          	Message *string
                                                                          }

                                                                            Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

                                                                            func (*NotAuthorizedException) Error

                                                                            func (e *NotAuthorizedException) Error() string

                                                                            func (*NotAuthorizedException) ErrorCode

                                                                            func (e *NotAuthorizedException) ErrorCode() string

                                                                            func (*NotAuthorizedException) ErrorFault

                                                                            func (e *NotAuthorizedException) ErrorFault() smithy.ErrorFault

                                                                            func (*NotAuthorizedException) ErrorMessage

                                                                            func (e *NotAuthorizedException) ErrorMessage() string

                                                                            type ResourceNotFoundException

                                                                            type ResourceNotFoundException struct {
                                                                            	Message *string
                                                                            }

                                                                              GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified. GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

                                                                              func (*ResourceNotFoundException) Error

                                                                              func (e *ResourceNotFoundException) Error() string

                                                                              func (*ResourceNotFoundException) ErrorCode

                                                                              func (e *ResourceNotFoundException) ErrorCode() string

                                                                              func (*ResourceNotFoundException) ErrorFault

                                                                              func (*ResourceNotFoundException) ErrorMessage

                                                                              func (e *ResourceNotFoundException) ErrorMessage() string

                                                                              type TimestampRange

                                                                              type TimestampRange struct {
                                                                              
                                                                              	// The ending timestamp in the range of timestamps for which to return fragments.
                                                                              	//
                                                                              	// This member is required.
                                                                              	EndTimestamp *time.Time
                                                                              
                                                                              	// The starting timestamp in the range of timestamps for which to return fragments.
                                                                              	//
                                                                              	// This member is required.
                                                                              	StartTimestamp *time.Time
                                                                              }

                                                                                The range of timestamps for which to return fragments.

                                                                                type UnsupportedStreamMediaTypeException

                                                                                type UnsupportedStreamMediaTypeException struct {
                                                                                	Message *string
                                                                                }

                                                                                  The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could not be determined from the codec IDs of the tracks in the first fragment for a playback session. The codec ID for track 1 should be V_MPEG/ISO/AVC and, optionally, the codec ID for track 2 should be A_AAC.

                                                                                  func (*UnsupportedStreamMediaTypeException) Error

                                                                                  func (*UnsupportedStreamMediaTypeException) ErrorCode

                                                                                  func (*UnsupportedStreamMediaTypeException) ErrorFault

                                                                                  func (*UnsupportedStreamMediaTypeException) ErrorMessage

                                                                                  func (e *UnsupportedStreamMediaTypeException) ErrorMessage() string