API

• ZegoUIKitPrebuiltLiveAudioRoom
  • applyToTakeSeat
  • cancelSeatTakingRequest
  • acceptSeatTakingRequest
  • rejectSeatTakingRequest
  • inviteAudienceToTakeSeat
  • acceptHostTakeSeatInvitation
  • turnMicrophoneOn
  • removeSpeakerFromSeat
  • takeSeat
  • leaveSeat
  • openSeat
  • closeSeat
  • openSeats
  • closeSeats
  • minimizeWindow
  • leave
  • muteUserAudio

ZegoUIKitPrebuiltLiveAudioRoom

applyToTakeSeat

request take seat to be a speaker.

• function prototype:

Untitled

applyToTakeSeat(index = -1)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.applyToTakeSeat(index);

1

Copied!

cancelSeatTakingRequest

cancel take seat request.

• function prototype:

Untitled

cancelSeatTakingRequest()

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.cancelSeatTakingRequest();

1

Copied!

acceptSeatTakingRequest

accept room user's take seat request.

• function prototype:

Untitled

acceptSeatTakingRequest(audienceUserID)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.acceptSeatTakingRequest(audienceUserID);

1

Copied!

rejectSeatTakingRequest

reject room user's take seat request.

• function prototype:

Untitled

rejectSeatTakingRequest(audienceUserID)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.rejectSeatTakingRequest(audienceUserID);

1

Copied!

inviteAudienceToTakeSeat

invite room user to take seat.

• function prototype:

Untitled

inviteAudienceToTakeSeat(audienceUserID)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.inviteAudienceToTakeSeat(audienceUserID);

1

Copied!

acceptHostTakeSeatInvitation

accept the take seat invitation from others.

• function prototype:

Untitled

acceptHostTakeSeatInvitation()

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.acceptHostTakeSeatInvitation();

1

Copied!

turnMicrophoneOn

open the microphone of specific user,if the target is not your userID,then the target will receive a onTurnOnYourMicrophoneRequest callback.

• function prototype:

Untitled

turnMicrophoneOn(userID, isOn)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.turnMicrophoneOn(userID, isOn);

1

Copied!

removeSpeakerFromSeat

remove user from speaker

• function prototype:

Untitled

removeSpeakerFromSeat(userID)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.removeSpeakerFromSeat(userID);

1

Copied!

takeSeat

try to take seat in position index.

• function prototype:

Untitled

takeSeat(index)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.takeSeat(index);

1

Copied!

leaveSeat

leave seat. If your are not speaker,nothing will happen.

• function prototype:

Untitled

leaveSeat()

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.leaveSeat();

1

Copied!

openSeat

open seat of position index.

• function prototype:

Untitled

openSeat(index)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.openSeat(index);

1

Copied!

closeSeat

close seat of position index.

• function prototype:

Untitled

closeSeat(index)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.closeSeat(index);

1

Copied!

openSeats

make all seats avaiable.Room users can take empty seat directly.

• function prototype:

Untitled

openSeats()

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.openSeats();

1

Copied!

closeSeats

make all seats locked.Room users should request to take empty seat.

• function prototype:

Untitled

closeSeats()

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.closeSeats();

1

Copied!

minimizeWindow

minimize the window.

• function prototype:

Untitled

minimizeWindow()

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.minimizeWindow();

1

Copied!

leave

leave the audio room.

• function prototype:

Untitled

leave(showConfirmation = false)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.leave();

1

Copied!

muteUserAudio

Decide whether to mute the speaker corresponding to the userID based on the mute setting.

• function prototype:

Untitled

muteUserAudio(userID, mute)

1

Copied!

• example:

Untitled

import ZegoUIKitPrebuiltLiveAudioRoom from '@zegocloud/zego-uikit-prebuilt-live-audio-room-rn';

const prebuiltRef = useRef();

<ZegoUIKitPrebuiltLiveAudioRoom
  ref={prebuiltRef}
  appID={KeyCenter.appID}
  appSign={KeyCenter.appSign}
  userID={userID}
  userName={userName}
  roomID={roomID}
  config={{

  }}
/>

prebuiltRef.current.muteUserAudio(userID, mute);

1

Copied!