Document History (Low-Latency Streaming) - Amazon Interactive Video Service

Document History (Low-Latency Streaming)

Low-Latency Streaming User Guide Changes

ChangeDescriptionDate

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.

May 20, 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 low-latency-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

May 16, 2024

Player SDK: Web 1.28.0

Updated version number and artifact links on the IVS documentation landing page and in the player SDK guides: Web, Video.js Integration, and JW Player Integration. Also see the Release Notes.

May 9, 2024

Player SDK: Android 1.28.0, iOS 1.28.0

Updated version number and artifact links on the IVS documentation landing page and in the player SDK guides: Android and iOS. Also see the Release Notes.

May 9, 2024

Broadcast SDK: Web 1.11.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.

May 6, 2024

Broadcast SDK: Web 1.10.1

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.

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 low-latency-streaming broadcast SDK guides: Android and iOS. Also see the Release Notes.

April 30, 2024

Broadcast SDK: Android 1.17.0, iOS 1.17.0

Updated version number and artifact links for the new release, in the low-latency-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

Player SDK 1.27.0

Updated version number and artifact links for the new release, in the player SDK guides: Web, Android, iOS, Video.js Integration, and JW Player Integration. On the Amazon IVS documentation landing page, updated the player SDK Reference links to point to the new versions. Also see the Amazon IVS Release Notes for this release.

In the Web Player Guide, we added more information on “Demos.”

April 11, 2024

SRT additional information

Added SRT information to:

April 10, 2024

Getting Started with Low-Latency Streaming

In "Step 6: View Your Live Stream," we added a section on "Viewing with the Amazon IVS Player."

April 4, 2024

Secure Reliable Transport ingest support

IVS now supports H.264-encoded video content using the SRT protocol. In Getting Started With IVS Low-Latency Streaming, in "Step 5: Set Up Streaming Software," we added new sections, "Streaming with OBS Studio using SRT" and "Streaming a Recorded Video with FFmpeg using SRT." Also see API Reference Changes.

April 4, 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 low-latency-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

Player SDK 1.26.0

Updated version number and artifact links for the new release, in the player SDK guides: Web, Android, iOS, Video.js Integration, and JW Player Integration. On the Amazon IVS documentation landing page, updated the player SDK Reference links to point to the new versions. Also see the Amazon IVS Release Notes for this release.

March 14, 2024

Broadcast SDK: Android 1.15.1, iOS 1.15.1

Updated version number and artifact links for the new release, in the low-latency-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

Monitoring

Changed the unit for IngestFramerate from Frames per second to Count/Second.

March 11, 2024

Setting Up Private Channels

In Token Schema, added a note about the maximum number of domains for access-control-allow-origin.

March 11, 2024

Player SDK: Web 1.25.0

Updated version number and artifact links for the new release, in the player SDK guides: Web, Video.js Integration, and JW Player Integration. On the Amazon IVS documentation landing page, updated the player SDK Reference links to point to the new versions. Also see the Amazon IVS Release Notes for this release.

February 29, 2024

iOS 12 support deprecation for Player and Broadcast SDKs

Added a deprecation notice for iOS 12, in the "Native Platforms" tables of Player SDK overview and Broadcast SDK overview (low-latency streaming).

February 23, 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 low-latency-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

IAM managed policies

Added entry to Policy Updates table in Managed Policies for Amazon IVS to reflect updates to IVSReadOnlyAccess for Server-Side Composition, Real-Time Composite Recording, and Tokenless Playback Restrictions.

February 16, 2024

Player SDK: Mobile 1.25.0

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

February 15, 2024

Service Quotas

In the "API Call Rate Quotas" table, we added StartViewerSessionRevocation and BatchStartViewerSessionRevocation. (These are not new endpoints but were missing from the table.) They are in the same part of the table as the playback-key-pair endpoints; the Endpoint Type is "Private channel."

February 5, 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 low-latency-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).

February 1, 2024

Tokenless playback restrictions

This release enables origin enforcement and geofencing outside of playback authorization. Several low-latency streaming documents were changed:

Also see API changes.

January 31, 2024

Audio-only playback

Added Audio-Only Playback to the Player overview.

January 25, 2024

Player SDK 1.24.0

Updated version number and artifact links for the new release, in the player SDK guides: Web, Android, iOS, Video.js Integration, and JW Player Integration. On the Amazon IVS documentation landing page, updated the player SDK Reference links to point to the new versions. Also see the Amazon IVS Release Notes for this release.

In the Web guide, we added a new section, "Audio-Only Playback," and deleted the "Known Issue" about lack of support for the audio-only rendition.

January 18, 2024

Troubleshooting Auto-Record to Amazon S3

In Troubleshooting, we added a section, Can KMS-S3 encryption be used with auto-record to S3?

January 4, 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 low-latency-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

Split out a Chat UG

Major documentation changes accompany this release. We moved chat information from the IVS Low-Latency Streaming User Guide to a new IVS Chat User Guide, located in the existing IVS Chat section of the IVS documentation landing page.

For other documentation changes, see Document History (Chat).

December 28, 2023

IVS Glossary

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

December 20, 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 low-latency-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 low-latency-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

Broadcast SDK: Android 1.13.0, iOS 1.13.0

Updated version number and artifact links for the new release, in the low-latency-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.

November 17, 2023

Auto-Record to S3

In Merge Fragmented Streams > Eligibility, we added a bullet: "Each stream must start 10 seconds or more after the previous stream."

November 17, 2023

Server-side composition and real-time composite recording

In Enabling Multiple Hosts on an IVS Stream, we added "Broadcasting a Stage: Client-Side versus Server-Side Composition" and updated "4. Broadcast the Stage."

In Security, we added S3 endpoints to the policy in "Identity-Based Policy Examples > Use the Amazon IVS Console."

For additional changes, see Document History (Real-Time Streaming).

November 16, 2023

Player SDK 1.23.0

Updated version number and artifact links for the new release, in the player SDK guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

November 14, 2023

IVS player and broadcast SDKs

In the Player overview and Broadcast SDK overview, we updated Platform Requirements > Native Platforms to clarify which SDK versions are supported.

November 9, 2023

Getting Started with IVS Low-Latency Streaming

We updated procedures in Set Up IAM Permissions.

October 20, 2023

Broadcast SDK: Web 1.6.0

Updated version number and artifact links for the new release, in the low-latency-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.

October 16, 2023

Monitoring IVS Low-Latency Streaming

Renamed the "Monitoring Live Stream Health" page and added information from "Monitoring IVS with CloudWatch" (which has been deleted as a separate page). Updated the CloudWatch console instructions.

October 12, 2023

Broadcast SDK: Android 1.12.1

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

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.

October 12, 2023

Player SDK 1.22.0

Updated version number and artifact links for the new release, in the player SDK guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

October 3, 2023

In-console streaming

In Getting Started with Low-Latency Streaming, we added in-console streaming to Step 5: Set Up Streaming Software.

October 2, 2023

Broadcast SDK: Mixer Guide

Added Mirroring the Broadcast, with Android and iOS examples.

September 18, 2023

Broadcast SDK: Web 1.5.2

Updated version number and artifact links for the new release, in the low-latency-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

Undesired Content

Split out existing content from Troubleshooting FAQs into its own top-level page.

In Getting Started with IVS Low-Latency Streaming, added "Step 8: Prevent Undesired Content (Recommended)."

September 8, 2023

Auto-Record to Amazon S3

In Byte-Range Playlists, clarified that segment duration is the same as the keyframe interval configured for the stream (not a fixed duration of approximately 2 seconds).

August 25, 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 low-latency-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

Player SDK 1.21.0

Updated version number and artifact links for the new release, in the player SDK guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

August 22, 2023

Channel-type definitions

Updated channel-type definitions to provide more detail, especially about rendered transcode ladders. See Channel Types in IVS Streaming Configuration.

August 18, 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.

We moved some information from the IVS Low-Latency User Guide to the new IVS Real-Time User Guide:

For other documentation changes, see:

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

Setting Up Private Channels

In Token Schema, added clarifying information on the exp field.

July 31, 2023

Security: getting IVS status information

In Incident Response, updated information on getting IVS status, to point to the AWS Health Dashboard.

July 31, 2023

