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

Class EOS_RTCAudio_UpdateParticipantVolumeCallbackInfo

java.lang.Object

com.sun.jna.Structure

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

Direct Known Subclasses:

EOS_RTCAudio_UpdateParticipantVolumeCallbackInfo.ByReference, EOS_RTCAudio_UpdateParticipantVolumeCallbackInfo.ByValue

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

This struct is passed in with a call to EOS_RTCAudio_OnUpdateParticipantVolumeCallback.

Since:

11/2/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_RTCAudio_UpdateParticipantVolumeCallbackInfo.ByReference
static class	EOS_RTCAudio_UpdateParticipantVolumeCallbackInfo.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_UpdateParticipantVolume.
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 volume of remote participant audio was successfully changed. EOS_EResult.EOS_InvalidParameters if any of the parameters are incorrect EOS_EResult.EOS_NotFound if either the local user or specified participant are not in the room EOS_EResult.EOS_UnexpectedError otherwise.
String	RoomName	The room this settings should be applied on.
float	Volume	The volume that was set for received audio (range 0.0 to 100.0).

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_UpdateParticipantVolumeCallbackInfo()
EOS_RTCAudio_UpdateParticipantVolumeCallbackInfo(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 volume of remote participant audio was successfully changed.
EOS_EResult.EOS_InvalidParameters if any of the parameters are incorrect
EOS_EResult.EOS_NotFound if either the local user or specified participant are not in the room
EOS_EResult.EOS_UnexpectedError otherwise.

ClientData

public com.sun.jna.Pointer ClientData

Client-specified data passed into EOS_RTCAudio_UpdateParticipantVolume.

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

Volume

public float Volume

The volume that was set for received audio (range 0.0 to 100.0).

Constructor Details

EOS_RTCAudio_UpdateParticipantVolumeCallbackInfo

public EOS_RTCAudio_UpdateParticipantVolumeCallbackInfo()

EOS_RTCAudio_UpdateParticipantVolumeCallbackInfo

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