AgoraPipOptions class
Configuration options for Agora picture-in-picture mode.
Since Available since v6.6.2. This class provides platform-specific options to configure picture-in-picture behavior on Android and iOS platforms.
Properties
- aspectRatioX → int?
-
Horizontal aspect ratio of the picture-in-picture window.
final
- aspectRatioY → int?
-
Vertical aspect ratio of the picture-in-picture window.
final
- autoEnterEnabled → bool?
-
Whether to automatically enter picture-in-picture mode.
final
- contentView ↔ int?
-
Identifier of the content view used for video rendering.
getter/setter pair
- contentViewLayout → AgoraPipContentViewLayout?
-
Layout configuration for picture-in-picture video streams.
final
- controlStyle → int?
-
Control style of the picture-in-picture window.
Available styles:
0: Show all system controls (default)
1: Hide forward and backward buttons
2: Hide play/pause button and progress bar (recommended)
3: Hide all system controls, including close and resume buttons (iOS only)
final
- externalStateMonitorInterval → int?
-
Interval for external state monitoring in milliseconds.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- preferredContentHeight → int?
-
Preferred height of the picture-in-picture content.
final
- preferredContentWidth → int?
-
Preferred width of the picture-in-picture content.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- seamlessResizeEnabled → bool?
-
Whether to enable seamless resizing of the picture-in-picture window.
final
- sourceContentView → int?
-
Identifier of the source content view.
final
- sourceRectHintBottom → int?
-
Bottom coordinate of the source rectangle hint.
final
- sourceRectHintLeft → int?
-
Left coordinate of the source rectangle hint.
final
- sourceRectHintRight → int?
-
Right coordinate of the source rectangle hint.
final
- sourceRectHintTop → int?
-
Top coordinate of the source rectangle hint.
final
- useExternalStateMonitor → bool?
-
Whether to use an external state monitor.
final
-
videoStreams
→ List<
AgoraPipVideoStream> ? -
Video transcoding configuration.
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