Customizing the Icon for a Specific Scenario
Function
This API is used to customize the icon for a specific scenario.
Function Prototype
setCustomUIImage(customSceneImageInfoList: CustomSceneImageInfoList, onSetCustomUIImageResult?: (ret: SDKERR, reason: string) => void): voidsetCustomUIImage(customSceneImageInfoList: CustomSceneImageInfoList, onSetCustomUIImageResult?: (ret: SDKERR, reason: string) => void): void
Request Parameters
Parameter | Mandatory | Type | Description |
---|---|---|---|
customSceneImageInfoList | Yes | CustomSceneImageInfoList | Custom icon details. |
onSetCustomUIImageResult | Yes | (ret: SDKERR, reason: string) => void | Callback of customizing icons for specific scenarios. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
customSceneImageInfoListSize | Yes | number | Number of scenarios requiring icon customization. |
customSceneImageInfoList | Yes | CustomSceneImageInfo | Custom icon details. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
scene | Yes | UICustomImageScene | Scenario requiring icon customization. |
imagePath | Yes | string | Custom icon path. |
width | Yes | number | Custom icon width. |
height | Yes | number | Custom icon height. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
CLOUD_RECORD_ICON_IMAGE_SCENE | 0 | Main icon of cloud recording in a meeting (in the recording pop-up menu, participant list, and sharing toolbar). |
MAIN_WINDOW_CLOUD_RECORD_ICON_SCENE | 1 | Small cloud recording icon in the main window. |
MAIN_WINDOW_CLOUD_RECORD_LOGO_SCENE | 2 | Large cloud recording logo in the main window. |
Return Values
void
Callback Method Parameters
(ret: SDKERR, reason: string) => void
Parameter | Type | Description |
---|---|---|
ret | For details about SDKERR, see Error Code Reference. | Error code. |
reason | string | Error description. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot