IVS Document History | Real-Time Streaming - Amazon IVS
Real-Time Streaming User Guide ChangesIVS Real-Time Streaming API Reference Changes

IVS Document History | Real-Time Streaming

The following tables describe the important changes to the documentation for Amazon IVS Real-Time Streaming. We update the documentation frequently, for new releases and to address the feedback that you send us.

Real-Time Streaming User Guide Changes

ChangeDescriptionDate

Broadcast SDK: Android 1.25.0, iOS 1.25.0

Updated version number and artifact links in the real-time-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

In each guide, we also:

  • Added "Get Supplemental Enhancement Information."

  • Added "Layered Encoding with Simulcast."

  • Added three simulcast items in "Renderer."

  • Deleted "Enable/Disable Layered Encoding with Simulcast."

December 12, 2024

Streaming Optimizations

Renamed "Configuring Layered Encoding with Simulcast" to "Configuring Layered Encoding with Simulcast (Publisher)" and added "Configuring Layered Encoding with Simulcast (Subscriber)."

December 12, 2024

Broadcast SDK: Web 1.19.0

Updated version number and artifact links in the low-latency-streaming broadcast SDK guide: Web. Also see the Release Notes.

We also added "Layered Encoding with Simulcast" and added three simulcast items in "Events."

December 12, 2024

Real-time thumbnail configuration

In Individual Participant Recording and Composite Recording, updated examples and JSON metadata information, and added pricing information. In Individual Participant Recording, added "Thumbnail-Only Recordings."

December 10, 2024

Broadcast SDK: Android 1.24.0, iOS 1.24.0

Updated version number and artifact links in the real-time-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

November 13, 2024

Third-Party Camera Filters

Many changes in Using Snap with the IVS Broadcast SDK > Web.

November 12, 2024

Broadcast SDK: Web 1.18.0

Updated version number and artifact links in the low-latency-streaming broadcast SDK guide: Web. Also see the Release Notes.

We added a new section, Get Supplemental Enhancement Information (SEI), to the SDK Guide.

November 12, 2024

RTMP

In "Create an Ingest Configuration," updated example (added --ingest-protocol).

November 7, 2024

Broadcast SDK: Web 1.17.0

Updated version number and artifact links on the IVS documentation landing page and in the low-latency-streaming broadcast SDK guide: Web. Also see the Release Notes.

October 10, 2024

Broadcast SDK: Android 1.23.0, iOS 1.23.0

Updated version number and artifact links on the IVS documentation landing page and in the real-time-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

For Android, we added Using the SDK with Debug Symbols.

October 10, 2024

Service Quotas

We added a quota for "Participant publish bitrate."

September 25, 2024

Monitoring IVS Real-Time Streaming

Added the PublishFramerate CloudWatch metric.

September 13, 2024

Broadcast SDK: Android 1.22.0, iOS 1.22.0

Updated version number and artifact links on the IVS documentation landing page and in the real-time-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

We also updated a section, "Getting Started > Install the Library" in the Android broadcast SDK guide.

September 11, 2024

Broadcast SDK: Web 1.16.0

Updated version number and artifact links on the IVS documentation landing page and in the low-latency-streaming broadcast SDK guide: Web. Also see the Release Notes.

September 11, 2024

RTMP ingest

We added an IVS Stream Ingest page. Under this are two pages, RTMP (new) and WHIP.

In Using EventBridge with IVS Real-Time Streaming, we added an IVS Stage Update event, Participant Publish Error.

In Service Quotas, we added TPS values for the five new API operations and 1 new IngestConfiguration quota (in "Other Quotas").

API changes are described in the API Reference table.

September 9, 2024

Real-Time Streaming Optimizations

Made various simulcast-related updates and added "Resolution of Layers."

August 22, 2024

In-console publish/subscribe

In Getting Started with IVS Real-Time Streaming, we added in-console publishing and subscribing to Publish and Subscribe to Video.

August 19, 2024

