host.anzo.eossdk.eos.sdk

Class EOS_Lobby_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_Lobby_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_Lobby_Interface
extends com.sun.jna.PointerType

The Lobby Interface is used to manage lobbies that provide a persistent connection between users and notifications of data sharing/updates. Lobbies may also be found by advertising and searching with the backend service. All Lobby Interface calls take a handle of type EOS_HLobby as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetLobbyInterface function.

Since:

8/16/2023

See Also:

EOS_Platform_Interface.getLobbyInterface()

Constructor Summary

Constructors

Constructor and Description
EOS_Lobby_Interface()
EOS_Lobby_Interface(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
EOS_NotificationId	addNotifyJoinLobbyAccepted(EOS_Lobby_AddNotifyJoinLobbyAcceptedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnJoinLobbyAcceptedCallback notificationFn) Register to receive notifications about lobby "JOIN" performed by local user (when no invite) via the overlay.
EOS_NotificationId	addNotifyLeaveLobbyRequested(EOS_Lobby_AddNotifyLeaveLobbyRequestedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnLeaveLobbyRequestedCallback notificationFn) Register to receive notifications about leave lobby requests performed by the local user via the overlay.
EOS_NotificationId	addNotifyLobbyInviteAccepted(EOS_Lobby_AddNotifyLobbyInviteAcceptedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnLobbyInviteAcceptedCallback notificationFn) Register to receive notifications about lobby invites accepted by local user via the overlay.
EOS_NotificationId	addNotifyLobbyInviteReceived(EOS_Lobby_AddNotifyLobbyInviteReceivedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnLobbyInviteReceivedCallback notificationFn) Register to receive notifications about lobby invites sent to local users.
EOS_NotificationId	addNotifyLobbyInviteRejected(EOS_Lobby_AddNotifyLobbyInviteRejectedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnLobbyInviteRejectedCallback notificationFn) Register to receive notifications about lobby invites rejected by local user via the overlay.
EOS_NotificationId	addNotifyLobbyMemberStatusReceived(EOS_Lobby_AddNotifyLobbyMemberStatusReceivedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnLobbyMemberStatusReceivedCallback notificationFn) Register to receive notifications about the changing status of lobby members.
EOS_NotificationId	addNotifyLobbyMemberUpdateReceived(EOS_Lobby_AddNotifyLobbyMemberUpdateReceivedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnLobbyMemberUpdateReceivedCallback notificationFn) Register to receive notifications when a lobby member updates the attributes associated with themselves inside the lobby.
EOS_NotificationId	addNotifyLobbyUpdateReceived(EOS_Lobby_AddNotifyLobbyUpdateReceivedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnLobbyUpdateReceivedCallback notificationFn) Register to receive notifications when a lobby owner updates the attributes associated with the lobby.
EOS_NotificationId	addNotifyRTCRoomConnectionChanged(EOS_Lobby_AddNotifyRTCRoomConnectionChangedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnRTCRoomConnectionChangedCallback notificationFn) Register to receive notifications of when the RTC Room for a particular lobby has a connection status change.
EOS_NotificationId	addNotifySendLobbyNativeInviteRequested(EOS_Lobby_AddNotifySendLobbyNativeInviteRequestedOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnSendLobbyNativeInviteRequestedCallback notificationFn) Register to receive notifications about a lobby "INVITE" performed by a local user via the overlay.
EOS_EResult	copyLobbyDetailsHandle(EOS_Lobby_CopyLobbyDetailsHandleOptions options, com.sun.jna.ptr.PointerByReference outLobbyDetailsHandle) Create a handle to an existing lobby.
EOS_EResult	copyLobbyDetailsHandleByInviteId(EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions options, com.sun.jna.ptr.PointerByReference outLobbyDetailsHandle) EOS_Lobby_CopyLobbyDetailsHandleByInviteId is used to immediately retrieve a handle to the lobby information from after notification of an invite If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.
EOS_EResult	copyLobbyDetailsHandleByUiEventId(EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions options, com.sun.jna.ptr.PointerByReference outLobbyDetailsHandle) EOS_Lobby_CopyLobbyDetailsHandleByUiEventId is used to immediately retrieve a handle to the lobby information from after notification of an join game If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.
void	createLobby(EOS_Lobby_CreateLobbyOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnCreateLobbyCallback completionDelegate) Creates a lobby and adds the user to the lobby membership.
EOS_EResult	createLobbySearch(EOS_Lobby_CreateLobbySearchOptions options, com.sun.jna.ptr.PointerByReference outLobbySearchHandle) Create a lobby search handle.
void	destroyLobby(EOS_Lobby_DestroyLobbyOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnDestroyLobbyCallback completionDelegate) Destroy a lobby given a lobby ID
java.lang.String	getConnectString(EOS_Lobby_GetConnectStringOptions options) Get the Connection string for an EOS lobby.
int	getInviteCount(EOS_Lobby_GetInviteCountOptions options) Get the number of known invites for a given user
java.lang.String	getInviteIdByIndex(EOS_Lobby_GetInviteIdByIndexOptions options) Retrieve an invite ID from a list of active invites for a given user
EOS_EResult	getRTCRoomName(EOS_Lobby_GetRTCRoomNameOptions options, java.nio.ByteBuffer outBuffer, java.nio.IntBuffer inOutBufferLength) TODO: Rework to return string Get the name of the RTC room associated with a specific lobby a local user belongs to.
void	hardMuteMember(EOS_Lobby_HardMuteMemberOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnHardMuteMemberCallback completionDelegate) Hard mute an existing member in the lobby, can't speak but can hear other members of the lobby
EOS_EResult	isRTCRoomConnected(EOS_Lobby_IsRTCRoomConnectedOptions options, java.nio.IntBuffer bOutIsConnected) Get the current connection status of the RTC Room for a lobby.
void	joinLobby(EOS_Lobby_JoinLobbyOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnJoinLobbyCallback completionDelegate) Join a lobby, creating a local instance under a given lobby ID.
void	joinLobbyById(EOS_Lobby_JoinLobbyByIdOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnJoinLobbyByIdCallback completionDelegate) This is a special case of EOS_Lobby_JoinLobby.
void	joinRTCRoom(EOS_Lobby_JoinRTCRoomOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnJoinRTCRoomCallback completionDelegate) Joins the RTC room associated with a specific lobby a local user belongs to.
void	kickMember(EOS_Lobby_KickMemberOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnKickMemberCallback completionDelegate) Kick an existing member from the lobby
void	leaveLobby(EOS_Lobby_LeaveLobbyOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnLeaveLobbyCallback completionDelegate) Leave a lobby given a lobby ID If the lobby you are leaving had an RTC Room enabled, leaving the lobby will also automatically leave the RTC room.
void	leaveRTCRoom(EOS_Lobby_LeaveRTCRoomOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnLeaveRTCRoomCallback completionDelegate) Leaves the RTC room associated with a specific lobby a local user belongs to.
java.lang.String	parseConnectString(EOS_Lobby_ParseConnectStringOptions options) Parse the ConnectString for an EOS lobby invitation to extract just the lobby ID.
void	promoteMember(EOS_Lobby_PromoteMemberOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnPromoteMemberCallback completionDelegate) Promote an existing member of the lobby to owner, allowing them to make lobby data modifications
void	queryInvites(EOS_Lobby_QueryInvitesOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnQueryInvitesCallback completionDelegate) Retrieve all existing invites for a single user
void	rejectInvite(EOS_Lobby_RejectInviteOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnRejectInviteCallback completionDelegate) Reject an invite from another user.
void	removeNotifyJoinLobbyAccepted(EOS_NotificationId inId) Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.
void	removeNotifyLeaveLobbyRequested(EOS_NotificationId inId) Unregister from receiving notifications when a user performs a leave lobby action via the overlay.
void	removeNotifyLobbyInviteAccepted(EOS_NotificationId inId) Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.
void	removeNotifyLobbyInviteReceived(EOS_NotificationId inId) Unregister from receiving notifications when a user receives a lobby invitation.
void	removeNotifyLobbyInviteRejected(EOS_NotificationId inId) Unregister from receiving notifications when a user rejects a lobby invitation via the overlay.
void	removeNotifyLobbyMemberStatusReceived(EOS_NotificationId inId) Unregister from receiving notifications when lobby members status change.
void	removeNotifyLobbyMemberUpdateReceived(EOS_NotificationId inId) Unregister from receiving notifications when lobby members change their data.
void	removeNotifyLobbyUpdateReceived(EOS_NotificationId inId) Unregister from receiving notifications when a lobby changes its data.
void	removeNotifyRTCRoomConnectionChanged(EOS_NotificationId inId) Unregister from receiving notifications when an RTC Room's connection status changes.
void	removeNotifySendLobbyNativeInviteRequested(EOS_NotificationId inId) Unregister from receiving notifications when a user requests a send invite via the overlay.
void	sendInvite(EOS_Lobby_SendInviteOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnSendInviteCallback completionDelegate) Send an invite to another user.
void	updateLobby(EOS_Lobby_UpdateLobbyOptions options, com.sun.jna.Pointer clientData, EOS_Lobby_OnUpdateLobbyCallback completionDelegate) Update a lobby given a lobby modification handle created by EOS_Lobby_UpdateLobbyModification
EOS_EResult	updateLobbyModification(EOS_Lobby_UpdateLobbyModificationOptions options, com.sun.jna.ptr.PointerByReference outLobbyModificationHandle) Creates a lobby modification handle (EOS_HLobbyModification).

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_Lobby_Interface

public EOS_Lobby_Interface(com.sun.jna.Pointer address)

EOS_Lobby_Interface

public EOS_Lobby_Interface()

Method Detail

createLobby

public void createLobby(EOS_Lobby_CreateLobbyOptions options,
                        com.sun.jna.Pointer clientData,
                        EOS_Lobby_OnCreateLobbyCallback completionDelegate)

Creates a lobby and adds the user to the lobby membership. There is no data associated with the lobby at the start and can be added vis EOS_Lobby_UpdateLobbyModification

If the lobby is successfully created with an RTC Room enabled, the lobby system will automatically join and maintain the connection to the RTC room as long as the local user remains in the lobby. Applications can use the EOS_Lobby_GetRTCRoomName to get the name of the RTC Room associated with a lobby, which may be used with many of the functions in the RTC interface. This can be useful to: register for notifications for talking status; to mute or unmute the local user's audio output; to block or unblock room participants; to set local audio device settings; and more.

Parameters:

options - Required fields for the creation of a lobby such as a user count and its starting advertised state

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the create operation completes, either successfully or in error

destroyLobby

public void destroyLobby(EOS_Lobby_DestroyLobbyOptions options,
                         com.sun.jna.Pointer clientData,
                         EOS_Lobby_OnDestroyLobbyCallback completionDelegate)

Destroy a lobby given a lobby ID

Parameters:

options - Structure containing information about the lobby to be destroyed

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the destroy operation completes, either successfully or in error

joinLobby

public void joinLobby(EOS_Lobby_JoinLobbyOptions options,
                      com.sun.jna.Pointer clientData,
                      EOS_Lobby_OnJoinLobbyCallback completionDelegate)

Join a lobby, creating a local instance under a given lobby ID. Backend will validate various conditions to make sure it is possible to join the lobby.

If the lobby is successfully join has an RTC Room enabled, the lobby system will automatically join and maintain the connection to the RTC room as long as the local user remains in the lobby. Applications can use the EOS_Lobby_GetRTCRoomName to get the name of the RTC Room associated with a lobby, which may be used with many of the functions in the RTC interface. This can be useful to: register for notifications for talking status; to mute or unmute the local user's audio output; to block or unblock room participants; to set local audio device settings; and more.

Parameters:

options - Structure containing information about the lobby to be joined

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the join operation completes, either successfully or in error

joinLobbyById

public void joinLobbyById(EOS_Lobby_JoinLobbyByIdOptions options,
                          com.sun.jna.Pointer clientData,
                          EOS_Lobby_OnJoinLobbyByIdCallback completionDelegate)

This is a special case of EOS_Lobby_JoinLobby. It should only be used if the lobby has had Join-by-ID enabled. Additionally, Join-by-ID should only be enabled to support native invites on an integrated platform.

Parameters:

options - Structure containing information about the lobby to be joined

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the join operation completes, either successfully or in error

See Also:

joinLobby(EOS_Lobby_JoinLobbyOptions, Pointer, EOS_Lobby_OnJoinLobbyCallback)

leaveLobby

public void leaveLobby(EOS_Lobby_LeaveLobbyOptions options,
                       com.sun.jna.Pointer clientData,
                       EOS_Lobby_OnLeaveLobbyCallback completionDelegate)

Leave a lobby given a lobby ID

If the lobby you are leaving had an RTC Room enabled, leaving the lobby will also automatically leave the RTC room.

Parameters:

options - Structure containing information about the lobby to be left

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the leave operation completes, either successfully or in error

updateLobbyModification

public EOS_EResult updateLobbyModification(EOS_Lobby_UpdateLobbyModificationOptions options,
                                           com.sun.jna.ptr.PointerByReference outLobbyModificationHandle)

Creates a lobby modification handle (EOS_HLobbyModification). The lobby modification handle is used to modify an existing lobby and can be applied with EOS_Lobby_UpdateLobby. The EOSLobbyModification must be released by calling EOS_LobbyModification_Release once it is no longer needed.

Parameters:

options - Required fields such as lobby ID

outLobbyModificationHandle - Pointer to a Lobby Modification Handle only set if successful

Returns:

EOS_EResult.EOS_Success if we successfully created the Lobby Modification Handle pointed at in OutLobbyModificationHandle, or an error result if the input data was invalid EOS_EResult.EOS_InvalidParameters if any of the options are incorrect

See Also:

EOS_LobbyModification.release(), updateLobby(EOS_Lobby_UpdateLobbyOptions, Pointer, EOS_Lobby_OnUpdateLobbyCallback), EOS_LobbyModification

updateLobby

public void updateLobby(EOS_Lobby_UpdateLobbyOptions options,
                        com.sun.jna.Pointer clientData,
                        EOS_Lobby_OnUpdateLobbyCallback completionDelegate)

Update a lobby given a lobby modification handle created by EOS_Lobby_UpdateLobbyModification

Parameters:

options - Structure containing information about the lobby to be updated

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the update operation completes, either successfully or in error

promoteMember

public void promoteMember(EOS_Lobby_PromoteMemberOptions options,
                          com.sun.jna.Pointer clientData,
                          EOS_Lobby_OnPromoteMemberCallback completionDelegate)

Promote an existing member of the lobby to owner, allowing them to make lobby data modifications

Parameters:

options - Structure containing information about the lobby and member to be promoted

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the promotion operation completes, either successfully or in error

kickMember

public void kickMember(EOS_Lobby_KickMemberOptions options,
                       com.sun.jna.Pointer clientData,
                       EOS_Lobby_OnKickMemberCallback completionDelegate)

Kick an existing member from the lobby

Parameters:

options - Structure containing information about the lobby and member to be kicked

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the kick operation completes, either successfully or in error

hardMuteMember

public void hardMuteMember(EOS_Lobby_HardMuteMemberOptions options,
                           com.sun.jna.Pointer clientData,
                           EOS_Lobby_OnHardMuteMemberCallback completionDelegate)

Hard mute an existing member in the lobby, can't speak but can hear other members of the lobby

Parameters:

options - Structure containing information about the lobby and member to be hard muted

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the hard mute operation completes, either successfully or in error

addNotifyLobbyUpdateReceived

public EOS_NotificationId addNotifyLobbyUpdateReceived(EOS_Lobby_AddNotifyLobbyUpdateReceivedOptions options,
                                                       com.sun.jna.Pointer clientData,
                                                       EOS_Lobby_OnLobbyUpdateReceivedCallback notificationFn)

Register to receive notifications when a lobby owner updates the attributes associated with the lobby.
Must call removeNotifyLobbyUpdateReceived(host.anzo.eossdk.eos.sdk.common.EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyLobbyUpdateReceived

public void removeNotifyLobbyUpdateReceived(EOS_NotificationId inId)

Unregister from receiving notifications when a lobby changes its data.

Parameters:

inId - Handle representing the registered callback

addNotifyLobbyMemberUpdateReceived

public EOS_NotificationId addNotifyLobbyMemberUpdateReceived(EOS_Lobby_AddNotifyLobbyMemberUpdateReceivedOptions options,
                                                             com.sun.jna.Pointer clientData,
                                                             EOS_Lobby_OnLobbyMemberUpdateReceivedCallback notificationFn)

Register to receive notifications when a lobby member updates the attributes associated with themselves inside the lobby.
Must call removeNotifyLobbyMemberUpdateReceived(host.anzo.eossdk.eos.sdk.common.EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyLobbyMemberUpdateReceived

public void removeNotifyLobbyMemberUpdateReceived(EOS_NotificationId inId)

Unregister from receiving notifications when lobby members change their data.

Parameters:

inId - Handle representing the registered callback

addNotifyLobbyMemberStatusReceived

public EOS_NotificationId addNotifyLobbyMemberStatusReceived(EOS_Lobby_AddNotifyLobbyMemberStatusReceivedOptions options,
                                                             com.sun.jna.Pointer clientData,
                                                             EOS_Lobby_OnLobbyMemberStatusReceivedCallback notificationFn)

Register to receive notifications about the changing status of lobby members.
Must call removeNotifyLobbyMemberStatusReceived(host.anzo.eossdk.eos.sdk.common.EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyLobbyMemberStatusReceived

public void removeNotifyLobbyMemberStatusReceived(EOS_NotificationId inId)

Unregister from receiving notifications when lobby members status change.

Parameters:

inId - Handle representing the registered callback

sendInvite

public void sendInvite(EOS_Lobby_SendInviteOptions options,
                       com.sun.jna.Pointer clientData,
                       EOS_Lobby_OnSendInviteCallback completionDelegate)

Send an invite to another user. User must be a member of the lobby or else the call will fail

Parameters:

options - Structure containing information about the lobby and user to invite

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the send invite operation completes, either successfully or in error

rejectInvite

public void rejectInvite(EOS_Lobby_RejectInviteOptions options,
                         com.sun.jna.Pointer clientData,
                         EOS_Lobby_OnRejectInviteCallback completionDelegate)

Reject an invite from another user.

Parameters:

options - Structure containing information about the invite to reject

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the reject invite operation completes, either successfully or in error

queryInvites

public void queryInvites(EOS_Lobby_QueryInvitesOptions options,
                         com.sun.jna.Pointer clientData,
                         EOS_Lobby_OnQueryInvitesCallback completionDelegate)

Retrieve all existing invites for a single user

Parameters:

options - Structure containing information about the invites to query

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the query invites operation completes, either successfully or in error

getInviteCount

public int getInviteCount(EOS_Lobby_GetInviteCountOptions options)

Get the number of known invites for a given user

Parameters:

options - the Options associated with retrieving the current invite count

Returns:

number of known invites for a given user or 0 if there is an error

getInviteIdByIndex

public java.lang.String getInviteIdByIndex(EOS_Lobby_GetInviteIdByIndexOptions options)
                                    throws EOSException

Retrieve an invite ID from a list of active invites for a given user

Parameters:

options - Structure containing the input parameters

Returns:

invite ID stringified version

Throws:

EOSInvalidParametersException - if any of the options are incorrect

EOSNotFoundException - if the invite doesn't exist

EOSException

See Also:

getInviteCount(EOS_Lobby_GetInviteCountOptions), copyLobbyDetailsHandleByInviteId(EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions, PointerByReference)

createLobbySearch

public EOS_EResult createLobbySearch(EOS_Lobby_CreateLobbySearchOptions options,
                                     com.sun.jna.ptr.PointerByReference outLobbySearchHandle)

Create a lobby search handle. This handle may be modified to include various search parameters. Searching is possible in three methods, all mutually exclusive:

• set the lobby ID to find a specific lobby
• set the target user ID to find a specific user
• set lobby parameters to find an array of lobbies that match the search criteria (not available yet)

Parameters:

options - Structure containing required parameters such as the maximum number of search results

outLobbySearchHandle - The new search handle or null if there was an error creating the search handle

Returns:

EOS_EResult.EOS_Success if the search creation completes successfully EOS_EResult.EOS_InvalidParameters if any of the options are incorrect

addNotifyLobbyInviteReceived

public EOS_NotificationId addNotifyLobbyInviteReceived(EOS_Lobby_AddNotifyLobbyInviteReceivedOptions options,
                                                       com.sun.jna.Pointer clientData,
                                                       EOS_Lobby_OnLobbyInviteReceivedCallback notificationFn)

Register to receive notifications about lobby invites sent to local users.
Must call removeNotifyLobbyInviteReceived(EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyLobbyInviteReceived

public void removeNotifyLobbyInviteReceived(EOS_NotificationId inId)

Unregister from receiving notifications when a user receives a lobby invitation.

Parameters:

inId - Handle representing the registered callback

addNotifyLobbyInviteAccepted

public EOS_NotificationId addNotifyLobbyInviteAccepted(EOS_Lobby_AddNotifyLobbyInviteAcceptedOptions options,
                                                       com.sun.jna.Pointer clientData,
                                                       EOS_Lobby_OnLobbyInviteAcceptedCallback notificationFn)

Register to receive notifications about lobby invites accepted by local user via the overlay.
Must call removeNotifyLobbyInviteAccepted(EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyLobbyInviteAccepted

public void removeNotifyLobbyInviteAccepted(EOS_NotificationId inId)

Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.

Parameters:

inId - Handle representing the registered callback

addNotifyLobbyInviteRejected

public EOS_NotificationId addNotifyLobbyInviteRejected(EOS_Lobby_AddNotifyLobbyInviteRejectedOptions options,
                                                       com.sun.jna.Pointer clientData,
                                                       EOS_Lobby_OnLobbyInviteRejectedCallback notificationFn)

Register to receive notifications about lobby invites rejected by local user via the overlay.
Must call removeNotifyLobbyInviteRejected(EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyLobbyInviteRejected

public void removeNotifyLobbyInviteRejected(EOS_NotificationId inId)

Unregister from receiving notifications when a user rejects a lobby invitation via the overlay.

Parameters:

inId - Handle representing the registered callback

addNotifyJoinLobbyAccepted

public EOS_NotificationId addNotifyJoinLobbyAccepted(EOS_Lobby_AddNotifyJoinLobbyAcceptedOptions options,
                                                     com.sun.jna.Pointer clientData,
                                                     EOS_Lobby_OnJoinLobbyAcceptedCallback notificationFn)

Register to receive notifications about lobby "JOIN" performed by local user (when no invite) via the overlay.
Must call removeNotifyJoinLobbyAccepted(EOS_NotificationId) to remove the notification

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyJoinLobbyAccepted

public void removeNotifyJoinLobbyAccepted(EOS_NotificationId inId)

Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.

Parameters:

inId - Handle representing the registered callback

addNotifySendLobbyNativeInviteRequested

public EOS_NotificationId addNotifySendLobbyNativeInviteRequested(EOS_Lobby_AddNotifySendLobbyNativeInviteRequestedOptions options,
                                                                  com.sun.jna.Pointer clientData,
                                                                  EOS_Lobby_OnSendLobbyNativeInviteRequestedCallback notificationFn)

Register to receive notifications about a lobby "INVITE" performed by a local user via the overlay. This is only needed when a configured integrated platform has EOS_IPMF_DisableSDKManagedSessions set. The EOS SDK will then use the state of EOS_IPMF_PreferEOSIdentity and EOS_IPMF_PreferIntegratedIdentity to determine when the NotificationFn is called.
Must call removeNotifySendLobbyNativeInviteRequested(EOS_NotificationId) to remove the notification.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

See Also:

EOS_EIntegratedPlatformManagementFlags.EOS_IPMF_DisableSDKManagedSessions, EOS_EIntegratedPlatformManagementFlags.EOS_IPMF_PreferEOSIdentity, EOS_EIntegratedPlatformManagementFlags.EOS_IPMF_PreferIntegratedIdentity

removeNotifySendLobbyNativeInviteRequested

public void removeNotifySendLobbyNativeInviteRequested(EOS_NotificationId inId)

Unregister from receiving notifications when a user requests a send invite via the overlay.

Parameters:

inId - Handle representing the registered callback

copyLobbyDetailsHandleByInviteId

public EOS_EResult copyLobbyDetailsHandleByInviteId(EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions options,
                                                    com.sun.jna.ptr.PointerByReference outLobbyDetailsHandle)

EOS_Lobby_CopyLobbyDetailsHandleByInviteId is used to immediately retrieve a handle to the lobby information from after notification of an invite If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.

Parameters:

options - Structure containing the input parameters

outLobbyDetailsHandle - out parameter used to receive the lobby handle

Returns:

EOS_EResult.EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
EOS_EResult.EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_EResult.EOS_NotFound If the invite ID cannot be found

See Also:

EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions, EOS_LobbyDetails.release()

copyLobbyDetailsHandleByUiEventId

public EOS_EResult copyLobbyDetailsHandleByUiEventId(EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions options,
                                                     com.sun.jna.ptr.PointerByReference outLobbyDetailsHandle)

EOS_Lobby_CopyLobbyDetailsHandleByUiEventId is used to immediately retrieve a handle to the lobby information from after notification of an join game If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.

Parameters:

options - Structure containing the input parameters

outLobbyDetailsHandle - out parameter used to receive the lobby handle

Returns:

EOS_EResult.EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
EOS_EResult.EOS_InvalidParameters if you pass an invalid ui event ID
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_EResult.EOS_NotFound If the invite ID cannot be found

See Also:

EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions, EOS_LobbyDetails.release()

copyLobbyDetailsHandle

public EOS_EResult copyLobbyDetailsHandle(EOS_Lobby_CopyLobbyDetailsHandleOptions options,
                                          com.sun.jna.ptr.PointerByReference outLobbyDetailsHandle)

Create a handle to an existing lobby. If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.

Parameters:

options - Structure containing information about the lobby to retrieve

outLobbyDetailsHandle - The new active lobby handle or null if there was an error

Returns:

EOS_EResult.EOS_Success if the lobby handle was created successfully
EOS_EResult.EOS_InvalidParameters if any of the options are incorrect
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_EResult.EOS_NotFound if the lobby doesn't exist

getRTCRoomName

public EOS_EResult getRTCRoomName(EOS_Lobby_GetRTCRoomNameOptions options,
                                  java.nio.ByteBuffer outBuffer,
                                  java.nio.IntBuffer inOutBufferLength)

TODO: Rework to return string Get the name of the RTC room associated with a specific lobby a local user belongs to.

This value can be used whenever you need a RoomName value in the RTC_* suite of functions. RTC Room Names must not be used with EOS_RTC_JoinRoom, EOS_RTC_LeaveRoom, or EOS_RTC_AddNotifyDisconnected. Doing so will return EOS_AccessDenied or EOS_INVALID_NOTIFICATIONID if used with those functions.

This function will only succeed when called on a lobby the local user is currently a member of.

Parameters:

options - Structure containing information about the RTC room name to retrieve

outBuffer - The buffer to store the null-terminated room name string within

inOutBufferLength - In: The maximum amount of writable chars in OutBuffer, Out: The minimum amount of chars needed in OutBuffer to store the RTC room name (including the null-terminator)

Returns:

EOS_EResult.EOS_Success if a room exists for the specified lobby, there was enough space in OutBuffer, and the name was written successfully
EOS_EResult.EOS_NotFound if the lobby does not exist
EOS_EResult.EOS_Disabled if the lobby exists, but did not have the RTC Room feature enabled when created
EOS_EResult.EOS_InvalidParameters if you pass a null pointer on invalid length for any of the parameters
EOS_EResult.EOS_LimitExceeded The OutBuffer is not large enough to receive the room name. InOutBufferLength contains the required minimum length to perform the operation successfully.

joinRTCRoom

public void joinRTCRoom(EOS_Lobby_JoinRTCRoomOptions options,
                        com.sun.jna.Pointer clientData,
                        EOS_Lobby_OnJoinRTCRoomCallback completionDelegate)

Joins the RTC room associated with a specific lobby a local user belongs to.

This function will only succeed when called on a lobby that has the RTC Room feature enabled. Clients may check if the RTC Room feature is enabled by inspecting the value of EOS_LobbyDetails_Info::bRTCRoomEnabled.

Parameters:

options - Structure containing information about which lobby a local user should join the RTC Room for

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the join RTC Room operation completes, either successfully or in error

leaveRTCRoom

public void leaveRTCRoom(EOS_Lobby_LeaveRTCRoomOptions options,
                         com.sun.jna.Pointer clientData,
                         EOS_Lobby_OnLeaveRTCRoomCallback completionDelegate)

Leaves the RTC room associated with a specific lobby a local user belongs to.

This function will only succeed when called on a lobby that has the RTC Room feature enabled. Clients may check if the RTC Room feature is enabled by inspecting the value of EOS_LobbyDetails_Info::bRTCRoomEnabled.

Parameters:

options - Structure containing information about which lobby a local user should leave the RTC Room for

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the join RTC Room operation completes, either successfully or in error

isRTCRoomConnected

public EOS_EResult isRTCRoomConnected(EOS_Lobby_IsRTCRoomConnectedOptions options,
                                      java.nio.IntBuffer bOutIsConnected)

Get the current connection status of the RTC Room for a lobby.

The RTC Room connection status is independent of the lobby connection status, however the lobby system will attempt to keep them consistent, automatically connecting to the RTC room after joining a lobby which has an associated RTC room and disconnecting from the RTC room when a lobby is left or disconnected.

This function will only succeed when called on a lobby the local user is currently a member of.

Parameters:

options - Structure containing information about the lobby to query the RTC Room connection status for

bOutIsConnected - If the result is EOS_Success, this will be set to EOS_TRUE if we are connected, or EOS_FALSE if we are not yet connected.

Returns:

EOS_EResult.EOS_Success if we are connected to the specified lobby, the input options and parameters were valid and we were able to write to bOutIsConnected successfully.
EOS_EResult.EOS_NotFound if the lobby doesn't exist
EOS_EResult.EOS_Disabled if the lobby exists, but did not have the RTC Room feature enabled when created
EOS_EResult.EOS_InvalidParameters if bOutIsConnected is NULL, or any other parameters are NULL or invalid

See Also:

addNotifyRTCRoomConnectionChanged(EOS_Lobby_AddNotifyRTCRoomConnectionChangedOptions, Pointer, EOS_Lobby_OnRTCRoomConnectionChangedCallback)

addNotifyRTCRoomConnectionChanged

public EOS_NotificationId addNotifyRTCRoomConnectionChanged(EOS_Lobby_AddNotifyRTCRoomConnectionChangedOptions options,
                                                            com.sun.jna.Pointer clientData,
                                                            EOS_Lobby_OnRTCRoomConnectionChangedCallback notificationFn)

Register to receive notifications of when the RTC Room for a particular lobby has a connection status change.

The RTC Room connection status is independent of the lobby connection status, however the lobby system will attempt to keep them consistent, automatically connecting to the RTC room after joining a lobby which has an associated RTC room and disconnecting from the RTC room when a lobby is left or disconnected.

This notification is entirely informational and requires no action in response by the application. If the connected status is offline (IsConnected is EOS_FALSE), the connection will automatically attempt to reconnect. The purpose of this notification is to allow applications to show the current connection status of the RTC room when the connection is not established.

Unlike EOS_RTC_AddNotifyDisconnected, EOS_RTC_LeaveRoom should not be called when the RTC room is disconnected.

This function will only succeed when called on a lobby the local user is currently a member of.

Parameters:

options - Structure containing information about the lobby to receive updates about

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - The function to call if the RTC Room's connection status changes

Returns:

A valid notification ID if the NotificationFn was successfully registered, or EOS_INVALID_NOTIFICATIONID if the input was invalid, the lobby did not exist, or the lobby did not have an RTC room.

See Also:

removeNotifyRTCRoomConnectionChanged(EOS_NotificationId)

removeNotifyRTCRoomConnectionChanged

public void removeNotifyRTCRoomConnectionChanged(EOS_NotificationId inId)

Unregister from receiving notifications when an RTC Room's connection status changes.

This should be called when the local user is leaving a lobby.

Parameters:

inId - Handle representing the registered callback

See Also:

addNotifyRTCRoomConnectionChanged(EOS_Lobby_AddNotifyRTCRoomConnectionChangedOptions, Pointer, EOS_Lobby_OnRTCRoomConnectionChangedCallback)

getConnectString

public java.lang.String getConnectString(EOS_Lobby_GetConnectStringOptions options)
                                  throws EOSException

Get the Connection string for an EOS lobby. The connection string describes the presence of a player in terms of game state. Xbox platforms expect titles to embed this into their MultiplayerActivity at creation. When present, the SDK will use this value to populate session presence in the social overlay and facilitate platform invitations.

Parameters:

options - Structure containing the input parameters. API version, the LobbyID of the lobby to generate the string from and the PUID of the requesting user.

Returns:

connection string

Throws:

EOSException - if unable to get the connection string

parseConnectString

public java.lang.String parseConnectString(EOS_Lobby_ParseConnectStringOptions options)
                                    throws EOSException

Parse the ConnectString for an EOS lobby invitation to extract just the lobby ID. Used for joining a lobby from a connection string (as generated by GetConnectString) found in a platform invitation or presence.

Parameters:

options - Structure containing the input parameters. API version and ConnectString.

Returns:

lobby ID string

Throws:

EOSException - if unable to parse the connection string

addNotifyLeaveLobbyRequested

public EOS_NotificationId addNotifyLeaveLobbyRequested(EOS_Lobby_AddNotifyLeaveLobbyRequestedOptions options,
                                                       com.sun.jna.Pointer clientData,
                                                       EOS_Lobby_OnLeaveLobbyRequestedCallback notificationFn)

Register to receive notifications about leave lobby requests performed by the local user via the overlay.
When user requests to leave the lobby in the social overlay, the SDK does not automatically leave the lobby, it is up to the game to perform any necessary cleanup and call the leaveLobby(host.anzo.eossdk.eos.sdk.lobby.options.EOS_Lobby_LeaveLobbyOptions, com.sun.jna.Pointer, host.anzo.eossdk.eos.sdk.lobby.callbacks.EOS_Lobby_OnLeaveLobbyCallback) method using the lobbyId sent in the notification function.
If the returned NotificationId is valid, you must call removeNotifyLeaveLobbyRequested(host.anzo.eossdk.eos.sdk.common.EOS_NotificationId) when you no longer wish to have your NotificationHandler called.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

removeNotifyLeaveLobbyRequested

public void removeNotifyLeaveLobbyRequested(EOS_NotificationId inId)

Unregister from receiving notifications when a user performs a leave lobby action via the overlay.

Parameters:

inId - Handle representing the registered callback