通过

multiplayer_c

  • 项目

枚举

枚举 说明
XblMatchmakingStatus 定义用于指示会话匹配请求状态的值。
XblMultiplayerInitializationStage 定义指示托管初始化期间会话初始化阶段的值。
XblMultiplayerMeasurementFailure 定义指示在会话初始化期间服务质量 (QoS) 测量失败原因的值。
XblMultiplayerMetrics 定义指示用于测量会话的匹配服务质量 (QoS) 的指标类型的值。
XblMultiplayerSessionChangeTypes 定义指示多人游戏会话的更改类型的值。
XblMultiplayerSessionMemberStatus 定义用于指示某会话数量状态的值。
XblMultiplayerSessionRestriction 定义值以指示对于可以加入会话的成员的限制。
XblMultiplayerSessionStatus 定义用于指示某会话当前状态的值。
XblMultiplayerSessionVisibility 定义指示会话的可见性或可访问性的值。
XblMultiplayerSessionWriteMode 定义指示创建或写入多人游戏会话时使用模式的值。
XblMutableRoleSettings 定义指示哪些多人游戏角色设置可静音的值。
XblNetworkAddressTranslationSetting 定义指示连接到 Xbox Live 的主机的当前网络地址转换 (NAT) 设置的值。
XblTournamentArbitrationState 定义了表示锦标赛游戏仲裁状态的值。 已弃用。 未来版本中将删除此枚举。
XblTournamentArbitrationStatus 定义指示锦标赛游戏结果状态的值。 已弃用。 未来版本中将删除此枚举。
XblTournamentGameResult 定义用于指示锦标赛游戏的状态的值。 已弃用。 未来版本中将删除此枚举。
XblTournamentGameResultSource 定义表示锦标赛游戏状态的来源值。 已弃用。 未来版本中将删除此枚举。
XblTournamentRegistrationReason 定义指示团队处于所选锦标赛注册状态的原因的值。 已弃用。 将来的版本会取消此限制。
XblTournamentRegistrationState 定义指示锦标赛的团队会话注册状态的值。 已弃用。 未来版本中将删除此枚举。
XblWriteSessionStatus 定义指示多人游戏会话写入状态的值。

函数