Broadcast SDK: Web 1.15.0

Updated version number and artifact links on the IVS documentation landing page and in the low-latency-streaming broadcast SDK guide: Web. Also see the Release Notes.

We also added a new section, Configuration for Subscribing to Participants, to the Web Broadcast SDK Guide.

In Streaming Optimizations, we added a new section, Changing Subscriber Jitter Buffer MinDelay. This includes information about the Web, Android, and iOS Broadcast SDKs.

August 15, 2024

Broadcast SDK: Android 1.21.0, iOS 1.21.0

Updated version number and artifact links on the IVS documentation landing page and in the real-time-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

We also added a new section, "Configuration for Subscribing to Participants," to the Android and iOS Broadcast SDK Guides.

August 15, 2024

Recording clarification

Added a note about using an existing S3 bucket, in Individual Participant Recording (in 1: Create an S3 Bucket) and Composite Recording (in Prerequisites, Step 3). The Object Ownership setting must be Bucket owner enforced or Bucket owner preferred.

August 13, 2024

Broadcast SDK: Web 1.14.0

Updated version number and artifact links on the IVS documentation landing page and in the low-latency-streaming broadcast SDK guide: Web. Also see the Release Notes.

July 18, 2024

Broadcast SDK: Android 1.20.0, iOS 1.20.0

Updated version number and artifact links on the IVS documentation landing page and in the real-time-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

July 18, 2024

Getting Started with Real-Time Streaming

Added information on attributes to "Distribute Participant Tokens," in both "Token Schema: Payload" and "Creating Tokens with the IVS Real-Time Streaming API."

July 12, 2024

Service Quotas

Increased the maximum number of stage subscribers from 10,000 to 25,000.

June 27, 2024

Generate Participant Tokens with a Key Pair

In Getting Started with IVS Real-Time Streaming, we updated Distribute Participant Tokens to explain the two ways to generate tokens (API and key pair) and we added "Creating Tokens with a Key Pair."

June 26, 2024

Individual participant recording

Added a new documentation section on Recording, with sub-documents on Individual Participant Recording (new) and Composite Recording (pre-existing). We also added Participant Recording State Change events and examples to Using EventBridge with IVS.

API changes are described in the API Reference table.

June 20, 2024

Service Quotas

Increased the Stages quota from 100 to 1,000.

June 14, 2024

Broadcast SDK: Android 1.19.0, iOS 1.19.0

Updated version number and artifact links on the IVS documentation landing page and in the real-time-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

June 13, 2024

Broadcast SDK: Web 1.13.0

Updated version number and artifact links on the IVS documentation landing page and in the low-latency-streaming broadcast SDK guide: Web. Also see the Release Notes.

In the guide, we updated the information in Error Handling for the new ERROR stage event.

June 13, 2024

Broadcast SDK: Web 1.12.0

Updated version number and artifact links on the IVS documentation landing page and in the low-latency-streaming broadcast SDK guide: Web. Also see the Release Notes.

In the guide, we updated the information in Handling Network Issues about the stage-connection ERRORED state.

May 20, 2024

Real-Time Streaming Optimizations

In Default Layers, Qualities, and Framerates, changed the max bitrate for Mobile, Low Layer, from 150,000 to 100,000 bps.

May 16, 2024

Broadcast SDK: Android 1.18.0, iOS 1.18.0

Updated version number and artifact links on the IVS documentation landing page and in the real-time-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

May 16, 2024

Broadcast SDK: Web 1.11.0

Updated version number and artifact links on the IVS documentation landing page and in the real-time-streaming broadcast SDK guide: Web. Also see the Release Notes.

May 6, 2024

Broadcast SDK: Web 1.10.1

Updated version number and artifact links on the IVS documentation landing page and in the real-time-streaming broadcast SDK guide: Web. Also see the Release Notes.

April 30, 2024

Broadcast SDK: Android 1.15.2, iOS 1.15.2

