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

Class EOS_RTCAudio_UpdateParticipantVolumeOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.rtcaudio.options.EOS_RTCAudio_UpdateParticipantVolumeOptions
Direct Known Subclasses:
EOS_RTCAudio_UpdateParticipantVolumeOptions.ByReference, EOS_RTCAudio_UpdateParticipantVolumeOptions.ByValue
@FieldOrder({"ApiVersion","LocalUserId","RoomName","ParticipantId","Volume"}) public class EOS_RTCAudio_UpdateParticipantVolumeOptions extends com.sun.jna.Structure
This struct is passed in with a call to EOS_RTCAudio_UpdateParticipantVolume
Since:
11/2/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_RTCAudio_UpdateParticipantVolumeOptions.ByReference
     
    static class 
    EOS_RTCAudio_UpdateParticipantVolumeOptions.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
    int
    ApiVersion
    API Version: Set this to EOS_RTCAUDIO_UPDATEPARTICIPANTVOLUME_API_LATEST.
    static final int
    EOS_RTCAUDIO_UPDATEPARTICIPANTVOLUME_API_LATEST
    The most recent version of the EOS_RTCAudio_UpdateParticipantVolume API.
    EOS_ProductUserId
    LocalUserId
    The Product User ID of the user trying to request this operation.
    EOS_ProductUserId
    ParticipantId
    The participant to modify or null to update the global configuration
    String
    RoomName
    The room this settings should be applied on.
    float
    Volume
    The volume to be 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_UpdateParticipantVolumeOptions()
     
    EOS_RTCAudio_UpdateParticipantVolumeOptions(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

    • EOS_RTCAUDIO_UPDATEPARTICIPANTVOLUME_API_LATEST

      public static final int EOS_RTCAUDIO_UPDATEPARTICIPANTVOLUME_API_LATEST
      The most recent version of the EOS_RTCAudio_UpdateParticipantVolume API.
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_RTCAUDIO_UPDATEPARTICIPANTVOLUME_API_LATEST.

    • LocalUserId

      public EOS_ProductUserId LocalUserId
      The Product User ID of the user trying to request this operation.

    • 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 to be set for received audio (range 0.0 to 100.0). Volume 50 means that the audio volume is not modified and stays in its source value.

  • Constructor Details

    • EOS_RTCAudio_UpdateParticipantVolumeOptions

      public EOS_RTCAudio_UpdateParticipantVolumeOptions()

    • EOS_RTCAudio_UpdateParticipantVolumeOptions

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