host.anzo.eossdk.eos.sdk.rtc.callbackresults

Class EOS_RTC_JoinRoomCallbackInfo

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.rtc.callbackresults.EOS_RTC_JoinRoomCallbackInfo

Direct Known Subclasses:

EOS_RTC_JoinRoomCallbackInfo.ByReference, EOS_RTC_JoinRoomCallbackInfo.ByValue

@Structure.FieldOrder(value={"ResultCode","ClientData","LocalUserId","RoomName","RoomOptionsCount","RoomOptions"})
public class EOS_RTC_JoinRoomCallbackInfo
extends com.sun.jna.Structure

This struct is passed in with a call to EOS_RTC_OnJoinRoomCallback.

Since:

11/01/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_RTC_JoinRoomCallbackInfo.ByReference
static class	EOS_RTC_JoinRoomCallbackInfo.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
com.sun.jna.Pointer	ClientData Client-specified data passed into EOS_RTC_JoinRoom.
EOS_ProductUserId	LocalUserId The Product User ID of the user who initiated this request.
EOS_EResult	ResultCode This returns: EOS_EResult.EOS_Success if the channel was successfully joined.
java.lang.String	RoomName The room the user was trying to join.
EOS_RTC_Option.ByReference	RoomOptions The room option items.
int	RoomOptionsCount The room option items count.

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_RTC_JoinRoomCallbackInfo()
EOS_RTC_JoinRoomCallbackInfo(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

ResultCode

public EOS_EResult ResultCode

This returns:
EOS_EResult.EOS_Success if the channel was successfully joined.
EOS_EResult.EOS_NoConnection: unable to connect to RTC servers (retryable).
EOS_EResult.EOS_InvalidAuth: if the token is invalid (not retryable).
EOS_EResult.EOS_RTC_TooManyParticipants: if the room cannot accept more participants (not retryable).
EOS_EResult.EOS_AccessDenied: if the room name belongs to the Lobby voice system (not retryable).
EOS_EResult.EOS_UnexpectedError otherwise (retryable).

ClientData

public com.sun.jna.Pointer ClientData

Client-specified data passed into EOS_RTC_JoinRoom.

LocalUserId

public EOS_ProductUserId LocalUserId

The Product User ID of the user who initiated this request.

RoomName

public java.lang.String RoomName

The room the user was trying to join.

RoomOptionsCount

public int RoomOptionsCount

The room option items count.

RoomOptions

public EOS_RTC_Option.ByReference RoomOptions

The room option items.

Constructor Detail

EOS_RTC_JoinRoomCallbackInfo

public EOS_RTC_JoinRoomCallbackInfo()

EOS_RTC_JoinRoomCallbackInfo

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