AWS ivs documentation change
Summary
Updated token exchange documentation to include web SDK support, added code examples for web SDK, clarified real-time composition updates, and updated support matrix for participant metadata changes.
Security assessment
The changes are feature updates and documentation improvements for token exchange functionality, extending support to web SDK and clarifying behavior. No evidence of security vulnerability fixes or security incidents.
Diff
diff --git a/ivs/latest/RealTimeUserGuide/broadcast-mobile-token-exchange.md b/ivs/latest/RealTimeUserGuide/broadcast-mobile-token-exchange.md index 99868afb5..a6dec9941 100644 --- a//ivs/latest/RealTimeUserGuide/broadcast-mobile-token-exchange.md +++ b//ivs/latest/RealTimeUserGuide/broadcast-mobile-token-exchange.md @@ -11,8 +11 @@ Exchanging TokensReceiving UpdatesVisibility of Updates -Token exchange enables you to upgrade or downgrade participant-token capabilities and update token attributes within the mobile broadcast SDK, without requiring participants to reconnect. This is useful for scenarios like co-hosting, where participants may start with subscribe-only capabilities and later need publish capabilities. - -Limitations: - - * Token exchange only works with tokens created on your server using a [key pair](https://docs.aws.amazon.com//ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed). It does not work with tokens created via the [CreateParticipantToken API](https://docs.aws.amazon.com/ivs/latest/RealTimeAPIReference/API_CreateParticipantToken.html). - - * If you use token exchange to change attributes that drive server-side-composition layouts (such as featuredParticipantAttribute and participantOrderAttribute), the layout of an active composition will not update until the participant reconnects. - +Token exchange enables you to upgrade or downgrade participant-token capabilities and update token attributes within the broadcast SDK, without requiring participants to reconnect. This is useful for scenarios like co-hosting, where participants may start with subscribe-only capabilities and later need publish capabilities. @@ -19,0 +13 @@ Limitations: +Token exchange is supported in both the mobile and web broadcast SDKs. When a participant exchanges a token, server-side composition detects the updated attributes in real time and automatically adjusts the layout — for example, reassigning the featured slot, reordering participants, or moving a participant into the picture-in-picture overlay — without requiring a reconnect. @@ -20,0 +15 @@ Limitations: +Limitation: Token exchange only works with tokens created on your server using a [key pair](https://docs.aws.amazon.com//ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed). It does not work with tokens created via the [CreateParticipantToken API](https://docs.aws.amazon.com/ivs/latest/RealTimeAPIReference/API_CreateParticipantToken.html). @@ -73,0 +69,7 @@ The remaining fields can be changed, including: +### Web + + + const stage = new Stage(originalToken, strategy); + await stage.join(); + await stage.exchangeToken(newToken); + @@ -95,0 +98,8 @@ A function in `StageRenderer` / `IVSStageRenderer` receives updates about alread +### Web + + + stage.on(StageEvents.STAGE_PARTICIPANT_METADATA_CHANGED, (participantInfo: StageParticipantInfo) => { + // participantInfo properties will be updated with the changed properties + } + ); + @@ -102 +112 @@ When a participant exchanges a token to update their `userId` or `attributes`, t - * **If the participant _is_ already publishing:** The update is broadcast immediately. However, only mobile SDKs v1.37.0+ receive the notification. Participants on the web SDK, older mobile SDKs, and server-side composition do not see the change until the participant unpublishes and republishes. + * **If the participant _is_ already publishing:** The update is broadcast immediately for participants using mobile SDKs v1.37.0+, the web SDK, and server-side composition. Participants using older mobile SDKs do not see the change until the participant unpublishes and republishes. @@ -109 +119 @@ This table clarifies the matrix of support: -Participant State | Observer: Mobile SDK 1.37.0+ | Observer: Older Mobile SDKs, Web SDK, Server-Side Composition +Participant State | Observer: Mobile SDK 1.37.0+, Web SDK, Server-Side Composition | Observer: Older Mobile SDKs