host.anzo.eossdk.eos.sdk.lobby.options

Class EOS_Lobby_LocalRTCOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.lobby.options.EOS_Lobby_LocalRTCOptions

Direct Known Subclasses:

EOS_Lobby_LocalRTCOptions.ByReference, EOS_Lobby_LocalRTCOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","Flags","IsUseManualAudioInput","IsUseManualAudioOutput","IsLocalAudioDeviceInputStartsMuted","Reserved"})
public class EOS_Lobby_LocalRTCOptions
extends com.sun.jna.Structure

Input parameters to use with Lobby RTC Rooms.

Since:

8/17/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Lobby_LocalRTCOptions.ByReference
static class	EOS_Lobby_LocalRTCOptions.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_LOBBY_LOCALRTCOPTIONS_API_LATEST.
static int	EOS_LOBBY_LOCALRTCOPTIONS_API_LATEST The most recent version of the EOS_Lobby_LocalRTCOptions structure.
int	Flags Flags for the local user in this room.
EOS_Bool	IsLocalAudioDeviceInputStartsMuted Set to EOS_TRUE to start the audio input device's stream as muted when first connecting to the RTC room.
EOS_Bool	IsUseManualAudioInput Set to EOS_TRUE to enable Manual Audio Input.
EOS_Bool	IsUseManualAudioOutput Set to EOS_TRUE to enable Manual Audio Output.
com.sun.jna.Pointer	Reserved Reserved field, should be nullptr by default

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_Lobby_LocalRTCOptions()
EOS_Lobby_LocalRTCOptions(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_LOBBY_LOCALRTCOPTIONS_API_LATEST

public static final int EOS_LOBBY_LOCALRTCOPTIONS_API_LATEST

The most recent version of the EOS_Lobby_LocalRTCOptions structure.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_LOBBY_LOCALRTCOPTIONS_API_LATEST.

Flags

public int Flags

Flags for the local user in this room. The default is 0 if this struct is not specified. @see EOS_RTC_JoinRoomOptions::Flags

IsUseManualAudioInput

public EOS_Bool IsUseManualAudioInput

Set to EOS_TRUE to enable Manual Audio Input. If manual audio input is enabled, audio recording is not started and the audio buffers must be passed manually using EOS_RTCAudio_SendAudio. The default is EOS_FALSE if this struct is not specified.

IsUseManualAudioOutput

public EOS_Bool IsUseManualAudioOutput

Set to EOS_TRUE to enable Manual Audio Output. If manual audio output is enabled, audio rendering is not started and the audio buffers must be received with EOS_RTCAudio_AddNotifyAudioBeforeRender and rendered manually. The default is EOS_FALSE if this struct is not specified.

IsLocalAudioDeviceInputStartsMuted

public EOS_Bool IsLocalAudioDeviceInputStartsMuted

Set to EOS_TRUE to start the audio input device's stream as muted when first connecting to the RTC room.

It must be manually unmuted with a call to EOS_RTCAudio_UpdateSending. If manual audio output is enabled, this value is ignored. The default value is EOS_FALSE if this struct is not specified.

Reserved

public com.sun.jna.Pointer Reserved

Reserved field, should be nullptr by default

Constructor Detail

EOS_Lobby_LocalRTCOptions

public EOS_Lobby_LocalRTCOptions()

EOS_Lobby_LocalRTCOptions

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