Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces
References
| Module | OnlineSubsystem |
| Header | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineSessionInterface.h |
| Include | #include "Interfaces/OnlineSessionInterface.h" |
Syntax
class IOnlineSession
Remarks
Interface definition for the online services session services Session services are defined as anything related managing a session and its state within a platform service
Variables
| Type | Name | Description | |
|---|---|---|---|
| FOnCancelFindSessionsComplete | OnCancelFindSessionsCompleteDelegates | Delegate fired when the cancellation of a search for an online session has completed | |
| FOnCancelMatchmakingComplete | OnCancelMatchmakingCompleteDelegates | Delegate fired when the cloud matchmaking has been canceled | |
| FOnCreateSessionComplete | OnCreateSessionCompleteDelegates | Delegate fired when a session create request has completed | |
| FOnDestroySessionComplete | OnDestroySessionCompleteDelegates | Delegate fired when a destroying an online session has completed | |
| FOnEndSessionComplete | OnEndSessionCompleteDelegates | Delegate fired when the online session has transitioned to the ending state | |
| FOnFindFriendSessionComplete[1] | OnFindFriendSessionCompleteDelegates | Delegate fired once the find friend task has completed Session has not been joined at this point, and still requires a call to JoinSession() | |
| FOnFindSessionsComplete | OnFindSessionsCompleteDelegates | Delegate fired when the search for an online session has completed | |
| FOnJoinSessionComplete | OnJoinSessionCompleteDelegates | Delegate fired when the process for a local user joining an online session has completed | |
| FOnMatchmakingComplete | OnMatchmakingCompleteDelegates | Delegate fired when the cloud matchmaking has completed | |
| FOnPingSearchResultsComplete | OnPingSearchResultsCompleteDelegates | Delegate fired when an individual server's query has completed | |
| FOnQosDataRequested | OnQosDataRequestedDelegates | Delegate fired when session is requesting QOS measurements | |
| FOnRegisterPlayersComplete | OnRegisterPlayersCompleteDelegates | Delegate fired when the session registration process has completed | |
| FOnSessionFailure | OnSessionFailureDelegates | Delegate fired when an unexpected error occurs that impacts session connectivity or use | |
| FOnSessionInviteReceived | OnSessionInviteReceivedDelegates | Called when a user receives a session invitation. | |
| FOnSessionParticipantJoined | OnSessionParticipantJoinedDelegates | Delegate fired when a player joins a session | |
| FOnSessionParticipantLeft | OnSessionParticipantLeftDelegates | Delegate fired when a player leaves a session | |
| FOnSessionParticipantRemoved | OnSessionParticipantRemovedDelegates | Delegate fired when a session's member is removed from the session | |
| FOnSessionParticipantsChange | OnSessionParticipantsChangeDelegates | Delegate fired when a player has joined or left a session | |
| FOnSessionParticipantSettingsUpdated | OnSessionParticipantSettingsUpdatedDelegates | Delegate fired when a session's member settings have changed | |
| FOnSessionSettingsUpdated | OnSessionSettingsUpdatedDelegates | Delegate fired when a session's settings have changed | |
| FOnSessionUserInviteAccepted | OnSessionUserInviteAcceptedDelegates | Called when a user accepts a session invitation. | |
| FOnStartSessionComplete | OnStartSessionCompleteDelegates | Delegate fired when the online session has transitioned to the started state | |
| FOnUnregisterPlayersComplete | OnUnregisterPlayersCompleteDelegates | Delegate fired when the un-registration process has completed | |
| FOnUpdateSessionComplete | OnUpdateSessionCompleteDelegates | Delegate fired when a update request has completed |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Hidden on purpose |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| FNamedOnlineSession * | AddNamedSession
(
FName SessionName, |
Adds a new named session to the list (from existing session data) | |
| FNamedOnlineSession * | AddNamedSession
(
FName SessionName, |
Adds a new named session to the list (new session) | |
| FDelegateHandle | AddOnCancelFindSessionsCompleteDelegate_Handle
(
const FOnCancelFindSessionsCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnCancelMatchmakingCompleteDelegate_Handle
(
const FOnCancelMatchmakingCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnCreateSessionCompleteDelegate_Handle
(
const FOnCreateSessionCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnDestroySessionCompleteDelegate_Handle
(
const FOnDestroySessionCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnEndSessionCompleteDelegate_Handle
(
const FOnEndSessionCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnFindFriendSessionCompleteDelegate_Handle
(
int32 LocalUserNum, |
||
| FDelegateHandle | AddOnFindSessionsCompleteDelegate_Handle
(
const FOnFindSessionsCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnJoinSessionCompleteDelegate_Handle
(
const FOnJoinSessionCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnMatchmakingCompleteDelegate_Handle
(
const FOnMatchmakingCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnPingSearchResultsCompleteDelegate_Handle
(
const FOnPingSearchResultsCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnQosDataRequestedDelegate_Handle
(
const FOnQosDataRequestedDelegate& Delegate |
||
| FDelegateHandle | AddOnRegisterPlayersCompleteDelegate_Handle
(
const FOnRegisterPlayersCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnSessionFailureDelegate_Handle
(
const FOnSessionFailureDelegate& Delegate |
||
| FDelegateHandle | AddOnSessionInviteReceivedDelegate_Handle
(
const FOnSessionInviteReceivedDelegate& Delegate |
||
| FDelegateHandle | AddOnSessionParticipantJoinedDelegate_Handle
(
const FOnSessionParticipantJoinedDelegate& Delegate |
||
| FDelegateHandle | AddOnSessionParticipantLeftDelegate_Handle
(
const FOnSessionParticipantLeftDelegate& Delegate |
||
| FDelegateHandle | AddOnSessionParticipantRemovedDelegate_Handle
(
const FOnSessionParticipantRemovedDelegate& Delegate |
||
| FDelegateHandle | AddOnSessionParticipantsChangeDelegate_Handle
(
const FOnSessionParticipantsChangeDelegate& Delegate |
||
| FDelegateHandle | |||
| FDelegateHandle | AddOnSessionSettingsUpdatedDelegate_Handle
(
const FOnSessionSettingsUpdatedDelegate& Delegate |
||
| FDelegateHandle | AddOnSessionUserInviteAcceptedDelegate_Handle
(
const FOnSessionUserInviteAcceptedDelegate& Delegate |
||
| FDelegateHandle | AddOnStartSessionCompleteDelegate_Handle
(
const FOnStartSessionCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnUnregisterPlayersCompleteDelegate_Handle
(
const FOnUnregisterPlayersCompleteDelegate& Delegate |
||
| FDelegateHandle | AddOnUpdateSessionCompleteDelegate_Handle
(
const FOnUpdateSessionCompleteDelegate& Delegate |
||
| bool | Cancels the current search in progress if possible for that search type | ||
| bool | CancelMatchmaking
(
int32 SearchingPlayerNum, |
Cancel a Matchmaking request for a given session name | |
| bool | CancelMatchmaking
(
const FUniqueNetId& SearchingPlayerId, |
Cancel a Matchmaking request for a given session name | |
| void | |||
| void | ClearOnCancelFindSessionsCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnCancelMatchmakingCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnCreateSessionCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnDestroySessionCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnEndSessionCompleteDelegates
(
void* Object |
||
| void | ClearOnFindFriendSessionCompleteDelegate_Handle
(
int32 LocalUserNum, |
||
| void | ClearOnFindFriendSessionCompleteDelegates
(
int32 LocalUserNum, |
||
| void | |||
| void | ClearOnFindSessionsCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnJoinSessionCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnMatchmakingCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPingSearchResultsCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnQosDataRequestedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnRegisterPlayersCompleteDelegates
(
void* Object |
||
| void | ClearOnSessionFailureDelegate_Handle
(
FDelegateHandle& Handle |
||
| void | ClearOnSessionFailureDelegates
(
void* Object |
||
| void | |||
| void | ClearOnSessionInviteReceivedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnSessionParticipantJoinedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnSessionParticipantLeftDelegates
(
void* Object |
||
| void | |||
| void | ClearOnSessionParticipantRemovedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnSessionParticipantsChangeDelegates
(
void* Object |
||
| void | |||
| void | ClearOnSessionParticipantSettingsUpdatedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnSessionSettingsUpdatedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnSessionUserInviteAcceptedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnStartSessionCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnUnregisterPlayersCompleteDelegates
(
void* Object |
||
| void | |||
| void | ClearOnUpdateSessionCompleteDelegates
(
void* Object |
||
| bool | CreateSession
(
int32 HostingPlayerNum, |
Creates an online session based upon the settings object specified. | |
| bool | CreateSession
(
const FUniqueNetId& HostingPlayerId, |
Creates an online session based upon the settings object specified. | |
| FUniqueNetIdPtr | CreateSessionIdFromString
(
const FString& SessionIdStr |
Create a session id from a string | |
| bool | DestroySession
(
FName SessionName, |
Destroys the specified online session NOTE: online session de-registration is an async process and does not complete until the OnDestroySessionComplete delegate is called. | |
| void | Dumps out the session state for all known sessions | ||
| bool | EndSession
(
FName SessionName |
Marks an online session as having been ended | |
| bool | FindFriendSession
(
int32 LocalUserNum, |
Allows the local player to follow a friend into a session | |
| bool | FindFriendSession
(
const FUniqueNetId& LocalUserId, |
Allows the local player to follow a friend into a session | |
| bool | FindFriendSession
(
const FUniqueNetId& LocalUserId, |
Allows the local player to retrieve the session of multiple friends | |
| bool | FindSessionById
(
const FUniqueNetId& SearchingUserId, |
Find a single advertised session by session id | |
| bool | FindSessionById
(
const FUniqueNetId& SearchingUserId, |
Find a single advertised session by session id (with userdata) | |
| bool | FindSessions
(
int32 SearchingPlayerNum, |
Searches for sessions matching the settings specified | |
| bool | FindSessions
(
const FUniqueNetId& SearchingPlayerId, |
Searches for sessions matching the settings specified | |
| FNamedOnlineSession * | GetNamedSession
(
FName SessionName |
Searches the named session array for the specified session | |
| int32 | Gets the number of known sessions registered with the interface | ||
| bool | GetResolvedConnectString
(
const FOnlineSessionSearchResult& SearchResult, |
Returns the platform specific connection information for joining a search result. | |
| bool | GetResolvedConnectString
(
FName SessionName, |
Returns the platform specific connection information for joining the match. | |
| FOnlineSessionSettings * | GetSessionSettings
(
FName SessionName |
Returns the session settings object for the session with a matching name | |
| EOnlineSessionState::Type | GetSessionState
(
FName SessionName |
Get the current state of a named session | |
| FString | GetVoiceChatRoomName
(
int32 LocalUserNum, |
Returns the name for the Voice Chat room, if any were created by setting bUseLobbiesVoiceChatIfAvailable to true during session creation | |
| bool | Searches the named session array for any presence enabled session | ||
| bool | IsPlayerInSession
(
FName SessionName, |
Determine if the player is registered in the specified session | |
| bool | JoinSession
(
const FUniqueNetId& LocalUserId, |
Joins the session specified | |
| bool | JoinSession
(
int32 LocalUserNum, |
Joins the session specified | |
| bool | PingSearchResults
(
const FOnlineSessionSearchResult& SearchResult |
Fetches the additional data a session exposes outside of the online service. | |
| void | RegisterLocalPlayer
(
const FUniqueNetId& PlayerId, |
Registers a local player with a session. | |
| bool | RegisterPlayer
(
FName SessionName, |
Registers a player with the online service as being part of the online session | |
| bool | RegisterPlayers
(
FName SessionName, |
Registers a group of players with the online service as being part of the online session | |
| void | RemoveNamedSession
(
FName SessionName |
Searches the named session array for the specified session and removes it | |
| void | RemovePlayerFromSession
(
int32 LocalUserNum, |
Removes a player from the session. | |
| bool | SendSessionInviteToFriend
(
int32 LocalUserNum, |
Sends an invitation to play in the player's current session | |
| bool | SendSessionInviteToFriend
(
const FUniqueNetId& LocalUserId, |
Sends an invitation to play in the player's current session | |
| bool | SendSessionInviteToFriends
(
int32 LocalUserNum, |
Sends invitations to play in the player's current session | |
| bool | SendSessionInviteToFriends
(
const FUniqueNetId& LocalUserId, |
Sends invitations to play in the player's current session | |
| bool | StartMatchmaking
(
const TArray< FUniqueNetIdRef >& LocalPlayers, |
Begins cloud based matchmaking for a session | |
| bool | StartMatchmaking
(
const TArray< FSessionMatchmakingUser >& LocalPlayers, |
Begins cloud based matchmaking for a session | |
| bool | StartSession
(
FName SessionName |
Marks an online session as in progress (as opposed to being in lobby or pending) | |
| void | TriggerOnCancelFindSessionsCompleteDelegates
(
bool Param1 |
||
| void | TriggerOnCancelMatchmakingCompleteDelegates
(
FName Param1, |
||
| void | TriggerOnCreateSessionCompleteDelegates
(
FName Param1, |
||
| void | TriggerOnDestroySessionCompleteDelegates
(
FName Param1, |
||
| void | TriggerOnEndSessionCompleteDelegates
(
FName Param1, |
||
| void | TriggerOnFindFriendSessionCompleteDelegates
(
int32 LocalUserNum, |
||
| void | TriggerOnFindSessionsCompleteDelegates
(
bool Param1 |
||
| void | TriggerOnJoinSessionCompleteDelegates
(
FName Param1, |
||
| void | TriggerOnMatchmakingCompleteDelegates
(
FName Param1, |
||
| void | TriggerOnPingSearchResultsCompleteDelegates
(
bool Param1 |
||
| void | TriggerOnQosDataRequestedDelegates
(
FName Param1 |
||
| void | TriggerOnRegisterPlayersCompleteDelegates
(
FName Param1, |
||
| void | TriggerOnSessionFailureDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnSessionInviteReceivedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnSessionParticipantJoinedDelegates
(
FName Param1, |
||
| void | TriggerOnSessionParticipantLeftDelegates
(
FName Param1, |
||
| void | TriggerOnSessionParticipantRemovedDelegates
(
FName Param1, |
||
| void | TriggerOnSessionParticipantsChangeDelegates
(
FName Param1, |
||
| void | TriggerOnSessionParticipantSettingsUpdatedDelegates
(
FName Param1, |
||
| void | TriggerOnSessionSettingsUpdatedDelegates
(
FName Param1, |
||
| void | TriggerOnSessionUserInviteAcceptedDelegates
(
const bool Param1, |
||
| void | TriggerOnStartSessionCompleteDelegates
(
FName Param1, |
||
| void | TriggerOnUnregisterPlayersCompleteDelegates
(
FName Param1, |
||
| void | TriggerOnUpdateSessionCompleteDelegates
(
FName Param1, |
||
| void | UnregisterLocalPlayer
(
const FUniqueNetId& PlayerId, |
Unregisters a local player with a session. | |
| bool | UnregisterPlayer
(
FName SessionName, |
Unregisters a player with the online service as being part of the online session | |
| bool | UnregisterPlayers
(
FName SessionName, |
Unregisters a group of players with the online service as being part of the online session | |
| bool | UpdateSession
(
FName SessionName, |
Updates the localized settings/properties for the session in question |