zoom_meeting_audio

Zoom Meeting Audio
Description:
  • Zoom Meeting Audio
Source:
Parameters:
Name Type Description
onUserAudioStatusChange function User's audio status changed callback.
onUserActiveAudioChange function The callback event that users whose audio is active changed.
onMuteOnEntryStatusChange function Callback event for the mute on entry status change.
Returns:
Type
ZoomMeetingAudio
Description:
  • Zoom Meeting Audio
Source:
Parameters:
Name Type Description
onUserAudioStatusChange function User's audio status changed callback.
onUserActiveAudioChange function The callback event that users whose audio is active changed.
onMuteOnEntryStatusChange function Callback event for the mute on entry status change.
Returns:
Type
ZoomMeetingAudio

Methods

(inner) MeetingAudio_CanEnableMuteOnEntry() → {Boolean}

Description:
  • Check if the host or cohost can enable mute on entry.
Source:
Returns:
TRUE indicates that the host or cohost can enable mute on entry. Otherwise not.
Type
Boolean

(inner) MeetingAudio_CanEnableMuteOnEntry() → {Boolean}

Description:
  • Check if the host or cohost can enable mute on entry.
Source:
Returns:
TRUE indicates that the host or cohost can enable mute on entry. Otherwise not.
Type
Boolean

(inner) MeetingAudio_EnableMuteOnEntry(bEnable, allowUnmuteBySelf) → {Number}

Description:
  • Mute or umute the user after joining the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to mute the user after joining the meeting.
allowUnmuteBySelf Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnableMuteOnEntry(bEnable, allowUnmuteBySelf) → {Number}

Description:
  • Mute or umute the user after joining the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to mute the user after joining the meeting.
allowUnmuteBySelf Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnablePlayChimeWhenEnterOrExit(bEnable) → {Number}

Description:
  • User joins or leaves the meeting in silence or no.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to play chime when the user joins or leaves the meeting.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnablePlayChimeWhenEnterOrExit(bEnable) → {Number}

Description:
  • User joins or leaves the meeting in silence or no.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to play chime when the user joins or leaves the meeting.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnablePlayMeetingAudio(bEnable) → {Number}

Description:
  • Enable or disable SDK to play meeting audio.
Source:
Parameters:
Name Type Description
bEnable Boolean True means that SDK will play meeting audio, False means that SDK will not play meeting audio.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise fails. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnablePlayMeetingAudio(bEnable) → {Number}

Description:
  • Enable or disable SDK to play meeting audio.
Source:
Parameters:
Name Type Description
bEnable Boolean True means that SDK will play meeting audio, False means that SDK will not play meeting audio.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise fails. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_IsMuteOnEntryEnabled() → {Boolean}

Description:
  • Determine if mute on entry is enabled.
Source:
Returns:
TRUE indicates that mute on entry is enabled.
Type
Boolean

(inner) MeetingAudio_IsMuteOnEntryEnabled() → {Boolean}

Description:
  • Determine if mute on entry is enabled.
Source:
Returns:
TRUE indicates that mute on entry is enabled.
Type
Boolean

(inner) MeetingAudio_IsPlayMeetingAudioEnabled() → {Boolean}

Description:
  • Determine if play meeting audio is enabled or not.
Source:
Returns:
TRUE means enabled, otherwise it is not enabled.
Type
Boolean

(inner) MeetingAudio_IsPlayMeetingAudioEnabled() → {Boolean}

Description:
  • Determine if play meeting audio is enabled or not.
Source:
Returns:
TRUE means enabled, otherwise it is not enabled.
Type
Boolean

(inner) MeetingAudio_JoinVoip() → {Number}

Description:
  • Join VoIP meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_JoinVoip() → {Number}

Description:
  • Join VoIP meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_LeaveVoip() → {Number}

Description:
  • Leave VoIP meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_LeaveVoip() → {Number}

Description:
  • Leave VoIP meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_MuteAudio(userid, allowunmutebyself) → {Number}

Description:
  • Mute the assigned user.
Source:
Parameters:
Name Type Description
userid Number Specify the user ID to mute. null indicates to mute all the participants.
allowunmutebyself Boolean The user may unmute himself when everyone is muted.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_MuteAudio(userid, allowunmutebyself) → {Number}

Description:
  • Mute the assigned user.
Source:
Parameters:
Name Type Description
userid Number Specify the user ID to mute. null indicates to mute all the participants.
allowunmutebyself Boolean The user may unmute himself when everyone is muted.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_SetMeetingAudioStatusCB(onUserAudioStatusChange) → {Boolean}

Description:
  • Set user's audio status changed callback function.
Source:
Parameters:
Name Type Description
onUserAudioStatusChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetMeetingAudioStatusCB(onUserAudioStatusChange) → {Boolean}

Description:
  • Set user's audio status changed callback function.
Source:
Parameters:
Name Type Description
onUserAudioStatusChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetOnMuteOnEntryStatusChangeCB(onMuteOnEntryStatusChange) → {Boolean}

Description:
  • Set callback event for the mute on entry status changed.
Source:
Parameters:
Name Type Description
onMuteOnEntryStatusChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetOnMuteOnEntryStatusChangeCB(onMuteOnEntryStatusChange) → {Boolean}

