host.anzo.eossdk.eos.sdk.rtcaudio

Class EOS_RTCAudio_OutputDeviceInformation

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.rtcaudio.EOS_RTCAudio_OutputDeviceInformation

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_RTCAudio_OutputDeviceInformation.ByReference, EOS_RTCAudio_OutputDeviceInformation.ByValue

@Structure.FieldOrder(value={"ApiVersion","IsDefaultDevice","DeviceId","DeviceName"})
public class EOS_RTCAudio_OutputDeviceInformation
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

This struct is used to get information about a specific audio output device.

Since:

11/1/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_RTCAudio_OutputDeviceInformation.ByReference
static class	EOS_RTCAudio_OutputDeviceInformation.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_OUTPUTDEVICEINFORMATION_API_LATEST.
java.lang.String	DeviceId The persistent unique id of the audio output device.
java.lang.String	DeviceName Human-readable name of the audio output device
static int	EOS_RTCAUDIO_OUTPUTDEVICEINFORMATION_API_LATEST The most recent version of the EOS_RTCAudio_OutputDeviceInformation struct.
EOS_Bool	IsDefaultDevice True if this is the default audio output device in the system.

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_OutputDeviceInformation()
EOS_RTCAudio_OutputDeviceInformation(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method and Description
void	close()
void	release() Release the memory associated with EOS_RTCAudio_OutputDeviceInformation.

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_OUTPUTDEVICEINFORMATION_API_LATEST

public static final int EOS_RTCAUDIO_OUTPUTDEVICEINFORMATION_API_LATEST

The most recent version of the EOS_RTCAudio_OutputDeviceInformation struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_RTCAUDIO_OUTPUTDEVICEINFORMATION_API_LATEST.

IsDefaultDevice

public EOS_Bool IsDefaultDevice

True if this is the default audio output device in the system.

DeviceId

public java.lang.String DeviceId

The persistent unique id of the audio output device.
The value can be cached - invalidated only when the audio device pool is changed.

See Also:

EOS_RTC_Audio_Interface.addNotifyAudioDevicesChanged(EOS_RTCAudio_AddNotifyAudioDevicesChangedOptions, Pointer, EOS_RTCAudio_OnAudioDevicesChangedCallback)

DeviceName

public java.lang.String DeviceName

Human-readable name of the audio output device

Constructor Detail

EOS_RTCAudio_OutputDeviceInformation

public EOS_RTCAudio_OutputDeviceInformation()

EOS_RTCAudio_OutputDeviceInformation

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

Method Detail

release

public void release()

Release the memory associated with EOS_RTCAudio_OutputDeviceInformation. This must be called on data retrieved from EOS_RTCAudio_CopyOutputDeviceInformationByIndex.

See Also:

EOS_RTCAudio_OutputDeviceInformation, EOS_RTC_Audio_Interface.copyOutputDeviceInformationByIndex(EOS_RTCAudio_CopyOutputDeviceInformationByIndexOptions)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception