Package host.anzo.eossdk.eos.sdk.rtc.options

Class EOS_RTC_JoinRoomOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.rtc.options.EOS_RTC_JoinRoomOptions

Direct Known Subclasses:

EOS_RTC_JoinRoomOptions.ByReference, EOS_RTC_JoinRoomOptions.ByValue

@FieldOrder({"ApiVersion","LocalUserId","RoomName","ClientBaseUrl","ParticipantToken","ParticipantId","Flags","IsManualAudioInputEnabled","IsManualAudioOutputEnabled"})
public class EOS_RTC_JoinRoomOptions
extends com.sun.jna.Structure

This struct is used to call EOS_RTC_JoinRoom.

Since:

11/01/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_RTC_JoinRoomOptions.ByReference
static class	EOS_RTC_JoinRoomOptions.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	Description
int	ApiVersion	API Version: Set this to EOS_RTC_JOINROOM_API_LATEST.
String	ClientBaseUrl	The room the user would like to join.
static final int	EOS_RTC_JOINROOM_API_LATEST	The most recent version of the EOS_RTC_JoinRoom API.
EOS_RTC_JoinRoomOptions_Flags	Flags	Join room flags, e.g.
EOS_Bool	IsManualAudioInputEnabled	Enable or disable Manual Audio Input.
EOS_Bool	IsManualAudioOutputEnabled	Enable or disable Manual Audio Output.
EOS_ProductUserId	LocalUserId	The product user id of the user trying to request this operation.
EOS_ProductUserId	ParticipantId	The participant id used to join the room.
String	ParticipantToken	Authorization credential token to join the room.
String	RoomName	The room the user would like to join.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
EOS_RTC_JoinRoomOptions()
EOS_RTC_JoinRoomOptions(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 Details

EOS_RTC_JOINROOM_API_LATEST

public static final int EOS_RTC_JOINROOM_API_LATEST

The most recent version of the EOS_RTC_JoinRoom API.

See Also:

• Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_RTC_JOINROOM_API_LATEST.

LocalUserId

public EOS_ProductUserId LocalUserId

The product user id of the user trying to request this operation.

RoomName

public String RoomName

The room the user would like to join.

ClientBaseUrl

public String ClientBaseUrl

The room the user would like to join.

ParticipantToken

public String ParticipantToken

Authorization credential token to join the room.

ParticipantId

public EOS_ProductUserId ParticipantId

The participant id used to join the room. If set to NULL the LocalUserId will be used instead.

Flags

public EOS_RTC_JoinRoomOptions_Flags Flags

Join room flags, e.g. EOS_RTC_JoinRoomOptions_Flags.EOS_RTC_JOINROOMFLAGS_ENABLE_ECHO. This is a bitwise-or union of the defined flags.

IsManualAudioInputEnabled

public EOS_Bool IsManualAudioInputEnabled

Enable or disable 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.

IsManualAudioOutputEnabled

public EOS_Bool IsManualAudioOutputEnabled

Enable or disable 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.

Constructor Details

EOS_RTC_JoinRoomOptions

public EOS_RTC_JoinRoomOptions()

EOS_RTC_JoinRoomOptions

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