函数 说明
XblFormatSecureDeviceAddress 针对不支持 SDA 的平台，在给定唯一设备 ID 的情况下设置安全设备地址的格式。
XblMultiplayerAddConnectionIdChangedHandler 在多人游戏连接 ID 更改时注册用于通知的事件处理程序。 使用返回的 XblFunctionContext 取消注册处理程序。
XblMultiplayerAddSessionChangedHandler 在多人游戏会话更改时注册用于通知的事件处理程序。 如果未使用 XblMultiplayerSetSubscriptionsEnabled 显式启用 RTA 订阅，则添加会话更改的处理程序将自动启用该订阅。 使用返回的 XblFunctionContext 取消注册处理程序。
XblMultiplayerAddSubscriptionLostHandler 在多人游戏订阅丢失时注册用于通知的事件处理程序。 使用返回的 XblFunctionContext 取消注册处理程序。
XblMultiplayerClearActivityAsync 清除指定 serviceConfigurationId 的用户的当前活动会话。
XblMultiplayerConnectionIdChangedHandler 在多人游戏连接 ID 更改时要调用的回调方法。
XblMultiplayerCreateSearchHandleAsync 创建与现有会话关联的搜索句柄。 这使会话可查询。
XblMultiplayerCreateSearchHandleResult 从 XblMultiplayerCreateSearchHandleAsync 获取结果。
XblMultiplayerDeleteSearchHandleAsync 从 MPSD 服务中删除搜索句柄。
XblMultiplayerGetActivitiesForSocialGroupAsync 已弃用 - 调用 XblMultiplayerGetActivitiesWithPropertiesForSocialGroupAsync，这还会填充结果中的 CustomSessionProperties。
查询与特定“所有者”玩家关联的社交组的当前活动。
XblMultiplayerGetActivitiesForSocialGroupResult 获取 XblMultiplayerGetActivitiesForSocialGroupAsync 调用的结果。
XblMultiplayerGetActivitiesForSocialGroupResultCount 获取返回的 XblMultiplayerActivityDetails 对象的数量。
XblMultiplayerGetActivitiesForUsersAsync 已弃用 - 调用 XblMultiplayerGetActivitiesWithPropertiesForUsersAsync，这还会填充结果中的 CustomSessionProperties。
查询 Xbox 用户 ID 指定的一组玩家的当前活动。
XblMultiplayerGetActivitiesForUsersResult 获取 XblMultiplayerGetActivitiesForUsersAsync 调用的结果。
XblMultiplayerGetActivitiesForUsersResultCount 获取返回的 XblMultiplayerActivityDetails 对象的数量。
XblMultiplayerGetActivitiesWithPropertiesForSocialGroupAsync 查询与特定“所有者”玩家关联的社交组的当前活动。
XblMultiplayerGetActivitiesWithPropertiesForSocialGroupResult 获取对 XblMultiplayerGetActivitiesWithPropertiesForSocialGroupAsync 的调用的结果。
XblMultiplayerGetActivitiesWithPropertiesForSocialGroupResultSize 获取返回的 XblMultiplayerActivityDetails 对象的大小。
XblMultiplayerGetActivitiesWithPropertiesForUsersAsync 查询 Xbox 用户 ID 指定的一组玩家的当前活动。
XblMultiplayerGetActivitiesWithPropertiesForUsersResult 获取对 XblMultiplayerGetActivitiesWithPropertiesForUsersAsync 的调用的结果。
XblMultiplayerGetActivitiesWithPropertiesForUsersResultSize 获取返回的 XblMultiplayerActivityDetails 对象的大小。
XblMultiplayerGetSearchHandlesAsync 按会话的关联搜索句柄搜索会话。
XblMultiplayerGetSearchHandlesResult 获取从 XblMultiplayerGetSearchHandlesAsync 调用返回的本地搜索句柄对象的句柄。
XblMultiplayerGetSearchHandlesResultCount 获取从 XblMultiplayerGetSearchHandlesAsync 调用返回的搜索句柄的数量。
XblMultiplayerGetSessionAsync 从服务器获取现有会话对象及其所有属性。
XblMultiplayerGetSessionByHandleAsync 从服务器获取会话对象及其所有属性，给定了会话句柄 ID。
XblMultiplayerGetSessionByHandleResult 获取 XblMultiplayerGetSessionByHandleAsync 调用的结果。
XblMultiplayerGetSessionResult 获取 XblMultiplayerGetSessionResult 调用的结果。
XblMultiplayerQuerySessionsAsync 使用各种筛选器检索会话列表。
XblMultiplayerQuerySessionsResult 获取会话查询的结果。
XblMultiplayerQuerySessionsResultCount 获取与会话查询匹配的会话数。
XblMultiplayerRemoveConnectionIdChangedHandler 取消注册用于多人游戏连接 ID 更改通知的事件处理程序。
XblMultiplayerRemoveSessionChangedHandler 取消注册用于多人游戏会话更改通知的事件处理程序。
XblMultiplayerRemoveSubscriptionLostHandler 取消注册用于多人游戏订阅丢失通知的事件处理程序。
XblMultiplayerSearchHandleCloseHandle 使本地搜索句柄详细信息对象的引用计数递减。
XblMultiplayerSearchHandleDuplicateHandle 使本地搜索句柄详细信息对象的引用计数递增。
XblMultiplayerSearchHandleGetCreationTime 获取搜索句柄的创建时间。
XblMultiplayerSearchHandleGetCustomSessionPropertiesJson 获取关联会话的自定义会话属性。
XblMultiplayerSearchHandleGetId 获取搜索句柄对象的 ID。
XblMultiplayerSearchHandleGetJoinRestriction 获取与搜索句柄关联的会话的加入限制。
XblMultiplayerSearchHandleGetMemberCounts 获取关联会话中成员的当前数量和最大数量。
XblMultiplayerSearchHandleGetNumberAttributes 获取指向附加了搜索句柄的特性数组的指针。
XblMultiplayerSearchHandleGetSessionClosed 获取与搜索句柄关联的会话是否暂时关闭以供加入。
XblMultiplayerSearchHandleGetSessionOwnerXuids 获取一个指针，该指针指向拥有与搜索句柄关联的会话的 Xuids 数组。
XblMultiplayerSearchHandleGetSessionReference 获取与搜索句柄关联的会话的会话参考。
XblMultiplayerSearchHandleGetStringAttributes 获取指向附加了搜索句柄的特性数组的指针。
XblMultiplayerSearchHandleGetTags 获取指向附加了搜索句柄的标记数组的指针。
XblMultiplayerSearchHandleGetVisibility 获取与搜索句柄关联的会话的可见性。
XblMultiplayerSendInvitesAsync 邀请指定的用户参加会话。 这将导致使用标准邀请文本向每个受邀用户显示通知。 如果用户接受该通知，则将激活游戏。
XblMultiplayerSendInvitesResult 邀请指定的用户参加会话。 这将导致使用标准邀请文本向每个受邀用户显示通知。 如果用户接受该通知，则将激活游戏。
XblMultiplayerSessionAddMemberReservation 为指定的 xuid 和成员常量添加会话中的新成员保留。
XblMultiplayerSessionChangedHandler 会话更改时要调用的回调方法。
XblMultiplayerSessionCloseHandle 使本地会话对象的引用计数递减。
XblMultiplayerSessionCompare 检查两个会话之间的增量并返回用 Or 连接的 MultiplayerSessionChangeType。 适用于将传递给 XblMultiplayerWriteSessionAsync 的会话对象与返回的会话对象进行比较。
XblMultiplayerSessionConstantsSetArbitrationTimeouts 为会话设置仲裁超时。 只能在创建新会话时设置。
XblMultiplayerSessionConstantsSetCapabilities 为会话设置功能常量。 这只能在创建新会话时设置。
XblMultiplayerSessionConstantsSetCloudComputePackageJson 只能在创建新会话时设置。 只有在设置了“cloudCompute”功能时才能指定。 支持客户端请求代表会话分配云计算实例。
XblMultiplayerSessionConstantsSetMaxMembersInSession 设置此会话中的最大成员数。
XblMultiplayerSessionConstantsSetMeasurementServerAddressesJson 应评估的潜在服务器连接字符串集。
XblMultiplayerSessionConstantsSetMemberInitialization 如果设置了“memberInitialization”对象，则会话需要客户端系统或游戏在创建会话后和/或新成员加入会话后执行初始化操作。 只能在创建新会话时设置。
XblMultiplayerSessionConstantsSetPeerToHostRequirements 以下阈值适用于来自候选主机的各个连接。 这只能在创建新会话时设置。
XblMultiplayerSessionConstantsSetPeerToPeerRequirements 以下阈值适用于会话中所有成员的各个成对连接。 这只能在创建新会话时设置。
XblMultiplayerSessionConstantsSetQosConnectivityMetrics 启用或禁用会话的连接指标。 这只能在创建新会话时设置。
XblMultiplayerSessionConstantsSetTimeouts 为会话设置超时。 只能在创建新会话时设置。
XblMultiplayerSessionConstantsSetVisibility 设置此会话的可见性。
XblMultiplayerSessionCreateHandle 创建一个新的本地多人游戏会话。
XblMultiplayerSessionCurrentUser 返回会话中的当前用户。
XblMultiplayerSessionCurrentUserDeleteCustomPropertyJson 删除当前用户的自定义属性。
XblMultiplayerSessionCurrentUserSetCustomPropertyJson 将当前用户的自定义属性设置为指定的 JSON 字符串。 该成员必须首先加入该会话。
XblMultiplayerSessionCurrentUserSetEncounters 设置当前用户的组名列表，该列表指示用户在多人游戏会话期间遇到了哪些组。 “相遇”是与另一个组的短暂交互。
XblMultiplayerSessionCurrentUserSetGroups 设置当前用户的组名字符串向量，该向量指示用户在多人游戏会话期间属于哪些组。
XblMultiplayerSessionCurrentUserSetMembersInGroup 设置组中的成员集合。 该成员必须首先加入该会话。
XblMultiplayerSessionCurrentUserSetQosMeasurements 为成员设置 XblMultiplayerQosMeasurements 的集合。 仅当游戏在手动管理 QoS 时才有用。 （如果平台自动执行 QoS，则无需调用）
XblMultiplayerSessionCurrentUserSetRoles 设置本地成员的角色信息。 该成员必须首先加入该会话。
XblMultiplayerSessionCurrentUserSetSecureDeviceAddressBase64 设置成员的 base64 编码安全设备地址。 该成员必须首先加入该会话。
XblMultiplayerSessionCurrentUserSetServerQosMeasurements 设置服务器的测量 JSON。 仅当游戏在手动管理 QoS 时才有用。 （如果平台自动执行 QoS，则无需调用）
XblMultiplayerSessionCurrentUserSetStatus 将当前用户设置为活动或非活动。 该成员必须首先加入该会话。
XblMultiplayerSessionDeleteCustomPropertyJson 删除会话自定义属性。
XblMultiplayerSessionDuplicateHandle 使本地会话对象的引用计数递增。
XblMultiplayerSessionEtag 随此会话返回的 ETag。
XblMultiplayerSessionGetInfo 获取有关会话的一些基本信息。 表示 MPSD 会话文档根目录中的信息。
XblMultiplayerSessionGetInitializationInfo 获取有关会话初始化的信息。
XblMultiplayerSessionGetMember 获取具有指定 MemberId 的会话成员。
XblMultiplayerSessionGetRoleByName 按角色类型名称和角色名称提取 XblMultiplayerRole 对象。
XblMultiplayerSessionHostCandidates 候选主机是设备令牌的已排序列表，该列表按照 XblMultiplayerMetrics 在会话常量中指定的优先级排序。
XblMultiplayerSessionJoin 将本地用户加入会话，将用户设置为活动状态。
XblMultiplayerSessionLeave 如果创建或加入会话的用户离开了会话，请进行调用。
XblMultiplayerSessionMatchmakingServer 一个多人会话服务器，其中包含与目标会话引用关联的属性。
XblMultiplayerSessionMembers 获取会话中的成员或一起进入会话的成员的集合。
XblMultiplayerSessionMembersAccepted 已接受并已添加到会话中且不再处于待处理状态的成员数。
XblMultiplayerSessionPropertiesSetJoinRestriction 限制谁可以加入“开放”会话。 （对保留没有影响，这意味着它对“私人”和“可见”会话没有影响。）
XblMultiplayerSessionPropertiesSetKeywords 与会话关联的关键字集合。 （可选，可能为空）
XblMultiplayerSessionPropertiesSetReadRestriction 限制谁可以读取“开放”会话。 （对保留没有影响，这意味着它对“私人”和“可见”会话没有影响。）
XblMultiplayerSessionPropertiesSetTurnCollection 设置会话 MemberIds 的集合，指示该轮到哪个成员。
XblMultiplayerSessionRawServersJson 一个 JSON 字符串，其中包含此多人游戏会话的服务器集合。 此 Json 对象具有经过分析可用于创建 XblMultiplayerArbitrationServer、XblMultiplayerMatchmakingServer 和 XblMultiplayerTournamentsServer 对象的信息。
XblMultiplayerSessionReferenceCreate 从服务配置 ID (SCID)、会话模板名称和会话名称创建 XblMultiplayerSessionReference。
XblMultiplayerSessionReferenceIsValid 验证 XblMultiplayerSessionReference 对象的格式是否正确。
XblMultiplayerSessionReferenceToUriPath 返回表示会话引用的 URI 路径。
XblMultiplayerSessionReferenceParseFromUriPath 返回从 URI 解析的会话引用。
XblMultiplayerSessionRoleTypes 与此会话关联的一组角色类型。
XblMultiplayerSessionSessionConstants 与此会话关联的一组常量。 只能在创建该会话时设置这些常量。
XblMultiplayerSessionSessionProperties 获取与会话关联的属性。 任何玩家都可以修改这些属性。
XblMultiplayerSessionSessionReference 会话的唯一标识信息。
XblMultiplayerSessionSetAllocateCloudCompute 如果设置了此属性，则将尝试分配“cloudComputePackage”。
XblMultiplayerSessionSetClosed 如果设置为 true，则会话“关闭”，这意味着新用户将无法加入，除非他们预先保留。
XblMultiplayerSessionSetCustomPropertyJson 将会话自定义属性设置为指定的 JSON 字符串。
XblMultiplayerSessionSetHostDeviceToken 设置主机的设备令牌。
XblMultiplayerSessionSetInitializationSucceeded 这只能在创建新会话时设置。
XblMultiplayerSessionSetLocked 设置是否锁定会话。 如果锁定，则离开会话的成员将能够返回到会话中，不允许其他用户占用此位置。
XblMultiplayerSessionSetMatchmakingResubmit 设置是否需要重新提交匹配项。
XblMultiplayerSessionSetMatchmakingServerConnectionPath 强制使用特定的服务器连接字符串，在 preserveSession=always 的情况下很有用。
XblMultiplayerSessionSetMatchmakingTargetSessionConstantsJson 设置匹配的属性。 这应该只由作为匹配服务的客户端来设置。
XblMultiplayerSessionSetMutableRoleSettings 设置角色的最大成员计数和/或目标成员计数。
XblMultiplayerSessionSetRawServersJson 设置 JSON 字符串，其中包含此多人游戏会话的服务器集合。
XblMultiplayerSessionSetServerConnectionStringCandidates 会话可用于连接游戏服务器的不区分大小写的连接字符串的排序列表。 一般来说，游戏应使用列表上的第一个字符串，但复杂的游戏可以使用自定义机制选择其他字符串中的一个（例如，基于负载）。
XblMultiplayerSessionSetSessionChangeSubscription 配置此客户端将订阅的会话更改集。
XblMultiplayerSessionSubscribedChangeTypes 返回 XblMultiplayerSessionChangeTypes 值的 OR 集，这些值表示当前 xboxlivecontext 订阅的会话的各个方面；如果没有，则返回 XblMultiplayerSessionChangeTypes::None。
XblMultiplayerSessionSubscriptionLostHandler rta 订阅丢失时要调用的回调方法。
XblMultiplayerSessionTimeOfSession 服务器返回会话的时间。
XblMultiplayerSessionWriteStatus 调用 XblMultiplayerWriteSessionAsync 后，写入的状态。
XblMultiplayerSetActivityAsync 将传递的会话设置为用户的当前活动，该活动将显示在与当前运行的游戏相关联的 Xbox 仪表板用户体验（例如，好友和游戏卡）中。 如果会话是可加入的，则也可以在那些用户体验中以相同方式显示。
XblMultiplayerSetSubscriptionsEnabled 通过 RTA 启动或停止多人游戏服务连接。 正在启动 RTA 订阅启动： 1。 使用 MultiplayerSession 对象在本地用户会话更改时回调。 已通过 XblMultiplayerAddSessionChangedHandler 添加处理程序。 2. 当此多人游戏订阅的 RTA 断开时，自动从会话中删除成员。
XblMultiplayerSetTransferHandleAsync 调用方对原始会话所拥有的访问权限扩展到目标会话。
XblMultiplayerSetTransferHandleResult 获取 XblMultiplayerSetTransferHandleAsync 操作的结果。
XblMultiplayerSubscriptionsEnabled 表明当前是否启用了多人游戏订阅。 注意，可以明确地使用 XblMultiplayerSetSubscriptionsEnabled 启用/禁用订阅，但如果添加了会话更改处理程序，将自动启用订阅。
XblMultiplayerWriteSessionAsync 将新的或更新的多人游戏会话写入服务。 该会话必须具有有效的会话引用。 如果不是用一个创建的，请改用 XblMultiplayerWriteSessionByHandleAsync。
XblMultiplayerWriteSessionByHandleAsync 使用指定的会话句柄将新的或更新的多人游戏会话写入服务。
XblMultiplayerWriteSessionByHandleResult 获取 XblMultiplayerWriteSessionAsync 操作的结果。
XblMultiplayerWriteSessionResult 获取 XblMultiplayerWriteSessionAsync 操作的结果。

