openharmony 鸿蒙 capi-oh-window-pip-h

2025-06-12 浏览 (1)

oh_window_pip.h

概述

定义画中画功能的相关接口，包含创建、删除画中画控制器，以及启动、停止画中画等。主要用于视频播放、直播、视频通话或视频会议场景下，以小窗（画中画）模式呈现内容。

引用文件： <window_manager/oh_window_pip.h>

库： libnative_window_manager.so

系统能力： SystemCapability.Window.SessionManager

起始版本： 20

相关模块： WindowManager

汇总

枚举

名称typedef关键字描述
PictureInPicture_PipTemplateTypePictureInPicture_PipTemplateType画中画模板类型。
PictureInPicture_PipControlGroupPictureInPicture_PipControlGroup画中画控制面板的控件组类型。
PictureInPicture_PipControlTypePictureInPicture_PipControlType控制面板控件类型枚举。
PictureInPicture_PipControlStatusPictureInPicture_PipControlStatus控制面板控件状态枚举。
PictureInPicture_PipStatePictureInPicture_PipState画中画生命周期状态枚举。

函数

名称typedef关键字描述
typedef void (*WebPipStartPipCallback)(uint32_t controllerId, uint8_t requestId, uint64_t surfaceId)WebPipStartPipCallback定义画中画窗口创建完成的回调函数。
typedef void (*WebPipLifecycleCallback)(uint32_t controllerId, PictureInPicture_PipState state, int32_t errcode)WebPipLifecycleCallback定义画中画窗口的生命周期回调函数。
typedef void (*WebPipControlEventCallback)(uint32_t controllerId, PictureInPicture_PipControlType controlType,PictureInPicture_PipControlStatus status)WebPipControlEventCallback定义画中画窗口的控件点击事件回调函数。
typedef void (*WebPipResizeCallback)(uint32_t controllerId, uint32_t width, uint32_t height, double scale)WebPipResizeCallback定义画中画窗口的尺寸变化回调函数。
int32_t OH_PictureInPicture_CreatePipConfig(PictureInPicture_PipConfig* pipConfig)-创建画中画参数配置器。
int32_t OH_PictureInPicture_DestroyPipConfig(PictureInPicture_PipConfig* pipConfig)-销毁画中画参数配置器。
int32_t OH_PictureInPicture_SetPipMainWindowId(PictureInPicture_PipConfig pipConfig, uint32_t mainWindowId)-设置拉起画中画的主窗口Id。
int32_t OH_PictureInPicture_SetPipTemplateType(PictureInPicture_PipConfig pipConfig,PictureInPicture_PipTemplateType pipTemplateType)-设置画中画模板类型，默认为视频播放。
int32_t OH_PictureInPicture_SetPipRect(PictureInPicture_PipConfig pipConfig, uint32_t width, uint32_t height)-设置画中画窗口大小，用于计算尺寸比例。
int32_t OH_PictureInPicture_SetPipControlGroup(PictureInPicture_PipConfig pipConfig,PictureInPicture_PipControlGroup* controlGroup, uint8_t controlGroupLength)-设置画中画控件组，需保证控件组与模板类型匹配。
int32_t OH_PictureInPicture_SetPipNapiEnv(PictureInPicture_PipConfig pipConfig, void* env)-设置拉起画中画的运行时环境。
int32_t OH_PictureInPicture_CreatePip(PictureInPicture_PipConfig pipConfig, uint32_t* controllerId)-创建画中画控制器。
int32_t OH_PictureInPicture_DeletePip(uint32_t controllerId)-删除画中画控制器。
int32_t OH_PictureInPicture_StartPip(uint32_t controllerId)-开启画中画。
int32_t OH_PictureInPicture_StopPip(uint32_t controllerId)-关闭画中画。
int32_t OH_PictureInPicture_UpdatePipContentSize(uint32_t controllerId, uint32_t width, uint32_t height)-当媒体源切换时，向画中画控制器更新媒体源尺寸信息。
int32_t OH_PictureInPicture_UpdatePipControlStatus(uint32_t controllerId, PictureInPicture_PipControlType controlType,PictureInPicture_PipControlStatus status)-更新画中画控制面板控件功能状态。
int32_t OH_PictureInPicture_SetPipControlEnabled(uint32_t controllerId, PictureInPicture_PipControlType controlType,bool enabled)-设置控制面板控件使能状态。
int32_t OH_PictureInPicture_RegisterStartPipCallback(uint32_t controllerId, WebPipStartPipCallback callback)-注册画中画窗口创建完成的回调函数。
int32_t OH_PictureInPicture_UnregisterStartPipCallback(uint32_t controllerId, WebPipStartPipCallback callback)-取消注册画中画窗口单个创建完成的回调函数。
int32_t OH_PictureInPicture_UnregisterAllStartPipCallbacks(uint32_t controllerId)-取消注册画中画窗口所有创建完成的回调函数。
int32_t OH_PictureInPicture_RegisterLifecycleListener(uint32_t controllerId, WebPipLifecycleCallback callback)-注册画中画窗口的生命周期回调函数。
int32_t OH_PictureInPicture_UnregisterLifecycleListener(uint32_t controllerId, WebPipLifecycleCallback callback)-取消注册画中画窗口的单个生命周期回调函数。
int32_t OH_PictureInPicture_UnregisterAllLifecycleListeners(uint32_t controllerId)-取消注册画中画窗口的所有生命周期回调函数。
int32_t OH_PictureInPicture_RegisterControlEventListener(uint32_t controllerId, WebPipControlEventCallback callback)-注册画中画窗口的控件点击事件回调函数。
int32_t OH_PictureInPicture_UnregisterControlEventListener(uint32_t controllerId, WebPipControlEventCallback callback)-取消注册画中画窗口的单个控件点击事件回调函数。
int32_t OH_PictureInPicture_UnregisterAllControlEventListeners(uint32_t controllerId)-取消注册画中画窗口的所有控件点击事件回调函数。
int32_t OH_PictureInPicture_RegisterResizeListener(uint32_t controllerId, WebPipResizeCallback callback)-注册画中画窗口尺寸变化的回调函数。
int32_t OH_PictureInPicture_UnregisterResizeListener(uint32_t controllerId, WebPipResizeCallback callback)-取消注册画中画窗口单个尺寸变化的回调函数。
int32_t OH_PictureInPicture_UnregisterAllResizeListeners(uint32_t controllerId)-取消注册画中画窗口所有尺寸变化的回调函数。

