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

Enum Class EOS_ERTCAudioInputStatus

java.lang.Object

java.lang.Enum<EOS_ERTCAudioInputStatus>

host.anzo.eossdk.eos.sdk.rtcaudio.enums.EOS_ERTCAudioInputStatus

All Implemented Interfaces:

com.sun.jna.NativeMapped, Serializable, Comparable<EOS_ERTCAudioInputStatus>, Constable

public enum EOS_ERTCAudioInputStatus
extends Enum<EOS_ERTCAudioInputStatus>
implements com.sun.jna.NativeMapped

An enumeration of the different audio input device statuses.

Since:

11/1/2023

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EOS_RTCAIS_Failed	Something failed while trying to use the device
EOS_RTCAIS_Idle	The device is not in used right now (e.g: you are alone in the room).
EOS_RTCAIS_Recording	The device is being used and capturing audio
EOS_RTCAIS_RecordingDisconnected	The SDK is in a recording state, but actually capturing silence because the device is disconnected (e.g: the microphone is not plugged in).
EOS_RTCAIS_RecordingSilent	The SDK is in a recording state, but actually capturing silence because the device is exclusively being used by the platform at the moment.

Method Summary

Modifier and Type	Method	Description
Object	fromNative(Object nativeValue, com.sun.jna.FromNativeContext context)
Class<?>	nativeType()
Object	toNative()
static EOS_ERTCAudioInputStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EOS_ERTCAudioInputStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EOS_RTCAIS_Idle

public static final EOS_ERTCAudioInputStatus EOS_RTCAIS_Idle

The device is not in used right now (e.g: you are alone in the room). In such cases, the hardware resources are not allocated.

EOS_RTCAIS_Recording

public static final EOS_ERTCAudioInputStatus EOS_RTCAIS_Recording

The device is being used and capturing audio

EOS_RTCAIS_RecordingSilent

public static final EOS_ERTCAudioInputStatus EOS_RTCAIS_RecordingSilent

The SDK is in a recording state, but actually capturing silence because the device is exclusively being used by the platform at the moment. This only applies to certain platforms.

EOS_RTCAIS_RecordingDisconnected

public static final EOS_ERTCAudioInputStatus EOS_RTCAIS_RecordingDisconnected

The SDK is in a recording state, but actually capturing silence because the device is disconnected (e.g: the microphone is not plugged in). This only applies to certain platforms.

EOS_RTCAIS_Failed

public static final EOS_ERTCAudioInputStatus EOS_RTCAIS_Failed

Something failed while trying to use the device

Method Details

values

public static EOS_ERTCAudioInputStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EOS_ERTCAudioInputStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromNative

public Object fromNative(Object nativeValue,
 com.sun.jna.FromNativeContext context)

Specified by:

fromNative in interface com.sun.jna.NativeMapped

toNative

public Object toNative()

Specified by:

toNative in interface com.sun.jna.NativeMapped

nativeType

public Class<?> nativeType()

Specified by:

nativeType in interface com.sun.jna.NativeMapped