句柄

句柄 说明
XblMultiplayerSearchHandle 搜索与 MPSD 会话相关联的详细信息对象的句柄。 对象具有关于会话的可筛选和可查询属性。
XblMultiplayerSessionHandle 本地多人游戏会话的句柄。 该句柄将用于查询和更改本地会话对象。 在对 XblMultiplayerWriteSessionAsync 进行后续调用之前，任何时间对本地会话对象所作的更改都不在多人游戏服务中反映出来。

结构

结构 说明
XblDeviceToken 表示参与会话的唯一设备的令牌。 它是可用于相等比较的不区分大小写的字符串。
XblFormattedSecureDeviceAddress 已格式化的安全设备地址。
XblMultiplayerActivityDetails 表示用户当前的多人游戏活动，同时提供有关相应会话的一些详细信息。
XblMultiplayerArbitrationServer 表示支持多人游戏会话的仲裁服务器。 已弃用。 未来的版本中将删除此结构。
XblMultiplayerInviteHandle 与已发送的未完成邀请对应的句柄。
XblMultiplayerMatchmakingServer 表示支持多人游戏会话的匹配服务器。
XblMultiplayerMemberInitialization 表示新建多人游戏服务会话的要求。
XblMultiplayerPeerToHostRequirements 表示适用于候选主机和会话成员之间每个连接的要求。
XblMultiplayerPeerToPeerRequirements 表示会话成员之间的连接要求。
XblMultiplayerRole 表示多人游戏角色的角色信息。
XblMultiplayerRoleType 表示多人游戏会话的角色类别。
XblMultiplayerSessionCapabilities 表示多人游戏服务会话的功能。
XblMultiplayerSessionChangeEventArgs 发生会话更改时传递给事件处理程序的参数。
XblMultiplayerSessionConstants 表示多人游戏会话的常数值。
XblMultiplayerSessionHandleId 表示对多人游戏会话的句柄 ID。
XblMultiplayerSessionInfo 有关本地多人游戏会话的基本信息。
XblMultiplayerSessionInitArgs 创建新的本地多人游戏会话时的可选参数。
XblMultiplayerSessionInitializationInfo 在成员初始化期间提供。
XblMultiplayerSessionMember 表示对多人游戏会话中成员的只读引用。
XblMultiplayerSessionMemberRole 表示会话成员在会话中的角色。
XblMultiplayerSessionNumberAttribute 一种关联属性，可在创建多人游戏会话搜索句柄时连接到该句柄。 属性名称为小写字母数字，并以字母开头。
XblMultiplayerSessionProperties 与此会话关联的一组属性。 任何玩家都可以修改这些属性。
XblMultiplayerSessionQuery 根据此请求的配置查询可见的多人游戏会话。
XblMultiplayerSessionQueryResult 从 XblMultiplayerQuerySessionsAsync 调用返回的会话信息。
XblMultiplayerSessionReference 表示对多人游戏会话的引用。
XblMultiplayerSessionReferenceUri 表示会话引用的 URI 路径表示。
XblMultiplayerSessionStringAttribute 一种关联属性，可在创建多人游戏会话搜索句柄时连接到该句柄。 属性名称为小写字母数字，并以字母开头。
XblMultiplayerSessionTag 一种可搜索标记，可在创建多人游戏会话搜索句柄时连接到该句柄。 标记必须是字母数字，并以字母开头。 它们不区分大小写。
XblMultiplayerTournamentsServer 表示支持多人游戏会话的锦标赛服务器。 已弃用。 未来的版本中将删除此结构。
XblMultiplayerTournamentTeam 代表锦标赛中的团队。 已弃用。 未来的版本中将删除此结构。
XblTournamentGameResultWithRank 代表一场多人游戏的结果。 已弃用。 未来的版本中将删除此结构。
XblTournamentReference 表示对锦标赛引用的引用。 已弃用。 未来的版本中将删除此结构。
XblTournamentTeamResult 代表多人游戏的团队结果。 已弃用。 未来的版本中将删除此结构。