You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KinesisVideoArchivedMedia::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::KinesisVideoArchivedMedia::Client

show all

Defined in:: (unknown)

Overview

An API client for Amazon Kinesis Video Streams Archived Media. To construct a client, you need to configure a :region and :credentials.

kinesisvideoarchivedmedia = Aws::KinesisVideoArchivedMedia::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::KinesisVideoArchivedMedia::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::KinesisVideoArchivedMedia::Client constructor
Constructs an API client.

API Operations collapse

#get_clip(options = {}) ⇒ Types::GetClipOutput
Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the specified time range.
#get_dash_streaming_session_url(options = {}) ⇒ Types::GetDASHStreamingSessionURLOutput
Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream.
#get_hls_streaming_session_url(options = {}) ⇒ Types::GetHLSStreamingSessionURLOutput
Retrieves an HTTP Live Streaming (HLS) URL for the stream.
#get_media_for_fragment_list(options = {}) ⇒ Types::GetMediaForFragmentListOutput
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.
#list_fragments(options = {}) ⇒ Types::ListFragmentsOutput
Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.

Listing fragments is eventually consistent.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::KinesisVideoArchivedMedia::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#get_clip(options = {}) ⇒ `Types::GetClipOutput`

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. For information about adapting stream data to a given format, see NAL Adaptation Flags.
 
  The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format.
 
 
 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. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for outgoing AWS data apply.



  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.get_clip({
  response_target: "/path/to/file", # where to write response data, file path, or IO object
  stream_name: "StreamName",
  stream_arn: "ResourceARN",
  clip_fragment_selector: { # required
    fragment_selector_type: "PRODUCER_TIMESTAMP", # required, accepts PRODUCER_TIMESTAMP, SERVER_TIMESTAMP
    timestamp_range: { # required
      start_timestamp: Time.now, # required
      end_timestamp: Time.now, # required
    },
  },
})
    
      
        
Response structure

      
      
resp.content_type #=> String
resp.payload #=> IO
    
  

  
    
    
    Options Hash (options):
    
      
        
          :response_target
          (IO, String)
          
            
          
          
            — Specifies where to stream response data. You can provide the path where a file will be created on disk, or you can provide an IO object. If omitted, the response data will be loaded into memory and written to a StringIO object.

          
        
      
        
          :stream_name
          (String)
          
            
          
          
            — The name of the stream for which to retrieve the media clip.

You must specify either the StreamName or the StreamARN.

          
        
      
        
          :stream_arn
          (String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the stream for which to retrieve the
media clip.

You must specify either the StreamName or the StreamARN.

          
        
      
        
          :clip_fragment_selector
          (required, Types::ClipFragmentSelector)
          
            
          
          
            — The time range of the requested clip and the source of the timestamps.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::GetClipOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#content_type => String
#payload => IO



      
    
  


  See Also:
  
    
      AWS API Documentation


    
      
  
  
    #get_dash_streaming_session_url(options = {})  ⇒ Types::GetDASHStreamingSessionURLOutput 
  

  

  

  
    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. For information about adapting stream data to a given format, see NAL Adaptation Flags.
 
  The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format.
 
 
 The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:
   Get an endpoint using GetDataEndpoint, 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 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.
 
  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. 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: 
    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. 
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.get_dash_streaming_session_url({
  stream_name: "StreamName",
  stream_arn: "ResourceARN",
  playback_mode: "LIVE", # accepts LIVE, LIVE_REPLAY, ON_DEMAND
  display_fragment_timestamp: "ALWAYS", # accepts ALWAYS, NEVER
  display_fragment_number: "ALWAYS", # accepts ALWAYS, NEVER
  dash_fragment_selector: {
    fragment_selector_type: "PRODUCER_TIMESTAMP", # accepts PRODUCER_TIMESTAMP, SERVER_TIMESTAMP
    timestamp_range: {
      start_timestamp: Time.now,
      end_timestamp: Time.now,
    },
  },
  expires: 1,
  max_manifest_fragment_results: 1,
})
    
      
        
Response structure

      
      
resp.dash_streaming_session_url #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :stream_name
          (String)
          
            
          
          
            — The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

          
        
      
        
          :stream_arn
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :playback_mode
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :display_fragment_timestamp
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :display_fragment_number
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :dash_fragment_selector
          (Types::DASHFragmentSelector)
          
            
          
          
            — The time range of the requested fragment and the source of the
timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or
LIVE_REPLAY. This parameter is optional if PlaybackMode is`LIVE.
IfPlaybackModeisLIVE, theFragmentSelectorTypecan be set, but
theTimestampRangeshould not be set. IfPlaybackModeisON_DEMAND
orLIVE_REPLAY, bothFragmentSelectorTypeandTimestampRange` must
be set.

          
        
      
        
          :expires
          (Integer)
          
            
          
          
            — 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).

          
        
      
        
          :max_manifest_fragment_results
          (Integer)
          
            
          
          
            — 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.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::GetDASHStreamingSessionURLOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#dash_streaming_session_url => String



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #get_hls_streaming_session_url(options = {})  ⇒ Types::GetHLSStreamingSessionURLOutput 
  

  

  

  
    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). For information about adapting stream data to a given format, see NAL Adaptation Flags.
 
  The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7).
 
 
 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:
   Get an endpoint using GetDataEndpoint, 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 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.
 
 
 
 
  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.
 
  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. 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: 
    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. 
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.get_hls_streaming_session_url({
  stream_name: "StreamName",
  stream_arn: "ResourceARN",
  playback_mode: "LIVE", # accepts LIVE, LIVE_REPLAY, ON_DEMAND
  hls_fragment_selector: {
    fragment_selector_type: "PRODUCER_TIMESTAMP", # accepts PRODUCER_TIMESTAMP, SERVER_TIMESTAMP
    timestamp_range: {
      start_timestamp: Time.now,
      end_timestamp: Time.now,
    },
  },
  container_format: "FRAGMENTED_MP4", # accepts FRAGMENTED_MP4, MPEG_TS
  discontinuity_mode: "ALWAYS", # accepts ALWAYS, NEVER, ON_DISCONTINUITY
  display_fragment_timestamp: "ALWAYS", # accepts ALWAYS, NEVER
  expires: 1,
  max_media_playlist_fragment_results: 1,
})
    
      
        
