CompanyOnwership_icon
OutSystems
Created on 06 January 2022
icon_unfollowing
Login to follow
amazon-kinesis-video-streams-connector

Amazon Kinesis Video Streams Connector

Supported
Stable version 2.0.0 (Compatible with OutSystems 11)
Uploaded on 03 June 2022 by 
OutSystems
amazon-kinesis-video-streams-connector

Amazon Kinesis Video Streams Connector

Documentation
2.0.0

The Amazon Kinesis Video Streams Connector enables you to integrate with Amazon Kinesis Video Streams to stream live video from devices to peers.

The actions in this connector provide you the following capabilities for video streaming:

Besides offering integration with the API methods described above, the Amazon Kinesis Video Streams Connector also provides the following utility methods:

  • SignWssEndpointUrl: Provides a URL presigned with a SigV4 signature to be used by the client device WebSocket connection without the need to expose credentials.

  • StartCall: A helper method that abstracts the logic for starting video calls with the Amazon Kinesis Video Streams Connector. Creates the signaling channel, fetches the channel endpoints, and gets the ICE Server configurations.

When establishing WebRTC connections, you can select the connectivity protocol to be used:

This component is based on the AWS SDK for .NET v3.

Requirements

To use the Kinesis Video Streams connector you must have:

Depending on the connector actions you want to consume, additional permissions must be set. Refer to this guide to check how to set up policies for consuming Kinesis Video Streams methods. Also, check this list of available actions in the service API.

See the AWS documentation for detailed information on Amazon Kinesis Video Streams.

Setup and authentication

To configure your connector to access Amazon Kinesis Video Streams, you need the following AWS authentication information:

  • The access key ID of your AWS access key

  • The secret access key of your AWS access key

  • The AWS Region of the service endpoint to which you want to connect. To reduce latency, choose a region close to your application server. See the API documentation for the list of region names.

Use the above authentication information to fill in the AWSCredentials parameters in all of the public actions available in the AmazonKinesisVS_IS module. The OutSystems parameters are:

  • Region

  • AccessKeyId

  • SecretAccessKey



1.0.1

The Amazon Kinesis Video Streams Connector enables you to integrate with Amazon Kinesis Video Streams to stream live video from devices to peers.

The actions in this connector provide you the following capabilities for video streaming:

Besides offering integration with the API methods described above, the Amazon Kinesis Video Streams Connector also provides the following utility methods:

  • SignWssEndpointUrl: Provides a URL presigned with a SigV4 signature to be used by the client device WebSocket connection without the need to expose credentials.

  • StartCall: A helper method that abstracts the logic for starting video calls with the Amazon Kinesis Video Streams Connector. Creates the signaling channel, fetches the channel endpoints, and gets the ICE Server configurations.

When establishing WebRTC connections, you can select the connectivity protocol to be used:

This component is based on the AWS SDK for .NET v3.

Requirements

To use the Kinesis Video Streams connector you must have:

Depending on the connector actions you want to consume, additional permissions must be set. Refer to this guide to check how to set up policies for consuming Kinesis Video Streams methods. Also, check this list of available actions in the service API.

See the AWS documentation for detailed information on Amazon Kinesis Video Streams.

Authentication

To configure your connector to access Amazon Kinesis Video Streams, you need the following AWS authentication information:

  • AWS access key ID

  • Secret access key of your AWS access key

  • AWS Region of the service endpoint to which you want to connect. To reduce latency, choose a region close to your application server. See the API documentation for a list of region names.

Use the above information to fill in the following site properties available in the AmazonKinesisVideoStreams_IS module:

  • Access Key

  • Secret Access Key

  • Region (default value is "USEast1")

The connector uses the values in these site properties as the default AWS credentials for Amazon Kinesis Video Streams authentication.

Alternatively, you can specify different credentials when invoking an action from the connector in your logic by using the AWSCredentials input parameter:


Each time you run an action from the connector, the authentication in Amazon Kinesis Video Streams is performed as follows:

  • If the AWSCredentials input parameter is passed (the parameter isn’t mandatory), these values are used for authentication.

  • Otherwise, the authentication uses the values in the Access Key, Secret Access Key, and Region site properties.

  • If the values in the site properties are not set, an exception is raised: “Invalid configuration. Please validate the values."

With this design, you have the flexibility to define a set of AWS credentials for specific actions, while using the ones configured in the site properties as default credentials for the remaining actions.


Support options
OutSystems supported
Customers entitled to support services may obtain assistance through support.
Dependencies
Amazon Kinesis Video Streams Connector has no dependencies.