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

Class EOS_RTCAudio_SetOutputDeviceSettingsOptions

java.lang.Object

com.sun.jna.Structure

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

Direct Known Subclasses:

EOS_RTCAudio_SetOutputDeviceSettingsOptions.ByReference, EOS_RTCAudio_SetOutputDeviceSettingsOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","LocalUserId","RealDeviceId"})
public class EOS_RTCAudio_SetOutputDeviceSettingsOptions
extends com.sun.jna.Structure

This struct is used to call EOS_RTCAudio_SetOutputDeviceSettings.

Since:

11/2/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_RTCAudio_SetOutputDeviceSettingsOptions.ByReference
static class	EOS_RTCAudio_SetOutputDeviceSettingsOptions.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 and Description
int	ApiVersion API Version: Set this to EOS_RTCAUDIO_SETOUTPUTDEVICESETTINGS_API_LATEST.
static int	EOS_RTCAUDIO_SETOUTPUTDEVICESETTINGS_API_LATEST The most recent version of the EOS_RTCAudio_SetOutputDeviceSettings API.
EOS_ProductUserId	LocalUserId The Product User ID of the user who initiated this request.
java.lang.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 and Description
EOS_RTCAudio_SetOutputDeviceSettingsOptions()
EOS_RTCAudio_SetOutputDeviceSettingsOptions(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 Detail

EOS_RTCAUDIO_SETOUTPUTDEVICESETTINGS_API_LATEST

public static final int EOS_RTCAUDIO_SETOUTPUTDEVICESETTINGS_API_LATEST

The most recent version of the EOS_RTCAudio_SetOutputDeviceSettings API.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_RTCAUDIO_SETOUTPUTDEVICESETTINGS_API_LATEST.

LocalUserId

public EOS_ProductUserId LocalUserId

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

RealDeviceId

public java.lang.String RealDeviceId

The device Id to be used for this user. Pass NULL or empty string to use a default output 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 output 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:

EOS_RTC_Audio_Interface.addNotifyAudioDevicesChanged(EOS_RTCAudio_AddNotifyAudioDevicesChangedOptions, Pointer, EOS_RTCAudio_OnAudioDevicesChangedCallback)

Constructor Detail

EOS_RTCAudio_SetOutputDeviceSettingsOptions

public EOS_RTCAudio_SetOutputDeviceSettingsOptions()

EOS_RTCAudio_SetOutputDeviceSettingsOptions

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