AgoraPipOptions class

Configuration options for Agora Picture-in-Picture (PiP) mode.

This class provides platform-specific options to configure PiP behavior for both Android and iOS platforms.

Constructors

AgoraPipOptions.new({bool? autoEnterEnabled, int? aspectRatioX, int? aspectRatioY, int? sourceRectHintLeft, int? sourceRectHintTop, int? sourceRectHintRight, int? sourceRectHintBottom, bool? seamlessResizeEnabled, bool? useExternalStateMonitor, int? externalStateMonitorInterval, int? sourceContentView, int? contentView, List<AgoraPipVideoStream>? videoStreams, AgoraPipContentViewLayout? contentViewLayout, int? preferredContentWidth, int? preferredContentHeight, int? controlStyle})

Creates an AgoraPipOptions instance.

Properties

aspectRatioX → int?

The horizontal aspect ratio of the PiP window.

final

aspectRatioY → int?

The vertical aspect ratio of the PiP window.

final

autoEnterEnabled → bool?

Whether to automatically enter PiP mode.

final

contentView ↔ int?

The content view identifier for video rendering.

getter/setter pair

contentViewLayout → AgoraPipContentViewLayout?

Layout configuration for PiP video streams.

final

controlStyle → int?

The control style for the PiP window.

final

externalStateMonitorInterval → int?

The interval for external state monitoring in milliseconds.

final

hashCode → int

The hash code for this object.

no setter, inherited

preferredContentHeight → int?

The preferred height of the PiP content.

final

preferredContentWidth → int?

The preferred width of the PiP content.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

seamlessResizeEnabled → bool?

Whether to enable seamless resize for the PiP window.

final

sourceContentView → int?

The source content view identifier.

final

sourceRectHintBottom → int?

The bottom coordinate of the source rectangle hint.

final

sourceRectHintLeft → int?

The left coordinate of the source rectangle hint.

final

sourceRectHintRight → int?

The right coordinate of the source rectangle hint.

final

sourceRectHintTop → int?

The top coordinate of the source rectangle hint.

final

useExternalStateMonitor → bool?

Whether to use external state monitoring.

final

videoStreams → List<AgoraPipVideoStream>?

Configuration for video transcoding.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited