Event

• onSeatTakingRequested
• onSeatTakingRequestCanceled
• onSeatTakingInviteRejected
• onSeatTakingRequestRejected
• onHostSeatTakingInviteSent
• onMemberListMoreButtonPressed
• onSeatsChanged
• onSeatsClosed
• onSeatsOpened
• onSeatClosed
• onSeatOpened
• onTurnOnYourMicrophoneRequest
• onSeatClicked
• onUserCountOrPropertyChanged
• playAudioConfig

onSeatTakingRequested

This callback will be triggered to host when room host receive user's request to be a speaker.

• function prototype:

Untitled

onSeatTakingRequested(audience)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatTakingRequested: (audience) => {
           //...
       },
   }}
/>

1

Copied!

onSeatTakingRequestCanceled

This callback will be triggered to host when room host receive audience's request to be a speaker and then canceled the request.

• function prototype:

Untitled

onSeatTakingRequestCanceled(audience)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatTakingRequestCanceled: (audience) => {
           //...
       },
   }}
/>

1

Copied!

onSeatTakingInviteRejected

This callback will be triggered to host when room host invite audience to be speaker and is rejected by audience.

• function prototype:

Untitled

onSeatTakingInviteRejected()

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatTakingInviteRejected: () => {
           //...
       },
   }}
/>

1

Copied!

onSeatTakingRequestRejected

This callback will be triggered to audience when room user request take seat and is rejected by room host.

• function prototype:

Untitled

onSeatTakingRequestRejected()

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatTakingRequestRejected: () => {
           //...
       },
   }}
/>

1

Copied!

onHostSeatTakingInviteSent

This callback will be triggered to audience when room host invite users to be a speaker.

• function prototype:

Untitled

onHostSeatTakingInviteSent()

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onHostSeatTakingInviteSent: () => {
           //...
       },
   }}
/>

1

Copied!

onMemberListMoreButtonPressed

This callback will be triggered to host when room host click more button of memebr list.

• function prototype:

Untitled

onMemberListMoreButtonPressed(userInfo)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onMemberListMoreButtonPressed: (userInfo) => {
           //...
       },
   }}
/>

1

Copied!

onSeatsChanged

This callback will be triggered when room speaker changed.

• function prototype:

Untitled

onSeatsChanged(takenSeats, untakenSeats)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatsChanged: (takenSeats, untakenSeats) => {
           //...
       },
   }}
/>

1

Copied!

onSeatsClosed

This callback will be triggered when room host close all seats.

• function prototype:

Untitled

onSeatsClosed()

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatsClosed: () => {
           //...
       },
   }}
/>

1

Copied!

onSeatsOpened

This callback will be triggered when room host open all seats.

• function prototype:

Untitled

onSeatsOpened()

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatsOpened: () => {
           //...
       },
   }}
/>

1

Copied!

onSeatClosed

This callback will be triggered when room host close seat of position index.

• function prototype:

Untitled

onSeatClosed(index)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatClosed: (index) => {
           //...
       },
   }}
/>

1

Copied!

onSeatOpened

This callback will be triggered when room host open seat of position index.

• function prototype:

Untitled

onSeatOpened(index)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatOpened: (index) => {
           //...
       },
   }}
/>

1

Copied!

onTurnOnYourMicrophoneRequest

This callback will be triggered when other user try to open your microphone.

• function prototype:

Untitled

onTurnOnYourMicrophoneRequest(formUser)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onTurnOnYourMicrophoneRequest: (formUser) => {
           //...
       },
   }}
/>

1

Copied!

onSeatClicked

This callback will be triggered when host or audience click the seat.

• function prototype:

Untitled

onSeatClicked(index, user)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onSeatClicked: (index, user) => {
           //...
       },
   }}
/>

1

Copied!

onUserCountOrPropertyChanged

This callback will be triggered when room user count changed or property changed.

• function prototype:

Untitled

onUserCountOrPropertyChanged(userList)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       onUserCountOrPropertyChanged: (userList) => {
           //...
       },
   }}
/>

1

Copied!

playAudioConfig

If there is an audience in the audio room and they take a seat become speakers, this callback will be triggered. If you return false in this callback, you will not hear the voice of the speaker.

• function prototype:

Untitled

playAudioConfig(localUserID, localRole, speaker)

1

Copied!

• example:

Untitled

<ZegoUIKitPrebuiltLiveAudioRoom
   appID={Your_APPID}
   appSign={Your_APPSign}
   userID={Your_UserID}
   userName={Your_UserName}
   roomID={roomID}
   config={{
       playAudioConfig: (localUserID, localRole, speaker) => {
           //...
           // Returning true means to play the audio from the speaker.
           // Returning false means to mute the speaker.
           return true;
       },
   }}
/>

1

Copied!