Class EOS_ActiveSession
java.lang.Object
com.sun.jna.PointerType
host.anzo.eossdk.eos.sdk.sessions.EOS_ActiveSession
- All Implemented Interfaces:
com.sun.jna.NativeMapped
,AutoCloseable
Representation of an existing session some local players are actively involved in (via Create/Join)
- Since:
- 9/5/2023
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
EOS_ActiveSession_CopyInfo is used to immediately retrieve a copy of active session information If the call returns an EOS_Success result, the out parameter, OutActiveSessionInfo, must be passed to EOS_ActiveSession_Info_Release to release the memory associated with it.EOS_ActiveSession_GetRegisteredPlayerByIndex is used to immediately retrieve individual players registered with the active session.int
Get the number of registered players associated with this active sessionvoid
release()
Release the memory associated with an active session.Methods inherited from class com.sun.jna.PointerType
equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString
-
Constructor Details
-
EOS_ActiveSession
public EOS_ActiveSession(com.sun.jna.Pointer address) -
EOS_ActiveSession
public EOS_ActiveSession()
-
-
Method Details
-
copyInfo
public EOS_ActiveSession_Info copyInfo(EOS_ActiveSession_CopyInfoOptions options) throws EOSException EOS_ActiveSession_CopyInfo is used to immediately retrieve a copy of active session information If the call returns an EOS_Success result, the out parameter, OutActiveSessionInfo, must be passed to EOS_ActiveSession_Info_Release to release the memory associated with it.- Parameters:
options
- Structure containing the input parameters- Returns:
- Out parameter used to receive the EOS_ActiveSession_Info structure.
- Throws:
EOSInvalidParametersException
- if you pass a null pointer for the out parameterEOSIncompatibleVersionException
- if the API version passed in is incorrectEOSException
- See Also:
-
getRegisteredPlayerCount
Get the number of registered players associated with this active session- Parameters:
options
- the options associated with retrieving the registered player count- Returns:
- number of registered players in the active session or 0 if there is an error
-
getRegisteredPlayerByIndex
public EOS_ProductUserId getRegisteredPlayerByIndex(EOS_ActiveSession_GetRegisteredPlayerByIndexOptions options) EOS_ActiveSession_GetRegisteredPlayerByIndex is used to immediately retrieve individual players registered with the active session.- Parameters:
options
- Structure containing the input parameters- Returns:
- the product user ID for the registered player at a given index or null if that index is invalid
- See Also:
-
release
public void release()Release the memory associated with an active session. This must be called on data retrieved from EOS_Sessions_CopyActiveSessionHandle -
close
- Specified by:
close
in interfaceAutoCloseable
- Throws:
Exception
-