API version 2017-09-30 of the Amazon Kinesis Video Streams Archived Media SDK configuration.

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

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

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

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

Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits.

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.

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

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

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.

See: newGetHLSStreamingSessionURL smart constructor.

Create a value of GetHLSStreamingSessionURL with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:displayFragmentTimestamp:GetHLSStreamingSessionURL', getHLSStreamingSessionURL_displayFragmentTimestamp - Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.

The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

$sel:hLSFragmentSelector:GetHLSStreamingSessionURL', getHLSStreamingSessionURL_hLSFragmentSelector - 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 is@ LIVE. 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.

$sel:expires:GetHLSStreamingSessionURL', getHLSStreamingSessionURL_expires - The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours).

When a session expires, no new calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, GetMP4MediaFragment, or GetTSFragment can be made for that session.

The default is 300 (5 minutes).

$sel:streamARN:GetHLSStreamingSessionURL', getHLSStreamingSessionURL_streamARN - The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.

You must specify either the StreamName or the StreamARN.

$sel:playbackMode:GetHLSStreamingSessionURL', getHLSStreamingSessionURL_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 HLS media playlist is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new playlist 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 HLS media playlist, 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 HLS media playlist 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 playlist, the older fragment is not added, and the gap is not filled.

• LIVE_REPLAY : For sessions of this type, the HLS media playlist 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 media playlist 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 HLS media playlist contains all the fragments for the session, up to the number that is specified in MaxMediaPlaylistFragmentResults. The playlist 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 largest fragment number (that is, the newest fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.

The default is LIVE.

$sel:containerFormat:GetHLSStreamingSessionURL', getHLSStreamingSessionURL_containerFormat - Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

The default is FRAGMENTED_MP4.

$sel:maxMediaPlaylistFragmentResults:GetHLSStreamingSessionURL', getHLSStreamingSessionURL_maxMediaPlaylistFragmentResults - The maximum number of fragments that are returned in the HLS media playlists.

When the PlaybackMode is LIVE, the most recent fragments are returned up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this maximum number.

When there are a higher number of fragments available in a live HLS media playlist, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND.

The maximum value of 5,000 fragments corresponds to more than 80 minutes of video on streams with 1-second fragments, and more than 13 hours of video on streams with 10-second fragments.

$sel:discontinuityMode:GetHLSStreamingSessionURL', getHLSStreamingSessionURL_discontinuityMode - Specifies when flags marking discontinuities between fragments are added to the media playlists.

Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

The following modes are supported:

• ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.
• NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.
• ON_DISCONTINUITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.

$sel:streamName:GetHLSStreamingSessionURL', getHLSStreamingSessionURL_streamName - The name of the stream for which to retrieve the HLS master playlist URL.

You must specify either the StreamName or the StreamARN.

See: newGetHLSStreamingSessionURLResponse smart constructor.

Create a value of GetHLSStreamingSessionURLResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hLSStreamingSessionURL:GetHLSStreamingSessionURLResponse', getHLSStreamingSessionURLResponse_hLSStreamingSessionURL - The URL (containing the session token) that a media player can use to retrieve the HLS master playlist.

$sel:httpStatus:GetHLSStreamingSessionURLResponse', getHLSStreamingSessionURLResponse_httpStatus - The response's http status code.

See: newGetClip smart constructor.

Create a value of GetClip with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamARN:GetClip', getClip_streamARN - The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip.

You must specify either the StreamName or the StreamARN.

$sel:streamName:GetClip', getClip_streamName - The name of the stream for which to retrieve the media clip.

You must specify either the StreamName or the StreamARN.

$sel:clipFragmentSelector:GetClip', getClip_clipFragmentSelector - The time range of the requested clip and the source of the timestamps.

See: newGetClipResponse smart constructor.

Create a value of GetClipResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentType:GetClipResponse', getClipResponse_contentType - The content type of the media in the requested clip.

$sel:httpStatus:GetClipResponse', getClipResponse_httpStatus - The response's http status code.

$sel:payload:GetClipResponse', getClipResponse_payload - Traditional MP4 file that contains the media clip from the specified video stream. The output will contain the first 100 MB or the first 200 fragments from the specified start timestamp. For more information, see Kinesis Video Streams Limits.

See: newGetMediaForFragmentList smart constructor.

Create a value of GetMediaForFragmentList with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamARN:GetMediaForFragmentList', getMediaForFragmentList_streamARN - The Amazon Resource Name (ARN) of the stream from which to retrieve fragment media. Specify either this parameter or the StreamName parameter.

$sel:streamName:GetMediaForFragmentList', getMediaForFragmentList_streamName - The name of the stream from which to retrieve fragment media. Specify either this parameter or the StreamARN parameter.

$sel:fragments:GetMediaForFragmentList', getMediaForFragmentList_fragments - A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments.

See: newGetMediaForFragmentListResponse smart constructor.

Create a value of GetMediaForFragmentListResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentType:GetMediaForFragmentListResponse', getMediaForFragmentListResponse_contentType - The content type of the requested media.

$sel:httpStatus:GetMediaForFragmentListResponse', getMediaForFragmentListResponse_httpStatus - The response's http status code.

$sel:payload:GetMediaForFragmentListResponse', getMediaForFragmentListResponse_payload - The payload that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see PutMedia. The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList call also include the following additional Matroska (MKV) tags:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the fragment.
• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception
• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception
• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

See: newListFragments smart constructor.

Create a value of ListFragments with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fragmentSelector:ListFragments', listFragments_fragmentSelector - Describes the timestamp range and timestamp origin for the range of fragments to return.

$sel:streamARN:ListFragments', listFragments_streamARN - The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

$sel:nextToken:ListFragments', listFragments_nextToken - A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

$sel:streamName:ListFragments', listFragments_streamName - The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

$sel:maxResults:ListFragments', listFragments_maxResults - The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

See: newListFragmentsResponse smart constructor.

Create a value of ListFragmentsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListFragments', listFragmentsResponse_nextToken - If the returned list is truncated, the operation returns this token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:fragments:ListFragmentsResponse', listFragmentsResponse_fragments - A list of archived Fragment objects from the stream that meet the selector criteria. Results are in no specific order, even across pages.

$sel:httpStatus:ListFragmentsResponse', listFragmentsResponse_httpStatus - The response's http status code.

See: newGetDASHStreamingSessionURL smart constructor.

Create a value of GetDASHStreamingSessionURL with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:displayFragmentTimestamp:GetDASHStreamingSessionURL', getDASHStreamingSessionURL_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.

$sel:expires:GetDASHStreamingSessionURL', getDASHStreamingSessionURL_expires - The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours).

When a session expires, no new calls to GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made for that session.

The default is 300 (5 minutes).

$sel:dASHFragmentSelector:GetDASHStreamingSessionURL', getDASHStreamingSessionURL_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 is@ LIVE. 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.

$sel:maxManifestFragmentResults:GetDASHStreamingSessionURL', getDASHStreamingSessionURL_maxManifestFragmentResults - The maximum number of fragments that are returned in the MPEG-DASH manifest.

When the PlaybackMode is LIVE, the most recent fragments are returned up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this maximum number.

When there are a higher number of fragments available in a live MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND.

The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second fragments, and more than 2 1/2 hours of video on streams with 10-second fragments.

$sel:streamARN:GetDASHStreamingSessionURL', getDASHStreamingSessionURL_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.

$sel:playbackMode:GetDASHStreamingSessionURL', getDASHStreamingSessionURL_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 MaxManifestFragmentResults. 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.

$sel:streamName:GetDASHStreamingSessionURL', getDASHStreamingSessionURL_streamName - The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

$sel:displayFragmentNumber:GetDASHStreamingSessionURL', getDASHStreamingSessionURL_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.

See: newGetDASHStreamingSessionURLResponse smart constructor.

Create a value of GetDASHStreamingSessionURLResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dASHStreamingSessionURL:GetDASHStreamingSessionURLResponse', getDASHStreamingSessionURLResponse_dASHStreamingSessionURL - The URL (containing the session token) that a media player can use to retrieve the MPEG-DASH manifest.

$sel:httpStatus:GetDASHStreamingSessionURLResponse', getDASHStreamingSessionURLResponse_httpStatus - The response's http status code.