StreamingLayout class

Annotations

• @Freezed(unionKey: 'preset', unionValueCase: FreezedUnionCase.kebab)

Constructors

StreamingLayout.activeParticipant()

Focuses layout on the current active speaker and places up to 9 other cameras to the right in a vertical grid in the order in which they last spoke.

const

factory

StreamingLayout.custom({required String compositionId, Map<String, CompositionParamValue>? compositionParams, Map<String, String>? sessionAssets})

Allows for custom layouts.

const

factory

StreamingLayout.defaultLayout({int? maxCamStreams})

The default grid layout, which renders participants in a grid (or, in a vertical grid to the right, if a screen share is enabled).

const

factory

StreamingLayout.fromJson(Map<String, dynamic> json)

factory

StreamingLayout.portrait({PortraitVariant? variant, int? maxCamStreams})

A mobile-friendly portrait layout.

const

factory

StreamingLayout.singleParticipant({@JsonKey(name: 'sessionId') required ParticipantId participant})

Limits layout to a single specific participant.

const

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

map<TResult extends Object?>({required TResult defaultLayout(_DefaultLayout value), required TResult singleParticipant(_SingleParticipantLayout value), required TResult activeParticipant(_ActiveParticipantLayout value), required TResult portrait(_PortraitLayout value), required TResult custom(_CustomLayout value)}) → TResult

inherited

mapOrNull<TResult extends Object?>({TResult? defaultLayout(_DefaultLayout value)?, TResult? singleParticipant(_SingleParticipantLayout value)?, TResult? activeParticipant(_ActiveParticipantLayout value)?, TResult? portrait(_PortraitLayout value)?, TResult? custom(_CustomLayout value)?}) → TResult?

inherited

maybeMap<TResult extends Object?>({TResult defaultLayout(_DefaultLayout value)?, TResult singleParticipant(_SingleParticipantLayout value)?, TResult activeParticipant(_ActiveParticipantLayout value)?, TResult portrait(_PortraitLayout value)?, TResult custom(_CustomLayout value)?, required TResult orElse()}) → TResult

inherited

maybeWhen<TResult extends Object?>({TResult defaultLayout(int? maxCamStreams)?, TResult singleParticipant(ParticipantId participant)?, TResult activeParticipant()?, TResult portrait(PortraitVariant? variant, int? maxCamStreams)?, TResult custom(String compositionId, Map<String, CompositionParamValue>? compositionParams, Map<String, String>? sessionAssets)?, required TResult orElse()}) → TResult

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>({required TResult defaultLayout(int? maxCamStreams), required TResult singleParticipant(ParticipantId participant), required TResult activeParticipant(), required TResult portrait(PortraitVariant? variant, int? maxCamStreams), required TResult custom(String compositionId, Map<String, CompositionParamValue>? compositionParams, Map<String, String>? sessionAssets)}) → TResult

inherited

whenOrNull<TResult extends Object?>({TResult? defaultLayout(int? maxCamStreams)?, TResult? singleParticipant(ParticipantId participant)?, TResult? activeParticipant()?, TResult? portrait(PortraitVariant? variant, int? maxCamStreams)?, TResult? custom(String compositionId, Map<String, CompositionParamValue>? compositionParams, Map<String, String>? sessionAssets)?}) → TResult?

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited