SignalingClient class

Initializes the AWS signaling channel for real-time communication.

This method allows users to input AWS credentials, establishes a signaling channel for communication, and retrieves necessary configurations like the channel endpoint and ICE server configuration for WebRTC.

AWS credentials include Access Key ID, Secret Access Key, and optional Session Token for temporary access to AWS services.

The signaling channel facilitates real-time communication by enabling signaling between peers, allowing them to exchange information required to establish WebRTC connections.

The method retrieves the signaling channel endpoint, which serves as the entry point for connecting to the signaling service. Additionally, it fetches ICE (Interactive Connectivity Establishment) server configurations, essential for establishing peer-to-peer WebRTC connections by providing network information like IP addresses and transport protocols.

After successful initialization, this method stores the signed headers required for establishing a WebSocket connection using the obtained signaling channel endpoint and AWS credentials.

Example usage:

_signalingClient = SignalingClient(
        channelName: YOUR_CHANNEL_NAME,
        accessKey: YOUR_ACCESS_KEY,
        secretKey: YOUR_SECRET_KEY,
        region: YOUR_REGION,
 );

Throws an AwsCredentialsException if the provided AWS credentials are invalid or authentication fails. Throws a SignalingChannelException if there's an issue establishing or retrieving the signaling channel.

Constructors

SignalingClient({required String channelName, String? clientId, required String accessKey, required String secretKey, required String region, int expires = 299})

Properties

accessKey ↔ String

AWS credentials accessKey put your AWS access key

getter/setter pair

channelName ↔ String

Signaling channel information

getter/setter pair

clientId ↔ String?

clientId is option if you not provide it automatic generate

getter/setter pair

domain ↔ String?

domain use for creating a SimpleWebSocket instance with a specified domain

getter/setter pair

expires ↔ int

expires default value is 299

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

iceServers ↔ List<Map<String, dynamic>>?

ice servers list iceServers use for create SDP offer for peer connection

getter/setter pair

region ↔ String

AWS credentials region put your region

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secretKey ↔ String

AWS credentials secretKey put your AWS secret key

getter/setter pair

signedQueryParams ↔ Map<String, dynamic>?

signedQueryParams this map constrain Signed Query Params for aws web socket connection

getter/setter pair

Methods

init() → dynamic

after Initializes the AWS signaling channel for real-time communication. call init method of this Signaling Client for get signedQueryParams Example usage:

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited