简介
AtomicLiveWidget 是纯播放 / 预览场景的轻量渲染容器,仅渲染视频(混流或单坐席)与业务挂件, 不提供麦位 / 连麦 / PK API。 将 AtomicLiveWidget 传给 AtomicPlayer.setView / AtomicPusher.setView 即可完成视频输出链路; 直播 ID 由播放器 / 推流器在绑定视图时设置,业务侧无需(也无法)自行设置。数据结构
AtomicLiveViewType
AtomicLiveView 的渲染类型。
枚举值 | 说明 |
playView | 播放视图,配合 AtomicPlayer 使用。 |
pushView | 推流视图,配合 AtomicPusher 使用。 |
UnitInfo
直播单元信息,描述渲染在 AtomicLiveView 上的单个坐席。
属性 | 类型 | 说明 |
index | Int | 单元索引。 |
liveID | String | 直播 ID。 |
userID | String | 用户 ID。 |
userName | String | 用户名称。 |
avatarURL | String | 头像 URL。 |
microphoneStatus | DeviceStatus | 麦克风状态。 |
cameraStatus | DeviceStatus | 摄像头状态。 |
userSuspendStatus | SuspendStatus | 用户挂起状态。 |
AtomicLiveViewChangeAdapter
AtomicLiveView 挂件适配器。业务侧通过实现该接口,按需为当前 AtomicLiveView 提供叠加层各类子 UI,并接收视频视图位置变化等回调。SDK 负责将其挂载到推流预览视图之上正确的层级,不影响底层渲染。create* 方法返回 nil 表示当前 View 不需要该类挂件。
方法
onCreateUnitView: 单元首次加入布局时构建坐席挂件视图;后续内容刷新请使用 onUpdateUnitView。
Widget? onCreateUnitView(UnitInfo unitInfo);
参数名 | 类型 | 说明 |
unitInfo | 直播单元信息。 |
onUpdateUnitView: 已挂件坐席的业务字段变化时更新其挂件视图。
void onUpdateUnitView(UnitInfo unitInfo, Widget? view);
参数名 | 类型 | 说明 |
unitInfo | 最新的直播单元信息。 | |
view | Widget? | onCreateUnitView 返回的原始挂件 Widget;尚未创建时为 null。可更新其 controller 或状态,它不是 SDK 的外层包装。 |
onVideoViewFrameChanged: 视频视图位置变化回调。当同房连麦坐席对应的视频视图位置 / 尺寸发生变化时由 SDK 触发,业务侧可据此同步调整叠加在其上的自定义挂件布局。位置以相对父容器的比例表示,取值范围 0, 1。
void onVideoViewFrameChanged(double left, double top, double right, double bottom);
参数名 | 类型 | 说明 |
left | double | 左上点距离左侧的比例。 |
top | double | 左上点距离上侧的比例。 |
right | double | 右下点距离左侧的比例。 |
bottom | double | 右下点距离上侧的比例。 |
onVolumeChanged: 说话音量变化回调。当麦上用户的说话音量发生变化时由 SDK 触发,播放侧来自流中携带的音量,推流侧来自本地采集与远端连麦用户的音量。仅当该用户的音量真正发生变化时才回调。
void onVolumeChanged(UnitInfo unitInfo, int volume, Widget? view);
参数名 | 类型 | 说明 |
unitInfo | 音量发生变化的麦位对应的直播单元信息。 | |
volume | int | 该用户最新的说话音量,取值范围 0 ~ 100。 |
view | Widget? | onCreateUnitView 返回的原始挂件 Widget;尚未创建时为 null。可更新其 controller 或状态,它不是 SDK 的外层包装。 |
AtomicLiveController
最小化原子直播视图的控制器,承载 AtomicLiveWidget / AtomicLiveView 的主动接口。直播 ID 由 AtomicPlayer / AtomicPusher 在绑定渲染视图时设置,控制器不对外提供设置直播 ID 的接口。
方法
create: 创建 AtomicLiveController。
static AtomicLiveController create(AtomicLiveViewType viewType) {return AtomicLiveControllerImpl(viewType);}
参数名 | 类型 | 说明 |
viewType | 直播视图渲染类型,播放或推流。 |
setViewChangeAdapter: 设置视图适配器,用于业务侧向当前视图上覆盖自定义挂件 UI(如美颜面板、静音 / 翻转等推流控制条、连麦坐席、开播倒计时等)。返回的视图会叠加在视频之上,不影响底层渲染。
void setViewChangeAdapter(AtomicLiveViewChangeAdapter adapter);
参数名 | 类型 | 说明 |
adapter | 视图适配器。 |