developers
Login

This website uses cookies to improve our services and deliver relevant ads.
By interacting with this site, you agree to this use. For more information, see our Cookies Policy

Platform 1.28 Reference Guide

OVR_Room.h File Reference

Typedefs

struct ovrRoom *

Functions

ovrDataStoreHandle
ovrUserArrayHandle
ovrMatchmakingEnqueuedUserArrayHandle
ovrUserHandle
ovrUserArrayHandle
ovrID
const char *
ovrID
bool
ovrRoomJoinPolicy
ovrRoomJoinability
unsigned int
const char *
ovrRoomType
unsigned int

Typedef Documentation

typedef struct ovrRoom* ovrRoomHandle ( )

Function Documentation

ovrDataStoreHandle ovr_Room_GetDataStore ( const ovrRoomHandle obj )
This method may return null. This indicates that the value is not present or that the curent app or user is not permitted to access it.
ovrUserArrayHandle ovr_Room_GetInvitedUsers ( const ovrRoomHandle obj )
A list of users that have been invited to the room, but have not joined the room yet. This method may return null. This indicates that the value is not present or that the curent app or user is not permitted to access it.
ovrMatchmakingEnqueuedUserArrayHandle ovr_Room_GetMatchedUsers ( const ovrRoomHandle obj )
If this is a matchmaking room, it contains all users matched into the room, including the host as well as users enqueued by someone else. Also includes additional per-user matchmaking metadata. This method may return null. This indicates that the value is not present or that the curent app or user is not permitted to access it.
ovrUserHandle ovr_Room_GetOwner ( const ovrRoomHandle obj )
This method may return null. This indicates that the value is not present or that the curent app or user is not permitted to access it.
ovrUserArrayHandle ovr_Room_GetUsers ( const ovrRoomHandle obj )
This method may return null. This indicates that the value is not present or that the curent app or user is not permitted to access it.
ovrID ovr_Room_GetApplicationID ( const ovrRoomHandle obj )
const char* ovr_Room_GetDescription ( const ovrRoomHandle obj )
ovrID ovr_Room_GetID ( const ovrRoomHandle obj )
bool ovr_Room_GetIsMembershipLocked ( const ovrRoomHandle obj )
ovrRoomJoinPolicy ovr_Room_GetJoinPolicy ( const ovrRoomHandle obj )
ovrRoomJoinability ovr_Room_GetJoinability ( const ovrRoomHandle obj )
unsigned int ovr_Room_GetMaxUsers ( const ovrRoomHandle obj )
const char* ovr_Room_GetName ( const ovrRoomHandle obj )
ovrRoomType ovr_Room_GetType ( const ovrRoomHandle obj )
unsigned int ovr_Room_GetVersion ( const ovrRoomHandle obj )
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
21
22
27
28
34
35
38
39
42
43
44
45
46
47
48
49
50
51
52
53
54
55
// This file was @generated with LibOVRPlatform/codegen/main. Do not modify it!

#ifndef OVR_ROOM_H
#define OVR_ROOM_H

#include "OVR_Platform_Defs.h"
#include "OVR_DataStore.h"
#include "OVR_MatchmakingEnqueuedUserArray.h"
#include "OVR_RoomJoinability.h"
#include "OVR_RoomJoinPolicy.h"
#include "OVR_RoomType.h"
#include "OVR_Types.h"
#include "OVR_User.h"
#include "OVR_UserArray.h"
#include <stdbool.h>

typedefstruct ovrRoom *ovrRoomHandle;

OVRP_PUBLIC_FUNCTION(ovrDataStoreHandle) ovr_Room_GetDataStore(const ovrRoomHandle obj);

OVRP_PUBLIC_FUNCTION(ovrUserArrayHandle) ovr_Room_GetInvitedUsers(const ovrRoomHandle obj);

OVRP_PUBLIC_FUNCTION(ovrMatchmakingEnqueuedUserArrayHandle) ovr_Room_GetMatchedUsers(const ovrRoomHandle obj);

OVRP_PUBLIC_FUNCTION(ovrUserHandle) ovr_Room_GetOwner(const ovrRoomHandle obj);

OVRP_PUBLIC_FUNCTION(ovrUserArrayHandle) ovr_Room_GetUsers(const ovrRoomHandle obj);

OVRP_PUBLIC_FUNCTION(ovrID)              ovr_Room_GetApplicationID(const ovrRoomHandle obj);
OVRP_PUBLIC_FUNCTION(constchar *)       ovr_Room_GetDescription(const ovrRoomHandle obj);
OVRP_PUBLIC_FUNCTION(ovrID)              ovr_Room_GetID(const ovrRoomHandle obj);
OVRP_PUBLIC_FUNCTION(bool)               ovr_Room_GetIsMembershipLocked(const ovrRoomHandle obj);
OVRP_PUBLIC_FUNCTION(ovrRoomJoinPolicy)  ovr_Room_GetJoinPolicy(const ovrRoomHandle obj);
OVRP_PUBLIC_FUNCTION(ovrRoomJoinability) ovr_Room_GetJoinability(const ovrRoomHandle obj);
OVRP_PUBLIC_FUNCTION(unsignedint)       ovr_Room_GetMaxUsers(const ovrRoomHandle obj);
OVRP_PUBLIC_FUNCTION(constchar *)       ovr_Room_GetName(const ovrRoomHandle obj);
OVRP_PUBLIC_FUNCTION(ovrRoomType)        ovr_Room_GetType(const ovrRoomHandle obj);
OVRP_PUBLIC_FUNCTION(unsignedint)       ovr_Room_GetVersion(const ovrRoomHandle obj);

#endif
The documentation for this file was generated from the following file: OVR_Room.h