UOnlinePicoFunctionLibrary Class Reference

Pico blueprint function library. More...

#include <OnlinePicoFunctionLibrary.h>

Static Public Member Functions
static void	PicoLogin (UObject *WorldContextObject, int32 LocalUserNum, const FString &UserId, const FString &InToken, const FString &InType, FOnlineManagerLoginCompleteDelegate InLoginComleteDelegate)
	Gets the account login information for the current device. More...
static FString	PicoGetNickName (UObject *WorldContextObject, int32 LocalUserNum)
	Gets a user's nickname. More...
static void	PicoReadFriendList (UObject *WorldContextObject, int32 LocalUserNum, const FString &ListName, FOnlineManagerReadFriendListDelegate InReadFriendListDelegate)
	Reads user's friend list by account number. More...
static void	PicoGetFriendList (UObject *WorldContextObject, int32 LocalUserNum, const FString &ListName, TArray< FPicoUserInfo > &OutFriends)
	Gets an arrary of friends for a specified user by friend list name. More...
static FPicoUserInfo	PicoGetFriend (UObject *WorldContextObject, int32 LocalUserNum, const FString &FriendId, const FString &ListName)
	Gets a user's friends by friend list name and friend ID. More...
static void	PicoRtcGetToken (UObject *WorldContextObject, const FString &UserId, const FString &RoomId, int Ttl, int InValue, FOnlineManagerRtcGetTokenDelegate InRtcGetTokenDelegate)
	Gets the rtc token. More...
static ERtcEngineInitResult	PicoGetRtcEngineInit (UObject *WorldContextObject)
	Initializes the RTC engine. More...
static int	PicoRtcJoinRoom (UObject *WorldContextObject, const FString &RoomId, const FString &UserId, const FString &Token, const FString &UserExtra, ERtcRoomProfileType InRoomProfileType, bool bIsAutoSubscribeAudio)
	Joins a user to a rtc room. More...
static int	RtcDestroyRoom (UObject *WorldContextObject, const FString &RoomId)
	Destroys a room. More...
static void	RtcEnableAudioPropertiesReport (UObject *WorldContextObject, int Interval)
	Enables audio properties report. When this switch is turned on, you will regularly receive a statistical report of audio data. More...
static int	RtcLeaveRoom (UObject *WorldContextObject, const FString &RoomId)
	Leaves a rtc room. More...
static void	RtcMuteLocalAudio (UObject *WorldContextObject, ERtcMuteState InRtcMuteState)
	Mutes local audio to make one's voice unable to be heard be others in the same room. More...
static void	RtcPublishRoom (UObject *WorldContextObject, const FString &RoomId)
	Publishes local audio stream to a room, thereby making the voice heard be others in the same room. More...
static void	RtcUnPublishRoom (UObject *WorldContextObject, const FString &RoomId)
	Stops publishing local audio stream to a room, so others in the same room cannot hear the voice. More...
static void	RtcRoomPauseAllSubscribedStream (UObject *WorldContextObject, const FString &RoomId, ERtcPauseResumeMediaType InPauseResumeMediaType)
	Pauses all subscribed streams of a room. Once paused, the voice of users in the room is blocked so nothing can be heard from this room. More...
static void	RtcRoomResumeAllSubscribedStream (UObject *WorldContextObject, const FString &RoomId, ERtcPauseResumeMediaType InPauseResumeMediaType)
	Resumes all subscribed streams of a room. Once resumed, the voice of users in the room can be heard again. More...
static void	RtcSetAudioPlaybackDevice (UObject *WorldContextObject, ERtcAudioPlaybackDevice InRtcAudioPlaybackDevice)
	Sets the type of audio playback device. More...
static void	RtcSetAudioScenario (UObject *WorldContextObject, ERtcAudioScenarioType InRtcAudioScenarioType)
	Sets audio scenario type. More...
static void	RtcSetCaptureVolume (UObject *WorldContextObject, ERtcStreamIndex InRtcStreamIndex, int InVolume)
	Sets volume for audio capture. More...
static void	RtcSetEarMonitorMode (UObject *WorldContextObject, ERtcEarMonitorMode InRtcEarMonitorMode)
	Sets the in-ear monitoring mode. More...
static void	RtcSetEarMonitorVolume (UObject *WorldContextObject, int InVolume)
	Sets the volume for in-ear monitoring. More...
static void	RtcSetPlaybackVolume (UObject *WorldContextObject, int InVolume)
	Sets the playback volume. More...
static void	RtcStartAudioCapture (UObject *WorldContextObject)
	Starts audio capture. More...
static void	RtcStopAudioCapture (UObject *WorldContextObject)
	Stops audio capture. More...
static void	RtcUpdateToken (UObject *WorldContextObject, const FString &RoomId, const FString &Token)
	Updates room token. More...
