Class: Aws::KinesisVideoArchivedMedia::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::KinesisVideoArchivedMedia::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-kinesisvideoarchivedmedia/client.rb
Overview
An API client for KinesisVideoArchivedMedia. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::KinesisVideoArchivedMedia::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#get_clip(params = {}) ⇒ 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(params = {}) ⇒ Types::GetDASHStreamingSessionURLOutput
Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream.
-
#get_hls_streaming_session_url(params = {}) ⇒ Types::GetHLSStreamingSessionURLOutput
Retrieves an HTTP Live Streaming (HLS) URL for the stream.
-
#get_images(params = {}) ⇒ Types::GetImagesOutput
Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
-
#get_media_for_fragment_list(params = {}) ⇒ Types::GetMediaForFragmentListOutput
Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
-
#list_fragments(params = {}) ⇒ Types::ListFragmentsOutput
Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 444 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1603 1604 1605 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 1603 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1606 1607 1608 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 1606 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 1576 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::KinesisVideoArchivedMedia') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-kinesisvideoarchivedmedia' context[:gem_version] = '1.71.0' Seahorse::Client::Request.new(handlers, context) end |
#get_clip(params = {}) ⇒ 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 prerequisite to using GetCLip API, you must obtain an endpoint using ‘GetDataEndpoint`, specifying GET_CLIP for` the APIName parameter. </p> 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 Amazon Web Services Pricing. Charges for outgoing Amazon Web Services data apply. `
522 523 524 525 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 522 def get_clip(params = {}, = {}, &block) req = build_request(:get_clip, params) req.send_request(, &block) end |
#get_dash_streaming_session_url(params = {}) ⇒ 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).
<note markdown=“1”> Don’t share or store this token where an unauthorized entity can access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you use with your Amazon Web Services credentials.
</note>
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.
<note markdown=“1”> 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.
</note>
Data retrieved with this action is billable. See [Pricing] for details.
-
<note markdown=“1”> For restrictions that apply to MPEG-DASH sessions, see [Kinesis Video Streams Limits].
</note>
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 [Amazon Web Services Pricing]. Charges for both HLS sessions and outgoing Amazon Web Services 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 Amazon Web Services 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].
[1]: www.iso.org/standard/55980.html [2]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html [3]: www.iso.org/standard/43345.html [4]: www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html [5]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html [6]: aws.amazon.com/kinesis/video-streams/pricing/ [7]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html [8]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html [9]: aws.amazon.com/pricing/ [10]: developer.apple.com/streaming/ [11]: developer.apple.com [12]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html
852 853 854 855 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 852 def get_dash_streaming_session_url(params = {}, = {}) req = build_request(:get_dash_streaming_session_url, params) req.send_request() end |
#get_hls_streaming_session_url(params = {}) ⇒ 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:
-
For streaming video, 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`. For audio only streaming, the codec ID of track 1 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).
<note markdown=“1”> 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 Amazon Web Services credentials.
</note>
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.
<note markdown=“1”> For the HLS streaming session, in-track codec private data (CPD) changes are supported. After the first media fragment is made available in a streaming session, fragments can contain CPD changes for each track. Therefore, the fragments in a session can have a different resolution, bit rate, or other information in the CPD without interrupting playback. However, any change made in the track number or track codec format can return an error when those different media fragments are loaded. For example, streaming will fail if the fragments in the stream change from having only video to having both audio and video, or if an AAC audio track is changed to an ALAW audio track. For each streaming session, only 500 CPD changes are allowed.
</note>
Data retrieved with this action is billable. For information, see [Pricing].
-
GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream.
<note markdown=“1”> If the ‘ContainerFormat` is `MPEG_TS`, this API is used instead of `GetMP4InitFragment` and `GetMP4MediaFragment` to retrieve stream media.
</note>
Data retrieved with this action is billable. For more information, see [Kinesis Video Streams pricing].
-
A streaming session URL must not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see [Kinesis Video Streams Limits].
You can monitor the amount of data that the media player consumes by monitoring the ‘GetMP4MediaFragment.OutgoingBytes` Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see [Monitoring Kinesis Video Streams]. For pricing information, see [Amazon Kinesis Video Streams Pricing] and [Amazon Web Services Pricing]. Charges for both HLS sessions and outgoing Amazon Web Services 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 Amazon Web Services, 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].
[1]: www.iso.org/standard/55980.html [2]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html [3]: www.iso.org/standard/43345.html [4]: tools.ietf.org/html/draft-pantos-http-live-streaming-23 [5]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html [6]: aws.amazon.com/kinesis/video-streams/pricing/ [7]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html [8]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html [9]: aws.amazon.com/pricing/ [10]: developer.apple.com/streaming/ [11]: developer.apple.com [12]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html
1256 1257 1258 1259 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 1256 def get_hls_streaming_session_url(params = {}, = {}) req = build_request(:get_hls_streaming_session_url, params) req.send_request() end |
#get_images(params = {}) ⇒ Types::GetImagesOutput
Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1379 1380 1381 1382 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 1379 def get_images(params = {}, = {}) req = build_request(:get_images, params) req.send_request() end |
#get_media_for_fragment_list(params = {}) ⇒ Types::GetMediaForFragmentListOutput
Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
<note markdown=“1”> You must first call the ‘GetDataEndpoint` API to get an endpoint. Then send the `GetMediaForFragmentList` requests to this endpoint using the [–endpoint-url parameter].
</note>
For limits, see [Kinesis Video Streams Limits].
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 Amazon Web Services, 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].
[1]: docs.aws.amazon.com/cli/latest/reference/ [2]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html [3]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html
1457 1458 1459 1460 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 1457 def get_media_for_fragment_list(params = {}, = {}, &block) req = build_request(:get_media_for_fragment_list, params) req.send_request(, &block) end |
#list_fragments(params = {}) ⇒ 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.
<note markdown=“1”> You must first call the ‘GetDataEndpoint` API to get an endpoint. Then send the `ListFragments` requests to this endpoint using the [–endpoint-url parameter].
</note>
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 Amazon Web Services, 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].
[1]: docs.aws.amazon.com/cli/latest/reference/ [2]: docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1567 1568 1569 1570 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 1567 def list_fragments(params = {}, = {}) req = build_request(:list_fragments, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1596 1597 1598 |
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/client.rb', line 1596 def waiter_names [] end |