Classes Reference


                    
                    
                    AWSKinesisVideoChannelInfo

A structure that encapsulates a signaling channel’s metadata and properties.

Declaration

Objective-C

@interface AWSKinesisVideoChannelInfo

Swift

class AWSKinesisVideoChannelInfo


                    
                    
                    AWSKinesisVideoChannelNameCondition

An optional input parameter for the ListSignalingChannels API. When this parameter is specified while invoking ListSignalingChannels, the API returns only the channels that satisfy a condition specified in ChannelNameCondition.

Declaration

Objective-C

@interface AWSKinesisVideoChannelNameCondition

Swift

class AWSKinesisVideoChannelNameCondition


                    
                    
                    AWSKinesisVideoCreateSignalingChannelInput

Declaration

Objective-C

@interface AWSKinesisVideoCreateSignalingChannelInput

Swift

class AWSKinesisVideoCreateSignalingChannelInput


                    
                    
                    AWSKinesisVideoCreateSignalingChannelOutput

Declaration

Objective-C

@interface AWSKinesisVideoCreateSignalingChannelOutput

Swift

class AWSKinesisVideoCreateSignalingChannelOutput


                    
                    
                    AWSKinesisVideoCreateStreamInput

Declaration

Objective-C

@interface AWSKinesisVideoCreateStreamInput

Swift

class AWSKinesisVideoCreateStreamInput


                    
                    
                    AWSKinesisVideoCreateStreamOutput

Declaration

Objective-C

@interface AWSKinesisVideoCreateStreamOutput

Swift

class AWSKinesisVideoCreateStreamOutput


                    
                    
                    AWSKinesisVideoDeleteEdgeConfigurationInput

Declaration

Objective-C

@interface AWSKinesisVideoDeleteEdgeConfigurationInput

Swift

class AWSKinesisVideoDeleteEdgeConfigurationInput


                    
                    
                    AWSKinesisVideoDeleteEdgeConfigurationOutput

Declaration

Objective-C

@interface AWSKinesisVideoDeleteEdgeConfigurationOutput

Swift

class AWSKinesisVideoDeleteEdgeConfigurationOutput


                    
                    
                    AWSKinesisVideoDeleteSignalingChannelInput

Declaration

Objective-C

@interface AWSKinesisVideoDeleteSignalingChannelInput

Swift

class AWSKinesisVideoDeleteSignalingChannelInput


                    
                    
                    AWSKinesisVideoDeleteSignalingChannelOutput

Declaration

Objective-C

@interface AWSKinesisVideoDeleteSignalingChannelOutput

Swift

class AWSKinesisVideoDeleteSignalingChannelOutput


                    
                    
                    AWSKinesisVideoDeleteStreamInput

Declaration

Objective-C

@interface AWSKinesisVideoDeleteStreamInput

Swift

class AWSKinesisVideoDeleteStreamInput


                    
                    
                    AWSKinesisVideoDeleteStreamOutput

Declaration

Objective-C

@interface AWSKinesisVideoDeleteStreamOutput

Swift

class AWSKinesisVideoDeleteStreamOutput


                    
                    
                    AWSKinesisVideoDeletionConfig

The configuration details required to delete the connection of the stream from the Edge Agent.

Declaration

Objective-C

@interface AWSKinesisVideoDeletionConfig

Swift

class AWSKinesisVideoDeletionConfig


                    
                    
                    AWSKinesisVideoDescribeEdgeConfigurationInput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeEdgeConfigurationInput

Swift

class AWSKinesisVideoDescribeEdgeConfigurationInput


                    
                    
                    AWSKinesisVideoDescribeEdgeConfigurationOutput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeEdgeConfigurationOutput

Swift

class AWSKinesisVideoDescribeEdgeConfigurationOutput


                    
                    
                    AWSKinesisVideoDescribeImageGenerationConfigurationInput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeImageGenerationConfigurationInput

Swift

class AWSKinesisVideoDescribeImageGenerationConfigurationInput


                    
                    
                    AWSKinesisVideoDescribeImageGenerationConfigurationOutput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeImageGenerationConfigurationOutput

Swift

class AWSKinesisVideoDescribeImageGenerationConfigurationOutput


                    
                    
                    AWSKinesisVideoDescribeMappedResourceConfigurationInput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeMappedResourceConfigurationInput

Swift

