Skip to main content
New Architecture, Better Experience: The new Room-based livestreaming system replaces the legacy Stream feature, delivering significant improvements in video quality, latency, and interactive capabilities.

​
Why Upgrade?

The legacy Stream feature is being deprecated in favor of our new Room-based livestreaming system. Beyond the deprecation, there are compelling reasons to upgrade that will benefit both your development experience and your end users.

​
Enhanced Video Quality

Higher Resolutions

Up to 1080p Full HD
  • Support for HD (720p), and FHD (1080p)
  • Adaptive bitrate streaming for optimal quality
  • Professional-grade video encoding

Reduced Latency

Near Real-Time Streaming
  • Low-latency mode for interactive broadcasts
  • Faster viewer-to-broadcaster interaction

​
New Capabilities

Co-Streaming

Multi-Host BroadcastingThe flagship feature of the new Room system enables multiple broadcasters to stream together in a single session:
  • Invite co-hosts to join your broadcast
  • Accept invitations to join as a co-host
  • Real-time audio/video synchronization between hosts
  • Collaborative stream management

Live Viewer Count

Real-Time Audience InsightsKnow exactly how many people are watching:
  • Real-time viewer count updates
  • Who’s watching list to see active viewers

Comprehensive Analytics

Deep Insights into Viewer BehaviorUnlock powerful analytics to understand your audience:
  • Total views and unique viewer counts
  • Watch minutes tracking with accurate duration
  • Average and peak concurrent viewers
  • Per-stream engagement metrics

​
Migration Overview

The migration from Stream to Room is straightforward, with most changes being simple terminology updates. The new Room system maintains functional parity with the legacy Stream system while adding new capabilities.

​
Terminology Changes

Legacy (Stream)New (Room)Description
AmityStreamAmityRoomThe main livestream entity
AmityStreamRepositoryAmityRoomRepositoryRepository for stream operations
streamIdroomIdUnique identifier for the stream
dataType: 'stream'dataType: 'room'Post data type for livestream posts

​
SDK Migration

​
Repository Changes

Replace Stream repository calls with Room repository equivalents: 
// Legacy Stream
let streamRepository = AmityStreamRepository(client: client)
let stream = try await streamRepository.getStream(streamId: "stream-123")

// New Room
let roomRepository = AmityRoomRepository(client: client)
let room = try await roomRepository.getRoom(roomId: "room-123")

​
Creating Livestream Posts

When creating posts with livestream content, use roomId instead of streamId: 
// Legacy Stream Post
let post = try await postRepository.createLivestreamPost(
    targetType: .community,
    targetId: communityId,
)

// New Room Post
let post = try await postRepository.createRoomPost(
    targetType: .community,
    targetId: communityId,
)

​
Entity Property Mapping

Most properties map directly with name changes:
Legacy Stream PropertyNew Room Property
stream.streamIdroom.roomId
stream.titleroom.title
stream.descriptionroom.description
stream.statusroom.status

​
New Room-Only Features

The Room system introduces new capabilities not available in the legacy Stream. These features are ready to use once you migrate:
FeatureDescriptionDocumentation
Co-Host ManagementInvite co-hosts, accept invitations, manage participants during broadcastsCo-Host Guide
Live Viewer CountReal-time viewer count and who’s watching listLive Viewing
Watch AnalyticsAutomatic watch session tracking with accurate durationAnalytics

​
UIKit Migration

Zero Code Changes Required: If you’re using social.plus UIKit, upgrading is automatic. Simply update to the latest UIKit version and you’re done!

​
Automatic Migration

When you upgrade to the latest version of UIKit:
  1. New Livestream Creation: All new livestream posts will automatically use the Room-based system
  2. Legacy Support: Posts created with the legacy Stream system remain fully viewable
  3. Seamless Experience: Users won’t notice any difference—the UI remains the same

​
Open Source UIKit

If you’re using our open-source UIKit:
  1. Pull the latest changes from the repository
  2. The Room integration is included automatically
  3. All new livestream functionality is available out of the box

​
What’s Included Automatically

  • ✅ Room creation and broadcasting UI
  • ✅ Co-streaming interface and co-host management
  • ✅ Live viewer count display
  • ✅ Watch minutes analytics tracking
  • ✅ Backward compatibility with legacy Stream posts

​
Console Updates (Coming soon)

The Admin Console with dedicated Room management and a powerful analytics dashboard:

​
New Room Management Section

  • Dedicated Room Dashboard: Separate section for Room-based livestreams
  • Legacy Stream Section: Existing streams remain accessible in their original location
  • Enhanced Moderation Tools: Improved controls for Room-based broadcasts

​
Livestream Analytics Dashboard

The new analytics dashboard provides comprehensive insights into your livestream performance:
FeatureDescription
Overview MetricsTotal streams, views, unique viewers, and watch minutes with trend comparisons
Stream TableSortable list of all streams with key metrics (views, viewers, duration, engagement)
Stream Detail ViewDeep dive into individual stream performance with time-series charts
Viewership ChartsVisualize concurrent viewers throughout the stream duration
Engagement ChartsTrack chat messages and reactions over time

​
Key Console Features

FeatureDescription
Room ListView and manage all Room-based livestreams
Live MonitoringReal-time view of active broadcasts
Analytics DashboardView watch time and engagement metrics
Moderation ControlsTerminate streams, manage flagged content

​
Backward Compatibility

Legacy Content Preserved: All existing Stream-based posts and recordings remain accessible. Users can continue viewing legacy content without any issues.
  • Legacy Stream posts continue to work and display correctly
  • Recorded content from legacy streams remains playable
  • No data migration required for existing content
  • Gradual transition at your own paceBest Practices

​
Deprecation Timeline

The legacy Stream feature is deprecated and will be removed in the future. We recommend migrating to the Room-based system as soon as possible to take advantage of new features and continued support.
PhaseTimelineDetails
CurrentNowRoom-based streaming available, Stream deprecated
Maintenance Mode6 monthsStream receives security fixes only, no new features
End of SupportTBAStream feature will be removed

​
Need Help?

Room Documentation

Complete Room broadcasting documentation

Co-Host Guide

Learn about co-streaming capabilities

Developer Forum

Get help from the community