Function Overview

Last updated：2022-01-13 20:26

ZEGO Express SDKs provide rich APIs for you to quickly build audio/video calling and live streaming capabilities into your applications based on ZEGO's cloud live streaming platform. With a powerful audio/video processing engine and a global real-time network, the platform is providing high-quality and reliable cloud audio/video streaming services to businesses around the world.

ZEGO Express SDKs are available for all major platforms, including Android, iOS, Mac, Windows, and Web.

SDK Initialization

Method	Description
getConfig	Get the specified extension content according to the Key value
on	Register callback event
createView	Create ZegoDocsView
setTestEnv	Set up the ZegoDocsView SDK environment
getVersion	Get SDK version information
setConfig	Set configuration items

File Upload and Load

Method	Description
loadFile	Load ZegoDocsView
unloadFile	Unload ZegoDocsView from view
uploadFile	Upload files to ZegoDocs service
uploadH5File	Upload custom H5 courseware to ZegoDocs service
cancelUploadFile	Cancel the upload action during file upload
cacheFile	Cache files to local storage
cancelCacheFile	Cancel the cache action in the process of caching files
queryFileCached	Check if the file cache exists

File Manipulation (paging, zooming, scrolling)

Method	Description
getFileID	Get the fileID corresponding to the current ZegoDocsView, which is consistent with the fileID passed in by loadFile.
getFileType	Get the file type of the current ZegoDocsView
getCurrentPage	Get the page number of the currently displayed ZegoDocsView
getPageCount	Get the total number of pages of the currently loaded ZegoDocsView
getVerticalPercent	Get the current vertical offset (vertical scroll bar) percentage
getVisibleSize	Get the width and height of the visible area of the current ZegoDocsView
getContentSize	The width and height of the ZegoDocsView content, the total height based on the currently set display width
playAnimation	Playing the corresponding animation in the file according to the specific information of [animationInfo] is only valid for dynamic PPT with animation effects.
stopPlay	Stop the audio and video playback of a page of the local dynamic PPT ZegoDocsView
flipPage	Jump to the specified page of the file and specified animation steps
scrollTo	Jump to vertical offset percentage
setScaleFactor	Synchronization area, including zoom, offset, sliding range, etc. Application scenarios: such as synchronization with ZegoWhiteboardView operations.
getPPTNotes	Get the remarks of the specified page number of the PPT
getThumbnailUrlList	Get the current file thumbnail list, only supports PDF, PPT, dynamic PPT, H5 file formats
switchSheet	Switch the Excel file to the specified sheet
nextStep	The next step of dynamic PPT, only for dynamic PPT ZegoDocsViewFileTypeDynamicPPTH5 type operations
previousStep	The last step of dynamic PPT, only for dynamic PPT ZegoDocsViewFileTypeDynamicPPTH5 type operation