Updated version number and artifact links on the IVS documentation landing page and in the real-time-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

April 30, 2024

Broadcast SDK: iOS Guide

In Publish a Media Stream, we updated the code example.

April 26, 2024

Broadcast SDK: Android 1.17.0, iOS 1.17.0

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guides: Android and iOS. On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version. Also see the Amazon IVS Release Notes for this release.

April 22, 2024

Server-side composition

In SSC, made various changes, especially in "Layout," to explain PiP and grid layouts.

In the Web Broadcast SDK Guide, added Server-Side Rendering Support.

March 26, 2024

OBS and WHIP Support

Added a note about quality issues (like intermittent video freezing) that can occur with WHIP in OBS.

March 22, 2024

Broadcast SDK: Android 1.16.0, iOS 1.16.0, Web 1.10.0

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guides: Android, iOS, and Web. On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version. Also see the Amazon IVS Release Notes for this release.

March 21, 2024

Broadcast SDK: Android 1.15.1, iOS 1.15.1

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guides: Android and iOS. On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version. Also see the Amazon IVS Release Notes for this release.

March 13, 2024

Broadcast SDK: Mobile Audio Modes

In "Audio Mode Presets," added information on the Volume Rocker preset category and an iOS known issue with the Video Chat preset. In "Advanced Use Cases," added a note on avoiding incorrect configurations, and added sections on "iOS Echo Cancellation" and "iOS Custom Audio Sources."

March 1, 2024

Broadcast SDK: Android 1.15.0, iOS 1.15.0, Web 1.9.0

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guides: Android, iOS, and Web. On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version. Also see the Amazon IVS Release Notes for this release.

February 22, 2024

OBS and WHIP Support

Added a new page. This document explains how to use WHIP-compatible encoders like OBS to publish to IVS real-time streaming. WHIP (WebRTC-HTTP Ingestion Protocol) is an IETF draft developed to standardize WebRTC ingestion.

February 6, 2024

Broadcast SDK: Android 1.14.1, iOS 1.14.1, Web 1.8.0

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guides: Android, iOS, and Web. On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version. Also see the Amazon IVS Release Notes for this release.

For the Android Guide, we added a new Known Issue (video size less than 176x176).

For the Web Guide, we added a new Known Issue. The workaround is constraining video resolution to 720p when invoking getUserMedia or getDisplayMedia.

In Real-Time Streaming Optimizations we updated Configuring Layered Encoding with Simulcast; now this is disabled by default.

February 1, 2024

Broadcast SDK: Android 1.13.4, iOS 1.13.4, Web 1.7.0

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guides: Android, iOS, and Web. On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version. Also see the Amazon IVS Release Notes for this release.

January 3, 2024

IVS Glossary

Extended the glossary, covering IVS real-time, low-latency, and chat terms.

December 20, 2023

Stage Health: New CloudWatch Metrics

Renamed the PacketLoss (Stage) metric to be DownloadPacketLoss (Stage) and released additional CloudWatch metrics for IVS real-time streaming:

  • DownloadPacketLoss (Stage,Participant)

  • DroppedFrames (Stage,Participant)

  • SubscribeBitrate (Stage,Participant,MediaType)

See Monitoring IVS Real-Time Streaming.

December 7, 2023

IAM managed policies

Added two managed policies, IVSReadOnlyAccess and IVSFullAccess. See:

December 5, 2023

Broadcast SDK: Android 1.13.2, iOS 1.13.2

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guides: Android and iOS.

On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version.

Also see the Amazon IVS Release Notes for this release.

December 4, 2023

Broadcast SDK: Android 1.13.1

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guide: Android.

On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version.

Also see the Amazon IVS Release Notes for this release.

November 21, 2023

Service Quotas

Changed "Participant publish resolution" from 1080p to 720p.

November 18, 2023

Broadcast SDK: Android 1.13.0, iOS 1.13.0

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guides: Android and iOS.

On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version.

Also see the Amazon IVS Release Notes for this release.

