AWS kinesisvideostreams documentation change
Summary
Removed all content from the file, effectively deleting the entire documentation for the GetHLSStreamingSessionURL API.
Security assessment
The change completely removes documentation content but provides no context about security vulnerabilities, weaknesses, or incidents. Documentation deletions without specific security context are considered routine maintenance or restructuring.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_reader_GetHLSStreamingSessionURL.md b/kinesisvideostreams/latest/dg/API_reader_GetHLSStreamingSessionURL.md index 16a6ea0cb..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_reader_GetHLSStreamingSessionURL.md +++ b//kinesisvideostreams/latest/dg/API_reader_GetHLSStreamingSessionURL.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_reader_GetHLSStreamingSessionURL.md) @@ -3,419 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_reader_GetHLSStreamingSessionURL "Open PDF") - -[Documentation](/index.html)[Amazon Kinesis Video Streams](/kinesis/index.html)[Developer Guide](what-is-kinesis-video.html) - -Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also - -# GetHLSStreamingSessionURL - -Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents. - -Both the `StreamName` and the `StreamARN` parameters are optional, but you must specify either the `StreamName` or the `StreamARN` when invoking this API operation. - -An Amazon Kinesis video stream has the following requirements for providing data through HLS: - - * [Video playback track requirements](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html). - - * Data retention must be greater than 0. - - * The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format ([MPEG-4 specification ISO/IEC 14496-15](https://www.iso.org/standard/55980.html)). For information about adapting stream data to a given format, see [NAL Adaptation Flags](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html). - - * The audio track (if present) of each fragment must contain codec private data in the AAC format ([AAC specification ISO/IEC 13818-7](https://www.iso.org/standard/43345.html)). - - - - -Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the [HLS specification](https://tools.ietf.org/html/draft-pantos-http-live-streaming-23). - -The following procedure shows how to use HLS with Kinesis Video Streams: - - 1. Call the `GetDataEndpoint` API to get an endpoint. Then send the `GetHLSStreamingSessionURL` requests to this endpoint using the [\--endpoint-url parameter](https://docs.aws.amazon.com/cli/latest/reference/). - - 2. Retrieve the HLS URL using `GetHLSStreamingSessionURL`. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. `GetHLSStreamingSessionURL` returns an authenticated URL (that includes an encrypted session token) for the session's HLS _master playlist_ (the root resource needed for streaming with HLS). - -###### Note - -Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials. - -The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available. - - 3. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples. - - 4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions: - - * **GetHLSMasterPlaylist:** Retrieves an HLS master playlist, which contains a URL for the `GetHLSMediaPlaylist` action for each track, and additional metadata for the media player, including estimated bitrate and resolution. - - * **GetHLSMediaPlaylist:** Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the `GetMP4InitFragment` action, and URLs to access the MP4 media fragments with the `GetMP4MediaFragment` actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the `PlaybackMode` is `LIVE` or `ON_DEMAND`. The HLS media playlist is typically static for sessions with a `PlaybackType` of `ON_DEMAND`. The HLS media playlist is continually updated with new fragments for sessions with a `PlaybackType` of `LIVE`. There is a distinct HLS media playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific track. - - * **GetMP4InitFragment:** Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "`fytp`" and "`moov`" MP4 atoms, and the child atoms that are needed to initialize the media player decoder. - -The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames. - - * **GetMP4MediaFragment:** Retrieves MP4 media fragments. These fragments contain the "`moof`" and "`mdat`" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps. - -###### Note - -The codec private data (CPD) contained in each fragment contains codec-specific initialization information, such as frame rate, resolution, and encoding profile, which are necessary for properly decoding the fragment. For both TS and MP4, CPD changes are supported during a streaming session. Therefore, the fragments in a session can have a different information in the CPD without interrupting playback. For each streaming session, only 500 CPD changes are allowed. - -###### Important - -Track changes aren't supported. Tracks must remain consistent throughout the queried media. Streaming will fail if the fragments in the stream change from having only video to having both audio and video, or if an AAC audio track is changed to an A-Law audio track. - -Data retrieved with this action is billable. For information, see [Pricing](https://aws.amazon.com/kinesis/video-streams/pricing/). - - * **GetTSFragment:** Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream. - -###### Note - -If the `ContainerFormat` is `MPEG_TS`, this API is used instead of `GetMP4InitFragment` and `GetMP4MediaFragment` to retrieve stream media. - -Data retrieved with this action is billable. For more information, see [Kinesis Video Streams pricing](https://aws.amazon.com/kinesis/video-streams/pricing/). - - - - -A streaming session URL must not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see [Kinesis Video Streams quotas](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html). - -You can monitor the amount of data that the media player consumes by monitoring the `GetMP4MediaFragment.OutgoingBytes` Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see [Monitoring Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). For pricing information, see [Amazon Kinesis Video Streams Pricing](https://aws.amazon.com/kinesis/video-streams/pricing/) and [AWS Pricing](https://aws.amazon.com/pricing/). Charges for both HLS sessions and outgoing AWS data apply. - -See the video playback examples in the documentation guide: [Use the AWS CLI to retrieve an HLS streaming session URL](./hls-playback.html#retrieve-hls-url) and [Example: Use HLS in HTML and JavaScript](./hls-playback.html#how-hls-ex1). - -For more information about HLS, see [HTTP Live Streaming](https://developer.apple.com/streaming/) on the [Apple Developer site](https://developer.apple.com). - -###### Important - -If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: - - * `x-amz-ErrorType` HTTP header – contains a more specific error type in addition to what the HTTP status code provides. - - * `x-amz-RequestId` HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id. - - - - -Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. - -For more information, see the **Errors** section at the bottom of this topic, as well as [Common Errors](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html). - -## Request Syntax - - - POST /getHLSStreamingSessionURL HTTP/1.1 - Content-type: application/json - - { - "ContainerFormat": "string", - "DiscontinuityMode": "string", - "DisplayFragmentTimestamp": "string", - "Expires": number, - "HLSFragmentSelector": { - "[FragmentSelectorType](./API_reader_HLSFragmentSelector.html#KinesisVideo-Type-reader_HLSFragmentSelector-FragmentSelectorType)": "string", - "[TimestampRange](./API_reader_HLSFragmentSelector.html#KinesisVideo-Type-reader_HLSFragmentSelector-TimestampRange)": { - "[EndTimestamp](./API_reader_HLSTimestampRange.html#KinesisVideo-Type-reader_HLSTimestampRange-EndTimestamp)": number, - "[StartTimestamp](./API_reader_HLSTimestampRange.html#KinesisVideo-Type-reader_HLSTimestampRange-StartTimestamp)": number - } - }, - "MaxMediaPlaylistFragmentResults": number, - "PlaybackMode": "string", - "StreamARN": "string", - "StreamName": "string" - } - -## URI Request Parameters - -The request does not use any URI parameters. - -## Request Body - -The request accepts the following data in JSON format. - -**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`. - -Type: String - -Valid Values: `FRAGMENTED_MP4 | MPEG_TS` - -Required: No - -**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](./API_reader_HLSFragmentSelector.html) 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](./API_reader_HLSFragmentSelector.html) is set to `SERVER_TIMESTAMP`, and `NEVER` when it is set to `PRODUCER_TIMESTAMP`. - -Type: String - -Valid Values: `ALWAYS | NEVER | ON_DISCONTINUITY` - -Required: No - -**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](./API_reader_HLSFragmentSelector.html) is `SERVER_TIMESTAMP`, the timestamps will be the server start timestamps. Similarly, when [HLSFragmentSelector](./API_reader_HLSFragmentSelector.html) is `PRODUCER_TIMESTAMP`, the timestamps will be the producer start timestamps. - -Type: String - -Valid Values: `ALWAYS | NEVER` - -Required: No - -**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). - -Type: Integer - -Valid Range: Minimum value of 300. Maximum value of 43200.