EOS_RTC_BlockParticipant

EOS API reference page for EOS_RTC_BlockParticipant

Choose your implementation method:

C

C#

This function is part of the RTC Interface.

Remarks

Use this function to block a participant already connected to the room. After blocking them no media will be sent or received between that user and the local user. This method can be used after receiving the OnParticipantStatusChanged notification.

Return Value

  • EOS_Success if the operation succeeded

  • EOS_InvalidParameters if any of the parameters are incorrect

  • EOS_NotFound if either the local user or specified participant are not in the specified room

Parameters

EOS_RTC_BlockParticipant

Parameter Type And Name

Usage Information

EOS_HRTC Handle

EOS_RTC_BlockParticipantOptions* Options

structure containing the parameters for the operation.

void* ClientData

Arbitrary data that is passed back in the CompletionDelegate

const EOS_RTC_OnBlockParticipantCallback CompletionDelegate

a callback that is fired when the async operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

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

Callback Remarks

Callback for completion of block participants request.

Callback Parameters

EOS_RTC_OnBlockParticipantCallback

Parameter Type And Name

Usage Information

const EOS_RTC_BlockParticipantCallbackInfo* Data

Related API Members

This function is part of the RTC Interface.

Remarks

Use this function to block a participant already connected to the room. After blocking them no media will be sent or received between that user and the local user. This method can be used after receiving the OnParticipantStatusChanged notification. {Result.InvalidParameters} if any of the parameters are incorrect {Result.NotFound} if either the local user or specified participant are not in the specified room

Return Value

{Result.Success} if the operation succeeded

Parameters

RTC.RTCInterface.BlockParticipant

Parameter Type And Name

Usage Information

BlockParticipantOptions options

structure containing the parameters for the operation.

object clientData

Arbitrary data that is passed back in the CompletionDelegate

OnBlockParticipantCallback completionDelegate

a callback that is fired when the async operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

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

Callback Remarks

Callback for completion of block participants request.

Callback Parameters

RTC.OnBlockParticipantCallback

Parameter Type And Name

Usage Information

BlockParticipantCallbackInfo data

Related API Members