枚举类型说明

PictureInPicture_PipTemplateType

enum PictureInPicture_PipTemplateType

描述

画中画模板类型。

起始版本： 20

枚举项描述
VIDEO_PLAY = 0表示将要切换为画中画播放的媒体类型是视频，系统依此加载视频播放模板。
VIDEO_CALL = 1表示将要切换为画中画播放的媒体类型是视频通话，系统依此加载视频通话模板。
VIDEO_MEETING = 2表示将要切换为画中画播放的媒体类型是视频会议，系统依此加载视频会议模板。
VIDEO_LIVE = 3表示将要切换为画中画播放的媒体类型是直播，系统依此加载直播模板。

PictureInPicture_PipControlGroup

enum PictureInPicture_PipControlGroup

描述

画中画控制面板的控件组类型。

起始版本： 20

枚举项描述
VIDEO_PLAY_VIDEO_PREVIOUS_NEXT = 101视频播放模板的视频上一个/下一个控件组。与视频快进/后退控件组为互斥控件组。如添加视频快进/后退控件组，则不可添加该控件组。
VIDEO_PLAY_FAST_FORWARD_BACKWARD = 102视频播放模板的视频快进/后退控件组。与视频上一个/下一个控件组为互斥控件组。如添加视频上一个/下一个控件组，则不可添加该控件组。
VIDEO_CALL_MICROPHONE_SWITCH = 201视频通话模板的打开/关闭麦克风控件组。
VIDEO_CALL_HANG_UP_BUTTON = 202视频通话模板的挂断控件组。
VIDEO_CALL_CAMERA_SWITCH = 203视频通话模板的打开/关闭摄像头控件组。
VIDEO_CALL_MUTE_SWITCH = 204视频通话模板的静音控件组。
VIDEO_MEETING_HANG_UP_BUTTON = 301视频会议模板的挂断控件组。
VIDEO_MEETING_CAMERA_SWITCH = 302视频会议模板的打开/关闭摄像头控件组。
VIDEO_MEETING_MUTE_SWITCH = 303视频会议模板的静音控件组。
VIDEO_MEETING_MICROPHONE_SWITCH = 304视频会议模板的打开/关闭麦克风控件组。
VIDEO_LIVE_VIDEO_PLAY_PAUSE = 401直播模板的播放/暂停直播控件组。
VIDEO_LIVE_MUTE_SWITCH = 402直播模板的静音控件组。

PictureInPicture_PipControlType

enum PictureInPicture_PipControlType

描述

控制面板控件类型枚举。

起始版本： 20