static bool	CreateSession (UObject *WorldContextObject, int HostingPlayerNum, FName SessionName, const FPicoOnlineSessionSettings &NewSessionSettings, FPicoManagerOnCreateSessionCompleteDelegate OnCreateSessionCompleteDelegate)
	Creates a private session or a matchmaking session. More...
static bool	StartSession (UObject *WorldContextObject, FName SessionName, FPicoManagerOnStartSessionCompleteDelegate OnStartSessionCompleteDelegate)
	Changes the session state to InProgress. More...
static bool	UpdateSession (UObject *WorldContextObject, FName SessionName, const FPicoOnlineSessionSettings &UpdatedSessionSettings, FPicoManagerOnUpdateSessionCompleteDelegate OnUpdateSessionCompleteDelegate, bool bShouldRefreshOnlineData=true)
	Updates the datastore of a session. More...
static bool	EndSession (UObject *WorldContextObject, FName SessionName, FPicoManagerOnEndSessionCompleteDelegate OnEndSessionCompleteDelegate)
	Changes the session state to Ended. More...
static bool	DestroySession (UObject *WorldContextObject, FName SessionName, FPicoManagerOnDestroySessionCompleteDelegate OnDestroySessionCompleteDelegate)
	Destroys the current session. More...
static bool	IsPlayerInSession (UObject *WorldContextObject, FName SessionName, const FString &UniqueId)
	Checks whether a player is in a session. More...
static bool	StartMatchmaking (UObject *WorldContextObject, const TArray< FString > &LocalPlayers, FName SessionName, const FPicoOnlineSessionSettings &NewSessionSettings, UPARAM(ref) FPicoOnlineSessionSearch &NewSessionSearch, FPicoManagerOnMatchmakingCompleteDelegate OnMatchmakingCompleteDelegate)
	Starts matchmaking for a session. More...
static bool	CancelMatchmaking (UObject *WorldContextObject, int SearchingPlayerNum, FName SessionName, FPicoManagerOnCancelMatchmakingCompleteDelegate OnCancelMatchmakingCompleteDelegate)
	Cancels matchmaking for a session. More...
static bool	FindSessions (UObject *WorldContextObject, int32 SearchingPlayerNum, UPARAM(ref) FPicoOnlineSessionSearch &NewSessionSearch, FPicoManagerOnFindSessionCompleteDelegate OnFindSessionCompleteDelegate)
	Finds matchmaking sessions or moderated sessions. More...
static bool	FindSessionById (UObject *WorldContextObject, const FString &SearchingUserId, const FString &SessionId, FPicoManagerOnSingleSessionResultCompleteDelegate OnSingleSessionResultCompleteDelegate)
	Gets session data by session ID. More...
static bool	JoinSession (UObject *WorldContextObject, int PlayerNum, FName SessionName, const FPicoOnlineSessionSearchResult &SearchResult, FPicoManagerOnJoinSessionCompleteDelegate OnJoinSessionCompleteDelegate)
	Joins a session. More...
static void	DumpSessionState (UObject *WorldContextObject)
	Dumps a session. More...
static EOnlineSessionStatePicoType	GetSessionState (UObject *WorldContextObject, FName SessionName)
	Gets the state of a session. More...
static FPicoNamedOnlineSession	GetNamedSession (UObject *WorldContextObject, FName SessionName)
	Gets the data about a session. More...
static FPicoNamedOnlineSession	AddNamedSessionBySettings (UObject *WorldContextObject, FName SessionName, const FPicoOnlineSessionSettings &SessionSettings)
	Adds session by session settings. More...
static FPicoNamedOnlineSession	AddNamedSession (UObject *WorldContextObject, FName SessionName, const FPicoOnlineSession &Session)
	Adds a session. More...
static FPicoOnlineSessionSettings	GetSessionSettings (UObject *WorldContextObject, FName SessionName)
	Gets the settings of a session. More...
static bool	SendSessionInviteToFriend (UObject *WorldContextObject, int32 LocalUserNum, FName SessionName, const FString &Friend)
	Invites a friend to the session. More...
static bool	PresenceClear (UObject *WorldContextObject, FOnlineManagerPresenceClearDelegate InPresenceClearDelegate)
	Clears a user's presence data in the current app. More...
static void	ReadInvitableUser (UObject *WorldContextObject, TArray< FString > SuggestedUserList, FOnlineManagerPresenceReadInvitableUserDelegate InReadInvitableUserDelegate)
	Reads a list of invitable users for a user. More...
static bool	GetInvitableFriendList (UObject *WorldContextObject, TArray< FPicoUserInfo > &OutFriendsList)
	Gets a list of invitable friends for a user. These friends are previously retrieved from the online service when PresenceGetDestinations is complete. More...