Auto-Record to Amazon S3: OAC and CORS

In Playback of Recorded Content from Private Buckets, replaced origin access identity (OAI) with origin access control (OAC). Also added information about configuring the S3 bucket for CORS, to play back recorded streams.

July 31, 2023

Resources and Support

In "Partner Solutions" > "Face and Background Filters," added a paragraph on Camera Kit.

July 21, 2023

Broadcast SDK: Android Guide

Minor changes. In the introduction, mentioned that there is no support for emulators. In "Create the Player and Set Up Event Listener" changed PlayerActivity class to Activity. In "Thread Safety" changed the text.

July 21, 2023

R2S3 rendition filtering and thumbnail enhancements

IVS customers can now control what renditions are generated for a stream when recording to Amazon S3 and what resolutions are generated for thumbnails. In the IVS User Guide, see:

  • Getting Started with IVS – In "Step 4: Create a Channel" > "Console Instructions," we updated screenshots and instructions.

  • Auto-Record to Amazon S3 – In "JSON Metadata Files," we added latest_thumbnail and updated thumbnail. In "Thumbnails" and "Discovering the Renditions of a Recording," we added rendition-resolution descriptions.

  • Costs – In "Storing Recorded Video," we updated screenshots.

Also see IVS API Reference Changes.

July 17, 2023

Player SDK 1.20.0

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

July 14, 2023

Getting Started with IVS

In How to Disable Recording, fixed the CLI example.

July 14, 2023

Broadcast SDK: Web 1.4.0, Android 1.10.0, and iOS 1.10.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.

July 13, 2023

Viewer session revocation for private channels

IVS customers can now revoke the viewer session associated with an auth token, to prevent and stop playback using that token. For more information, see Setting Up Private Channels:

  • "Token Schema" – We added viewer-id and modified viewer-session-version.

  • "Revoke Viewer Sessions" – New section.

Also see IVS API Reference Changes.

June 28, 2023

Security TLS update

In "Infrastructure Security" > "API Calls," updated the TLS version to 1.2 minimum and 1.3 recommended.

June 27, 2023

Broadcast SDK: iOS 1.9.1 and iOS 1.7.5

Updated version number and artifact links for the new release in the broadcast SDK guide: iOS.

The Amazon IVS documentation landing page points to the latest version of the Broadcast SDK Reference.

Also see the Amazon IVS Release Notes for this release.

June 27, 2023

Broadcast SDK: Web 1.3.3

Updated version number and artifact links for the new release in the broadcast SDK guide: Web.

The Amazon IVS documentation landing page points to the latest version of the Broadcast SDK Reference.

Also see the Amazon IVS Release Notes for this release.

June 16, 2023

Advanced channel types

Introduced two new channel types, ADVANCED_SD and ADVANCED_HD. We updated several pages:

June 2, 2023

Broadcast SDK: Android 1.9.0 & iOS 1.9.0

Updated version number and artifact links for the new release, in the 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.

In the Broadcast SDK overview, updated supported iOS versions from 11+ to 12+ (for the SDK without stage functionality).

In the iOS Guide, added a new section, "How iOS Chooses Camera Resolution and Frame Rate."

Also see the Amazon IVS Release Notes for this release.

June 1, 2023

Auto-Record to AmazonS3

In "Example: recording_ended.json," updated the byte_range_playlist value from byte-range-multivariant.m3u8 to byte-range-variant.m3u8.

May 25, 2023

Player SDK 1.19.0

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

May 23, 2023

Broadcast SDK: iOS 1.8.1 and iOS 1.7.4

Updated version number and artifact links for the new release in the broadcast SDK guide: iOS.

The Amazon IVS documentation landing page points to the latest version of the Broadcast SDK Reference.

Also see the Amazon IVS Release Notes for this release.

May 16, 2023

Monitoring stage health

Added Monitoring Stage Health, a new User Guide page for new Amazon IVS functionality. For Stage Health, we also:

Note: With the IVS real-time streaming launch on Aug 2, 2023, this document was renamed "Monitoring Amazon IVS Real-Time Streaming" and moved to the new IVS Real-Time Streaming user Guide.

May 11, 2023

Stage participant limits

In Service Quotas, deleted the "stage participants" limit. This is superceded by the limits for subscriber and publisher participants.

May 2, 2023

Broadcast SDK: Web 1.3.2

Updated version number and artifact links for the new release in the broadcast SDK guide: Web.

The Amazon IVS documentation landing page points to the latest version of the Broadcast SDK Reference.

Also see the Amazon IVS Release Notes for this release.

May 1, 2023

RTMP support: documentation errata

Changed Broadcast Android SDK Guide and Broadcast iOS SDK Guide to indicate that these SDKs support only RTMPS ingest (not insecure RTMP ingest).

April 29, 2023

Stage participant limits

This release includes the following changes:

  • Enabling Multiple Hosts – Updated the maximum number of stage participants from 12 to 1,000.

  • Service Quotas – Updated the participant limit to 1,000 and added add new limits for subscriber and publisher participants. Changes TPSs for some endpoints.

April 27, 2023

IVS User Guide landing page

On the What is IVS? home page, we added sections for "Multiple Hosts" and "IVS Chat" and updated the section on "Latency."

April 27, 2023

Resources and Support

In "Partner Solutions" > "Face and Background Filters," updated the DeepAR link.

April 25, 2023

Resources and Support

Added a section on Partner Solutions.

April 17, 2023

Player SDK: Web Guide

In "Known Issues and Workarounds," added an issue (the Web Player does not support the audio_only rendition).

April 17, 2023

Streaming Configuration

In Closed Captioning, added a link to a new blog post on captioning.

April 14, 2023

Broadcast Web SDK Guide

Made miscellaneous updates:

  • In “Create an Instance of the AmazonIVSBroadcastClient​,” added a note about making sure your client-side configuration aligns with the back-end channel type.

  • In “Hide Video” code examples, changed VIDEO_DEVICE_NAME to VIDEO_DEVICE_NAME.source.

  • In “Enabling Multiple Hosts,” changed ConnectionState references to StageConnectionState.

  • In “Add Multiple Hosts with the Broadcast SDK” and “Known Issues,” synchronized information here and on GitHub.

April 10, 2023

Streaming Configuration

In Video Settings, added a ColorSpace bullet.

April 5, 2023

Enabling Multiple Hosts

In Set Up the AWS CLI, changed the stage namespace from ivsrealtime to ivs-realtime.

April 5, 2023

Player SDK 1.18.0

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

April 4, 2023

RTMP support

In several documents, indicated that both RTMP (insecure ingest) and RTMPS are now supported. Among other things, this affects the ingest endpoint; see Set Up Streaming Software, Broadcast Android SDK Guide, and Broadcast iOS SDK Guide.

March 30, 2023

Setting Up Private Channels

In Generate and Sign Playback Tokens, added to the payload an optional field, single-use-uuid, for generating a single-use token.

March 29, 2023

Broadcast SDK: Web 1.3.1

Updated version number and artifact links for the new release, in the broadcast SDK guide: 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 28, 2023

Support for multiple hosts on a stream

Added a new page, Enabling Multiple Hosts on an IVS Stream. And in Service Quotas, added "Amazon IVS Stage" endpoints and added stage limits to Other Quotas > Amazon IVS.

Also see Stage API Reference Changes.

March 23, 2023

Broadcast SDK: Android 1.8.0, iOS 1.8.0, and Web 1.3.0

Updated version number and artifact links for the new release, in the 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.

In the Broadcast SDK overview, added stage platform requirements.

Also see the Amazon IVS Release Notes for this release.

March 23, 2023

Web Broadcast SDK

In Known Issues and Workarounds, added an issue: viewers of a Safari broadcast sometimes see green artifacts in the video feed.

March 17, 2023

Broadcast SDK: Android 1.7.3

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

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

Also see the Amazon IVS Release Notes for this release.

March 2, 2023

Player SDK 1.17.0

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

February 28, 2023

Service Quotas

Clarified that all quotas are enforced per region.

February 24, 2023

Troubleshooting FAQs

In "Use Private Channels," clarified the use of private channels to prevent undesirable content. In "Broadcasting and Encoding," added two subsections on troubleshooting an IVS Web Broadcast SDK session and using Chrome WebRTC-internals.

