Struct aws_sdk_kinesisvideoarchivedmedia::Client

pub struct Client { /* private fields */ }

Client for Amazon Kinesis Video Streams Archived Media

Client for invoking operations on Amazon Kinesis Video Streams Archived Media. Each operation on Amazon Kinesis Video Streams Archived Media is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_kinesisvideoarchivedmedia::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_kinesisvideoarchivedmedia::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_kinesisvideoarchivedmedia::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn get_clip(&self) -> GetClip

Constructs a fluent builder for the GetClip operation.

• The fluent builder is configurable:
  • stream_name(impl Into<String>) / set_stream_name(Option<String>):

    The name of the stream for which to retrieve the media clip.

    You must specify either the StreamName or the StreamARN.

  • stream_arn(impl Into<String>) / set_stream_arn(Option<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(ClipFragmentSelector) / set_clip_fragment_selector(Option<ClipFragmentSelector>):

    The time range of the requested clip and the source of the timestamps.

• On success, responds with GetClipOutput with field(s):
  • content_type(Option<String>):

    The content type of the media in the requested clip.

  • payload(ByteStream):

    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.

• On failure, responds with SdkError<GetClipError>

pub fn get_dash_streaming_session_url(&self) -> GetDASHStreamingSessionURL

Constructs a fluent builder for the GetDASHStreamingSessionURL operation.

• The fluent builder is configurable:
  • stream_name(impl Into<String>) / set_stream_name(Option<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(impl Into<String>) / set_stream_arn(Option<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(DashPlaybackMode) / set_playback_mode(Option<DashPlaybackMode>):

    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 MaxManifestFragmentResults. 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(DashDisplayFragmentTimestamp) / set_display_fragment_timestamp(Option<DashDisplayFragmentTimestamp>):

    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(DashDisplayFragmentNumber) / set_display_fragment_number(Option<DashDisplayFragmentNumber>):

    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(DashFragmentSelector) / set_dash_fragment_selector(Option<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. 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.

  • expires(i32) / set_expires(Option<i32>):

    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(i64) / set_max_manifest_fragment_results(Option<i64>):

    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.

• On success, responds with GetDashStreamingSessionUrlOutput with field(s):
  • dash_streaming_session_url(Option<String>):

    The URL (containing the session token) that a media player can use to retrieve the MPEG-DASH manifest.

• On failure, responds with SdkError<GetDASHStreamingSessionURLError>

pub fn get_hls_streaming_session_url(&self) -> GetHLSStreamingSessionURL

Constructs a fluent builder for the GetHLSStreamingSessionURL operation.

• The fluent builder is configurable:
  • stream_name(impl Into<String>) / set_stream_name(Option<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(impl Into<String>) / set_stream_arn(Option<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(HlsPlaybackMode) / set_playback_mode(Option<HlsPlaybackMode>):

    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 largest fragment number (that is, the newest fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.

    The default is LIVE.

  • hls_fragment_selector(HlsFragmentSelector) / set_hls_fragment_selector(Option<HlsFragmentSelector>):

    The time range of the requested fragment and the source of the timestamps.

    This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

  • container_format(ContainerFormat) / set_container_format(Option<ContainerFormat>):

    Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

    The default is FRAGMENTED_MP4.

  • discontinuity_mode(HlsDiscontinuityMode) / set_discontinuity_mode(Option<HlsDiscontinuityMode>):

    Specifies when flags marking discontinuities between fragments are added to the media playlists.

    Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

    The following modes are supported:

    • ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.

    • NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.

    • ON_DISCONTINUITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

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

  • display_fragment_timestamp(HlsDisplayFragmentTimestamp) / set_display_fragment_timestamp(Option<HlsDisplayFragmentTimestamp>):

    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(i32) / set_expires(Option<i32>):

    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(i64) / set_max_media_playlist_fragment_results(Option<i64>):

    The maximum number of fragments that are returned in the HLS media playlists.

    When the PlaybackMode is LIVE, the most recent fragments are returned up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this maximum number.

    When there are a higher number of fragments available in a live HLS media playlist, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.

    The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND.

    The maximum value of 5,000 fragments corresponds to more than 80 minutes of video on streams with 1-second fragments, and more than 13 hours of video on streams with 10-second fragments.

• On success, responds with GetHlsStreamingSessionUrlOutput with field(s):
  • hls_streaming_session_url(Option<String>):

    The URL (containing the session token) that a media player can use to retrieve the HLS master playlist.

• On failure, responds with SdkError<GetHLSStreamingSessionURLError>

pub fn get_images(&self) -> GetImages

Constructs a fluent builder for the GetImages operation.

• The fluent builder is configurable:
  • stream_name(impl Into<String>) / set_stream_name(Option<String>):

    The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

  • stream_arn(impl Into<String>) / set_stream_arn(Option<String>):

    The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

  • image_selector_type(ImageSelectorType) / set_image_selector_type(Option<ImageSelectorType>):

    The origin of the Server or Producer timestamps to use to generate the images.

  • start_timestamp(DateTime) / set_start_timestamp(Option<DateTime>):

    The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.

  • end_timestamp(DateTime) / set_end_timestamp(Option<DateTime>):

    The end timestamp for the range of images to be generated.

  • sampling_interval(i32) / set_sampling_interval(Option<i32>):

    The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 3000 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.

    The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.

  • format(Format) / set_format(Option<Format>):

    The format that will be used to encode the image.

  • format_config(HashMap<FormatConfigKey, String>) / set_format_config(Option<HashMap<FormatConfigKey, String>>):

    The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

  • width_pixels(i32) / set_width_pixels(Option<i32>):

    The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.

  • height_pixels(i32) / set_height_pixels(Option<i32>):

    The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

  • max_results(i64) / set_max_results(Option<i64>):

    The maximum number of images to be returned by the API.

    The default limit is 100 images per API response. The additional results will be paginated.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

• On success, responds with GetImagesOutput with field(s):
  • images(Option<Vec<Image>>):

    The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

  • next_token(Option<String>):

    The encrypted token that was used in the request to get more images.

• On failure, responds with SdkError<GetImagesError>

pub fn get_media_for_fragment_list(&self) -> GetMediaForFragmentList

Constructs a fluent builder for the GetMediaForFragmentList operation.

• The fluent builder is configurable:
  • stream_name(impl Into<String>) / set_stream_name(Option<String>):

    The name of the stream from which to retrieve fragment media. Specify either this parameter or the StreamARN parameter.

  • stream_arn(impl Into<String>) / set_stream_arn(Option<String>):

    The Amazon Resource Name (ARN) of the stream from which to retrieve fragment media. Specify either this parameter or the StreamName parameter.

  • fragments(Vec<String>) / set_fragments(Option<Vec<String>>):

    A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments.

• On success, responds with GetMediaForFragmentListOutput with field(s):
  • content_type(Option<String>):

    The content type of the requested media.

  • payload(ByteStream):

    The payload that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see PutMedia. 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

• On failure, responds with SdkError<GetMediaForFragmentListError>

pub fn list_fragments(&self) -> ListFragments

Constructs a fluent builder for the ListFragments operation.

• The fluent builder is configurable:
  • stream_name(impl Into<String>) / set_stream_name(Option<String>):

    The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

  • stream_arn(impl Into<String>) / set_stream_arn(Option<String>):

    The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

  • max_results(i64) / set_max_results(Option<i64>):

    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(impl Into<String>) / set_next_token(Option<String>):

    A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

  • fragment_selector(FragmentSelector) / set_fragment_selector(Option<FragmentSelector>):

    Describes the timestamp range and timestamp origin for the range of fragments to return.

• On success, responds with ListFragmentsOutput with field(s):
  • fragments(Option<Vec<Fragment>>):

    A list of archived Fragment objects from the stream that meet the selector criteria. Results are in no specific order, even across pages.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListFragmentsError>

impl Client

pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Selfwhere
    C: SmithyConnector<Error = E> + Send + 'static,
    E: Into<ConnectorError>,

Creates a client with the given service config and connector override.

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.