static bool	PresenceSet (UObject *WorldContextObject, const FString &ApiName, const FString &LobbySessionId, const FString &MatchSessionId, bool bIsJoinable, const FString &Extra, FOnlineManagerPresenceSetDelegate InPresenceSetDelegate)
	Sets presence data for a user in the current app. More...
static bool	PresenceSetDestination (UObject *WorldContextObject, const FString &ApiName, FOnlineManagerPresenceSetDestinationDelegate InPresenceSetDestinationDelegate)
	Replaces a user's current destination with the provided one. More...
static bool	PresenceSetIsJoinable (UObject *WorldContextObject, bool bIsJoinable, FOnlineManagerPresenceSetIsJoinableDelegate InPresenceSetIsJoinableDelegate)
	Sets whether a user is joinable. More...
static bool	PresenceSetLobbySession (UObject *WorldContextObject, const FString &LobbySession, FOnlineManagerPresenceSetLobbySessionDelegate InPresenceSetLobbySessionDelegate)
	Replaces a user's current lobby session ID with the provided one. More...
static bool	PresenceSetMatchSession (UObject *WorldContextObject, const FString &MatchSession, FOnlineManagerPresenceSetMatchSessionDelegate InPresenceSetMatchSessionDelegate)
	Replaces a user's current match session ID with the provided one. More...
static bool	PresenceSetExtra (UObject *WorldContextObject, const FString &Extra, FOnlineManagerPresenceSetExtraDelegate InPresenceSetExtraDelegate)
	Sets extra presence data for a user. More...
static bool	PresenceReadSendInvites (UObject *WorldContextObject, FOnlineManagerPresenceReadSentInvitesDelegate InPresenceReadSendInvitesDelegate)
	Reads a list of sent invitations. More...
static bool	PresenceSendInvites (UObject *WorldContextObject, TArray< FString > UserIdArray, FOnlineManagerPresenceSentInvitesDelegate InPresenceSentInvitesDelegate)
	Sends invitations to users. More...
static bool	GetSendInvitesList (UObject *WorldContextObject, TArray< FPicoApplicationInvite > &OutList)
	Gets a list of sent invitations when PresenceSendInvites or PresenceReadSendInvites is complete. More...
static bool	PresenceGetDestinations (UObject *WorldContextObject, FOnlineManagerPresenceGetDestinationsDelegate InPresenceGetDestinationsDelegate)
	Gets all the destinations that can be set for a user. More...
static bool	PresenceGetDestinationsList (UObject *WorldContextObject, TArray< FPicoDestination > &OutList)
	Gets a list of destinations when PresenceGetDestinations is complete. More...
static bool	LaunchOtherApp (UObject *WorldContextObject, const FString &AppID, const FString &Message, FOnlineManagerLaunchOtherAppDelegate InLaunchOtherAppDelegate)
	Launches a different app in a user's library. More...
static bool	LaunchOtherAppByPresence (UObject *WorldContextObject, const FString &AppID, const FString &PackageName, const FString &Message, const FString &ApiName, const FString &LobbySessionId, const FString &MatchSessionId, const FString &TrackId, const FString &Extra, FOnlineManagerLaunchOtherAppByPresenceDelegate InLaunchOtherAppByPresenceDelegate)
	Launches a different app in a user's library. More...
static bool	GetLaunchDetails (UObject *WorldContextObject, FLaunchDetails &OutLaunchDetails)
	Gets information about how the app was launched. More...
static bool	LogDeeplinkResult (UObject *WorldContextObject, const FString &TrackingID, ELaunchResult LaunchResult)
	Logs if the user has been successfully directed to the desired destination via a deep link. More...
static bool	ReadLeaderboards (UObject *WorldContextObject, const TArray< FString > &Players, UPARAM(ref) FPicoOnlineLeaderboardRead &PicoReadObject, FPicoManagerOnReadLeaderboardsCompleteDelegate OnReadLeaderboardsCompleteDelegate)
	Get entries of a leaderboard. More...
static bool	ReadLeaderboardsForFriends (UObject *WorldContextObject, int32 LocalUserNum, UPARAM(ref) FPicoOnlineLeaderboardRead &PicoReadObject, FPicoManagerOnReadLeaderboardsCompleteDelegate OnReadLeaderboardsCompleteDelegate)
	Get entries of a leaderboard. More...
static bool	WriteLeaderboards (UObject *WorldContextObject, const FString &SessionName, const FString &Player, UPARAM(ref) FPicoOnlineLeaderboardWrite &PicoWriteObject)
	Writes a entry of a leaderboard. More...
static UOnlineSubsystemPicoManager *	GetOnlineSubsystemPicoManager ()
	Gets the class of online subsystem Pico manager for binding notifications. More...

Detailed Description

Pico blueprint function library.