February 17, 2023

Byte-range tags and manifest files for auto-record to S3

In Auto-Record to Amazon S3, updated "Recording Contents," added "Byte-Range Playlists" and new fields in JSON examples for recording_started and recording_ended.

February 16, 2023

Getting Started with IVS Chat

In the beginning, say that IVS Chat also can be used on its own, without a video stream. See Getting Started with IVS Chat in the Amazon IVS Chat User Guide.

February 9, 2023

Troubleshooting FAQs

Added a new section on Undesirable Content.

Sept 8, 2023 update: This section was moved to Undesired Content.

February 6, 2023

Player SDK overview

In Browser & Platform Requirements, added a note that the Web SDK Video.js and Player JW integrations are not supported in browser-like environments.

February 6, 2023

Auto-Record to Amazon S3

In the Eligibility requirements for merge fragmented streams, changed the required bitrate difference from 10% to 50%.

February 6, 2023

Streaming configuration

Revised Stream with the Amazon IVS Broadcast SDK to include the Web Broadcast SDK (not just Android and iOS).

February 2, 2023

IVS Chat Client Messaging SDK: Android 1.1.0

Updated version number and artifact links for the new release, in the Chat SDK Guide: Android.

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

Also see the Amazon IVS Release Notes for this release.

This release includes an extensive Chat Kotlin Coroutines tutorial, split into two parts:

January 31, 2023

Chat Android SDK tutorial

Added an extensive Android tutorial for the Chat Client Messaging SDK. The tutorial is split into two parts:

January 24, 2023

Service Quotas

Increased some Chat quotas:

  • TPS for CreateChatToken, DeleteMessage, DisconnectUser, and SendEvent Rooms

  • Other Quotas: concurrent chat connections; rate of DeleteMessage, DisconnectUser, and SendMessage requests; rate of messaging requests per connection; and Rooms

January 19, 2023

Private Channels

In Token Schema, added the strict-origin-enforcement field to the token payload.

January 17, 2023

Player SDK 1.16.0

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

January 17, 2023

Chat React & React Native Best Practices

Added this new Chat page.

Note: On December 28, 2023, this document was moved to the new IVS Chat User Guide.

January 13, 2023

Chat React Native SDK tutorial

Added an extensive React Native tutorial for the Chat Client Messaging SDK. The tutorial is split into two parts:

January 10, 2023

Troubleshooting

Added a new Troubleshooting FAQs page, describing best practices and troubleshooting tips.

January 6, 2023

Added timestamp to record-to-S3 manifest files

Added a timestamp to S3 manifest files created by the auto-record to S3 feature. See the Amazon IVS Release Notes.

December 9, 2022

Player SDK latency

Added Reducing Latency in Third-Party Players.

December 8, 2022

Broadcast Web SDK Guide

Added content (previously only on GitHub) to this page.

December 8, 2022

Broadcast SDK: Android 1.7.2

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

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

Also see the Amazon IVS Release Notes for this release.

December 6, 2022

IVS setup

In IVS Getting Started, updated steps to create an AWS account and set up permissions. Added "Step 2: Set Up Root and Administrative Users."

In Security, made minor changes to the beginning of the IAM section.

December 5, 2022

Chat: setup and iOS SDK tutorial

In Getting Started with IVS Chat, updated and renamed "Initial Setup."

Added a Chat iOS Tutorial page to the User Guide, pointing to an existing tutorial on GitHub.

December 5, 2022

Costs for Auto-Record to S3

In Auto-Record to Amazon S3, clarified costs.

December 2, 2022

Chat JavaScript SDK tutorial

Added an extensive JS tutorial for the Chat Client Messaging SDK. The tutorial is split into two parts:

December 2, 2022

Web Player known issue

In the Player Web SDK Guide, we added a Known Issue and Workaround: when playing a muted live stream on an iOS mobile browser, player instability may be seen when resuming an inactive player tab.

November 18, 2022

Setting Up Private Channels

In "Create or Import a Playback Key," reorganized content and clarified use of private and public keys. In "Generate and Sign Playback Tokens," clarified that you do not have to enter the public key in jwt.io.

November 18, 2022

Chat Logging

Initial release of this new functionality. See these User Guide changes:

November 17, 2022

Chat Client Messaging SDK: JavaScript 1.0.2

Updated version number and artifact links for the new release, in the Chat SDK guide: JavaScript.

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

Also see the Amazon IVS Release Notes for this release.

November 9, 2022

Split-view on live channels (for monitoring live stream health)

In Access Stream Session Data, added console instructions for accessing the new split view. This is a faster way to get session health data, right from the "Live channels" page.

November 8, 2022

Resources and Support

Added a link to IVS blogs on the DEV community site.

November 7, 2022

Auto-Record to Amazon S3

In "Merge Fragmented Streams" > "Eligibility," deleted the redundant bullet, "Source video quality must be the same."

November 7, 2022

Player SDK 1.14.0

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

November 1, 2022

Player SDK: Web Guide

Updated Working with Content Security Policy, to reflect the fact that newer versions of all browsers have been updated to deal with new CSP rules. Deleted old sections on "Hosting Assets on the Same Origin" and "Hosting Assets on a Separate Origin."

October 27, 2022

Getting Started with Amazon IVS Chat

Updated and clarified Step 3, formerly "Authenticate and Authorize Chat Clients," now Create a Chat Token.

October 27, 2022

Player SDK: Web Guide

In “Sample Code,” added quotes around PLAYBACK_URL and clarified that it should be replaced with a URL string.

October 24, 2022

Chat Client Messaging SDK: JavaScript Guide

Added a new section, React Native Support.

October 24, 2022

IVS Chat Client Messaging SDK: JavaScript 1.0.1

Initial release of this new SDK. See Amazon IVS Chat Client Messaging SDK in the IVS User Guide.

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

Also see the Amazon IVS Release Notes for this release.

October 18, 2022

Broadcast SDK: iOS 1.7.1

Updated version number and artifact links for the new release, in the broadcast SDK guide: 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.

October 6, 2022

Web Player SDK 1.13.0 Release Notes

Added a known issue to the Release Notes for Web Player 1.13.0, about the Sawmill Enabled log.

September 27, 2022

Broadcast SDK 1.7.0 release

Updated version number and artifact links for the new release, in the broadcast SDK guide: Android, 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.

September 22, 2022

Player 1.13.0 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

September 20, 2022

Broadcast SDK: iOS 1.5.2

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

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 12, 2022

IVS Chat Client Messaging SDK: Android 1.0.0 and iOS 1.0.0

Initial release of these new SDKs. See Amazon IVS Chat Client Messaging SDK in the IVS User Guide.

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

Also see the Amazon IVS Release Notes for this release.

We updated Getting Started with Amazon IVS Chat with links to various demos (including a backend server app that demonstrates token generation) and sample code for deleting a chat message.

September 8, 2022

Monitoring Amazon IVS with Amazon CloudWatch

For some Amazon IVS metrics with the Channel dimension, we corrected the description. Channel values are not ARNs (as previously stated). They are the channel's resource-id, which is the last part of an ARN.

Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

September 2, 2022

Resources and Support

Added a new page to the Amazon IVS User Guide. This points to additional information about, and support for, Amazon IVS.

September 1, 2022

Merge fragmented streams

Initial release of this new functionality. See these documentation changes:

August 30, 2022

Monitoring Live Stream Health

In Filter Streams by Health, corrected the CLI example: changed filter-by name to filter-by health.

August 17, 2022

Expand BASIC channel

The maximum resolution and bitrate for BASIC channels have changed. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. See these documentation changes:

  • Getting Started with IVS – Updated the screenshot in Initial channel setup.

  • Streaming Configuration – Updated definitions in Channel Types.

  • Costs – Updated channel definitions in Live Video.

  • Service Quotas – In Other Quotas, updated IVS information for Ingest bitrate & Ingest resolution, for BASIC channels.

August 16, 2022

Player SDK 1.12.0 release: Web

Updated version numbers and artifact links for the new release in Player guides: Web, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

August 9, 2022

Broadcast SDK: iOS 1.5.1

Updated Release Notes for the July 28 release: added a fixed item (memory leak).

August 8, 2022

Auto-Record to Amazon S3