class AWSKinesisVideoDescribeMappedResourceConfigurationInput


                    
                    
                    AWSKinesisVideoDescribeMappedResourceConfigurationOutput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeMappedResourceConfigurationOutput

Swift

class AWSKinesisVideoDescribeMappedResourceConfigurationOutput


                    
                    
                    AWSKinesisVideoDescribeMediaStorageConfigurationInput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeMediaStorageConfigurationInput

Swift

class AWSKinesisVideoDescribeMediaStorageConfigurationInput


                    
                    
                    AWSKinesisVideoDescribeMediaStorageConfigurationOutput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeMediaStorageConfigurationOutput

Swift

class AWSKinesisVideoDescribeMediaStorageConfigurationOutput


                    
                    
                    AWSKinesisVideoDescribeNotificationConfigurationInput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeNotificationConfigurationInput

Swift

class AWSKinesisVideoDescribeNotificationConfigurationInput


                    
                    
                    AWSKinesisVideoDescribeNotificationConfigurationOutput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeNotificationConfigurationOutput

Swift

class AWSKinesisVideoDescribeNotificationConfigurationOutput


                    
                    
                    AWSKinesisVideoDescribeSignalingChannelInput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeSignalingChannelInput

Swift

class AWSKinesisVideoDescribeSignalingChannelInput


                    
                    
                    AWSKinesisVideoDescribeSignalingChannelOutput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeSignalingChannelOutput

Swift

class AWSKinesisVideoDescribeSignalingChannelOutput


                    
                    
                    AWSKinesisVideoDescribeStreamInput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeStreamInput

Swift

class AWSKinesisVideoDescribeStreamInput


                    
                    
                    AWSKinesisVideoDescribeStreamOutput

Declaration

Objective-C

@interface AWSKinesisVideoDescribeStreamOutput

Swift

class AWSKinesisVideoDescribeStreamOutput


                    
                    
                    AWSKinesisVideoEdgeAgentStatus

An object that contains the latest status details for an edge agent’s recorder and uploader jobs. Use this information to determine the current health of an edge agent.

Declaration

Objective-C

@interface AWSKinesisVideoEdgeAgentStatus

Swift

class AWSKinesisVideoEdgeAgentStatus


                    
                    
                    AWSKinesisVideoEdgeConfig

A description of the stream’s edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

Required parameters: [HubDeviceArn, RecorderConfig]

Declaration

Objective-C

@interface AWSKinesisVideoEdgeConfig

Swift

class AWSKinesisVideoEdgeConfig


                    
                    
                    AWSKinesisVideoGetDataEndpointInput

Declaration

Objective-C

@interface AWSKinesisVideoGetDataEndpointInput

Swift

class AWSKinesisVideoGetDataEndpointInput


                    
                    
                    AWSKinesisVideoGetDataEndpointOutput

Declaration

Objective-C

@interface AWSKinesisVideoGetDataEndpointOutput

Swift

class AWSKinesisVideoGetDataEndpointOutput


                    
                    
                    AWSKinesisVideoGetSignalingChannelEndpointInput

Declaration

Objective-C

@interface AWSKinesisVideoGetSignalingChannelEndpointInput

Swift

class AWSKinesisVideoGetSignalingChannelEndpointInput


                    
                    
                    AWSKinesisVideoGetSignalingChannelEndpointOutput

Declaration

Objective-C

@interface AWSKinesisVideoGetSignalingChannelEndpointOutput

Swift

class AWSKinesisVideoGetSignalingChannelEndpointOutput


                    
                    
                    AWSKinesisVideoImageGenerationConfiguration

The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream.

Required parameters: [Status, ImageSelectorType, DestinationConfig, SamplingInterval, Format]

Declaration

Objective-C

@interface AWSKinesisVideoImageGenerationConfiguration

Swift

class AWSKinesisVideoImageGenerationConfiguration


                    
                    
                    AWSKinesisVideoImageGenerationDestinationConfig

The structure that contains the information required to deliver images to a customer.

Required parameters: [Uri, DestinationRegion]

Declaration

Objective-C

@interface AWSKinesisVideoImageGenerationDestinationConfig

Swift

class AWSKinesisVideoImageGenerationDestinationConfig


                    
                    
                    AWSKinesisVideoLastRecorderStatus

The latest status of a stream’s edge recording job.

Declaration

Objective-C

@interface AWSKinesisVideoLastRecorderStatus

Swift

class AWSKinesisVideoLastRecorderStatus


                    
                    
                    AWSKinesisVideoLastUploaderStatus

