AgoraPipOptions

声网画中画模式的配置选项。

TypeScript

export class AgoraPipOptions {
  autoEnterEnabled?: boolean;
  aspectRatioX?: number;
  aspectRatioY?: number;
  sourceRectHintLeft?: number;
  sourceRectHintTop?: number;
  sourceRectHintRight?: number;
  sourceRectHintBottom?: number;
  seamlessResizeEnabled?: boolean;
  useExternalStateMonitor?: boolean;
  externalStateMonitorInterval?: number;
  videoStreams?: RtcRendererViewProps[];
  contentViewLayout?: AgoraPipContentViewLayout;
  sourceContentView?: number;
  contentView?: number;
  preferredContentWidth?: number;
  preferredContentHeight?: number;
  controlStyle?: number;
}

自从

自 v4.6.2 版本新增。

该类提供平台特定的选项来配置 Android 和 iOS 平台的画中画行为。

autoEnterEnabled

是否自动进入画中画模式。

aspectRatioX

画中画窗口的水平宽高比。 仅适用于 Android 平台。

aspectRatioY

画中画窗口的垂直宽高比。 仅适用于 Android 平台。

sourceRectHintLeft

源矩形提示的左坐标。 用于指定画中画窗口的初始位置。 仅适用于 Android 平台。

sourceRectHintTop

源矩形提示的上坐标。 用于指定画中画窗口的初始位置。 仅适用于 Android 平台。

sourceRectHintRight

源矩形提示的右坐标。 用于指定画中画窗口的初始位置。 仅适用于 Android 平台。

sourceRectHintBottom

源矩形提示的下坐标。 用于指定画中画窗口的初始位置。 仅适用于 Android 平台。

seamlessResizeEnabled

是否启用画中画窗口的无缝调整大小。 启用后，画中画窗口将平滑调整大小。 默认为 false。 仅适用于 Android 平台。

useExternalStateMonitor

是否使用外部状态监控。 启用后，创建专用线程来监控画中画窗口状态。使用 externalStateMonitorInterval 配置监控频率。 默认为 true。 仅适用于 Android 平台。

externalStateMonitorInterval

外部状态监控的间隔，单位为毫秒。 仅在 useExternalStateMonitor 为 true 时生效。 默认为 100ms。 仅适用于 Android 平台。

videoStreams

视频转码配置。 仅在 contentView 设置为 0 时生效。当用户让 SDK 管理视图时，所有视频流将放置在画中画窗口的根视图中。 仅适用于 iOS 平台。

contentViewLayout

画中画视频流的布局配置。 仅在 contentView 设置为 0 时生效。 仅适用于 iOS 平台。

sourceContentView

sourceContentView 确定画中画动画的源帧和恢复目标。传递 0 以使用应用的根视图。为了获得最佳动画效果，请将此设置为包含视频内容的视图。系统使用此视图进行画中画进入/退出动画，并在返回应用或停止画中画时作为恢复目标。

contentView

contentView 确定将在画中画窗口中显示哪个视图。如果传递 0，画中画控制器将自动管理并显示所有视频流。如果传递特定的视图 ID，你需要负责管理画中画窗口中显示的内容。

preferredContentWidth

画中画内容的首选宽度。 仅适用于 iOS 平台。

preferredContentHeight

画中画内容的首选高度。 仅适用于 iOS 平台。

controlStyle

画中画窗口的控制样式。 可用样式：

• 0：显示所有系统控件（默认）
• 1：隐藏前进和后退按钮
• 2：隐藏播放/暂停按钮和进度条（推荐）
• 3：隐藏所有系统控件，包括关闭和恢复按钮

仅适用于 iOS 平台。