EOS_RTCAudio_UpdateReceiving

EOS API reference page for EOS_RTCAudio_UpdateReceiving

Choose your implementation method:

C

C#

Remarks

Use this function to tweak incoming audio options per room.

Due to internal implementation details, this function requires that you first register to any notification for room

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 room

Parameters

EOS_RTCAudio_UpdateReceiving

Parameter Type And Name

Usage Information

EOS_HRTCAudio Handle

const EOS_RTCAudio_UpdateReceivingOptions* Options

structure containing the parameters for the operation.

void* ClientData

Arbitrary data that is passed back in the CompletionDelegate

const EOS_RTCAudio_OnUpdateReceivingCallback CompletionDelegate

The callback to be fired when the operation completes, either successfully or in error

Related API Members

Remarks

Use this function to tweak incoming audio options per room. {Result.InvalidParameters} if any of the parameters are incorrect {Result.NotFound} if either the local user or specified participant are not in the room

Due to internal implementation details, this function requires that you first register to any notification for room

Return Value

{Result.Success} if the operation succeeded

Parameters

RTCAudio.RTCAudioInterface.UpdateReceiving

Parameter Type And Name

Usage Information

UpdateReceivingOptions options

structure containing the parameters for the operation.

object clientData

Arbitrary data that is passed back in the CompletionDelegate

OnUpdateReceivingCallback completionDelegate

The callback to be fired when the operation completes, either successfully or in error

Related API Members

Tags