We also made various updates to Streaming Optimizations. Among other things, the "Adaptive Streaming: Layered Encoding with Simulcast" feature now requires explicit opt-in and is supported only in recent versions of the SDK.

November 17, 2023

Composite Recording

Made the following changes:

November 16, 2023

Server-side composition (SSC)

IVS server-side composition enables clients to offload the composition and broadcasting of an IVS stage to an IVS-managed service. SSC and RTMP broadcast to a channel are invoked through IVS control-plane endpoints in the stage’s home region. See:

Also see:

November 16, 2023

IVS broadcast SDK

In the Broadcast SDK overview, we updated Platform Requirements > Native Platforms to clarify which SDK versions are supported and we added "Mobile Browsers (iOS and Android)."

In the Broadcast Web Guide, we added "Mobile Web Limitations."

November 9, 2023

IVS broadcast SDK

We added a new page on Third-Party Camera Filters.

November 9, 2023

Getting Started with IVS Real-Time Streaming

We updated procedures in Set Up IAM Permissions.

October 20, 2023

Monitoring Real-Time Streaming

In CloudWatch Metrics: IVS Real-Time Streaming, we added sample values for dimensions.

October 17, 2023

Broadcast SDK: Web Guide

We made several changes to Monitor Remote Participant Media Mute State.

October 17, 2023

Broadcast SDK: Web 1.6.0

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guide: Web.

The Amazon IVS documentation landing page points to the current version of Broadcast SDK References.

Also see the Amazon IVS Release Notes for this release.

In the Web Guide, in "Retrieve a MediaStream from a Device," we also deleted the two max lines; best practice is to specify only ideal.

In Real-Time Streaming Optimizations, we added a new section, Optimizing Audio Bitrate and Stereo Support.

October 16, 2023

Stage Health: New CloudWatch Metrics

Released CloudWatch metrics for IVS real-time streaming. See Monitoring IVS Real-Time Streaming.

October 12, 2023

Broadcast SDK: Android 1.12.1

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guide: Android. Also added a new section, Using Bluetooth Microphones.

The Amazon IVS documentation landing page points to the current version of Broadcast SDK References.

Also see the Amazon IVS Release Notes for this release.

October 12, 2023

Broadcast SDK: Web 1.5.2

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guide: Web.

The Amazon IVS documentation landing page points to the current version of Broadcast SDK References.

Also see the Amazon IVS Release Notes for this release.

September 14, 2023

Getting Started with IVS Real-Time Streaming

In Android > Install the Broadcast SDK, added data binding.

September 12, 2023

Broadcast SDK error handling

Added "Error Handling" sections to the Broadcast SDK Guides: Web, Android, and iOS.

September 12, 2023

Getting Started with IVS Real-Time Streaming

In Distribute Participant Tokens, added an Important note about not building functionality based on current token format.

September 1, 2023

Getting Started with IVS Real-Time Streaming

In Set Up IAM Permissions, updated the set of permissions.

August 31, 2023

Broadcast SDK: Web 1.5.1, Android 1.12.0, and iOS 1.12.0

Updated version number and artifact links for the new release, in the real-time-streaming broadcast SDK guides: Web, Android, and iOS.

On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version.

Also see the Amazon IVS Release Notes for this release.

August 23, 2023

Real-time streaming launch

Major documentation changes accompany this release. We renamed the previous documentation to be IVS Low-Latency Streaming and published new IVS Real-Time Streaming documentation. The IVS documentation landing page now has separate sections for real-time streaming and low-latency streaming. Each section has its own User Guide and API Reference.

For other documentation changes, see Document History (Low-Latency Streaming).

August 7, 2023

Broadcast SDK: Web 1.5.0, Android 1.11.0, and iOS 1.11.0

Updated version number and artifact links for the new release, in the broadcast SDK guides: Web, Android, and iOS.

On the Amazon IVS documentation landing page, updated the broadcast SDK Reference links to point to the new version.