枚举项描述
VIDEO_PLAY_PAUSE = 0播放/暂停控件。
VIDEO_PREVIOUS = 1视频上一个控件。
VIDEO_NEXT = 2视频下一个控件。
FAST_FORWARD = 3视频快进控件。
FAST_BACKWARD = 4视频快退控件。
HANG_UP_BUTTON = 5挂断控件。
MICROPHONE_SWITCH = 6打开/关闭麦克风控件。
CAMERA_SWITCH = 7打开/关闭摄像头控件。
MUTE_SWITCH = 8打开/关闭静音控件。

PictureInPicture_PipControlStatus

enum PictureInPicture_PipControlStatus

描述

控制面板控件状态枚举。

起始版本： 20

枚举项描述
PLAY = 1视频播放状态。
PAUSE = 0视频暂停状态。
OPEN = 1摄像头/麦克风/静音控件的打开状态。
CLOSE = 0摄像头/麦克风/静音控件的关闭状态。

PictureInPicture_PipState

enum PictureInPicture_PipState

描述

画中画生命周期状态枚举。

起始版本： 20

枚举项描述
ABOUT_TO_START = 1表示画中画将要启动。
STARTED = 2表示画中画已经启动。
ABOUT_TO_STOP = 3表示画中画将要停止。
STOPPED = 4表示画中画已经停止。
ABOUT_TO_RESTORE = 5表示画中画将从小窗播放恢复到原始播放界面。
ERROR = 6表示画中画生命周期执行过程出现了异常。

函数说明

WebPipStartPipCallback()

typedef void (*WebPipStartPipCallback)(uint32_t controllerId, uint8_t requestId, uint64_t surfaceId)

描述

定义画中画窗口创建完成的回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
uint8_t requestId请求Id，表示当前请求拉起画中画窗口的次数。
uint64_t surfaceId画中画内部Xcomponent组件的surfaceId，用于应用自行渲染。

WebPipLifecycleCallback()

typedef void (*WebPipLifecycleCallback)(uint32_t controllerId, PictureInPicture_PipState state, int32_t errcode)

描述

定义画中画窗口的生命周期回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
PictureInPicture_PipState state当前画中画生命周期状态。
int32_t errcode画中画接口的通用状态码。具体可见WindowManager_ErrorCode。

WebPipControlEventCallback()

typedef void (*WebPipControlEventCallback)(uint32_t controllerId, PictureInPicture_PipControlType controlType, PictureInPicture_PipControlStatus status)

描述

定义画中画窗口的控件点击事件回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
PictureInPicture_PipControlType controlType画中画控制面板的控件类型。
PictureInPicture_PipControlStatus status画中画控制面板的控件状态。

WebPipResizeCallback()

typedef void (*WebPipResizeCallback)(uint32_t controllerId, uint32_t width, uint32_t height, double scale)

描述

定义画中画窗口的尺寸变化回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
uint32_t width画中画窗口宽度，单位为px，该参数为正整数，不大于屏幕宽。
uint32_t height画中画窗口高度，单位为px，该参数为正整数，不大于屏幕高。
double scale画中画窗口缩放比，显示大小相对于width和height的缩放比，该参数为浮点数，取值范围大于0.0，小于等于1.0。等于1表示画中画窗口的实际显示宽高值与width和height一样大。

OH_PictureInPicture_CreatePipConfig()

int32_t OH_PictureInPicture_CreatePipConfig(PictureInPicture_PipConfig* pipConfig)

描述

创建画中画参数配置器。

起始版本： 20

参数：

参数项描述
PictureInPicture_PipConfig* pipConfig用于接受创建的画中画参数配置器。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。

OH_PictureInPicture_DestroyPipConfig()

int32_t OH_PictureInPicture_DestroyPipConfig(PictureInPicture_PipConfig* pipConfig)

描述

销毁画中画参数配置器。

起始版本： 20

参数：

参数项描述
PictureInPicture_PipConfig* pipConfig画中画参数配置器。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。

OH_PictureInPicture_SetPipMainWindowId()

int32_t OH_PictureInPicture_SetPipMainWindowId(PictureInPicture_PipConfig pipConfig, uint32_t mainWindowId)

描述

设置拉起画中画的主窗口Id。

起始版本： 20

参数：

参数项描述
PictureInPicture_PipConfig pipConfig画中画参数配置器。
uint32_t mainWindowId拉起画中画的主窗口Id。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。

OH_PictureInPicture_SetPipTemplateType()

int32_t OH_PictureInPicture_SetPipTemplateType(PictureInPicture_PipConfig pipConfig, PictureInPicture_PipTemplateType pipTemplateType)

描述

设置画中画模板类型，默认为视频播放。

起始版本： 20

参数：

参数项描述
PictureInPicture_PipConfig pipConfig画中画参数配置器。
PictureInPicture_PipTemplateType pipTemplateType画中画模板类型。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。

