diff --git a/AWSKinesisVideo/AWSKinesisVideoModel.h b/AWSKinesisVideo/AWSKinesisVideoModel.h index 3eb714e8735..c704a2f7033 100644 --- a/AWSKinesisVideo/AWSKinesisVideoModel.h +++ b/AWSKinesisVideo/AWSKinesisVideoModel.h @@ -910,7 +910,7 @@ typedef NS_ENUM(NSInteger, AWSKinesisVideoUploaderStatus) { @property (nonatomic, assign) AWSKinesisVideoImageSelectorType imageSelectorType; /** -

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 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

+

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 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

*/ @property (nonatomic, strong) NSNumber * _Nullable samplingInterval; diff --git a/AWSKinesisVideo/AWSKinesisVideoResources.m b/AWSKinesisVideo/AWSKinesisVideoResources.m index 88dd68455dc..572fcfd9f55 100644 --- a/AWSKinesisVideo/AWSKinesisVideoResources.m +++ b/AWSKinesisVideo/AWSKinesisVideoResources.m @@ -222,7 +222,7 @@ - (NSString *)definitionString { {\"shape\":\"AccessDeniedException\"},\ {\"shape\":\"ClientLimitExceededException\"}\ ],\ - \"documentation\":\"

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

\"\ + \"documentation\":\"

This API is related to WebRTC Ingestion and is only available in the us-west-2 region.

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

\"\ },\ \"DescribeNotificationConfiguration\":{\ \"name\":\"DescribeNotificationConfiguration\",\ @@ -398,7 +398,7 @@ - (NSString *)definitionString { {\"shape\":\"ResourceInUseException\"},\ {\"shape\":\"ResourceNotFoundException\"}\ ],\ - \"documentation\":\"

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

\"\ + \"documentation\":\"

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.

\"\ },\ \"TagResource\":{\ \"name\":\"TagResource\",\ @@ -520,7 +520,7 @@ - (NSString *)definitionString { {\"shape\":\"AccessDeniedException\"},\ {\"shape\":\"NoDataRetentionException\"}\ ],\ - \"documentation\":\"

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

\"\ + \"documentation\":\"

This API is related to WebRTC Ingestion and is only available in the us-west-2 region.

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

\"\ },\ \"UpdateNotificationConfiguration\":{\ \"name\":\"UpdateNotificationConfiguration\",\ @@ -1254,7 +1254,7 @@ - (NSString *)definitionString { },\ \"SamplingInterval\":{\ \"shape\":\"SamplingInterval\",\ - \"documentation\":\"

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 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

\"\ + \"documentation\":\"

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 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

\"\ },\ \"Format\":{\ \"shape\":\"Format\",\ diff --git a/AWSKinesisVideo/AWSKinesisVideoService.h b/AWSKinesisVideo/AWSKinesisVideoService.h index 08338ec1250..6478f274acd 100644 --- a/AWSKinesisVideo/AWSKinesisVideoService.h +++ b/AWSKinesisVideo/AWSKinesisVideoService.h @@ -375,7 +375,7 @@ FOUNDATION_EXPORT NSString *const AWSKinesisVideoSDKVersion; - (void)describeMappedResourceConfiguration:(AWSKinesisVideoDescribeMappedResourceConfigurationInput *)request completionHandler:(void (^ _Nullable)(AWSKinesisVideoDescribeMappedResourceConfigurationOutput * _Nullable response, NSError * _Nullable error))completionHandler; /** -

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

+

This API is related to WebRTC Ingestion and is only available in the us-west-2 region.

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

@param request A container for the necessary parameters to execute the DescribeMediaStorageConfiguration service method. @@ -387,7 +387,7 @@ FOUNDATION_EXPORT NSString *const AWSKinesisVideoSDKVersion; - (AWSTask *)describeMediaStorageConfiguration:(AWSKinesisVideoDescribeMediaStorageConfigurationInput *)request; /** -

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

+

This API is related to WebRTC Ingestion and is only available in the us-west-2 region.

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

@param request A container for the necessary parameters to execute the DescribeMediaStorageConfiguration service method. @param completionHandler The completion handler to call when the load request is complete. @@ -650,7 +650,7 @@ FOUNDATION_EXPORT NSString *const AWSKinesisVideoSDKVersion; - (void)listTagsForStream:(AWSKinesisVideoListTagsForStreamInput *)request completionHandler:(void (^ _Nullable)(AWSKinesisVideoListTagsForStreamOutput * _Nullable response, NSError * _Nullable error))completionHandler; /** -

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

+

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.

@param request A container for the necessary parameters to execute the StartEdgeConfigurationUpdate service method. @@ -662,7 +662,7 @@ FOUNDATION_EXPORT NSString *const AWSKinesisVideoSDKVersion; - (AWSTask *)startEdgeConfigurationUpdate:(AWSKinesisVideoStartEdgeConfigurationUpdateInput *)request; /** -

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

+

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.

@param request A container for the necessary parameters to execute the StartEdgeConfigurationUpdate service method. @param completionHandler The completion handler to call when the load request is complete. @@ -825,7 +825,7 @@ FOUNDATION_EXPORT NSString *const AWSKinesisVideoSDKVersion; - (void)updateImageGenerationConfiguration:(AWSKinesisVideoUpdateImageGenerationConfigurationInput *)request completionHandler:(void (^ _Nullable)(AWSKinesisVideoUpdateImageGenerationConfigurationOutput * _Nullable response, NSError * _Nullable error))completionHandler; /** -

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

+

This API is related to WebRTC Ingestion and is only available in the us-west-2 region.

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

@param request A container for the necessary parameters to execute the UpdateMediaStorageConfiguration service method. @@ -837,7 +837,7 @@ FOUNDATION_EXPORT NSString *const AWSKinesisVideoSDKVersion; - (AWSTask *)updateMediaStorageConfiguration:(AWSKinesisVideoUpdateMediaStorageConfigurationInput *)request; /** -

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :

  • If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.

  • If the StorageStatus is enabled, the data will be stored in the StreamARN provided.

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

+

This API is related to WebRTC Ingestion and is only available in the us-west-2 region.

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :

  • If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.

  • If the StorageStatus is enabled, the data will be stored in the StreamARN provided.

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

@param request A container for the necessary parameters to execute the UpdateMediaStorageConfiguration service method. @param completionHandler The completion handler to call when the load request is complete.