API reference

FOvrNetSyncSession Struct

In Header file OVRPlatformModels.h
It represents the session of FOvrNetSyncConnection that allows multiple clients to connect and communicate with each other in real-time. It provides a way to manage and facilitate real-time communication and data synchronization between multiple clients in a networked environment.

Constructors

FOvrNetSyncSession ()
This is the default constructor for the struct, which initializes the ::ovrNetSyncSessionHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrNetSyncSession::FOvrNetSyncSession()
FOvrNetSyncSession ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrNetSyncSession::FOvrNetSyncSession(ovrNetSyncSessionHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrNetSyncSessionHandle
MessageHandlePtr: TOvrMessageHandlePtr

Fields

ConnectionId : int64
A long integer represents the unique ID of the FOvrNetSyncConnection within which this session exists.
Signature
int64 FOvrNetSyncSession::ConnectionId
Muted : bool
True if the local session has muted this session.
Signature
bool FOvrNetSyncSession::Muted
SessionId : FOvrId
The cloud networking internal session ID that can uniquely represent this session within the connection.
Signature
FOvrId FOvrNetSyncSession::SessionId
UserId : FOvrId
The ovrID of the user behind this session.
Signature
FOvrId FOvrNetSyncSession::UserId
VoipGroup : FString
A string represents the name of the voip group that this session is subscribed to.
Signature
FString FOvrNetSyncSession::VoipGroup

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrNetSyncSession::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrNetSyncSession::Update(ovrNetSyncSessionHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrNetSyncSessionHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void