API General overview

1. Basics

Name	Function explaination	Versions	Remarks
pz.env	Environmental variables	1.0.0
pz.canIUse	Determine whether the phizclip's APIs, callbacks, parameters, components, etc are available in the current version	1.0.0
pz.base64ToArrayBuffer	will Base64 String ArrayBuffer object	1.0.0
pz.arrayBufferToBase64	will ArrayBuffer Object converted to Base64 Character string	1.0.0
pz.base64ToTempFilePath	Save the base64 data of the image to the local sandbox and return the local cache path	1.0.0
pz.fileToBase64	will file converted to Base64 Character string	1.0.0

1.1 system

Name	Function explaination	Versions	Remarks
pz.getSystemInfoSync	pz.getSystemInfo The synchronous version of	1.0.0
pz.getSystemInfoAsync	Asynchronous access system information	1.0.0
pz.getSystemInfo	Access to system information	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.openAppAuthorizeSetting	Jump to the Phiz authorization management page
pz.openSystemBluetoothSetting	Jump to the Bluetooth Settings page of the system
pz.getWindowInfo	Get window information
pz.getSystemSetting	Get device Settings
pz.getSkylineInfoSync	The synchronous version of pz.getSkylineInfo
pz.getSkylineInfo	Gets the current runtime's support for the Skyline rendering engine
pz.getDeviceInfo	Get basic device information

1.2 To update

Name	Function explaination	Versions	Remarks
pz.getUpdateManager	ObtainGlobally uniqueVersion Update Manager for managing phizclip updates	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.updateWeChatApp	Update the client version

1.2.1 UpdateManager

Name	Function explaination	Versions	Remarks
UpdateManager.applyUpdate	Force the phizclip to restart and use the new version.	1.0.0
UpdateManager.onCheckForUpdate	Monitor the Phiz background request to check the update results event.	1.0.0
UpdateManager.onUpdateFailed	Listen for phizclip to update failed events	1.0.0
UpdateManager.onUpdateReady	Listening phizclip has a version update event.	1.0.0

1.3 phizclip

1.3.1 Life cycle

Name	Function explaination	Versions	Remarks
pz.getLaunchOptionsSync	Get the parameters of the phizclip startup	1.0.0
pz.getEnterOptionsSync	Get the parameters at the start of the phizclip	1.0.0

1.3.2 Application-level event

Name	Function explaination	Versions	Remarks
pz.onPageNotFound	There are no events on the page to be opened by the listening phizclip	1.0.0
pz.onError	Listening for phizclip error events	1.0.0
pz.onAppShow	Listen to phizclip cut foreground event	1.0.0
pz.onAppHide	Listen to phizclip cut background event	1.0.0
pz.offPageNotFound	The page to be opened by the unlisten phizclip does not have an event	1.0.0
pz.offError	Cancel listening phizclip error event	1.0.0
pz.offAppShow	Cancel the monitor phizclip to cut the foreground event	1.0.0
pz.offAppHide	Cancel listening phizclip to cut background event	1.0.0
pz.onThemeChange	Listen for system theme change events.	1.0.0
pz.onUnhandledRejection	Listening for unhandled Promise Reject event.	1.0.0
pz.offUnhandledRejection	Unlisten unprocessed Promise Reject event	1.0.0
pz.offThemeChange	Unlisten System Theme Change Event	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.onAudioInterruptionEnd	Listen to Audio Interrupt End Event
pz.onAudioInterruptionBegin	Listen for audio was interrupted due to system occupancy
pz.offAudioInterruptionEnd	Cancel Listening Audio Interrupt End Event
pz.offAudioInterruptionBegin	Cancel listening audio is interrupted due to system occupation Start event
pz.onLazyLoadError	Listen for application asynchronous component load failure callback
pz.offLazyLoadError	Cancels the callback to listen for application asynchronous component loading failure

1.4 debugging

Name	Function explaination	Versions	Remarks
pz.setEnableDebug	Set whether to turn on the debug switch	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.getRealtimeLogManager	Get the real-time log manager object
pz.getLogManager	Get the log manager object

1.4.1 console

Name	Function explaination	Versions	Remarks
console.debug	Print debug logs to the debug panel	1.0.0
console.error	Prints an error log to the debug panel	1.0.0
console.group	Create a new group in the debug panel	1.0.0
console.groupEnd	End The group created by console.group	1.0.0
console.info	Prints the info log to the debug panel	1.0.0
console.log	Print log logs to the debug panel	1.0.0
console.warn	Print a warn log to the debug panel	1.0.0

1.4.2 LogManager

Name	Function explaination	Versions	Remarks
LogManager.debug	write debug journal	Yes, but the log is only on the local console	3.0.36
LogManager.info	write info journal	Yes, but the log is only on the local console	3.0.36
LogManager.log	write log journal	Yes, but the log is only on the local console	3.0.36
LogManager.warn	write warn journal	Yes, but the log is only on the local console	3.0.36

1.4.3 RealtimeLogManager

Name	Function explaination	Versions	Remarks
RealtimeLogManager.error	write error Log	Yes, but the log is only on the local console	3.0.36
RealtimeLogManager.info	write info Log	Yes, but the log is only on the local console	3.0.36
RealtimeLogManager.warn	write warn Log	Yes, but the log is only on the local console	3.0.36
RealtimeLogManager.setFilterMsg	Set filter keywords	Yes, but the log is only on the local console	3.0.36
RealtimeLogManager.addFilterMsg	Add filter keywords	Yes, but the log is only on the local console	3.0.36

Please note

The following APIs are not supported at this time

Name	Function explaination
RealtimeLogManager.getCurrentState	Real-time logs aggregate cached logs for a certain time interval, and if the cached content exceeds the limit, it is discarded.
RealtimeLogManager.in	Set the page where the real-time log page parameter is located
RealtimeLogManager.tag	Gets an instance of the log manager for the given tag

1.4.4 RealtimeTagLogManager

Please note

The following APIs are not supported at this time

Name	Function explaination
RealtimeTagLogManager.info	write info Log
RealtimeTagLogManager.warn	write warn Log
RealtimeTagLogManager.error	write error Log
RealtimeTagLogManager.insetFilterMsgfo	Set filter keywords
RealtimeTagLogManager.addFilterMsg	Add filter keywords

1.5 performance

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.getPerformance	Get information about the current phizclip performance
pz.reportPerformance	phizclip speed reporting
pz.preloadWebview	Preload the WebView for the next page
pz.preloadSkylineView	Preload the Skyline runtime environment required for the next page
pz.preloadAssets	Preload the media resource files for the view layer

1.5.1 EntryList

Please note

The following APIs are not supported at this time

Name	Function explaination
EntryList.getEntries	This method returns all performance data in the current list
EntryList.getEntriesByType	Gets all the types in the current list [entryType] Performance data
EntryList.getEntriesByName	Gets all the names in the current list [name] And the type is [entryType] Performance data

1.5.2 Performance

Please note

The following APIs are not supported at this time

Name	Function explaination
Performance.getEntries	This method returns all the performance data in the current buffer
Performance.getEntriesByType	Gets all of the types in the current buffer [entryType] Performance data
Performance.getEntriesByName	Gets all names in the current buffer as [name] And the type is [entryType] Performance data
Performance.createObserver	Create a global performance event listener
Performance.setBufferSize	Set the buffer size, Default buffer 30 Bar Performance Data
PerformanceEntry	Single piece of performance data

1.5.3 PerformanceObserver

Please note

The following APIs are not supported at this time

Name	Function explaination
PerformanceObserver.disconnect	Stop listening.
PerformanceObserver.observe	Start listening

1.6 Subcontract loading

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.preDownloadSubpackage	Trigger subcontract pre-download

1.6.1 PreDownloadSubpackageTask

Please note

The following APIs are not supported at this time

Name	Function explaination
PreDownloadSubpackageTask.onProgressUpdate	Listen for subcontract load schedule change events

1.7 encryption

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.getUserCryptoManager	Get user encryption module

1.7.1 UserCryptoManager

Please note

The following APIs are not supported at this time

Name	Function explaination
UserCryptoManager.getLatestUserKey	Get the latest user encryption key
UserCryptoManager.getRandomValues	Gets a cryptographic secure random number

2. routing

Name	Function explaination	Versions	Remarks
pz.switchTab	Jump to tabBar Page, and close all other non - tabBar page	1.0.0
pz.reLaunch	Close all pages and open to a page in the app	1.0.0
pz.redirectTo	Close the current page and jump to a page in the app	1.0.0
pz.navigateTo	Keep the current page and jump to a page within the app	1.0.0
pz.navigateBack	Close the current page and return to the previous page or multilevel page	1.0.0

2.1 EventChannel

Name	Function explaination	Versions	Remarks
EventChannel.emit	Trigger an event	1.0.0
EventChannel.off	Cancel listening for an event	1.0.0
EventChannel.on	Continue to monitor an event	1.0.0
EventChannel.once	listen for an event at a time, when triggered	1.0.0

3. Jump

Name	Function explaination	Versions	Remarks
pz.navigateToMiniProgram	Open another little program	1.0.0
pz.navigateBackMiniProgram	Return to previous phizclip	1.0.0
pz.exitMiniProgram	Exit current phizclip	1.0.0
pz.navigateToWechatMiniProgram	Open phizclip	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.openEmbeddedMiniProgram	Open the half screen phizclip

4. Forward

Name	Function explaination	Versions	Remarks
pz.showShareMenu	Display the forward on for the current page	1.0.0
pz.hideShareMenu	Hide the forward on for the current page	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.updateShareMenu	Update Forwarding Properties
pz.showShareImageMenu	Open the pop-up window to share pictures, you can send pictures to friends, collection or download
pz.shareVideoMessage	Forward video to chat
pz.shareFileMessage	Forward file to chat
pz.onCopyUrl	Listen to the user click on the upper right menuCopy linkEvent triggered when on
pz.offCopyUrl	Unlisten to the user click on the upper right menuCopy linkEvent triggered when on
pz.getShareInfo	Get forwarding details
pz.authPrivateMessage	Authenticate Private Messages

5. interface

5.1 interactive

Name	Function explaination	Versions	Remarks
pz.showToast	Display Message Prompt Box	1.0.0
pz.showModal	Display modal dialog box	1.0.0
pz.showLoading	display loading Prompt box	1.0.0
pz.showActionSheet	Display Action Menu	1.0.0
pz.hideToast	Hide message prompt box	1.0.0
pz.hideLoading	hide loading Prompt box	1.0.0
pz.enableAlertBeforeUnload	Open the phizclip page to return to the inquiry dialog	2.11.5
pz.disableAlertBeforeUnload	Close the phizclip page and return to the query dialog	2.11.5

5.2 Navigation bar

