Zoom Wallpaper Setting
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
onMeetingWallpaperChanged |
function
|
Callback event of notification that the meeting wall-paper item is changed. |
onMeetingWallpaperImageDownloadStatus |
function
|
Callback event of notification that download status of the meeting wall-paper is changed. |
onPersonalWallpaperChanged |
function
|
Callback event of notification that the personal wall-paper item is changed. |
onPersonalWallpaperImageDownloadStatus |
function
|
Callback event of notification that download status of the personal wall-paper is changed. |
Returns:
-
Type
-
ZoomWallpaperSetting
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
onMeetingWallpaperChanged |
function
|
Callback event of notification that the meeting wall-paper item is changed. |
onMeetingWallpaperImageDownloadStatus |
function
|
Callback event of notification that download status of the meeting wall-paper is changed. |
onPersonalWallpaperChanged |
function
|
Callback event of notification that the personal wall-paper item is changed. |
onPersonalWallpaperImageDownloadStatus |
function
|
Callback event of notification that download status of the personal wall-paper is changed. |
Returns:
-
Type
-
ZoomWallpaperSetting
Methods
(inner) GetCurrentMeetingWallpaperItem() → {Object}
- Description:
- Get the meeting wall-paper item.
- Source:
Returns:
The current using meeting wall-paper config.
-
Type
-
Object
(inner) GetCurrentMeetingWallpaperItem() → {Object}
- Description:
- Get the meeting wall-paper item.
- Source:
Returns:
The current using meeting wall-paper config.
-
Type
-
Object
(inner) GetCurrentPersonalWallpaperItem() → {Object}
- Description:
- Get the current user's persional wall-paper item.
- Source:
Returns:
The current user's personal wall-paper config.
-
Type
-
Object
(inner) GetCurrentPersonalWallpaperItem() → {Object}
- Description:
- Get the current user's persional wall-paper item.
- Source:
Returns:
The current user's personal wall-paper config.
-
Type
-
Object
(inner) GetMeetingWallpaperItemByID(wallpaperId) → {Object}
- Description:
- Get the meeting wall-paper item by wall-paper ID.
- Source:
Parameters:
| Name |
Type |
Description |
wallpaperId |
String
|
|
Returns:
The meeting wall-paper with the wall-paper ID.
-
Type
-
Object
(inner) GetMeetingWallpaperItemByID(wallpaperId) → {Object}
- Description:
- Get the meeting wall-paper item by wall-paper ID.
- Source:
Parameters:
| Name |
Type |
Description |
wallpaperId |
String
|
|
Returns:
The meeting wall-paper with the wall-paper ID.
-
Type
-
Object
(inner) GetMeetingWallpaperList() → {Array}
- Description:
- Get the meeting wall-paper list.
- Source:
Returns:
The meeting wall-paper list.
-
Type
-
Array
(inner) GetMeetingWallpaperList() → {Array}
- Description:
- Get the meeting wall-paper list.
- Source:
Returns:
The meeting wall-paper list.
-
Type
-
Array
(inner) GetPersonalWallpaperItemByID(wallpaperId) → {Object}
- Description:
- Get the personal wall-paper item by wall-paper ID.
- Source:
Parameters:
| Name |
Type |
Description |
wallpaperId |
String
|
|
Returns:
The personal wall-paper item with the wall-paper ID.
-
Type
-
Object
(inner) GetPersonalWallpaperItemByID(wallpaperId) → {Object}
- Description:
- Get the personal wall-paper item by wall-paper ID.
- Source:
Parameters:
| Name |
Type |
Description |
wallpaperId |
String
|
|
Returns:
The personal wall-paper item with the wall-paper ID.
-
Type
-
Object
(inner) GetPersonalWallpaperList() → {Array}
- Description:
- Get the current user's personal wall-paper list.
- Source:
Returns:
The current user's personal wall-paper list.
-
Type
-
Array
(inner) GetPersonalWallpaperList() → {Array}
- Description:
- Get the current user's personal wall-paper list.
- Source:
Returns:
The current user's personal wall-paper list.
-
Type
-
Array
(inner) IsMeetingWallpaperEnabled() → {Boolean}
- Description:
- Determine if the meeting wall-paper feature enabled by OP.
- Source:
Returns:
True indicates the feature enabled. Otherwise false.
-
Type
-
Boolean
(inner) IsMeetingWallpaperEnabled() → {Boolean}
- Description:
- Determine if the meeting wall-paper feature enabled by OP.
- Source:
Returns:
True indicates the feature enabled. Otherwise false.
-
Type
-
Boolean
(inner) IsMeetingWallpaperThumbsReady() → {Boolean}
- Description:
- Determine if meeting wall-paper thumbnail ready.
- Source:
Returns:
True indicates ready. Otherwise false.
-
Type
-
Boolean
(inner) IsMeetingWallpaperThumbsReady() → {Boolean}
- Description:
- Determine if meeting wall-paper thumbnail ready.
- Source:
Returns:
True indicates ready. Otherwise false.
-
Type
-
Boolean
(inner) IsPersonalWallpaperEnabled() → {Boolean}
- Description:
- Determine if the personal wall-paper feature enabled by OP.
- Source:
Returns:
True indicates the feature enabled. Otherwise false.
-
Type
-
Boolean
(inner) IsPersonalWallpaperEnabled() → {Boolean}
- Description:
- Determine if the personal wall-paper feature enabled by OP.
- Source:
Returns:
True indicates the feature enabled. Otherwise false.
-
Type
-
Boolean
(inner) SetMeetingWallpaper(wallpaperId, transparency, mode) → {Number}
- Description:
- Set the meeting wall-paper item.
- Source:
Parameters:
| Name |
Type |
Description |
wallpaperId |
Number
|
|
transparency |
Number
|
transparency of the wallpaper. |
mode |
Number
|
layout mode of the wallpaper. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) SetMeetingWallpaper(wallpaperId, transparency, mode) → {Number}
- Description:
- Set the meeting wall-paper item.
- Source:
Parameters:
| Name |
Type |
Description |
wallpaperId |
Number
|
|
transparency |
Number
|
transparency of the wallpaper. |
mode |
Number
|
layout mode of the wallpaper. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) SetOnMeetingWallpaperChangedCB(onMeetingWallpaperChanged) → {Boolean}
- Description:
- Set callback event of notification that the meeting wall-paper item is changed.
- Source:
Parameters:
| Name |
Type |
Description |
onMeetingWallpaperChanged |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnMeetingWallpaperChangedCB(onMeetingWallpaperChanged) → {Boolean}
- Description:
- Set callback event of notification that the meeting wall-paper item is changed.
- Source:
Parameters:
| Name |
Type |
Description |
onMeetingWallpaperChanged |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnMeetingWallpaperImageDownloadStatusCB(onMeetingWallpaperImageDownloadStatus) → {Boolean}
- Description:
- Set callback event of notification that download status of the meeting wall-paper is changed.
- Source:
Parameters:
| Name |
Type |
Description |
onMeetingWallpaperImageDownloadStatus |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnMeetingWallpaperImageDownloadStatusCB(onMeetingWallpaperImageDownloadStatus) → {Boolean}
- Description:
- Set callback event of notification that download status of the meeting wall-paper is changed.
- Source:
Parameters:
| Name |
Type |
Description |
onMeetingWallpaperImageDownloadStatus |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnPersonalWallpaperChangedCB(onPersonalWallpaperChanged) → {Boolean}
- Description:
- Set callback event of notification that the personal wall-paper item is changed.
- Source:
Parameters:
| Name |
Type |
Description |
onPersonalWallpaperChanged |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnPersonalWallpaperChangedCB(onPersonalWallpaperChanged) → {Boolean}
- Description:
- Set callback event of notification that the personal wall-paper item is changed.
- Source:
Parameters:
| Name |
Type |
Description |
onPersonalWallpaperChanged |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnPersonalWallpaperImageDownloadStatusCB(onPersonalWallpaperImageDownloadStatus) → {Boolean}
- Description:
- Set callback event of notification that download status of the personal wall-paper is changed.
- Source:
Parameters:
| Name |
Type |
Description |
onPersonalWallpaperImageDownloadStatus |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnPersonalWallpaperImageDownloadStatusCB(onPersonalWallpaperImageDownloadStatus) → {Boolean}
- Description:
- Set callback event of notification that download status of the personal wall-paper is changed.
- Source:
Parameters:
| Name |
Type |
Description |
onPersonalWallpaperImageDownloadStatus |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetPersonalWallpaper(transparency, mode) → {Number}
- Description:
- Set the current user's personal wall-paper.
- Source:
Parameters:
| Name |
Type |
Description |
transparency |
Number
|
transparency of the wallpaper. |
mode |
Number
|
layout mode of the wallpaper. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) SetPersonalWallpaper(transparency, mode) → {Number}
- Description:
- Set the current user's personal wall-paper.
- Source:
Parameters:
| Name |
Type |
Description |
transparency |
Number
|
transparency of the wallpaper. |
mode |
Number
|
layout mode of the wallpaper. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
Events
onMeetingWallpaperChanged
- Description:
- Callback event of notification that the meeting wall-paper item is changed.
- Source:
Parameters:
| Name |
Type |
Description |
item |
Object
|
The config changed. |
onMeetingWallpaperChanged
- Description:
- Callback event of notification that the meeting wall-paper item is changed.
- Source:
Parameters:
| Name |
Type |
Description |
item |
Object
|
The config changed. |
onMeetingWallpaperImageDownloadStatus
- Description:
- Callback event of notification that download status of the meeting wall-paper is changed.
- Source:
Parameters:
| Name |
Type |
Description |
status |
Number
|
The download status of the meeting wall-peper. see ZoomSDKWallpaperSettingStatus. |
wallpaperId |
String
|
The download meeting wall-paper image ID. |
onMeetingWallpaperImageDownloadStatus
- Description:
- Callback event of notification that download status of the meeting wall-paper is changed.
- Source:
Parameters:
| Name |
Type |
Description |
status |
Number
|
The download status of the meeting wall-peper. see ZoomSDKWallpaperSettingStatus. |
wallpaperId |
String
|
The download meeting wall-paper image ID. |
onPersonalWallpaperChanged
- Description:
- Callback event of notification that the personal wall-paper item is changed.
- Source:
Parameters:
| Name |
Type |
Description |
item |
Object
|
The config changed. |
onPersonalWallpaperChanged
- Description:
- Callback event of notification that the personal wall-paper item is changed.
- Source:
Parameters:
| Name |
Type |
Description |
item |
Object
|
The config changed. |
onPersonalWallpaperImageDownloadStatus
- Description:
- Callback event of notification that download status of the personal wall-paper is changed.
- Source:
Parameters:
| Name |
Type |
Description |
status |
Number
|
The download status of the personal wall-peper. see ZoomSDKWallpaperSettingStatus. |
wallpaperId |
String
|
The download personal wall-paper image ID. |
onPersonalWallpaperImageDownloadStatus
- Description:
- Callback event of notification that download status of the personal wall-paper is changed.
- Source:
Parameters:
| Name |
Type |
Description |
status |
Number
|
The download status of the personal wall-peper. see ZoomSDKWallpaperSettingStatus. |
wallpaperId |
String
|
The download personal wall-paper image ID. |