Pico Unity Platform SDK
Pico.Platform Namespace Reference

Namespaces

namespace  Models
 

Classes

class  CLIB
 
class  CoreService
 
class  Looper
 
class  MatchmakingOptions
 
class  MatchmakingService
 
class  Message
 
class  MessageQueue
 
class  NetworkService
 
class  RoomOptions
 
class  RoomService
 
class  RtcAudioPropertyInfo
 
class  RtcAudioPropertyOptions
 
class  RtcGetTokenOptions
 
class  RtcRoomOptions
 
class  RtcService
 
class  Runner
 
class  Task
 
class  UserService
 

Enumerations

enum  PlatformInitializeResult {
  PlatformInitializeResult.Unknown = -999, PlatformInitializeResult.NetError = -6, PlatformInitializeResult.MissingImpl = -5, PlatformInitializeResult.LoadImplFailed = -4,
  PlatformInitializeResult.InternalError = -3, PlatformInitializeResult.InvalidParams = -2, PlatformInitializeResult.AlreadyInitialized = -1, PlatformInitializeResult.Success = 0
}
 
enum  GameConnectionEvent {
  GameConnectionEvent.Connected = 0, GameConnectionEvent.Closed = 1, GameConnectionEvent.Lost = 2, GameConnectionEvent.Resumed = 3,
  GameConnectionEvent.KickedByRelogin = 4, GameConnectionEvent.KickedByGameServer = 5, GameConnectionEvent.GameLogicError = 6, GameConnectionEvent.Unknown = 7
}
 
enum  GameRequestFailedReason {
  GameRequestFailedReason.None = 0, GameRequestFailedReason.NotInitialized = 1, GameRequestFailedReason.Uninitialized = 2, GameRequestFailedReason.CurrentlyUnavailable = 3,
  GameRequestFailedReason.CurrentlyUnknown = 4
}
 
enum  GameInitializeResult {
  GameInitializeResult.Success = 0, GameInitializeResult.Uninitialized = 1, GameInitializeResult.NetworkError = 2, GameInitializeResult.InvalidCredentials = 3,
  GameInitializeResult.ServiceNotAvailable = 4, GameInitializeResult.Unknown = 5
}
 
enum  KVPairType { KVPairType.String = 0, KVPairType.Int = 1, KVPairType.Double = 2, KVPairType.Unknown = 3 }
 
enum  MessageType {
  MessageType.Unknown = -1, MessageType.PlatformInitializeAndroidAsynchronous = 1, MessageType.User_GetLoggedInUser = 10000, MessageType.User_GetAccessToken = 10001,
  MessageType.User_Get = 10002, MessageType.User_LaunchFriendRequestFlow = 10003, MessageType.User_GetLoggedInUserFriends = 10004, MessageType.User_GetNextUserArrayPage = 10005,
  MessageType.Notification_Rtc_OnRoomStats = 10200, MessageType.Notification_Rtc_OnJoinRoom = 10201, MessageType.Notification_Rtc_OnLeaveRoom = 10202, MessageType.Notification_Rtc_OnUserLeaveRoom = 10203,
  MessageType.Notification_Rtc_OnUserJoinRoom = 10204, MessageType.Notification_Rtc_OnConnectionStateChange = 10205, MessageType.Notification_Rtc_OnWarn = 10206, MessageType.Notification_Rtc_OnRoomWarn = 10207,
  MessageType.Notification_Rtc_OnRoomError = 10208, MessageType.Notification_Rtc_OnError = 10209, MessageType.Notification_Rtc_OnUserStartAudioCapture = 10210, MessageType.Notification_Rtc_OnAudioPlaybackDeviceChanged = 10211,
  MessageType.Notification_Rtc_OnRemoteAudioPropertiesReport = 10212, MessageType.Notification_Rtc_OnLocalAudioPropertiesReport = 10213, MessageType.Notification_Rtc_OnUserStopAudioCapture = 10214, MessageType.Notification_Rtc_OnUserMuteAudio = 10215,
  MessageType.Notification_Rtc_OnMediaDeviceStateChanged = 10216, MessageType.Rtc_GetToken = 10300, MessageType.Matchmaking_Browse2 = 10400, MessageType.Matchmaking_Cancel2 = 10402,
  MessageType.Matchmaking_CreateAndEnqueueRoom2 = 10404, MessageType.Matchmaking_Enqueue2 = 10408, MessageType.Matchmaking_EnqueueRoom2 = 10410, MessageType.Matchmaking_GetAdminSnapshot = 10411,
  MessageType.Matchmaking_GetStats = 10412, MessageType.Matchmaking_ReportResultInsecure = 10414, MessageType.Matchmaking_StartMatch = 10415, MessageType.Room_CreateAndJoinPrivate = 10500,
  MessageType.Room_CreateAndJoinPrivate2 = 10501, MessageType.Room_Get = 10502, MessageType.Room_GetCurrent = 10503, MessageType.Room_GetCurrentForUser = 10504,
  MessageType.Room_GetInvitableUsers = 10505, MessageType.Room_GetInvitableUsers2 = 10506, MessageType.Room_GetModeratedRooms = 10507, MessageType.Room_GetNextRoomArrayPage = 10508,
  MessageType.Room_InviteUser = 10509, MessageType.Room_Join = 10510, MessageType.Room_Join2 = 10511, MessageType.Room_KickUser = 10512,
  MessageType.Room_LaunchInvitableUserFlow = 10513, MessageType.Room_Leave = 10514, MessageType.Room_SetDescription = 10515, MessageType.Room_UpdateDataStore = 10516,
  MessageType.Room_UpdateMembershipLockStatus = 10517, MessageType.Room_UpdateOwner = 10518, MessageType.Room_UpdatePrivateRoomJoinPolicy = 10519, MessageType.Notification_Matchmaking_MatchFound = 10600,
  MessageType.Notification_Room_InviteAccepted = 10601, MessageType.Notification_Room_InviteReceived = 10602, MessageType.Notification_Room_RoomUpdate = 10603, MessageType.Notification_Game_ConnectionEvent = 10604,
  MessageType.Notification_Game_RequestFailed = 10605, MessageType.Notification_Game_StateReset = 10606, MessageType.PlatformGameInitializeAsynchronous = 10700
}
 
enum  MatchmakingStatApproach { MatchmakingStatApproach.Unknown = 0, MatchmakingStatApproach.Trailing = 1, MatchmakingStatApproach.Swingy = 2 }
 
enum  MatchmakingCriterionImportance {
  MatchmakingCriterionImportance.Required = 0, MatchmakingCriterionImportance.High = 1, MatchmakingCriterionImportance.Medium = 2, MatchmakingCriterionImportance.Low = 3,
  MatchmakingCriterionImportance.Unknown = 4
}
 
enum  RoomType { RoomType.Unknown = 0, RoomType.Matchmaking = 1, RoomType.Moderated = 2, RoomType.Private = 3 }
 
enum  RoomJoinability {
  RoomJoinability.Unknown = 0, RoomJoinability.AreIn = 1, RoomJoinability.AreKicked = 2, RoomJoinability.CanJoin = 3,
  RoomJoinability.IsFull = 4, RoomJoinability.NoViewer = 5, RoomJoinability.PolicyPrevents = 6
}
 
enum  RoomJoinPolicy {
  RoomJoinPolicy.None = 0, RoomJoinPolicy.Everyone = 1, RoomJoinPolicy.FriendsOfMembers = 2, RoomJoinPolicy.FriendsOfOwner = 3,
  RoomJoinPolicy.InvitedUsers = 4, RoomJoinPolicy.Unknown = 5
}
 
enum  MembershipLockStatus { MembershipLockStatus.Unknown = 0, MembershipLockStatus.Lock = 1, MembershipLockStatus.Unlock = 2 }
 
enum  RtcAudioPlaybackDevice {
  RtcAudioPlaybackDevice.Headset = 1, RtcAudioPlaybackDevice.EarPiece = 2, RtcAudioPlaybackDevice.SpeakerPhone = 3, RtcAudioPlaybackDevice.HeadsetBlueTooth = 4,
  RtcAudioPlaybackDevice.HeadsetUsb = 5
}
 
enum  RtcAudioScenarioType {
  RtcAudioScenarioType.Music = 0, RtcAudioScenarioType.HighQualityCommunication = 1, RtcAudioScenarioType.Communication = 2, RtcAudioScenarioType.Media = 3,
  RtcAudioScenarioType.GameStreaming = 4
}
 
enum  RtcConnectionState {
  RtcConnectionState.Disconnected = 1, RtcConnectionState.Connecting = 2, RtcConnectionState.Connected = 3, RtcConnectionState.Reconnecting = 4,
  RtcConnectionState.Reconnected = 5, RtcConnectionState.Lost = 6
}
 
enum  RtcEarMonitorMode { RtcEarMonitorMode.Off = 0, RtcEarMonitorMode.On = 1 }
 
enum  RtcEngineInitResult { RtcEngineInitResult.Unknown = -999, RtcEngineInitResult.AlreadyInitialized = -1, RtcEngineInitResult.InvalidConfig = -2, RtcEngineInitResult.Success = 0 }
 
enum  RtcJoinRoomType { RtcJoinRoomType.First = 0, RtcJoinRoomType.Reconnected = 1 }
 
enum  RtcMediaDeviceError {
  RtcMediaDeviceError.Ok = 0, RtcMediaDeviceError.NoPermission = 1, RtcMediaDeviceError.DeviceBusy = 2, RtcMediaDeviceError.DeviceFailure = 3,
  RtcMediaDeviceError.DeviceNotFound = 4, RtcMediaDeviceError.DeviceDisconnected = 5, RtcMediaDeviceError.DeviceNoCallback = 6, RtcMediaDeviceError.UnSupportedFormat = 7
}
 
enum  RtcMediaDeviceState {
  RtcMediaDeviceState.Started = 1, RtcMediaDeviceState.Stopped = 2, RtcMediaDeviceState.RuntimeError = 3, RtcMediaDeviceState.Added = 4,
  RtcMediaDeviceState.Removed = 5
}
 
enum  RtcMediaDeviceType { RtcMediaDeviceType.AudioUnknown = -1, RtcMediaDeviceType.AudioRenderDevice = 0, RtcMediaDeviceType.AudioCaptureDevice = 1 }
 
enum  RtcMuteState { RtcMuteState.Off = 0, RtcMuteState.On = 1 }
 
enum  RtcPauseResumeMediaType { RtcPauseResumeMediaType.Audio = 0, RtcPauseResumeMediaType.Video = 1, RtcPauseResumeMediaType.AudioAndVideo = 2 }
 
enum  RtcPrivilege { RtcPrivilege.PublishStream = 0, RtcPrivilege.PublishAudioStream = 1, RtcPrivilege.PublishVideoStream = 2, RtcPrivilege.SubscribeStream = 3 }
 
enum  RtcRoomProfileType {
  RtcRoomProfileType.Communication = 0, RtcRoomProfileType.LiveBroadcasting = 1, RtcRoomProfileType.Game = 2, RtcRoomProfileType.CloudGame = 3,
  RtcRoomProfileType.LowLatency = 4
}
 
enum  RtcStreamIndex { RtcStreamIndex.Main = 0, RtcStreamIndex.Screen = 1 }
 
enum  RtcUserLeaveReasonType { RtcUserLeaveReasonType.Quit = 0, RtcUserLeaveReasonType.Dropped = 1 }
 
enum  Gender { Gender.Unknown = 0, Gender.Male = 1, Gender.Female = 2 }
 
enum  UserPresenceStatus { UserPresenceStatus.Unknown = 0, UserPresenceStatus.OnLine = 1, UserPresenceStatus.OffLine = 2 }
 

Enumeration Type Documentation

◆ GameConnectionEvent

Enumerator
Connected 
Closed 
Lost 
Resumed 
KickedByRelogin 
KickedByGameServer 
GameLogicError 
Unknown 

◆ GameInitializeResult

Enumerator
Success 
Uninitialized 
NetworkError 
InvalidCredentials 
ServiceNotAvailable 
Unknown 

◆ GameRequestFailedReason

Enumerator
None 
NotInitialized 
Uninitialized 
CurrentlyUnavailable 
CurrentlyUnknown 

◆ Gender

enum Pico.Platform.Gender
strong
Enumerator
Unknown 
Male 
Female 

◆ KVPairType

Enumerator
String 
Int 
Double 
Unknown 

◆ MatchmakingCriterionImportance

Enumerator
Required 
High 
Medium 
Low 
Unknown 

◆ MatchmakingStatApproach

Enumerator
Unknown 
Trailing 
Swingy 

◆ MembershipLockStatus

Enumerator
Unknown 
Lock 
Unlock 

◆ MessageType