OH_PictureInPicture_SetPipRect()

int32_t OH_PictureInPicture_SetPipRect(PictureInPicture_PipConfig pipConfig, uint32_t width, uint32_t height)

描述

设置画中画窗口大小，用于计算尺寸比例。

起始版本： 20

参数：

参数项描述
PictureInPicture_PipConfig pipConfig画中画参数配置器。
uint32_t width原始内容宽度，单位为px，该参数应为正整数。用于确定画中画窗口比例。
uint32_t height原始内容高度，单位为px，该参数应为正整数。用于确定画中画窗口比例。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。

OH_PictureInPicture_SetPipControlGroup()

int32_t OH_PictureInPicture_SetPipControlGroup(PictureInPicture_PipConfig pipConfig, PictureInPicture_PipControlGroup* controlGroup, uint8_t controlGroupLength)

描述

设置画中画控件组，需保证控件组与模板类型匹配。

起始版本： 20

参数：

参数项描述
PictureInPicture_PipConfig pipConfig画中画参数配置器。
PictureInPicture_PipControlGroup* controlGroup画中画控制面板的可选控件组列表，应用可以对此进行配置以决定是否显示。应用未配置时，面板显示基础控件（如视频播放控件组的播放/暂停控件）；应用选择配置时，则最多可以选择三个控件。
uint8_t controlGroupLength画中画控件组数量，取值范围为0 ~ 3。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。

OH_PictureInPicture_SetPipNapiEnv()

int32_t OH_PictureInPicture_SetPipNapiEnv(PictureInPicture_PipConfig pipConfig, void* env)

描述

设置拉起画中画的运行时环境。

起始版本： 20

参数：

参数项描述
PictureInPicture_PipConfig pipConfig画中画参数配置器。
void* envnapi的环境指针。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。

OH_PictureInPicture_CreatePip()

int32_t OH_PictureInPicture_CreatePip(PictureInPicture_PipConfig pipConfig, uint32_t* controllerId)

描述

创建画中画控制器。

起始版本： 20

参数：

参数项描述
PictureInPicture_PipConfig pipConfig画中画参数配置器。
uint32_t* controllerId用于接收创建画中画控制器的id。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_DeletePip()

int32_t OH_PictureInPicture_DeletePip(uint32_t controllerId)

描述

删除画中画控制器。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。

OH_PictureInPicture_StartPip()

int32_t OH_PictureInPicture_StartPip(uint32_t controllerId)

描述

开启画中画。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_PIP_STATE_ABNORMAL，表示画中画窗口状态异常。
返回WINDOW_MANAGER_ERRORCODE_PIP_CREATE_FAILED，表示画中画窗口创建失败。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。
返回WINDOW_MANAGER_ERRORCODE_PIP_REPEAT_OPERATION，表示画中画窗口重复操作。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。

OH_PictureInPicture_StopPip()

int32_t OH_PictureInPicture_StopPip(uint32_t controllerId)

描述

关闭画中画。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_PIP_DESTROY_FAILED，表示画中画窗口销毁失败。
返回WINDOW_MANAGER_ERRORCODE_PIP_STATE_ABNORMAL，表示画中画窗口状态异常。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。
返回WINDOW_MANAGER_ERRORCODE_PIP_REPEAT_OPERATION，表示画中画窗口重复操作。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。

OH_PictureInPicture_UpdatePipContentSize()

int32_t OH_PictureInPicture_UpdatePipContentSize(uint32_t controllerId, uint32_t width, uint32_t height)

描述

当媒体源切换时，向画中画控制器更新媒体源尺寸信息。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
uint32_t width表示媒体内容宽度，单位为px，该参数应为正整数。用于更新画中画窗口比例。
uint32_t height表示媒体内容高度，单位为px，该参数应为正整数。用于更新画中画窗口比例。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_UpdatePipControlStatus()

int32_t OH_PictureInPicture_UpdatePipControlStatus(uint32_t controllerId, PictureInPicture_PipControlType controlType, PictureInPicture_PipControlStatus status)

描述

更新画中画控制面板控件功能状态。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
PictureInPicture_PipControlType controlType表示画中画控制面板控件类型。目前仅支持VIDEO_PLAY_PAUSE、MICROPHONE_SWITCH、CAMERA_SWITCH和MUTE_SWITCH这几种控件类型，传入其他控件类型无效。
PictureInPicture_PipControlStatus status表示画中画控制面板控件状态。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_SetPipControlEnabled()

int32_t OH_PictureInPicture_SetPipControlEnabled(uint32_t controllerId, PictureInPicture_PipControlType controlType, bool enabled)

