multiplayer_c

函数

函数	说明
XblFormatSecureDeviceAddress	针对不支持 SDA 的平台，根据唯一设备 ID 设置安全设备地址的格式。
XblMultiplayerAddConnectionIdChangedHandler	注册事件处理程序，用于在多人游戏连接 ID 更改时接收通知。使用返回的 XblFunctionContext 注销该处理程序。
XblMultiplayerAddSessionChangedHandler	注册事件处理程序，用于在多人游戏会话发生更改时接收通知。如果未通过 XblMultiplayerSetSubscriptionsEnabled 显式启用 RTA 订阅，则添加会话变更处理程序将自动启用它。使用返回的 XblFunctionContext 注销该处理程序。
XblMultiplayerAddSubscriptionLostHandler	注册事件处理程序，用于在多人游戏订阅丢失时接收通知。使用返回的 XblFunctionContext 注销该处理程序。
XblMultiplayerClearActivityAsync	清除指定 serviceConfigurationId 的用户当前活动会话。
XblMultiplayerConnectionIdChangedHandler	在多人游戏连接 ID 更改时要调用的回调方法。
XblMultiplayerCreateSearchHandleAsync	创建与现有会话关联的搜索句柄。这使会话可被查询。
XblMultiplayerCreateSearchHandleResult	获取 XblMultiplayerCreateSearchHandleAsync 的结果。
XblMultiplayerDeleteSearchHandleAsync	从 MPSD 服务中删除搜索句柄。
XblMultiplayerGetActivitiesForSocialGroupResult	获取 XblMultiplayerGetActivitiesForSocialGroupAsync 调用的结果。
XblMultiplayerGetActivitiesForSocialGroupResultCount	获取返回的 XblMultiplayerActivityDetails 对象数量。
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	获取指向拥有与搜索句柄关联的会话的 Xuid 数组的指针。
XblMultiplayerSearchHandleGetSessionReference	获取与搜索句柄关联的会话的会话引用。
XblMultiplayerSearchHandleGetStringAttributes	获取指向随搜索句柄附加的属性数组的指针。
XblMultiplayerSearchHandleGetTags	获取指向随搜索句柄附加的标记数组的指针。
XblMultiplayerSearchHandleGetVisibility	获取与搜索句柄关联的会话的可见性。
XblMultiplayerSendInvitesAsync	邀请指定用户加入会话。这将导致每个被邀请用户看到使用标准邀请文本显示的通知。如果用户接受该通知，则会激活标题。
XblMultiplayerSendInvitesResult	邀请指定用户加入会话。这将导致每个被邀请用户看到使用标准邀请文本显示的通知。如果用户接受该通知，则会激活标题。
XblMultiplayerSessionAddMemberReservation	为指定的 xuid 和成员常量添加会话上的新成员预留。
XblMultiplayerSessionArbitrationServer	一个仲裁服务器，其中包含与锦标赛游戏结果关联的属性。
XblMultiplayerSessionArbitrationStatus	锦标赛的仲裁状态。
XblMultiplayerSessionChangedHandler	会话发生变化时要调用的回调方法。
XblMultiplayerSessionCloseHandle	递减对本地会话对象的引用计数。
XblMultiplayerSessionCompare	检查两个会话之间的增量并返回按位或组合的 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	设置指示轮到谁的会话 MemberId 集合。
XblMultiplayerSessionRawServersJson	包含此多人游戏会话的服务器集合的 JSON 字符串。此 JSON 对象包含用于解析以创建 XblMultiplayerArbitrationServer、XblMultiplayerMatchmakingServer 和 XblMultiplayerTournamentsServer 对象的信息。
XblMultiplayerSessionReferenceCreate	从服务配置 ID (SCID)、会话模板名称和会话名称创建 XblMultiplayerSessionReference 对象。
XblMultiplayerSessionReferenceIsValid	验证 XblMultiplayerSessionReference 对象格式是否正确。
XblMultiplayerSessionReferenceParseFromUriPath	返回从 URI 解析出的会话引用。
XblMultiplayerSessionReferenceToUriPath	返回会话引用的 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 值集，表示当前 xboxlivecontext 已订阅的会话方面；如果没有订阅，则返回 XblMultiplayerSessionChangeTypes::None。
XblMultiplayerSessionSubscriptionLostHandler	当 rta 订阅丢失时要调用的回调方法。
XblMultiplayerSessionTimeOfSession	服务器返回会话的时间。
XblMultiplayerSessionTournamentsServer	一个锦标赛会话服务器，其中包含与锦标赛引用关联的属性。
XblMultiplayerSessionWriteStatus	调用 XblMultiplayerWriteSessionAsync 后的写入状态。
XblMultiplayerSetActivityAsync	将传递的会话设置为用户的当前活动，此活动将在 XBOX 仪表板用户体验（例如朋友和玩家卡）中显示为与当前正在运行的游戏关联。如果会话可加入，也可能在这些用户体验中显示为可加入。
XblMultiplayerSetSubscriptionsEnabled	显式启动或停止通过 RTA 的多人游戏服务连接。启用 RTA 订阅可实现：1. 当本地用户的会话使用 MultiplayerSession 对象发生更改时进行回调。使用 XblMultiplayerAddSessionChangedHandler 添加处理程序。2. 当支撑此多人游戏订阅的 RTA 连接中断时自动从会话中移除成员。
XblMultiplayerSetTransferHandleAsync	调用方对源会话所拥有的访问权将扩展到目标会话。
XblMultiplayerSetTransferHandleResult	获取 XblMultiplayerSetTransferHandleAsync 操作的结果。
XblMultiplayerSubscriptionsEnabled	指示当前是否已启用多人游戏订阅。请注意，可以使用 XblMultiplayerSetSubscriptionsEnabled 显式启用/禁用订阅，但如果添加了会话变更处理程序，订阅也会自动启用。
XblMultiplayerWriteSessionAsync	将新的或已更新的多人游戏会话写入服务。此会话必须具有有效的会话引用。如果创建时没有会话引用，请改用 XblMultiplayerWriteSessionByHandleAsync。
XblMultiplayerWriteSessionByHandleAsync	使用指定的会话句柄，将新的或已更新的多人游戏会话写入服务。
XblMultiplayerWriteSessionByHandleResult	获取 XblMultiplayerWriteSessionAsync 操作的结果。
XblMultiplayerWriteSessionResult	获取 XblMultiplayerWriteSessionAsync 操作的结果。