In JSON Metadata Files, added notes for recording_started_at and recording_ended_at, about using duration_ms to determine the duration of a recording.

August 8, 2022

Amazon IVS Broadcast SDK: Web

Updated (here and in Release Notes) the July 21 entry for this release, by deleting the 1.0.0 version number and adding a note that documentation for future releases will be updated only on GitHub.

August 4, 2022

Clarify console instructions

Noted that you click the hamburger icon to open the nav pane only if the pane is collapsed. This occurs in three places:

August 3, 2022

Broadcast SDK release: iOS 1.5.1

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

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.

July 28, 2022

Amazon IVS Broadcast SDK: Web

Initial release of the Web broadcast SDK. See the documentation under "Amazon IVS Broadcast SDK" on the Amazon IVS documentation landing page.

Also updated Streaming with Amazon IVS Broadcast SDK in Getting Started with Amazon IVS.

Important: For future releases, documentation will be updated only on GitHub: https://aws.github.io/amazon-ivs-web-broadcast/ (not here).

July 21, 2022

IVS Chat metric

Monitoring Amazon IVS with Amazon CloudWatch – A metric (Deliveries) was added for IVS Chat.

Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

July 15, 2022

Player SDK release: iOS 1.8.3

Updated version number and artifact links for the new release, in the iOS Player Guide.

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

July 14, 2022

Estimate data use screenshot

In Costs, the screenshot for "Estimate data use" was updated: the "audio" rendition is no longer provided.

June 30, 2022

Player SDK 1.11.0 release: Web

Updated version number and artifact links for the new release, in Player guides: Web, Video.js Integration, and JW Player Integration.

On the Amazon IVS documentation landing page, updated the player SDK Web Reference link to point to the new version.

Also see the Amazon IVS Release Notes for this release.

In the Player SDK: Web Guide, we deleted two items from "Known Issues and Workarounds" which no longer apply:

  • When playing recorded content on an iOS mobile browser using the Video.js integration, the replay button does not work properly.

  • When playing a live stream on a Google Pixel 4 or 4a mobile browser, playback may stop unexpectedly.

June 28, 2022

Broadcast SDK 1.5.0 release

Updated version number and artifact links for the new release, in the broadcast SDK guide: Android, 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.

June 22, 2022

Streaming ingest configuration

In Stream Ingest: Codecs, RTMPS, and Port 443, clarified terminology: you specify an IVS ingest server (which includes port 443 in the path).

June 20, 2022

Service Quotas

For IVS Chat quotas, added quota for "rate of SendMessage requests per room" and clarified that the existing rate quota for SendMessage requests applies across all your rooms.

June 14, 2022

Ingest server format

In Getting Started with Amazon IVS, updated the screenshot in "Final Channel Creation" to show the current format of Ingest server (with port 443 and path /app/). Updated instructions in "Streaming with OBS Studio" and "Streaming a Recorded Video with FFmpeg."

June 14, 2022

Player SDK 1.10.0 release: Web and Android

Updated version number and artifact links for the new release, in Player guides: Web, Android, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

May 24, 2022

Service Quotas

Added call-rate quotas for GetStreamSession and ListStreamSessions. (These IVS endpoints were added previously, when Stream Health was launched.)

May 16, 2022

iOS Player Guide

In "Known Issues and Workarounds," deleted a bullet about iOS 10, which is no longer supported:

  • iOS 10 devices may experience a crash when returning from background.

    Workaround: Set the layer’s player property to nil before entering the background.

May 10, 2022

Broadcast SDK: Custom Image Sources

Added a bullet for a new CIFilter implementation in the sample iOS app.

May 10, 2022

Web Player Guide

In "Content Security Policy," added domains for video streams from third-party CDNs (*.akamaized.net and *.ext.cloudfront.live.hls.ttvnw.net).

April 29, 2022

Video.js Player Guide

In "Events," deleted MetadataEventType (which is no longer available) from the list of allowable event values.

April 29, 2022

Security policy updates

In Identity-Based Policy Examples, changed the console policy (added Chat, lambda, and Amazon CloudWatch) and the introductory text to it.

April 29, 2022

Private channels

In Generate and Sign Playback Tokens, specified that the exp timestamp value in the payload field of the token schema is UTC.

April 29, 2022

OBS Studio setup

IVS Getting Started – In Streaming with OBS Studio, clarified how to specify the server and stream key, and added steps to set video resolution, bitrate, and keyframe interval.

April 29, 2022

Stream Health updates

Monitoring Amazon IVS Live Stream Health – In "Console Instructions," noted that charts of the high-resolution CloudWatch metrics are available in the stream session details pages. In "Filter Streams by Health," added "CloudWatch Health Dimension for ConcurrentStreams."

Monitoring Amazon IVS with Amazon CloudWatch – A new dimension (Health) was added to the ConcurrentStreams metric, to filter the results by channel health.

Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

April 28, 2022

Amazon IVS Chat

Initial release of this new functionality. New and updated information is accessible from the Amazon IVS documentation landing page:

  • Getting Started with Amazon IVS Chat -- New page (in the Amazon IVS Chat User Guide).

  • Chat Message Review Handler – New page (in the Amazon IVS Chat User Guide).

  • Monitoring Amazon IVS with Amazon CloudWatch -- Added new metrics and a new namespace for chat.

    Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

    Dec 28, 2023 update: Chat-related CloudWatch content was moved to Monitoring Amazon IVS Chat.

  • Security -- In "Data Protection," added chat bullets. In "Identity and Access Management," added a section on "Resource-Based Policy for Amazon IVS Chat." In "Infrastructure Security," added a section on "Amazon IVS Chat."

  • Service Quotas -- In "Service Quota Increases," updated which quotas are adjustable. Merged two sections into "Other Quotas." Added chat information in "API Call Rate Quotas," "Other Quotas," and "Service Quotas Integration with CloudWatch Usage Metrics."

  • On the Amazon IVS documentation landing page, added an Amazon IVS Chat section with two API reference documents. See IVS Chat API Documentation Changes (a new section of this page).

    Dec 28, 2023 update: We moved chat-related information to the new IVS Chat User Guide. For other documentation changes see Document History (Chat).

April 26, 2022

iOS Player 1.8.2 release

Updated version number and artifact links for the new release, in the iOS Player Guide.

On the Amazon IVS documentation landing page, updated the iOS Player SDK Reference link to point to the new version.

April 22, 2022

Manual SDK installation

In the "Getting Started" > "Install the Library" section of Broadcast SDK: Android and Player: Android Guide, added a sentence about installing manually.

April 19, 2022

Broadcast SDK 1.4.0 release

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

Added a new page on Broadcast SDK: Custom Image Sources.

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 19, 2022

iOS Player 1.8.1 release

Updated version number and artifact links for the new release, in the iOS Player Guide.

On the Amazon IVS documentation landing page, updated the iOS Player SDK Reference link to point to the new versions.

March 31, 2022

Device support for Android player

In the Android Player Guide, clarified which native Android devices are supported (phones and tablets). In the Player overview, added a Supported Devices table column in the "Native Platform" section.

March 23, 2022

Using Amazon EventBridge with Amazon IVS

Modified the Session Ended event and updated its description. Also clarified the event descriptions of Session Created and Stream End.

March 18, 2022

Player Video.js Integration

In "Setup with Script Tag," step 1, added a closing </script> to the example.

March 4, 2022

Broadcast SDK 1.3.0 release

Updated version number and artifact links for the new release, in the broadcast SDK guide: Android, 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 3, 2022

Player 1.8.0 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

March 1, 2022

Using Amazon EventBridge with Amazon IVS

For the Recording End Failure event, added an example failure case: the attempt to write a master playlist fails.

February 10, 2022

Using Amazon EventBridge with Amazon IVS

For the Recording Start event, added a note that it takes awhile before manifest files and video segments are written.

February 9, 2022

Broadcast SDK: Android 1.2.1 release

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

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

Also see the Amazon IVS Release Notes for this release.

February 3, 2022

React Native wrapper for Player SDK

In the Player Android Guide and Player iOS Guide, added a link to GitHub code and documentation for the new React Native wrapper.

January 27, 2022

React Native wrapper for Player SDK

In the Player Android Guide and Player iOS Guide, added a link to GitHub code and documentation for the new React Native wrapper.

January 27, 2022