Response structure

      
      
resp.hls_streaming_session_url #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :stream_name
          (String)
          
            
          
          
            — The name of the stream for which to retrieve the HLS master playlist
URL.

You must specify either the StreamName or the StreamARN.

          
        
      
        
          :stream_arn
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :playback_mode
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :hls_fragment_selector
          (Types::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.
IfPlaybackModeisLIVE, theFragmentSelectorTypecan be set, but
theTimestampRangeshould not be set. IfPlaybackModeisON_DEMAND
orLIVE_REPLAY, bothFragmentSelectorTypeandTimestampRange` must
be set.

          
        
      
        
          :container_format
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :discontinuity_mode
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :display_fragment_timestamp
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :expires
          (Integer)
          
            
          
          
            — 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).

          
        
      
        
          :max_media_playlist_fragment_results
          (Integer)
          
            
          
          
            — 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.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::GetHLSStreamingSessionURLOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#hls_streaming_session_url => String



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #get_media_for_fragment_list(options = {})  ⇒ Types::GetMediaForFragmentListOutput 
  

  

  

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


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.get_media_for_fragment_list({
  response_target: "/path/to/file", # where to write response data, file path, or IO object
  stream_name: "StreamName", # required
  fragments: ["FragmentNumberString"], # required
})
    
      
        
Response structure

      
      
resp.content_type #=> String
resp.payload #=> IO
    
  

  
    
    
    Options Hash (options):
    
      
        
          :response_target
          (IO, String)
          
            
          
          
            — Specifies where to stream response data. You can provide the path where a file will be created on disk, or you can provide an IO object. If omitted, the response data will be loaded into memory and written to a StringIO object.

          
        
      
        
          :stream_name
          (required, String)
          
            
          
          
            — The name of the stream from which to retrieve fragment media.

          
        
      
        
          :fragments
          (required, Array<String>)
          
            
          
          
            — A list of the numbers of fragments for which to retrieve media. You
retrieve these values with ListFragments.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::GetMediaForFragmentListOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#content_type => String
#payload => IO



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #list_fragments(options = {})  ⇒ Types::ListFragmentsOutput 
  

  

  

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


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.list_fragments({
  stream_name: "StreamName", # required
  max_results: 1,
  next_token: "NextToken",
  fragment_selector: {
    fragment_selector_type: "PRODUCER_TIMESTAMP", # required, accepts PRODUCER_TIMESTAMP, SERVER_TIMESTAMP
    timestamp_range: { # required
      start_timestamp: Time.now, # required
      end_timestamp: Time.now, # required
    },
  },
})
    
      
        
Response structure

      
      
resp.fragments #=> Array
resp.fragments[0].fragment_number #=> String
resp.fragments[0].fragment_size_in_bytes #=> Integer
resp.fragments[0].producer_timestamp #=> Time
resp.fragments[0].server_timestamp #=> Time
resp.fragments[0].fragment_length_in_milliseconds #=> Integer
resp.next_token #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :stream_name
          (required, String)
          
            
          
          
            — The name of the stream from which to retrieve a fragment list.

          
        
      
        
          :max_results
          (Integer)
          
            
          
          
            — 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.

          
        
      
        
          :next_token
          (String)
          
            
          
          
            — A token to specify where to start paginating. This is the
ListFragmentsOutput$NextToken from a previously truncated
response.

          
        
      
        
          :fragment_selector
          (Types::FragmentSelector)
          
            
          
          
            — Describes the timestamp range and timestamp origin for the range of
fragments to return.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::ListFragmentsOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#fragments => Array<Types::Fragment>
#next_token => String



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean 
  

  

  

  
    Waiters polls an API operation until a resource enters a desired
state.

Basic Usage

Waiters will poll until they are succesful, they fail by
entering a terminal state, or until a maximum number of attempts
are made.

   # polls in a loop, sleeping between attempts
   client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the
delay (in seconds) between each polling attempt. You configure
waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end


Callbacks

You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end


Handling Errors

When a waiter is successful, it returns true. When a waiter
fails, it raises an error. All errors raised extend from
Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end



  


  Parameters:

  
    
      
        waiter_name
      
      
        (Symbol)
      
      
      
        —
        The name of the waiter. See #waiter_names
for a full list of supported waiters.

      
    
  
    
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        Additional request parameters. See the #waiter_names
for a list of supported waiters and what request they call. The
called request determines the list of accepted parameters.

      
    
  


Yield Parameters:

  
    
      
        waiter
      
      
        (Waiters::Waiter)
      
      
      
        —
        Yields a Waiter
object that can be configured prior to waiting.

      
    
  

Returns:

  
    
      
      
        (Boolean)
      
      
      
        —
        Returns true if the waiter was successful.

      
    
  

Raises:

  
    
      
      
        (Errors::FailureStateError)
      
      
      
        —
        Raised when the waiter terminates
because the waiter has entered a state that it will not transition
out of, preventing success.

      
    
  
    
      
      
        (Errors::TooManyAttemptsError)
      
      
      
        —
        Raised when the configured
maximum number of attempts have been made, and the waiter is not
yet successful.

      
    
  
    
      
      
        (Errors::UnexpectedError)
      
      
      
        —
        Raised when an error is encounted
while polling for a resource that is not expected.

      
    
  
    
      
      
        (Errors::NoSuchWaiterError)
      
      
      
        —
        Raised when you request to wait
for an unknown state.

      
    
  




    
      
  
  
    #waiter_names  ⇒ Array<Symbol> 
  

  

  

  
    Returns the list of supported waiters. The following table lists the supported
waiters and the client method they call:



Waiter Name Client Method Default Delay: Default Max Attempts:








  


  
Returns:

  
    
      
      
        (Array<Symbol>)
      
      
      
        —
        the list of supported waiters.



      
  Generated on Mon Nov 11 04:50:03 2024 by
  yard
  0.9.34 (ruby-2.7.8).

Class: Aws::KinesisVideoArchivedMedia::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ `Aws::KinesisVideoArchivedMedia::Client`

Instance Method Details

#get_clip(options = {}) ⇒ `Types::GetClipOutput`

#get_dash_streaming_session_url(options = {}) ⇒ `Types::GetDASHStreamingSessionURLOutput`

#get_hls_streaming_session_url(options = {}) ⇒ `Types::GetHLSStreamingSessionURLOutput`

#get_media_for_fragment_list(options = {}) ⇒ `Types::GetMediaForFragmentListOutput`

#list_fragments(options = {}) ⇒ `Types::ListFragmentsOutput`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ `Array<Symbol>`

Class: Aws::KinesisVideoArchivedMedia::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::KinesisVideoArchivedMedia::Client

Instance Method Details

#get_clip(options = {}) ⇒ Types::GetClipOutput

#get_dash_streaming_session_url(options = {}) ⇒ Types::GetDASHStreamingSessionURLOutput

#get_hls_streaming_session_url(options = {}) ⇒ Types::GetHLSStreamingSessionURLOutput

#get_media_for_fragment_list(options = {}) ⇒ Types::GetMediaForFragmentListOutput

#list_fragments(options = {}) ⇒ Types::ListFragmentsOutput

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::KinesisVideoArchivedMedia::Client`

#get_clip(options = {}) ⇒ `Types::GetClipOutput`

#get_dash_streaming_session_url(options = {}) ⇒ `Types::GetDASHStreamingSessionURLOutput`

#get_hls_streaming_session_url(options = {}) ⇒ `Types::GetHLSStreamingSessionURLOutput`

#get_media_for_fragment_list(options = {}) ⇒ `Types::GetMediaForFragmentListOutput`

#list_fragments(options = {}) ⇒ `Types::ListFragmentsOutput`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

#waiter_names ⇒ `Array<Symbol>`