Documentation

Overview

    Package kinesisvideoarchivedmedia provides the API client, operations, and parameter types for Amazon Kinesis Video Streams Archived Media.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2017-09-30"
    View Source
    const ServiceID = "Kinesis Video Archived Media"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for Amazon Kinesis Video Streams Archived Media.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) GetClip

                func (c *Client) GetClip(ctx context.Context, params *GetClipInput, optFns ...func(*Options)) (*GetClipOutput, error)

                  Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the specified time range. Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation. As a prerequsite to using GetCLip API, you must obtain an endpoint using GetDataEndpoint, specifying GET_CLIP for the APIName parameter. An Amazon Kinesis video stream has the following requirements for providing data through MP4:

                  * The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711).

                  * 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 and HEVC for H.265 format. For more information, see 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 (http://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)) or the MS Wave format (http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html).

                  You can monitor the amount of outgoing data by monitoring the GetClip.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams (http://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 outgoing AWS data apply.

                  func (*Client) GetDASHStreamingSessionURL

                  func (c *Client) GetDASHStreamingSessionURL(ctx context.Context, params *GetDASHStreamingSessionURLInput, optFns ...func(*Options)) (*GetDASHStreamingSessionURLOutput, error)

                    Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You can then open the URL in a 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 MPEG-DASH:

                    * The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711).

                    * 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 and HEVC for H.265 format. For more information, see 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 (http://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)) or the MS Wave format (http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html).

                    The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:

                    * Get an endpoint using GetDataEndpoint (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html), specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter.

                    * Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL. Kinesis Video Streams creates an MPEG-DASH streaming session to be used for accessing content in a stream using the MPEG-DASH protocol. GetDASHStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's MPEG-DASH manifest (the root resource needed for streaming with MPEG-DASH). 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 manifest 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.

                    * Provide the URL (containing the encrypted session token) for the MPEG-DASH manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video Streams makes the initialization fragment and media fragments available through the manifest 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 encoded video frames or encoded audio samples.

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

                    * GetDASHManifest: Retrieves an MPEG DASH manifest, which contains the metadata for the media that you want to playback.

                    * 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. After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video. Data retrieved with this action is billable. See Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) for details.

                    The following restrictions apply to MPEG-DASH sessions:

                    * A streaming session URL should 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 (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

                    * A Kinesis video stream can have a maximum of ten active MPEG-DASH streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active MPEG-DASH sessions does not count against the active GetMedia connection limit. The maximum limits for active HLS and MPEG-DASH streaming sessions are independent of each other.

                    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 (http://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. For more information about HLS, see HTTP Live Streaming (https://developer.apple.com/streaming/) on the Apple Developer site (https://developer.apple.com). 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).

                    func (*Client) GetHLSStreamingSessionURL

                    func (c *Client) GetHLSStreamingSessionURL(ctx context.Context, params *GetHLSStreamingSessionURLInput, optFns ...func(*Options)) (*GetHLSStreamingSessionURLOutput, error)

                      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:

                      * The media must contain h.264 or h.265 encoded video and, optionally, AAC encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEG/ISO/HEVC (for h.265). Optionally, the codec ID of track 2 should be A_AAC.

                      * 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 (http://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:

                      * Get an endpoint using GetDataEndpoint (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html), specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.

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

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

                      * 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. After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video. Data retrieved with this action is billable. See Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) for details.

                      * GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream. 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/).

                      The following restrictions apply to HLS sessions:

                      * A streaming session URL should 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 (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

                      * A Kinesis video stream can have a maximum of ten active HLS streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active HLS sessions does not count against the active GetMedia connection limit. The maximum limits for active HLS and MPEG-DASH streaming sessions are independent of each other.

                      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 (http://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. For more information about HLS, see HTTP Live Streaming (https://developer.apple.com/streaming/) on the Apple Developer site (https://developer.apple.com). 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).

                      func (*Client) GetMediaForFragmentList

                      func (c *Client) GetMediaForFragmentList(ctx context.Context, params *GetMediaForFragmentListInput, optFns ...func(*Options)) (*GetMediaForFragmentListOutput, error)

                        Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter (https://docs.aws.amazon.com/cli/latest/reference/). The following limits apply when using the GetMediaForFragmentList API:

                        * A client can call GetMediaForFragmentList up to five times per second per stream.

                        * Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMediaForFragmentList session.

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

                        func (*Client) ListFragments

                        func (c *Client) ListFragments(ctx context.Context, params *ListFragmentsInput, optFns ...func(*Options)) (*ListFragmentsOutput, error)

                          Returns a list of Fragment objects from the specified stream and timestamp range within the archived data. Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second. You must first call the GetDataEndpoint API to get an endpoint. Then send the ListFragments requests to this endpoint using the --endpoint-url parameter (https://docs.aws.amazon.com/cli/latest/reference/). 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).

                          type EndpointResolver

                          type EndpointResolver interface {
                          	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                          }

                            EndpointResolver interface for resolving service endpoints.

                            func EndpointResolverFromURL

                            func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                              EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                              type EndpointResolverFunc

                              type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                func (EndpointResolverFunc) ResolveEndpoint

                                func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                type EndpointResolverOptions

                                type EndpointResolverOptions = internalendpoints.Options

                                  EndpointResolverOptions is the service endpoint resolver options

                                  type GetClipInput

                                  type GetClipInput struct {
                                  
                                  	// The time range of the requested clip and the source of the timestamps.
                                  	//
                                  	// This member is required.
                                  	ClipFragmentSelector *types.ClipFragmentSelector
                                  
                                  	// The Amazon Resource Name (ARN) of the stream for which to retrieve the media
                                  	// clip. You must specify either the StreamName or the StreamARN.
                                  	StreamARN *string
                                  
                                  	// The name of the stream for which to retrieve the media clip. You must specify
                                  	// either the StreamName or the StreamARN.
                                  	StreamName *string
                                  }

                                  type GetClipOutput

                                  type GetClipOutput struct {
                                  
                                  	// The content type of the media in the requested clip.
                                  	ContentType *string
                                  
                                  	// 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.
                                  	Payload io.ReadCloser
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type GetDASHStreamingSessionURLInput

                                  type GetDASHStreamingSessionURLInput struct {
                                  
                                  	// The time range of the requested fragment and the source of the timestamps. This
                                  	// parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This
                                  	// parameter is optional if PlaybackMode isLIVE. If PlaybackMode is LIVE, the
                                  	// FragmentSelectorType can be set, but the TimestampRange should not be set. If
                                  	// PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and
                                  	// TimestampRange must be set.
                                  	DASHFragmentSelector *types.DASHFragmentSelector
                                  
                                  	// 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.
                                  	DisplayFragmentNumber types.DASHDisplayFragmentNumber
                                  
                                  	// 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.
                                  	DisplayFragmentTimestamp types.DASHDisplayFragmentTimestamp
                                  
                                  	// 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).
                                  	Expires *int32
                                  
                                  	// 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.
                                  	MaxManifestFragmentResults *int32
                                  
                                  	// Whether to retrieve live, live replay, or archived, on-demand data. Features of
                                  	// the three types of sessions include the following:
                                  	//
                                  	// * LIVE : For sessions of
                                  	// this type, the MPEG-DASH manifest is continually updated with the latest
                                  	// fragments as they become available. We recommend that the media player retrieve
                                  	// a new manifest on a one-second interval. When this type of session is played in
                                  	// a media player, the user interface typically displays a "live" notification,
                                  	// with no scrubber control for choosing the position in the playback window to
                                  	// display. In LIVE mode, the newest available fragments are included in an
                                  	// MPEG-DASH manifest, even if there is a gap between fragments (that is, if a
                                  	// fragment is missing). A gap like this might cause a media player to halt or
                                  	// cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH
                                  	// manifest if they are older than the newest fragment in the playlist. If the
                                  	// missing fragment becomes available after a subsequent fragment is added to the
                                  	// manifest, the older fragment is not added, and the gap is not filled.
                                  	//
                                  	// *
                                  	// LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated
                                  	// similarly to how it is updated for LIVE mode except that it starts by including
                                  	// fragments from a given start time. Instead of fragments being added as they are
                                  	// ingested, fragments are added as the duration of the next fragment elapses. For
                                  	// example, if the fragments in the session are two seconds long, then a new
                                  	// fragment is added to the manifest every two seconds. This mode is useful to be
                                  	// able to start playback from when an event is detected and continue live
                                  	// streaming media that has not yet been ingested as of the time of the session
                                  	// creation. This mode is also useful to stream previously archived media without
                                  	// being limited by the 1,000 fragment limit in the ON_DEMAND mode.
                                  	//
                                  	// * ON_DEMAND :
                                  	// For sessions of this type, the MPEG-DASH manifest contains all the fragments for
                                  	// the session, up to the number that is specified in
                                  	// MaxMediaPlaylistFragmentResults. The manifest must be retrieved only once for
                                  	// each session. When this type of session is played in a media player, the user
                                  	// interface typically displays a scrubber control for choosing the position in the
                                  	// playback window to display.
                                  	//
                                  	// In all playback modes, if FragmentSelectorType is
                                  	// PRODUCER_TIMESTAMP, and if there are multiple fragments with the same start
                                  	// timestamp, the fragment that has the larger fragment number (that is, the newer
                                  	// fragment) is included in the MPEG-DASH manifest. The other fragments are not
                                  	// included. Fragments that have different timestamps but have overlapping
                                  	// durations are still included in the MPEG-DASH manifest. This can lead to
                                  	// unexpected behavior in the media player. The default is LIVE.
                                  	PlaybackMode types.DASHPlaybackMode
                                  
                                  	// 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.
                                  	StreamARN *string
                                  
                                  	// The name of the stream for which to retrieve the MPEG-DASH manifest URL. You
                                  	// must specify either the StreamName or the StreamARN.
                                  	StreamName *string
                                  }

                                  type GetDASHStreamingSessionURLOutput

                                  type GetDASHStreamingSessionURLOutput struct {
                                  
                                  	// The URL (containing the session token) that a media player can use to retrieve
                                  	// the MPEG-DASH manifest.
                                  	DASHStreamingSessionURL *string
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type GetHLSStreamingSessionURLInput

                                  type GetHLSStreamingSessionURLInput struct {
                                  
                                  	// 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.
                                  	ContainerFormat types.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:
                                  	//
                                  	// * 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_DISCONTIUNITY: 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.
                                  	DiscontinuityMode types.HLSDiscontinuityMode
                                  
                                  	// 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.
                                  	DisplayFragmentTimestamp types.HLSDisplayFragmentTimestamp
                                  
                                  	// 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).
                                  	Expires *int32
                                  
                                  	// The time range of the requested fragment and the source of the timestamps. This
                                  	// parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This
                                  	// parameter is optional if PlaybackMode isLIVE. If PlaybackMode is LIVE, the
                                  	// FragmentSelectorType can be set, but the TimestampRange should not be set. If
                                  	// PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and
                                  	// TimestampRange must be set.
                                  	HLSFragmentSelector *types.HLSFragmentSelector
                                  
                                  	// 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 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.
                                  	MaxMediaPlaylistFragmentResults *int32
                                  
                                  	// 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
                                  	// larger fragment number (that is, the newer 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.
                                  	PlaybackMode types.HLSPlaybackMode
                                  
                                  	// 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.
                                  	StreamARN *string
                                  
                                  	// The name of the stream for which to retrieve the HLS master playlist URL. You
                                  	// must specify either the StreamName or the StreamARN.
                                  	StreamName *string
                                  }

                                  type GetHLSStreamingSessionURLOutput

                                  type GetHLSStreamingSessionURLOutput struct {
                                  
                                  	// The URL (containing the session token) that a media player can use to retrieve
                                  	// the HLS master playlist.
                                  	HLSStreamingSessionURL *string
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type GetMediaForFragmentListInput

                                  type GetMediaForFragmentListInput struct {
                                  
                                  	// A list of the numbers of fragments for which to retrieve media. You retrieve
                                  	// these values with ListFragments.
                                  	//
                                  	// This member is required.
                                  	Fragments []string
                                  
                                  	// The name of the stream from which to retrieve fragment media.
                                  	//
                                  	// This member is required.
                                  	StreamName *string
                                  }

                                  type GetMediaForFragmentListOutput

                                  type GetMediaForFragmentListOutput struct {
                                  
                                  	// The content type of the requested media.
                                  	ContentType *string
                                  
                                  	// The payload that Kinesis Video Streams returns is a sequence of chunks from the
                                  	// specified stream. For information about the chunks, see PutMedia
                                  	// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html).
                                  	// 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
                                  	Payload io.ReadCloser
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type HTTPClient

                                  type HTTPClient interface {
                                  	Do(*http.Request) (*http.Response, error)
                                  }

                                  type HTTPSignerV4

                                  type HTTPSignerV4 interface {
                                  	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                  }

                                  type ListFragmentsAPIClient

                                  type ListFragmentsAPIClient interface {
                                  	ListFragments(context.Context, *ListFragmentsInput, ...func(*Options)) (*ListFragmentsOutput, error)
                                  }

                                    ListFragmentsAPIClient is a client that implements the ListFragments operation.

                                    type ListFragmentsInput

                                    type ListFragmentsInput struct {
                                    
                                    	// The name of the stream from which to retrieve a fragment list.
                                    	//
                                    	// This member is required.
                                    	StreamName *string
                                    
                                    	// Describes the timestamp range and timestamp origin for the range of fragments to
                                    	// return.
                                    	FragmentSelector *types.FragmentSelector
                                    
                                    	// 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.
                                    	MaxResults *int32
                                    
                                    	// A token to specify where to start paginating. This is the
                                    	// ListFragmentsOutput$NextToken from a previously truncated response.
                                    	NextToken *string
                                    }

                                    type ListFragmentsOutput

                                    type ListFragmentsOutput struct {
                                    
                                    	// A list of archived Fragment objects from the stream that meet the selector
                                    	// criteria. Results are in no specific order, even across pages.
                                    	Fragments []types.Fragment
                                    
                                    	// 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.
                                    	NextToken *string
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                    type ListFragmentsPaginator

                                    type ListFragmentsPaginator struct {
                                    	// contains filtered or unexported fields
                                    }

                                      ListFragmentsPaginator is a paginator for ListFragments

                                      func NewListFragmentsPaginator

                                      func NewListFragmentsPaginator(client ListFragmentsAPIClient, params *ListFragmentsInput, optFns ...func(*ListFragmentsPaginatorOptions)) *ListFragmentsPaginator

                                        NewListFragmentsPaginator returns a new ListFragmentsPaginator

                                        func (*ListFragmentsPaginator) HasMorePages

                                        func (p *ListFragmentsPaginator) HasMorePages() bool

                                          HasMorePages returns a boolean indicating whether more pages are available

                                          func (*ListFragmentsPaginator) NextPage

                                          func (p *ListFragmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFragmentsOutput, error)

                                            NextPage retrieves the next ListFragments page.

                                            type ListFragmentsPaginatorOptions

                                            type ListFragmentsPaginatorOptions struct {
                                            	// 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.
                                            	Limit int32
                                            
                                            	// Set to true if pagination should stop if the service returns a pagination token
                                            	// that matches the most recent token provided to the service.
                                            	StopOnDuplicateToken bool
                                            }

                                              ListFragmentsPaginatorOptions is the paginator options for ListFragments

                                              type Options

                                              type Options struct {
                                              	// Set of options to modify how an operation is invoked. These apply to all
                                              	// operations invoked for this client. Use functional options on operation call to
                                              	// modify this list for per operation behavior.
                                              	APIOptions []func(*middleware.Stack) error
                                              
                                              	// Configures the events that will be sent to the configured logger.
                                              	ClientLogMode aws.ClientLogMode
                                              
                                              	// The credentials object to use when signing requests.
                                              	Credentials aws.CredentialsProvider
                                              
                                              	// The endpoint options to be used when attempting to resolve an endpoint.
                                              	EndpointOptions EndpointResolverOptions
                                              
                                              	// The service endpoint resolver.
                                              	EndpointResolver EndpointResolver
                                              
                                              	// Signature Version 4 (SigV4) Signer
                                              	HTTPSignerV4 HTTPSignerV4
                                              
                                              	// The logger writer interface to write logging messages to.
                                              	Logger logging.Logger
                                              
                                              	// The region to send requests to. (Required)
                                              	Region string
                                              
                                              	// Retryer guides how HTTP requests should be retried in case of recoverable
                                              	// failures. When nil the API client will use a default retryer.
                                              	Retryer aws.Retryer
                                              
                                              	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                              	// implementation if nil.
                                              	HTTPClient HTTPClient
                                              }

                                              func (Options) Copy

                                              func (o Options) Copy() Options

                                                Copy creates a clone where the APIOptions list is deep copied.

                                                type ResolveEndpoint

                                                type ResolveEndpoint struct {
                                                	Resolver EndpointResolver
                                                	Options  EndpointResolverOptions
                                                }

                                                func (*ResolveEndpoint) HandleSerialize

                                                func (*ResolveEndpoint) ID

                                                func (*ResolveEndpoint) ID() string

                                                Directories

                                                Path Synopsis
                                                internal