结构

结构	说明
XblDeviceToken	表示参与会话的唯一设备的令牌。它是一个不区分大小写的字符串，可用于相等性比较。
XblFormattedSecureDeviceAddress	格式化的安全设备地址。
XblMultiplayerActivityDetails	表示用户当前的 Multiplayer Activity，以及有关相应会话的一些详细信息。
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	可在创建多人游戏会话搜索句柄时附加到该句柄的可搜索标记。标记必须为字母数字并以字母开头。标记不区分大小写。

句柄

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

枚举

枚举	说明
XblMatchmakingStatus	定义指示会话匹配请求状态的值。
XblMultiplayerInitializationStage	定义指示托管初始化期间会话初始化阶段的值。
XblMultiplayerMeasurementFailure	定义指示会话初始化期间服务质量 (QoS) 测量失败原因的值。
XblMultiplayerMetrics	定义指示用于测量会话匹配服务质量 (QoS) 的指标类型的值。
XblMultiplayerSessionChangeTypes	定义指示多人游戏会话变更类型的值。
XblMultiplayerSessionMemberStatus	定义指示会话成员状态的值。
XblMultiplayerSessionRestriction	定义指示对可加入会话的用户的限制的值。
XblMultiplayerSessionStatus	定义指示会话当前状态的值。
XblMultiplayerSessionVisibility	定义指示会话可见性或可访问性的值。
XblMultiplayerSessionWriteMode	定义指示创建或写入多人游戏会话时使用的模式的值。
XblMutableRoleSettings	定义指示哪些多人游戏角色设置可变的值。
XblNetworkAddressTranslationSetting	定义指示连接到 {% term xbox-live %} 的控制台当前网络地址转换 (NAT) 设置的值。
XblWriteSessionStatus	定义指示多人游戏会话写入状态的值。

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

multiplayer_c

multiplayer_c

函数

结构

句柄

枚举

​multiplayer_c

​函数

​结构

​句柄

​枚举

multiplayer_c

函数

结构

句柄

枚举