/* * Copyright 2010-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.kinesisvideoarchivedmedia.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* 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: *

* *

* 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. *

*

* The following procedure shows how to use HLS with Kinesis Video Streams: *

*
    *
  1. *

    * Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL * for the APIName parameter. *

    *
    2. *
  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). *

    * *

    * 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. *
  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. *
  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: *

    * *
    5. *
*

* 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 Limits. *

*

* 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. For pricing information, see Amazon Kinesis * Video Streams Pricing and AWS * Pricing. Charges for both HLS sessions and outgoing AWS data apply. *

*

* For more information about HLS, see HTTP Live Streaming on the * Apple Developer site. *

* *

* 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: *

* *

* 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. *

* */ public class GetHLSStreamingSessionURLRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The name of the stream for which to retrieve the HLS master playlist URL. *

*

* You must specify either the StreamName or the * StreamARN. *

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
*/ private String streamName; /** *

* 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. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
*/ private String streamARN; /** *

* Whether to retrieve live, live replay, or archived, on-demand data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

*

* Constraints:
* Allowed Values: LIVE, LIVE_REPLAY, ON_DEMAND */ private String playbackMode; /** *

* 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. *

*/ private HLSFragmentSelector hLSFragmentSelector; /** *

* 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. *

*

* Constraints:
* Allowed Values: FRAGMENTED_MP4, MPEG_TS */ private String containerFormat; /** *

* 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: *

* *

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

*

* Constraints:
* Allowed Values: ALWAYS, NEVER, ON_DISCONTINUITY */ private String discontinuityMode; /** *

* 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. *

*

* Constraints:
* Allowed Values: ALWAYS, NEVER */ private String displayFragmentTimestamp; /** *

* 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). *

*

* Constraints:
* Range: 300 - 43200
*/ private Integer expires; /** *

* 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. *

*

* Constraints:
* Range: 1 - 5000
*/ private Long maxMediaPlaylistFragmentResults; /** *

* The name of the stream for which to retrieve the HLS master playlist URL. *

*

* You must specify either the StreamName or the * StreamARN. *

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @return

* The name of the stream for which to retrieve the HLS master * playlist URL. *

*

* You must specify either the StreamName or the * StreamARN. *

*/ public String getStreamName() { return streamName; } /** *

* The name of the stream for which to retrieve the HLS master playlist URL. *

*

* You must specify either the StreamName or the * StreamARN. *

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @param streamName

* The name of the stream for which to retrieve the HLS master * playlist URL. *

*

* You must specify either the StreamName or the * StreamARN. *

*/ public void setStreamName(String streamName) { this.streamName = streamName; } /** *

* The name of the stream for which to retrieve the HLS master playlist URL. *

*

* You must specify either the StreamName or the * StreamARN. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @param streamName

* The name of the stream for which to retrieve the HLS master * playlist URL. *

*

* You must specify either the StreamName or the * StreamARN. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetHLSStreamingSessionURLRequest withStreamName(String streamName) { this.streamName = streamName; return this; } /** *

* 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. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @return

* 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. *

*/ public String getStreamARN() { return 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. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @param 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. *

*/ public void setStreamARN(String streamARN) { this.streamARN = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetHLSStreamingSessionURLRequest withStreamARN(String streamARN) { this.streamARN = streamARN; return this; } /** *

* Whether to retrieve live, live replay, or archived, on-demand data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

*

* Constraints:
* Allowed Values: LIVE, LIVE_REPLAY, ON_DEMAND * * @return

* Whether to retrieve live, live replay, or archived, on-demand * data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

* @see HLSPlaybackMode */ public String getPlaybackMode() { return playbackMode; } /** *

* Whether to retrieve live, live replay, or archived, on-demand data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

*

* Constraints:
* Allowed Values: LIVE, LIVE_REPLAY, ON_DEMAND * * @param playbackMode

* Whether to retrieve live, live replay, or archived, on-demand * data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

* @see HLSPlaybackMode */ public void setPlaybackMode(String playbackMode) { this.playbackMode = playbackMode; } /** *

* Whether to retrieve live, live replay, or archived, on-demand data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: LIVE, LIVE_REPLAY, ON_DEMAND * * @param playbackMode

* Whether to retrieve live, live replay, or archived, on-demand * data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see HLSPlaybackMode */ public GetHLSStreamingSessionURLRequest withPlaybackMode(String playbackMode) { this.playbackMode = playbackMode; return this; } /** *

* Whether to retrieve live, live replay, or archived, on-demand data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

*

* Constraints:
* Allowed Values: LIVE, LIVE_REPLAY, ON_DEMAND * * @param playbackMode

* Whether to retrieve live, live replay, or archived, on-demand * data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

* @see HLSPlaybackMode */ public void setPlaybackMode(HLSPlaybackMode playbackMode) { this.playbackMode = playbackMode.toString(); } /** *

* Whether to retrieve live, live replay, or archived, on-demand data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: LIVE, LIVE_REPLAY, ON_DEMAND * * @param playbackMode

* Whether to retrieve live, live replay, or archived, on-demand * data. *

*

* Features of the three types of sessions include the following: *

* *

* 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see HLSPlaybackMode */ public GetHLSStreamingSessionURLRequest withPlaybackMode(HLSPlaybackMode playbackMode) { this.playbackMode = playbackMode.toString(); return this; } /** *

* 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. *

* * @return

* 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. *

*/ public HLSFragmentSelector getHLSFragmentSelector() { return 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. *

* * @param 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. *

*/ public void setHLSFragmentSelector(HLSFragmentSelector hLSFragmentSelector) { this.hLSFragmentSelector = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetHLSStreamingSessionURLRequest withHLSFragmentSelector( HLSFragmentSelector hLSFragmentSelector) { this.hLSFragmentSelector = hLSFragmentSelector; return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: FRAGMENTED_MP4, MPEG_TS * * @return

* 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. *

* @see ContainerFormat */ public String getContainerFormat() { return 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. *

*

* Constraints:
* Allowed Values: FRAGMENTED_MP4, MPEG_TS * * @param 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. *

* @see ContainerFormat */ public void setContainerFormat(String containerFormat) { this.containerFormat = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: FRAGMENTED_MP4, MPEG_TS * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see ContainerFormat */ public GetHLSStreamingSessionURLRequest withContainerFormat(String containerFormat) { this.containerFormat = containerFormat; return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: FRAGMENTED_MP4, MPEG_TS * * @param 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. *

* @see ContainerFormat */ public void setContainerFormat(ContainerFormat containerFormat) { this.containerFormat = containerFormat.toString(); } /** *

* 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: FRAGMENTED_MP4, MPEG_TS * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see ContainerFormat */ public GetHLSStreamingSessionURLRequest withContainerFormat(ContainerFormat containerFormat) { this.containerFormat = containerFormat.toString(); return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: ALWAYS, NEVER, ON_DISCONTINUITY * * @return

* 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. *

* @see HLSDiscontinuityMode */ public String getDiscontinuityMode() { return 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. *

*

* Constraints:
* Allowed Values: ALWAYS, NEVER, ON_DISCONTINUITY * * @param 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. *

* @see HLSDiscontinuityMode */ public void setDiscontinuityMode(String discontinuityMode) { this.discontinuityMode = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: ALWAYS, NEVER, ON_DISCONTINUITY * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see HLSDiscontinuityMode */ public GetHLSStreamingSessionURLRequest withDiscontinuityMode(String discontinuityMode) { this.discontinuityMode = discontinuityMode; return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: ALWAYS, NEVER, ON_DISCONTINUITY * * @param 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. *

* @see HLSDiscontinuityMode */ public void setDiscontinuityMode(HLSDiscontinuityMode discontinuityMode) { this.discontinuityMode = discontinuityMode.toString(); } /** *

* 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: ALWAYS, NEVER, ON_DISCONTINUITY * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see HLSDiscontinuityMode */ public GetHLSStreamingSessionURLRequest withDiscontinuityMode( HLSDiscontinuityMode discontinuityMode) { this.discontinuityMode = discontinuityMode.toString(); return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: ALWAYS, NEVER * * @return

* 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. *

* @see HLSDisplayFragmentTimestamp */ public String getDisplayFragmentTimestamp() { return 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. *

*

* Constraints:
* Allowed Values: ALWAYS, NEVER * * @param 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. *

* @see HLSDisplayFragmentTimestamp */ public void setDisplayFragmentTimestamp(String displayFragmentTimestamp) { this.displayFragmentTimestamp = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: ALWAYS, NEVER * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see HLSDisplayFragmentTimestamp */ public GetHLSStreamingSessionURLRequest withDisplayFragmentTimestamp( String displayFragmentTimestamp) { this.displayFragmentTimestamp = displayFragmentTimestamp; return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: ALWAYS, NEVER * * @param 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. *

* @see HLSDisplayFragmentTimestamp */ public void setDisplayFragmentTimestamp(HLSDisplayFragmentTimestamp displayFragmentTimestamp) { this.displayFragmentTimestamp = displayFragmentTimestamp.toString(); } /** *

* 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: ALWAYS, NEVER * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see HLSDisplayFragmentTimestamp */ public GetHLSStreamingSessionURLRequest withDisplayFragmentTimestamp( HLSDisplayFragmentTimestamp displayFragmentTimestamp) { this.displayFragmentTimestamp = displayFragmentTimestamp.toString(); return this; } /** *

* 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). *

*

* Constraints:
* Range: 300 - 43200
* * @return

* 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). *

*/ public Integer getExpires() { return 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). *

*

* Constraints:
* Range: 300 - 43200
* * @param 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). *

*/ public void setExpires(Integer expires) { this.expires = 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). *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 300 - 43200
* * @param 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). *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetHLSStreamingSessionURLRequest withExpires(Integer expires) { this.expires = expires; return this; } /** *

* 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. *

*

* Constraints:
* Range: 1 - 5000
* * @return

* 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. *

*/ public Long getMaxMediaPlaylistFragmentResults() { return 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. *

*

* Constraints:
* Range: 1 - 5000
* * @param 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. *

*/ public void setMaxMediaPlaylistFragmentResults(Long maxMediaPlaylistFragmentResults) { this.maxMediaPlaylistFragmentResults = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 - 5000
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetHLSStreamingSessionURLRequest withMaxMediaPlaylistFragmentResults( Long maxMediaPlaylistFragmentResults) { this.maxMediaPlaylistFragmentResults = maxMediaPlaylistFragmentResults; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getStreamName() != null) sb.append("StreamName: " + getStreamName() + ","); if (getStreamARN() != null) sb.append("StreamARN: " + getStreamARN() + ","); if (getPlaybackMode() != null) sb.append("PlaybackMode: " + getPlaybackMode() + ","); if (getHLSFragmentSelector() != null) sb.append("HLSFragmentSelector: " + getHLSFragmentSelector() + ","); if (getContainerFormat() != null) sb.append("ContainerFormat: " + getContainerFormat() + ","); if (getDiscontinuityMode() != null) sb.append("DiscontinuityMode: " + getDiscontinuityMode() + ","); if (getDisplayFragmentTimestamp() != null) sb.append("DisplayFragmentTimestamp: " + getDisplayFragmentTimestamp() + ","); if (getExpires() != null) sb.append("Expires: " + getExpires() + ","); if (getMaxMediaPlaylistFragmentResults() != null) sb.append("MaxMediaPlaylistFragmentResults: " + getMaxMediaPlaylistFragmentResults()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getStreamName() == null) ? 0 : getStreamName().hashCode()); hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode()); hashCode = prime * hashCode + ((getPlaybackMode() == null) ? 0 : getPlaybackMode().hashCode()); hashCode = prime * hashCode + ((getHLSFragmentSelector() == null) ? 0 : getHLSFragmentSelector().hashCode()); hashCode = prime * hashCode + ((getContainerFormat() == null) ? 0 : getContainerFormat().hashCode()); hashCode = prime * hashCode + ((getDiscontinuityMode() == null) ? 0 : getDiscontinuityMode().hashCode()); hashCode = prime * hashCode + ((getDisplayFragmentTimestamp() == null) ? 0 : getDisplayFragmentTimestamp() .hashCode()); hashCode = prime * hashCode + ((getExpires() == null) ? 0 : getExpires().hashCode()); hashCode = prime * hashCode + ((getMaxMediaPlaylistFragmentResults() == null) ? 0 : getMaxMediaPlaylistFragmentResults().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetHLSStreamingSessionURLRequest == false) return false; GetHLSStreamingSessionURLRequest other = (GetHLSStreamingSessionURLRequest) obj; if (other.getStreamName() == null ^ this.getStreamName() == null) return false; if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == false) return false; if (other.getStreamARN() == null ^ this.getStreamARN() == null) return false; if (other.getStreamARN() != null && other.getStreamARN().equals(this.getStreamARN()) == false) return false; if (other.getPlaybackMode() == null ^ this.getPlaybackMode() == null) return false; if (other.getPlaybackMode() != null && other.getPlaybackMode().equals(this.getPlaybackMode()) == false) return false; if (other.getHLSFragmentSelector() == null ^ this.getHLSFragmentSelector() == null) return false; if (other.getHLSFragmentSelector() != null && other.getHLSFragmentSelector().equals(this.getHLSFragmentSelector()) == false) return false; if (other.getContainerFormat() == null ^ this.getContainerFormat() == null) return false; if (other.getContainerFormat() != null && other.getContainerFormat().equals(this.getContainerFormat()) == false) return false; if (other.getDiscontinuityMode() == null ^ this.getDiscontinuityMode() == null) return false; if (other.getDiscontinuityMode() != null && other.getDiscontinuityMode().equals(this.getDiscontinuityMode()) == false) return false; if (other.getDisplayFragmentTimestamp() == null ^ this.getDisplayFragmentTimestamp() == null) return false; if (other.getDisplayFragmentTimestamp() != null && other.getDisplayFragmentTimestamp().equals(this.getDisplayFragmentTimestamp()) == false) return false; if (other.getExpires() == null ^ this.getExpires() == null) return false; if (other.getExpires() != null && other.getExpires().equals(this.getExpires()) == false) return false; if (other.getMaxMediaPlaylistFragmentResults() == null ^ this.getMaxMediaPlaylistFragmentResults() == null) return false; if (other.getMaxMediaPlaylistFragmentResults() != null && other.getMaxMediaPlaylistFragmentResults().equals( this.getMaxMediaPlaylistFragmentResults()) == false) return false; return true; } }