EOS API reference page for EOS_Lobby_HardMuteMember

3 분 소요

This function is part of the Lobby Interface.


Hard mute an existing member in the lobby, can't speak but can hear other members of the lobby

Return Value

  • EOS_Success if the hard mute completes successfully

  • EOS_IncompatibleVersion if the API version passed in is incorrect

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_Invalid_ProductUserID if a target user is incorrect

  • EOS_NotFound if lobby or target user cannot be found

  • EOS_Lobby_VoiceNotEnabled if lobby has no voice enabled

  • EOS_Lobby_NotOwner if the calling user is not the owner of the lobby

  • EOS_NotFound if a lobby of interest does not exist

  • EOS_AlreadyPending if the user is already marked for hard mute

  • EOS_TooManyRequests if there are too many requests



Parameter Type And NameUsage Information
EOS_HLobby Handle
const EOS_Lobby_HardMuteMemberOptions* OptionsStructure containing information about the lobby and member to be hard muted
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Lobby_OnHardMuteMemberCallback CompletionDelegateA callback that is fired when the hard mute operation completes, either successfully or in error

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnHardMuteMemberCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_HardMuteMember

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Lobby_HardMuteMemberCallbackInfo* DataA EOS_Lobby_HardMuteMember CallbackInfo containing the output information and result