Description:
  • Set callback event for the mute on entry status changed.
Source:
Parameters:
Name Type Description
onMuteOnEntryStatusChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetUserActiveAudioChangeCB(onUserActiveAudioChange) → {Boolean}

Description:
  • Set the callback event that users whose audio is active changed.
Source:
Parameters:
Name Type Description
onUserActiveAudioChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetUserActiveAudioChangeCB(onUserActiveAudioChange) → {Boolean}

Description:
  • Set the callback event that users whose audio is active changed.
Source:
Parameters:
Name Type Description
onUserActiveAudioChange function
Returns:
Type
Boolean

(inner) MeetingAudio_UnMuteAudio(userid) → {Number}

Description:
  • Unmute the assigned user.
Source:
Parameters:
Name Type Description
userid Number Specify the user ID to unmute.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_UnMuteAudio(userid) → {Number}

Description:
  • Unmute the assigned user.
Source:
Parameters:
Name Type Description
userid Number Specify the user ID to unmute.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

onMuteOnEntryStatusChange

Description:
  • Callback event for the mute on entry status change.
Source:
Parameters:
Name Type Description
bEnabled Boolean Specify whether mute on entry is enabled or not.

onMuteOnEntryStatusChange

Description:
  • Callback event for the mute on entry status change.
Source:
Parameters:
Name Type Description
bEnabled Boolean Specify whether mute on entry is enabled or not.

onUserActiveAudioChange

Description:
  • The callback event that users whose audio is active changed.
Source:
Parameters:
Name Type Description
lstActiveAudio String List to store the ID of user whose audio is active.

onUserActiveAudioChange

Description:
  • The callback event that users whose audio is active changed.
Source:
Parameters:
Name Type Description
lstActiveAudio String List to store the ID of user whose audio is active.

onUserAudioStatusChange

Description:
  • User's audio status changed callback.
Source:
Parameters:
Name Type Description
lstAudioStatusChange String List of the user information with audio status changed. The list will be emptied once the function calls end.
strAudioStatusList Array List of the user information whose audio status changes, saved in json format. This parameter is currently invalid, hereby only for reservations.

onUserAudioStatusChange

Description:
  • User's audio status changed callback.
Source:
Parameters:
Name Type Description
lstAudioStatusChange String List of the user information with audio status changed. The list will be emptied once the function calls end.
strAudioStatusList Array List of the user information whose audio status changes, saved in json format. This parameter is currently invalid, hereby only for reservations.
Zoom Meeting Audio
Description:
  • Zoom Meeting Audio
Source:
Parameters:
Name Type Description
onUserAudioStatusChange function User's audio status changed callback.
onUserActiveAudioChange function The callback event that users whose audio is active changed.
onMuteOnEntryStatusChange function Callback event for the mute on entry status change.
Returns:
Type
ZoomMeetingAudio
Description:
  • Zoom Meeting Audio
Source:
Parameters:
Name Type Description
onUserAudioStatusChange function User's audio status changed callback.
onUserActiveAudioChange function The callback event that users whose audio is active changed.
onMuteOnEntryStatusChange function Callback event for the mute on entry status change.
Returns:
Type
ZoomMeetingAudio

Methods

(inner) MeetingAudio_CanEnableMuteOnEntry() → {Boolean}

Description:
  • Check if the host or cohost can enable mute on entry.
Source:
Returns:
TRUE indicates that the host or cohost can enable mute on entry. Otherwise not.
Type
Boolean

(inner) MeetingAudio_CanEnableMuteOnEntry() → {Boolean}

Description:
  • Check if the host or cohost can enable mute on entry.
Source:
Returns:
TRUE indicates that the host or cohost can enable mute on entry. Otherwise not.
Type
Boolean

(inner) MeetingAudio_EnableMuteOnEntry(bEnable, allowUnmuteBySelf) → {Number}

Description:
  • Mute or umute the user after joining the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to mute the user after joining the meeting.
allowUnmuteBySelf Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnableMuteOnEntry(bEnable, allowUnmuteBySelf) → {Number}

Description:
  • Mute or umute the user after joining the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to mute the user after joining the meeting.
allowUnmuteBySelf Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnablePlayChimeWhenEnterOrExit(bEnable) → {Number}

Description:
  • User joins or leaves the meeting in silence or no.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to play chime when the user joins or leaves the meeting.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnablePlayChimeWhenEnterOrExit(bEnable) → {Number}

Description:
  • User joins or leaves the meeting in silence or no.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to play chime when the user joins or leaves the meeting.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnablePlayMeetingAudio(bEnable) → {Number}

Description:
  • Enable or disable SDK to play meeting audio.
Source:
Parameters:
Name Type Description
bEnable Boolean True means that SDK will play meeting audio, False means that SDK will not play meeting audio.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise fails. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_EnablePlayMeetingAudio(bEnable) → {Number}

Description:
  • Enable or disable SDK to play meeting audio.
Source:
Parameters:
Name Type Description
bEnable Boolean True means that SDK will play meeting audio, False means that SDK will not play meeting audio.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise fails. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_IsMuteOnEntryEnabled() → {Boolean}