Name	Function explaination	Versions	Remarks
pz.showNavigationBarLoading	Show navigation bar loading animation on current page	1.0.0
pz.setNavigationBarTitle	Dynamically set the title of the current page	1.0.0
pz.setNavigationBarColor	Set the page navigation bar color	1.0.0
pz.hideNavigationBarLoading	Hide navigation bar on current page Load animation	1.0.0
pz.hideHomeButton	Hide back home on	1.0.0

5.3 background

Name	Function explaination	Versions	Remarks
pz.setBackgroundTextStyle	Dynamically set drop-down background font, loading Style of Graph	1.0.0
pz.setBackgroundColor	Dynamically set the background color of the window	1.0.0

5.4 Tab Bar

Name	Function explaination	Versions	Remarks
pz.showTabBarRedDot	display tabBar The red dot in the upper right corner of an item	1.0.0
pz.showTabBar	display tabBar	1.0.0
pz.setTabBarStyle	Dynamic settings tabBar Overall style	1.0.0
pz.setTabBarItem	Dynamic settings tabBar The content of an item,2.7.0 Image support temporary files and network files	1.0.0
pz.setTabBarBadge	for tabBar Add text to the top right corner of an item	1.0.0
pz.removeTabBarBadge	to remove tabBar Text in the upper-right corner of an item	1.0.0
pz.hideTabBarRedDot	hide tabBar The red dot in the upper right corner of an item	1.0.0
pz.hideTabBar	hide tabBar	1.0.0

5.5 Typeface

Name	Function explaination	Versions	Remarks
pz.loadFontFace	Dynamic loading network font, file address needs to be download type	1.0.0

5.6 Dropdown refresh

Name	Function explaination	Versions	Remarks
pz.stopPullDownRefresh	Stop current page drop-down refresh	1.0.0
pz.startPullDownRefresh	Start Drop Down Refresh	1.0.0

5.7 Roll

5.7.1 pz.pageScrollTo

Name	Function explaination	Versions	Remarks
pz.pageScrollTo	Scroll the page to the target location, support selection and scrolling distance positioning in two ways	1.0.0

5.7.2 ScrollViewContext

Name	Function explaination	Versions	Remarks
ScrollViewContext	The ScrollView operation instance can be obtained through the NodeRef.node method of pz.createSelectorQuery.	3.0.45
ScrollViewContext.scrollIntoView	Scroll to specified position	3.0.45
ScrollViewContext.scrollTo	Scroll to specified position	3.0.45

5.8 animation

Name	Function explaination	Versions	Remarks
pz.createAnimation	Create an animation instance animation	1.0.0

5.8.1 Animation

Name	Function explaination	Versions	Remarks
Animation.export	Export the animation queue.	1.0.0
Animation.step	Indicates that a set of animations is complete.	1.0.0
Animation.matrix	with transform-function matrix	1.0.0
Animation.matrix3d	with transform-function matrix3d	1.0.0
Animation.rotate	Rotate one angle clockwise from the origin	1.0.0
Animation.rotate3d	from fixed The axis rotates one angle clockwise	1.0.0
Animation.rotateX	from X The axis rotates one angle clockwise	1.0.0
Animation.rotateY	from And The axis rotates one angle clockwise	1.0.0
Animation.rotateZ	from With The axis rotates one angle clockwise	1.0.0
Animation.scale	scaling	1.0.0
Animation.scale3d	scaling	1.0.0
Animation.scaleX	scaling X axis	1.0.0
Animation.scaleY	scaling Y axis	1.0.0
Animation.scaleZ	scaling Z axis	1.0.0
Animation.skew	tilt the X-axis and Y-axis	1.0.0
Animation.skewX	tilt the X-axis	1.0.0
Animation.skewY	tilt the Y-axis	1.0.0
Animation.translate	Translation transformation	1.0.0
Animation.translate3d	xyz Coordinate translation	1.0.0
Animation.translateX	shift the X-axis	1.0.0
Animation.translateY	shift the Y-axis	1.0.0
Animation.translateZ	shift the Z-axis	1.0.0
Animation.opacity	Set Transparency	1.0.0
Animation.backgroundColor	Set the background color	1.0.0
Animation.width	Set width	1.0.0
Animation.height	Set Height	1.0.0
Animation.left	Set up left value	1.0.0
Animation.right	Set up right value	1.0.0
Animation.top	Set up top value	1.0.0
Animation.bottom	Set up bottom value	1.0.0

5.9 to sticky

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.setTopBarText	Dynamically set the top column text content

5.10 Custom components

Name	Function explaination	Versions	Remarks
pz.nextTick	Delay a part of an operation to the next time slice	1.0.0

5.11 Menu

Name	Function explaination	Versions	Remarks
pz.getMenuButtonBoundingClientRect	Get layout location information for the menu on (capsule on in the upper right corner)	1.0.0

5.12 window

Name	Function explaination	Versions	Remarks
pz.onWindowResize	Listen for window size changes	1.0.0
pz.offWindowResize	Cancel listening window size change event	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.setWindowSize	To set the window size, this interface applies only to PC Platform, please refer to the guide for details

5.13 worklet animation

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.worklet	The applet gets the worklet object

5.13.1 worklet

Please note

The following APIs are not supported at this time

Name	Function explaination
worklet.cancelAnimation	Cancels SharedValue driven animations
worklet.derived	DerivedValue derivative values, generate other Shared variables based on the existing SharedValue
worklet.shared	Shared variables SharedValue for animation across threads share data and drive
worklet.decay	animation based on rolling
worklet.spring	animation based on physics
worklet.timing	animation based on time
worklet.delay	delay the animation
worklet.repeat	repeat animation
worklet.sequence	combination animation sequence, perform incoming animation in turn
worklet.runOnJS	worklet function operation in the UI thread, the capture of the outer function may be worklet type or ordinary functions, in order to more clearly distinguish, to its request must use runOnJS JS thread back normal function
worklet.runOnUI	the UI thread execution worklet function

6. network

6.1 network

Name	Function explaination	Versions	Remarks
pz.request	initiate HTTPS Network request	1.0.0

6.2 RequestTask

Name	Function explaination	Versions	Remarks
RequestTask.abort	Interrupt request task	1.0.0
RequestTask.offHeadersReceived	Cancel the wiretap HTTP Response Header event	1.0.0
RequestTask.onHeadersReceived	to monitor HTTP Response Header Events.	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
RequestTask.onChunkReceived	to monitor Transfer-Encoding Chunk Received Events.
RequestTask.offChunkReceived	Cancel the wiretap HTTP Response Header Transfer-Encoding Chunk Received Events.

6.3 to download

Name	Function explaination	Versions	Remarks
pz.downloadFile	Download file resources locally	1.0.0

6.3.1 DownloadTask

Name	Function explaination	Versions	Remarks
DownloadTask.abort	Interrupt Download Task	1.0.0
DownloadTask.offHeadersReceived	Cancel the wiretap. HTTP Response Header event	1.0.0
DownloadTask.onHeadersReceived	to monitor HTTP Response Header Events. Will be earlier than the request to complete the event	1.0.0
DownloadTask.offProgressUpdate	Cancel listening for download schedule change events	1.0.0
DownloadTask.onProgressUpdate	Listen for changes in download progress	1.0.0

6.4 upload

Name	Function explaination	Versions	Remarks
pz.uploadFile	Upload local resources to the server	1.0.0

6.4.1 UploadTask

Name	Function explaination	Versions	Remarks
UploadTask.abort	Interrupt upload task	1.0.0
UploadTask.offHeadersReceived	Cancel listening upload progress change event	1.0.0
UploadTask.onHeadersReceived	to monitor HTTP Response Header Events. Will be earlier than the request to complete the event	1.0.0
UploadTask.offProgressUpdate	Cancel listening upload progress change event	1.0.0
UploadTask.onProgressUpdate	Monitor upload progress changes	1.0.0

6.5 WebSocket

Name	Function explaination	Versions	Remarks
pz.sendSocketMessage	adopt WebSocket Connect to send data	1.0.0
pz.onSocketOpen	to monitor WebSocket Connection Open Event	1.0.0
pz.onSocketMessage	to monitor WebSocket Message event received from server	1.0.0
pz.onSocketError	to monitor WebSocket Error event	1.0.0
pz.onSocketClose	to monitor WebSocket Connection Closure Event	1.0.0
pz.connectSocket	Create a WebSocket Connect	1.0.0
pz.closeSocket	Stop WebSocket Connect	1.0.0

6.5.1 SocketTask

Name	Function explaination	Versions	Remarks
SocketTask.close	Stop WebSocket Connect	1.0.0
SocketTask.onClose	to monitor WebSocket Connection Closure Event	1.0.0
SocketTask.onError	to monitor WebSocket Error event	1.0.0
SocketTask.onMessage	to monitor WebSocket Message event received from server	1.0.0
SocketTask.onOpen	to monitor WebSocket Connection Open Event	1.0.0
SocketTask.send	adopt WebSocket Connect to send data	1.0.0

6.6 mDNS

Please note

The following APIs are not supported at this time

| Name| Function explaination | | --- | --- | --- | --- | | pz.stopLocalServiceDiscovery | Stop searching. mDNS service | | pz.startLocalServiceDiscovery | Start searching the LAN. mDNS service | | pz.onLocalServiceResolveFail | to monitor mDNS Event of service resolution failure | | pz.onLocalServiceLost | to monitor mDNS Event of service departure | | pz.onLocalServiceFound | to monitor mDNS Events discovered by services | | pz.onLocalServiceDiscoveryStop | to monitor mDNS Event where the service stopped searching | | pz.offLocalServiceResolveFail | Cancel the wiretap. mDNS Event of service resolution failure | | pz.offLocalServiceLost | Cancel the wiretap. mDNS Event of service departure | | pz.offLocalServiceFound | Cancel the wiretap. mDNS Events discovered by services | | pz.offLocalServiceDiscoveryStop | Cancel the wiretap. mDNS Event where the service stopped searching |

6.7 TCP Signal communication

Name	Function explaination	Versions	Remarks
pz.createTCPSocket	Create a TCP Socket Example	1.0.0

6.7.1 TCPSocket

Name	Function explaination	Versions	Remarks
TCPSocket.onMessage	Monitor triggers the event when data is received	1.0.0
TCPSocket.write	in socket Send data on	1.0.0
TCPSocket.close	Close the connection	1.0.0
TCPSocket.connect	Start a connection on the given socket	1.0.0
TCPSocket.offConnect	Cancel the wiretap when a socket The event is triggered when the connection is successfully established	1.0.0
TCPSocket.offClose	Once we cancel the wiretap socket Full shutdown sends out the event	1.0.0
TCPSocket.offError	Cancel Listen Triggered when an error occurs	1.0.0
TCPSocket.offMessage	Cancels listening to trigger this event when data is received	1.0.0
TCPSocket.onClose	Once the wire is tapped, socket Full shutdown sends out the event	1.0.0
TCPSocket.onConnect	Listen in when a socket The event is triggered when the connection is successfully established	1.0.0
TCPSocket.onError	Listen is triggered when an error occurs	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
TCPSocket.bindWifi	Bind the TCP Socket to the current wifi network, onBindWifi event will be triggered after success
TCPSocket.offBindWifi	Removed when a socket binding the wifi network success
TCPSocket.onBindWifi	TCPSocket onBindWifi