Web Player CSP change

In "Hosting Assets on a Separate Origin," add information for Chrome.

January 25, 2022

Setting Up Private Channels

In "Token Schema," added information about support for multiple domains and wildcard domains in the access-control-allow-origin token-payload field.

January 24, 2022

Web Player 1.7.0 Release Notes

In the Release Notes, updated the bullet on setInitialBufferDuration() to say it does not work on iOS mobile browsers.

January 21, 2022

Player 1.7.0 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

January 20, 2022

R2S3 thumbnail configuration release

In Getting Started with Amazon IVS, we updated Step 3: Create a Channel with Optional Recording.

In Auto-Record to Amazon S3, we added a note to "Recording Contents" about modifying the thumbnails folder, added a new "Thumbnails" section, and changed the information about the thumbnails and path fields in "JSON Metadata Files."

January 18, 2022

Android Player Guide

In "Install the Library," deleted the jcenter() line, as JCenter is deprecated.

January 7, 2022

iOS Player

Added a "Known Issue" about the player crashing when testing against the arm64e architecture.

December 20, 2021

Broadcast SDK 1.2.0 release

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

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

Also see the Amazon IVS Release Notes for this release.

December 9, 2021

Using Amazon EventBridge with Amazon IVS

Expanded the descriptions of stream/session start/create/end events and added usage suggestions.

December 3, 2021

Streaming Configuration

For streaming from Android and iOS, replaced the information on Larix Broadcaster with a pointer to documentation on the Amazon IVS broadcast SDK.

November 24, 2021

Broadcasting: SDK for Android Guide

Added an issue for Android 5/6/7 devices, which can use only the system’s default microphone, hence cannot receive the broadcast SDK's onDeviceAdded and onDeviceRemoved callbacks for microphones.

November 24, 2021

Player 1.6 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

November 23, 2021

Amazon IVS Player

At the end of the introductory text, added a paragraph about casting support and a pointer to Amazon IVS Broadcast SDK documentation.

November 23, 2021

Monitoring Amazon IVS Live Stream Health

New User Guide page for new Amazon IVS functionality. For Stream Health, we also:

  • Updated the IAM policy in "Step 2: Set up IAM Permissions" of Getting Started with Amazon IVS: added three IVS permissions (GetStream, GetStreamSession, ListStreamSessions) and cloudwatch:GetMetricData.

  • Added four high-resolution metrics to Monitoring Amazon IVS with Amazon CloudWatch: IngestAudioBitrate, IngestFramerate, IngestVideoBitrate, and KeyframeInterval.

    Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

  • Added two events to Using Amazon EventBridge with Amazon IVS: Session Created and Session Ended.

November 18, 2021

Using Amazon EventBridge with Amazon IVS

Updated the description of the Recording Start event.

November 5, 2021

Broadcasting: SDK for iOS Guide

Add a "Known Issue" for AirPods connected to an iOS 12 device.

November 4, 2021

Stream with FFmpeg

In Streaming Configuration, clarified that FFmpeg can be used with many OSs/devices (not just Windows Desktop) and fixed the format of the example in the Webcam bullet.

November 3, 2021

Broadcast SDK (Android and iOS) 1.1.0 release

Updated version number and artifact links for the new release, in broadcast SDK guides: Android and iOS. In Android, there are new setPosition coordinates in "Create a Broadcast Configuration." In iOS, there is a new advanced use case ("Use Background Video"), slot-position changes in "Create a Broadcast Configuration," and a new "Known Issue."

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

Added a new page, Broadcasting: Mixer Guide, to the documentation for this feature.

Also see the Amazon IVS Release Notes for this release.

October 20, 2021

Setting Up Private Channels

In "Token Schema," updated access-control-allow-origin definition to refer to "origin" instead of "domain."

October 11, 2021

Android Player 1.5.1 release

Bug-fix release; see Amazon IVS Release Notes. Also updated version-number references in links and text in the Android Player Guide.

September 29, 2021

Player 1.5.0 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

September 28, 2021

Streaming Configuration

In "Audio Settings," specified a minimum bitrate, 96 Kbps.

September 22, 2021

Getting Started with Amazon IVS

In "Step 4: Set Up Streaming Software," added a note about disconnecting if no data is sent for 30 seconds.

September 20, 2021

Identity-based policy example

In Amazon IVS Security, fixed a typo in the example in Access an Amazon IVS Channel: added ending punctuation (}]}).

September 17, 2021

SDK sizes for Player 1.4.1 and 1.4.0

In the Release Notes for Player 1.4.1 and 1.4.0, we made corrections to the tables of mobile SDK sizes.

September 16, 2021

Player 1.4.1 release

Bug-fix release; see Amazon IVS Release Notes. Also updated version number and artifact links in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

In Streaming Configuration, updated the information on Closed Captioning.

September 8, 2021

Broadcasting: SDK for Android Guide

In "Set the ImagePreviewView for Preview," made minor text clarifications. In "Swap Cameras," fixed two typos. In "Create a Broadcast Configuration," deleted the line referencing video.setDefaultAspectMode, which is not usable now.

September 1, 2021

Streaming configuration with FFmpeg

Modified settings for capturing video files. Specifically, -g 120 was changed to -force_key_frames expr:gte(t,n_forced*2). This causes the encoder to insert a keyframe every 2 seconds, regardless of source-input frame rate.

August 23, 2021

Amazon IVS Player: SDK for Web Guide

Added new "Known Issue" for Pixel 4/4a mobile browsers.

August 20, 2021

Amazon IVS Player: Video.js Integration

In "Sample Code," updated the version number to 7.14.3. There is a security vulnerability in versions of Video.js earlier than 7.14.3.

August 19, 2021

Streaming Configuration

For the STANDARD channel type, added a note that audio is transcoded only for renditions 360p and below; above that, audio is passed through.

August 18, 2021

Getting Started with Amazon IVS

In "Step 2: Set Up IAM Permissions," added steps to attach the policy to an existing user. This new procedure is in addition to the old procedure, which is for creating a new user and attaching a policy to that user.

August 11, 2021

Player 1.4.0 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration.

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

Also see the Amazon IVS Release Notes for this release.

August 10, 2021

Amazon IVS Player: SDK for Web Guide

In "Setup With NPM," added a note about hosting player static assets from your own domain.

July 30, 2021

Getting Started with Amazon IVS

In "Step 2: Set Up IAM Permissions," updated policy information and instructions.

In "Step 3: Create a Channel with Optional Recording," added a section, "Auto-Record to S3" (to replace a prior paragraph).

In "Step 4: Set up Streaming Software," added a section, "Streaming with the Amazon IVS Broadcast SDK."

July 29, 2021

Auto-Record to S3

Added a new section, “Playback of Recorded Content from Private Buckets.” Also updated the introduction to this page.

July 28, 2021

Amazon IVS Broadcast SDK (Android and iOS)

Initial release of the broadcast SDK for Android and iOS. See the documentation under "Amazon IVS Broadcast SDK," a new section of the Amazon IVS documentation landing page.

July 27, 2021

Amazon IVS Player

Updated Desktop Browsers to indicate Amazon IVS Player 1.3.0 support for ultra-low latency on new versions of Safari for macOS.

July 14, 2021

Amazon IVS Service Quotas

For the PutMetadata endpoint, added a limit of 155 TPS per account.

June 29, 2021

ivs.rocks

On the Amazon IVS User Guide landing page, added a link to and brief description of ivs.rocks.

June 25, 2021

Player Browser & Platform Requirements

For the Amazon IVS Player, added links to sites listing the latest versions of supported browsers.

June 25, 2021

Streaming Configuration

In "Channel Types," updated definitions of channel types. For STANDARD channels, resolution can be up to 1080p; for BASIC channels, 480p. (The prior definitions were only in terms of vertical resolution.)

June 17, 2021

Costs

Added a new page on costs.

June 17, 2021

Amazon IVS Player: SDK for Android Guide

Added a new "Permissions" section.

June 17, 2021

Player mobile-browser support

In Mobile Browsers, added information about support for Chrome for iPadOS and Safari for iPadOS.

June 14, 2021

Player SDK size

Added a new "SDK Size" section to the Android and iOS Player SDK guides.

June 11, 2021

Amazon IVS Player: SDK for Web Guide