Enumerator
Unknown 
PlatformInitializeAndroidAsynchronous 
User_GetLoggedInUser 
User_GetAccessToken 
User_Get 
User_LaunchFriendRequestFlow 
User_GetLoggedInUserFriends 
User_GetNextUserArrayPage 
Notification_Rtc_OnRoomStats 
Notification_Rtc_OnJoinRoom 
Notification_Rtc_OnLeaveRoom 
Notification_Rtc_OnUserLeaveRoom 
Notification_Rtc_OnUserJoinRoom 
Notification_Rtc_OnConnectionStateChange 
Notification_Rtc_OnWarn 
Notification_Rtc_OnRoomWarn 
Notification_Rtc_OnRoomError 
Notification_Rtc_OnError 
Notification_Rtc_OnUserStartAudioCapture 
Notification_Rtc_OnAudioPlaybackDeviceChanged 
Notification_Rtc_OnRemoteAudioPropertiesReport 
Notification_Rtc_OnLocalAudioPropertiesReport 
Notification_Rtc_OnUserStopAudioCapture 
Notification_Rtc_OnUserMuteAudio 
Notification_Rtc_OnMediaDeviceStateChanged 
Rtc_GetToken 
Matchmaking_Browse2 
Matchmaking_Cancel2 
Matchmaking_CreateAndEnqueueRoom2 
Matchmaking_Enqueue2 
Matchmaking_EnqueueRoom2 
Matchmaking_GetAdminSnapshot 
Matchmaking_GetStats 
Matchmaking_ReportResultInsecure 
Matchmaking_StartMatch 
Room_CreateAndJoinPrivate 
Room_CreateAndJoinPrivate2 
Room_Get 
Room_GetCurrent 
Room_GetCurrentForUser 
Room_GetInvitableUsers 
Room_GetInvitableUsers2 
Room_GetModeratedRooms 
Room_GetNextRoomArrayPage 
Room_InviteUser 
Room_Join 
Room_Join2 
Room_KickUser 
Room_LaunchInvitableUserFlow 
Room_Leave 
Room_SetDescription 
Room_UpdateDataStore 
Room_UpdateMembershipLockStatus 
Room_UpdateOwner 
Room_UpdatePrivateRoomJoinPolicy 
Notification_Matchmaking_MatchFound 
Notification_Room_InviteAccepted 
Notification_Room_InviteReceived 
Notification_Room_RoomUpdate 
Notification_Game_ConnectionEvent 
Notification_Game_RequestFailed 
Notification_Game_StateReset 
PlatformGameInitializeAsynchronous 

◆ PlatformInitializeResult

Enumerator
Unknown 
NetError 
MissingImpl 
LoadImplFailed 
InternalError 
InvalidParams 
AlreadyInitialized 
Success 

◆ RoomJoinability

Enumerator
Unknown 
AreIn 
AreKicked 
CanJoin 
IsFull 
NoViewer 
PolicyPrevents 

◆ RoomJoinPolicy

Enumerator
None 
Everyone 
FriendsOfMembers 
FriendsOfOwner 
InvitedUsers 
Unknown 

◆ RoomType

Enumerator
Unknown 
Matchmaking 
Moderated 
Private 

◆ RtcAudioPlaybackDevice

Enumerator
Headset 
EarPiece 
SpeakerPhone 
HeadsetBlueTooth 
HeadsetUsb 

◆ RtcAudioScenarioType

Enumerator
Music 
HighQualityCommunication 
Communication 
Media 
GameStreaming 

◆ RtcConnectionState

Enumerator
Disconnected 
Connecting 
Connected 
Reconnecting 
Reconnected 
Lost 

◆ RtcEarMonitorMode

Enumerator
Off 
On 

◆ RtcEngineInitResult

Enumerator
Unknown 
AlreadyInitialized 
InvalidConfig 
Success 

◆ RtcJoinRoomType

Enumerator
First 
Reconnected 

◆ RtcMediaDeviceError

Enumerator
Ok 
NoPermission 
DeviceBusy 
DeviceFailure 
DeviceNotFound 
DeviceDisconnected 
DeviceNoCallback 
UnSupportedFormat 

◆ RtcMediaDeviceState

Enumerator
Started 
Stopped 
RuntimeError 
Added 
Removed 

◆ RtcMediaDeviceType

Enumerator
AudioUnknown 
AudioRenderDevice 
AudioCaptureDevice 

◆ RtcMuteState

Enumerator
Off 
On 

◆ RtcPauseResumeMediaType

Enumerator
Audio 
Video 
AudioAndVideo 

◆ RtcPrivilege

Enumerator
PublishStream 
PublishAudioStream 
PublishVideoStream 
SubscribeStream 

◆ RtcRoomProfileType

Enumerator
Communication 
LiveBroadcasting 
Game 
CloudGame 
LowLatency 

◆ RtcStreamIndex

Enumerator
Main 
Screen 

◆ RtcUserLeaveReasonType

Enumerator
Quit 
Dropped 

◆ UserPresenceStatus

Enumerator
Unknown 
OnLine 
OffLine