6.8 UDP Signal communication

Name	Function explaination	Versions	Remarks
pz.createUDPSocket	Create a UDP Socket Example	1.0.0

6.8.1 UDPSocket

Name	Function explaination	Versions	Remarks
UDPSocket.bind	Bind a system randomly assigned available port or bind a specified port number	1.0.0
UDPSocket.close	Closing the UDP Socket instance is equivalent to destroying it	1.0.0
UDPSocket.offClose	Unlisten Close Event	1.0.0
UDPSocket.offError	Unlisten Error Event	1.0.0
UDPSocket.offListening	The event that starts listening for packet messages	1.0.0
UDPSocket.offMessage	Unlisten for events that receive messages	1.0.0
UDPSocket.onClose	Listen Close Event	1.0.0
UDPSocket.onError	Listen for error events	1.0.0
UDPSocket.onListening	Listen to start listening for packet messages	1.0.0
UDPSocket.onMessage	Listen to events that receive messages	1.0.0
UDPSocket.connect	Preconnect to the specified IP and Port, you need to cooperate. write Methods used together	1.0.0
UDPSocket.write	Usage and send Method is the same if the connect With send No difference (note that even if the connect You also need to fill in the address and port parameters for this interface.	1.0.0
UDPSocket.setTTL	Set up IP_TTL Socket option to set a IP Maximum number of hops allowed for packet transmission	1.0.0
UDPSocket.send	To the specified IP and port Send a message.	1.0.0

7. payment

Name	Function explaination	Versions	Remarks
pz.requestPayment	Initiate Phiz Pay	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.requestOrderPayment	Create a custom version of the transaction component order and initiate payment

8. Data cache

Name	Function explaination	Versions	Remarks
pz.setStorageSync	pz.setStorage The synchronous version of	1.0.0
pz.setStorage	To store data in the local cache key in	1.0.0
pz.removeStorageSync	pz.removeStorage The synchronous version of	1.0.0
pz.removeStorage	Removes the specified item from the local cache key	1.0.0
pz.getStorageSync	pz.getStorage The synchronous version of	1.0.0
pz.getStorageInfoSync	pz.getStorageInfo The synchronous version of	1.0.0
pz.getStorageInfo	Get information about the current storage asynchronously	1.0.0
pz.getStorage	Gets the specified object asynchronously from the local cache key Content	1.0.0
pz.clearStorageSync	pz.clearStorage The synchronous version of	1.0.0
pz.clearStorage	Clean up the local data cache	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.revokeBufferURL	Destroy data stored in memory based on URL
pz.createBufferURL	Create a unique URL based on the incoming buffer and store it in-memory
pz.batchSetStorageSync	Store data in batches at the specified key in the local cache
pz.batchSetStorage	Store data in batches at the specified key in the local cache
pz.batchGetStorageSync	Synchronously obtain the contents of the specified key from the local cache in batches
pz.batchGetStorage	Synchronously obtain the contents of the specified key from the local cache in batches

8.1 Periodic update

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.setBackgroundFetchToken	Set a custom login status and bring it when periodically pulling data, so the third-party server can verify the legitimacy of the request
pz.onBackgroundFetchData	Monitoring the callback when the backgroundFetch data is received
pz.getBackgroundFetchToken	Get the customized login status that has been set
pz.getBackgroundFetchData	Pull backgroundFetch Client cache data

8.2 Cache manager

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.createCacheManager	Create a cache manager

8.2.1 CacheManager

Please note

The following APIs are not supported at this time

Name	Function explaination
CacheManager.addRule	Add rules
CacheManager.addRules	Add rules in batches. For how to write rules, please refer to CacheManager.addRule
CacheManager.clearCaches	Clear all chache
CacheManager.clearRules	Clear all te rules, at the same times all the cache corresponding to the rules will also get clear
CacheManager.deleteCache	Delete cache
CacheManager.deleteCaches	Delete cache in batches
CacheManager.deleteRule	Delete rule, at the same time, all the cache corresponding to the rule will be deleted
CacheManager.deleteRules	Delete rules, at the same time, all the cache corresponding to these rules will be deleted
CacheManager.match	Matching cache rules; generally need to be used in together with the request event
CacheManager.off	Cancel monitoring events
CacheManager.on	Monitoring events
CacheManager.start	Enables caching; only takes effect when mode is 'none'. After invoking, the state of the cache manager will be set to 1.
CacheManager.stop	Disable caching; only takes effect when mode is 'none'. After invoking, the state of the cache manager will be set to 0

9. Data analysis

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.reportMonitor	Custom service data monitoring and reporting interface
pz.reportEvent	Incident reporting
pz.reportAnalytics	Custom Analysis Data Reporting Interface
pz.getExptInfoSync	Given the experimental parameter array, get the corresponding experimental parameter values

10. canvas

Name	Function explaination	Versions	Remarks
pz.createOffscreenCanvas	Create Off Screen canvas Example	1.0.0
pz.createCanvasContext	Create canvas's drawing context CanvasContext object	1.0.0
pz.canvasToTempFilePath	Export the contents of the specified area of the current canvas to generate a specified size picture	1.0.0
pz.canvasPutImageData	Drawing pixel data to canvas	1.0.0
pz.canvasGetImageData	Obtain canvas Area Implied Pixel Data	1.0.0

10.1 Canvas

Name	Function explaination	Versions	Remarks
Canvas.createImage	Create an image object. Only the canvas obtained by createSelectorQuery has this method	1.0.0
Canvas.getContext	This method returns the Canvas image context	1.0.0
Canvas.createImageData	Create ImageData object (support only 2D canvas)	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
Canvas.cancelAnimationFrame	Cancel the animation frame request added to the schedule by requestAnimationFrame
Canvas.createPath2D	create Path2D object
Canvas.requestAnimationFrame	Executes on the next redraw.
Canvas.toDataURL	Returns a data URI containing the image presentation

10.2 CanvasContext

Name	Function explaination	Versions	Remarks
CanvasContext.arc	Create a curve	1.0.0
CanvasContext.arcTo	based on control point and radius of circular arc path drawing	1.0.0
CanvasContext.beginPath	began to create a path	1.0.0
CanvasContext.clearRect	Remove the contents of the canvas in the rectangular area	1.0.0
CanvasContext.drawImage	drawing to the canvas	1.0.0
CanvasContext.createCircularGradient	Create a circular gradient color	1.0.0
CanvasContext.createLinearGradient	create a linear gradient color	1.0.0
CanvasContext.createPattern	to create the specified image mode, the method of RMB can be repeated at a specified direction image	1.0.0
CanvasContext.clip	Shear arbitrary shape and size from original canvas	1.0.0
CanvasContext.bezierCurveTo	create cubic bezier path	1.0.0
CanvasContext.draw	Draws the previous description (path, deformation, style) in the drawing context to the canvas	1.0.0
CanvasContext.fill	To fill the contents of the current path	1.0.0
CanvasContext.fillRect	fills a rectangle	1.0.0
CanvasContext.fillText	To draw on the canvas is populated text	1.0.0
CanvasContext.lineTo	create to add a new, since the last time and then create a specified point to the target point line	1.0.0
CanvasContext.setLineDash	Setting dotted line style	1.0.0
CanvasContext.setLineCap	Set the endpoint style of line	1.0.0
CanvasContext.setGlobalAlpha	Set the brush global transparency	1.0.0
CanvasContext.setFontSize	set font size	1.0.0
CanvasContext.setFillStyle	set the fill color	1.0.0
CanvasContext.scale	after the call, after creating the path of the horizontal ordinate will be resized	1.0.0
CanvasContext.save	Save the drawing context	1.0.0
CanvasContext.rotate	centered on the origin clockwise rotation axis current	1.0.0
CanvasContext.restore	Save the drawing context before	1.0.0
CanvasContext.rect	create a rectangular path	1.0.0
CanvasContext.quadraticCurveTo	create quadratic bezier path	1.0.0
CanvasContext.moveTo	move the path to the specified point in the canvas, not create line	1.0.0
CanvasContext.setStrokeStyle	Set the stroke color	1.0.0
CanvasContext.setShadow	set shadow style	1.0.0
CanvasContext.setMiterLimit	set the maximum length of the miter	1.0.0
CanvasContext.setLineWidth	set the width of line	1.0.0
CanvasContext.setLineJoin	set the intersection of line style	1.0.0
CanvasContext.setTransform	Method for resetting (overlay) the current transformation using a matrix	1.0.0
CanvasContext.setTextBaseline	Set vertical alignment of the text	1.0.0
CanvasContext.setTextAlign	set text alignment	1.0.0
CanvasContext.measureText	Measure the text size information	1.0.0
CanvasContext.strokeRect	Draw a rectangle(Unfilled)	1.0.0
CanvasContext.strokeText	Method for drawing a text stroke at a given (x, y) position	1.0.0
CanvasContext.transform	Method for Overlaying the Current Transformation Multiple Times Using Matrices	1.0.0
CanvasContext.translate	Transform the origin (0, 0) of the current coordinate system	1.0.0
CanvasContext.stroke	draw the path of the current frame	1.0.0

10.3 CanvasGradient

Name	Function explaination
CanvasGradient.addColorStop	Adds a gradient point for the color.
Color	Color
Image	Image
ImageData	ImageData object

10.4 OffscreenCanvas

Name	Function explaination	Versions	Remarks
OffscreenCanvas.createImage	Create image object	1.0.0
OffscreenCanvas.getContext	This method returns OffscreenCanvas Drawing context	1.0.0

11. Media

11.1 map

Name	Function explaination	Versions	Remarks
pz.createMapContext	Create in the map context a ‘MapContext’ object	1.0.0

11.1.1 MapContext

Name	Function explaination	Versions	Remarks
MapContext.addArc	An arc, a passing point and an angle must be set	1.0.0
MapContext.addCustomLayer	Add the personalization layer	1.0.0
MapContext.addGroundOverlay	create custom picture layer, pictures will follow the map zoom zoom	1.0.0
MapContext.addMarkers	add marker	1.0.0
MapContext.fromScreenLocation	Gets the latitude and longitude of the points on the screen, with the origin of the coordinates being the upper left corner of the map	1.0.0
MapContext.getCenterLocation	Get the latitude and longitude of the current map center	1.0.0
MapContext.getRegion	Gets the current map center longitude and latitude	1.0.0
MapContext.getRotate	Obtain the rotation angle of the current map	1.0.0
MapContext.getSkew	Obtain the tilt angle of the current map	1.0.0
MapContext.getScale	Obtain the zoom level of the current map	1.0.0
MapContext.includePoints	Zoom view to display all longitude and latitude	1.0.0
MapContext.initMarkerCluster	Configure initialization point aggregation (the default configuration is used when not invoked)	1.0.0
MapContext.moveAlong	Move the marker along the specified path for scenarios such as trajectory playback	1.0.0
MapContext.moveToLocation	Move the center of the map to the current set position. Needs to be used in coordination with the map component's show-location	1.0.0
MapContext.openMapApp	Pull up the map app to select navigation	1.0.0
MapContext.removeCustomLayer	Remove the personalization layer	1.0.0
MapContext.removeGroundOverlay	Remove the custom image layer	1.0.0
MapContext.removeMarkers	Remove marker	1.0.0
MapContext.setBoundary	Limit the map display area	1.0.0
MapContext.setCenterOffset	Set the offset of the map center point to grow backwards and downwards, with a screen scale range of 0.25~0.75. The default offset is [0.5, 0.5]	1.0.0
MapContext.setLocMarkerIcon	Set anchor icon, support network path, local path, code package path	1.0.0
MapContext.toScreenLocation	Get the screen coordinates corresponding to latitude and longitude. The origin of the coordinates is the upper left corner of the map.	1.0.0
MapContext.translateMarker	Panning marker with animation	1.0.0
MapContext.updateGroundOverlay	Update custom image layers	1.0.0
MapContext.on	Monitor map events.	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
MapContext.addVisualLayer	Add visual layer
MapContext.removeVisualLayer	Remove layer for visualization
MapContext.removeArc	delete arc

11.2 picture

Name	Function explaination	Versions	Remarks
pz.saveImageToPhotosAlbum	Save pictures to system album	1.0.0
pz.previewMedia	Preview pictures and videos	1.0.0
pz.previewImage	Remove layer for visualization	1.0.0
pz.getImageInfo	Get picture information	1.0.0
pz.compressImage	Compression image interface, optional compression quality	1.0.0
pz.chooseFile	Select a file from the file selector	2.0.32
pz.chooseImage	Select picture from local album or take picture with the camera	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.cropImage	Edit picture interface
pz.editImage	Crop picture interface
pz.chooseMessageFile	Select file from the file selector

11.3 video

Name	Function explaination	Versions	Remarks
pz.saveVideoToPhotosAlbum	Save Video to System Album	1.0.0
pz.createVideoContext	Open Video Editor	1.0.0
pz.compressVideo	Compress video interface	1.0.0
pz.chooseVideo	Take video or select video from local album	1.0.0
pz.chooseMedia	Take or select pictures or videos from local album	1.0.0
pz.previewVideo	Preview video	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.openVideoEditor	Open Video Editor
pz.getVideoInfo	Get video details

11.3.1 videoContext

Name	Function explaination	Versions	Remarks
videoContext.exitBackgroundPlayback	Exit back-end audio playback mode	1.0.0
videoContext.exitFullScreen	Exit Full Screen	1.0.0
videoContext.exitPictureInPicture	Exit window, which can be called on any page	1.0.0
videoContext.hideStatusBar	Hide the status bar, only available in full iOS screen	1.0.0
videoContext.pause	Pause video	1.0.0
videoContext.play	Play the video	1.0.0
videoContext.playbackRate	Set playback speed to double (2x)	1.0.0
videoContext.requestBackgroundPlayback	Enter back-end audio playback mode	1.0.0
videoContext.requestFullScreen	Enter full screen mode	1.0.0
videoContext.seek	Jump to the specified location	1.0.0
videoContext.sendDanmu	Send bullet screen comments	1.0.0
videoContext.showStatusBar	Display status bar, valid for iOS full screen only	1.0.0
videoContext.stop	Stop the video	1.0.0

11.4 Audio

Name	Function explaination	Versions	Remarks
pz.stopVoice	End voice reprodution	1.0.0
pz.setInnerAudioOption	Set playback options for InnerAudioContext	1.0.0
pz.playVoice	Start playing the voice	1.0.0
pz.pauseVoice	Pause a voice that is playing	1.0.0
pz.createInnerAudioContext	Create in the internal audio context an InnerAudioContext object	1.0.0
pz.createAudioContext	Create in audio context an AudioContext object	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.getAvailableAudioSources	Get the currently supported audio input source
pz.createWebAudioContext	create WebAudio context
pz.createMediaAudioPlayer	Create a MediaAudioPlayer object (can be used to play audio output from 'VideoDecoder' video decoder)

11.4.1 AudioBuffer

Please note

The following APIs are not supported at this time

Name	Function explaination
AudioBuffer.copyFromChannel	Copy from the specified channel of AudioBuffer to the array terminal
AudioBuffer.copyToChannel	Copy samples from a specified array to a specific channel in the audioBuffer
AudioBuffer.getChannelData	Returns a Float32Array containing PCM data with channels, defined by channel parameters (0 representing the first channel)

11.4.2 audiocontext

Name	Function explaination	Versions	Remarks
audiocontext.setSrc	Set the audio address	1.0.0
audiocontext.play	Play audio	1.0.0
audiocontext.pause	Pause audio.	1.0.0
audiocontext.seek	Jump to the specified location	1.0.0

11.4.3 InnerAudioContext

Name	Function explaination	Versions	Remarks
InnerAudioContext.destroy	Destroy current instance	1.0.0
InnerAudioContext.offCanplay	Cancel monitoing events which the audio enters the playable state	1.0.0
InnerAudioContext.offEnded	Cancel monitoring for events which audio naturally plays until the end	1.0.0
InnerAudioContext.offError	Cancel monitoring audio playback error events	1.0.0
InnerAudioContext.offTimeUpdate	Cancel monitoring audio playback progress update events	1.0.0
InnerAudioContext.offSeeking	Cancel monitoring audio skip operation events	1.0.0
InnerAudioContext.offWaiting	Monitor events which plays the audio naturally to the end	1.0.0
InnerAudioContext.onEnded	Monitor event which plays the audio naturally to the end	1.0.0
InnerAudioContext.offPlay	Cancel monitoring audio playback events	1.0.0
InnerAudioContext.onCanplay	Monitor events which the audio enters the playable state (but it doesn’t guarantee a smooth playback)	1.0.0
InnerAudioContext.onPause	Monitoring audio pause events	1.0.0
InnerAudioContext.offPause	Cancel monitoring audio pause event	1.0.0
InnerAudioContext.offSeeked	Monitor event in which audio completes the skip operation	1.0.0
InnerAudioContext.offStop	Cancel monitoring audio stop event	1.0.0
InnerAudioContext.onError	Monitor audio playback error events	1.0.0
InnerAudioContext.onPlay	Listen for audio playback events	1.0.0
InnerAudioContext.onSeeked	Listen for audio events to complete jump operations	1.0.0
InnerAudioContext.onSeeking	Listen to audio jump operation event	1.0.0
InnerAudioContext.onStop	Listen for audio stop events	1.0.0
InnerAudioContext.onTimeUpdate	Listen to audio playback progress update events	1.0.0
InnerAudioContext.onWaiting	Listen for audio loading events	1.0.0
InnerAudioContext.pause	Time out	1.0.0
InnerAudioContext.play	play	1.0.0
InnerAudioContext.seek	Jump to the specified location	1.0.0
InnerAudioContext.stop	stop	1.0.0

11.4.4 MediaAudioPlayer

Please note

The following APIs are not supported at this time

Name	Function explaination
MediaAudioPlayer.addAudioSource	Add audio source
MediaAudioPlayer.destroy	Destroy Player
MediaAudioPlayer.removeAudioSource	Remove audio sources
MediaAudioPlayer.start	Start Player
MediaAudioPlayer.stop	Stop the player

11.4.5 WebAudioContext

Please note

The following APIs are not supported at this time

Name	Function explaination
WebAudioContext.close	Close Web Audio Context
WebAudioContext.createAnalyser	Create an AnalyserNode
WebAudioContext.createBiquadFilter	Create a BiquadFilterNode
WebAudioContext.createBuffer	Create an AudioBuffer that represents a short audio segment that resides in memory
WebAudioContext.createBufferSource	Create a BufferSourceNode instance to play the audio data through the AudioBuffer object.
WebAudioContext.createChannelMerger	Create a Channel MergerNode
WebAudioContext.createChannelSplitter	Create a Channel Splitter Node
WebAudioContext.createConstantSource	Create a ConstantSourceNode
WebAudioContext.createDelay	Create a DelayNode
WebAudioContext.createDynamicsCompressor	Create a DynamicsCompressorNode
WebAudioContext.createGain	Create a GainNode
WebAudioContext.createIIRFilter	Create an IIRFilterNode
WebAudioContext.createOscillator	Create a OscillatorNode
WebAudioContext.createPanner	Create a PannerNode
WebAudioContext.createPeriodicWave	Create a PeriodicWaveNode
WebAudioContext.createScriptProcessor	Create a ScriptProcessorNode
WebAudioContext.createWaveShaper	Create a WaveShaperNode
WebAudioContext.decodeAudioData	Asynchronously decodes a resource as an AudioBuffer
WebAudioContext.resume	Synchronize recovery of a paused WebAudioContext context
WebAudioContext.suspend	Synchronize Pause WebAudioContext Context
WebAudioContextNode	A class of audio processing modules, different nodes have different functions, such as GainNode(Volume adjustment)

11.5 Background audio

Name	Function explaination	Versions	Remarks
pz.stopBackgroundAudio	Stop playing the music	1.0.0
pz.seekBackgroundAudio	Control the progress of the music playback	1.0.0
pz.playBackgroundAudio	Use a background player to play music.	1.0.0
pz.pauseBackgroundAudio	Pause the music	1.0.0
pz.onBackgroundAudioStop	Listen to the music stop event	1.0.0
pz.onBackgroundAudioPlay	Listen to music playback events	1.0.0
pz.onBackgroundAudioPause	Listen for music pauses.	1.0.0
pz.getBackgroundAudioPlayerState	Gets background music playback status	1.0.0
pz.getBackgroundAudioManager	ObtainGlobally uniqueBackground Audio Manager. phizclip cut into the background, if the audio is playing state, you can continue to play. But the background state cannot manipulate the playback state of the audio by calling the API.	2.12.12

11.5.1 backgroundaudiomanager

Name	Function explaination	Versions	Remarks
backgroundaudiomanager.onCanplay	Listen for background audio to enter a playable state event. But it doesn't guarantee a smooth playback	1.0.0
backgroundaudiomanager.onEnded	Monitor background audio natural playback end event	1.0.0
BackgroundAudioManager.onError	Listen for background audio playback error events	1.0.0
backgroundaudiomanager.onNext	Listen to the user click on the next song event in the system music play panel (iOS only)	1.0.0
backgroundaudiomanager.onPause	Listen for background audio pause events	1.0.0
backgroundaudiomanager.onPlay	Listen for background audio playback events	1.0.0
backgroundaudiomanager.onPrev	Listen to the user click on the previous event in the system music player panel (iOS only)	1.0.0
backgroundaudiomanager.onSeeked	Listen to background audio to complete jump operation event	1.0.0
backgroundaudiomanager.onSeeking	Listen to background audio start jump operation event	1.0.0
backgroundaudiomanager.onStop	Listen for background audio stop event	1.0.0
backgroundaudiomanager.onTimeUpdate	Listen for background audio playback progress update event, only phizclip in the foreground will callback	1.0.0
backgroundaudiomanager.onWaiting	Listen for audio loading events.	1.0.0
backgroundaudiomanager.pause	Pause the music	1.0.0
backgroundaudiomanager.play	Play music	1.0.0
backgroundaudiomanager.seek	Jump to the specified location	1.0.0
backgroundaudiomanager.stop	Stop the music	1.0.0

11.6 Real-time audio and video

Name	Function explaination	Versions	Remarks
pz.createLivePusherContext	create live-pusher context LivePusherContext object	1.0.0
pz.createLivePlayerContext	create live-player context LivePlayerContext object	1.0.0

11.6.1 LivePlayerContext

Name	Function explaination	Versions	Remarks
LivePlayerContext.exitFullScreen	Exit Full Screen	1.0.0
LivePlayerContext.exitPictureInPicture	Exit window, which can be called on any page	1.0.0
LivePlayerContext.mute	Mute	1.0.0
LivePlayerContext.pause	pause	1.0.0
LivePlayerContext.play	play	1.0.0
LivePlayerContext.requestFullScreen	Enter full screen	1.0.0
LivePlayerContext.requestPictureInPicture	Enter the small window	1.0.0
LivePlayerContext.resume	restore	1.0.0
LivePlayerContext.snapshot	screenshot	1.0.0
LivePlayerContext.stop	stop	1.0.0

11.6.2 LivePusherContext

Name	Function explaination	Versions	Remarks
LivePusherContext.exitPictureInPicture	Exit the small window. This method can be called on any page	1.0.0
LivePusherContext.pause	Suspended thrust	1.0.0
LivePusherContext.pauseBGM	Pause background	1.0.0
LivePusherContext.playBGM	Play background music	1.0.0
LivePusherContext.resume	Recovery push-off	1.0.0
LivePusherContext.resumeBGM	Restore the background sound	1.0.0
LivePusherContext.sendMessage	Send SEI message	1.0.0
LivePusherContext.setBGMVolume	Set the background volume	1.0.0
LivePusherContext.setMICVolume	Set microphone volume	1.0.0
LivePusherContext.snapshot	snapshot	1.0.0
LivePusherContext.start	Start pushing the flow while turning on camera preview	1.0.0
LivePusherContext.startPreview	Open camera preview	1.0.0
LivePusherContext.stop	Stop the push stream while stopping the camera preview	1.0.0
LivePusherContext.stopBGM	Stop background	1.0.0
LivePusherContext.stopPreview	Turn off camera preview	1.0.0
LivePusherContext.switchCamera	Switch back and forth camera	1.0.0
LivePusherContext.toggleTorch	Switch flashlights	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
LivePusherContext.createOffscreenCanvas	Create an off-screen Canvas that can take textures from LivePusher
LivePusherContext.onCustomRendererEvent	This method allows developers to subscribe to events when custom rendering is enabled

11.7 Sound recording

Name	Function explaination	Versions	Remarks
pz.stopRecord	Stop recording	1.0.0
pz.startRecord	Start recording	1.0.0
pz.getRecorderManager	ObtainGlobally uniqueRecording Manager RecorderManager	1.0.0

11.7.1 RecorderManager

Name	Function explaination	Versions	Remarks
RecorderManager.onError	Listen for recording error events	1.0.0
RecorderManager.onFrameRecorded	Listens for file events that have finished recording the specified frame size.	1.0.0
RecorderManager.onInterruptionBegin	The listening recording was interrupted because the system was in use	1.0.0
RecorderManager.onInterruptionEnd	Listening recording interrupt end event. Received.	1.0.0
RecorderManager.onPause	Listen to Pause Event	1.0.0
RecorderManager.onResume	Wiretaps continue the event	1.0.0
RecorderManager.onStop	End of Listening Recording Event	1.0.0
RecorderManager.pause	Pause recording	1.0.0
RecorderManager.resume	Continue recording	1.0.0
RecorderManager.onStart	Start of listening recording	1.0.0
RecorderManager.stop	Stop recording	1.0.0
RecorderManager.start	Start recording	1.0.0

11.8 camera

Name	Function explaination	Versions	Remarks
pz.createCameraContext	create camera context CameraContext object	1.0.0

11.8.1 CameraContext

Name	Function explaination	Versions	Remarks
CameraContext.onCameraFrame	Obtain Camera Real-time frame data	1.0.0
CameraContext.setZoom	Set Zoom Level	1.0.0
CameraContext.startRecord	Start recording	1.0.0
CameraContext.stopRecord	End Video	1.0.0
CameraContext.takePhoto	Taking photos	1.0.0

11.8.2 CameraFrameListener

Name	Function explaination	Versions	Remarks
CameraFrameListener.start	Start monitoring the frame data	1.0.0
CameraFrameListener.stop	Stop listening for frame data	1.0.0

11.9 Rich text

11.9.1 EditorContext

Name	Function explaination	Versions	Remarks
EditorContext.blur	Editor out of focus while folding keyboard	1.0.0
EditorContext.clear	Clear editor content	1.0.0
EditorContext.format	Modify Style	1.0.0
EditorContext.getContents	Get editor content	1.0.0
EditorContext.getSelectionText	Gets the plain text content in the selected area of the editor	1.0.0
EditorContext.insertDivider	Insert split line	1.0.0
EditorContext.insertImage	Insert Picture	1.0.0
EditorContext.insertText	Overwrite the current selection, set a text	1.0.0
EditorContext.redo	restore	1.0.0
EditorContext.removeFormat	Clear the style of the current selection	1.0.0
EditorContext.scrollIntoView	Scrolls the editor cursor into the viewable area of the window	1.0.0
EditorContext.setContents	Initializes editor content, only delta takes effect when html and delta exist together	1.0.0
EditorContext.undo	Revoke	1.0.0

11.10 Audio and video synthesis

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.createMediaContainer	Create an audio and video processing container that will eventually combine the tracks in the container into a video

11.10.1 MediaContainer

Please note

The following APIs are not supported at this time

Name	Function explaination
MediaContainer.addTrack	Add an audio or video track to the container
MediaContainer.destroy	Destroy containers, release resources
MediaContainer.export	Merge tracks in container and export video files
MediaContainer.extractDataSource	Detach the incoming video source from the track
MediaContainer.removeTrack	Remove an audio or video track from a container
MediaTrack	Can be passed MediaContainer.extractDataSource Return

11.11 Real-time speech

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.updateVoIPChatMuteConfig	Update live voice mute settings
pz.subscribeVoIPVideoMembers	Subscription video screen member
pz.setEnable1v1Chat	Enable a tandem call
pz.onVoIPVideoMembersChanged	Monitor real-time voice call member video state change event
pz.onVoIPChatStateChanged	Monitor real-time voice call member video state change event
pz.onVoIPChatSpeakersChanged	Monitor real-time voice call member call status change event
pz.onVoIPChatMembersChanged	Monitor real-time voice call member online status change event
pz.offVoIPChatSpeakersChanged	Example Remove the monitoring function for real-time voice call member call status change events
pz.onVoIPChatInterrupted	Listen for passive disconnection of real-time voice call event
pz.offVoIPVideoMembersChanged	Unmonitor real-time voice call member video status change event
pz.offVoIPChatStateChanged	Cancel monitoring of room state changes
pz.offVoIPChatMembersChanged	Unmonitor real-time voice call member online status change event
pz.offVoIPChatInterrupted	Cancel Listening Passive Disconnect Real-time Voice Call Event
pz.joinVoIPChat	join (create) Live voice calls, more info visible Real-time voice guide
pz.exitVoIPChat	Exit (destroy) live voice calls
pz.join1v1Chat	Join (create) a tandem call

11.12 Picture recorder

Name	Function explaination	Versions	Remarks
pz.createMediaRecorder	create WebGL Picture recorder, which can be recorded frame by frame in WebGL And export the video file	1.0.0

11.12.1 MediaRecorder

Name	Function explaination	Versions	Remarks
MediaRecorder.pause	Pause recording	1.0.0
MediaRecorder.resume	Resume recording	1.0.0
MediaRecorder.start	Start recording	1.0.0
MediaRecorder.stop	End recording	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
MediaRecorder.destroy	Destruction recorder
MediaRecorder.off	Cancels listening recording events.
MediaRecorder.on	Registers callback functions for listening to recorded events
MediaRecorder.requestFrame	Request the next frame recording, in the callback Start recording the current frame after finishing the render

11.13 Video decoder

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.createVideoDecoder	Create a video decoder, frame by frame access to decoded data

11.13.1 VideoDecoder

Please note

The following APIs are not supported at this time

Name	Function explaination
VideoDecoder.getFrameData	Get the decoded data for the next frame
VideoDecoder.off	Cancels listening recording events
VideoDecoder.on	Registers callback functions for listening to recorded events
VideoDecoder.remove	Remove decoder
VideoDecoder.seek	Jump to a point in time to decode
VideoDecoder.start	Start decoding.
VideoDecoder.stop	Stop decoding

12. position

Name	Function explaination	Versions	Remarks
pz.openLocation	Check your location using Phiz's built-in map	1.0.0
pz.startLocationUpdate	Open phizclip to receive location messages when entering reception	1.0.0
pz.getLocation	Get current location, speed	1.0.0
pz.choosePoi	Open the map to choose the location, support fuzzy positioning (accurate to the city) and accurate positioning mixed election	2.12.1
pz.chooseLocation	Open the map and select the location	1.0.0
pz.stopLocationUpdate	Close monitoring real-time position changes, both the front and the back stop receiving messages	3.0.18
pz.startLocationUpdateBackground	Open the phizclip before the background are receiving location messages, you need to guide the user to open	3.0.18
pz.onLocationChange	Monitor real-time geo-location change events in conjunction with pz.startLocationUpdateBackground, pz.startLocationUpdateUse	3.0.18
pz.offLocationChange	Cancel listening for live geo-change events	3.0.18
pz.onLocationChangeError	Triggered when the listening persistent location interface returns a failure	3.0.18
pz.offLocationChangeError	Triggered when the unlisten persistent location interface returns failure	3.0.18

Please note

The following APIs are not supported at this time

Name	Function explaination
getFuzzyLocation	Gets the current fuzzy geographic location

13. file

Name	Function explaination	Versions	Remarks
pz.saveFile	Save files locally	1.0.0
pz.removeSavedFile	Delete local cache file	1.0.0
pz.openDocument	New page opens document	1.0.0
pz.getSavedFileList	Gets a list of local cache files saved under the phizclip	1.0.0
pz.getSavedFileInfo	Get file information for local files	1.0.0
pz.getFileSystemManager	Get the globally unique file manager	1.0.0
pz.getFileInfo	Get File Information	1.0.0
pz.saveFileToDisk	Save file system files to the user disk, only in the PC End support	1.0.0

13.1 FileSystemManager

Name	Function explaination	Versions	Remarks
FileSystemManager.accessSync	FileSystemManager.access The synchronous version of	1.0.0
FileSystemManager.access	Judgment file/Directory exists	1.0.0
FileSystemManager.appendFile	Append content at the end of the file	1.0.0
FileSystemManager.appendFileSync	FileSystemManager.appendFile The synchronous version of	1.0.0
FileSystemManager.close	Close file	1.0.0
FileSystemManager.closeSync	Synchronize Close Files	1.0.0
FileSystemManager.copyFile	Copy file	1.0.0
FileSystemManager.copyFileSync	FileSystemManager.copyFile The synchronous version of	1.0.0
FileSystemManager.getFileInfo	Under the phizclip Local temporary file or Local cache file information	1.0.0
FileSystemManager.getSavedFileList	Gets a list of local cache files saved under the phizclip	1.0.0
FileSystemManager.mkdir	Create a directory	1.0.0
FileSystemManager.mkdirSync	FileSystemManager.mkdir The synchronous version of	1.0.0
FileSystemManager.readdir	Read list of files in a directory	1.0.0
FileSystemManager.readdirSync	FileSystemManager.readdir The synchronous version of	1.0.0
FileSystemManager.readFile	Read local file content	1.0.0
FileSystemManager.readFileSync	FileSystemManager.readFile The synchronous version of	1.0.0
FileSystemManager.removeSavedFile	Delete the saved local cache file under the phizclip	1.0.0
FileSystemManager.rename	Rename the file	1.0.0
FileSystemManager.renameSync	FileSystemManager.rename The synchronous version of	1.0.0
FileSystemManager.rmdir	Delete directory	1.0.0
FileSystemManager.rmdirSync	FileSystemManager.rmdir The synchronous version of	1.0.0
FileSystemManager.saveFile	Save temporary files locally.	1.0.0
FileSystemManager.saveFileSync	FileSystemManager.saveFile The synchronous version of	1.0.0
FileSystemManager.state	Gets the file Stats object	1.0.0
FileSystemManager.statSync	FileSystemManager.state The synchronous version of	1.0.0
FileSystemManager.unlink	Delete file	1.0.0
FileSystemManager.unlinkSync	FileSystemManager.unlink The synchronous version of	1.0.0
FileSystemManager.unzip	Decompress file	1.0.0
FileSystemManager.writeFile	Write file	1.0.0
FileSystemManager.writeFileSync	FileSystemManager.writeFile The synchronous version of	1.0.0
FileSystemManager.write	Write file	1.0.0
FileSystemManager.writeSync	Synchronous write file	1.0.0
FileSystemManager.fstat	Get status information for files	1.0.0
FileSystemManager.fstatSync	Synchronize access to file status information	1.0.0
FileSystemManager.ftruncate	Truncate file contents	1.0.0
FileSystemManager.ftruncateSync	Truncate file contents	1.0.0
FileSystemManager.open	Open the file and return the file descriptor	1.0.0
FileSystemManager.openSync	Open file synchronously, return file descriptor	1.0.0
FileSystemManager.read	Read Files	1.0.0
FileSystemManager.readCompressedFile	Reads the contents of a local file of the specified compression type	1.0.0
FileSystemManager.readCompressedFileSync	Read the local file content of the specified compression type synchronously	1.0.0
FileSystemManager.readSync	Read Files	1.0.0
FileSystemManager.readZipEntry	Read the files in the archive	1.0.0
FileSystemManager.truncate	Truncate file contents	1.0.0
FileSystemManager.truncateSync	Truncate file contents (truncate The synchronous version of)	1.0.0
ReadResult	File read result	1.0.0

13.2 Stats

Name	Function explaination	Versions	Remarks
Stats.isDirectory	Determines if the current file is a directory	1.0.0
Stats.isFile	Determines if the current file is a normal file	1.0.0
WriteResult	File write result.	1.0.0

14. Open interface

14.1 log in

Please note

• The following APIs require integration with the extension SDK or require the app to implement the corresponding proxy methods.

Name	Function explaination	Versions	Remarks
pz.login	Call the interface to get the login credentials	1.0.0
pz.checkSession	Check if the login status is expired	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.pluginLogin	This interface is only callable in the applet plug-in. The calling interface obtains the plug-in user identity credential (code).

14.2 Account information

Name	Function explaination	Versions	Remarks
pz.getAccountInfoSync	Get current account information	1.0.0

14.3 User Information

Name	Function explaination	Versions	Remarks
pz.getUserProfile	Access to user information	1.0.0	Note that the use of this api requires the integration of the Phiz extension SDK
pz.getUserInfo	Access to user information	1.0.0	Note that using this api requires the app to implement a proxy method
UserInfo	User Information	1.0.0

14.4 To grant authorization

Name	Function explaination	Versions	Remarks
pz.authorize	Initiate authorization requests to users in advance	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.authorizeForMiniProgram	This interface can only be called in a phizclip plug-inUse the same as pz.authorize

14.5 Set up

Name	Function explaination	Versions	Remarks
pz.openSetting	Set up the client phizclip settings interface, return the results of user settings	1.0.0
pz.getSetting	Get the user's current settings	1.0.0
AuthSetting	User authorization settings information, refer toJurisdiction	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
SubscriptionsSetting	Subscribe message settings

14.6 Receiving address

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.chooseAddress	Get user receipt address

14.7 Card coupon

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.openCard	Check the card coupon in the Phiz card package
pz.addCard	Batch Add Card Coupons

14.8 invoice

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.chooseInvoiceTitle	Select the user's invoice header
pz.chooseInvoice	Select an invoice the user already has

14.9 Biometric authentication

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.startSoterAuthentication	start SOTER Biometric authentication
pz.checkIsSupportSoterAuthentication	Gets the natively supported SOTER Biometric authentication method
pz.checkIsSoterEnrolledInDevice	Interface to obtain whether biometric information such as fingerprints is recorded in the device

14.10 Phiz Movement

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.shareToWeRun	Share data with Phiz campaign
pz.getWeRunData	Get the user's Phiz movement steps in the past 30 days

14.11 Subscription message

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.requestSubscribeMessage	Call up the client phizclip subscription message interface and return the result of user subscription message
pz.requestSubscribeDeviceMessage	Subscribe to the device message interface. The authorization box pops up after the invocation

14.12 Phiz red envelopes

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.showRedPackage	Pull h5 to receive the red envelope cover page

14.13 Collection

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.addVideoToFavorites	Collection video
pz.addFileToFavorites	Collection of documents

14.14 license plate

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.chooseLicensePlate	Select the license plate.

14.15 Video Number

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.reserveChannelsLive	Reservation Video Number
pz.openChannelsUserProfile	The video number home page is displayed
pz.openChannelsEvent	The video number active page opens
pz.openChannelsLive	Open the video number live
pz.getChannelsShareKey	To obtain the sharing source of video number live card/video card
pz.openChannelsActivity	Open Video Number
pz.getChannelsLiveNoticeInfo	Get video number live preview information
pz.getChannelsLiveInfo	Get Video Number Live Streaming

14.16 Phiz group

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.getGroupEnterInfo	Access to Phiz group chat scenario of phizclip startup information

14.17 Phiz customer service

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.openCustomerServiceChat	Open the Phiz customer service

15. Equipment

15.1 Bluetooth - Universal

Name	Function explaination	Versions	Remarks
pz.stopBluetoothDevicesDiscovery	Stop searching for nearby Bluetooth peripherals	1.0.0
pz.startBluetoothDevicesDiscovery	Start searching for nearby Bluetooth peripherals	1.0.0
pz.openBluetoothAdapter	Initializing Bluetooth Module	1.0.0
pz.onBluetoothDeviceFound	Listen for events that search for new devices	1.0.0
pz.onBluetoothAdapterStateChange	Monitor Bluetooth Adapter State Change Event	1.0.0
pz.offBluetoothDeviceFound	Cancel listening for events that find new devices	1.0.0
pz.offBluetoothAdapterStateChange	Unlisten for Bluetooth adapter state change events	1.0.0
pz.makeBluetoothPair	Bluetooth pairing interface, Android only	1.0.0
pz.getConnectedBluetoothDevices	According to Master Service UUID Get connected Bluetooth devices	1.0.0
pz.getBluetoothDevices	Get all searched Bluetooth devices during Bluetooth module active	1.0.0
pz.getBluetoothAdapterState	Get the status of the native Bluetooth adapter	1.0.0
pz.closeBluetoothAdapter	Turn off the bluetooth module	1.0.0

15.2 Bluetooth-Low-Power Central Device

Name	Function explaination	Versions	Remarks
pz.writeBLECharacteristicValue	Writing Binary Data to Bluetooth Low Power Device Eigenvalues	1.0.0
pz.setBLEMTU	Negotiating Bluetooth Low Power Maximum Transmission Unit (Maximum Transmission Unit, MAN) (Maximum Transmission Unit, MTU)	1.0.0
pz.readBLECharacteristicValue	Reading Binary Data of Characteristic Value of Bluetooth Low Power Device	1.0.0
pz.onBLEConnectionStateChange	Monitor Bluetooth Low Power Connection State Change Event	1.0.0
pz.onBLECharacteristicValueChange	Monitor Eigenvalue Change Events of Bluetooth Low Power Devices	1.0.0
pz.offBLEConnectionStateChange	Cancel listening for Bluetooth low energy connection state change events	1.0.0
pz.offBLECharacteristicValueChange	Cancel monitoring of eigenvalue change events for Bluetooth low-power devices	1.0.0
pz.notifyBLECharacteristicValueChange	Enables a Bluetooth low-power device when its eigenvalue changes notify Features, subscription features	1.0.0
pz.getBLEDeviceServices	Get all Bluetooth Low Power Device Services (service) (service)	1.0.0
pz.getBLEDeviceRSSI	Get the signal strength of a Bluetooth low-power device (Received Signal Strength Indication, RSSI)	1.0.0
pz.getBLEDeviceCharacteristics	Get all the features of a service on a Bluetooth low-power device (characteristic)	1.0.0
pz.createBLEConnection	Connect to a Bluetooth low-power device	1.0.0
pz.closeBLEConnection	Disconnect from a Bluetooth low energy device	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.isBluetoothDevicePaired	This command is used to query whether Bluetooth devices are paired. Supported by Android only
pz.onBLEMTUChange	Monitor Bluetooth low power Max transmission unit change events (Android only)
pz.offBLEMTUChange	Obtain Bluetooth low power Max transfer unit Remove the listening function for Bluetooth low power Max transfer unit change events
pz.getBLEMTU	Obtain Bluetooth low power maximum transmission unit

15.3 Bluetooth - low power peripheral

Name	Function explaination	Versions	Remarks
pz.onBLEPeripheralConnectionStateChanged	Listen for the current peripheral device connection or disconnection event	1.0.0
pz.offBLEPeripheralConnectionStateChanged	Unlistens for current peripheral connection or disconnection events	1.0.0
pz.createBLEPeripheralServer	Set up local server as Bluetooth low-power peripheral device, can create multiple	1.0.0

15.3.1 BLEPeripheralServer

Name	Function explaination	Versions	Remarks
BLEPeripheralServer.addService	Add service.	1.0.0
BLEPeripheralServer.close	Close the current server	1.0.0
BLEPeripheralServer.offCharacteristicReadRequest	Cancels listening for connected device requests to read current peripheral device eigenvalue events	1.0.0
BLEPeripheralServer.offCharacteristicSubscribed	Unsubscribe from listening feature	1.0.0
BLEPeripheralServer.offcharacteristicUnsubscribed	Unlistening Uncharacteristic Subscription Event	1.0.0
BLEPeripheralServer.offCharacteristicWriteRequest	Unlisten for connected device requests to write current peripheral feature events	1.0.0
BLEPeripheralServer.onCharacteristicReadRequest	Listen to connected devices request to read the eigenvalue events of the current peripheral device.	1.0.0
BLEPeripheralServer.onCharacteristicSubscribed	Listen for feature subscription events, only iOS Support	1.0.0
BLEPeripheralServer.onCharacteristicUnsubscribed	Listen to uncharacteristic subscription events, only iOS Support	1.0.0
BLEPeripheralServer.onCharacteristicWriteRequest	Listen for connected device requests to write the current peripheral's eigenvalue event.	1.0.0
BLEPeripheralServer.removeService	Remove service	1.0.0
BLEPeripheralServer.startAdvertising	Begins broadcasting a locally created peripheral	1.0.0
BLEPeripheralServer.stopAdvertising	Stop broadcasting.	1.0.0
BLEPeripheralServer.writeCharacteristicValue	Writes a binary data value to the specified feature, notifying the connected host that the slave's characteristic value has changed, and the interface handles whether to walk back to the packet or to subscribe	1.0.0

15.4 Bluetooth-Beacons(Beacon)

Name	Function explaination	Versions	Remarks
pz.stopBeaconDiscovery	Stop searching the area. Beacon equipment	1.0.0
pz.startBeaconDiscovery	Start searching nearby. Beacon equipment	1.0.0
pz.onBeaconUpdate	to monitor Beacon Device update event, only one listener can be registered	1.0.0
pz.onBeaconServiceChange	to monitor Beacon Service state change events, only one listener can be registered	1.0.0
pz.offBeaconUpdate	Cancel the wiretap. Beacon Device Update Event	1.0.0
pz.offBeaconServiceChange	Cancel the wiretap. Beacon Service State Change Event	1.0.0
pz.getBeacons	Gets all searched Beacon equipment	1.0.0
BeaconInfo	Beacon equipment	1.0.0

15.5 NFC

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.stopHCE	Stop NFC Modular
pz.startHCE	Initialization NFC Modular
pz.sendHCEMessage	send NFC news
pz.onHCEMessage	Listening reception NFC Device message event, can register only one listener
pz.offHCEMessage	receive NFC Device Message Event, Cancel Event Monitoring
pz.getNFCAdapter	Obtain NFC Example
pz.getHCEState	Determines whether the current device supports HCE ability

15.5.1 IsoDep

Please note

The following APIs are not supported at this time

Name	Function explaination
IsoDep.close	Disconnection
IsoDep.connect	Connect NFC label
IsoDep.getHistoricalBytes	Get reset information
IsoDep.getMaxTransceiveLength	Get the maximum transmission length
IsoDep.isConnected	Check if you are connected
IsoDep.setTimeout	Set timeout
IsoDep.transceive	Sending data

15.5.2 MifareClassic

Please note

The following APIs are not supported at this time

Name	Function explaination
MifareClassic.close	Disconnection
MifareClassic.connect	Connect NFC label
MifareClassic.getMaxTransceiveLength	Get the maximum transmission length
MifareClassic.isConnected	Check if you are connected
MifareClassic.setTimeout	Set timeout
MifareClassic.transceive	Sending data

15.5.2 MifareUltralight

Please note

The following APIs are not supported at this time

Name	Function explaination
MifareUltralight.close	Disconnection
MifareUltralight.connect	Connect NFC label
MifareUltralight.getMaxTransceiveLength	Get the maximum transmission length
MifareUltralight.isConnected	Check if you are connected
MifareUltralight.setTimeout	Set timeout
MifareUltralight.transceive	Sending data

15.5.3 Ndef

Please note

The following APIs are not supported at this time

Name	Function explaination
Ndef.close	Disconnection
Ndef.connect	Connect NFC label
Ndef.isConnected	Check if you are connected
Ndef.offNdefMessage	Cancel the wiretap. Ndef news
Ndef.onNdefMessage	to monitor Ndef news
Ndef.setTimeout	Set timeout
Ndef.writeNdefMessage	Rewrite Ndef Tag content

15.5.4 NfcA

Please note

The following APIs are not supported at this time

Name	Function explaination
NfcA.close	Disconnection
NfcA.connect	Connect NFC label
NfcA.getAtqa	Get ATQA information
NfcA.getMaxTransceiveLength	Get the maximum transmission length
NfcA.getSak	Get SAK information
NfcA.isConnected	Check if you are connected
NfcA.setTimeout	Set timeout
NfcA.transceive	Sending data

15.5.5 NFCAdapter

Please note

The following APIs are not supported at this time

Name	Function explaination
NFCAdapter.getIsoDep	Get the IsoDep instance, which supports ISO-DEP (ISO 14443-4)Standard reading and writing
NFCAdapter.getMifareClassic	Get a Mifare Classic instance that supports MIFARE Reading and Writing of Classic Tags
NFCAdapter.getMifareUltralight	Get the Mifare Ultra instance, which supports MIFARE Read and write of Ultimate tag
NFCAdapter.getNdef	Gets an instance of Ndef that supports reading and writing NDF data on NFC tags in NDEV format
NFCAdapter.getNfcA	Get an instance of NfcA, and the instance supports NFC-A (ISO 14443-3A)Standard reading and writing
NFCAdapter.getNfcB	Get an NfcB instance that supports NFC-B (ISO 14443-3B)Standard reading and writing
NFCAdapter.getNfcF	Get the NfcF instance, which supports NFC-F (HE 6319-4)Standard reading and writing
NFCAdapter.getNfcV	Get an instance of NfcV, which supports NFC-V (ISO 15693)Standard reading and writing
NFCAdapter.offDiscovered	Remove the NFC Tag listener function
NFCAdapter.onDiscovered	The NFC Tag is monitored
NFCAdapter.startDiscovery
NFCAdapter.stopDiscovery

15.5.6 NfcB

Please note

The following APIs are not supported at this time

Name	Function explaination
NfcB.close	Disconnection
NfcB.connect	Connect NFC label
NfcB.getMaxTransceiveLength	Get the maximum transmission length
NfcB.isConnected	Check if you are connected
NfcB.setTimeout	Set timeout
NfcB.transceive	Sending data

15.5.7 NfcF

Please note

The following APIs are not supported at this time

Name	Function explaination
NfcF.close	Disconnection
NfcF.connect	Connect NFC label
NfcF.getMaxTransceiveLength	Get the maximum transmission length
NfcF.isConnected	Check if you are connected
NfcF.setTimeout	Set timeout
NfcF.transceive	Sending data

15.5.7 NfcV

Please note

The following APIs are not supported at this time

Name	Function explaination
NfcV.close	Disconnection
NfcV.connect	Connect NFC label
NfcV.getMaxTransceiveLength	Get the maximum transmission length
NfcV.isConnected	Check if you are connected
NfcV.setTimeout	Set timeout
NfcV.transceive	Sending data

15.6 Wi-Fi

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.stopWifi	Stop Wi-Fi Modular
pz.startWifi	Initialization Wi-Fi Modular
pz.setWifiList	Set up wifiList in AP Relevant information
pz.onWifiConnected	Listen on the connection. Wi-Fi The incident.
pz.onGetWifiList	Listen to get Wi-Fi List data event
pz.getWifiList	Request access Wi-Fi list
pz.getConnectedWifi	In the connected Wi-Fi information
pz.connectWifi	Connect Wi-Fi
pz.onWifiConnectedWithPartialInfo	Listen for Wi-Fi connection events
pz.offWifiConnectedWithPartialInfo	Removes the listener function for events connected to Wi-Fi
pz.offWifiConnected	Untap the connection. Wi-Fi The incident
pz.offGetWifiList	Cancel the wiretap and get Wi-Fi List data event
WifiInfo	Wifi information

15.7 calendar

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.addPhoneRepeatCalendar	Add Recurring Events to the System Calendar
pz.addPhoneCalendar	Add events to the system calendar

15.8 Contacts

Name	Function explaination	Versions	Remarks
pz.addPhoneContact	Add a phone contact	1.0.0
pz.chooseContact	Pull up your phone's address book and select your contacts	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.searchContacts	Search the address book, match the phone number that is similar

15.9 Accessibility

Name	Function explaination	Versions	Remarks
pz.checkIsOpenAccessibility	Detection of whether visual accessibility is enabled	2.12.1

15.10 Electric quantity

Name	Function explaination	Versions	Remarks
pz.getBatteryInfoSync	pz.getBatteryInfo The synchronous version of	1.0.0
pz.getBatteryInfo	Get Device Power	1.0.0

15.11 clipboard

Name	Function explaination	Versions	Remarks
pz.setClipboardData	Setting the contents of the system clipboard	1.0.0
pz.getClipboardData	Get the contents of the system clipboard	1.0.0

15.12 network

Name	Function explaination	Versions	Remarks
pz.onNetworkStatusChange	Monitor Network State Change Event	1.0.0
pz.offNetworkStatusChange	Cancel monitoring of network state change events. If the parameter is null, cancel all event monitoring	1.0.0
pz.getNetworkType	Get network type	1.0.0

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.onNetworkWeakChange	Listens for weak network status change events
pz.getLocalIPAddress	Get the LAN IP address
pz.offNetworkWeakChange	Removes the listener function for weak network state change events

15.13 encryption

Name	Function explaination	Versions	Remarks
pz.getRandomValues	Get cryptographic secure random numbers	1.0.0

15.14 screen

Name	Function explaination	Versions	Remarks
pz.setVisualEffectOnCapture	Set the screen performance during screen capture/recording(Android Only)	2.12.16
pz.setScreenBrightness	Set Screen Brightness	1.0.0
pz.setKeepScreenOn	Set to Remain Always Bright	1.3.9
pz.onUserCaptureScreen	Monitor user active screen capture event	1.0.0
pz.onScreenRecordingStateChanged	Monitor user screen-recording events(iOS only)	2.12.16
pz.offUserCaptureScreen	User Active Screenshot Event	1.0.0
pz.offScreenRecordingStateChanged	Removes the listener function for user screen-recording events	2.12.16
pz.getScreenRecordingState	Example Query whether the user is recording a screen	2.12.16
pz.getScreenBrightness	Get screen brightness	1.0.0

15.15 keyboard

Name	Function explaination	Versions	Remarks
pz.onKeyboardHeightChange	Monitor keyboard height changes	1.0.0
pz.offKeyboardHeightChange	Unlisten for keyboard height change events	1.0.0
pz.hideKeyboard	After input, textarea, etc., focus pulls up the keyboard, manually invoke this interface to close the keyboard	1.0.0
pz.getSelectedTextRange	After input, text area, and so on, get the cursor position of the input box	1.0.0

15.16 telephone

Name	Function explaination	Versions	Remarks
pz.makePhoneCall	Make a call	1.0.0

15.17 Accelerometer

Name	Function explaination	Versions	Remarks
pz.stopAccelerometer	Stop monitoring the acceleration data	1.0.0
pz.startAccelerometer	Start listening for acceleration data	1.0.0
pz.onAccelerometerChange	Listening for acceleration data events	1.0.0
pz.offAccelerometerChange	Cancel monitoring of the acceleration data event, parameter is null, cancel all event monitoring	1.0.0

15.18 Luopan

Name	Function explaination	Versions	Remarks
pz.stopCompass	Stop listening to compass data	1.0.0
pz.startCompass	Start monitoring compass data	1.0.0
pz.onCompassChange	Monitor compass data change events	1.0.0
pz.offCompassChange	Cancel listening for compass data change events. If the parameter is empty, cancel all event monitoring	1.0.0

15.19 Equipment direction

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.stopDeviceMotionListening	Stop listening for changes in direction
pz.startDeviceMotionListening	Start listening for changes in device orientation
pz.onDeviceMotionChange	Monitor device direction change event
pz.offDeviceMotionChange	Cancel listening device direction change event, the parameter is empty, then cancel all the event listening

15.20 gyroscope

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.stopGyroscope	Stop monitoring the gyroscope data
pz.startGyroscope	Start listening for gyro data
pz.onGyroscopeChange	Monitoring gyro data change events
pz.offGyroscopeChange	Cancel monitoring of gyro data change events

15.21 Memory

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.onMemoryWarning	Listening for Out of Memory Alert Events
pz.offMemoryWarning	Unlisten for out-of-memory alarm events

15.22 Scan code

Name	Function explaination	Versions	Remarks
pz.scanCode	Set up the client scan interface to scan the code	1.0.0

15.23 vibration

Name	Function explaination	Versions	Remarks
pz.vibrateShort	Make the mobile phone vibrate for a short time (15 ms）	1.0.0
pz.vibrateLong	Make the phone vibrate for a longer time (400 ms)	1.0.0

15.24 Sms

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.sendSms	Pull up the SMS sending screen

16. AI

16.1 Visual algorithm

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.isVKSupport	Judge supported version
pz.createVKSession	Create the vision kit session object
VKBodyAnchor	Human anchor

16.2 VKCamera

Please note

The following APIs are not supported at this time

Name	Function explaination
VKCamera.getProjectionMatrix	Get projection matrix
VKFaceAnchor	Face anchor

16.3 VKFrame

Please note

The following APIs are not supported at this time

Name	Function explaination
VKFrame.getCameraBuffer	Gets the current frame rgba buffer
VKFrame.getCameraTexture	Get the current frame texture. Currently only YUV textures are supported
VKFrame.getDisplayTransform	Gets the texture adjustment matrix
VKMarkerAnchor	marker anchor
VKOSDAnchor	OSD anchor
VKHandAnchor	Gesture anchor
VKPlaneAnchor	Flat anchor, supported only by version v2

16.4 VKSession

Please note

The following APIs are not supported at this time

Name	Function explaination
VKSession.addMarker	Plane anchor. Only v2 version supports adding a marker for A, which requires that the track.marker passed in pz.createVKSession is true
VKSession.addOSDMarker	Add a one-shot detection marker (OSD) and set the value of track.OSD passed to pz.createVKSession to true
VKSession.cancelAnimationFrame	Cancels the animation frame request that was added to the schedule by requestAnimationFrame
VKSession.destroy	Destroy session
VKSession.detectFace	Face key point detection in static image
VKSession.getAllMarker	Gets all markers and requires that the track.marker passed in pz.createVKSession is true
VKSession.getAllOSDMarker	Obtain all OSD markers and set the value of track.OSD passed to pz.createVKSession to true
VKSession.getVKFrame	Gets the frame object, and each call triggers a frame analysis process
VKSession.hitTest	Touch detection: v1 version only supports single plane (that is, after hitTest generates a plane once, subsequent hitTest will not regenerate a plane, but detect based on the previously generated plane)
VKSession.detectHand	Static image gesture key point detection. Available when the pz.createVKSession parameter is passed to {track: {hand: {mode: 2}}}
VKSession.detectBody	Static image key point detection of human body. Available when the pz.createVKSession parameter is passed to {track: {body: {mode: 2}}}
VKSession.off	Cancel listening for session events
VKSession.on	Listening for session events
VKSession.runOCR	Static image OCR detection. Available when the pz.createVKSession parameter is passed to {track: {OCR: {mode: 2}}}.
VKSession.removeMarker	Delete a marker that is passed to pz.createVKSession to be true
VKSession.removeOSDMarker	Delete an OSD marker and set the value of track.OSD passed to pz.createVKSession to true
VKSession.requestAnimationFrame	Executes the next time you redraw
VKSession.start	Open a session
VKSession.stop	Stop a session
VKSession.updateOSDThreshold	Update the accuracy of OSD identification. Set track.OSD to true when pz.createVKSession is set

16.5 Face recognition

Please note

The following APIs are not supported at this time, but you can check the PhizClip Financial Scenarios API for information.

Name	Function explaination
pz.stopFaceDetect	Stop face recognition
pz.initFaceDetect	Initializing face recognition
pz.faceDetect	Face recognition, you need to pass pz.initFaceDetect Once initialized, frame data returned using the camera interface is recommended

17. Worker

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.createWorker	Create a Worker Thread

17.1 Worker

Please note

The following APIs are not supported at this time

Name	Function explaination
Worker.getCameraFrameData	Gets the current camera frame image and returns ArrayBuffer data
Worker.onMessage	Monitor main thread/Worker Event of a message sent by a thread to the current thread
Worker.onProcessKilled	Monitor the event that the worker thread is recycled by the system (when iOS system resources are tight, the worker thread may be recycled by the system, the developer can monitor this event and create a new worker)
Worker.postMessage	Main thread/Worker The message sent by the thread.
Worker.terminate	End current Worker Threads. Only in the main thread worker Object.
Worker.testOnProcessKilled	to monitor Worker thread is recycled by system event (when iOS system resource is tight, worker thread exists the possibility of system recycling, developer can listen to this event and create a worker again). Only in the main thread worker Object.

18. FXML

Name	Function explaination	Versions	Remarks
pz.createSelectorQuery	Returns a SelectorQuery Object instance	1.0.0
pz.createIntersectionObserver	Creates and returns a IntersectionObserver Object instance	1.0.0

18.1 IntersectionObserver

Name	Function explaination	Versions	Remarks
IntersectionObserver.disconnect	Stop listening	1.0.0
IntersectionObserver.observe	Specify the target node and start listening for changes in the intersection state	1.0.0
IntersectionObserver.relativeTo	Use a selector to specify a node as one of the reference areas	1.0.0
IntersectionObserver.relativeToViewport	Specify the page display area as one of the reference areas	1.0.0

18.2 MediaQueryObserver

Name	Function explaination	Versions	Remarks
MediaQueryObserver.disconnect	Stop listening	1.0.0
MediaQueryObserver.observe	Start listening to page media query Changes	1.0.0

18.3 NodesRef

Name	Function explaination	Versions	Remarks
NodesRef.boundingClientRect	Query request to add layout location of node	1.0.0
NodesRef.context	Add node Context Object query request	1.0.0
NodesRef.fields	Get information about nodes	1.0.0
NodesRef.scrollOffset	Obtain Node Node instance	1.0.0
NodesRef.node	Add node scrolling location query request	2.12.12

18.4 SelectorQuery

Name	Function explaination	Versions	Remarks
SelectorQuery.exec	Execute all requests	1.0.0
SelectorQuery.in	Change the selection of a selector to a custom component component within	1.0.0
SelectorQuery.select	Select the first match selector under the current page selector Node	1.0.0
SelectorQuery.selectAll	Select the match selector under the current page selector All nodes	1.0.0
SelectorQuery.selectViewport	Select display area	1.0.0

19. Third party platform

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.getExtConfigSync	pz.getExtConfig The synchronous version of
pz.getExtConfig	ObtainThird party platformCustom data fields

20. Advertising

Please note

The following APIs are not supported at this time

Name	Function explaination
pz.createRewardedVideoAd	Create Incentive Video Advertising Components
pz.createInterstitialAd	Create Splash Advertising Component

20.1 InterstitialAd

Please note

The following APIs are not supported at this time

Name	Function explaination
InterstitialAd.destroy	Destroy the screen ad instance
InterstitialAd.load	Load a screen ad
InterstitialAd.offClose	Cancel Listen Clip Ad Close Event
InterstitialAd.offError	Cancel Monitor Plugin Error Event
InterstitialAd.offLoad	Cancel Monitor Plugin Loading Event
InterstitialAd.onClose	Listen to screen ads closing events.
InterstitialAd.onError	Listen for plugin error events.
InterstitialAd.onLoad	Listen to the plug-in ad loading event.
InterstitialAd.show	Display ad inserts.

20.2 RewardedVideoAd

Please note

The following APIs are not supported at this time

Name	Function explaination
RewardedVideoAd.destroy	Destroy incentive video advertising examples
RewardedVideoAd.load	Load motivational video ads
RewardedVideoAd.offClose	Cancel listening for user clicks Turn off advertising Button event
RewardedVideoAd.offError	Unlisten Incentive Video Error Event
RewardedVideoAd.offLoad	Unlisten Incentive Video Ad Loading Event
RewardedVideoAd.onClose	Listening user clicks Turn off advertising Button event
RewardedVideoAd.onError	Listen for incentive video error events
RewardedVideoAd.onLoad	Listen for motivational video ad loading events
RewardedVideoAd.show	Display motivational video ads.

21. Other

Name	Function explaination
pz.onCustomEvent	Listens to the onCustomEvent event dispatched natively
pz.offCustomEvent	Unlisten to the onCustomEvent event dispatched natively
pz.addCustomEventListener	Listens to the event dispatched natively
pz.removeCustomEventListener	Unlisten to the onCustomEvent event dispatched natively
pz.getSuperviseInfo	Get monitoring information
pz.sendWebviewEvent	The applet sends events to H5
pz.reportEvent	Incident reporting
pz.loadExtApi	Load custom API configuration