The latest status of a stream’s edge to cloud uploader job.

Declaration

Objective-C

@interface AWSKinesisVideoLastUploaderStatus

Swift

class AWSKinesisVideoLastUploaderStatus


                    
                    
                    AWSKinesisVideoListEdgeAgentConfigurationsEdgeConfig

A description of a single stream’s edge configuration.

Declaration

Objective-C

@interface AWSKinesisVideoListEdgeAgentConfigurationsEdgeConfig

Swift

class AWSKinesisVideoListEdgeAgentConfigurationsEdgeConfig


                    
                    
                    AWSKinesisVideoListEdgeAgentConfigurationsInput

Declaration

Objective-C

@interface AWSKinesisVideoListEdgeAgentConfigurationsInput

Swift

class AWSKinesisVideoListEdgeAgentConfigurationsInput


                    
                    
                    AWSKinesisVideoListEdgeAgentConfigurationsOutput

Declaration

Objective-C

@interface AWSKinesisVideoListEdgeAgentConfigurationsOutput

Swift

class AWSKinesisVideoListEdgeAgentConfigurationsOutput


                    
                    
                    AWSKinesisVideoListSignalingChannelsInput

Declaration

Objective-C

@interface AWSKinesisVideoListSignalingChannelsInput

Swift

class AWSKinesisVideoListSignalingChannelsInput


                    
                    
                    AWSKinesisVideoListSignalingChannelsOutput

Declaration

Objective-C

@interface AWSKinesisVideoListSignalingChannelsOutput

Swift

class AWSKinesisVideoListSignalingChannelsOutput


                    
                    
                    AWSKinesisVideoListStreamsInput

Declaration

Objective-C

@interface AWSKinesisVideoListStreamsInput

Swift

class AWSKinesisVideoListStreamsInput


                    
                    
                    AWSKinesisVideoListStreamsOutput

Declaration

Objective-C

@interface AWSKinesisVideoListStreamsOutput

Swift

class AWSKinesisVideoListStreamsOutput


                    
                    
                    AWSKinesisVideoListTagsForResourceInput

Declaration

Objective-C

@interface AWSKinesisVideoListTagsForResourceInput

Swift

class AWSKinesisVideoListTagsForResourceInput


                    
                    
                    AWSKinesisVideoListTagsForResourceOutput

Declaration

Objective-C

@interface AWSKinesisVideoListTagsForResourceOutput

Swift

class AWSKinesisVideoListTagsForResourceOutput


                    
                    
                    AWSKinesisVideoListTagsForStreamInput

Declaration

Objective-C

@interface AWSKinesisVideoListTagsForStreamInput

Swift

class AWSKinesisVideoListTagsForStreamInput


                    
                    
                    AWSKinesisVideoListTagsForStreamOutput

Declaration

Objective-C

@interface AWSKinesisVideoListTagsForStreamOutput

Swift

class AWSKinesisVideoListTagsForStreamOutput


                    
                    
                    AWSKinesisVideoLocalSizeConfig

The configuration details that include the maximum size of the media (MaxLocalMediaSizeInMB) that you want to store for a stream on the Edge Agent, as well as the strategy that should be used (StrategyOnFullSize) when a stream’s maximum size has been reached.

Declaration

Objective-C

@interface AWSKinesisVideoLocalSizeConfig

Swift

class AWSKinesisVideoLocalSizeConfig


                    
                    
                    AWSKinesisVideoMappedResourceConfigurationListItem

A structure that encapsulates, or contains, the media storage configuration properties.

Declaration

Objective-C

@interface AWSKinesisVideoMappedResourceConfigurationListItem

Swift

class AWSKinesisVideoMappedResourceConfigurationListItem


                    
                    
                    AWSKinesisVideoMediaSourceConfig

The configuration details that consist of the credentials required (MediaUriSecretArn and MediaUriType) to access the media files that are streamed to the camera.

Required parameters: [MediaUriSecretArn, MediaUriType]

Declaration

Objective-C

@interface AWSKinesisVideoMediaSourceConfig

Swift

class AWSKinesisVideoMediaSourceConfig


                    
                    
                    AWSKinesisVideoMediaStorageConfiguration

A structure that encapsulates, or contains, the media storage configuration properties.

If StorageStatus is enabled, the data will be stored in the StreamARN provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled.
If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.

Required parameters: [Status]

Declaration