Added two "Known Issues" when playing content on an iOS mobile browser (with player.getQualities() and player.getLiveLatency() calls).

June 9, 2021

Supported regions and service endpoints

Replace lists of supported regions with a link to the Amazon IVS page in the AWS General Reference, which is updated automatically when support for new regions is added. Changes were made on the Monitoring Amazon IVS with Amazon CloudWatch page.

Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

June 8, 2021

Amazon IVS Player issues

In "Known Issues and Workarounds," for the Web, Android, and iOS Player, asked customers to report all issues to Support. Also added an issue with Android 11 emulators.

June 4, 2021

Android and iOS Player 1.3.3 release

Bug-fix release; see Amazon IVS Release Notes. Also updated version-number references in links and text in the Android Player Guide and iOS Player Guide.

The Amazon IVS documentation landing page always points to the most current versions of the Player SDK References.

June 1, 2021

Setting Up Private Channels

Updated "Generate and Sign Playback Tokens" (information on creating the signature and steps in "Instructions").

May 26, 2021

Global versus regional

Moved "Global Solution, Regional Control" from Getting Started with Amazon IVS to What Is Amazon IVS.

May 21, 2021

Amazon IVS Player: Video.js Integration

In "Sample Code," updated the Cloudflare version number from 7.6.6 to 7.11.4.

May 20, 2021

Android Player 1.3.2 release

Bug-fix release; see Amazon IVS Release Notes. Also updated version-number references in links and text in the Android Player Guide.

May 19, 2021

Amazon IVS Service Quotas

Minor wording changes. Deleted information about maximum number of tags; this was moved to the API Reference.

May 12, 2021

Amazon IVS Release Notes

Added a note for Web Player 1.3.1: the 1.3.0 NPM package exists but does not work.

May 11, 2021

Using Amazon EventBridge with Amazon IVS

Updated stream_id to be a "sanitized" value in all relevant examples.

May 10, 2021

Amazon IVS Player: SDK for Web Guide

Added a known issue and workaround, for player.seekTo() calls when playing recorded content on an iOS mobile browser.

May 10, 2021

Streaming Configuration

Renamed the Encoder Configuration page to Streaming Configuration.

May 6, 2021

Using Amazon EventBridge with Amazon IVS

In "Examples: Recording State Change," added the recording_duration_ms field, changed the example value of the recording_s3_key_prefix field, and changed the value of the recording_status_reason field.

May 5, 2021

Player 1.3 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration. For Android, added mavenCentral() to "Install the Library."

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

In Player 1.3.0 and later, timed metadata is now supported on Chrome and Safari for iOS. This is noted in the IVS Player SDK overview (table on "Mobile Browsers") and Embedding Metadata within a Video Stream (in "Consuming Metadata").

Also see the Amazon IVS Release Notes for this release.

May 5, 2021

Amazon IVS Service Quotas

Added a new section, "Service Quotas Integration with CloudWatch Usage Metrics."

April 26, 2021

Maximum duration of a stream

In Getting Started with Amazon IVS ("Step 4: Set Up Streaming Software"), added a note about the maximum duration of a stream, 48 hours.

April 23, 2021

IAM policy changes

Made several IAM policy changes:

April 22, 2021

New CloudWatch metrics

Various doc changes for the release of new CloudWatch metrics:

  • Monitoring Amazon IVS with Amazon CloudWatch — Added new metrics: concurrent views and concurrent streams.

    Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

  • Service Quotas – Updated the names of related quotas to match the new metrics.

  • Glossary – Added "view."

April 13, 2021

Auto-Record to S3

New User Guide page for this new Amazon IVS functionality. This also affects several existing documents:

  • Getting Started with Amazon IVS — Added IAM policy info for R2S3. Rewrote the step to create a channel. Added a paragraph on optionally enabling local recording in OBS Studio. New section on disabling recording.

  • Using Amazon EventBridge with Amazon IVS — Added Recording State Change events.

  • Monitoring Amazon IVS with Amazon CloudWatch — Added RecordedTime metric.

    Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

  • Amazon IVS Security — Added a section on "Using Service-Linked Roles (SLRs) for Amazon IVS."

  • Service Quotas — Added "API Call Rate Quotas" for the new recording-configuration endpoints and a "Resource Quotas" limit for recording configurations.

April 7, 2021

Amazon IVS Streaming Configuration

In "Closed Captioning," clarified that the Player SDKs support only 1 language, not multi-track captions playback.

March 29, 2021

Global versus regional

In What is Amazon IVS, added a new section, "Global Solution, Regional Control," to clarify what is global versus regional. In Getting Started with Amazon IVS, mentioned selecting a region, in the instructions for creating a channel.

March 25, 2021

EventBridge event latency & IDR/Keyframe encoder setting

Clarified the relationship between the IDR/Keyframe video-encoder setting and latency in some EventBridge events. This affects two documents:

March 25, 2021

Monitoring Amazon IVS with Amazon CloudWatch

Clarified how long CloudWatch retains data.

Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

March 18, 2021

Streaming Configuration

In "Audio Settings," changed the supported bitrate to 320 Kpbs (from 192).

March 15, 2021

Required versions of TLS

Clarified requirements for TLS (Transport Layer Security). For API calls, clients must support TLS 1.0 or later, but we recommend TLS 1.2 or later. For streaming/playback, TLS version 1.2 or later is required.

Changes were made in two documents: Streaming Configuration (section on "Stream Ingest: Codecs, RTMPS, and Port 443") and Security (section on "Infrastructure Security").

March 15, 2021

Amazon IVS Player: SDK for Web Guide

Added a known issue with HTML5 and setQuality().

March 15, 2021

Amazon IVS Player: SDK for Web Guide

Added a known issue with captions.

March 11, 2021

Amazon IVS Player

Added sections on "Thread Safety" in SDK for Android Guide and SDK for IOS Guide.

Also, for Android, noted that after the player.release() method is called, the player can no longer be used.

March 2, 2021

Monitoring Amazon IVS with Amazon CloudWatch

Updated the procedure for accessing Amazon IVS metrics using the CloudWatch console: added information on when "IVS" is listed and a screenshot.

Oct 12, 2023 update: This CloudWatch document was deleted and the content was moved to Monitoring IVS Low-Latency Streaming.

February 26, 2021

Security

In “Infrastructure Security,” added a note that Amazon IVS streaming requires TLS 1.2. Also listed a new web page for details on AWS global network security procedures.

February 17, 2021

Amazon IVS Player: JW Player Integration

New User Guide page on the JW Player plug-in for the Amazon IVS player. Also added a JW Player row to the Framework Integrations table in the Web Player Guide.

January 28, 2021

Using Amazon EventBridge with Amazon IVS

Expanded the wording about guarantees for sending events.

January 22, 2021

Using Amazon EventBridge with Amazon IVS

Added: Events are sent on a best-effort basis.

January 13, 2021

Streaming Configuration

Changed the codec audio setting from AAC to AAC (LC).

December 18, 2020

Amazon IVS Service Quotas

In "Resource Quotas," added the maximum number of tags for a resource.

December 17, 2020

Android Player 1.2.1 release

Bug-fix release; see Amazon IVS Release Notes. Also updated version-number references in links and text in the Android Player Guide.

December 16, 2020

Amazon IVS Release Notes

For Amazon IVS Android Player 1.2.0 and 1.1.0, added a known issue which causes the SDK to crash.

December 11, 2020

Getting Started with Amazon IVS

In bullet on playback URLs (in "Step 3: Create a Channel"), added a note that custom domains for playback are not supported.

December 4, 2020

Amazon IVS Release Notes

Deleted download links for iOS Player 1.0.6 and 1.0.0; these versions are deprecated.

Added a "Known Issue" for iOS Player 1.2.0.

December 4, 2020

Player 1.2.0 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, and Video.js Integration. Added a Known Issue to the Android guide.

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

Also see the updated Amazon IVS Release Notes.

November 23, 2020

Setting Up Private Channels

In the section on "Generate and Sign Playback Tokens," the channel-arn value in the JWT payload is a string.

November 18, 2020

Using Amazon EventBridge with Amazon IVS

Added stream_id field to many events. This is a unique stream identifier assigned each time a channel goes live. For a given channel, each live stream has a new stream_id. Stream IDs allow customers to distinguish different stream sessions on the same channel.

