API Summary

The API for the Web Broadcast SDK is broken into Low-Latency and Real-Time APIs. There are some shared abstractions between the two but they are largely distinct. Review the Low-Latency SDK Guide or Real-Time SDK Guide for in-depth usage samples and documentation around features supported by the SDK.

The following list contains most of the crucial APIs used for either product.

Real-Time

• Stage
  • Used to create a Real-Time Stage
• LocalStageStream
  • Used to configure local media to publish to the Stage
• StageStrategy
  • Interface to control the features of a Stage and how it should behave
• StageEvents
  • Events to handle when a Stage changes
• StageError
  • Errors to handle when an issue occurs
• StageParticipantInfo
  • Interface representing a participant in a Stage
• RemoteStageStream
  • Remote Stream of a participant in a Stage that plays media

Low-Latency

• IVSBroadcastClient.create
  • Used to create a Low-Latency Broadcast
• BroadcastClientConfig
  • Configuration to provide to the create factory
• StreamConfig
  • Used to configure the constraints of the Broadcast
  • Presets are also provided for easy configuration:
    • BASIC_LANDSCAPE
    • BASIC_PORTRAIT
    • BASIC_FULL_HD_LANDSCAPE
    • BASIC_FULL_HD_PORTRAIT
    • STANDARD_LANDSCAPE
    • STANDARD_PORTRAIT
• AmazonIVSBroadcastClient
  • Broadcast client instance returned from the creation process
• BroadcastClientEvents
  • Events to handle when a Broadcast changes
• Errors
  • Errors to handle when an issue occurs