Package host.anzo.eossdk.eos.sdk.rtcaudio.callbackresults

Class EOS_RTCAudio_UpdateReceivingCallbackInfo

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.rtcaudio.callbackresults.EOS_RTCAudio_UpdateReceivingCallbackInfo

Direct Known Subclasses:

EOS_RTCAudio_UpdateReceivingCallbackInfo.ByReference, EOS_RTCAudio_UpdateReceivingCallbackInfo.ByValue

@FieldOrder({"ResultCode","ClientData","LocalUserId","RoomName","ParticipantId","IsAudioEnabled"})
public class EOS_RTCAudio_UpdateReceivingCallbackInfo
extends com.sun.jna.Structure

This struct is passed in with a call to EOS_RTCAudio_OnUpdateReceivingCallback.

Since:

11/2/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_RTCAudio_UpdateReceivingCallbackInfo.ByReference
static class	EOS_RTCAudio_UpdateReceivingCallbackInfo.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field	Description
com.sun.jna.Pointer	ClientData	Client-specified data passed into EOS_RTCAudio_UpdateReceiving.
EOS_Bool	IsAudioEnabled	Muted or unmuted audio track
EOS_ProductUserId	LocalUserId	The Product User ID of the user who initiated this request.
EOS_ProductUserId	ParticipantId	The participant to modify or null to update the global configuration
EOS_EResult	ResultCode	This returns: EOS_EResult.EOS_Success if receiving of channels of remote users was successfully enabled/disabled. EOS_EResult.EOS_InvalidParameters if any of the parameters are incorrect. EOS_EResult.EOS_NotFound if the participant isn't found by ParticipantId. EOS_EResult.EOS_UnexpectedError otherwise.
String	RoomName	The room this settings should be applied on.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
EOS_RTCAudio_UpdateReceivingCallbackInfo()
EOS_RTCAudio_UpdateReceivingCallbackInfo(com.sun.jna.Pointer peer)

Method Summary

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ResultCode

public EOS_EResult ResultCode

This returns:
EOS_EResult.EOS_Success if receiving of channels of remote users was successfully enabled/disabled.
EOS_EResult.EOS_InvalidParameters if any of the parameters are incorrect.
EOS_EResult.EOS_NotFound if the participant isn't found by ParticipantId.
EOS_EResult.EOS_UnexpectedError otherwise.

ClientData

public com.sun.jna.Pointer ClientData

Client-specified data passed into EOS_RTCAudio_UpdateReceiving.

LocalUserId

public EOS_ProductUserId LocalUserId

The Product User ID of the user who initiated this request.

RoomName

public String RoomName

The room this settings should be applied on.

ParticipantId

public EOS_ProductUserId ParticipantId

The participant to modify or null to update the global configuration

IsAudioEnabled

public EOS_Bool IsAudioEnabled

Muted or unmuted audio track

Constructor Details

EOS_RTCAudio_UpdateReceivingCallbackInfo

public EOS_RTCAudio_UpdateReceivingCallbackInfo()

EOS_RTCAudio_UpdateReceivingCallbackInfo

public EOS_RTCAudio_UpdateReceivingCallbackInfo(com.sun.jna.Pointer peer)