November 12, 2020

Embedding Metadata Within a Video Stream

Added new section on "Viewing Timed Metadata" from the Amazon IVS console.

November 9, 2020

Web Player Guide

Updated the section on "Content Security Policy," especially for hosting assets on a separate page when using Safari.

November 4, 2020

Service Quotas (CCV and CCB limits)

Added notes about the importance of ensuring adequate concurrent-viewer and concurrent-broadcaster limits, especially before large streaming events. See Getting Started with Amazon IVS and Amazon IVS Service Quotas.

November 4, 2020

Using Amazon EventBridge with Amazon IVS

Updated Limit Breach events: the detail section of the JSON blob uses limit_name for all these events. (Previously only Concurrent Broadcasts showed that and the others showed limit.)

October 28, 2020

Setting Up Private Channels

In the section on "Generate and Sign Playback Tokens,"noted that the exp (expiration) field in JWT payloads is an integer.

October 27, 2020

Amazon IVS Service Quotas

Increased three limits: number of channels, concurrent viewers, and concurrent broadcasts.

October 27, 2020

Web Player 1.1.2 release

Bug-fix release; see the Amazon IVS Release Notes. Version-number references in links and text were updated in the Web Player Guide and Video.js integration Guide.

October 9, 2020

Ingest resolution quotas & event

Added service quotas and EventBridge events for ingest resolution. See Amazon IVS Service Quotas and Using Amazon EventBridge with Amazon IVS.

October 9, 2020

Player 1.1.0 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, and Video.js Integration.

In the iOS and Web guides, added a new section on "Known Issues."

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

In the Amazon IVS Player overview, deleted the Android getSessionId function (which does not yet work).

October 7, 2020

Setting Up Private Channels

Added a new section, "Workflow for Private Channels." In the section on generating and signing tokens, clarified payload field descriptions and example. Corrected examples for listing and getting playback key pairs.

September 21, 2020

Using Amazon EventBridge with Amazon IVS

The channel_name field was added to several events.

September 14, 2020

Embedding Metadata Within a Video Stream

Expanded information on setting up IAM permissions (full procedure and policy), inserting metadata (added a CLI procedure), and consuming metadata (linked to several GitHub demos).

September 14, 2020

Player guides

Clarified which is the most current version of each player (Web, Android, iOS, and Video.js Integration).

September 9, 2020

Getting Started with Amazon IVS

Mentioned that there is a short delay before a new stream can be viewed in the console.

September 9, 2020

Amazon IVS Release Notes

Changed the Player iOS download link to be the same as what is in the Player iOS Guide.

September 9, 2020

Embedding Metadata within a Video Stream

Added link to relevant AWS blog posts.

September 3, 2020

Amazon IVS Player

Expanded the discussion of player features. Clarified that we can guarantee the performance of only the Amazon IVS player (not third-party players).

September 3, 2020

Amazon IVS Service Quotas

Corrected this to indicate that only the channels, concurrent viewers, and concurrent broadcasts quotas can be adjusted.

August 31, 2020

Streaming Configuration

Several changes, including adding Reducing Latency subsection on “Avoid Third-Party Streaming/Forwarding Services” and clarifying why we strongly recommend CBR over VBR.

August 24, 2020

Embedding Metadata within a Video Stream

Updated Web example in Consuming Timed Metadata.

August 24, 2020

Amazon IVS Player: SDK for Android Guide

Updated code example in Install the Library.

August 24, 2020

Using Amazon EventBridge with Amazon IVS

In the section on “Examples: Limit Breach,” updated several field names: limit_name, limit_value, exceeded_by, and limit_unit. These names include underscores (not dashes).

August 19, 2020

Setting Up Private Channels

New User Guide page on new Amazon IVS functionality, supporting private channels. This also affects several existing documents:

Getting Started with Amazon IVS and Logging Amazon IVS API Calls with AWS CloudTrail: Added authorized field to channel.

Security: Several changes including a new section on “Privileged and Unprivileged Access.”

Service Quotas: Added several playback quotas.

Glossary: Added playback key pair.

August 19, 2020

Getting Started with Amazon IVS

Added a new section on AWS Regional Service.

August 11, 2020

Amazon IVS Player: SDK for iOS Guide

Updated links to the reference documentation and framework download to point to the 1.0.6 release. Also updated reference-doc link on the Amazon IVS doc landing page.

August 11, 2020

Using Amazon EventBridge with Amazon IVS

Amazon IVS EventBridge events are now available through the Amazon EventBridge console. See the section on "Creating Amazon EventBridge Rules for Amazon IVS."

August 5, 2020

Amazon IVS Player: Video.js Integration

In the “Setup With NPM” section, updated the link to the Video.js npm package to install, to version 7.6.6.

July 30, 2020

Using Amazon EventBridge with Amazon IVS

For Amazon IVS stream-state and stream-health changes, the event name is provided in a field called event_name (not eventName, as previously documented).

July 29, 2020

Getting Started with Amazon IVS

Changed the instructions for setting up streaming software, to indicate that port 443 is required for Amazon IVS ingest. This also affects the Streaming Configuration document; see the new section on RTMPS and Port 443.

July 27, 2020

Amazon IVS Player: SDK for iOS Guide

Changed the download location of the latest version, in the instructions for installing the framework manually.

July 27, 2020

Embedding Metadata Within a Video Stream

Added Android and iOS examples of consuming timed metadata.

July 24, 2020

New service and User Guide

This is the initial release of Amazon Interactive Video Service (IVS).

July 15, 2020

IVS Low-Latency Streaming API Reference Changes

API Change Description Date

Remove svs from ARN patterns

ARN patterns which specified [is]vs were updated to specify ivs. This affects several endpoints (including all Tags endpoints) and the following objects: BatchError, BatchStartViewerSessionRevocationError, BatchStartViewerSessionRevocationViewerSession, Channel, ChannelSummary, PlaybackKeyPair, PlaybackKayPairSummary, Stream, StreamSummary, StreamKey, StreamKeySummary.

April 25, 2024

Secure Reliable Transport ingest support

We added the srt field to the Channel object. This affects six responses: BatchGetChannel, CreateChannel, GetChannel, UpdateChannel, and GetStreamSession.

April 4, 2024

Tokenless playback restrictions

  • Added a new resource, PlaybackRestrictionPolicy.

  • Added five PlaybackRestrictionPolicy(ies) endpoints (Create/Delete/Get/List/Update).

  • Added the PlaybackRestrictionPolicy and PlaybackRestrictionPolicySummary objects.

  • Added playbackRestrictionPolicyArn to the Channel and ChannelSummary objects. This affects Channel endpoint responses (Create/BatchGet/Get/List/Update).

  • In the ListChannel request, added filterByPlaybackRestrictionPolicyArn.

January 31, 2024

Channel-type definitions

Updated channel-type definitions to provide more detail, especially about rendered transcode ladders. See Channel Types in the IVS Low-Latency Streaming API Reference.

August 18, 2023

R2S3 rendition filtering and thumbnail enhancements

  • In ThumbnailConfiguration, added resolution and storage. This affects the CreateRecordingConfiguration request and response, GetRecordingConfiguration response, and GetStreamSession response.

  • In ThumbnailConfiguration, changed the targetIntervalSeconds minimum from 5 to 1 and updated the "Important" note to say it applies only to BASIC channels.

  • Added the RenditionConfiguration object.

  • Added renditionConfiguration to the RecordingConfiguration object. This affects three responses: CreateRecordingConfiguration, GetRecordingConfiguration, and GetStreamSession. We also added renditionConfiguration to the CreateRecordingConfiguration request.

July 17, 2023

Viewer session revocation for private channels

  • Added two endpoints: StartViewerSessionRevocation and BatchStartViewerSessionRevocation.

  • Added two objects: BatchStartViewerSessionRevocationError and BatchStartViewerSessionRevocationViewerSession.

June 28, 2023

Advanced channel types

  • Added new channel type values and definitions. This affects two requests (Create/UpdateChannel) and the Channel object.

  • Added the preset field to the Channel and ChannelSummary objects. This affects several requests (Create/UpdateChannel) and responses (BatchGetChannel, Create/Get/UpdateChannel, GetStreamSession, ListChannels).

  • Added type to the ChannelSummary object. This affects the ListChannels response.