Objective-C

@interface AWSKinesisVideoMediaStorageConfiguration

Swift

class AWSKinesisVideoMediaStorageConfiguration


                    
                    
                    AWSKinesisVideoNotificationConfiguration

The structure that contains the notification information for the KVS images delivery. If this parameter is null, the configuration will be deleted from the stream.

Required parameters: [Status, DestinationConfig]

Declaration

Objective-C

@interface AWSKinesisVideoNotificationConfiguration

Swift

class AWSKinesisVideoNotificationConfiguration


                    
                    
                    AWSKinesisVideoNotificationDestinationConfig

The structure that contains the information required to deliver a notification to a customer.

Required parameters: [Uri]

Declaration

Objective-C

@interface AWSKinesisVideoNotificationDestinationConfig

Swift

class AWSKinesisVideoNotificationDestinationConfig


                    
                    
                    AWSKinesisVideoRecorderConfig

The recorder configuration consists of the local MediaSourceConfig details that are used as credentials to accesss the local media files streamed on the camera.

Required parameters: [MediaSourceConfig]

Declaration

Objective-C

@interface AWSKinesisVideoRecorderConfig

Swift

class AWSKinesisVideoRecorderConfig


                    
                    
                    AWSKinesisVideoResourceEndpointListItem

An object that describes the endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.

The media server endpoint will correspond to the WEBRTC Protocol.

Declaration

Objective-C

@interface AWSKinesisVideoResourceEndpointListItem

Swift

class AWSKinesisVideoResourceEndpointListItem


                    
                    
                    AWSKinesisVideoScheduleConfig

This API enables you to specify the duration that the camera, or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the ScheduleExpression and the DurationInMinutes attributes.

If the ScheduleConfig is not provided in the RecorderConfig, then the Edge Agent will always be set to recording mode.

If the ScheduleConfig is not provided in the UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).

Required parameters: [ScheduleExpression, DurationInSeconds]

Declaration

Objective-C

@interface AWSKinesisVideoScheduleConfig

Swift

class AWSKinesisVideoScheduleConfig


                    
                    
                    AWSKinesisVideoSingleMasterChannelEndpointConfiguration

An object that contains the endpoint configuration for the SINGLE_MASTER channel type.

Declaration

Objective-C

@interface AWSKinesisVideoSingleMasterChannelEndpointConfiguration

Swift

class AWSKinesisVideoSingleMasterChannelEndpointConfiguration


                    
                    
                    AWSKinesisVideoSingleMasterConfiguration

A structure that contains the configuration for the SINGLE_MASTER channel type.

Declaration

Objective-C

@interface AWSKinesisVideoSingleMasterConfiguration

Swift

class AWSKinesisVideoSingleMasterConfiguration


                    
                    
                    AWSKinesisVideoStartEdgeConfigurationUpdateInput

Declaration

Objective-C

@interface AWSKinesisVideoStartEdgeConfigurationUpdateInput

Swift

class AWSKinesisVideoStartEdgeConfigurationUpdateInput


                    
                    
                    AWSKinesisVideoStartEdgeConfigurationUpdateOutput

Declaration

Objective-C

@interface AWSKinesisVideoStartEdgeConfigurationUpdateOutput

Swift

class AWSKinesisVideoStartEdgeConfigurationUpdateOutput


                    
                    
                    AWSKinesisVideoStreamInfo

An object describing a Kinesis video stream.

Declaration

Objective-C

@interface AWSKinesisVideoStreamInfo

Swift

class AWSKinesisVideoStreamInfo


                    
                    
                    AWSKinesisVideoStreamNameCondition

Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

Declaration

Objective-C

@interface AWSKinesisVideoStreamNameCondition

Swift

class AWSKinesisVideoStreamNameCondition


                    
                    
                    AWSKinesisVideoTag

A key and value pair that is associated with the specified signaling channel.

Required parameters: [Key, Value]

Declaration

Objective-C

@interface AWSKinesisVideoTag

Swift

class AWSKinesisVideoTag


                    
                    
                    AWSKinesisVideoTagResourceInput

Declaration

Objective-C

@interface AWSKinesisVideoTagResourceInput

Swift

class AWSKinesisVideoTagResourceInput


                    
                    
                    AWSKinesisVideoTagResourceOutput

Declaration

Objective-C

@interface AWSKinesisVideoTagResourceOutput

Swift

