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

Class EOS_RTCAudio_SetInputDeviceSettingsOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.rtcaudio.options.EOS_RTCAudio_SetInputDeviceSettingsOptions
Direct Known Subclasses:
EOS_RTCAudio_SetInputDeviceSettingsOptions.ByReference, EOS_RTCAudio_SetInputDeviceSettingsOptions.ByValue
@FieldOrder({"ApiVersion","LocalUserId","RealDeviceId","IsPlatformAEC"}) public class EOS_RTCAudio_SetInputDeviceSettingsOptions extends com.sun.jna.Structure
This struct is used to call EOS_RTCAudio_SetInputDeviceSettings.
Since:
11/2/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_RTCAudio_SetInputDeviceSettingsOptions.ByReference
     
    static class 
    EOS_RTCAudio_SetInputDeviceSettingsOptions.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_SETINPUTDEVICESETTINGS_API_LATEST.
    static final int
    EOS_RTCAUDIO_SETINPUTDEVICESETTINGS_API_LATEST
    The most recent version of the EOS_RTCAudio_SetInputDeviceSettings API.
    EOS_Bool
    IsPlatformAEC
    Enable or disable Platform AEC (Acoustic Echo Cancellation) if available.
    EOS_ProductUserId
    LocalUserId
    The Product User ID of the user trying to request this operation.
    String
    RealDeviceId
    The device Id to be used for this user.

    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_SetInputDeviceSettingsOptions()
     
    EOS_RTCAudio_SetInputDeviceSettingsOptions(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_SETINPUTDEVICESETTINGS_API_LATEST

      public static final int EOS_RTCAUDIO_SETINPUTDEVICESETTINGS_API_LATEST
      The most recent version of the EOS_RTCAudio_SetInputDeviceSettings API.
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_RTCAUDIO_SETINPUTDEVICESETTINGS_API_LATEST.

    • LocalUserId

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

    • RealDeviceId

      public String RealDeviceId
      The device Id to be used for this user. Pass NULL or empty string to use a default input device.

      If the device ID is invalid, the default device will be used instead. Despite this fact, that device ID will be stored and the library will try to move on it when an audio device pool is being changed.

      The actual hardware audio input device usage depends on the current payload and optimized not to use it when generated audio frames cannot be processed by someone else based on a scope of rules (For instance, when a client is alone in a room).

      See Also:

    • IsPlatformAEC

      public EOS_Bool IsPlatformAEC
      Enable or disable Platform AEC (Acoustic Echo Cancellation) if available.

  • Constructor Details

    • EOS_RTCAudio_SetInputDeviceSettingsOptions

      public EOS_RTCAudio_SetInputDeviceSettingsOptions()

    • EOS_RTCAudio_SetInputDeviceSettingsOptions

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