June 2, 2023

RTMP support

Added the insecureIngest field to the Channel and ChannelSummary objects. This affects several requests and responses.

March 30, 2023

Stream state

In the Stream and StreamSummary objects, noted that the OFFLINE value of the state field should not be relied on. Instead, a "NotBroadcasting" error will indicate that the stream is not live.

February 8, 2023

Merge fragmented streams

Added the recordingReconnectWindowSeconds field to the CreateRecordingConfiguration request and the RecordingConfiguration object. This affects three responses (CreateRecordingConfiguration, GetRecordingConfiguration, and GetStreamSession.

August 30, 2022

Expand BASIC channel to 1080p

Updated channel type definitions in CreateChannel, UpdateChannel, and the Channel object.

August 16, 2022

Restrictions on tags

Updated information on tags restrictions. Amazon IVS has no constraints on tags beyond what is documented in the AWS documentation that we link to. This affects the "Welcome" section and several endpoints and data types.

August 12, 2022

Max and default values of maxResults

Updated the maximum and default values of maxResults to reflect the actual behavior of the system. Affects all List endpoints that use maxResults.

August 12, 2022

Timestamp fields

For ISO 8601 fields, added a note that these are returned as strings. Due to an auto-generation issue, these appear in our documented syntax as number.

March 28, 2022

API authorization

In "Authentication versus Authorization," clarify the bullet on authorization.

March 18, 2022

ARN encoding in tag endpoints

For the three tag endpoints, added a statement that the resourceArn field must be URL-encoded.

March 18, 2022

Audio/video configuration objects

Updated the definitions of the AudioConfiguration and VideoConfiguration data types, to indicate that they are used for monitoring. (Configuration is done in the broadcaster's encoder.)

February 17, 2022

R2S3 thumbnail configuration release

Added a new field (thumbnailConfiguration) in the RecordingConfiguration object. This in turn affects the CreateRecordingConfiguration request and response, GetRecordingConfiguration response, and GetStreamSession response.

Added a new object: ThumbnailConfiguration.

January 18, 2022

Stream Health release

Added 2 endpoints: GetStreamSession and ListStreamSessions.

Added 7 objects: AudioConfiguration, IngestConfiguration, StreamEvent, StreamFilters, StreamSession, StreamSessionSummary, and VideoConfiguration.

Added the streamID field to the Stream and StreamSummary objects. This in turn affects the GetStream and ListStreams responses.

Added the filtersBy field to the ListStreams request.

November 18, 2021

Format of time fields

Updated the description of startTime in the Stream and StreamSummary objects, to add that it's an ISO 8601 timestamp returned as a string.

September 21, 2021

STANDARD channel type

For the STANDARD channel type, added notes that audio is transcoded only for renditions 360p and below; above that, audio is passed through.

August 18, 2021

ListTagsForResource endpoint

Removed support for pagination; i.e., the maxResults request field and nextToken request/response field. (Pagination did not work correctly.)

August 13, 2021

PutMetadata TPS limit per account

For the PutMetadata endpoint, added a limit of 155 TPS per account.

June 29, 2021

Channel-type definitions

Updated the definitions of channel types. For STANDARD channels, resolution can be up to 1080p; for BASIC channels, 480p. (The prior definitions were only in terms of vertical resolution.)

June 17, 2021

Supported regions and service endpoints

Replace lists of supported regions with a link to the Amazon IVS page in the AWS General Reference, which is updated automatically when support for new regions is added. Changes were made on the "Welcome" page.

June 8, 2021

Tagging

In "Tagging" (in the "Welcome" section), added the maximum number of tags that can be applied to a resource (50).

May 12, 2021

New CloudWatch Metrics

Changed the definition of viewerCount in the Stream and StreamSummary objects.

April 13, 2021

Auto-Record to S3

  • Added 4 recording-configuration endpoints (Create, Delete, Get, List).

  • Add 4 data types (DestinationConfiguration, RecordingConfiguration, RecordingConfigurationSummary, S3DestinationConfiguration).

  • Added a RecordingConfigurationArn field to the Channel and ChannelSummary objects and channel endpoints.

  • Modified ListChannels to filter by recording-configuration ARN.

April 7, 2021

Authentication & authorization

  • Added an "Authentication versus Authorization" section to clarify the difference between these concepts.

  • Changed the description of the authorized field (in the Channel data type and channel endpoints), to: "Whether the channel is private (enabled for playback authorization)."

March 16, 2021

PutMetadata

Added a minimum length (1) for the metadata request field.

March 4, 2021

Channel latency mode

In Create/UpdateChannel and Channel/ChannelSummary objects, added a description of latencyMode values.

December 18, 2020

Channel default values

  • In Channel data type, add default value for authorized.

  • In Channel data type and CreateChannel, add default value for type.

December 17, 2020

All List endpoints

Indicated that the maxResults request field has a default value, 50.

December 5, 2020

Stream & StreamSummary objects

Changed the description of the viewerCount field to indicate that a value of -1 indicates that the request timed out; in this case, retry.

November 10, 2020

Authentication

Added Sigv4 signing info. See "Authentication" in the Welcome section.

October 9, 2020

DeleteChannel & DeleteStreamKey

Changed the HTTP response from 200 to 204. August 26, 2020
DeleteChannel Clarified how to delete a channel that's live, to avoid an error. August 20, 2020
Playback authorization (for private channels)
  • New PlaybackKeyPair endpoints

  • A new authorized field in the Channel and ChannelSummary objects

  • New objects, PlaybackKeyPair and PlaybackKeyPairSummary

August 19, 2020
New service and API Reference This is the initial release of Amazon Interactive Video Service (IVS). July 15, 2020

Stage API Reference Changes

API Change Description Date

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.

The Stage API Reference is part of IVS real-time streaming documentation, where it was renamed IVS Real-Time Streaming API Reference. We will list future updates to this API Reference in Document History (Real-Time Streaming), not here.

August 7, 2023

Stage Health

  • Added five endpoints: GetParticipant, ListParticipants, GetStageSession, ListStageSessions, ListParticipantEvents.

  • Added five objects: Event, Participant, ParticipantSummary, StageSession, StageSessionSummary.

May 11, 2023

New functionality

This is the initial release of the stage API. We added a Stage API Reference tile to the documentation landing page.

March 23, 2023

IVS Chat API Documentation Changes

API Change Description Date

New error message

Added the ConflictException error to UpdateLoggingConfiguration.

March 17, 2023

maximumMessageRatePerSecond max value

Changed the maximum value of maximumMessageRatePerSecond from 10 to 100. This affects the CreateRoom, GetRoom, and UpdateRoom endpoints.

January 30, 2023

Event (Subscribe) MessageID field

In the Chat Messaging API Reference, in Event (Subscribe), added a deprecated field (MessageID) to Attributes. This is included for backward compatibility.

January 25, 2023

New error type

Added the PendingVerification error for DeleteMessage, DisconnectUser, & SendEvent.

December 5, 2022

WebSocket errors

In the Chat Messaging API Reference, we updated descriptions of two WebSocket errors (Unauthorized & Forbidden).

November 18, 2022

Chat Logging

Initial release of this new functionality. We added the following:

  • A new resource, LoggingConfiguration

  • Five data types: CloudWatchDestinationConfiguration, DestinationConfiguration, KinesisDestinationConfiguration, LoggingConfigurationSummary, S3DestinationConfiguration

  • Five endpoints: Create/Delete/Get/List/UpdateLoggingConfiguration(s)

  • The loggingConfigurationIdentifiers field to the RoomSummary object and Room requests/responses

November 17, 2022

CreateChatToken description

Updated the description of CreateChatToken, including new guidance on using the attributes field.

November 17, 2022

Restrictions on tags

Updated information on tags restrictions. Amazon IVS Chat has no constraints on tags beyond what is documented in the AWS documentation that we link to. This affects the "Welcome" section, four endpoints (CreateRoom, ListTagsForResource, TagResource, UntagResource), and the RoomSummary data type.

August 12, 2022

New functionality

This is the initial release of Amazon IVS Chat. We added an Amazon IVS Chat section of the documentation landing page, with two API reference documents:

April 26, 2022