ZegoLiveStreamingControllerPKImpl class

Here are the APIs related to PK.

Properties

hashCode → int
The hash code for this object.
no setterinherited
isInPK → bool
is in pk or not
no setter
mutedUsersNotifier → ValueNotifier<List<String>>
mute users stream
no setter
private → ZegoLiveStreamingControllerPKPrivateImpl
Don't call that
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stateNotifier → ValueNotifier<ZegoLiveStreamingPKBattleState>
pk state stream
no setter

Methods

acceptRequest({required String requestID, required ZegoLiveStreamingPKUser targetHost, int timeout = 60, String customData = ''}) → Future<ZegoLiveStreamingPKServiceResult>
Accept the PK invitation from the targetHost, which invitation ID is requestID.
cancelRequest({required List<String> targetHostIDs, String customData = ''}) → Future<ZegoLiveStreamingPKServiceResult>
Cancel the PK invitation to targetHostIDs. You can provide your reason by attaching customData.
getHosts(String requestID) → List<AdvanceInvitationUser>
the host list in invitation or in PK.
muteAudios({required List<String> targetHostIDs, required bool isMute}) → Future<bool>
Silence the targetHostIDs in PK, local host and audience in the live streaming won't hear the muted host's voice.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
quit() → Future<ZegoLiveStreamingPKServiceResult>
Quit PK on your own. only pop the PK View on your own end, other PK participants decide on their own.
rejectRequest({required String requestID, required String targetHostID, int timeout = 60, String customData = ''}) → Future<ZegoLiveStreamingPKServiceResult>
Rejects the PK invitation from the targetHost, which invitation ID is requestID.
sendRequest({required List<String> targetHostIDs, int timeout = 60, String customData = '', bool isAutoAccept = false}) → Future<ZegoLiveStreamingPKServiceSendRequestResult>
inviting hosts for a PK.
stop() → Future<ZegoLiveStreamingPKServiceResult>
Stop PK to all pk-hosts, only the PK Initiator can stop it. The PK is over and all participants will exit the PK View.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited