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

Enum Class EOS_ERTCBackgroundMode

java.lang.Object

java.lang.Enum<EOS_ERTCBackgroundMode>

host.anzo.eossdk.eos.sdk.common.enums.EOS_ERTCBackgroundMode

All Implemented Interfaces:

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

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

All background modes supported by the RTC components

Since:

10/31/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_RTCBM_KeepRoomsAlive	Application status has no effect on RTC rooms.
EOS_RTCBM_LeaveRooms	Upon entering a background application status, all logged in users leave any RTC rooms.

Method Summary

Modifier and Type	Method	Description
Object	fromNative(Object nativeValue, com.sun.jna.FromNativeContext context)
Class<?>	nativeType()
Object	toNative()
static EOS_ERTCBackgroundMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EOS_ERTCBackgroundMode[]	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_RTCBM_LeaveRooms

public static final EOS_ERTCBackgroundMode EOS_RTCBM_LeaveRooms

Upon entering a background application status, all logged in users leave any RTC rooms. All subsequent attemps to join any RTC rooms will be rejected. Upon returning to a foreground application status, all subsequent attemps to join any RTC rooms will be allowed.

EOS_RTCBM_KeepRoomsAlive

public static final EOS_ERTCBackgroundMode EOS_RTCBM_KeepRoomsAlive

Application status has no effect on RTC rooms. Audio is captured from input devices and is played to output devices. Games should obtain consent from users and otherwise make users aware this is occurring.

Method Details

values

public static EOS_ERTCBackgroundMode[] 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_ERTCBackgroundMode 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