IvsRealtimePlatform class

Native IVS Real-Time stage controls (Android + iOS).

This class talks to the Amazon IVS Broadcast stage SDK over a method channel. It does not call AWS IAM or mint tokens by itself. Obtain a participant token first (typically from your backend); see join.

Constructors

IvsRealtimePlatform()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stageConnectionEvents Stream<Map<String, dynamic>>
Fired when the native stage session ends after having been connected (e.g. host ended the stream, or the server closed the session). Map includes at least event"disconnected". Some failures are surfaced here after SDK errors as well as the normal disconnected state.
no setter

Methods

join({required String token, required bool publish}) Future<void>
Joins the stage with Amazon's participant token, or leaves if already connected.
leave() Future<void>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
refreshStageBindings() Future<void>
Re-runs native Stage.refreshStrategy and rebinds the participant grid (e.g. after the platform view gets its first real layout).
setLocalStreamMuted({required bool micMuted, required bool cameraMuted}) Future<void>
Mute/unmute what you publish to the stage (host only; no-op if not publishing).
setPublish(bool enabled) Future<void>
setShowParticipantStateOverlay(bool visible) Future<void>
When false (default), native participant tiles show only the video preview (no publish/subscribe/mute/dB strip). Set to true for the previous demo-style overlay. Layout around the grid stays Flutter (Stack, buttons, etc.).
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited