AWSKinesisVideoArchivedMedia Class Reference

Inherits from AWSService : NSObject
Declared in AWSKinesisVideoArchivedMediaService.h
AWSKinesisVideoArchivedMediaService.m

Overview

  configuration

The service configuration used to instantiate this service client.

@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

Discussion

Warning: Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSKinesisVideoArchivedMediaService.h

+ defaultKinesisVideoArchivedMedia

Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

+ (instancetype)defaultKinesisVideoArchivedMedia

Return Value

The default service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
    AWSServiceManager.default().defaultServiceConfiguration = configuration

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                      identityPoolId:@"YourIdentityPoolId"];
      AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                           credentialsProvider:credentialsProvider];
      [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

      return YES;
  }

Then call the following to get the default service client:

Swift

 let KinesisVideoArchivedMedia = AWSKinesisVideoArchivedMedia.default()

Objective-C

 AWSKinesisVideoArchivedMedia *KinesisVideoArchivedMedia = [AWSKinesisVideoArchivedMedia defaultKinesisVideoArchivedMedia];

Declared In

AWSKinesisVideoArchivedMediaService.h

+ registerKinesisVideoArchivedMediaWithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

+ (void)registerKinesisVideoArchivedMediaWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSKinesisVideoArchivedMedia.register(with: configuration!, forKey: "USWest2KinesisVideoArchivedMedia")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSKinesisVideoArchivedMedia registerKinesisVideoArchivedMediaWithConfiguration:configuration forKey:@"USWest2KinesisVideoArchivedMedia"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let KinesisVideoArchivedMedia = AWSKinesisVideoArchivedMedia(forKey: "USWest2KinesisVideoArchivedMedia")

Objective-C

 AWSKinesisVideoArchivedMedia *KinesisVideoArchivedMedia = [AWSKinesisVideoArchivedMedia KinesisVideoArchivedMediaForKey:@"USWest2KinesisVideoArchivedMedia"];

Warning: After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSKinesisVideoArchivedMediaService.h

+ KinesisVideoArchivedMediaForKey:

Retrieves the service client associated with the key. You need to call + registerKinesisVideoArchivedMediaWithConfiguration:forKey: before invoking this method.

+ (instancetype)KinesisVideoArchivedMediaForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSKinesisVideoArchivedMedia.register(with: configuration!, forKey: "USWest2KinesisVideoArchivedMedia")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSKinesisVideoArchivedMedia registerKinesisVideoArchivedMediaWithConfiguration:configuration forKey:@"USWest2KinesisVideoArchivedMedia"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let KinesisVideoArchivedMedia = AWSKinesisVideoArchivedMedia(forKey: "USWest2KinesisVideoArchivedMedia")

Objective-C

 AWSKinesisVideoArchivedMedia *KinesisVideoArchivedMedia = [AWSKinesisVideoArchivedMedia KinesisVideoArchivedMediaForKey:@"USWest2KinesisVideoArchivedMedia"];

Declared In

AWSKinesisVideoArchivedMediaService.h

+ removeKinesisVideoArchivedMediaForKey:

Removes the service client associated with the key and release it.

+ (void)removeKinesisVideoArchivedMediaForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

Warning: Before calling this method, make sure no method is running on this client.

Declared In

AWSKinesisVideoArchivedMediaService.h

– getHLSStreamingSessionURL:

Retrieves an HTTP Live Streaming (HLS) URL for the stream. The URL can then be opened in a browser or media player to view the stream contents.

You must specify either the StreamName or the StreamARN.

An Amazon Kinesis video stream has the following requirements for providing data through HLS:

  • The media type must be video/h264.

  • Data retention must be greater than 0.

  • The fragments must contain codec private data in the AVC (Advanced Video Coding) for H.264 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags.

Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF), rather than the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification.

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

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

  2. 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 bit rates) is made available.

  3. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video decoder and renderer. The media fragments contain H.264-encoded video frames and time stamps.

  4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

    • GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action, and additional metadata for the media player, including estimated bit rate and resolution.

    • GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 intitialization 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.

    • 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, which the media player needs to decode video frames.

    • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's video frames and their time stamps.

      After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data are excluded in the HLS media playlist. Therefore, the codec private data does not change between fragments in a session.

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

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.

- (AWSTask<AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLOutput*> *)getHLSStreamingSessionURL:(AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLInput *)request

Parameters

request

A container for the necessary parameters to execute the GetHLSStreamingSessionURL service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorUnsupportedStreamMediaType, AWSKinesisVideoArchivedMediaErrorNoDataRetention, AWSKinesisVideoArchivedMediaErrorMissingCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidCodecPrivateData.

Declared In

AWSKinesisVideoArchivedMediaService.h

– getHLSStreamingSessionURL:completionHandler:

Retrieves an HTTP Live Streaming (HLS) URL for the stream. The URL can then be opened in a browser or media player to view the stream contents.

You must specify either the StreamName or the StreamARN.

An Amazon Kinesis video stream has the following requirements for providing data through HLS:

  • The media type must be video/h264.

  • Data retention must be greater than 0.

  • The fragments must contain codec private data in the AVC (Advanced Video Coding) for H.264 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags.

Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF), rather than the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification.

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

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

  2. 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 bit rates) is made available.

  3. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video decoder and renderer. The media fragments contain H.264-encoded video frames and time stamps.

  4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

    • GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action, and additional metadata for the media player, including estimated bit rate and resolution.

    • GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 intitialization 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.

    • 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, which the media player needs to decode video frames.

    • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's video frames and their time stamps.

      After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data are excluded in the HLS media playlist. Therefore, the codec private data does not change between fragments in a session.

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

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.

- (void)getHLSStreamingSessionURL:(AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetHLSStreamingSessionURL service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorUnsupportedStreamMediaType, AWSKinesisVideoArchivedMediaErrorNoDataRetention, AWSKinesisVideoArchivedMediaErrorMissingCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidCodecPrivateData.

Declared In

AWSKinesisVideoArchivedMediaService.h

– getMediaForFragmentList:

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

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.

- (AWSTask<AWSKinesisVideoArchivedMediaGetMediaForFragmentListOutput*> *)getMediaForFragmentList:(AWSKinesisVideoArchivedMediaGetMediaForFragmentListInput *)request

Parameters

request

A container for the necessary parameters to execute the GetMediaForFragmentList service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoArchivedMediaGetMediaForFragmentListOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized.

Declared In

AWSKinesisVideoArchivedMediaService.h

– getMediaForFragmentList:completionHandler:

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

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.

- (void)getMediaForFragmentList:(AWSKinesisVideoArchivedMediaGetMediaForFragmentListInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSKinesisVideoArchivedMediaGetMediaForFragmentListOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetMediaForFragmentList service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized.

Declared In

AWSKinesisVideoArchivedMediaService.h

– listFragments:

Returns a list of Fragment objects from the specified stream and start location within the archived data.

- (AWSTask<AWSKinesisVideoArchivedMediaListFragmentsOutput*> *)listFragments:(AWSKinesisVideoArchivedMediaListFragmentsInput *)request

Parameters

request

A container for the necessary parameters to execute the ListFragments service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoArchivedMediaListFragmentsOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized.

Declared In

AWSKinesisVideoArchivedMediaService.h

– listFragments:completionHandler:

Returns a list of Fragment objects from the specified stream and start location within the archived data.

- (void)listFragments:(AWSKinesisVideoArchivedMediaListFragmentsInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSKinesisVideoArchivedMediaListFragmentsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListFragments service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized.

Declared In

AWSKinesisVideoArchivedMediaService.h