Skip to content

awslabs/amazon-kinesis-video-streams-signaling

amazon-kinesis-video-streams-signaling

The goal of the Signaling library is to enable communication with the Amazon Kinesis Video Signaling Service. Refer to AWS KVS API Reference and WebRTC Websocket APIs for more details.

What is Signaling?

The Amazon Kinesis Video Signaling Service facilitates peer-to-peer communication by providing signaling channels that enable applications to discover, establish, control, and terminate connections through the exchange of signaling messages. This library provides APIs to construct requests to send to the Signaling Service and to parse responses from the Signaling Service.

  • Note that this library has a dependency on coreJSON.

Using the library

  1. Use the Signaling_Construct* APIs to construct requests to send to the Signaling Service.
    • Ensure to authenticate and sign the constructed requests using the Signature Version 4 (SigV4) authentication flow before sending them.
  2. Use the Signaling_Parse* APIs to parse the responses from the Signaling Service.
  3. Use Signaling_ConstructWssMessage and Signaling_ParseWssRecvMessage APIs to communicate with the WSS endpoint.
    • Ensure to authenticate and sign the constructed messages using the Signature Version 4 (SigV4) authentication flow before sending them.

License

This project is licensed under the Apache-2.0 License.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published