Also see the Amazon IVS Release Notes for this release.

August 7, 2023

IVS Real-Time Streaming API Reference Changes

API Change Description Date

Real-time thumbnail configuration

Modified the S3DestinationConfiguration object: added thumbnailConfigurations. This affects the GetComposition response and StartComposition request and response.

Modified the AutoParticipantRecordingConfiguration object: added thumbnailConfiguration and added NONE as a valid value for mediaTypes. This affects the CreateStage request and response, GetStage response, and UpdateStage request and response.

Added two objects: CompositionThumbnailConfiguration and ParticipantThumbnailConfiguration.

 December 10, 2024

Update Event and Video objects

In the Event object, we added more valid values for errorCode.

In the Video object, we clarified that height and width must be even numbers.

 October 2, 2024

RTMP ingest

We added two objects: IngestConfiguration and IngestConfigurationSummary. We added five IngestConfiguration endpoints (Create, Delete, Get, List, and Update).

We updated DeleteStage (description of the operation) and DisconnectParticipant (descriptions of the operation and participantId).

We modified the Participant object (added the protocol field); that affects the GetParticipant response.

We modified the StageEndpoints object (added the rtmp and rtmps fields); that affects the CreateStage, GetStage, and UpdateStage responses. We also updated this object's description (added a caching recommendation).

September 9, 2024

Generate Participant Tokens with a Key Pair

We added three objects (PublicKey, PublicKeySummary, StageEndpoints) and four endpoints: (DeletePublicKey, GetPublicKey, ImportPublicKey, ListPublicKeys). We modified the Stage object (added the endpoints field); that affects the CreateStage, GetStage, and UpdateStage responses.

 June 26, 2024

Individual participant recording

We added one object (AutoParticipantRecordingConfiguration) and modified three objects (Participant, ParticipantSummary, Stage). This affects five endpoints: CreateStage request and response, GetParticipant response, GetStage response, ListParticipants request and response, and UpdateStage request and response.

 June 20, 2024

Remove svs from ARN patterns

ARN patterns which specified [is]vs were updated to specify ivs. This affects all three Tag endpoints and the ChannelDestinationConfiguration$channelArn field.

 April 25, 2024

Server-side composition updates

We added one object: PipConfiguration.

We modified two objects (LayoutConfiguration, GridConfiguration). This affects the GetComposition response and the StartComposition request and response.

 March 13, 2024

Composite recording

We added 4 StorageConfiguration endpoints and 7 objects (DestinationDetail, RecordingConfiguration, S3DestinationConfiguration, S3Detail, S3StorageConfiguration, StorageConfiguration, StorageConfigurationSummary).

We modified 3 objects (Composition, Destination, DestinationConfiguration). This affects the GetComposition response and the StartComposition request and response.

 November 16, 2023

Server-side composition

We added 8 Composition and EncoderConfiguration endpoints and 11 objects (ChannelDestinationConfiguration, Composition, CompositionSummary, Destination, DestinationConfiguration, DestinationSummary, EncoderConfiguration, EncoderConfigurationSummary, GridConfiguration, LayoutConfiguration, and Video).

 November 16, 2023

Stage Health: New Participant Data

Added six fields to the Participant object: browserName, browserVersion, ispName, osName, osVersion, and sdkVersion. This affects the GetParticipant response.

 October 12, 2023

Participant Token

Added an Important note about not building functionality based on current token format.

 September 1, 2023

IVS Real-Time Streaming launch

Major documentation changes accompany this release. We renamed the previous documentation to be IVS Low-Latency Streaming and published new IVS Real-Time Streaming documentation. The IVS documentation landing page now has separate sections for real-time streaming and low-latency streaming. Each section has its own User Guide and API Reference.

IVS Real-Time Streaming API Reference is part of IVS real-time streaming documentation. Previously it was titled IVS Stage API Reference. Its prior history is described in Document History (Low-Latency Streaming).

 August 7, 2023