Description:
  • Determine if mute on entry is enabled.
Source:
Returns:
TRUE indicates that mute on entry is enabled.
Type
Boolean

(inner) MeetingAudio_IsMuteOnEntryEnabled() → {Boolean}

Description:
  • Determine if mute on entry is enabled.
Source:
Returns:
TRUE indicates that mute on entry is enabled.
Type
Boolean

(inner) MeetingAudio_IsPlayMeetingAudioEnabled() → {Boolean}

Description:
  • Determine if play meeting audio is enabled or not.
Source:
Returns:
TRUE means enabled, otherwise it is not enabled.
Type
Boolean

(inner) MeetingAudio_IsPlayMeetingAudioEnabled() → {Boolean}

Description:
  • Determine if play meeting audio is enabled or not.
Source:
Returns:
TRUE means enabled, otherwise it is not enabled.
Type
Boolean

(inner) MeetingAudio_JoinVoip() → {Number}

Description:
  • Join VoIP meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_JoinVoip() → {Number}

Description:
  • Join VoIP meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_LeaveVoip() → {Number}

Description:
  • Leave VoIP meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_LeaveVoip() → {Number}

Description:
  • Leave VoIP meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_MuteAudio(userid, allowunmutebyself) → {Number}

Description:
  • Mute the assigned user.
Source:
Parameters:
Name Type Description
userid Number Specify the user ID to mute. null indicates to mute all the participants.
allowunmutebyself Boolean The user may unmute himself when everyone is muted.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_MuteAudio(userid, allowunmutebyself) → {Number}

Description:
  • Mute the assigned user.
Source:
Parameters:
Name Type Description
userid Number Specify the user ID to mute. null indicates to mute all the participants.
allowunmutebyself Boolean The user may unmute himself when everyone is muted.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_SetMeetingAudioStatusCB(onUserAudioStatusChange) → {Boolean}

Description:
  • Set user's audio status changed callback function.
Source:
Parameters:
Name Type Description
onUserAudioStatusChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetMeetingAudioStatusCB(onUserAudioStatusChange) → {Boolean}

Description:
  • Set user's audio status changed callback function.
Source:
Parameters:
Name Type Description
onUserAudioStatusChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetOnMuteOnEntryStatusChangeCB(onMuteOnEntryStatusChange) → {Boolean}

Description:
  • Set callback event for the mute on entry status changed.
Source:
Parameters:
Name Type Description
onMuteOnEntryStatusChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetOnMuteOnEntryStatusChangeCB(onMuteOnEntryStatusChange) → {Boolean}

Description:
  • Set callback event for the mute on entry status changed.
Source:
Parameters:
Name Type Description
onMuteOnEntryStatusChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetUserActiveAudioChangeCB(onUserActiveAudioChange) → {Boolean}

Description:
  • Set the callback event that users whose audio is active changed.
Source:
Parameters:
Name Type Description
onUserActiveAudioChange function
Returns:
Type
Boolean

(inner) MeetingAudio_SetUserActiveAudioChangeCB(onUserActiveAudioChange) → {Boolean}

Description:
  • Set the callback event that users whose audio is active changed.
Source:
Parameters:
Name Type Description
onUserActiveAudioChange function
Returns:
Type
Boolean

(inner) MeetingAudio_UnMuteAudio(userid) → {Number}

Description:
  • Unmute the assigned user.
Source:
Parameters:
Name Type Description
userid Number Specify the user ID to unmute.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingAudio_UnMuteAudio(userid) → {Number}

Description:
  • Unmute the assigned user.
Source:
Parameters:
Name Type Description
userid Number Specify the user ID to unmute.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

onMuteOnEntryStatusChange

Description:
  • Callback event for the mute on entry status change.
Source:
Parameters:
Name Type Description
bEnabled Boolean Specify whether mute on entry is enabled or not.

onMuteOnEntryStatusChange

Description:
  • Callback event for the mute on entry status change.
Source:
Parameters:
Name Type Description
bEnabled Boolean Specify whether mute on entry is enabled or not.

onUserActiveAudioChange

Description:
  • The callback event that users whose audio is active changed.
Source:
Parameters:
Name Type Description
lstActiveAudio String List to store the ID of user whose audio is active.

onUserActiveAudioChange

Description:
  • The callback event that users whose audio is active changed.
Source:
Parameters:
Name Type Description
lstActiveAudio String List to store the ID of user whose audio is active.

onUserAudioStatusChange

Description:
  • User's audio status changed callback.
Source:
Parameters:
Name Type Description
lstAudioStatusChange String List of the user information with audio status changed. The list will be emptied once the function calls end.
strAudioStatusList Array List of the user information whose audio status changes, saved in json format. This parameter is currently invalid, hereby only for reservations.

onUserAudioStatusChange

Description:
  • User's audio status changed callback.
Source:
Parameters:
Name Type Description
lstAudioStatusChange String List of the user information with audio status changed. The list will be emptied once the function calls end.
strAudioStatusList Array List of the user information whose audio status changes, saved in json format. This parameter is currently invalid, hereby only for reservations.