class AWSKinesisVideoTagResourceOutput


                    
                    
                    AWSKinesisVideoTagStreamInput

Declaration

Objective-C

@interface AWSKinesisVideoTagStreamInput

Swift

class AWSKinesisVideoTagStreamInput


                    
                    
                    AWSKinesisVideoTagStreamOutput

Declaration

Objective-C

@interface AWSKinesisVideoTagStreamOutput

Swift

class AWSKinesisVideoTagStreamOutput


                    
                    
                    AWSKinesisVideoUntagResourceInput

Declaration

Objective-C

@interface AWSKinesisVideoUntagResourceInput

Swift

class AWSKinesisVideoUntagResourceInput


                    
                    
                    AWSKinesisVideoUntagResourceOutput

Declaration

Objective-C

@interface AWSKinesisVideoUntagResourceOutput

Swift

class AWSKinesisVideoUntagResourceOutput


                    
                    
                    AWSKinesisVideoUntagStreamInput

Declaration

Objective-C

@interface AWSKinesisVideoUntagStreamInput

Swift

class AWSKinesisVideoUntagStreamInput


                    
                    
                    AWSKinesisVideoUntagStreamOutput

Declaration

Objective-C

@interface AWSKinesisVideoUntagStreamOutput

Swift

class AWSKinesisVideoUntagStreamOutput


                    
                    
                    AWSKinesisVideoUpdateDataRetentionInput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateDataRetentionInput

Swift

class AWSKinesisVideoUpdateDataRetentionInput


                    
                    
                    AWSKinesisVideoUpdateDataRetentionOutput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateDataRetentionOutput

Swift

class AWSKinesisVideoUpdateDataRetentionOutput


                    
                    
                    AWSKinesisVideoUpdateImageGenerationConfigurationInput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateImageGenerationConfigurationInput

Swift

class AWSKinesisVideoUpdateImageGenerationConfigurationInput


                    
                    
                    AWSKinesisVideoUpdateImageGenerationConfigurationOutput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateImageGenerationConfigurationOutput

Swift

class AWSKinesisVideoUpdateImageGenerationConfigurationOutput


                    
                    
                    AWSKinesisVideoUpdateMediaStorageConfigurationInput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateMediaStorageConfigurationInput

Swift

class AWSKinesisVideoUpdateMediaStorageConfigurationInput


                    
                    
                    AWSKinesisVideoUpdateMediaStorageConfigurationOutput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateMediaStorageConfigurationOutput

Swift

class AWSKinesisVideoUpdateMediaStorageConfigurationOutput


                    
                    
                    AWSKinesisVideoUpdateNotificationConfigurationInput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateNotificationConfigurationInput

Swift

class AWSKinesisVideoUpdateNotificationConfigurationInput


                    
                    
                    AWSKinesisVideoUpdateNotificationConfigurationOutput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateNotificationConfigurationOutput

Swift

class AWSKinesisVideoUpdateNotificationConfigurationOutput


                    
                    
                    AWSKinesisVideoUpdateSignalingChannelInput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateSignalingChannelInput

Swift

class AWSKinesisVideoUpdateSignalingChannelInput


                    
                    
                    AWSKinesisVideoUpdateSignalingChannelOutput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateSignalingChannelOutput

Swift

class AWSKinesisVideoUpdateSignalingChannelOutput


                    
                    
                    AWSKinesisVideoUpdateStreamInput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateStreamInput

Swift

class AWSKinesisVideoUpdateStreamInput


                    
                    
                    AWSKinesisVideoUpdateStreamOutput

Declaration

Objective-C

@interface AWSKinesisVideoUpdateStreamOutput

Swift

class AWSKinesisVideoUpdateStreamOutput


                    
                    
                    AWSKinesisVideoUploaderConfig

The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleConfig is not provided in the UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).

Required parameters: [ScheduleConfig]

Declaration

Objective-C

@interface AWSKinesisVideoUploaderConfig

Swift

class AWSKinesisVideoUploaderConfig


                    
                    
                    AWSKinesisVideoResources

Undocumented

Declaration

Objective-C

@interface AWSKinesisVideoResources : NSObject

+ (instancetype)sharedInstance;

- (NSDictionary *)JSONObject;

@end

Swift

class AWSKinesisVideoResources : NSObject


                    
                    
                    AWSKinesisVideo

Declaration

Objective-C

@interface AWSKinesisVideo

Swift

class AWSKinesisVideo