描述

设置控制面板控件使能状态。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
PictureInPicture_PipControlType controlType表示画中画控制面板控件类型。
bool enabled表示画中画控制面板控件使能状态。true表示控件为可使用状态，false则为禁用状态。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_RegisterStartPipCallback()

int32_t OH_PictureInPicture_RegisterStartPipCallback(uint32_t controllerId, WebPipStartPipCallback callback)

描述

注册画中画窗口创建完成的回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
WebPipStartPipCallback callback画中画窗口创建完成的回调函数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_UnregisterStartPipCallback()

int32_t OH_PictureInPicture_UnregisterStartPipCallback(uint32_t controllerId, WebPipStartPipCallback callback)

描述

取消注册画中画窗口单个创建完成的回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
WebPipStartPipCallback callback画中画窗口创建完成的回调函数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_UnregisterAllStartPipCallbacks()

int32_t OH_PictureInPicture_UnregisterAllStartPipCallbacks(uint32_t controllerId)

描述

取消注册画中画窗口所有创建完成的回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_RegisterLifecycleListener()

int32_t OH_PictureInPicture_RegisterLifecycleListener(uint32_t controllerId, WebPipLifecycleCallback callback)

描述

注册画中画窗口的生命周期回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
WebPipLifecycleCallback callback画中画窗口的生命周期回调函数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_UnregisterLifecycleListener()

int32_t OH_PictureInPicture_UnregisterLifecycleListener(uint32_t controllerId, WebPipLifecycleCallback callback)

描述

取消注册画中画窗口的单个生命周期回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
WebPipLifecycleCallback callback画中画窗口的生命周期回调函数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_UnregisterAllLifecycleListeners()

int32_t OH_PictureInPicture_UnregisterAllLifecycleListeners(uint32_t controllerId)

描述

取消注册画中画窗口的所有生命周期回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_RegisterControlEventListener()

int32_t OH_PictureInPicture_RegisterControlEventListener(uint32_t controllerId, WebPipControlEventCallback callback)

描述

注册画中画窗口的控件点击事件回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
WebPipControlEventCallback callback画中画窗口的控件点击事件回调函数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_UnregisterControlEventListener()

int32_t OH_PictureInPicture_UnregisterControlEventListener(uint32_t controllerId, WebPipControlEventCallback callback)

描述

取消注册画中画窗口的单个控件点击事件回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
WebPipControlEventCallback callback画中画窗口的控件点击事件回调函数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_UnregisterAllControlEventListeners()

int32_t OH_PictureInPicture_UnregisterAllControlEventListeners(uint32_t controllerId)

描述

取消注册画中画窗口的所有控件点击事件回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_RegisterResizeListener()

int32_t OH_PictureInPicture_RegisterResizeListener(uint32_t controllerId, WebPipResizeCallback callback)

描述

注册画中画窗口尺寸变化的回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
WebPipResizeCallback callback画中画窗口尺寸变化的回调函数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_UnregisterResizeListener()

int32_t OH_PictureInPicture_UnregisterResizeListener(uint32_t controllerId, WebPipResizeCallback callback)

描述

取消注册画中画窗口单个尺寸变化的回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。
WebPipResizeCallback callback画中画窗口尺寸变化的回调函数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

OH_PictureInPicture_UnregisterAllResizeListeners()

int32_t OH_PictureInPicture_UnregisterAllResizeListeners(uint32_t controllerId)

描述

取消注册画中画窗口所有尺寸变化的回调函数。

起始版本： 20

参数：

参数项描述
uint32_t controllerId画中画控制器Id，为非负整数。

返回：

类型说明
int32_t返回结果代码。
返回OK，表示函数调用成功。
返回WINDOW_MANAGER_ERRORCODE_INCORRECT_PARAM，表示参数错误。
返回WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED，表示设备不支持画中画。
返回WINDOW_MANAGER_ERRORCODE_ERRORCODE_PIP_INTERNAL_ERROR，表示画中画内部错误。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkUI（方舟UI框架）

harmony 鸿蒙ARKUI_TextPickerCascadeRangeContent

harmony 鸿蒙ARKUI_TextPickerRangeContent

harmony 鸿蒙ArkUI_AnimateCompleteCallback

harmony 鸿蒙ArkUI_AttributeItem

harmony 鸿蒙ArkUI_ColorStop

harmony 鸿蒙ArkUI_ContextCallback

harmony 鸿蒙ArkUI_EventModule

harmony 鸿蒙ArkUI_ExpectedFrameRateRange

harmony 鸿蒙ArkUI_IntOffset

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/4z0PoQ