{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"XBOX Game Development Documentation","description":"Official developer documentation for the Microsoft Game Development Kit (GDK), XBOX Services APIs, PlayFab, PIX, and Partner Center — build, publish, and operate games on XBOX and Windows.","colors":{"primary":"#7CC400","light":"#7CC400","dark":"#7CC400"},"logo":{"light":"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026auto=format\u0026n=EGENQIzNH9RmFI5A\u0026q=85\u0026s=78627ddb1e16ee7d1baa7bf50fdd25f5","dark":"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026auto=format\u0026n=EGENQIzNH9RmFI5A\u0026q=85\u0026s=78627ddb1e16ee7d1baa7bf50fdd25f5"},"favicon":{"light":"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026auto=format\u0026n=EGENQIzNH9RmFI5A\u0026q=85\u0026s=78627ddb1e16ee7d1baa7bf50fdd25f5","dark":"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026auto=format\u0026n=EGENQIzNH9RmFI5A\u0026q=85\u0026s=78627ddb1e16ee7d1baa7bf50fdd25f5"},"appearance":{"default":"dark"},"background":{"color":{"light":"#FFFFFF","dark":"#09090b"}},"navbar":{"links":[{"href":"https://forms.cloud.microsoft/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR0NCPI86XoxGliSdH5F4obBUNUJFVE1BN0U4MlRUQzRSQUtGTjkwVDFaNy4u","label":"Submit a Bug / Issue"}],"primary":{"type":"button","label":"User Experience Feedback","href":"https://forms.cloud.microsoft/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR0NCPI86XoxGliSdH5F4obBUM0FQSjUwQkYyVFdDQ0tLQlI0MjhJTzQ1Wi4u"}},"footer":{"socials":{"website":"https://developer.microsoft.com/en-us/games","discord":"https://discord.com/invite/BDVZ8yY38W","youtube":"https://www.youtube.com/msftgamedev"},"links":[{"header":"GDK","items":[{"label":"GDK Download","href":"https://www.microsoft.com/en-us/software-download/gdk"},{"label":"GDK on GitHub","href":"https://github.com/microsoft/GDK"},{"label":"GDK Samples","href":"https://github.com/microsoft/Xbox-GDK-Samples"}]},{"header":"Services \u0026 Tools","items":[{"label":"PlayFab","href":"https://developer.microsoft.com/en-us/games/products/playfab"},{"label":"Microsoft Azure","href":"https://azure.microsoft.com/"},{"label":"Visual Studio","href":"https://visualstudio.microsoft.com/"},{"label":"Havok","href":"https://www.havok.com/"},{"label":"Simplygon","href":"https://www.simplygon.com/"}]},{"header":"Publishing","items":[{"label":"Onboarding HUB","href":"https://developer.microsoft.com/en-US/games/publish"},{"label":"Publish with ID@XBOX","href":"https://www.xbox.com/en-US/developers/id"},{"label":"XBOX Publisher Guide","href":"https://developer.microsoft.com/en-us/games/publish"},{"label":"Partner Center","href":"https://partner.microsoft.com/en-us/dashboard"}]}]},"seo":{"metatags":{"author":"XBOX","category":"Game Development","og:site_name":"XBOX Game Development Documentation","og:image":"/images/We_Are_Xbox_Email-Signature_200x200.png","twitter:card":"summary_large_image","twitter:image":"/images/We_Are_Xbox_Email-Signature_200x200.png","description":"Official developer documentation for the Microsoft Game Development Kit (GDK), XBOX Services APIs, PlayFab, PIX, and Partner Center — build, publish, and operate games on XBOX and Windows.","keywords":"XBOX, GDK, Game Development Kit, XSAPI, PlayFab, Partner Center, PIX, Microsoft Game Development, XBOX Series X, XBOX One, Windows game development, xbox-live, achievements, multiplayer","og:type":"website","twitter:site":"@msftgamedev"},"organization":{"name":"Microsoft","url":"https://developer.microsoft.com/en-us/games/","logo":"https://developer.microsoft.com/en-us/games/favicon.ico","sameAs":["https://github.com/microsoft/Xbox-GDK-Samples","https://www.youtube.com/msftgamedev","https://developer.microsoft.com/en-us/games/"]},"indexing":"navigable"},"fonts":{"heading":{"family":"Segoe UI Bold","weight":700,"source":"fonts/Segoe UI Bold.woff","format":"woff"},"body":{"family":"Segoe UI","weight":400,"source":"fonts/Segoe UI.woff","format":"woff"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"thumbnails":{"background":"https://mintcdn.com/microsoft-4404708b/yWviP1jMKvfGdjTk/images/We_Are_Xbox_Teams-Background_01_Original_1920x1080.webp?fit=max\u0026auto=format\u0026n=yWviP1jMKvfGdjTk\u0026q=85\u0026s=80319a2dac1bf15401e6b379afe9e911"},"metadata":{"timestamp":true},"navigation":{"languages":[{"language":"en","href":""},{"language":"es","href":"es"},{"language":"fr-CA","href":"fr-CA"},{"language":"fr","href":"fr"},{"language":"ja-jp","href":"ja-jp"},{"language":"ko","href":"ko"},{"language":"pt-BR","href":"pt-BR"},{"language":"zh-CN","href":"zh-CN"},{"language":"zh-TW","href":"zh-TW"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"microsoft-4404708b","hasAudioNarration":false,"actualSubdomain":"microsoft-4404708b","customDomains":["devdocs.xbox.com"],"gitSource":{"type":"github","owner":"microsoft","repo":"xbox-game-development-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"949d678a-bdd4-43de-9718-7dd1dbd7de1a","liveDeploymentHistoryId":"6ad136112339ddbbdfc61215","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad136112339ddbbdfc61215"},"feedback":{"thumbs":true,"agentFeedback":true,"issues":false,"edits":false,"contextualFeedback":{"allowEmail":true}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad15fac22f060f2f1eabf08","clientVersion":"0.0.3865","searchFilterCounts":[{"language":"en","tag":"GDK APIs","count":3001},{"language":"fr-CA","tag":"GDK APIs","count":3001},{"language":"fr","tag":"GDK APIs","count":3001},{"language":"pt-BR","tag":"GDK APIs","count":3001},{"language":"zh-TW","tag":"GDK APIs","count":3001},{"language":"ko","tag":"GDK APIs","count":2970},{"language":"ja-jp","tag":"GDK APIs","count":2919},{"language":"zh-CN","tag":"GDK APIs","count":2917},{"language":"es","tag":"GDK APIs","count":2916},{"language":"en","tag":"PlayFab APIs","count":2629},{"language":"fr-CA","tag":"PlayFab APIs","count":2629},{"language":"fr","tag":"PlayFab APIs","count":2629},{"language":"pt-BR","tag":"PlayFab APIs","count":2629},{"language":"zh-CN","tag":"PlayFab APIs","count":2629},{"language":"zh-TW","tag":"PlayFab APIs","count":2629},{"language":"es","tag":"PlayFab APIs","count":2628},{"language":"ja-jp","tag":"PlayFab APIs","count":2628},{"language":"ko","tag":"PlayFab APIs","count":2628},{"language":"en","tag":"Functions","count":2257},{"language":"fr-CA","tag":"Functions","count":2257},{"language":"fr","tag":"Functions","count":2257},{"language":"pt-BR","tag":"Functions","count":2257},{"language":"zh-TW","tag":"Functions","count":2257},{"language":"ko","tag":"Functions","count":2250},{"language":"ja-jp","tag":"Functions","count":2246},{"language":"es","tag":"Functions","count":2244},{"language":"zh-CN","tag":"Functions","count":2244},{"language":"en","tag":"PlayFab API","count":1872},{"language":"fr-CA","tag":"PlayFab API","count":1872},{"language":"fr","tag":"PlayFab API","count":1872},{"language":"pt-BR","tag":"PlayFab API","count":1872},{"language":"zh-CN","tag":"PlayFab API","count":1872},{"language":"zh-TW","tag":"PlayFab API","count":1872},{"language":"es","tag":"PlayFab API","count":1871},{"language":"ja-jp","tag":"PlayFab API","count":1871},{"language":"ko","tag":"PlayFab API","count":1871},{"language":"pt-BR","tag":"Services","count":1696},{"language":"fr","tag":"Services","count":1695},{"language":"zh-TW","tag":"Services","count":1695},{"language":"fr-CA","tag":"Services","count":1694},{"language":"en","tag":"Services","count":1687},{"language":"zh-CN","tag":"Services","count":1672},{"language":"ja-jp","tag":"Services","count":1666},{"language":"ko","tag":"Services","count":1663},{"language":"es","tag":"Services","count":1652},{"language":"en","tag":"C","count":1516},{"language":"es","tag":"C","count":1516},{"language":"fr-CA","tag":"C","count":1516},{"language":"fr","tag":"C","count":1516},{"language":"ja-jp","tag":"C","count":1516},{"language":"ko","tag":"C","count":1516},{"language":"pt-BR","tag":"C","count":1516},{"language":"zh-CN","tag":"C","count":1516},{"language":"zh-TW","tag":"C","count":1516},{"language":"pt-BR","tag":"PlayFab","count":1334},{"language":"fr","tag":"PlayFab","count":1333},{"language":"zh-TW","tag":"PlayFab","count":1333},{"language":"fr-CA","tag":"PlayFab","count":1332},{"language":"en","tag":"PlayFab","count":1329},{"language":"zh-CN","tag":"PlayFab","count":1314},{"language":"ja-jp","tag":"PlayFab","count":1311},{"language":"ko","tag":"PlayFab","count":1311},{"language":"es","tag":"PlayFab","count":1307},{"language":"pt-BR","tag":"PlayFab services","count":1166},{"language":"en","tag":"PlayFab services","count":1165},{"language":"fr","tag":"PlayFab services","count":1165},{"language":"zh-TW","tag":"PlayFab services","count":1165},{"language":"fr-CA","tag":"PlayFab services","count":1164},{"language":"zh-CN","tag":"PlayFab services","count":1148},{"language":"ja-jp","tag":"PlayFab services","count":1147},{"language":"ko","tag":"PlayFab services","count":1147},{"language":"es","tag":"PlayFab services","count":1144},{"language":"en","tag":"Structs","count":1073},{"language":"fr-CA","tag":"Structs","count":1073},{"language":"fr","tag":"Structs","count":1073},{"language":"pt-BR","tag":"Structs","count":1073},{"language":"zh-TW","tag":"Structs","count":1073},{"language":"ko","tag":"Structs","count":1050},{"language":"zh-CN","tag":"Structs","count":1041},{"language":"es","tag":"Structs","count":1040},{"language":"ja-jp","tag":"Structs","count":1040},{"language":"en","tag":"Multiplayer","count":1004},{"language":"fr-CA","tag":"Multiplayer","count":1004},{"language":"fr","tag":"Multiplayer","count":1004},{"language":"pt-BR","tag":"Multiplayer","count":1004},{"language":"zh-TW","tag":"Multiplayer","count":1004},{"language":"ja-jp","tag":"Multiplayer","count":992},{"language":"zh-CN","tag":"Multiplayer","count":992},{"language":"ko","tag":"Multiplayer","count":990},{"language":"es","tag":"Multiplayer","count":986},{"language":"default","tag":"PlayFab APIs","count":596},{"language":"default","tag":"PlayFab REST API References","count":596},{"language":"default","tag":"Server","count":162},{"language":"default","tag":"Account Management","count":112},{"language":"default","tag":"Multiplayer","count":88},{"language":"default","tag":"Client","count":79},{"language":"default","tag":"Admin","count":74},{"language":"default","tag":"Addon","count":62},{"language":"default","tag":"MultiplayerServer","count":51},{"language":"default","tag":"Groups","count":50}],"searchSettings":{"maxResults":10,"isFiltersEnabled":true,"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":false,"type":"link"}},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"teamspace","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6ac9660d63bf063e3d634cde","deploymentId":"6a1f493825ae88ce6e69dab9","questionText":"What do I need to do before I can publish my game?","status":"active","generatedBy":"manual","createdAt":"2026-10-09T22:09:17.346Z","updatedAt":"2026-10-09T22:09:17.346Z","__v":0},{"_id":"6ac965e463bf063e3d634a49","deploymentId":"6a1f493825ae88ce6e69dab9","questionText":"How do I get access to game development tools?","status":"active","generatedBy":"manual","createdAt":"2026-10-09T22:08:36.356Z","updatedAt":"2026-10-09T22:08:36.356Z","__v":0},{"_id":"6ac965c863bf063e3d634792","deploymentId":"6a1f493825ae88ce6e69dab9","questionText":"How do I get started in building my XBOX game?","status":"active","generatedBy":"manual","createdAt":"2026-10-09T22:08:08.403Z","updatedAt":"2026-10-09T22:08:08.403Z","__v":0}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"#background-color::after{content:\"\";position:fixed;inset:0;pointer-events:none;z-index:0;background:linear-gradient(to top left,rgba(124,196,0,.18) 0,rgba(124,196,0,.08) 10%,rgba(124,196,0,.02) 25%,rgba(124,196,0,0) 60%)}html.light #background-color::after{background:linear-gradient(to top left,rgba(124,196,0,.1) 0,rgba(124,196,0,.05) 10%,rgba(124,196,0,.02) 25%,rgba(124,196,0,0) 60%)}#sidebar{background:linear-gradient(to right,rgba(124,196,0,.08) 0,rgba(124,196,0,.03) 25%,rgba(124,196,0,0) 60%);border-right:1px solid rgba(124,196,0,.15)}html.light #sidebar{background:linear-gradient(to right,rgba(124,196,0,.05) 0,rgba(124,196,0,.02) 25%,rgba(124,196,0,0) 60%);border-right:1px solid rgba(124,196,0,.12)}#content-area a.link,#mdx-content a,#mdx-content a.link,mdx-content a{color:#1e6feb}#content-area a.link:hover,#mdx-content a.link:hover,#mdx-content a:hover,mdx-content a:hover{color:#1552b8}html.dark #content-area a.link,html.dark #mdx-content a,html.dark mdx-content a{color:#4c9aff}html.dark #content-area a.link:hover,html.dark #mdx-content a:hover,html.dark mdx-content a:hover{color:#7bb6ff}html.light #content-area,html.light #mdx-content,html.light #mdx-content dd,html.light #mdx-content dt,html.light #mdx-content li,html.light #mdx-content p,html.light #mdx-content span,html.light #mdx-content td,html.light #mdx-content th,html.light mdx-content{color:#1f1f1f}html.light #mdx-content h1,html.light #mdx-content h2,html.light #mdx-content h3,html.light #mdx-content h4,html.light #mdx-content h5,html.light #mdx-content h6,html.light #page-title,html.light #sidebar,html.light #sidebar a,html.light #sidebar-content,html.light #table-of-contents,html.light breadcrumb-item,html.light breadcrumb-list,html.light sidebar-group,html.light sidebar-group-header,html.light sidebar-title,html.light toc-item,html.light toc-item a{color:#000}html.dark #content-area,html.dark #mdx-content,html.dark #mdx-content dd,html.dark #mdx-content dt,html.dark #mdx-content li,html.dark #mdx-content p,html.dark #mdx-content span,html.dark #mdx-content td,html.dark #mdx-content th,html.dark mdx-content{color:#e6e6e6}html.dark #mdx-content h1,html.dark #mdx-content h2,html.dark #mdx-content h3,html.dark #mdx-content h4,html.dark #mdx-content h5,html.dark #mdx-content h6,html.dark #page-title,html.dark #sidebar,html.dark #sidebar a,html.dark #sidebar-content,html.dark #table-of-contents,html.dark breadcrumb-item,html.dark breadcrumb-list,html.dark sidebar-group,html.dark sidebar-group-header,html.dark sidebar-title,html.dark toc-item,html.dark toc-item a{color:#fff}"}],"page":{"pagePath":"zh-TW/reference/live/rest/json/json-property","slug":"/zh-TW/reference/live/rest/json/json-property","pageMetadata":{"title":"Property (JSON)","description":"Property (JSON)","sidebarTitle":"Property (JSON)","href":"/zh-TW/reference/live/rest/json/json-property"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Property (JSON)\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,h5:`h5`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`property-json`,children:`Property (JSON)`}),`\n`,_jsx(_components.p,{children:`包含用戶端為配對要求準則提供的屬性資料。`}),`\n`,_jsx(`a`,{id:`ID4EN`}),`\n`,_jsx(Heading,{level:`2`,id:`property`,children:`Property`}),`\n`,_jsx(_components.p,{children:`Property 物件具有下列規格。`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`成員`}),_jsx(_components.th,{children:`類型`}),_jsx(_components.th,{children:`描述`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`id`}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`此屬性的識別碼。`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`type`}),_jsx(_components.td,{children:`32 位元帶正負號的整數`}),_jsxs(_components.td,{children:[`屬性的類型。支援的值為：`,_jsxs(`ul`,{children:[_jsx(`li`,{children:`0 = 整數`}),_jsx(`li`,{children:`1 = 字串`})]})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`此屬性的值。`})]})]})]}),`\n`,_jsx(`a`,{id:`ID4EGC`}),`\n`,_jsx(Heading,{level:`2`,id:`範例-json-語法`,children:`範例 JSON 語法`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"20\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`]})})}),`\n`,_jsx(`a`,{id:`ID4EPC`}),`\n`,_jsx(Heading,{level:`2`,id:`另請參閱`,children:`另請參閱`}),`\n`,_jsx(`a`,{id:`ID4ERC`}),`\n`,_jsx(_components.h5,{children:`上層`}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`/zh-TW/reference/live/rest/json/atoc-xboxlivews-reference-json`,children:`JavaScript Object Notation (JSON) 物件參考`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Property (JSON)","description":"Property (JSON)","sidebarTitle":"Property (JSON)","href":"/zh-TW/reference/live/rest/json/json-property"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Property (JSON)","slug":"property-json","depth":1,"children":[]},{"title":"Property","slug":"property","depth":2,"children":[]},{"title":"範例 JSON 語法","slug":"範例-json-語法","depth":2,"children":[]},{"title":"另請參閱","slug":"另請參閱","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"microsoft-4404708b","siteName":"XBOX Game Development Documentation","title":"Property (JSON) - XBOX Game Development Documentation","relatedPages":[{"title":"XblMultiplayerSessionDeleteCustomPropertyJson","link":"reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessiondeletecustompropertyjson","breadcrumbs":["GDK APIs","XBOX services API reference","XSAPI","multiplayer_c","Functions","XblMultiplayerSessionDeleteCustomPropertyJson"],"icon":""},{"title":"XblMultiplayerEventArgsPropertiesJson","link":"reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayereventargspropertiesjson","breadcrumbs":["GDK APIs","XBOX services API reference","XSAPI","multiplayer_manager_c","Functions","XblMultiplayerEventArgsPropertiesJson"],"icon":""}],"relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/zh-TW/reference/live/rest/json/json-property","matchLevel":0},"es":{"href":"/es","matchLevel":4},"fr-CA":{"href":"/fr-CA","matchLevel":4},"fr":{"href":"/fr","matchLevel":4},"ja-jp":{"href":"/ja-jp","matchLevel":4},"ko":{"href":"/ko","matchLevel":4},"pt-BR":{"href":"/pt-BR","matchLevel":4},"zh-CN":{"href":"/zh-CN","matchLevel":4},"zh-TW":{"href":"/zh-TW","matchLevel":4}}},"lastModified":"2026-10-07T17:23:04.958Z","gitLastModified":"2026-10-06T23:18:36.000Z","originalFileLocation":"zh-TW/reference/live/rest/json/json-property.mdx","locale":"en"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Property (JSON)\">\u003cmeta data-mint-head name=\"keywords\" content=\"XBOX, GDK, Game Development Kit, XSAPI, PlayFab, Partner Center, PIX, Microsoft Game Development, XBOX Series X, XBOX One, Windows game development, xbox-live, achievements, multiplayer\">\u003cmeta data-mint-head name=\"application-name\" content=\"XBOX Game Development Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026amp;auto=format\u0026amp;n=EGENQIzNH9RmFI5A\u0026amp;q=85\u0026amp;s=78627ddb1e16ee7d1baa7bf50fdd25f5\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026amp;auto=format\u0026amp;n=EGENQIzNH9RmFI5A\u0026amp;q=85\u0026amp;s=78627ddb1e16ee7d1baa7bf50fdd25f5\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026amp;auto=format\u0026amp;n=EGENQIzNH9RmFI5A\u0026amp;q=85\u0026amp;s=78627ddb1e16ee7d1baa7bf50fdd25f5\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026amp;auto=format\u0026amp;n=EGENQIzNH9RmFI5A\u0026amp;q=85\u0026amp;s=78627ddb1e16ee7d1baa7bf50fdd25f5\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026amp;auto=format\u0026amp;n=EGENQIzNH9RmFI5A\u0026amp;q=85\u0026amp;s=78627ddb1e16ee7d1baa7bf50fdd25f5\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026amp;auto=format\u0026amp;n=EGENQIzNH9RmFI5A\u0026amp;q=85\u0026amp;s=78627ddb1e16ee7d1baa7bf50fdd25f5\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/microsoft-4404708b/EGENQIzNH9RmFI5A/images/We_Are_Xbox_Email-Signature_200x200.png?fit=max\u0026amp;auto=format\u0026amp;n=EGENQIzNH9RmFI5A\u0026amp;q=85\u0026amp;s=78627ddb1e16ee7d1baa7bf50fdd25f5\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Property (JSON) - XBOX Game Development Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Property (JSON)\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"XBOX Game Development Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://devdocs.xbox.com/zh-TW/reference/live/rest/json/json-property\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://microsoft-4404708b.mintlify.app/images/We_Are_Xbox_Email-Signature_200x200.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Property (JSON) - XBOX Game Development Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Property (JSON)\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://microsoft-4404708b.mintlify.app/images/We_Are_Xbox_Email-Signature_200x200.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/microsoft-4404708b/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"XBOX Game Development Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7CC400\">\u003cmeta data-mint-head name=\"author\" content=\"XBOX\">\u003cmeta data-mint-head name=\"category\" content=\"Game Development\">\u003clink data-mint-head rel=\"canonical\" href=\"https://devdocs.xbox.com/zh-TW/reference/live/rest/json/json-property\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/zh-TW/reference/live/rest/json/json-property.md\">","siteName":"XBOX Game Development Documentation","nav":{"languages":[{"language":"en","tabs":[{"tab":"Home","pages":[{"group":"Introduction","icon":"hand-wave","pages":[{"title":"XBOX Game Development Documentation","sidebarTitle":"Home","description":"Build and publish games for XBOX Series X|S, XBOX One, and Windows PC using the XBOX Game Development Kit (GDK), PlayFab, and XBOX services.","icon":"house","keywords":["XBOX","GDK","Game Development Kit","Microsoft Game Dev","XBOX Series X|S","XBOX One","Windows PC games","game development documentation"],"href":""},{"title":"GDK glossary of terms and acronyms","sidebarTitle":"Glossary","description":"Definitions of key terms, acronyms, and platform concepts used across the XBOX GDK documentation, including console, tooling, and networking vocabulary.","icon":"book-bookmark","href":"/home/glossary"}]},{"group":"Onboarding \u0026 Access","icon":"id-card","pages":[{"title":"XBOX Partner Onboarding for access and publishing","sidebarTitle":"XBOX Partner Onboarding","description":"The ID@XBOX onboarding workflow: business intro, NDA, concept approval, TLA and GDK License Agreement, Partner Center, Entra ID, and dev kit access.","icon":"id-card","keywords":["ID@XBOX","XBOX onboarding","NDA","concept approval","Partner Center registration","GDK access","TLA","GDK License Agreement","Entra ID","SupplierWeb","Microsoft supplier","Entertainment Developer Store","EDS","dev kits","Seller ID","DUNS"],"related":["/home/onboarding-access/access-resources","/home/onboarding-access/setup-organization","/home/onboarding-access/security-requirements","/publishing/developer-account"],"href":"/home/onboarding"},{"title":"Access GDK resources and downloads","sidebarTitle":"Access resources","description":"Where to find the GDK download, secure documentation, samples, dev forums, and other Partner Center resources after ID@XBOX onboarding is complete.","icon":"folder-open","href":"/home/onboarding-access/access-resources"},{"title":"Security requirements for GDK licensees","sidebarTitle":"Security requirements","description":"Confidentiality, NDA, and security obligations for XBOX GDK and XBOX One SDK licensees who access secure development hardware, tools, and documentation.","icon":"lock","href":"/home/onboarding-access/security-requirements"},{"title":"Set up your organization in Partner Center","sidebarTitle":"Set up organization","description":"Connect a Microsoft Entra ID tenant to Partner Center and add team members so your studio can access secure XBOX documentation, downloads, and forums.","icon":"building","href":"/home/onboarding-access/setup-organization"}]},{"group":"Setup \u0026 Install","icon":"download","pages":[{"title":"Set up and install the GDK","sidebarTitle":"Setup and install","description":"Start here for XBOX GDK development: what the GDK is, dev PC setup, Windows SDK and Visual Studio install, GDK download, and building your first sample.","icon":"rocket","href":"/home/setup-install/get-started"},{"title":"Install the GDK toolchain","sidebarTitle":"Install the GDK","description":"Requirements, prerequisites, and step-by-step install instructions for the Windows SDK, Visual Studio, and the XBOX Game Development Kit on your dev PC.","icon":"download","href":"/home/setup-install/download-install"},{"title":"GDK samples","sidebarTitle":"Samples","description":"Reference samples that ship with the GDK and are hosted in the XBOX-GDK-Samples repository, demonstrating platform features and API patterns end to end.","icon":"code","href":"/home/setup-install/samples"},{"group":"Dev Kit Setup","icon":"gamepad","hidden":true,"pages":[{"title":"Overview","href":"/home/setup-install/devkits/overview"},{"group":"Setup \u0026 activation","icon":"power-off","pages":[{"title":"Activate retail console as dev kit","href":"/home/setup-install/devkits/setup/activate-retail-console-as-dev-kit"},{"title":"Activating dev kit","href":"/home/setup-install/devkits/setup/activating-dev-kit"},{"title":"Activating dev kit qr code","href":"/home/setup-install/devkits/setup/activating-dev-kit-qr-code"},{"title":"Devkit faq","href":"/home/setup-install/devkits/setup/devkit-faq"},{"title":"Provisioning role","href":"/home/setup-install/devkits/setup/provisioning-role"},{"title":"Setting up your devkit","href":"/home/setup-install/devkits/setup/setting-up-your-devkit"},{"title":"Troubleshooting setup","href":"/home/setup-install/devkits/setup/troubleshooting-setup"}]},{"group":"Settings","icon":"gear","pages":[{"title":"Configuring development network access","description":"Domains, ports, CIDR blocks, and firewall exceptions required to develop XBOX GDK titles and connect a dev PC to XBOX Series X|S dev kits on your network.","sidebarTitle":"Dev network access","icon":"network-wired","href":"/home/setup-install/devkits/settings/configure-dev-network"}]}]},{"group":"Concepts","icon":"book","pages":[{"title":"Activating dev kit permissions sandbox","href":"/home/setup-install/concepts/activating-dev-kit-permissions-sandbox"},{"title":"Gc console eou","href":"/home/setup-install/concepts/gc-console-eou"},{"title":"Gc console rebootreason","href":"/home/setup-install/concepts/gc-console-rebootreason"},{"title":"Gc console uems","href":"/home/setup-install/concepts/gc-console-uems"},{"title":"Remove gold sharing","href":"/home/setup-install/concepts/remove-gold-sharing"},{"title":"Scorpio devkit tips","href":"/home/setup-install/concepts/scorpio-devkit-tips"},{"title":"Deployment","href":"/home/setup-install/concepts/deployment"},{"title":"Using console modes","href":"/home/setup-install/concepts/using-console-modes"}]},{"group":"Dev kit settings","icon":"sliders","pages":[{"title":"Change dev kit mode","href":"/home/setup-install/dev-kit-settings/change-dev-kit-mode"},{"title":"Config dev kit settings","href":"/home/setup-install/dev-kit-settings/config-dev-kit-settings"},{"title":"Dev kit os","href":"/home/setup-install/dev-kit-settings/dev-kit-os"},{"title":"Setting a hostname","href":"/home/setup-install/dev-kit-settings/setting-a-hostname"}]},{"group":"Studio-wide configuration","icon":"building","pages":[{"title":"Recovering multiple consoles","href":"/home/setup-install/studio-wide-configuration/recovering-multiple-consoles"},{"title":"Recovery update settings","href":"/home/setup-install/studio-wide-configuration/recovery-update-settings"},{"title":"Unattended setup script","href":"/home/setup-install/studio-wide-configuration/unattended-setup-script"}]}]},{"group":"Build Your First Title","icon":"play","pages":[{"title":"Develop a new GDK title","sidebarTitle":"Develop a new title","description":"Create a new GDK title in Visual Studio using project templates for Windows PC, XBOX Series X|S consoles, or a cross-platform build that targets both.","icon":"code","href":"/home/build-first-title/developing-new-titles"},{"title":"Build and run your first console title with GDKX","sidebarTitle":"First console title walkthrough","description":"End-to-end walkthrough: create a native GDKX project, add DirectXTK12, build for XBOX Series X|S, deploy to a dev kit, and produce an installable XVC.","icon":"gamepad","keywords":["GDKX","sample game","XBOX Series X|S","dev kit","xbapp","xbconnect","makepkg","XVC","DirectXTK12","MicrosoftGame.config"],"href":"/home/build-first-title/first-console-title-walkthrough"},{"title":"Add backend services with PlayFab","sidebarTitle":"Add PlayFab backend services","description":"Pair your GDK title with PlayFab early to get identity, multiplayer, leaderboards, economy, and live operations without hosting your own servers.","icon":"server","href":"/home/build-first-title/add-backend-services"},{"title":"Porting guides to the XBOX GDK","sidebarTitle":"Porting guides","description":"Index of porting guidance for bringing existing titles to the XBOX GDK from XBOX One ERA, FXC, Steamworks, and other source platforms and engines.","icon":"arrow-right-arrow-left","href":"/home/build-first-title/porting-guides"}]}]},{"tab":"Get Started","pages":[{"group":"Porting","icon":"arrow-right-arrow-left","pages":[{"title":"Porting overview","sidebarTitle":"Overview","description":"Bring an existing PC or console title to modern XBOX and Windows: pick a port path from Steam, prior XBOX generations, other consoles, or non-Steam PC.","icon":"compass","href":"/paths/porting/overview"},{"title":"Port from Steam","sidebarTitle":"From Steam","description":"Map Steamworks features to the GDK when porting from Steam to XBOX: user auth, Steam Cloud saves, achievements, and leaderboards to XBOX Services.","icon":"steam","href":"/paths/porting/from-steam"},{"title":"Port from other platforms","sidebarTitle":"From other platforms","description":"Port a title from another console to XBOX Series X|S: DirectX 12 rendering, XInput/WGI input mapping, DirectStorage, and XBOX Services integration.","icon":"gamepad","href":"/paths/porting/from-console"},{"title":"Port from a prior XBOX generation","sidebarTitle":"From prior XBOX gen","description":"Migrate an XBOX One ERA/XDK title to the GDK for Series X|S: WinRT to flat C APIs, XAsync tasks, XMemAlloc memory, and MSIXVC packaging.","icon":"xbox","href":"/paths/porting/from-xbox-era"},{"title":"Port from PC (non-Steam)","sidebarTitle":"From PC (non-Steam)","description":"Bring a Win32 PC game from Epic, GOG, or your own launcher to XBOX and the Microsoft Store using the GDK, MSIXVC packaging, and Play Anywhere options.","icon":"desktop","href":"/paths/porting/from-pc"},{"title":"General porting guides","sidebarTitle":"General Porting","description":"Core GDK porting workflow shared across engines: the porting guides reference, cross-gen development, MSIXVC packaging, and engine integration basics.","icon":"arrows-turn-right","href":"/paths/porting/guides"},{"title":"Publishing your port","sidebarTitle":"Publishing","description":"Certification, XR compliance, top failing XRs, pre-release flow, and Microsoft Store setup when publishing a title you're porting to XBOX.","icon":"shield-check","href":"/paths/porting/publishing"}]},{"group":"Build Paths","icon":"screwdriver-wrench","pages":[{"title":"Play Anywhere (Console + PC) overview","sidebarTitle":"Play Anywhere","description":"Ship one XBOX Play Anywhere title across XBOX Series X|S consoles and Windows PCs and handhelds, with shared saves, entitlements, and a single purchase.","icon":"right-left","href":"/paths/play-anywhere/overview"},{"title":"XBOX Series X|S overview","sidebarTitle":"XBOX Series X|S","description":"Build native XBOX Series X|S console titles with the GDK — target the console hardware directly, light up console-only features, and pass XBOX certification.","icon":"gamepad","href":"/paths/series-xs/overview"},{"title":"Windows \u0026 ROG XBOX Ally overview","sidebarTitle":"Windows \u0026 ROG XBOX Ally","description":"Ship XBOX games on Windows PCs and handhelds like the ROG XBOX Ally using the GDK, with handheld-aware input, power, and screen-size considerations.","icon":"windows","href":"/paths/windows/overview"},{"title":"Unreal Engine overview","sidebarTitle":"Unreal Engine","description":"Build XBOX and Windows titles in Unreal Engine using the XBOX plug-in granted through ID@XBOX that talks to the GDK from inside the Unreal editor.","icon":"gamepad","href":"/paths/unreal/overview"},{"title":"Unity overview","sidebarTitle":"Unity","description":"Build XBOX and Windows titles in Unity using the XBOX add-on granted through ID@XBOX to package, sign in, and connect to platform features from the editor.","icon":"cube","href":"/paths/unity/overview"},{"title":"Godot \u0026 Community Engines overview","sidebarTitle":"Godot \u0026 Community Engines","description":"Ship XBOX and Windows titles with community engines like Godot, GameMaker, or a custom C/C++ engine by integrating the GDK yourself via native plug-ins.","icon":"code","href":"/paths/community-engines/overview"}]}]},{"tab":"Build","pages":[{"group":"GDK and Game Engines Integration","icon":"rocket","pages":[{"title":"PC end-to-end overview","sidebarTitle":"Overview","description":"Follow an end-to-end roadmap for shipping a Windows PC title with the GDK: engine integration, XBOX services, handhelds, and Microsoft Store submission.","icon":"compass","href":"/build/gdk-and-engines/overview"},{"title":"Use the GDK with Unity, Unreal, and other engines","sidebarTitle":"GDK and engines","description":"See how the XBOX GDK integrates with Unity, Unreal Engine, GameMaker, Godot, and custom C or C++ engines through plug-ins, extensions, and project templates.","icon":"puzzle-piece","href":"/build/gdk-and-engines/gdk-and-engines"},{"group":"Unreal Engine","icon":"u","pages":[{"title":"Use the GDK with Unreal Engine","sidebarTitle":"Use the GDK with Unreal Engine","description":"Integrate GDK plug-ins and platform extensions into Unreal Engine 5.7+ to target Win64, XBOX Series X|S, and XBOX One with unified PC builds and faster cook.","icon":"u","href":"/build/gdk-and-engines/unreal/unreal"},{"title":"Integrate the GDK with a pre-4.26 Unreal Engine project","sidebarTitle":"Unreal Engine — legacy (pre-4.26)","description":"Wire the XBOX GDK into Unreal Engine builds older than 4.26 by editing Build.cs, adding include and library paths manually, and launching with wdapp.","icon":"unreal-engine","href":"/build/gdk-and-engines/unreal/unreal-legacy"},{"title":"Ship an Unreal Engine title to XBOX PC (UE 5.8+)","sidebarTitle":"Unreal Engine — XBOX PC (5.8+)","description":"Publish a single Unreal Engine executable to Microsoft Store, Epic Games Store, and Steam using the public GDK plug-ins introduced in Unreal Engine 5.8.","icon":"unreal-engine","href":"/build/gdk-and-engines/unreal/unreal-xbox-pc"}]},{"group":"Unity","icon":"cube","pages":[{"title":"Use the GDK with Unity","sidebarTitle":"Use the GDK with Unity","description":"Integrate the GDK packages and XBOX services into a Unity project to target Windows x64, XBOX Series X|S, and XBOX One from a single project and code base.","icon":"cube","href":"/build/gdk-and-engines/unity/unity"},{"title":"Unity C# API wrappers for the GDK","sidebarTitle":"Unity C# API wrappers","description":"Reference the XGamingRuntime C# namespace in the GDK for Unity package: naming conventions, HRESULT handling, async patterns, and native-vs-managed examples.","icon":"unity","href":"/build/gdk-and-engines/unity/unity-api-wrappers"}]},{"group":"Godot","icon":"robot","pages":[{"title":"Use the GDK with Godot","sidebarTitle":"Use the GDK with Godot","description":"Integrate the XBOX GDK, XBOX services, PlayFab, and GameInput into a Godot project using the source-only XBOX Godot Sample to ship to XBOX on PC.","icon":"robot","href":"/build/gdk-and-engines/godot"},{"group":"Release notes","icon":"clipboard-list","pages":[{"title":"XBOX Godot NetRumble sample v0.1.0 release","description":"Release notes for XBOX Godot NetRumble v0.1.0, a Godot 4 multiplayer sample that runs the Microsoft GDK, XBOX services, and PlayFab together in one title.","sidebarTitle":"NetRumble v0.1.0","href":"/build/gdk-and-engines/godot-release-notes/godot-netrumble-release-notes-0-1-0"},{"title":"XBOX Godot Sample v0.3.0 Release","description":"Breaking type rename, new features, improvements, and fixes in v0.3.0 of the XBOX Godot Sample for building Godot games that ship to XBOX on PC.","sidebarTitle":"v0.3.0","href":"/build/gdk-and-engines/godot-release-notes/godot-release-notes-0-3-0"},{"title":"XBOX Godot Sample v0.2.0 Release","description":"Describes new features, improvements, and fixes in the v0.2.0 release of the XBOX Godot sample for building Godot games for XBOX on PC.","sidebarTitle":"v0.2.0","href":"/build/gdk-and-engines/godot-release-notes/godot-release-notes-0-2-0"},{"title":"XBOX Godot Sample v0.1.0 Release","description":"Describes the initial v0.1.0 release of the XBOX Godot sample for building Godot games for XBOX on PC.","sidebarTitle":"v0.1.0","href":"/build/gdk-and-engines/godot-release-notes/godot-release-notes-0-1-0"}]}]},{"title":"Use the GDK with GameMaker","sidebarTitle":"GameMaker","description":"Prepare a GameMaker Studio 2 game for Microsoft Store publishing using the GMEXT-GDK extension, Visual Studio 2022, CMake, and the June 2024 GDK release.","icon":"dice","href":"/build/gdk-and-engines/gamemaker"},{"title":"Integrate the GDK with a custom C/C++ engine","sidebarTitle":"Custom engine","description":"Integrate the GDK, Gaming Runtime Services (GRTS), and XSAPI into a C/C++ engine without built-in GDK support to ship on Microsoft Store on PC and XBOX.","icon":"code-branch","href":"/build/gdk-and-engines/custom-engine"},{"title":"Optional services","sidebarTitle":"Optional services","description":"Layer optional XBOX and PlayFab services — XUser sign-in, achievements, XGameSave, social, multiplayer, and XStore commerce — into your PC GDK title.","icon":"plug","href":"/build/gdk-and-engines/optional-services"},{"group":"Handheld devices","icon":"mobile-screen","pages":[{"title":"PC handheld overview","sidebarTitle":"Overview","description":"Optimize and certify GDK titles for Windows handhelds like the ROG XBOX Ally with the Handheld Compatibility program, controller UX, and power guidance.","icon":"mobile-screen","href":"/build/gdk-and-engines/handheld/overview"},{"title":"Additional considerations for handheld devices","description":"Additional handheld guidance covering docked mode detection, guaranteed gamepad input, GetSystemPowerStatus power management, and screen size considerations.","sidebarTitle":"Additional considerations","icon":"list","href":"/build/gdk-and-engines/handheld/handheld-considerations"},{"title":"Handheld Compatibility program guidelines","description":"Follow five Handheld Compatibility program guidelines to optimize your GDK title for Windows gaming handhelds: defaults, input, fonts, power, and detection.","sidebarTitle":"Handheld guidelines","icon":"list-check","href":"/build/gdk-and-engines/handheld/handheld-guidance"},{"title":"Handheld Compatibility guidelines and test cases","description":"Follow pass/fail test steps for the Handheld Compatibility program's five guidelines on defaults, iconography, text input, HDR, and power management.","sidebarTitle":"Guidelines and test cases","icon":"clipboard-check","href":"/build/gdk-and-engines/handheld/handheld-guidelines-and-testcases"},{"title":"Game launchers and handhelds","description":"Build handheld game launchers with Full Screen Experience detection, resource limits, web tech, guide button handling, and foreground management on Windows.","sidebarTitle":"Game launchers","icon":"rocket","href":"/build/gdk-and-engines/handheld/handheld-launchers"},{"title":"Balancing performance and power efficiency","description":"Balance performance and battery life on Windows handhelds like the ROG XBOX Ally by auto-detecting hardware, tuning defaults, and reacting to power changes.","sidebarTitle":"Performance and power","icon":"battery-half","href":"/build/gdk-and-engines/handheld/handheld-performance"}]},{"group":"PC development guides","icon":"desktop","pages":[{"title":"Advanced Shader Delivery","description":"Advanced Shader Delivery precompiles Direct3D 12 shaders and delivers them at download time, reducing load times and in-game shader compilation stutter.","href":"/build/gdk-and-engines/guides/advanced-shader-delivery"},{"title":"Direct3D 12 programming guide","description":"Direct3D 12 programming guide covering work submission, resource binding, memory management, rendering, and debugging on DirectX 12 compatible GPUs.","href":"/build/gdk-and-engines/guides/directx-12-programming-guide"},{"title":"Simplified GDK directory structure (headers and libraries)","description":"Opt into the simplified October 2025 GDK directory layout with GDKCrossPlatform for MSBuild, CMake, and custom builds, and add ARM64 to your x64 title.","sidebarTitle":"GDK directory layout","icon":"folder-tree","href":"/build/gdk-and-engines/guides/gdk-directory-structure"},{"title":"Start a new PC title with GDK project templates","description":"Start new PC Desktop titles with five GDK Visual Studio project templates for Direct3D 12, Gaming Runtime, static libraries, DLLs, and makefile builds.","sidebarTitle":"Project templates","icon":"file-code","href":"/build/gdk-and-engines/guides/gdk-project-templates"},{"title":"Supporting high DPI displays on PC","description":"Enable Per-Monitor V2 DPI awareness in your PC title with an assembly manifest so rendering and mouse input work correctly on high-DPI Windows displays.","sidebarTitle":"High DPI displays","icon":"display","href":"/build/gdk-and-engines/guides/high-dpi-displays"},{"title":"Game performance in hybrid CPU environments","description":"Tune PC game thread affinity, CPU set enumeration, and priority boosts for heterogeneous CPUs from Intel, AMD, and Qualcomm to hit consistent frame times.","sidebarTitle":"Hybrid CPU performance","icon":"microchip","href":"/build/gdk-and-engines/guides/hybrid-cpu-performance"},{"title":"PC Bootstrapper","description":"Learn how the PC Bootstrapper GamingServicesUI.exe improves MSIXVC PC game launches with splash screens, update checks, cloud save sync, and single-instance.","sidebarTitle":"PC Bootstrapper","icon":"rocket","href":"/build/gdk-and-engines/guides/pc-bootstrapper"},{"title":"Troubleshoot XBOX Services traffic on PC","description":"Use Fiddler to inspect network traffic between your GDK PC title and XBOX Services, matching expected patterns for sign-in, achievements, and cloud saves.","sidebarTitle":"Troubleshoot services traffic","icon":"network-wired","href":"/build/gdk-and-engines/guides/troubleshoot-xbox-services-traffic"},{"title":"Window display modes and title-callable UI dialogs","description":"Configure PC game window display modes so title-callable UI (TCUI) dialogs render correctly and the Gaming Runtime prevents minimization on focus loss.","sidebarTitle":"Window modes and TCUI","icon":"window-restore","href":"/build/gdk-and-engines/guides/window-display-modes-tcui"},{"title":"FAQ for PC developers","sidebarTitle":"PC developer FAQ","description":"Answers to common PC GDK developer questions: sandbox dependencies, gaming services updates, multi-user package uninstall, and local game save locations.","icon":"circle-question","href":"/build/gdk-and-engines/guides/pc-faq"}]}]},{"group":"Steam porting guide","icon":"steam","pages":[{"title":"Steam porting guide overview","description":"Guide for porting Windows PC games from the Steamworks API to the XBOX GDK, mapping Steam features to their GDK and PlayFab equivalents.","sidebarTitle":"Overview","href":"/build/steam-porting-guide/overview"},{"title":"Conceptual differences between the GDK and Steamworks","description":"Compare how the GDK C APIs and Steamworks interface singletons structure code, manage state, and expect your game to run when porting a title from Steam.","href":"/build/steam-porting-guide/conceptual-differences"},{"group":"Features","pages":[{"title":"Stats and achievements","description":"Port Steam achievements and stats to the XBOX GDK title-managed API, tracking progress in your game and syncing check-ins to XBOX services.","href":"/build/steam-porting-guide/features/stats-and-achievements"},{"title":"Port Steam Cloud storage to the XBOX GDK","description":"Replace Steam Cloud and ISteamRemoteStorage with the XBOX GDK XGameSave wrapper, with side-by-side code samples for reading, writing, and syncing saves.","href":"/build/steam-porting-guide/features/steam-cloud"},{"title":"Leaderboards","description":"Recreate Steam leaderboards on XBOX GDK using event-based stats and Partner Center stat rules, with code samples comparing the two leaderboard APIs.","href":"/build/steam-porting-guide/features/steam-leaderboards"},{"title":"User authentication and ownership","description":"Migrate Steam user authentication and ownership checks to the XBOX GDK, covering user sign-in, entitlements, and licensing differences between platforms.","href":"/build/steam-porting-guide/features/user-authentication-and-ownership"}]},{"title":"GDK features not in Steamworks","description":"Overview of XBOX GDK capabilities with no Steamworks equivalent, including sandboxes, event-based achievements and stats, and XBOX Play Anywhere support.","href":"/build/steam-porting-guide/gdk-features-not-in-steamworks"},{"title":"Initializing the GDK","description":"Set up MicrosoftGame.config, initialize the Gaming Runtime and XSAPI, and sign in the user to XBOX Live when porting a title from Steamworks to the GDK.","href":"/build/steam-porting-guide/initializing-the-gdk"}]},{"group":"Game Principles","icon":"compass","pages":[{"group":"Localization and globalization","icon":"globe","pages":[{"title":"Localization and globalization overview","description":"Localize and globalize GDK titles for XBOX consoles with MicrosoftGame.config strings, NLS APIs, per-locale resources, and Partner Center service surfaces.","icon":"globe","sidebarTitle":"Overview","href":"/build/game-principles/localization"},{"title":"Console-supported languages","description":"Reference the full list of language, region, BCP-47 locale, and Narrator combinations XBOX consoles support when planning GDK title localization coverage.","sidebarTitle":"Console-supported languages","icon":"language","href":"/build/game-principles/localization/console-supported-languages"},{"title":"Determining console location","description":"Call GetUserDefaultGeoName in your GDK title to retrieve the XBOX console country and region at runtime, independent of the package manifest locale.","sidebarTitle":"Determining console location","icon":"location-dot","href":"/build/game-principles/localization/determining-console-geolocation"},{"title":"Determining console locale and language","description":"Use GetUserDefaultLocaleName and XPackageGetUserLocale to detect the XBOX console language and load the closest matching localized resources in your GDK title.","sidebarTitle":"Determining console locale","icon":"map-pin","href":"/build/game-principles/localization/determining-console-locale"},{"title":"Game-supported and unsupported locales","description":"Plan supported and unsupported XBOX locales in your GDK package Resources, test with xbconfig preferredlanguages, and add an in-title language picker.","sidebarTitle":"Supported and unsupported locales","icon":"circle-check","href":"/build/game-principles/localization/game-supported-and-unsupported-locales"},{"title":"Localization of packaged resources","description":"Localize strings, images, and assets in your GDK package using MicrosoftGame.config, chunk layout, and Intelligent Delivery for per-locale downloads.","sidebarTitle":"Localizing packaged resources","icon":"box","href":"/build/game-principles/localization/localization-of-packaged-resources"},{"title":"Supported NLS functions","description":"Reference the National Language Support (NLS) functions available under WINAPI_PARTITION_GAMES in the GDK, with XBOX Game OS caveats and usage notes.","sidebarTitle":"Supported NLS functions","icon":"list","href":"/build/game-principles/localization/supported-nls-apis"}]},{"group":"Security","icon":"shield","pages":[{"title":"GDK security overview","description":"Understand security obligations for GDK licensees, including secure GDK handling, dev hardware storage, Asset Custodian duties, and Microsoft audits.","icon":"shield","href":"/build/game-principles/security/security-overview"},{"title":"Communication security overview","href":"/build/game-principles/security/communication-security-overview"},{"title":"Game security concepts","href":"/build/game-principles/security/game-security-concepts"},{"title":"Game tool security","href":"/build/game-principles/security/game-tool-security"},{"title":"General game security","href":"/build/game-principles/security/general-game-security"},{"title":"Secure communication impl","href":"/build/game-principles/security/secure-communication-impl"},{"title":"Secure samples","href":"/build/game-principles/security/secure-samples"},{"title":"Secure game mesh impl","href":"/build/game-principles/security/secure-game-mesh-impl"},{"title":"Secure webrequest impl","href":"/build/game-principles/security/secure-webrequest-impl"}]},{"group":"Accessibility","icon":"universal-access","pages":[{"title":"GDK accessibility overview","description":"Explore Microsoft Gaming Accessibility guidelines, GDK APIs, XAGs, and feature tags for building accessible XBOX games players can enjoy.","icon":"universal-access","href":"/build/game-principles/accessibility/accessibility-overview"},{"title":"XBOX Accessibility Guidelines (XAG)","sidebarTitle":"XBOX Accessibility Guidelines (XAG)","description":"Overview of the XBOX Accessibility Guidelines (XAG v3.2) covering text, audio, input, UI, and photosensitivity best practices for games evaluated by MGATS.","icon":"universal-access","href":"/build/game-principles/accessibility/xbox-accessibility-guidelines"},{"title":"GDK accessibility overview","description":"Explore Microsoft Gaming Accessibility guidelines, GDK APIs, XAGs, and feature tags for building accessible XBOX games players can enjoy.","icon":"universal-access","href":"/build/game-principles/accessibility/accessibility-overview"},{"title":"XBOX Accessibility Guidelines (XAG)","sidebarTitle":"XBOX Accessibility Guidelines (XAG)","description":"Overview of the XBOX Accessibility Guidelines (XAG v3.2) covering text, audio, input, UI, and photosensitivity best practices for games evaluated by MGATS.","icon":"universal-access","href":"/build/game-principles/accessibility/xbox-accessibility-guidelines"},{"group":"XAG deep dives","icon":"list-check","pages":[{"title":"XAG 101: Text display","sidebarTitle":"101 · Text display","description":"Optimize text readability with minimum default sizes, configurable style and color, and adequate spacing so players with low vision can read everything.","icon":"font","href":"/build/game-principles/accessibility/xag-deep-dives/xag-101-text-display"},{"title":"XAG 102: Contrast","sidebarTitle":"102 · Contrast","description":"Meet minimum contrast ratios for text, HUD, and gameplay elements against their backgrounds so players with low vision can interpret them.","icon":"circle-half-stroke","href":"/build/game-principles/accessibility/xag-deep-dives/xag-102-contrast"},{"title":"XAG 103: Additional channels for visual and audio cues","sidebarTitle":"103 · Additional cues","description":"XAG 103 guidance for expressing visual and audio cues through multiple sensory channels like text, haptics, and spatial audio for blind and deaf players.","icon":"sitemap","href":"/build/game-principles/accessibility/xag-deep-dives/xag-103-additional-cues"},{"title":"XAG 104: Subtitles and captions","sidebarTitle":"104 · Subtitles \u0026 captions","description":"Ensure players who don't rely on audio can follow all speech and important non-speech audio via subtitles, captions, and sign language.","icon":"closed-captioning","href":"/build/game-principles/accessibility/xag-deep-dives/xag-104-subtitles-captions"},{"title":"XAG 105: Audio accessibility","sidebarTitle":"105 · Audio accessibility","description":"XAG 105 guidance on independent volume controls, spatial audio, mono downmix, and pause support so players with hearing loss can tune the mix they need.","icon":"sliders","href":"/build/game-principles/accessibility/xag-deep-dives/xag-105-audio-accessibility"},{"title":"XAG 106: Screen narration","sidebarTitle":"106 · Screen narration","description":"Represent all on-screen visual information aurally via screen narration so blind, low-vision, and non-reading players can use every UI.","icon":"ear-listen","href":"/build/game-principles/accessibility/xag-deep-dives/xag-106-screen-narration"},{"title":"XAG 107: Input","sidebarTitle":"107 · Input","description":"Let players operate the game with their chosen input: remapping, alternatives to holds and combos, single-stick modes, and mobile-touch guidance.","icon":"gamepad","href":"/build/game-principles/accessibility/xag-deep-dives/xag-107-input"},{"title":"XAG 108: Game difficulty options","sidebarTitle":"108 · Difficulty options","description":"Provide multiple difficulty presets, granular assist controls, an ultra-low mode, and non-condescending labels so every player can finish the game.","icon":"sliders-up","href":"/build/game-principles/accessibility/xag-deep-dives/xag-108-difficulty-options"},{"title":"XAG 109: Objective clarity","sidebarTitle":"109 · Objective clarity","description":"Always let the player know what they're supposed to be working toward — with task lists, progress trackers, waypoints, and narrative recaps.","icon":"list-check","href":"/build/game-principles/accessibility/xag-deep-dives/xag-109-objective-clarity"},{"title":"XAG 110: Haptic feedback","sidebarTitle":"110 · Haptic feedback","description":"XAG 110 guidance for haptic feedback: let players disable haptics and adjust intensity, and never use rumble as the sole channel for critical game information.","icon":"wave-square","href":"/build/game-principles/accessibility/xag-deep-dives/xag-110-haptic-feedback"},{"title":"XAG 111: Audio descriptions","sidebarTitle":"111 · Audio descriptions","description":"Provide audio description tracks for FMVs and scripted cinematic events so players who can't see visual content can still understand the story.","icon":"audio-description","href":"/build/game-principles/accessibility/xag-deep-dives/xag-111-audio-descriptions"},{"title":"XAG 112: UI navigation","sidebarTitle":"112 · UI navigation","description":"Provide clear, consistent, multi-input UI navigation across the game so players using assistive technology can reach settings and gameplay without barriers.","icon":"compass","href":"/build/game-principles/accessibility/xag-deep-dives/xag-112-ui-navigation"},{"title":"XAG 113: UI focus handling","sidebarTitle":"113 · UI focus handling","description":"Always show a highly visible focus indicator that never disappears or moves to offscreen elements, so players can tell which UI element has input focus.","icon":"crosshairs","href":"/build/game-principles/accessibility/xag-deep-dives/xag-113-ui-focus-handling"},{"title":"XAG 114: UI context","sidebarTitle":"114 · UI context","description":"Provide clear labels, consistent iconography, tooltips, and helpful context so players understand each UI element's purpose, operation, and expected input.","icon":"circle-info","href":"/build/game-principles/accessibility/xag-deep-dives/xag-114-ui-context"},{"title":"XAG 115: Error messages and destructive actions","sidebarTitle":"115 · Errors \u0026 destructive actions","description":"Detect and describe input errors, warn players before destructive actions, and let them review, undo, or reset choices before they're committed.","icon":"triangle-exclamation","href":"/build/game-principles/accessibility/xag-deep-dives/xag-115-error-messages"},{"title":"XAG 116: Time limits","sidebarTitle":"116 · Time limits","description":"Give players adequate time — or the ability to adjust, extend, or disable time limits — for any UI interaction that isn't a core gameplay mechanic.","icon":"stopwatch","href":"/build/game-principles/accessibility/xag-deep-dives/xag-116-time-limits"},{"title":"XAG 117: Visual distractions and motion settings","sidebarTitle":"117 · Motion \u0026 distractions","description":"Let players pause moving or blinking content, and offer field-of-view, camera-shake, motion-blur, and sensitivity settings to reduce motion sickness.","icon":"eye-slash","href":"/build/game-principles/accessibility/xag-deep-dives/xag-117-visual-distractions-motion"},{"title":"XAG 118: Photosensitivity","sidebarTitle":"118 · Photosensitivity","description":"Test games for photosensitive-seizure triggers and eliminate luminance flashes, red flashes, and high-contrast patterns that risk seizures or migraines.","icon":"bolt","href":"/build/game-principles/accessibility/xag-deep-dives/xag-118-photosensitivity"},{"title":"XAG 119: Speech-to-text and text-to-speech chat","sidebarTitle":"119 · STT / TTS chat","description":"Support speech-to-text and text-to-speech chat, narrate incoming text and emotes, and respect (and let players override) platform chat accessibility settings.","icon":"comments","href":"/build/game-principles/accessibility/xag-deep-dives/xag-119-chat"},{"title":"XAG 120: Communication experiences","sidebarTitle":"120 · Communication experiences","description":"XAG 120 guidance for accessible player communication: make the navigation, configuration, and use of voice, text, STT, and TTS chat features fully accessible.","icon":"users","href":"/build/game-principles/accessibility/xag-deep-dives/xag-120-communication-experiences"},{"title":"XAG 121: Accessible feature documentation","sidebarTitle":"121 · Accessible feature docs","description":"XAG 121 guidance for publishing accessible online feature documentation so players can assess your title's accessibility before purchase and get support after.","icon":"book-open","href":"/build/game-principles/accessibility/xag-deep-dives/xag-121-accessible-feature-documentation"},{"title":"XAG 122: Accessible customer support","sidebarTitle":"122 · Accessible customer support","description":"XAG 122 guidance for accessible customer support: offer phone, TTY, email, and live chat channels meeting WCAG 2 AA so all players can reach your support team.","icon":"headset","href":"/build/game-principles/accessibility/xag-deep-dives/xag-122-accessible-customer-support"},{"title":"XAG 123: Mental health best practices","sidebarTitle":"123 · Mental health best practices","description":"Give players control over game content that may impact mental health, and represent characters with mental health conditions accurately and respectfully.","icon":"brain","href":"/build/game-principles/accessibility/xag-deep-dives/xag-123-mental-health-best-practices"}]},{"title":"Gaming and Disability Player Experience Guide","sidebarTitle":"Gaming and Disability Player Experience Guide","description":"Use the Gaming and Disability Player Experience Guide (GADPEG) to explore gameplay barriers by motor, vision, hearing, cognitive, and speech disability.","icon":"user-group","href":"/build/game-principles/accessibility/gadpeg"},{"title":"Disability etiquette","sidebarTitle":"Disability etiquette","description":"Watch a 16-minute XBOX training video on disability etiquette that helps game developers run respectful playtests with the Gaming and Disability Community.","icon":"handshake","href":"/build/game-principles/accessibility/etiquette"},{"title":"Game Accessibility Workshop Toolkit","sidebarTitle":"Workshop toolkit","description":"Run Game Accessibility Workshops at your studio using facilitator assets, exercises, and inclusive design guidance from the XBOX Research Accessibility Team.","icon":"chalkboard-user","href":"/build/game-principles/accessibility/accessibility-workshop-toolkit"},{"title":"Gaming Accessibility Fundamentals learning path","sidebarTitle":"Gaming Accessibility Fundamentals learning path","description":"Take the free Gaming Accessibility Fundamentals learning path on Microsoft Learn: five modules and a virtual badge covering game accessibility basics.","icon":"graduation-cap","href":"/build/game-principles/accessibility/gaf-info"},{"title":"Speech accessibility user settings","description":"Retrieve and respect XBOX speech accessibility settings for STT, TTS, and narration using XAccessibility, XSpeechSynthesizer, Game Chat 2, and PlayFab Party.","icon":"ear-listen","href":"/build/game-principles/accessibility/speech-accessibility"},{"title":"Accessibility feature tags","sidebarTitle":"Feature tags","description":"Standard tags you declare in Partner Center so players can filter the Microsoft Store for the accessibility features they need. Version 2.0.1.","icon":"tags","href":"/build/game-principles/accessibility/accessibility-feature-tags"},{"title":"Accessibility of gaming AI experiences","sidebarTitle":"Accessibility and AI","description":"Learn how accessibility applies to AI-driven game frontends and backends, including pitfalls, practices, and opportunities for LLM and vision models.","icon":"microchip-ai","href":"/build/game-principles/accessibility/accessibility-of-gaming-ai"},{"title":"Developer accessibility resources","sidebarTitle":"Accessibility resources","description":"Curated Microsoft and third-party accessibility resources for XBOX developers, including XAGs, GADPEG, XBOX Adaptive Controller, training, and community links.","icon":"graduation-cap","href":"/build/game-principles/accessibility/accessibility-resources"},{"title":"Gaming and Disability Player Experience Guide","sidebarTitle":"Gaming and Disability Player Experience Guide","description":"Use the Gaming and Disability Player Experience Guide (GADPEG) to explore gameplay barriers by motor, vision, hearing, cognitive, and speech disability.","icon":"user-group","href":"/build/game-principles/accessibility/gadpeg"},{"title":"Disability etiquette","sidebarTitle":"Disability etiquette","description":"Watch a 16-minute XBOX training video on disability etiquette that helps game developers run respectful playtests with the Gaming and Disability Community.","icon":"handshake","href":"/build/game-principles/accessibility/etiquette"},{"title":"Game Accessibility Workshop Toolkit","sidebarTitle":"Workshop toolkit","description":"Run Game Accessibility Workshops at your studio using facilitator assets, exercises, and inclusive design guidance from the XBOX Research Accessibility Team.","icon":"chalkboard-user","href":"/build/game-principles/accessibility/accessibility-workshop-toolkit"},{"title":"Gaming Accessibility Fundamentals learning path","sidebarTitle":"Gaming Accessibility Fundamentals learning path","description":"Take the free Gaming Accessibility Fundamentals learning path on Microsoft Learn: five modules and a virtual badge covering game accessibility basics.","icon":"graduation-cap","href":"/build/game-principles/accessibility/gaf-info"},{"title":"Speech accessibility user settings","description":"Retrieve and respect XBOX speech accessibility settings for STT, TTS, and narration using XAccessibility, XSpeechSynthesizer, Game Chat 2, and PlayFab Party.","icon":"ear-listen","href":"/build/game-principles/accessibility/speech-accessibility"},{"title":"Accessibility feature tags","sidebarTitle":"Feature tags","description":"Standard tags you declare in Partner Center so players can filter the Microsoft Store for the accessibility features they need. Version 2.0.1.","icon":"tags","href":"/build/game-principles/accessibility/accessibility-feature-tags"},{"title":"Accessibility of gaming AI experiences","sidebarTitle":"Accessibility and AI","description":"Learn how accessibility applies to AI-driven game frontends and backends, including pitfalls, practices, and opportunities for LLM and vision models.","icon":"microchip-ai","href":"/build/game-principles/accessibility/accessibility-of-gaming-ai"},{"title":"Developer accessibility resources","sidebarTitle":"Accessibility resources","description":"Curated Microsoft and third-party accessibility resources for XBOX developers, including XAGs, GADPEG, XBOX Adaptive Controller, training, and community links.","icon":"graduation-cap","href":"/build/game-principles/accessibility/accessibility-resources"},{"group":"Playbook for Accessible Gaming Events (PAGE)","icon":"calendar-check","pages":[{"title":"PAGE 101 · Accessible event registration guidelines","sidebarTitle":"101 · Registration","description":"Make gaming event registration accessible with PAGE 101 guidance on forms, websites, kiosks, sign-in desks, queues, fonts, contrast, and language.","icon":"clipboard-list","href":"/build/game-principles/accessibility/page/page-101-registration"},{"title":"Playbook for Accessible Gaming Events (PAGE) 102 · Venues","sidebarTitle":"102 · Venues","description":"Pick an accessible gaming event venue with PAGE 102 checks for signage, doors, elevators, bathrooms, floor plans, lighting, seating, and audio systems.","icon":"building","href":"/build/game-principles/accessibility/page/page-102-venues"},{"title":"PAGE 103 · Accessible social media for gaming events","sidebarTitle":"103 · Social Media","description":"Post accessible event announcements and updates with PAGE 103 guidance on image alt-text, closed captions, audio description, and photosensitivity safety.","icon":"hashtag","href":"/build/game-principles/accessibility/page/page-103-social-media"},{"title":"Playbook for Accessible Gaming Events (PAGE) 104 · Catering","sidebarTitle":"104 · Catering","description":"Serve accessible food and beverages at gaming events using PAGE 104 tips on dietary needs, allergen safety, menus, utensils, and buffet line layout.","icon":"utensils","href":"/build/game-principles/accessibility/page/page-104-catering"},{"title":"PAGE 105 · Accessible speakers, videos, and presentations","sidebarTitle":"105 · Speakers \u0026 video","description":"Deliver accessible talks, videos, and PowerPoint decks with PAGE 105 tips on captions, sign-language interpretation, audio description, and photosensitivity.","icon":"microphone","href":"/build/game-principles/accessibility/page/page-105-speakers-videos-presentations"},{"title":"PAGE 106 · Accessible web content and applications","sidebarTitle":"106 · Web \u0026 apps","description":"Ship accessible event websites and companion apps with PAGE 106 guidance on WCAG 2.1 AA conformance, VPATs, and alternative access methods for attendees.","icon":"globe","href":"/build/game-principles/accessibility/page/page-106-web-content-applications"},{"title":"PAGE 107 · Accessible game demo stations for events","sidebarTitle":"107 · Demo stations","description":"Set up accessible game demo kiosks with PAGE 107 tips on monitors, tables, cleanliness, standard controllers, XBOX Adaptive Controller, and title info.","icon":"gamepad","href":"/build/game-principles/accessibility/page/page-107-game-demo-stations"},{"title":"PAGE 108 · Accessible attractions and activations","sidebarTitle":"108 · Attractions","description":"Design accessible photo booths, games of skill, and body-art activations with PAGE 108 guidance on queues, ramps, audio, effects, and content warnings.","icon":"star","href":"/build/game-principles/accessibility/page/page-108-attractions-activations"},{"title":"PAGE 109 · Accessible SWAG and merch for gaming events","sidebarTitle":"109 · SWAG \u0026 merch","description":"Choose accessible event SWAG and merch with PAGE 109 guidance on variety, safety, tactile options, printed catalogs, and inclusive wearable sizing.","icon":"shirt","href":"/build/game-principles/accessibility/page/page-109-swag-and-merch"},{"title":"Playbook for Accessible Gaming Events (PAGE) 110 · Staff","sidebarTitle":"110 · Staff","description":"Hire and train accessible gaming event staff with PAGE 110 guidance on disability etiquette, assistance requests, and interactions with attendees.","icon":"users","href":"/build/game-principles/accessibility/page/page-110-staff"},{"title":"PAGE 111 · Accessible transportation for gaming events","sidebarTitle":"111 · Transportation","description":"Offer accessible transportation to gaming events with PAGE 111 guidance on ADA parking, mass transit, paratransit, and on-site conveyance for attendees.","icon":"car","href":"/build/game-principles/accessibility/page/page-111-transportation"},{"title":"PAGE 112 · Post-event feedback and playbook review","sidebarTitle":"112 · Post-event","description":"Run post-event reviews with PAGE 112: collect feedback from guests with disabilities, study anecdotes and surveys, and evolve your accessibility playbook.","icon":"clipboard-check","href":"/build/game-principles/accessibility/page/page-112-post-event"},{"title":"PAGE · Pre-planning and post-event accessibility checklists","sidebarTitle":"Checklists","description":"Use PAGE pre-planning and post-event accessibility checklists to catch high-priority items across registration, venue, catering, speakers, and follow-up.","icon":"list-check","href":"/build/game-principles/accessibility/page/page-checklists"}]},{"title":"Why make games accessible","description":"Understand why accessible games matter: reach over 1 billion players with disabilities, improve design for everyone, and drive XBOX sales and social impact.","sidebarTitle":"Why make games accessible","icon":"heart","href":"/build/game-principles/accessibility/why-make-games-accessible"},{"title":"Why make games accessible","description":"Understand why accessible games matter: reach over 1 billion players with disabilities, improve design for everyone, and drive XBOX sales and social impact.","sidebarTitle":"Why make games accessible","icon":"heart","href":"/build/game-principles/accessibility/why-make-games-accessible"}]},{"group":"Sustainability","icon":"leaf","pages":[{"title":"Sustainability overview","sidebarTitle":"Sustainability overview","description":"Why energy efficiency matters on XBOX, how gameplay drives the console carbon footprint, and where to start with the Sustainability Toolkit to lower power draw.","icon":"leaf","href":"/build/game-principles/sustainability/sustainability-overview"},{"title":"Sustainability developer overview","sidebarTitle":"Sustainability developer overview","description":"How to approach profiling and optimizing your title's power consumption — which components matter, how to read Power Load %, and where the best savings hide.","icon":"gauge-high","href":"/build/game-principles/sustainability/sustainability-developer-overview"},{"title":"XBOX Game Energy Efficiency Essentials","sidebarTitle":"Energy efficiency essentials","description":"Checklist of essential passive and opt-in techniques from the XBOX Sustainability Toolkit for lowering a title's power consumption without sacrificing fidelity.","icon":"bolt","href":"/build/game-principles/sustainability/energy-efficiency-essentials"},{"title":"Dynamic Power States (DPS)","sidebarTitle":"Dynamic Power States","description":"Opt in to Dynamic Power States so the GPU driver scales power based on rendering workload, saving an extra 10–15% on XBOX Series consoles.","icon":"bolt","href":"/build/game-principles/sustainability/dynamic-power-states"},{"title":"Sustainability profiling with PIX","sidebarTitle":"Sustainability PIX guide","description":"Measure your XBOX title's power consumption with Performance Investigator for XBOX (PIX) and Power Monitor — step-by-step devkit setup, capture, and metrics.","icon":"chart-mixed","href":"/build/game-principles/sustainability/sustainability-pix-guide"},{"title":"Measure power consumption with your devkit","sidebarTitle":"Sustainability devkit guide","description":"Use the XBOX Series devkit front panel, XBOX Manager, and PIXGetPowerMetrics to track power consumption in real time on the console.","icon":"microchip","href":"/build/game-principles/sustainability/sustainability-devkit-guide"},{"title":"Lab platform baselines","sidebarTitle":"Lab platform baselines","description":"XBOX power consumption averages captured with PIX across in-game areas: main menu, loading, cutscenes, gameplay, constrained state, and multiplayer.","icon":"flask","href":"/build/game-principles/sustainability/lab-platform-baselines"},{"title":"View sustainability data in Partner Center","sidebarTitle":"Partner Center sustainability data","description":"Download energy consumption, carbon footprint, and power data for your XBOX titles from the Partner Center Insights Downloads Hub to track sustainability.","icon":"chart-line","href":"/build/game-principles/sustainability/partner-center-sustainability-data"},{"title":"Certification sustainability power reports","sidebarTitle":"Certification power reports","icon":"clipboard-check","description":"How XBOX Certification measures your title's power consumption across in-game areas, and how to request a bespoke Sustainability Power Report.","href":"/build/game-principles/sustainability/sustainability-case-studies"},{"title":"Global platform baselines","sidebarTitle":"Global platform baselines","description":"Anonymized AC-power telemetry from XBOX Series X|S consoles in the field, broken down by feature (4K, 60 FPS, HDR, VRR) and genre.","icon":"globe","href":"/build/game-principles/sustainability/global-platform-baselines"},{"group":"Case studies","icon":"book","pages":[{"title":"Call of Duty: Modern Warfare II \u0026 Warzone case study","sidebarTitle":"Call of Duty","description":"Infinity Ward's console + PC Eco Mode — three tiers, up to ~50% menu power savings, and 90% console adoption on the default setting.","icon":"crosshairs","href":"/build/game-principles/sustainability/case-studies/case-studies-cod"},{"title":"The Elder Scrolls Online case study","sidebarTitle":"Elder Scrolls Online","description":"How ZeniMax Online capped menu framerate at 30 FPS and applied idle detection, achieving a 5% platform-wide efficiency gain after Gold Road launched.","icon":"scroll","href":"/build/game-principles/sustainability/case-studies/case-studies-elder-scrolls-online"},{"title":"For Honor case study","sidebarTitle":"For Honor","description":"Ubisoft Montreal's Smart Eco Mode — default-on kept 95% of players enabled and won Best Green Tech from Playing for the Planet in 2024.","icon":"shield-halved","href":"/build/game-principles/sustainability/case-studies/case-studies-for-honor"},{"title":"Fortnite \u0026 Unreal Engine case study","sidebarTitle":"Fortnite","description":"How Epic combined the XBOX Sustainability Toolkit with Unreal Engine features to save an estimated 73 GWh per year across Fortnite's player base.","icon":"gamepad","href":"/build/game-principles/sustainability/case-studies/case-studies-fortnite"},{"title":"Gears of War: Reloaded case study","sidebarTitle":"Gears of War: Reloaded","description":"The Coalition combined passive Idle Energy Savings (−41% on Series X) with player-selectable Eco-Performance and Eco-Quality modes across Campaign and Versus.","icon":"gear","href":"/build/game-principles/sustainability/case-studies/case-studies-gears-of-war-reloaded"},{"title":"Halo Infinite case study","sidebarTitle":"Halo Infinite","description":"343 Industries dropped pause-menu resolution to 1080p for a 15% power saving with no visible impact, then explored 2.5D menus for ~30% additional savings.","icon":"circle","href":"/build/game-principles/sustainability/case-studies/case-studies-halo"},{"title":"Minecraft case study","sidebarTitle":"Minecraft","description":"Mojang's Minecraft Java FPS limiter for AFK and minimized states cuts power up to 75%, plus a console framerate cap on controller-disconnect dialogs.","icon":"cube","href":"/build/game-principles/sustainability/case-studies/case-studies-minecraft"},{"title":"Sustainability case studies overview","sidebarTitle":"Overview","description":"Sustainability Toolkit case studies from shipping titles like Call of Duty and Halo Infinite — techniques used, measured power savings, and roll-out models.","icon":"book-open","href":"/build/game-principles/sustainability/case-studies/case-studies-overview"},{"title":"Star Wars Outlaws case study","sidebarTitle":"Star Wars Outlaws","description":"Ubisoft Massive dropped pause-menu framerate to 1 FPS after 30 seconds of inactivity — pause-menu power draw fell from ~75% to 18–20%.","icon":"jedi","href":"/build/game-principles/sustainability/case-studies/case-studies-star-wars-outlaws"}]}]}]},{"group":"Core Features","tag":"","pages":[{"title":"Common GDK features for XBOX and PC titles","description":"Async, game config, streaming, input, lighting, packaging, and user identity features shared across XBOX and Windows titles built with the GDK.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/index"},{"group":"User and identity","pages":[{"title":"User identity and XUser APIs in the GDK","description":"User model choices, XUser identity APIs, and sign-in flows for XBOX and PC titles built with the June 2022 or later Microsoft Game Development Kit.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/user/index"},{"title":"User identity and XUser","description":"User identity and XUser","sidebarTitle":"User identity and xuser","icon":"right-to-bracket","href":"/build/core-features/common/user/player-identity-xuser"},{"title":"Microsoft Game Development Kit User Models","description":"Microsoft Game Development Kit User Models","sidebarTitle":"Microsoft game development kit user","icon":"user","href":"/build/core-features/common/user/gamecore-user-models"},{"title":"Opting into Default User Required","description":"Opting into Default User Required","sidebarTitle":"Opting into default user required","icon":"user","href":"/build/core-features/common/user/users-opting-into-simplified-model"},{"title":"Establishing the Default User for the Game","description":"Establishing the Default User for the Game","sidebarTitle":"Establishing the default user for the","icon":"user","href":"/build/core-features/common/user/users-establishing-default-user"},{"title":"Changing the Default User for the Game","description":"Changing the Default User for the Game","sidebarTitle":"Changing the default user for the game","icon":"user","href":"/build/core-features/common/user/users-changing-default-user"},{"title":"Dealing with Controller Loss","description":"Dealing with Controller Loss","sidebarTitle":"Dealing with controller loss","icon":"gamepad","href":"/build/core-features/common/user/users-dealing-with-controller-loss"},{"title":"When do user-to-controller associations take place?","description":"When do user-to-controller associations take place?","sidebarTitle":"When do user-to-controller associations","icon":"user","href":"/build/core-features/common/user/users-timing-of-user-to-device-association"},{"title":"Guest users overview","description":"Support Sponsored Guest accounts in XBOX titles so players can join local or online multiplayer sessions without creating a full XBOX account.","sidebarTitle":"Guest users","icon":"circle-info","href":"/build/core-features/common/user/users-guest-overview"},{"title":"Headless automation of XUser","description":"Headless automation of XUser","sidebarTitle":"Headless automation of xuser","icon":"user","href":"/build/core-features/common/user/users-headless-automation"},{"title":"How to: best practice to sign in a user","description":"How to: best practice to sign in a user","sidebarTitle":"How to: best practice to sign in a user","icon":"book-open","href":"/build/core-features/common/user/xuser_howto_best_practice_signing_in"},{"title":"Users and input devices","description":"Users and input devices","sidebarTitle":"Users and input devices","icon":"user","href":"/build/core-features/common/user/users-input-devices"},{"title":"XUser Cross-Platform Support","description":"XUser Cross-Platform Support","sidebarTitle":"Xuser cross-platform support","icon":"user","href":"/build/core-features/common/user/xuser-crossplatform"}]},{"group":"Core systems async programming model","pages":[{"title":"Async programming model in the XBOX GDK","description":"Documentation for the GDK async libraries and asynchronous programming model used by XBOX and PC titles for non-blocking operations and callbacks.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/async/index"},{"title":"Asynchronous Programming Overview","description":"Asynchronous Programming Overview","sidebarTitle":"Asynchronous programming","icon":"circle-info","href":"/build/core-features/common/async/async-toc"},{"title":"Asynchronous programming design goals and improvements","description":"Asynchronous programming design goals and improvements","sidebarTitle":"Asynchronous programming design goals","icon":"map","href":"/build/core-features/common/async/async-whitepaper"},{"title":"Asynchronous Programming Model","description":"Asynchronous Programming Model","sidebarTitle":"Asynchronous programming model","icon":"square-pen","href":"/build/core-features/common/async/async-programming-model"},{"group":"Async libraries","pages":[{"title":"XAsync libraries for asynchronous task programming","description":"Use the XAsync and XAsyncProvider libraries to define, invoke, and cancel asynchronous tasks and custom providers in GDK titles, with worked examples.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/async/async-libraries/index"},{"group":"Xtaskqueue library","pages":[{"title":"XTaskQueue library overview","description":"XTaskQueue library overview","sidebarTitle":"Xtaskqueue library","icon":"microchip","href":"/build/core-features/common/async/async-libraries/async-library-xtaskqueue"},{"title":"Create task queue example","description":"Create task queue example","sidebarTitle":"Create task queue example","icon":"microchip","href":"/build/core-features/common/async/async-libraries/async-library-xtaskqueue-example-create-task-queue"},{"title":"Dispatch task queue example","description":"Dispatch task queue example","sidebarTitle":"Dispatch task queue example","icon":"microchip","href":"/build/core-features/common/async/async-libraries/async-library-xtaskqueue-example-dispatch-task-queue"},{"title":"Clean up task queue example","description":"Clean up task queue example","sidebarTitle":"Clean up task queue example","icon":"microchip","href":"/build/core-features/common/async/async-libraries/async-library-xtaskqueue-example-cleanup-task-queue"}]},{"group":"Xasync library","pages":[{"title":"XAsync library overview","description":"XAsync library overview","sidebarTitle":"Xasync library","icon":"toolbox","href":"/build/core-features/common/async/async-libraries/async-library-xasync"},{"title":"Set up async task example","description":"Set up async task example","sidebarTitle":"Set up async task example","icon":"code","href":"/build/core-features/common/async/async-libraries/async-library-xasync-example-setup-async-task"},{"title":"Run simple task example","description":"Run simple task example","sidebarTitle":"Run simple task example","icon":"microchip","href":"/build/core-features/common/async/async-libraries/async-library-xasync-example-run-simple-task"},{"title":"Run Microsoft Game Development Kit API task example","description":"Run Microsoft Game Development Kit API task example","sidebarTitle":"Run microsoft game development kit API","icon":"cube","href":"/build/core-features/common/async/async-libraries/async-library-xasync-example-run-gdk-task"}]},{"group":"Xasyncprovider library","pages":[{"title":"XAsyncProvider library overview","description":"XAsyncProvider library overview","sidebarTitle":"Xasyncprovider library","icon":"circle-info","href":"/build/core-features/common/async/async-libraries/async-library-xasyncprovider"},{"title":"Set up custom provider example","description":"Set up custom provider example","sidebarTitle":"Set up custom provider example","icon":"code","href":"/build/core-features/common/async/async-libraries/async-library-xasyncprovider-example-setup-custom-provider"},{"title":"Set up invocation methods example","description":"Set up invocation methods example","sidebarTitle":"Set up invocation methods example","icon":"code","href":"/build/core-features/common/async/async-libraries/async-library-xasyncprovider-example-setup-invocation-methods"},{"title":"Set up return data example","description":"Set up return data example","sidebarTitle":"Set up return data example","icon":"code","href":"/build/core-features/common/async/async-libraries/async-library-xasyncprovider-example-setup-return-data"},{"title":"Set up cancelability example","description":"Set up cancelability example","sidebarTitle":"Set up cancelability example","icon":"download","href":"/build/core-features/common/async/async-libraries/async-library-xasyncprovider-example-setup-cancelability"}]}]},{"group":"Async task queue","pages":[{"title":"Async task queue design","description":"Async task queue design","sidebarTitle":"Async task queue design","icon":"microchip","href":"/build/core-features/common/async/async-task-queue-design"},{"title":"How to: Creating a thread pool task queue","description":"How to: Creating a thread pool task queue","sidebarTitle":"How to: creating a thread pool task","icon":"microchip","href":"/build/core-features/common/async/async-task-queue-design-howto/creating-thread-pool-task-queue"},{"title":"How to: Submitting callbacks","description":"How to: Submitting callbacks","sidebarTitle":"How to: submitting callbacks","icon":"paper-plane","href":"/build/core-features/common/async/async-task-queue-design-howto/submitting-callbacks"},{"title":"How to: Duplicating a task queue handle","description":"How to: Duplicating a task queue handle","sidebarTitle":"How to: duplicating a task queue handle","icon":"microchip","href":"/build/core-features/common/async/async-task-queue-design-howto/duplicating-task-queue-handle"},{"title":"How to: Creating a manual task queue","description":"How to: Creating a manual task queue","sidebarTitle":"How to: creating a manual task queue","icon":"microchip","href":"/build/core-features/common/async/async-task-queue-design-howto/creating-manual-task-queue"},{"title":"How to: Using events to control manual queue dispatching","description":"How to: Using events to control manual queue dispatching","sidebarTitle":"How to: using events to control manual","icon":"microchip","href":"/build/core-features/common/async/async-task-queue-design-howto/control-manual-queue-dispatching"},{"title":"How to: Using a task queue with a Windows message loop","description":"How to: Using a task queue with a Windows message loop","sidebarTitle":"How to: using a task queue with a","icon":"microchip","href":"/build/core-features/common/async/async-task-queue-design-howto/task-queue-windows-msg-loop"},{"title":"How to: Using the process task queue","description":"How to: Using the process task queue","sidebarTitle":"How to: using the process task queue","icon":"microchip","href":"/build/core-features/common/async/async-task-queue-design-howto/using-process-task-queue"},{"title":"How to: Creating a composite task queue","description":"How to: Creating a composite task queue","sidebarTitle":"How to: creating a composite task queue","icon":"book-open","href":"/build/core-features/common/async/async-task-queue-design-howto/creating-composite-task-queue"},{"title":"How to: Using delayed callbacks","description":"How to: Using delayed callbacks","sidebarTitle":"How to: using delayed callbacks","icon":"microchip","href":"/build/core-features/common/async/async-task-queue-design-howto/using-delayed-callbacks"},{"title":"How to: Using a task queue waiter","description":"How to: Using a task queue waiter","sidebarTitle":"How to: using a task queue waiter","icon":"microchip","href":"/build/core-features/common/async/async-task-queue-design-howto/using-task-queue-waiter"}]},{"title":"Generic async task wrapper","description":"Generic async task wrapper","sidebarTitle":"Generic async task wrapper","icon":"microchip","href":"/build/core-features/common/async/async-task-function-example"}]},{"group":"Graphics and rendering","pages":[{"group":"Graphics and rendering","pages":[{"title":"Graphics on XBOX and PC with the GDK","description":"DirectX 12 specs, Dolby Vision, HDR, ray tracing, and gen9 XBOX graphics topics for GDK titles targeting XBOX Series X|S, XBOX One, and Windows.","sidebarTitle":"Overview","icon":"palette","href":"/build/core-features/graphics/index"},{"title":"Graphics","description":"Graphics","sidebarTitle":"Graphics","icon":"palette","href":"/build/core-features/graphics/gc-graphics-toc"},{"group":"Direct3d 12 on XBOX","pages":[{"title":"Atoc d3d12x","href":"/build/core-features/graphics/d3d12x/atoc-d3d12x"},{"title":"D3d12x overview","href":"/build/core-features/graphics/d3d12x/d3d12x-overview"},{"title":"D3d12x differences from pc","href":"/build/core-features/graphics/d3d12x/d3d12x-differences-from-pc"},{"title":"D3d12x xmemalloc objecttypes","href":"/build/core-features/graphics/d3d12x/d3d12x-xmemalloc-objecttypes"},{"title":"Creation flags","href":"/build/core-features/graphics/directx/creation-flags"},{"title":"Native resource management","href":"/build/core-features/graphics/directx/native-resource-management"},{"title":"Suspend and resume","href":"/build/core-features/graphics/directx/suspend-and-resume"},{"title":"Offchip tesselation","href":"/build/core-features/graphics/directx/offchip-tesselation"},{"title":"Frame scheduling and presentation","href":"/build/core-features/graphics/directx/frame-scheduling-and-presentation"},{"title":"Hardware overlays","href":"/build/core-features/graphics/directx/hardware-overlays"},{"title":"Color and depth compression","href":"/build/core-features/graphics/directx/color-and-depth-compression"},{"title":"Screen areas","description":"Screen areas","sidebarTitle":"Screen areas","icon":"palette","href":"/build/core-features/graphics/overviews/screen-areas"},{"title":"Hdr support","href":"/build/core-features/graphics/overviews/hdr-support"},{"title":"One twenty hz support","href":"/build/core-features/graphics/overviews/one-twenty-hz-support"},{"title":"Cmask decoding","href":"/build/core-features/graphics/overviews/cmask-decoding"},{"title":"Enhanced barriers","href":"/build/core-features/graphics/overviews/enhanced-barriers"},{"title":"Gpu synchronization scarlett","href":"/build/core-features/graphics/overviews/gpu-synchronization-scarlett"},{"title":"Graphics pso overview","href":"/build/core-features/graphics/graphics-pso-overview"},{"title":"Image processing overview","href":"/build/core-features/graphics/image-processing-overview"}]},{"group":"XBOX one overview of graphics","pages":[{"title":"Graphics","href":"/build/core-features/graphics/overviews/graphics"},{"title":"Xbox one gpu overview","href":"/build/core-features/graphics/whitepapers/xbox-one-gpu-overview"},{"title":"Xbox one gpu compute units","href":"/build/core-features/graphics/whitepapers/xbox-one-gpu-compute-units"},{"title":"Xbox one gpu memory access","href":"/build/core-features/graphics/whitepapers/xbox-one-gpu-memory-access"},{"title":"Xg memory overview","href":"/build/core-features/graphics/d3d12x/xg-memory-overview"},{"title":"Caches and coherency on xbox one gpu","href":"/build/core-features/graphics/whitepapers/caches-and-coherency-on-xbox-one-gpu"},{"title":"How do vmem instructions work","href":"/build/core-features/graphics/whitepapers/how-do-vmem-instructions-work"},{"title":"Xbox one occupancy quick reference","href":"/build/core-features/graphics/whitepapers/xbox-one-occupancy-quick-reference"},{"title":"Checkerboard rendering on xbox one","href":"/build/core-features/graphics/whitepapers/checkerboard-rendering-on-xbox-one"},{"title":"Automatic shader modification for checkerboard rendering","href":"/build/core-features/graphics/whitepapers/automatic-shader-modification-for-checkerboard-rendering"},{"title":"Xbox one dynamic resolution","href":"/build/core-features/graphics/whitepapers/xbox-one-dynamic-resolution"},{"title":"Xbox one esram manager","href":"/build/core-features/graphics/whitepapers/xbox-one-esram-manager"}]},{"group":"XBOX series x|s graphics feature overviews","pages":[{"title":"Graphics newfeatures toc","href":"/build/core-features/graphics/graphics-newfeatures-toc"},{"group":"Sampler feedback introduction","pages":[{"title":"Sampler Feedback and SFS on XBOX Series X|S","description":"Guides for Sampler Feedback and Sampler Feedback Streaming (SFS) on XBOX Series X|S: Direct3D 12 API design, GPU hardware design, texture streaming usage.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/graphics/newfeatures/sfs/index"},{"title":"Sf overview","href":"/build/core-features/graphics/newfeatures/sfs/sf-overview"},{"title":"Why Sampler Feedback?","description":"Why Sampler Feedback?","sidebarTitle":"Why sampler feedback?","icon":"palette","href":"/build/core-features/graphics/newfeatures/sfs/why-sf"},{"title":"Sf gpu design","href":"/build/core-features/graphics/newfeatures/sfs/sf-gpu-design"},{"title":"Sf api design","href":"/build/core-features/graphics/newfeatures/sfs/sf-api-design"},{"title":"Sfs usage","href":"/build/core-features/graphics/newfeatures/sfs/sfs-usage"}]},{"group":"Raytracing introduction","pages":[{"title":"Raytracing on XBOX Series X|S with XDXR","description":"Raytracing guidance for XBOX Series X|S titles using XDXR, covering BVH builders, BVH compression, hardware design, k-DOP support, and offline RTPSO.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/graphics/newfeatures/raytracing/index"},{"title":"Rt overview","href":"/build/core-features/graphics/newfeatures/raytracing/rt-overview"},{"title":"Rt hardware design","href":"/build/core-features/graphics/newfeatures/raytracing/rt-hardware-design"},{"title":"Rt xdxr","href":"/build/core-features/graphics/newfeatures/raytracing/rt-xdxr"},{"title":"Rt bvhbuilders","href":"/build/core-features/graphics/newfeatures/raytracing/rt-bvhbuilders"},{"title":"Rt standalone","href":"/build/core-features/graphics/newfeatures/raytracing/rt-standalone"},{"title":"Rt compression","href":"/build/core-features/graphics/newfeatures/raytracing/rt-compression"},{"title":"Rt offlinertpso","href":"/build/core-features/graphics/newfeatures/raytracing/rt-offlinertpso"},{"title":"Rt xdxrbestpractices","href":"/build/core-features/graphics/newfeatures/raytracing/rt-xdxrbestpractices"},{"title":"Rt kdop","href":"/build/core-features/graphics/newfeatures/raytracing/rt-kdop"}]},{"group":"Mesh shader introduction","pages":[{"title":"Mesh shaders and meshlets on XBOX Series X|S","description":"Guides for the Direct3D 12 mesh shader pipeline on XBOX Series X|S consoles, covering the API design, meshlets, meshlet culling, and Scarlett-specific behavior.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/graphics/newfeatures/ms/index"},{"title":"Mesh Shader pipeline overview","description":"How the Mesh Shader pipeline replaces the input assembler with programmable Amplification and Mesh stages for scalable geometry on XBOX Series X|S.","sidebarTitle":"Mesh shader pipeline","icon":"circle-info","href":"/build/core-features/graphics/newfeatures/ms/ms-overview"},{"title":"Why Mesh Shaders?","description":"Why Mesh Shaders?","sidebarTitle":"Why mesh shaders?","icon":"palette","href":"/build/core-features/graphics/newfeatures/ms/ms-why"},{"title":"Mesh Shader pipeline API overview","description":"Mesh Shader pipeline API overview","sidebarTitle":"Mesh shader pipeline API","icon":"palette","href":"/build/core-features/graphics/newfeatures/ms/ms-api-design"},{"title":"Ms usage","href":"/build/core-features/graphics/newfeatures/ms/ms-usage"},{"title":"Meshlets","description":"Meshlets","sidebarTitle":"Meshlets","icon":"palette","href":"/build/core-features/graphics/newfeatures/ms/ms-meshlet-render"},{"title":"Meshlet culling example","description":"Meshlet culling example","sidebarTitle":"Meshlet culling example","icon":"code","href":"/build/core-features/graphics/newfeatures/ms/ms-meshlet-culling"},{"title":"Ms scarlett","href":"/build/core-features/graphics/newfeatures/ms/ms-scarlett"}]},{"group":"Variable rate shading introduction","pages":[{"title":"Variable Rate Shading (VRS) on XBOX Series X|S","description":"Guides for Variable Rate Shading on XBOX Series X|S: the Direct3D 12 API, VRS feature details, shading-rate overview, and when VRS helps a renderer.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/graphics/newfeatures/vrs/index"},{"title":"Vrs overview","href":"/build/core-features/graphics/newfeatures/vrs/vrs-overview"},{"title":"Why vrs","href":"/build/core-features/graphics/newfeatures/vrs/why-vrs"},{"title":"Vrs feature","href":"/build/core-features/graphics/newfeatures/vrs/vrs-feature"},{"title":"Vrs api","href":"/build/core-features/graphics/newfeatures/vrs/vrs-api"}]},{"group":"XBOX texture compressor overview","pages":[{"title":"XBOX Texture Compressor (XBTC) tool reference","description":"Reference for XBTC, the XBOX Texture Compressor that produces textures for the XBOX Series X|S hardware decompression unit, plus JSON batch configuration.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/graphics/newfeatures/xbtc/index"},{"title":"Xbox texture compressor","href":"/build/core-features/graphics/newfeatures/xbtc/xbox-texture-compressor"},{"title":"Xbtc","href":"/build/core-features/graphics/newfeatures/xbtc/xbtc"},{"title":"Xbtc archive format","href":"/build/core-features/graphics/newfeatures/xbtc/xbtc-archive-format"},{"title":"Xbtc json batch configuration","href":"/build/core-features/graphics/newfeatures/xbtc/xbtc-json-batch-configuration"}]},{"title":"Gpu overview","href":"/build/core-features/graphics/overviews/gpu-overview"},{"title":"Graphics memory overview","href":"/build/core-features/graphics/graphics-memory-overview"},{"title":"Scarlett tex layouts","href":"/build/core-features/graphics/scarlett-tex-layouts"},{"title":"Dolby vision for gaming","href":"/build/core-features/graphics/dolby-vision-for-gaming"},{"title":"Series s optimizations","href":"/build/core-features/graphics/whitepapers/series-s-optimizations"}]},{"title":"DirectX-Specs","description":"DirectX-Specs","sidebarTitle":"DirectX-specs","icon":"palette","href":"/build/core-features/graphics/directx-specs"},{"group":"Microsoft graphics presentations","pages":[{"title":"XBOX graphics presentations from XFest and XDD","description":"Slide decks and talks from Microsoft game conferences (XFest 2019, XFest 2022, XDD 2024) covering XBOX graphics techniques, tools, and hardware deep dives.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/graphics/overviews/presentations/index"},{"title":"Gc graphics presentations","href":"/build/core-features/graphics/overviews/presentations/gc-graphics-presentations"},{"group":"XBOX dev days 2024","pages":[{"title":"Xdd2024","description":"Explore xdd2024 documentation and reference for the XBOX Game Development Kit.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/graphics/overviews/presentations/xdd2024/index"},{"group":"Summaries","pages":[{"title":"Gc graphics xdd 2024 gr01","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr01"},{"title":"Gc graphics xdd 2024 gr02","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr02"},{"title":"Gc graphics xdd 2024 gr03","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr03"},{"title":"Gc graphics xdd 2024 gr04","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr04"},{"title":"Gc graphics xdd 2024 gr05","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr05"},{"title":"Gc graphics xdd 2024 gr06","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr06"},{"title":"Gc graphics xdd 2024 gr07","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr07"},{"title":"Gc graphics xdd 2024 gr08","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr08"},{"title":"Gc graphics xdd 2024 gr09","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr09"},{"title":"Gc graphics xdd 2024 gr10","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr10"},{"title":"Gc graphics xdd 2024 gr11","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr11"},{"title":"Optimize game dev workflows with Visual Studio and AI","description":"Optimizing game development workflows with Visual Studio and AI","sidebarTitle":"Optimizing game development workflows","icon":"palette","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr12"},{"title":"Gc graphics xdd 2024 gr13","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gc-graphics-xdd-2024-gr13"}]},{"group":"Overviews","pages":[{"title":"Getting the most from xbox shader compiler","href":"/build/core-features/graphics/overviews/presentations/xdd2024/getting-the-most-from-xbox-shader-compiler"},{"title":"Whats new in pix 2024","href":"/build/core-features/graphics/overviews/presentations/xdd2024/whats-new-in-pix-2024"},{"title":"Gpu debugging tips and tricks","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gpu-debugging-tips-and-tricks"},{"title":"Optimizing shader performance with pix shader explorer","href":"/build/core-features/graphics/overviews/presentations/xdd2024/optimizing-shader-performance-with-pix-shader-explorer"},{"title":"Gpu performance tips and tricks","href":"/build/core-features/graphics/overviews/presentations/xdd2024/gpu-performance-tips-and-tricks"}]}]},{"group":"Xfest 2022","pages":[{"title":"Xfest2022","description":"Explore xfest2022 documentation and reference for the XBOX Game Development Kit.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/graphics/overviews/presentations/xfest2022/index"},{"title":"Gc graphics xfest 2022 gr01","href":"/build/core-features/graphics/overviews/presentations/xfest2022/gc-graphics-xfest-2022-gr01"},{"title":"Gc graphics xfest 2022 gr02","href":"/build/core-features/graphics/overviews/presentations/xfest2022/gc-graphics-xfest-2022-gr02"},{"title":"Gc graphics xfest 2022 gr03","href":"/build/core-features/graphics/overviews/presentations/xfest2022/gc-graphics-xfest-2022-gr03"},{"title":"Gc graphics xfest 2022 gr06","href":"/build/core-features/graphics/overviews/presentations/xfest2022/gc-graphics-xfest-2022-gr06"},{"title":"Gc graphics xfest 2022 gr07","href":"/build/core-features/graphics/overviews/presentations/xfest2022/gc-graphics-xfest-2022-gr07"},{"title":"Gc graphics xfest 2022 gr09","href":"/build/core-features/graphics/overviews/presentations/xfest2022/gc-graphics-xfest-2022-gr09"}]},{"group":"Xfest 2019","pages":[{"title":"Xfest2019","description":"Explore xfest2019 documentation and reference for the XBOX Game Development Kit.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/graphics/overviews/presentations/xfest2019/index"},{"title":"Gc graphics xfest 2019 gr01","href":"/build/core-features/graphics/overviews/presentations/xfest2019/gc-graphics-xfest-2019-gr01"},{"title":"Gc graphics xfest 2019 gr04","href":"/build/core-features/graphics/overviews/presentations/xfest2019/gc-graphics-xfest-2019-gr04"},{"title":"Gc graphics xfest 2019 gr08","href":"/build/core-features/graphics/overviews/presentations/xfest2019/gc-graphics-xfest-2019-gr08"}]}]},{"title":"Graphics samples","description":"Graphics samples","sidebarTitle":"Graphics samples","icon":"code","href":"/build/core-features/graphics/graphics-samples"}]},{"group":"Lighting","pages":[{"title":"Lighting API and LampArray on XBOX and PC","description":"Drive RGB lighting on peripherals and controllers with the GDK Lighting API and LampArray basics for XBOX Series X|S, XBOX One, and Windows titles.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/lighting/index"},{"title":"Lighting API Overview","description":"Lighting API Overview","sidebarTitle":"Lighting API","icon":"circle-info","href":"/build/core-features/common/lighting/gc-lighting-toc"},{"group":"Lighting concepts","pages":[{"title":"LampArray Basics","description":"LampArray Basics","sidebarTitle":"Lamparray basics","icon":"note-sticky","href":"/build/core-features/common/lighting/lighting-basics"},{"title":"Setting colors on a LampArray","description":"Setting colors on a LampArray","sidebarTitle":"Setting colors on a lamparray","icon":"sliders","href":"/build/core-features/common/lighting/lighting-colors"},{"title":"LampArray Effects","description":"LampArray Effects","sidebarTitle":"Lamparray effects","icon":"compass","href":"/build/core-features/common/lighting/lighting-effects"}]}]}]},{"group":"Input and devices","pages":[{"title":"Input APIs and hardware for XBOX GDK titles","description":"GameInput APIs, controller and accessory hardware, and advanced input topics for XBOX Series X|S, XBOX One, and Windows GDK titles.","sidebarTitle":"Overview","icon":"gamepad","href":"/build/core-features/common/input/index"},{"title":"Input","description":"Input","sidebarTitle":"Input","icon":"gamepad","href":"/build/core-features/common/input/gc-input-toc"},{"group":"Overview of gameinput","pages":[{"title":"Overviews","description":"Reference and overviews for gamepad, keyboard, and mouse input in the XBOX Game Development Kit (core features). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/input/overviews/index"},{"title":"Overview of GameInput","description":"GameInput is the GDK's unified input API for gamepads, keyboards, mice, and other controllers on XBOX consoles and Windows 10 or later.","sidebarTitle":"Overview of gameinput","icon":"gamepad","href":"/build/core-features/common/input/overviews/input-overview"},{"title":"GameInput frequently asked questions","description":"Answers to common GameInput questions: supported XBOX and Windows versions, engine integration for Unreal, Godot, and Unity, and porting from XInput.","sidebarTitle":"Gameinput frequently asked questions","icon":"circle-info","href":"/build/core-features/common/input/overviews/input-faq"},{"title":"GameInput fundamentals","description":"GameInput fundamentals","sidebarTitle":"Gameinput fundamentals","icon":"lightbulb","href":"/build/core-features/common/input/overviews/input-fundamentals"},{"title":"GameInput readings","description":"GameInput readings","sidebarTitle":"Gameinput readings","icon":"gamepad","href":"/build/core-features/common/input/overviews/input-readings"},{"title":"GameInput devices","description":"GameInput devices","sidebarTitle":"Gameinput devices","icon":"gamepad","href":"/build/core-features/common/input/overviews/input-devices"},{"title":"GameInput for PC and console with NuGet","description":"GameInput for PC and console with NuGet","sidebarTitle":"Gameinput for pc and console with NuGet","icon":"gamepad","href":"/build/core-features/common/input/overviews/input-nuget"},{"title":"GameInput API versioning","description":"GameInput API versioning","sidebarTitle":"Gameinput API versioning","icon":"clock-rotate-left","href":"/build/core-features/common/input/overviews/input-versioning"}]},{"group":"Advanced gameinput topics","pages":[{"title":"Advanced GameInput topics: force feedback and callbacks","description":"Advanced GameInput topics for GDK titles, including callbacks, force feedback, keyboard and mouse handling, and dynamic latency synchronization.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/input/advanced/index"},{"title":"Advanced GameInput topics","description":"Advanced GameInput topics","sidebarTitle":"Advanced gameinput topics","icon":"gamepad","href":"/build/core-features/common/input/advanced/input-advanced-topics"},{"title":"GameInput callbacks","description":"GameInput callbacks","sidebarTitle":"Gameinput callbacks","icon":"gamepad","href":"/build/core-features/common/input/advanced/input-callbacks"},{"title":"GameInput work queues","description":"GameInput work queues","sidebarTitle":"Gameinput work queues","icon":"gamepad","href":"/build/core-features/common/input/advanced/input-work-queues"},{"title":"Dynamic Latency Input","description":"Dynamic Latency Input","sidebarTitle":"Dynamic latency input","icon":"network-wired","href":"/build/core-features/common/input/advanced/input-synchronization"},{"title":"Force feedback on GameInput","description":"Force feedback on GameInput","sidebarTitle":"Force feedback on gameinput","icon":"gamepad","href":"/build/core-features/common/input/advanced/input-forcefeedback"},{"title":"Keyboards and mice in GameInput","description":"Keyboards and mice in GameInput","sidebarTitle":"Keyboards and mice in gameinput","icon":"gamepad","href":"/build/core-features/common/input/advanced/input-keyboard-mouse"}]},{"group":"Gameinput for hardware developers","pages":[{"title":"GameInput hardware: force feedback, haptics, and sensors","description":"Guides for the hardware surfaces GameInput exposes: force feedback interface, haptics, device interfaces, the device mapping tool, and sensors.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/input/hardware/index"},{"title":"GameInput for hardware developers","description":"GameInput for hardware developers","sidebarTitle":"Gameinput for hardware developers","icon":"gamepad","href":"/build/core-features/common/input/hardware/input-hardware-topics"},{"title":"GameInput Device Mapping Tool and Testing Guide","description":"GameInput Device Mapping Tool and Testing Guide","sidebarTitle":"Gameinput device mapping tool and","icon":"book-open","href":"/build/core-features/common/input/hardware/input-hardware-mapping"},{"title":"Interfacing with the different GameInput device types","description":"Interfacing with the different GameInput device types","sidebarTitle":"Interfacing with the different","icon":"brackets-curly","href":"/build/core-features/common/input/hardware/input-hardware-interfaces"},{"title":"GameInput force feedback interface","description":"GameInput force feedback interface","sidebarTitle":"Gameinput force feedback interface","icon":"gamepad","href":"/build/core-features/common/input/hardware/input-hardware-force-feedback"},{"title":"Sensors in GameInput","description":"Reference for GameInput sensor support: HID sensor stack requirements, gamepad and handheld coordinate systems, and sample acceleration output.","sidebarTitle":"Sensors in gameinput","icon":"gamepad","href":"/build/core-features/common/input/hardware/input-hardware-sensors"},{"title":"Haptics in GameInput","description":"Haptics in GameInput","sidebarTitle":"Haptics in gameinput","icon":"server","href":"/build/core-features/common/input/hardware/input-hardware-haptics"}]},{"group":"Gameinput porting guide","pages":[{"title":"Porting existing input code to GameInput","description":"Port titles from XInput or Windows.Xbox.Input to GameInput, or combine GameInput with an existing input stack while migrating your game to the GDK.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/input/porting/index"},{"title":"Combining GameInput with existing input stacks","description":"Combining GameInput with existing input stacks","sidebarTitle":"Combining gameinput with existing input","icon":"gamepad","href":"/build/core-features/common/input/porting/input-porting"},{"title":"Porting from Windows.XBOX.Input to GameInput","description":"Porting from Windows.XBOX.Input to GameInput","sidebarTitle":"Porting from windows.XBOX.input to","icon":"gamepad","href":"/build/core-features/common/input/porting/input-porting-wxi"},{"title":"Porting from XInput to GameInput","description":"Porting from XInput to GameInput","sidebarTitle":"Porting from xinput to gameinput","icon":"gamepad","href":"/build/core-features/common/input/porting/input-porting-xinput"}]},{"title":"Virtual keyboard support","description":"Virtual keyboard support","sidebarTitle":"Virtual keyboard support","icon":"gamepad","href":"/build/core-features/common/input/overviews/virtualkeyboardsupport"}]},{"group":"Game configuration and packaging","pages":[{"group":"Game configuration","pages":[{"title":"MicrosoftGame.config editor and reference","description":"Author and edit the MicrosoftGame.config manifest for XBOX and PC titles using the MicrosoftGame.config Editor and the full property reference.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/game-config/index"},{"title":"MicrosoftGame.config overview","description":"MicrosoftGame.config overview","sidebarTitle":"Microsoftgame.config","icon":"circle-info","href":"/build/core-features/common/game-config/MicrosoftGameConfig-Overview"},{"title":"MicrosoftGame.config Editor","description":"MicrosoftGame.config Editor","sidebarTitle":"Microsoftgame.config editor","icon":"clipboard-list","href":"/build/core-features/common/game-config/MicrosoftGameConfig-Editor"},{"title":"MicrosoftGame.config localization","description":"MicrosoftGame.config localization","sidebarTitle":"Microsoftgame.config localization","icon":"language","href":"/build/core-features/common/game-config/MicrosoftGameConfig-Localization"}]},{"group":"Packaging","pages":[{"title":"Packaging and deployment for XBOX GDK titles","description":"Package XBOX and PC titles for submission using MakePkg, deployment workflows, and Subval validation tools included with the Microsoft GDK.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/packaging/index"},{"title":"Overview of packaging","description":"Overview of packaging","sidebarTitle":"Overview of packaging","icon":"box","href":"/build/core-features/common/packaging/overviews/packaging"},{"title":"XBOX Game Package Manager","description":"XBOX Game Package Manager","sidebarTitle":"XBOX game package manager","icon":"box","href":"/build/core-features/common/packaging/xgpm"},{"title":"Package Uploader","description":"Package Uploader","sidebarTitle":"Package uploader","icon":"box","href":"/build/core-features/common/packaging/package-uploader"},{"title":"Getting started with packaging titles for XBOX consoles","description":"Getting started with packaging titles for XBOX consoles","sidebarTitle":"Getting started with packaging titles","icon":"circle-info","href":"/build/core-features/common/packaging/overviews/packaging-getting-started-for-console"},{"title":"Get started packaging PC titles with MSIXVC tools","description":"Getting started with packaging titles for a PC by using the MSIXVC packaging tools","sidebarTitle":"Getting started with packaging titles","icon":"box","href":"/build/core-features/common/packaging/overviews/packaging-getting-started-for-PC"},{"title":"Streaming Installation and Intelligent Delivery: an overview","description":"Streaming Installation and Intelligent Delivery: an overview","sidebarTitle":"Streaming installation and intelligent","icon":"video","href":"/build/core-features/common/packaging/overviews/streaming_install-intelligent_delivery"},{"title":"Supporting Games-as-a-Service (GaaS)","description":"Supporting Games-as-a-Service (GaaS)","sidebarTitle":"Supporting games-as-a-service (gaas)","icon":"box","href":"/build/core-features/common/packaging/supporting-games-as-a-service"},{"group":"Msixvc2 packaging (preview)","pages":[{"title":"MSIXVC2 packaging overview","description":"MSIXVC2 is the new PC packaging format in the GDK, delivering smaller base packages, faster content updates, and a simplified upload workflow.","sidebarTitle":"Msixvc2 packaging","icon":"box","href":"/build/core-features/common/packaging/overviews/packaging-msixvc2-overview"},{"title":"Getting started with MSIXVC2 packaging for PC","description":"Getting started with MSIXVC2 packaging for PC","sidebarTitle":"Getting started with msixvc2 packaging","icon":"box","href":"/build/core-features/common/packaging/overviews/packaging-getting-started-for-PC-msixvc2"},{"title":"Content updates with MSIXVC2","description":"Content updates with MSIXVC2","sidebarTitle":"Content updates with msixvc2","icon":"box","href":"/build/core-features/common/packaging/packaging-updates-msixvc2"},{"title":"MSIXVC2 encryption model","description":"MSIXVC2 encryption model","sidebarTitle":"Msixvc2 encryption model","icon":"lock","href":"/build/core-features/common/packaging/packaging-encryption-msixvc2"}]},{"group":"Common packaging tasks and workflow overview","pages":[{"title":"Title packaging, updates, and streaming-install testing","description":"Title packaging, content updates, and streaming-installation testing","sidebarTitle":"Title packaging, content updates, and","icon":"video","href":"/build/core-features/common/packaging/title-packaging-streaming-install-testing"},{"group":"Submission validator (submissionvalidator.dll)","pages":[{"title":"Submission Validator (SubVal) quality checks reference","description":"Reference for Submission Validator, the GDK component that runs quality checks on title packages before submission, including messages and check catalogs.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/packaging/subval/index"},{"title":"Submission Validator (SubmissionValidator.dll)","description":"Submission Validator (SubmissionValidator.dll)","sidebarTitle":"Submission validator (submissionvalidato","icon":"box","href":"/build/core-features/common/packaging/subval/submissionvalidator"},{"title":"Submission Validator quality checks","description":"Submission Validator quality checks","sidebarTitle":"Submission validator quality checks","icon":"paper-plane","href":"/build/core-features/common/packaging/subval/submissionvalidator-tests"},{"title":"Submission Validator messages","description":"Submission Validator messages","sidebarTitle":"Submission validator messages","icon":"box","href":"/build/core-features/common/packaging/subval/submissionvalidator-messages"}]},{"title":"Application packaging during development","description":"Application packaging during development","sidebarTitle":"Application packaging during development","icon":"box","href":"/build/core-features/common/packaging/packaging-packaging-during-development"},{"title":"Flat File Install overview","description":"Flat File Install overview","sidebarTitle":"Flat file install","icon":"circle-info","href":"/build/core-features/common/packaging/packaging-flatfileinstall"},{"title":"Testing packages on a development PC","description":"Testing packages on a development PC","sidebarTitle":"Testing packages on a development pc","icon":"box","href":"/build/core-features/common/packaging/packaging-testing-PC-install"},{"title":"Content update best practices","description":"Content update best practices","sidebarTitle":"Content update best practices","icon":"box","href":"/build/core-features/common/packaging/packaging-updates"},{"title":"Creating test discs","description":"Creating test discs","sidebarTitle":"Creating test discs","icon":"box","href":"/build/core-features/common/packaging/creating-test-compilation-discs"},{"title":"Creating a disc subset","description":"Creating a disc subset","sidebarTitle":"Creating a disc subset","icon":"box","href":"/build/core-features/common/packaging/packaging-disc-subset"},{"title":"Cross-generation test discs overview","description":"Cross-generation test discs overview","sidebarTitle":"Cross-generation test discs","icon":"box","href":"/build/core-features/common/packaging/creating-cross-gen-test-discs"},{"title":"Creating discs","description":"Creating discs","sidebarTitle":"Creating discs","icon":"box","href":"/build/core-features/common/packaging/creating-discs"},{"title":"Framework package dependencies","description":"Framework package dependencies","sidebarTitle":"Framework package dependencies","icon":"box","href":"/build/core-features/common/packaging/packaging-framework-packages"},{"title":"Custom installation actions","description":"Custom installation actions","sidebarTitle":"Custom installation actions","icon":"download","href":"/build/core-features/common/packaging/packaging-custom-install-actions"},{"title":"Mods support for PC GDK titles","description":"Mods support for PC GDK titles","sidebarTitle":"Mods support for pc GDK titles","icon":"cube","href":"/build/core-features/common/packaging/packaging-mods"},{"title":"GDK downloadable content (DLC) packages","description":"Microsoft Game Development Kit downloadable content (DLC) packages","sidebarTitle":"Microsoft game development kit","icon":"box","href":"/build/core-features/common/packaging/packaging-downloadable-content-dlc"},{"title":"Publisher Content packages","description":"Describes how to create and ship Publisher Content packages, a package type that lets game publishers host and update supplemental content on their own CDNs.","icon":"box","href":"/build/core-features/common/packaging/packaging-publisher-content"},{"title":"Creating, examining, and testing content updates","description":"Creating, examining, and testing content updates","sidebarTitle":"Creating, examining, and testing","icon":"box","href":"/build/core-features/common/packaging/packaging-testing-updates"}]},{"group":"Intelligent delivery features","pages":[{"title":"Intelligent Delivery","description":"Intelligent Delivery","sidebarTitle":"Intelligent delivery","icon":"box","href":"/build/core-features/common/packaging/overviews/intelligentdelivery"},{"title":"Intelligent Delivery: features and recipes","description":"Intelligent Delivery: features and recipes","sidebarTitle":"Intelligent delivery: features and","icon":"box","href":"/build/core-features/common/packaging/intelligentdelivery-features-recipes"},{"title":"Intelligent Delivery: custom tag specifiers","description":"Intelligent Delivery: custom tag specifiers","sidebarTitle":"Intelligent delivery: custom tag","icon":"box","href":"/build/core-features/common/packaging/intelligentdelivery-custom"},{"title":"Intelligent Delivery: device specifiers","description":"Intelligent Delivery: device specifiers","sidebarTitle":"Intelligent delivery: device specifiers","icon":"box","href":"/build/core-features/common/packaging/intelligentdelivery-device"},{"title":"Intelligent Delivery: language specifiers","description":"Intelligent Delivery: language specifiers","sidebarTitle":"Intelligent delivery: language","icon":"language","href":"/build/core-features/common/packaging/intelligentdelivery-language"},{"title":"Intelligent Delivery: OnDemand content","description":"Intelligent Delivery: OnDemand content","sidebarTitle":"Intelligent delivery: ondemand content","icon":"box","href":"/build/core-features/common/packaging/intelligentdelivery-ondemand"},{"group":"Intelligent delivery implementation","pages":[{"title":"Dynamic reordering of chunks","description":"Dynamic reordering of chunks","sidebarTitle":"Dynamic reordering of chunks","icon":"box","href":"/build/core-features/common/packaging/packaging-chunkreordering"},{"title":"Streaming installation: debugging","description":"Streaming installation: debugging","sidebarTitle":"Streaming installation: debugging","icon":"video","href":"/build/core-features/common/packaging/packaging-debugging"},{"title":"Streaming installation: status","description":"Streaming installation: status","sidebarTitle":"Streaming installation: status","icon":"chart-line","href":"/build/core-features/common/packaging/packaging-installstatus"},{"title":"Multi-disc functionality","description":"Multi-disc functionality","sidebarTitle":"Multi-disc functionality","icon":"box","href":"/build/core-features/common/packaging/packaging-multi-disc"}]}]},{"group":"Tools for streaming installation","pages":[{"title":"Deployment package schema and streaming install tools","description":"Deployment package schema reference for the makepkg mapping file, including the package, chunk, and filegroup elements, plus streaming install tooling.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/packaging/deployment/index"},{"title":"Tools for streaming installation","description":"Tools for streaming installation","sidebarTitle":"Tools for streaming installation","icon":"video","href":"/build/core-features/common/packaging/deployment/atoc-deployment-tools"},{"group":"Deployment package schema","pages":[{"title":"Deployment package schema","description":"Deployment package schema","sidebarTitle":"Deployment package schema","icon":"box","href":"/build/core-features/common/packaging/deployment/atoc-deployment-schema"},{"title":"\u003cChunk> element","description":"\u003cChunk> element","sidebarTitle":"\u003cchunk> element","icon":"box","href":"/build/core-features/common/packaging/deployment/deployment-element-chunk"},{"title":"\u003cFileGroup> element","description":"\u003cFileGroup> element","sidebarTitle":"\u003cfilegroup> element","icon":"users","href":"/build/core-features/common/packaging/deployment/deployment-element-filegroup"},{"title":"\u003cPackage> element","description":"\u003cPackage> element","sidebarTitle":"\u003cpackage> element","icon":"box","href":"/build/core-features/common/packaging/deployment/deployment-element-package"}]},{"title":"Make package (makepkg.exe)","description":"Make package (makepkg.exe)","sidebarTitle":"Make package (makepkg.exe)","icon":"box","href":"/build/core-features/common/packaging/deployment/makepkg"},{"title":"Make package resource index (MakePRI.exe)","description":"Make package resource index (MakePRI.exe)","sidebarTitle":"Make package resource index","icon":"box","href":"/build/core-features/common/packaging/deployment/makepri"},{"title":"packageutil.exe","description":"packageutil.exe","sidebarTitle":"Packageutil.exe","icon":"box","href":"/build/core-features/common/packaging/deployment/packageutil"},{"title":"Split package (splitpkg.exe)","description":"Split package (splitpkg.exe)","sidebarTitle":"Split package (splitpkg.exe)","icon":"box","href":"/build/core-features/common/packaging/deployment/splitpkg"}]}]}]},{"group":"Game streaming","pages":[{"title":"XBOX Cloud Gaming touch and streaming support","description":"Build streaming-ready XBOX GDK titles with touch layout support, TAK command line tooling, and configuration for XBOX Cloud Gaming clients.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/game-streaming/index"},{"title":"Introduction to game streaming","description":"Get started with XBOX Game Streaming and XBOX Remote Play, including Cloud Aware APIs, offerings, and how to prepare a title for streaming.","sidebarTitle":"Introduction to game streaming","icon":"video","href":"/build/core-features/common/game-streaming/game-streaming-overview"},{"group":"Game streaming setup","pages":[{"title":"Streaming your game","description":"Streaming your game","sidebarTitle":"Streaming your game","icon":"video","href":"/build/core-features/common/game-streaming/game-streaming-stream-your-game"},{"title":"Setting up your XBOX Development Kit for streaming","description":"Setting up your XBOX Development Kit for streaming","sidebarTitle":"Setting up your XBOX development kit","icon":"download","href":"/build/core-features/common/game-streaming/game-streaming-setup-xbox-developer-kit"},{"title":"Android Content Test Application (CTA) overview (Deprecated)","description":"Android Content Test Application (CTA) overview (Deprecated)","sidebarTitle":"Android content test application (cta)","icon":"circle-info","href":"/build/core-features/common/game-streaming/game-streaming-android-content-test-application"},{"title":"Web Content Test Application (CTA) overview","description":"Web Content Test Application (CTA) overview","sidebarTitle":"Web content test application (cta)","icon":"video","href":"/build/core-features/common/game-streaming/game-streaming-web-content-test-application"},{"title":"Windows Content Test Application (CTA) overview (Deprecated)","description":"Windows Content Test Application (CTA) overview (Deprecated)","sidebarTitle":"Windows content test application (cta)","icon":"video","href":"/build/core-features/common/game-streaming/game-streaming-windows-pc-content-test-application"},{"title":"Content Test Application (CTA) Stream Configuration Overview","description":"Content Test Application (CTA) Stream Configuration Overview","sidebarTitle":"Content test application (cta) stream","icon":"sliders","href":"/build/core-features/common/game-streaming/game-streaming-content-test-application-stream-config"}]},{"group":"Game streaming basics","pages":[{"title":"Cloud Aware API calls","description":"Cloud Aware API calls","sidebarTitle":"Cloud aware API calls","icon":"video","href":"/build/core-features/common/game-streaming/game-streaming-am-i-streaming"},{"title":"Optimizing your game for XBOX Game Streaming","description":"Optimizing your game for XBOX Game Streaming","sidebarTitle":"Optimizing your game for XBOX game","icon":"gauge-high","href":"/build/core-features/common/game-streaming/game-streaming-optimizing-your-game"},{"title":"XBOX Game Streaming VS. XBOX Remote Play","description":"XBOX Game Streaming VS. XBOX Remote Play","sidebarTitle":"XBOX game streaming VS. XBOX remote play","icon":"bug","href":"/build/core-features/common/game-streaming/game-streaming-project-xcloud-vs-console-streaming"},{"title":"Reference XBOX Game Streaming servers in XSTS claims","description":"Configure the Device capabilities (dca) claim in Partner Center and interpret it server-side to detect XBOX Game Streaming servers from an XSTS token.","sidebarTitle":"Referencing XBOX game streaming servers","icon":"right-to-bracket","href":"/build/core-features/common/game-streaming/game-streaming-referencing-xcloud-servers-in-xsts-claims"}]},{"group":"Creating touch experiences","pages":[{"title":"Getting started with touch","description":"Getting started with touch","sidebarTitle":"Getting started with touch","icon":"gamepad","href":"/build/core-features/common/game-streaming/game-streaming-getting-started-with-touch"},{"title":"Build a native touch interface with IGameInput","description":"Building a native touch interface for your game with IGameInput","sidebarTitle":"Building a native touch interface for","icon":"gamepad","href":"/build/core-features/common/game-streaming/game-streaming-native-touch-igameinput"},{"group":"Touch adaptation kit","pages":[{"title":"Game streaming touch touch adaptation bundle","href":"/build/core-features/common/game-streaming/game-streaming-touch-touch-adaptation-bundle"},{"group":"Touch adaptation kit editor","pages":[{"title":"Touch Adaptation Kit (TAK) Editor for Visual Studio Code","description":"Use the TAK Editor extension for Visual Studio Code to create, preview, customize, and package touch adaptation bundles for XBOX Cloud Gaming titles.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/game-streaming/tak-editor/index"},{"title":"What is the Touch Adaptation Kit Editor?","description":"What is the Touch Adaptation Kit Editor?","sidebarTitle":"What is the touch adaptation kit editor?","icon":"gamepad","href":"/build/core-features/common/game-streaming/tak-editor/game-streaming-tak-editor"},{"title":"TAK Editor Setup","description":"TAK Editor Setup","sidebarTitle":"Tak editor setup","icon":"download","href":"/build/core-features/common/game-streaming/tak-editor/game-streaming-tak-editor-setup"},{"title":"Creating bundles and layouts in the TAK Editor","description":"Creating bundles and layouts in the TAK Editor","sidebarTitle":"Creating bundles and layouts in the tak","icon":"video","href":"/build/core-features/common/game-streaming/tak-editor/game-streaming-tak-editor-create-bundle"},{"title":"Preview Touch Adaptation Layouts","description":"Preview Touch Adaptation Layouts","sidebarTitle":"Preview touch adaptation layouts","icon":"paper-plane","href":"/build/core-features/common/game-streaming/tak-editor/game-streaming-tak-editor-preview-layouts"},{"title":"Customizing the Touch Controls Preview","description":"Customizing the Touch Controls Preview","sidebarTitle":"Customizing the touch controls preview","icon":"gamepad","href":"/build/core-features/common/game-streaming/tak-editor/game-streaming-tak-editor-customize-preview"},{"title":"Packing Touch Adaptation Bundles with the TAK Editor","description":"Packing Touch Adaptation Bundles with the TAK Editor","sidebarTitle":"Packing touch adaptation bundles with","icon":"gamepad","href":"/build/core-features/common/game-streaming/tak-editor/game-streaming-tak-editor-pack-bundles"},{"title":"Troubleshooting and Feedback","description":"Troubleshooting and Feedback","sidebarTitle":"Troubleshooting and feedback","icon":"triangle-exclamation","href":"/build/core-features/common/game-streaming/tak-editor/game-streaming-tak-editor-troubleshooting"}]},{"group":"Command line tool (tak.exe)","pages":[{"title":"Touch Adaptation Kit (TAK) command line tool reference","description":"Reference for the TAK CLI commands (convert, create, license, notice, pack, serve, settings, and takx-version) that build and package touch adaptation bundles.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/build/core-features/common/game-streaming/tak-command-line-tool/index"},{"title":"Touch Adaptation Kit Command Line Tool (tak.exe)","description":"Touch Adaptation Kit Command Line Tool (tak.exe)","sidebarTitle":"Touch adaptation kit command line tool","icon":"gamepad","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line"},{"group":"Create command","pages":[{"title":"Create Command","description":"Create Command","sidebarTitle":"Create command","icon":"terminal","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-create-command"},{"title":"Templates","description":"Templates","sidebarTitle":"Templates","icon":"video","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-templates"}]},{"title":"Convert Command","description":"Convert Command","sidebarTitle":"Convert command","icon":"video","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-convert-command"},{"title":"License Command","description":"License Command","sidebarTitle":"License command","icon":"video","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-license-command"},{"title":"Notice Command","description":"Notice Command","sidebarTitle":"Notice command","icon":"video","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-notice-command"},{"title":"Pack Command","description":"Pack Command","sidebarTitle":"Pack command","icon":"video","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-pack-command"},{"title":"Serve Command","description":"Serve Command","sidebarTitle":"Serve command","icon":"video","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-serve-command"},{"title":"Settings Command","description":"Settings Command","sidebarTitle":"Settings command","icon":"sliders","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-settings-command"},{"title":"Takx Version Command","description":"Takx Version Command","sidebarTitle":"Takx version command","icon":"clock-rotate-left","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-takx-version-command"},{"title":"Unpack Command","description":"Unpack Command","sidebarTitle":"Unpack command","icon":"video","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-unpack-command"},{"title":"Verify command","description":"Verify command","sidebarTitle":"Verify command","icon":"video","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-verify-command"},{"title":"Version Command","description":"Version Command","sidebarTitle":"Version command","icon":"video","href":"/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-version-command"}]},{"title":"Localizing Touch Adaptation Kit Content","description":"Localizing Touch Adaptation Kit Content","sidebarTitle":"Localizing touch adaptation kit content","icon":"language","href":"/build/core-features/common/game-streaming/game-streaming-tak-localization"},{"title":"Touch Adaptation Kit (TAK) Reference","description":"Touch Adaptation Kit (TAK) reference for building touch layouts, bundles, and using tak.exe to enable touch controls in streamed XBOX games.","sidebarTitle":"Touch adaptation kit (tak)","icon":"gamepad","href":"/build/core-features/common/game-streaming/game-streaming-touch-touch-adaptation-kit-overview"},{"group":"Building layouts","pages":[{"title":"Building touch control layouts for XBOX game streaming","description":"Design, package, and validate custom touch control layouts for XBOX Cloud Gaming titles, covering the TAK toolchain, custom assets, and high contrast mode.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/game-streaming/building-touch-layouts/index"},{"title":"Building Touch Control Layouts","description":"Building Touch Control Layouts","sidebarTitle":"Building touch control layouts","icon":"gamepad","href":"/build/core-features/common/game-streaming/building-touch-layouts/game-streaming-touch-building-touch-layout"},{"title":"A designer's guide to building touch controls","description":"A designer's guide to building touch controls","sidebarTitle":"A designer's guide to building touch","icon":"book-open","href":"/build/core-features/common/game-streaming/building-touch-layouts/game-streaming-tak-designers-guide"},{"title":"Create custom touch controls layout with GitHub Copilot","description":"Create custom touch controls layout with GitHub Copilot","sidebarTitle":"Create custom touch controls layout","icon":"gamepad","href":"/build/core-features/common/game-streaming/building-touch-layouts/game-streaming-build-touch-layout-github-copilot"},{"title":"Game streaming tak custom assets","href":"/build/core-features/common/game-streaming/building-touch-layouts/game-streaming-tak-custom-assets"},{"title":"High Contrast Mode","description":"High Contrast Mode","sidebarTitle":"High contrast mode","icon":"gamepad","href":"/build/core-features/common/game-streaming/building-touch-layouts/game-streaming-tak-high-contrast-mode"},{"title":"Changing Touch Control Layouts Based On Game State","description":"Changing Touch Control Layouts Based On Game State","sidebarTitle":"Changing touch control layouts based on","icon":"chart-line","href":"/build/core-features/common/game-streaming/building-touch-layouts/game-streaming-touch-changing-layouts-game-state"},{"title":"Deploying your touch control layouts","description":"Deploying your touch control layouts","sidebarTitle":"Deploying your touch control layouts","icon":"box","href":"/build/core-features/common/game-streaming/building-touch-layouts/game-streaming-touch-deploying-touch-layout"},{"title":"Publishing Touch Layouts","description":"Publishing Touch Layouts","sidebarTitle":"Publishing touch layouts","icon":"rocket","href":"/build/core-features/common/game-streaming/building-touch-layouts/game-streaming-touch-publishing-layouts"}]},{"group":"Sample layouts","pages":[{"title":"Samples","description":"Explore samples documentation and reference for the XBOX Game Development Kit.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/core-features/common/game-streaming/building-touch-layouts/samples/index"},{"title":"Getting Started With Touch Bundle Layouts","description":"Getting Started With Touch Bundle Layouts","sidebarTitle":"Getting started with touch bundle","icon":"gamepad","href":"/build/core-features/common/game-streaming/building-touch-layouts/samples/game-streaming-touch-getting-started-with-sample-layouts"},{"title":"Driving Touch Control Layout","description":"Driving Touch Control Layout","sidebarTitle":"Driving touch control layout","icon":"video","href":"/build/core-features/common/game-streaming/building-touch-layouts/samples/game-streaming-touch-tak-sample-driving"},{"title":"Fighting Touch Control Layout","description":"Fighting Touch Control Layout","sidebarTitle":"Fighting touch control layout","icon":"code","href":"/build/core-features/common/game-streaming/building-touch-layouts/samples/game-streaming-touch-tak-sample-fighter"},{"title":"First Person Shooter Touch Control Layout","description":"First Person Shooter Touch Control Layout","sidebarTitle":"First person shooter touch control","icon":"gamepad","href":"/build/core-features/common/game-streaming/building-touch-layouts/samples/game-streaming-touch-tak-sample-first-person"},{"title":"Standard XBOX Controller Touch Control Layout","description":"Standard XBOX Controller Touch Control Layout","sidebarTitle":"Standard XBOX controller touch control","icon":"gamepad","href":"/build/core-features/common/game-streaming/building-touch-layouts/samples/game-streaming-touch-tak-sample-full-layout"},{"title":"2D Platformer Touch Control Layout","description":"2D Platformer Touch Control Layout","sidebarTitle":"2d platformer touch control layout","icon":"gamepad","href":"/build/core-features/common/game-streaming/building-touch-layouts/samples/game-streaming-touch-tak-sample-platformer"}]}]}]},{"group":"Graphics","pages":[{"title":"DirectCapture Overview","description":"DirectCapture cuts XBOX Game Streaming server latency by up to 72ms by capturing compatible frames in software instead of via display hardware.","sidebarTitle":"Directcapture","icon":"video","href":"/build/core-features/common/game-streaming/game-streaming-directcapture-overview"},{"title":"Custom Resolution Overview","description":"Use XGameStreamingSetResolution to match XBOX Game Streaming output to phone, tablet, and other client aspect ratios instead of 16:9.","sidebarTitle":"Custom resolution","icon":"display","href":"/build/core-features/common/game-streaming/game-streaming-custom-resolution-overview"},{"title":"Best Practices for Game Streaming Custom Resolution","description":"Best Practices for Game Streaming Custom Resolution","sidebarTitle":"Best practices for game streaming","icon":"display","href":"/build/core-features/common/game-streaming/game-streaming-custom-resolution-best-practices"},{"title":"Testing With Custom Resolution","description":"Testing With Custom Resolution","sidebarTitle":"Testing with custom resolution","icon":"display","href":"/build/core-features/common/game-streaming/game-streaming-testing-custom-resolution"}]},{"group":"Latency compensation","pages":[{"title":"Game streaming latency compensation overview","description":"Apply latency-compensation techniques with the XGameStreaming APIs to keep single-player and multiplayer titles fair over higher network latency.","sidebarTitle":"Game streaming latency compensation","icon":"network-wired","href":"/build/core-features/common/game-streaming/game-streaming-latency-compensation-overview"},{"title":"Game streaming latency compensation deep dive","description":"Game streaming latency compensation deep dive","sidebarTitle":"Game streaming latency compensation","icon":"network-wired","href":"/build/core-features/common/game-streaming/game-streaming-latency-compensation-deep-dive"},{"title":"Game streaming latency measurement","description":"Game streaming latency measurement","sidebarTitle":"Game streaming latency measurement","icon":"network-wired","href":"/build/core-features/common/game-streaming/game-streaming-latency-measurement"},{"title":"Simulating latency while testing your game","description":"Simulating latency while testing your game","sidebarTitle":"Simulating latency while testing your","icon":"network-wired","href":"/build/core-features/common/game-streaming/game-streaming-simulate-latency-while-testing"}]}]},{"group":"Additional pages","pages":[{"group":"Common","pages":[{"title":"Common GDK features","description":"GDK features shared across XBOX console and PC platforms, including the async programming model, user model, input, packaging, and streaming.","sidebarTitle":"Common GDK features","icon":"cube","href":"/build/core-features/common/common-features-overview"},{"group":"Game config","pages":[{"title":"MicrosoftGame.config","description":"MicrosoftGame.config","sidebarTitle":"Microsoftgame.config","icon":"map","href":"/build/core-features/common/game-config/MicrosoftGameConfig-toc"}]},{"group":"Game save","pages":[{"title":"Game save","description":"Explore XBOX GDK Game Saves documentation including overviews, developer guides, debugging, tools, walkthroughs, sync flow, and API references.","sidebarTitle":"Overview","icon":"hard-drive","href":"/build/core-features/common/game-save/index"},{"title":"Game Saves debugging","description":"Fix common XBOX GDK Game Saves errors including SCID misconfiguration, Partner Center Connected Storage setup, handle cleanup, and NTSTATUS codes.","sidebarTitle":"Game saves debugging","icon":"cloud-arrow-up","href":"/build/core-features/common/game-save/game-saves-debugging"},{"title":"Game Saves developer guide","description":"Integrate XBOX GDK Game Saves into a title with guidance on terminology, XGameSave and XGameSaveFiles APIs, user models, PLM, security, and certification.","sidebarTitle":"Game saves developer","icon":"book-open","href":"/build/core-features/common/game-save/game-saves-developer-guide"},{"title":"Game Saves system dialogs","description":"Reference for XBOX Game Saves system dialogs, including lock contention, cloud sync conflicts, offline failures, corrupted saves, and network errors.","sidebarTitle":"Game saves system dialogs","icon":"cloud-arrow-up","href":"/build/core-features/common/game-save/game-saves-dialogues"},{"title":"Game Saves overview","description":"Learn how XBOX Game Saves keep player progress in sync across XBOX consoles, PCs, and handhelds, and follow the development lifecycle from setup to launch.","sidebarTitle":"Game saves","icon":"circle-info","href":"/build/core-features/common/game-save/game-saves-overview"},{"title":"Game Saves storage systems","description":"Compare XBOX Game Saves storage systems including title cloud storage, local save storage, machine provider storage, and per-title quotas and limits.","sidebarTitle":"Game saves storage systems","icon":"hard-drive","href":"/build/core-features/common/game-save/game-saves-storage-systems"},{"title":"Understanding the Game Saves sync flow","description":"Walk through the six-step XBOX Game Saves sync flow: title start, connection check, data ownership, cloud sync, gameplay loop, and session end.","sidebarTitle":"Understanding the game saves sync flow","icon":"cloud-arrow-up","href":"/build/core-features/common/game-save/game-saves-syncing"},{"title":"Game Saves (contents)","description":"Index of XBOX GDK Game Saves articles covering the developer guide, debugging, tools, walkthroughs, sync flow, system dialogs, and storage systems.","sidebarTitle":"Game saves (contents)","icon":"cloud-arrow-up","href":"/build/core-features/common/game-save/game-saves-toc"},{"title":"Game Saves tools","description":"Inspect XBOX Game Saves traffic with Fiddler and use the xbstorage and gamesaveutil command-line tools to export and import local save data.","sidebarTitle":"Game saves tools","icon":"cloud-arrow-up","href":"/build/core-features/common/game-save/game-saves-tools"},{"title":"Game Saves walkthroughs and samples","description":"Step-by-step XBOX Game Saves walkthroughs for Partner Center setup, safe-write patterns, offline handling, testing sync scenarios, and title migration.","sidebarTitle":"Game saves walkthroughs and samples","icon":"code","href":"/build/core-features/common/game-save/game-saves-walkthroughs-and-samples"},{"title":"XGameSave API overview","description":"Reference for the XBOX XGameSave API covering the container-and-blob model, provider initialization, update handles, atomic updates, and sync-flow diagrams.","sidebarTitle":"Xgamesave API","icon":"circle-info","href":"/build/core-features/common/game-save/xgamesave"},{"title":"XGameSaveFiles API overview","description":"Reference for XBOX XGameSaveFiles covering XGameSaveFilesGetFolderWithUIAsync, Win32 cloud-sync behavior, quotas, debugging, and performance best practices.","sidebarTitle":"Xgamesavefiles API","icon":"circle-info","href":"/build/core-features/common/game-save/xgamesavefiles"}]},{"group":"Packaging","pages":[{"title":"Packaging","description":"Packaging","sidebarTitle":"Packaging","icon":"box","href":"/build/core-features/common/packaging/gc-packaging-toc"}]},{"group":"User","pages":[{"title":"Users","description":"Users","sidebarTitle":"Users","icon":"user","href":"/build/core-features/common/user/user-toc"}]}]}]}]},{"group":"Console Features","tag":"","pages":[{"title":"Console features for the XBOX Game Development Kit","description":"Audio, memory, cross-gen, networking, Game DVR, and console-specific console features for XBOX Series X|S and XBOX One titles built with the GDK.","sidebarTitle":"Overview","icon":"tv","href":"/build/console-features/index"},{"group":"Memory","pages":[{"title":"Memory system for XBOX GDK titles","description":"System memory, kernel memory usage, virtual memory allocation, cross-core costs, writeable file mappings, and diagnostics for XBOX GDK titles.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/console-features/memory/index"},{"group":"Memory","pages":[{"title":"System memory overview","href":"/build/console-features/memory/system-memory-overview"},{"title":"System memory details","href":"/build/console-features/memory/system-memory-details"},{"title":"Cross Core Memory Costs","description":"Cross Core Memory Costs","sidebarTitle":"Cross core memory costs","icon":"memory","href":"/build/console-features/memory/Cross-Core-Memory-Costs"},{"title":"System memory diagnostics","href":"/build/console-features/memory/system-memory-diagnostics"},{"title":"System memory porting","href":"/build/console-features/memory/system-memory-porting"},{"title":"Working with the Microsoft GDK Game OS memory manager","description":"Working with the Microsoft GDK Game OS memory manager","sidebarTitle":"Working with the microsoft GDK game os","icon":"cube","href":"/build/console-features/memory/system-memory-working"},{"title":"System memory tooling","href":"/build/console-features/memory/system-memory-tooling"},{"title":"Kernel memory usage","href":"/build/console-features/memory/kernel_memory_usage"},{"title":"Virtual memory allocator","href":"/build/console-features/memory/virtual-memory-allocator"},{"title":"Writeable file mappings","href":"/build/console-features/memory/writeable-file-mappings"}]}]},{"group":"Audio","pages":[{"group":"Audio","pages":[{"title":"XBOX GDK audio overviews and tools","description":"Documentation for GDK audio on XBOX Series X|S and XBOX One, including XAudio2, XMA, SHAPE, XDSP, spatial audio, and audio tooling.","sidebarTitle":"Overview","icon":"volume-high","href":"/build/console-features/audio/index"},{"title":"Audio","description":"Audio","sidebarTitle":"Audio","icon":"volume-high","href":"/build/console-features/audio/gc-audio-toc"},{"group":"Audio overview","pages":[{"title":"Overview of audio","description":"Overview of audio","sidebarTitle":"Overview of audio","icon":"volume-high","href":"/build/console-features/audio/overviews/audio"},{"title":"Overview of XBOX Series X|S audio hardware","description":"Overview of XBOX Series X|S audio hardware","sidebarTitle":"Overview of XBOX series x|s audio","icon":"server","href":"/build/console-features/audio/overviews/scarlett-audio"},{"title":"The audio architecture in XBOX One","description":"The audio architecture in XBOX One","sidebarTitle":"The audio architecture in XBOX one","icon":"lightbulb","href":"/build/console-features/audio/overviews/xbox-one-audio-architecture"},{"title":"XDK vs GDK audio API comparison","description":"Comparison of XBOX One Software Development Kit and Microsoft Game Development Kit Audio API","sidebarTitle":"Comparison of XBOX one software","icon":"cube","href":"/build/console-features/audio/overviews/comparison-of-xdk-and-gdk-audio-api"}]},{"group":"Xapu","pages":[{"title":"XAPU overview","description":"XBOX Audio Processing Unit (XAPU) API for hardware-accelerated Opus decoding and high-quality sample rate conversion on XBOX Series X|S.","sidebarTitle":"Xapu","icon":"volume-high","href":"/build/console-features/audio/overviews/xapu-overview"},{"title":"Single-stream Opus audio decoding with the XAPU API","description":"Overview of single stream Opus audio decoding by using the XAPU API","sidebarTitle":"Overview of single stream opus audio","icon":"volume-high","href":"/build/console-features/audio/overviews/xapu-overview-single-stream-audio-decode"}]},{"group":"Xdsp","pages":[{"title":"Overviews","description":"Reference and overviews for audio, mixing, and sound-processing in the XBOX Game Development Kit (console features). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/console-features/audio/overviews/index"},{"title":"XDSP overview","description":"Use the XDSP API for hardware-accelerated convolution reverb, FFT and IFFT, and impulse-response enveloping on XBOX Series X|S consoles.","sidebarTitle":"Xdsp","icon":"volume-high","href":"/build/console-features/audio/overviews/xdsp-overview"},{"title":"Overview of a single stream Convolution using the XDSP API","description":"Overview of a single stream Convolution using the XDSP API","sidebarTitle":"Overview of a single stream convolution","icon":"volume-high","href":"/build/console-features/audio/overviews/xdsp-overview-single-stream-convolution"},{"title":"Overview of a single stream FFT/IFFT using the XDSP API","description":"Overview of a single stream FFT/IFFT using the XDSP API","sidebarTitle":"Overview of a single stream fft/ifft","icon":"volume-high","href":"/build/console-features/audio/overviews/xdsp-overview-single-stream-fft-ifft"},{"title":"XDSP Impulse Response Reduction Overview","description":"XDSP Impulse Response Reduction Overview","sidebarTitle":"Xdsp impulse response reduction","icon":"volume-high","href":"/build/console-features/audio/overviews/xdsp-overview-ir-reduction"},{"title":"XDSP Enveloping Overview","description":"XDSP Enveloping Overview","sidebarTitle":"Xdsp enveloping","icon":"volume-high","href":"/build/console-features/audio/overviews/xdsp-overview-enveloping"},{"title":"Single-stream convolution with envelope using the XDSP API","description":"Overview of a single stream Convolution with Envelope using the XDSP API","sidebarTitle":"Overview of a single stream convolution","icon":"volume-high","href":"/build/console-features/audio/overviews/xdsp-overview-single-stream-convolution-with-envelope"}]},{"title":"Overview of spatial sound","description":"Add Dolby Atmos, DTS:X, and Windows Sonic spatial audio to XBOX games, including hardware object counts for XBOX Series X|S and XBOX One.","sidebarTitle":"Overview of spatial sound","icon":"volume-high","href":"/build/console-features/audio/overviews/spatial-audio-overview"},{"group":"Xaudio2","pages":[{"title":"Xaudio2 overview","href":"/build/console-features/audio/overviews/xaudio2-overview"},{"title":"Use XAudio2 to play a sound","description":"Use XAudio2 to play a sound","sidebarTitle":"Use xaudio2 to play a sound","icon":"volume-high","href":"/build/console-features/audio/overviews/xaudio2-play-sound"},{"title":"Overview of ADPCM","description":"How XAudio2 uses ADPCM lossy audio compression with configurable sample block size for XBOX game audio, and how to encode ADPCM content.","sidebarTitle":"Overview of adpcm","icon":"circle-info","href":"/build/console-features/audio/overviews/adpcm-overview"},{"title":"ADPCM command-line encoder","description":"ADPCM command-line encoder","sidebarTitle":"Adpcm command-line encoder","icon":"volume-high","href":"/build/console-features/audio/tools/adpcmencoder-tools"}]},{"group":"Shape","pages":[{"title":"Overview of SHAPE","description":"How the XBOX One SHAPE audio hardware uses fixed-function blocks, mix buffers, and DMA to accelerate flowgraphs for XMA, SRC, and filtering.","sidebarTitle":"Overview of shape","icon":"volume-high","href":"/build/console-features/audio/overviews/shape-overview"},{"title":"SHAPE audio flowgraph construction best practices","description":"Getting into SHAPE: Best practices for constructing audio flowgraphs","sidebarTitle":"Getting into shape: best practices for","icon":"brackets-curly","href":"/build/console-features/audio/overviews/best-practices-audio-flowgraph-construction"},{"title":"ACP overview","description":"Programming guide for the Audio Control Processor (ACP) and the acphal library that manages SHAPE audio flowgraphs on XBOX One consoles.","sidebarTitle":"Acp","icon":"volume-high","href":"/build/console-features/audio/overviews/acp-overview"}]},{"group":"Xma2","pages":[{"title":"Overview of XMA2","description":"How XMA2 hardware audio decompression works on XBOX One, and how it compares to xWMA software decoding for XAudio2 game audio content.","sidebarTitle":"Overview of xma2","icon":"volume-high","href":"/build/console-features/audio/overviews/xma2-overview"},{"group":"Xma2 encoder tool","pages":[{"title":"Tools","description":"Reference and tools for audio, mixing, and sound-processing in the XBOX Game Development Kit (console features). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/build/console-features/audio/tools/index"},{"title":"XMA2 encoder tool","description":"XMA2 encoder tool","sidebarTitle":"Xma2 encoder tool","icon":"video","href":"/build/console-features/audio/tools/xma2encodertool"},{"group":"Xma2 encoder reference","pages":[{"title":"XMA2 encoder library and command line tool","description":"Reference for the XMA2 encoder library and command line tool that produces XMA-compressed audio assets for XBOX titles built with the GDK.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/console-features/audio/tools/xma2encoder/index"},{"title":"XMA2 Encoder reference information","description":"XMA2 Encoder reference information","sidebarTitle":"Xma2 encoder reference information","icon":"volume-high","href":"/build/console-features/audio/tools/xma2encoder/atoc-xmaencoder"},{"group":"Xma2 encoder functions","pages":[{"title":"XMA2encoder functions","description":"XMA2encoder functions","sidebarTitle":"Xma2encoder functions","icon":"video","href":"/build/console-features/audio/tools/xma2encoder/tech-xmaencoder-funcs"},{"title":"XAudio2XMAEncoder","description":"XAudio2XMAEncoder","sidebarTitle":"Xaudio2xmaencoder","icon":"volume-high","href":"/build/console-features/audio/tools/xma2encoder/methods/xaudio2xmaencoder-xmaencoder-xbox-microsoft-m"}]}]}]}]},{"group":"Xwma","pages":[{"title":"Overview of xWMA","description":"xWMA audio format for XBOX games: a WMA Professional subset decoded in software by XAudio2 for compressed dialog and music streams.","sidebarTitle":"Overview of xwma","icon":"volume-high","href":"/build/console-features/audio/overviews/xwma-overview"},{"group":"Xwma command-line encoder","pages":[{"title":"Xwmaencode tools","href":"/build/console-features/audio/tools/xwmaencode-tools"},{"group":"Xwma encoder reference","pages":[{"title":"xWMA encoder library and command line tool","description":"Reference for the xWMA encoder library and command line tool that produces xWMA-compressed audio assets for XBOX titles built with the GDK.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/console-features/audio/tools/xwmaencoder/index"},{"title":"xWMA Encoder reference information","description":"xWMA Encoder reference information","sidebarTitle":"Xwma encoder reference information","icon":"volume-high","href":"/build/console-features/audio/tools/xwmaencoder/atoc-xwmaencoder"},{"group":"Xwma encoder functions","pages":[{"title":"Xwmaencoder functions","description":"Xwmaencoder functions","sidebarTitle":"Xwmaencoder functions","icon":"video","href":"/build/console-features/audio/tools/xwmaencoder/tech-xwmaencoder-nativereference-funcs"},{"title":"XWMAEncoder","description":"XWMAEncoder","sidebarTitle":"Xwmaencoder","icon":"volume-high","href":"/build/console-features/audio/tools/xwmaencoder/methods/xwmaencoder-xwmaencoder-xbox-microsoft-m"}]}]}]}]},{"title":"WASAPI","description":"Use the Windows Audio Session API (WASAPI) in XBOX GDK games to manage audio streams to endpoint devices and handle device invalidations.","sidebarTitle":"Wasapi","icon":"volume-high","href":"/build/console-features/audio/overviews/wasapi-overview"}]},{"title":"Text-to-speech","description":"Text-to-speech","sidebarTitle":"Text-to-speech","icon":"comments","href":"/build/console-features/text-to-speech/text-to-speech"}]},{"group":"Player data, social features, networking, and multiplayer","pages":[{"title":"Networking on XBOX consoles with the GDK","description":"Networking topics for XBOX GDK titles, covering game mesh, MsQuic, XDK migration, web requests, and console networking tools for XBOX Series X|S.","sidebarTitle":"Overview","icon":"network-wired","href":"/build/console-features/networking/index"},{"group":"Networking","pages":[{"title":"Networking","description":"Networking","sidebarTitle":"Networking","icon":"network-wired","href":"/build/console-features/networking/gc-networking-toc"},{"title":"Introduction to Microsoft Game Development Kit networking","description":"Overview of GDK networking APIs for HTTP, WebSocket, sockets, chat, and game data, plus network initialization and suspend and resume requirements.","sidebarTitle":"Introduction to microsoft game","icon":"circle-info","href":"/build/console-features/networking/introduction-networking"},{"title":"Detecting network initialization status","description":"Detecting network initialization status","sidebarTitle":"Detecting network initialization status","icon":"chart-line","href":"/build/console-features/networking/initialization-connectivity-networking"},{"title":"Quality of service (QoS) packet tagging on XBOX consoles","description":"Quality of service (QoS) packet tagging on XBOX consoles","sidebarTitle":"Quality of service (QoS) packet tagging","icon":"network-wired","href":"/build/console-features/networking/qos-packet-tagging"},{"title":"XBOX reserved ports","description":"XBOX reserved ports","sidebarTitle":"XBOX reserved ports","icon":"network-wired","href":"/build/console-features/networking/reserved-ports-networking"},{"group":"XDK migration guide","pages":[{"title":"Migrating XDK networking to the XBOX GDK","description":"Guidance for porting XDK networking code, including Secure Sockets and XBOX Integrated Multiplayer, to XBOX GDK game mesh APIs on Series X|S.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/console-features/networking/xdk-migration/index"},{"title":"XBOX One Software Development Kit migration guides","description":"XBOX One Software Development Kit migration guides","sidebarTitle":"XBOX one software development kit","icon":"book-open","href":"/build/console-features/networking/xdk-migration/xdk-migration-toc"},{"title":"XBOX One Software Development Kit migration overview","description":"XBOX One Software Development Kit migration overview","sidebarTitle":"XBOX one software development kit","icon":"circle-info","href":"/build/console-features/networking/xdk-migration/xdk-migration-overview-networking"},{"title":"Web request differences between GDK and XDK","description":"Differences between web requests in the Microsoft Game Development Kit and the XBOX One Software Development Kit","sidebarTitle":"Differences between web requests in the","icon":"network-wired","href":"/build/console-features/networking/xdk-migration/xdk-migration-web-requests-networking"},{"title":"Game mesh communication: GDK vs XDK differences","description":"Differences between game mesh communication in the Microsoft Game Development Kit and XBOX One Software Development Kit","sidebarTitle":"Differences between game mesh","icon":"network-wired","href":"/build/console-features/networking/xdk-migration/xdk-migration-game-mesh-networking"}]},{"group":"Web requests","pages":[{"title":"Web requests and HTTP stacks on XBOX","description":"Debugging custom HTTP stacks, using xCurl, and troubleshooting web request traffic through proxies for XBOX GDK titles on console.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/console-features/networking/web-requests/index"},{"title":"Web requests","description":"Web requests","sidebarTitle":"Web requests","icon":"network-wired","href":"/build/console-features/networking/web-requests/web-requests-toc"},{"title":"HTTP and WebSocket web requests in the GDK","description":"Choose between xCurl, libHttpClient, and WinHTTP for HTTP and WebSocket calls in GDK titles, and handle suspend and resume correctly on console.","sidebarTitle":"Web requests","icon":"plug","href":"/build/console-features/networking/web-requests/http-networking"},{"title":"xCurl overview","description":"xCurl overview","sidebarTitle":"Xcurl","icon":"network-wired","href":"/build/console-features/networking/web-requests/intro-xcurl"},{"title":"WinHTTP overview","description":"WinHTTP overview","sidebarTitle":"Winhttp","icon":"circle-info","href":"/build/console-features/networking/web-requests/intro-winhttp"},{"title":"Debugging custom HTTP stacks","description":"Debugging custom HTTP stacks","sidebarTitle":"Debugging custom HTTP stacks","icon":"network-wired","href":"/build/console-features/networking/web-requests/debugging-custom-http-stacks"}]},{"group":"Game mesh","pages":[{"title":"Game mesh networking for XBOX titles","description":"Peer-to-peer game mesh APIs for XBOX GDK titles, including MsQuic, Party unity and unreal integration, and gameplay mesh communication guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/console-features/networking/game-mesh/index"},{"title":"Game Mesh","description":"Game Mesh","sidebarTitle":"Game mesh","icon":"network-wired","href":"/build/console-features/networking/game-mesh/game-mesh-toc"},{"title":"Azure PlayFab Party","description":"Azure PlayFab Party","sidebarTitle":"Azure PlayFab Party","icon":"people-group","href":"/build/console-features/networking/game-mesh/playfab-party-intro-networking"},{"title":"Azure PlayFab Party Online Subsystem for Unreal","description":"Azure PlayFab Party Online Subsystem for Unreal","sidebarTitle":"Azure PlayFab party online subsystem","icon":"people-group","href":"/build/console-features/networking/game-mesh/party-unreal-online-subsystem"},{"title":"Azure PlayFab Party SDK for Unity","description":"Azure PlayFab Party SDK for Unity","sidebarTitle":"Azure PlayFab party SDK for unity","icon":"people-group","href":"/build/console-features/networking/game-mesh/party-unity-plugin"},{"title":"MsQuic","description":"MsQuic","sidebarTitle":"Msquic","icon":"palette","href":"/build/console-features/networking/game-mesh/msquic-intro-networking"},{"title":"Preferred local UDP multiplayer port networking APIs","description":"Preferred local User Datagram Protocol (UDP) multiplayer port networking APIs","sidebarTitle":"Preferred local user datagram protocol","icon":"user","href":"/build/console-features/networking/game-mesh/preferred-local-udp-multiplayer-port-networking"},{"group":"Windows sockets","pages":[{"title":"Introduction to Windows Sockets in the GDK","description":"Introduction to Windows sockets in the Microsoft Game Development Kit","sidebarTitle":"Introduction to windows sockets in the","icon":"circle-info","href":"/build/console-features/networking/game-mesh/winsock-intro-networking"},{"title":"PC port behavior","description":"PC port behavior","sidebarTitle":"Pc port behavior","icon":"network-wired","href":"/build/console-features/networking/game-mesh/pc-port-behavior"},{"title":"XBOX console port behavior","description":"XBOX console port behavior","sidebarTitle":"XBOX console port behavior","icon":"network-wired","href":"/build/console-features/networking/game-mesh/xbox-console-port-behavior"}]},{"title":"Quality of Service measurements in the GDK","description":"Quality of Service measurements in the Microsoft Game Development Kit","sidebarTitle":"Quality of service measurements in the","icon":"network-wired","href":"/build/console-features/networking/game-mesh/qos-networking"}]},{"group":"Networking tools for the microsoft game development kit","pages":[{"title":"Tools","description":"Networking tools and utilities for the XBOX Game Development Kit (console features): diagnostics, packet capture, and network verification helpers.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/build/console-features/networking/tools/index"},{"title":"Networking tools in the Microsoft Game Development Kit","description":"Networking tools in the Microsoft Game Development Kit","sidebarTitle":"Networking tools in the microsoft game","icon":"network-wired","href":"/build/console-features/networking/tools/tools-networking-toc"},{"title":"Fiddler setup networking","href":"/build/console-features/networking/tools/fiddler-setup-networking"},{"title":"Fiddler on Windows PC","description":"Fiddler on Windows PC","sidebarTitle":"Fiddler on windows pc","icon":"network-wired","href":"/build/console-features/networking/tools/fiddler-pc"},{"title":"Capturing network traffic on XBOX One Dev Kits","description":"Capturing network traffic on XBOX One Dev Kits","sidebarTitle":"Capturing network traffic on XBOX one","icon":"network-wired","href":"/build/console-features/networking/tools/netcap-networking"},{"title":"Network stress tests on XBOX Dev Kits","description":"Network stress tests on XBOX Dev Kits","sidebarTitle":"Network stress tests on XBOX dev kits","icon":"network-wired","href":"/build/console-features/networking/tools/netstress-networking"}]}]}]},{"group":"Storage and game saves","pages":[{"title":"Storage","description":"Documentation for title and connected storage in the XBOX Game Development Kit (console features). Covers concepts, tools, configuration, and workflows.","sidebarTitle":"Overview","icon":"hard-drive","href":"/build/console-features/storage/index"},{"group":"Storage","pages":[{"title":"Local storage","description":"Local storage","sidebarTitle":"Local storage","icon":"hard-drive","href":"/build/console-features/storage/local-storage"},{"title":"DirectStorage","description":"DirectStorage","sidebarTitle":"Directstorage","icon":"hard-drive","href":"/build/console-features/storage/directstorage-toc"},{"title":"DirectStorage Overview","description":"DirectStorage APIs for XBOX Series X|S deliver high-throughput NVMe storage I/O with low CPU overhead for large numbers of small requests.","sidebarTitle":"Directstorage","icon":"circle-info","href":"/build/console-features/storage/directstorage/directstorage-overview"},{"title":"Directstorage white paper","href":"/build/console-features/storage/directstorage/directstorage-white-paper"},{"title":"Directstorage compression","href":"/build/console-features/storage/directstorage/directstorage-compression"},{"title":"Easy Hardware Decompression","description":"Easy Hardware Decompression","sidebarTitle":"Easy hardware decompression","icon":"download","href":"/build/console-features/storage/directstorage/directstorage-drop-in-decompression"},{"title":"Directstorage shuffles","href":"/build/console-features/storage/directstorage/directstorage-shuffles"}]}]},{"group":"Game dvr","pages":[{"title":"Game DVR and broadcasting on XBOX consoles","description":"Integrate Game DVR, capture, and broadcasting APIs into GDK titles for XBOX Series X|S and XBOX One, including broadcast notifications and metadata.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/console-features/game-dvr/index"},{"title":"Game DVR and broadcasting","description":"Game DVR and broadcasting","sidebarTitle":"Game dvr and broadcasting","icon":"square-pen","href":"/build/console-features/game-dvr/gamedvr-broadcast"}]},{"group":"Cross console gen development","pages":[{"title":"Cross-gen games with the XBOX GDK","description":"Ship cross-gen XBOX titles with the GDK using back-compat only, dual-SKU, or Smart Delivery, and pick the right strategy for XBOX One and Series X|S.","sidebarTitle":"Overview","icon":"folder-open","href":"/build/console-features/cross-gen/index"},{"title":"Cross-generation title development","description":"Cross-generation title development","sidebarTitle":"Cross-generation title development","icon":"arrows-left-right","href":"/build/console-features/cross-gen/gc-cross-gen-toc"},{"title":"Cross-generation gaming","description":"Develop cross-generation XBOX titles that ship on both XBOX One and XBOX Series X|S consoles, including Smart Delivery packaging strategies.","sidebarTitle":"Cross-generation gaming","icon":"circle-info","href":"/build/console-features/cross-gen/cross-gen-overview"},{"title":"Dual SKU cross-generation games","description":"Dual SKU cross-generation games","sidebarTitle":"Dual sku cross-generation games","icon":"tags","href":"/build/console-features/cross-gen/cross-gen-dual-sku"},{"title":"Cross-generation gaming through backward compatibility only","description":"Cross-generation gaming through backward compatibility only","sidebarTitle":"Cross-generation gaming through","icon":"arrows-left-right","href":"/build/console-features/cross-gen/cross-gen-backcompat-only"},{"title":"Smart Delivery","description":"Smart Delivery","sidebarTitle":"Smart delivery","icon":"box","href":"/build/console-features/cross-gen/cross-gen-smart-delivery"}]},{"group":"Additional pages","pages":[{"title":"Console specific GDK features","description":"GDK features specific to XBOX Series X|S and XBOX One consoles, including audio systems, cross-generation development, memory, and storage.","sidebarTitle":"Console specific GDK features","icon":"cube","href":"/build/console-features/console-features-overview"}]},{"group":"Debugging and diagnostics","icon":"bug","pages":[{"title":"Devkit second nic","href":"/build/console-features/debugging-diagnostics/devkit-second-nic"},{"title":"Profiling mode","href":"/build/console-features/debugging-diagnostics/profiling-mode"},{"title":"Retrieving crash dumps","href":"/build/console-features/debugging-diagnostics/retrieving-crash-dumps"},{"title":"Xtf gamepad input testing","href":"/build/console-features/debugging-diagnostics/xtf-gamepad-input-testing"},{"title":"Inspecting errors","href":"/build/console-features/debugging-diagnostics/inspecting-errors"},{"title":"Debugging with overlay folders","href":"/build/console-features/debugging-diagnostics/debugging-with-overlay-folders"},{"title":"Troubleshooting common issues","href":"/build/console-features/debugging-diagnostics/troubleshooting-common-issues"}]},{"group":"Build without install","icon":"hammer","pages":[{"title":"Withoutinstall overview","href":"/build/console-features/build-without-install/withoutinstall-overview"},{"title":"Build environment withoutinstall","href":"/build/console-features/build-without-install/build-environment-withoutinstall"},{"title":"Project configuration withoutinstall","href":"/build/console-features/build-without-install/project-configuration-withoutinstall"}]},{"group":"Console workflows","icon":"diagram-project","pages":[{"title":"Xbox game life cycle","href":"/build/console-features/console-workflows/xbox-game-life-cycle"},{"title":"Using gdk remotely","href":"/build/console-features/console-workflows/using-gdk-remotely"},{"title":"Upgrading xbox one xdk titles on scarlett","href":"/build/console-features/console-workflows/upgrading-xbox-one-xdk-titles-on-scarlett"}]},{"group":"Porting from XBOX One era","icon":"arrow-right-arrow-left","pages":[{"title":"Porting guide for existing era","href":"/build/console-features/porting-from-xbox-one-era/porting-guide-for-existing-era"},{"title":"Era migration library","href":"/build/console-features/porting-from-xbox-one-era/era-migration-library"}]},{"group":"Threading and performance","icon":"gauge-high","pages":[{"title":"Xbox game cache","href":"/build/console-features/threading-performance/xbox-game-cache"}]},{"title":"Console comparison","href":"/build/console-features/console-comparison"}]},{"group":"ATG engagement","icon":"handshake-angle","hidden":true,"tag":"NDA","pages":[{"title":"Atg engagement","href":"/build/atg-engagement/atg-engagement"},{"title":"Atg graphics engagement","href":"/build/atg-engagement/atg-graphics-engagement"},{"title":"Atg systems engagement","href":"/build/atg-engagement/atg-systems-engagement"}]}]},{"tab":"Services","groups":[{"group":"XBOX Services","pages":[{"title":"XBOX services","description":"Explore XBOX services documentation: XBOX Live features, multiplayer, player data, community, storage, and fundamentals for the XBOX Game Development Kit.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services"},{"group":"Fundamentals","pages":[{"title":"Fundamentals","description":"XBOX services fundamentals for GDK developers: identity, sandboxes, Real-Time Activity, XSAPI, game binding, service-to-service auth, and Partner Center config.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/fundamentals/index"},{"title":"XBOX services overview","description":"Introduction to XBOX services micro-services for profile, presence, stats, leaderboards, achievements, multiplayer, and matchmaking, accessed through XSAPI.","sidebarTitle":"XBOX services","icon":"circle-info","href":"/services/xbox-services/fundamentals/live-xbl-overview"},{"group":"Identity","pages":[{"title":"Identity","description":"Landing page for XBOX services identity topics: authentication, privacy, privileges, user profile, gamertags, and how XBOX identifies players by XUID.","sidebarTitle":"Overview","icon":"id-card","href":"/services/xbox-services/fundamentals/identity/index"},{"title":"User identity","description":"Overview of how XBOX services identify players via XUID, and how GDK XUser and PlayFab identity link to sign-in, privileges, privacy, and user profile.","sidebarTitle":"User identity","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/identity/xs-identity-overview"},{"group":"User authentication","pages":[{"title":"Auth","description":"Browse XBOX services authentication topics, including user sign-in, the XBOX Authentication Library (XAL), XUser APIs, and troubleshooting guidance.","sidebarTitle":"Overview","icon":"id-card","href":"/services/xbox-services/fundamentals/identity/auth/index"},{"title":"Account authentication and access overview","description":"Authenticate XBOX players and manage identity with XUserHandle, the XBOX Authentication Library (XAL), and XUser APIs across GDK and cross-platform titles.","sidebarTitle":"Account authentication and access","icon":"database","href":"/services/xbox-services/fundamentals/identity/auth/live-authentication-overview"},{"title":"Troubleshooting XBOX services sign-in","description":"Diagnose common XBOX services sign-in failures, including sandbox mismatches, test account access, and service config publishing issues during development.","sidebarTitle":"Troubleshooting XBOX services sign-in","icon":"lightbulb","href":"/services/xbox-services/fundamentals/identity/auth/live-troubleshooting-sign-in"}]},{"group":"Gamertags","pages":[{"title":"Gamertags","description":"Gamertags topic hub covering classic and modern XBOX gamertags, UTF-8 character ranges, backwards compatibility, and rendering best practices for titles.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/identity/user-profile/gamertags/index"},{"title":"Gamertags overview","description":"Compare classic and modern XBOX gamertags and learn how to retrieve, display, and render UTF-8 gamertag strings in GDK titles across XBOX and Windows.","sidebarTitle":"Gamertags","icon":"user","href":"/services/xbox-services/fundamentals/identity/user-profile/gamertags/live-gamertags-overview"},{"title":"Classic gamertags","description":"Classic XBOX gamertags support ASCII characters a-z, A-Z, 0-9, comma, and space, with a 15-character limit and a 16-byte buffer including the null terminator.","sidebarTitle":"Classic gamertags","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/identity/user-profile/gamertags/live-classic-gamertags-overview"},{"title":"Modern gamertags","description":"Learn how modern XBOX gamertags expand identity with UTF-8 characters and unique suffixes, and see rendering examples titles should follow for players.","sidebarTitle":"Modern gamertags","icon":"circle-info","href":"/services/xbox-services/fundamentals/identity/user-profile/gamertags/live-modern-gamertags-overview"},{"title":"Modern gamertags definition and terminology","description":"Definitions for modern XBOX gamertag components, including suffix rules, 12-character modern gamertag limits, buffer sizes, and supported UTF-8 ranges.","sidebarTitle":"Modern gamertags definition and","icon":"lightbulb","href":"/services/xbox-services/fundamentals/identity/user-profile/gamertags/live-modern-gamertags-definition"},{"title":"Best practices and testing for modern gamertags","description":"Best practices for rendering modern XBOX gamertag suffixes and instructions for testing modern gamertag support with test accounts and retail accounts.","sidebarTitle":"Best practices and testing for modern","icon":"gauge-high","href":"/services/xbox-services/fundamentals/identity/user-profile/gamertags/live-modern-gamertags-best-practices-and-testing"},{"title":"Live modern gamertags unicode","href":"/services/xbox-services/fundamentals/identity/user-profile/gamertags/live-modern-gamertags-unicode"},{"title":"Backwards compatibility and gamertag conversions","description":"Understand how modern XBOX gamertags stay backwards compatible with classic 15-character alphanumeric gamertags and how conversions surface in APIs.","sidebarTitle":"Backwards compatibility and gamertag","icon":"database","href":"/services/xbox-services/fundamentals/identity/user-profile/gamertags/live-modern-backwards-compatibility"}]},{"group":"Privileges and privacy","pages":[{"title":"XBOX services user privileges overview","description":"Retrieve XBOX services user privileges and learn how subscription, device, app, and parental controls determine which features a player can access.","sidebarTitle":"XBOX services user privileges","icon":"user","href":"/services/xbox-services/fundamentals/identity/privileges/live-user-privileges-overview"},{"title":"Configuring Privileges in Partner Center","description":"Use Partner Center to configure XBOX privileges for your title, including broadcasting restrictions per sandbox and free-to-play multiplayer without Gold.","sidebarTitle":"Configuring privileges in partner center","icon":"database","href":"/services/xbox-services/fundamentals/identity/privileges/config/live-privileges-config"},{"title":"Privacy and permissions overview","description":"Use the XBOX Privacy service and XSAPI to run permission checks for chat, video, and cross-network play, and to respect mute and avoid list preferences.","sidebarTitle":"Privacy and permissions","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/identity/privacy/live-privacy-overview"},{"title":"Client-side use of XBOX services user privileges","description":"Check XBOX services user privileges from your client with XUserCheckPrivilege and XUserResolvePrivilegeWithUiAsync to drive upsell UI on XBOX and PC.","sidebarTitle":"Client-side use of XBOX services user","icon":"user","href":"/services/xbox-services/fundamentals/identity/privileges/concepts/live-user-privileges-client"},{"title":"Server-side handling of XBOX services User Privileges","description":"Enforce XBOX services privileges in your server by decoding XSTS tokens from relying parties and reading privilege claims for each user identity.","sidebarTitle":"Server-side handling of XBOX services","icon":"database","href":"/services/xbox-services/fundamentals/identity/privileges/concepts/live-user-privileges-server"}]}]},{"group":"Sandboxes","pages":[{"title":"Sandboxes","description":"Guides to XBOX Live development sandboxes: setup, sandbox IDs, isolating title data during development, and retrieving certification save files.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/sandboxes/index"},{"title":"Setting up sandboxes","description":"How to obtain sandbox ID, TitleID, and SCID from Partner Center and configure your XBOX dev kit sandbox to enable XBOX Live services for your title.","sidebarTitle":"Setting up sandboxes","icon":"sliders","href":"/services/xbox-services/fundamentals/sandboxes/live-setting-up-sandboxes"},{"title":"XBOX services sandboxes overview","description":"Publish XBOX Live service config to a development sandbox, learn sandbox IDs, test accounts, and how to switch sandboxes on PC and XBOX console.","sidebarTitle":"XBOX services sandboxes","icon":"circle-info","href":"/services/xbox-services/fundamentals/sandboxes/live-setup-sandbox"},{"title":"Advanced XBOX services sandboxes","description":"Deep dive into XBOX Live sandboxes as isolated virtual environments in production, including content isolation, authorization scope, and dev workflows.","sidebarTitle":"Advanced XBOX services sandboxes","icon":"lightbulb","href":"/services/xbox-services/fundamentals/sandboxes/live-advanced-sandboxes"},{"title":"Retrieve game save files from certification testing","description":"Use XblConnectedStorage, xbstorage, and xgamesaveutil to pull game saves from the XBOX Live CERT sandbox and apply them to your dev test accounts.","sidebarTitle":"Retrieving game save files generated","icon":"cloud-arrow-up","href":"/services/xbox-services/fundamentals/sandboxes/live-get-certification-test-saves"}]},{"group":"Game binding","pages":[{"title":"Game binding","description":"Index of Game Binding topics for the XBOX GDK, covering how to share a single XBOX services configuration between primary and secondary console products.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/game-binding/index"},{"title":"Game Binding overview","description":"Learn how XBOX services Game Binding lets two console products, such as XBOX Series and XBOX One versions, share one Partner Center configuration.","sidebarTitle":"Game binding","icon":"circle-info","href":"/services/xbox-services/fundamentals/game-binding/game-binding-overview"}]},{"group":"Using XBOX services APIs","pages":[{"title":"XBOX services API","description":"Guides for the XBOX Services API (XSAPI): C API async patterns, XDK C++ backwards compatibility, XSAPI initialization, and REST endpoint alternatives.","sidebarTitle":"Overview","icon":"book-open","href":"/services/xbox-services/fundamentals/xbox-services-api/index"},{"title":"XBOX services API overview","description":"Compare the client-side XBOX Services API (XSAPI) and XBOX Live REST endpoints, weigh trade-offs, and choose the right approach for your GDK title.","sidebarTitle":"XBOX services API","icon":"circle-info","href":"/services/xbox-services/fundamentals/xbox-services-api/live-introduction-to-xbox-live-apis"},{"title":"How to use XBOX Services APIs (XSAPIs)","description":"Initialize GRTS, create an XTaskQueue, set up HttpClient tracing, and call XblInitialize to start using the XSAPI C APIs for XBOX Live in your title.","sidebarTitle":"How to use XBOX services APIs (xsapis)","icon":"book-open","href":"/services/xbox-services/fundamentals/xbox-services-api/live-gs-xbl-apis"},{"title":"XSAPI C overview","description":"Introduction to the XSAPI C API layer for XBOX Live in GDK titles, covering memory allocation callbacks, threading control, and libHttpClient.","sidebarTitle":"XSAPI c","icon":"circle-info","href":"/services/xbox-services/fundamentals/xbox-services-api/live-xsapi-flat-c"},{"title":"Making async calls in the XSAPI C API","description":"Use XAsyncBlock and XTaskQueueHandle to control threading for asynchronous XSAPI C calls like XblProfileGetUserProfileAsync in XBOX Live titles.","sidebarTitle":"Making async calls in the XSAPI c API","icon":"lightbulb","href":"/services/xbox-services/fundamentals/xbox-services-api/live-flatc-async-patterns"},{"title":"Backwards compatibility with XDK XSAPI","description":"Include the xsapi-cpp compatibility header shipped with the GDK to keep using the XDK-era C++ XSAPI when porting existing XBOX Live game code.","sidebarTitle":"Backwards compatibility with XDK XSAPI","icon":"lightbulb","href":"/services/xbox-services/fundamentals/xbox-services-api/live-gs-backcompat-api"}]},{"group":"Real-time activity (rta) service","pages":[{"title":"Rta","description":"Real-Time Activity (RTA) service topics for XBOX game developers, including conceptual overviews, best practices, and XSAPI example code for stat updates.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/rta/index"},{"title":"Real-Time Activity service overview","description":"The Real-Time Activity (RTA) service uses WebSockets to push player stats, presence, and state updates to titles and companion apps without polling.","sidebarTitle":"Real-time activity service","icon":"circle-info","href":"/services/xbox-services/fundamentals/rta/live-real-time-activity-service-overview"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for real-time activity (RTA) in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/fundamentals/rta/concepts/index"},{"title":"Registering for player stat change notifications","description":"Enable Real-Time Activity (RTA) notifications for player stat changes by opting in through your XBOX services configuration in Partner Center.","sidebarTitle":"Registering for player stat change","icon":"chart-line","href":"/services/xbox-services/fundamentals/rta/concepts/live-register-for-stat-notifications"},{"title":"Best practices for the RTA service","description":"Best practices for the Real-Time Activity (RTA) WebSocket service, covering subscriptions, token expiration, reconnection windows, and XSAPI handling.","sidebarTitle":"Best practices for the rta service","icon":"lightbulb","href":"/services/xbox-services/fundamentals/rta/concepts/live-rta-best-practices"}]},{"group":"Example code","pages":[{"title":"How to","description":"Reference and how-to guides for real-time activity (RTA) in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/rta/how-to/index"},{"title":"Programming the RTA service","description":"Flat C code samples showing how to register and unregister XSAPI handlers with the XBOX Real-Time Activity (RTA) service to receive player stat changes.","sidebarTitle":"Programming the rta service","icon":"lightbulb","href":"/services/xbox-services/fundamentals/rta/how-to/live-programming-rta"}]}]},{"group":"Authentication and s2s","pages":[{"title":"S2s auth calls","description":"Guides for XBOX Live authentication, XSTS tokens, and service-to-service calls from title back ends, including Partner Center config and S2S patterns.","sidebarTitle":"Overview","icon":"id-card","href":"/services/xbox-services/fundamentals/s2s-auth-calls/index"},{"title":"Authentication and S2S","description":"How titles authenticate with XBOX Live and make service-to-service REST calls, covering custom service config, XSTS tokens, and S2S auth flow.","sidebarTitle":"Authentication and s2s","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/live-s2s-auth-calls-nav"},{"group":"Custom service configuration","pages":[{"title":"Custom service config","description":"Custom service configuration hub for XBOX titles, spanning access policies, single sign-on, relying parties, and web services setup in Partner Center.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/index"},{"title":"Custom service configuration","description":"Overview of custom game service configuration in Partner Center, covering access policies, single sign-on, relying parties, and web service endpoints.","sidebarTitle":"Custom service configuration","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/live-custom-services-config-nav"},{"group":"Access policies","pages":[{"title":"Access policies","description":"Access policies documentation hub covering how XBOX titles let other apps and services read or write feature area data such as leaderboards and storage.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/access-policies/index"},{"title":"Access Policies","description":"Section index for XBOX access policies, linking the overview and Partner Center configuration steps for sharing title storage and gameplay data.","sidebarTitle":"Access policies","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/access-policies/live-access-policies-nav"},{"title":"Access policies overview","description":"Access policies let XBOX titles grant companion apps, web services, and other games permission to read or update settings and data stored in XBOX services.","sidebarTitle":"Access policies","icon":"circle-info","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/access-policies/live-access-policies-overview"},{"group":"Portal config","pages":[{"title":"Config","description":"Reference and configuration for service-to-service access policies in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/access-policies/config/index"},{"title":"Configuring access policies via Partner Center","description":"How to configure XBOX services access policies in Partner Center so other apps, games, and web services can read or modify your title's stored data.","sidebarTitle":"Configuring access policies via partner","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/access-policies/config/live-access-policies-config-nav"},{"title":"Configuring access policies in Partner Center","description":"Step-by-step Partner Center guide for Managed Partners to add access policies that let companion apps and web services share XBOX services data.","sidebarTitle":"Configuring access policies in partner","icon":"gauge","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/access-policies/config/live-access-policies-udc"}]}]},{"group":"Single sign-on","pages":[{"title":"Single sign on","description":"Single sign-on hub explaining how XBOX players can access your services using their XBOX account, plus Partner Center configuration walkthroughs.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/single-sign-on/index"},{"title":"Single sign-on","description":"Section index for XBOX single sign-on (SSO), showing how XBOX network sign-in unlocks your custom services and how to configure it in Partner Center.","sidebarTitle":"Single sign-on","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/single-sign-on/live-single-sign-on-nav"},{"title":"Configuring single sign-on in Partner Center","description":"Configure XBOX single sign-on in Partner Center so your title's URLs receive XSTS tokens, letting players use their XBOX account with your custom services.","sidebarTitle":"Configuring single sign-on in partner","icon":"gauge","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/single-sign-on/live-single-sign-on"}]},{"group":"Web services","pages":[{"title":"Web services","description":"Web services documentation for XBOX titles, showing how to customize app interactions with XBOX services and configure endpoints in Partner Center.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/web-services/index"},{"title":"Web services","description":"Configure custom web service endpoints for XBOX Live-enabled titles, including publisher-level Partner Center setup for SSO and S2S access.","sidebarTitle":"Web services","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/web-services/live-web-services-nav"},{"title":"Setting up web services at Partner Center","description":"Create and configure publisher web services in Partner Center for XBOX Live SSO, Relying Party setup, and service-to-service call access.","sidebarTitle":"Setting up web services at partner","icon":"gauge","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/web-services/live-web-services"}]},{"title":"Configuring relying parties","description":"Pointer to Partner Center steps for configuring relying parties that decode XBOX Secure Token Service (XSTS) tokens for your custom web services.","sidebarTitle":"Configuring relying parties","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/relying-parties/live-relying-parties-nav"}]},{"group":"Service calls to XBOX services","pages":[{"title":"S2s calls","description":"Reference for making XBOX Live service-to-service REST calls from title services, including XSTS token acquisition and S2S calling patterns.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/s2s-auth-calls/s2s-calls/index"},{"title":"Service calls to XBOX services","description":"Overview of authenticating title services with XBOX Live to invoke REST endpoints, covering S2S call flows and Business Partner Certificate setup.","sidebarTitle":"Service calls to XBOX services","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/s2s-calls/live-s2s-calls-nav"},{"title":"Live title service calls xbox live","href":"/services/xbox-services/fundamentals/s2s-auth-calls/s2s-calls/live-title-service-calls-xbox-live"},{"group":"Service-to-service calling patterns","pages":[{"title":"S2s call patterns","description":"XBOX Live service-to-service calling patterns, including MPSD multiplayer session management and retrieving the GDPR deleted accounts list.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/s2s-auth-calls/s2s-calls/s2s-call-patterns/index"},{"title":"Service-to-service calling patterns","description":"XBOX Live service-to-service calling patterns for MPSD multiplayer session management and GDPR deleted account retrieval from your title service.","sidebarTitle":"Service-to-service calling patterns","icon":"lightbulb","href":"/services/xbox-services/fundamentals/s2s-auth-calls/s2s-calls/s2s-call-patterns/live-s2s-call-patterns-nav"},{"title":"Service-to-service multiplayer session management","description":"Use S2S calling patterns with the Multiplayer Session Directory (MPSD) to manage XBOX Live sessions from a title server with Business Partner auth.","sidebarTitle":"Service-to-service multiplayer session","icon":"people-group","href":"/services/xbox-services/fundamentals/s2s-auth-calls/s2s-calls/s2s-call-patterns/live-mpsd-service-to-service"},{"title":"Getting the deleted accounts list from a service","description":"Retrieve the XBOX Live deleted accounts list for GDPR compliance using an XSTS token and the deletedaccounts.xboxlive.com REST endpoint.","sidebarTitle":"Getting the deleted accounts list from","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/s2s-calls/s2s-call-patterns/live-get-deleted-accounts-list"}]}]},{"group":"XBOX services authentication","pages":[{"title":"Service authentication","description":"XBOX Live service authentication guides covering XSTS tokens, title service auth, website sign-in, and security token claims for GDK titles.","sidebarTitle":"Overview","icon":"id-card","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/index"},{"title":"XBOX services authentication (contents)","description":"Contents index for XBOX Live authentication topics: XSTS security tokens, title service auth, website sign-in, and background on token flows.","sidebarTitle":"XBOX services authentication (contents)","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/live-service-authentication-nav"},{"title":"XBOX services authentication","description":"Background on XBOX Live call authentication using XSTS tokens and signatures, covering client-side XSAPI usage and service-to-service RESTful flows.","sidebarTitle":"XBOX services authentication","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/live-xbox-live-authentication"},{"title":"XBOX services authentication for title services","description":"Use partner XSTS tokens with encrypted JWT claims like pXUID and gamertag to authenticate users on your custom XBOX Live title web service.","sidebarTitle":"XBOX services authentication for title","icon":"lightbulb","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/live-title-service-authentication"},{"group":"XBOX services security tokens","pages":[{"title":"Security tokens","description":"Reference for XBOX Live XSTS security tokens: token structure, claim definitions, sample XSTS token decryption, and Relying Party validation.","sidebarTitle":"Overview","icon":"lock","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/security-tokens/index"},{"title":"XBOX Live security tokens","description":"Index of XBOX Live security token topics: XSTS token structure for GDK titles, available token claims, and a sample decoded XSTS token.","sidebarTitle":"XBOX live security tokens","icon":"lightbulb","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/security-tokens/live-security-token-nav"},{"title":"Live security tokens","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/security-tokens/live-security-tokens"},{"title":"XBOX services security token claims","description":"Reference of claims in XBOX Live XSTS encrypted tokens, including audience, sandbox ID, proof key, and device, title, and user identity claims.","sidebarTitle":"XBOX services security token claims","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/security-tokens/live-token-claims"},{"title":"Example XSTS Token, decryption, and validation","description":"Walk through a sample encrypted XBOX Live XSTS JWT token, showing how to decrypt it with a Relying Party private key and validate its claims.","sidebarTitle":"Example xsts token, decryption, and","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/security-tokens/live-sample-xsts-token"}]},{"title":"XBOX services sign-in for title websites","description":"Enable Microsoft account OAuth 2.0 sign-in on title websites and exchange access tokens for XBOX Live user tokens to read player data and profiles.","sidebarTitle":"XBOX services sign-in for title websites","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/live-website-authentication"}]}]},{"group":"Configure services in partner center","pages":[{"title":"Portal config","description":"Partner Center portal configuration topics for XBOX services, including title setup, data sharing, Game DVR, service config IDs, and the summary page.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/portal-config/index"},{"title":"Portal configuration overview","description":"Overview of XBOX services configuration in Partner Center for identity, event-based data, stats, leaderboards, achievements, and gameplay settings.","sidebarTitle":"Portal configuration","icon":"circle-info","href":"/services/xbox-services/fundamentals/portal-config/live-portal-config-overview"},{"title":"Summary page for XBOX services configuration","description":"Use the XBOX services summary page in Partner Center to view per-sandbox configuration, switch sandboxes, and export, import, certify, or publish changes.","sidebarTitle":"Summary page for XBOX services","icon":"sliders","href":"/services/xbox-services/fundamentals/portal-config/live-portal-summary-tab"},{"title":"Configuring XBOX services setup in Partner Center","description":"Configure initial XBOX services properties for your title in Partner Center, including localized titles, default locale, device families, and embargo date.","sidebarTitle":"Configuring XBOX services setup in","icon":"gauge","href":"/services/xbox-services/fundamentals/portal-config/live-config-xbl-setup"},{"title":"Set up an app or game in Partner Center (Managed Partners)","description":"Step-by-step Partner Center setup for Managed Partners to create a product, enable XBOX services, publish, and update the MicrosoftGame.config file.","sidebarTitle":"Setting up an app or game at partner","icon":"download","href":"/services/xbox-services/fundamentals/portal-config/live-setup-partner-center-partners"},{"title":"Configuring Game DVR in Partner Center","description":"Add and localize Game DVR clip strings for your XBOX title in Partner Center, and enable Game DVR recording and broadcasting on Windows 10 releases.","sidebarTitle":"Configuring game dvr in partner center","icon":"gauge","href":"/services/xbox-services/fundamentals/portal-config/live-game-dvr"},{"title":"Configuring data sharing in Partner Center","description":"Grant companion apps, web services, and other games access to your XBOX services data by configuring feature area sharing policies in Partner Center.","sidebarTitle":"Configuring data sharing in partner","icon":"lightbulb","href":"/services/xbox-services/fundamentals/portal-config/live-data-sharing-udc"},{"title":"XBOX services configuration IDs, for Managed Partners","description":"Locate XBOX services configuration IDs in Partner Center for Managed Partners so titles can wire up achievements, stats, leaderboards, and Smartmatch.","sidebarTitle":"XBOX services configuration ids, for","icon":"gauge","href":"/services/xbox-services/fundamentals/portal-config/live-service-config-ids-mp"}]}]},{"group":"Multiplayer","pages":[{"title":"Multiplayer","description":"Browse XBOX GDK multiplayer topics, including chat, invites, matchmaking, MPSD, Multiplayer Manager, Multiplayer Activity, and cross-network guidance.","sidebarTitle":"Overview","icon":"users-line","href":"/services/xbox-services/multiplayer/index"},{"title":"Multiplayer overview","description":"Overview of Microsoft multiplayer technologies for dedicated servers, peer-to-peer, matchmaking, invites, session management, and game chat across platforms.","sidebarTitle":"Multiplayer","icon":"users-line","href":"/services/xbox-services/multiplayer/overviews/multiplayer-intro"},{"group":"Overviews","pages":[{"title":"Overviews","description":"Reference and overviews for multiplayer sessions and matchmaking in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/overviews/index"},{"title":"XBOX services multiplayer overview","description":"Introduction to XBOX services multiplayer features including MPSD sessions, SmartMatch matchmaking, networking, voice chat, and text chat for real-time play.","sidebarTitle":"XBOX services multiplayer","icon":"circle-info","href":"/services/xbox-services/multiplayer/overviews/live-multiplayer-intro"},{"title":"Common multiplayer scenarios","description":"Compare common XBOX Live multiplayer scenarios such as comparative play, online play with friends, and skill-based matchmaking, ordered by effort.","sidebarTitle":"Common multiplayer scenarios","icon":"users-line","href":"/services/xbox-services/multiplayer/overviews/live-common-multiplayer-scenarios"},{"title":"XBOX and PC multiplayer design guidance","description":"Architecture guidance for GDK titles targeting XBOX and PC, comparing server-client and client-host designs using PlayFab Party, MPSD, MPM, and SmartMatch.","sidebarTitle":"XBOX and pc multiplayer design guidance","icon":"cube","href":"/services/xbox-services/multiplayer/overviews/multiplayer-design-guidance-xbox-pc-gdk"},{"title":"Cross-platform multiplayer design guidance","description":"Design guidance for combining PlayFab, MPSD, and SmartMatch in cross-platform multiplayer titles targeting XBOX, PC, PlayStation, Steam, iOS, and Android.","sidebarTitle":"Cross-platform multiplayer design","icon":"users-line","href":"/services/xbox-services/multiplayer/overviews/multiplayer-design-guidance-cross-platform"}]},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for multiplayer sessions and matchmaking in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/multiplayer/concepts/index"},{"title":"Multiplayer concepts overview","description":"Key XBOX multiplayer terms and concepts, including multiplayer sessions, MPSD, session templates, SmartMatch matchmaking, and Quality of Service (QoS).","sidebarTitle":"Multiplayer concepts","icon":"users-line","href":"/services/xbox-services/multiplayer/concepts/live-multiplayer-concepts"},{"title":"Configuring the Multiplayer service","description":"Configure the XBOX Multiplayer service for your title, including session templates, SmartMatch hoppers, and custom invite strings in service configuration.","sidebarTitle":"Configuring the multiplayer service","icon":"users-line","href":"/services/xbox-services/multiplayer/concepts/live-configure-the-multiplayer-service"},{"title":"Multiplayer roles","description":"Define player roles and reserve slots in XBOX multiplayer sessions so the service tracks role assignments and enforces maximum counts per gameplay role.","sidebarTitle":"Multiplayer roles","icon":"users-line","href":"/services/xbox-services/multiplayer/concepts/live-multiplayer-roles"},{"title":"Multiplayer session browse","description":"Enable XBOX multiplayer session browse so players can query, filter, and join open game sessions using title-defined metadata instead of matchmaking.","sidebarTitle":"Multiplayer session browse","icon":"people-group","href":"/services/xbox-services/multiplayer/concepts/live-session-browse"},{"title":"Introduction to calling the Multiplayer service directly","description":"Introduction to calling the 2015 Multiplayer API and MPSD directly instead of using Multiplayer Manager, including sessions, invites, and SmartMatch.","sidebarTitle":"Introduction to calling the multiplayer","icon":"circle-info","href":"/services/xbox-services/multiplayer/concepts/live-intro-calling-mp-directly"},{"title":"Migrating an arbiter","description":"How to select a new arbiter during a 2015 Multiplayer session using graceful or failover migration with MPSD host candidate lists on XBOX services.","sidebarTitle":"Migrating an arbiter","icon":"lightbulb","href":"/services/xbox-services/multiplayer/concepts/live-migrating-an-arbiter"}]},{"group":"Game chat","pages":[{"title":"Chat","description":"Browse chat topics for the XBOX GDK, including Game Chat 2, PlayFab Party voice chat, and guidance for adding low-latency communication to your title.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/chat/index"},{"group":"Game chat 2","pages":[{"title":"Game chat2","description":"Browse Game Chat 2 topics for the XBOX GDK, including the C++ API walkthrough, real-time audio manipulation, and privacy-aware voice and text chat.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/chat/game-chat2/index"},{"title":"Intro to Game Chat 2","description":"Add voice and text chat to your XBOX GDK title with Game Chat 2, honoring player privacy, accessibility, and XBOX console communication requirements.","sidebarTitle":"Intro to game chat 2","icon":"users-line","href":"/services/xbox-services/multiplayer/chat/game-chat2/game-chat-2-intro"},{"title":"Using the Game Chat 2 C++ API","description":"Walkthrough for the Game Chat 2 C++ API on XBOX GDK, covering initialization, adding users, configuring chat channels, and error handling patterns.","sidebarTitle":"Using the game chat 2 c++ API","icon":"users-line","href":"/services/xbox-services/multiplayer/chat/game-chat2/using-game-chat-2"},{"title":"Real-time audio manipulation","description":"Walkthrough for inspecting and applying real-time audio effects to Game Chat 2 voice streams using the audio manipulation pipeline in your XBOX GDK title.","sidebarTitle":"Real-time audio manipulation","icon":"volume-high","href":"/services/xbox-services/multiplayer/chat/game-chat2/real-time-audio-manipulation"}]},{"title":"Adding chat by using Microsoft Azure PlayFab Party","description":"Learn how PlayFab Party adds low-latency voice, text chat, and transcription to XBOX GDK games with cross-network support and PlayFab pricing details.","sidebarTitle":"Adding chat by using microsoft azure","icon":"people-group","href":"/services/xbox-services/multiplayer/chat/playfab-party-intro-chat"}]},{"group":"Multiplayer activity (mpa)","pages":[{"title":"Mpa","description":"Browse XBOX Multiplayer Activity (MPA) topics for the GDK, including activities, invites, recent players, PlayFab integration, and troubleshooting guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/mpa/index"},{"title":"Multiplayer Activity (MPA) feature overview","description":"Overview of how Multiplayer Activity simplifies XBOX integration for activities, invites, and recent players, and enables joins from a player's social graph.","sidebarTitle":"Multiplayer activity (mpa) feature","icon":"circle-info","href":"/services/xbox-services/multiplayer/mpa/live-mpa-overview"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for Multiplayer Activity (MPA) in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/multiplayer/mpa/concepts/index"},{"title":"Activities","description":"Advertise joinable multiplayer experiences to other XBOX players with Multiplayer Activity, including activity fields, join restrictions, and player counts.","sidebarTitle":"Activities","icon":"users-line","href":"/services/xbox-services/multiplayer/mpa/concepts/live-mpa-activities"},{"title":"Send an invite for another player to join a multiplayer game","description":"Send Multiplayer Activity invites so another XBOX player can join a game, including client and server flows, crossplay flags, and connection strings.","sidebarTitle":"Send a request for another player to","icon":"users-line","href":"/services/xbox-services/multiplayer/mpa/concepts/live-mpa-invites"},{"title":"Recent players","description":"Record player interactions with XBOX Multiplayer Activity recent players, supporting unidirectional reports and server-submitted bidirectional groups.","sidebarTitle":"Recent players","icon":"users-line","href":"/services/xbox-services/multiplayer/mpa/concepts/live-mpa-recent-players"},{"title":"MPA invite and activity troubleshooting guide","description":"Troubleshoot XBOX Multiplayer Activity invite and activity issues by checking join restrictions, crossplay flags, sandbox, title ID, and Partner Center setup.","sidebarTitle":"Mpa invite and activity troubleshooting","icon":"triangle-exclamation","href":"/services/xbox-services/multiplayer/mpa/concepts/live-mpa-troubleshooting"},{"title":"Integration with PlayFab Lobby \u0026 Match","description":"Best practices for integrating XBOX Multiplayer Activity with PlayFab Lobby and Match, including activity updates, XUID resolution, and invite handling.","sidebarTitle":"Integration with PlayFab lobby \u0026 match","icon":"shuffle","href":"/services/xbox-services/multiplayer/mpa/concepts/live-mpa-playfab-integration"}]},{"group":"Example code","pages":[{"title":"How to","description":"Reference and how-to guides for Multiplayer Activity (MPA) in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/mpa/how-to/index"},{"title":"Example code for Multiplayer Activity","description":"Quickstart XBOX Multiplayer Activity C++ examples for setting activities, sending invites, and updating the recent players list from your GDK title.","sidebarTitle":"Example code for multiplayer activity","icon":"users-line","href":"/services/xbox-services/multiplayer/mpa/how-to/live-mpa-client-how-to"}]}]},{"group":"Multiplayer manager (mpm)","pages":[{"title":"Mpm","description":"Browse Multiplayer Manager (MPM) topics, concepts, and how-to guides for managing XBOX Live sessions, matchmaking, and game invites in your GDK title.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/mpm/index"},{"title":"Multiplayer Manager overview","description":"Overview of Multiplayer Manager, the high-level XBOX Live API that simplifies MPSD session management, SmartMatch matchmaking, invites, and join-in-progress.","sidebarTitle":"Multiplayer manager","icon":"circle-info","href":"/services/xbox-services/multiplayer/mpm/live-multiplayer-manager-overview"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for Multiplayer Manager (MPM) in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/multiplayer/mpm/concepts/index"},{"title":"Multiplayer Manager API overview","description":"Overview of the most important XBOX Multiplayer Manager API methods and classes, including lobby sessions, game sessions, members, and multiplayer events.","sidebarTitle":"Multiplayer manager API","icon":"circle-info","href":"/services/xbox-services/multiplayer/mpm/concepts/live-multiplayer-manager-api-overview"},{"group":"Multiplayer manager flowcharts","pages":[{"title":"Flowcharts","description":"Browse XBOX Multiplayer Manager flowcharts, including matchmaking, invites, protocol activation, host migration, and shutting down multiplayer sessions.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/index"},{"title":"Playing a game with friends (flowchart)","description":"Flowcharts for starting an XBOX Multiplayer Manager game with friends, covering the inviting client and the client that receives and accepts the invite.","sidebarTitle":"Playing a game with friends (flowchart)","icon":"users","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mpm-play-with-friends"},{"title":"Playing a game by using SmartMatch matchmaking (flowchart)","description":"Flowchart showing how to start an XBOX Multiplayer Manager game with friends, then fill open slots by using SmartMatch matchmaking with other XBOX players.","sidebarTitle":"Playing a game by using smartmatch","icon":"shuffle","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mpm-play-with-smartmatch-matchmaking"},{"title":"Checking Quality of Service for matchmaking (flowchart)","description":"Flowchart showing when to run Quality of Service checks in an XBOX Multiplayer Manager matchmaking workflow before players start gameplay together.","sidebarTitle":"Checking quality of service for","icon":"network-wired","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mpm-use-matchmaking-and-qos"},{"title":"Sending invites to another player (flowchart)","description":"Flowchart for sending XBOX game invites with Multiplayer Manager, showing use of the system Title-Callable UI friend picker or a custom in-title UI.","sidebarTitle":"Sending invites to another player","icon":"users-line","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mpm-send-invites"},{"title":"Handling protocol activation (flowchart)","description":"Flowchart for handling Multiplayer Manager protocol activation on XBOX when a player accepts a game invite or joins a game through the profile card.","sidebarTitle":"Handling protocol activation (flowchart)","icon":"users-line","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mpm-on-protocol-activation"},{"title":"Filling open slots in a multiplayer game (flowchart)","description":"Flowcharts for filling open slots in an XBOX multiplayer game with Multiplayer Manager, either by inviting friends or by using SmartMatch matchmaking.","sidebarTitle":"Filling open slots in a multiplayer","icon":"lightbulb","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mpm-fill-open-slots"},{"title":"Handling host migration (flowchart)","description":"Flowchart for handling host migration in an XBOX Multiplayer Manager game when the current host disconnects and a new host must take over the session.","sidebarTitle":"Handling host migration (flowchart)","icon":"users-line","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mpm-host-migration"},{"title":"Shutting down a multiplayer session (flowchart)","description":"Flowchart for shutting down a Multiplayer Manager session on XBOX after a multiplayer game finishes and the lobby and game sessions are no longer needed.","sidebarTitle":"Shutting down a multiplayer session","icon":"people-group","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mpm-shut-down"}]}]},{"group":"Example code","pages":[{"title":"How to","description":"Reference and how-to guides for Multiplayer Manager (MPM) in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/mpm/how-to/index"},{"title":"Play multiplayer with friends using Multiplayer Manager","description":"Step-by-step guide for using Multiplayer Manager to initialize a lobby session, send XBOX Live invites, and let friends join a game in progress.","sidebarTitle":"Enable playing a multiplayer game with","icon":"users","href":"/services/xbox-services/multiplayer/mpm/how-to/live-play-multiplayer-with-friends"},{"title":"Multiplayer matchmaking with SmartMatch and MPM","description":"Use Multiplayer Manager and SmartMatch matchmaking to find XBOX Live players, create a lobby session, send optional invites, and start a multiplayer match.","sidebarTitle":"Enable finding a multiplayer game by","icon":"shuffle","href":"/services/xbox-services/multiplayer/mpm/how-to/live-play-multiplayer-with-matchmaking"},{"title":"Sending game invites using Multiplayer Manager","description":"How to send XBOX Live game invites with Multiplayer Manager using the platform title-callable UI (TCUI) or a title-implemented custom invite UI.","sidebarTitle":"Sending game invites using multiplayer","icon":"book-open","href":"/services/xbox-services/multiplayer/mpm/how-to/live-send-game-invites"},{"title":"Handle protocol activation with Multiplayer Manager","description":"Use XBOX Multiplayer Manager to handle protocol activation when a player accepts a game invite or joins from a gamercard, including lobby join handling.","sidebarTitle":"Handling protocol activation to start a","icon":"users-line","href":"/services/xbox-services/multiplayer/mpm/how-to/live-handle-protocol-activation"}]}]},{"group":"Multiplayer session directory (mpsd)","pages":[{"title":"Mpsd","description":"Browse Multiplayer Session Directory (MPSD) topics, concepts, and how-to guides for sharing session state, invites, and joins across XBOX Live clients.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/mpsd/index"},{"title":"Multiplayer Session Directory overview","description":"Overview of the MPSD service, XblMultiplayer session handles, change notifications, and session synchronization across XBOX Live clients and titles.","sidebarTitle":"Multiplayer session directory","icon":"users-line","href":"/services/xbox-services/multiplayer/mpsd/live-mpsd-overview"},{"title":"Live xbox multiplayer session directory","href":"/services/xbox-services/multiplayer/mpsd/live-xbox-multiplayer-session-directory"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for Multiplayer Session Directory (MPSD) in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/multiplayer/mpsd/concepts/index"},{"title":"Multiplayer Session advanced topics","description":"Deep dive into MPSD sessions covering member properties, capabilities, size limits, user states, timeouts, arbiters, and process lifecycle management.","sidebarTitle":"Multiplayer session advanced topics","icon":"people-group","href":"/services/xbox-services/multiplayer/mpsd/concepts/live-mpsd-details"},{"title":"Game session visibility and joinability","description":"Explains MPSD game session visibility (open, visible, private) and joinability settings, and recommends configurations for XBOX multiplayer invites and joins.","sidebarTitle":"Game session visibility and joinability","icon":"people-group","href":"/services/xbox-services/multiplayer/mpsd/concepts/live-game-session-visibility-joinability"},{"title":"Multiplayer session templates","description":"Learn how MPSD session templates work as blueprints for creating multiplayer sessions, including template versions and examples you can copy and modify.","sidebarTitle":"Multiplayer session templates","icon":"people-group","href":"/services/xbox-services/multiplayer/mpsd/concepts/live-session-templates"},{"title":"Session template constants","description":"Reference for predefined MPSD session template constants (system, capabilities, metrics, memberInitialization, QoS) that configure XBOX multiplayer sessions.","sidebarTitle":"Session template constants","icon":"people-group","href":"/services/xbox-services/multiplayer/mpsd/concepts/live-session-template-constants"},{"title":"Enable large sessions for Multiplayer","description":"How to create large MPSD multiplayer sessions with up to 10,000 members for MMO games, broadcasts, and encounters using the 2015 Multiplayer APIs.","sidebarTitle":"Enable large sessions for multiplayer","icon":"users-line","href":"/services/xbox-services/multiplayer/mpsd/concepts/live-large-sessions"},{"title":"Multiplayer FAQ and troubleshooting","description":"Frequently asked questions and troubleshooting tips for XBOX multiplayer, covering MPSD, MPA, session subscriptions, disconnects, SCIDs, and sandboxes.","sidebarTitle":"Multiplayer faq and troubleshooting","icon":"circle-question","href":"/services/xbox-services/multiplayer/mpsd/concepts/live-multiplayer-2015-faq"},{"title":"MPSD invite and activity troubleshooting guide","description":"Troubleshoot disabled MPSD invite and activity join UI by checking session state, sandbox and title IDs, MicrosoftGame.config, and template setup.","sidebarTitle":"Mpsd invite and activity troubleshooting","icon":"triangle-exclamation","href":"/services/xbox-services/multiplayer/mpsd/concepts/live-multiplayer-invite-troubleshooting"},{"title":"Moving from MPSD to PlayFab Multiplayer and MPA","description":"Migration guide for moving XBOX titles from MPSD to PlayFab Multiplayer lobbies and Multiplayer Activity (MPA) for invites, matchmaking, and recent players.","sidebarTitle":"Moving from mpsd to PlayFab multiplayer","icon":"server","href":"/services/xbox-services/multiplayer/mpsd/concepts/live-mpsd-to-mlp"}]},{"group":"Example code","pages":[{"title":"How to","description":"Reference and how-to guides for Multiplayer Session Directory (MPSD) in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/mpsd/how-to/index"},{"title":"Multiplayer tasks","description":"Code samples for common 2015 Multiplayer tasks: subscribing to MPSD changes, creating sessions, sending invites, joining, matchmaking tickets, and activity.","sidebarTitle":"Multiplayer tasks","icon":"users-line","href":"/services/xbox-services/multiplayer/mpsd/how-to/live-mpsd-how-tos"},{"title":"Multiplayer session status codes","description":"Reference table of HTTP status codes returned by XBOX services when requesting or updating an MPSD multiplayer session, with response bodies and meanings.","sidebarTitle":"Multiplayer session status codes","icon":"chart-line","href":"/services/xbox-services/multiplayer/mpsd/how-to/live-mpsd-status-codes"}]}]},{"group":"Invites","pages":[{"title":"Invites","description":"Browse XBOX invites topics for the GDK, including invite concepts, UX flow diagrams, cross-SDK support, and example code for sending and receiving invites.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/invites/index"},{"title":"Invites overview","description":"Overview of the XBOX multiplayer invite system, including how titles send invites, control invite flow, and pass custom notification text and title data.","sidebarTitle":"Invites","icon":"users-line","href":"/services/xbox-services/multiplayer/invites/live-multiplayer-invites-overview"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for multiplayer invites in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/multiplayer/invites/concepts/index"},{"title":"Flows for multiplayer game invites","description":"Detailed UX flow breakdown for sending and receiving multiplayer game invites on XBOX, covering in-game invites, toast notifications, and Party interactions.","sidebarTitle":"Flows for multiplayer game invites","icon":"lightbulb","href":"/services/xbox-services/multiplayer/invites/concepts/live-multiplayer-invite-flows"},{"title":"Multiplayer invites across XDK and GDK title versions","description":"How the XBOX Multiplayer service supports invites, joins, SmartMatch, and activity across XBOX One SDK and Microsoft GDK title versions sharing a title ID.","sidebarTitle":"Invites across XBOX one software","icon":"clock-rotate-left","href":"/services/xbox-services/multiplayer/invites/concepts/live-multiplayer-xdkinvites"}]},{"group":"Example code","pages":[{"title":"How to","description":"Reference and how-to guides for multiplayer invites in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/invites/how-to/index"},{"title":"Sending invites","description":"Send XBOX multiplayer game invites from a title using the Title-Callable UI overlay or the XblMultiplayerSendInvitesAsync API with a custom in-game UI.","sidebarTitle":"Sending invites","icon":"users-line","href":"/services/xbox-services/multiplayer/invites/how-to/live-invites-send"},{"title":"Receiving invites","description":"Add multiplayer game invite handling to your XBOX services title by registering the multiplayer protocol and XGameActivation invite event callbacks.","sidebarTitle":"Receiving invites","icon":"book-open","href":"/services/xbox-services/multiplayer/invites/how-to/live-invites-receive"}]}]},{"group":"Smartmatch matchmaking","pages":[{"title":"Matchmaking","description":"Browse XBOX matchmaking documentation for the GDK, including SmartMatch concepts, target session QoS, and Partner Center hopper configuration guides.","sidebarTitle":"Overview","icon":"users-line","href":"/services/xbox-services/multiplayer/matchmaking/index"},{"title":"Matchmaking overview","description":"Introduction to XBOX SmartMatch matchmaking, including how match tickets, MPSD sessions, and the Multiplayer Manager API help find compatible players.","sidebarTitle":"Matchmaking","icon":"users-line","href":"/services/xbox-services/multiplayer/matchmaking/live-matchmaking-overview"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for multiplayer matchmaking in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/multiplayer/matchmaking/concepts/index"},{"title":"Using SmartMatch matchmaking","description":"Use XBOX SmartMatch matchmaking to create match ticket sessions, set player attributes, manage QoS, and reuse game sessions in your multiplayer title.","sidebarTitle":"Using smartmatch matchmaking","icon":"users-line","href":"/services/xbox-services/multiplayer/matchmaking/concepts/live-matchmaking-how-tos"},{"title":"Target session initialization and QoS","description":"Target session initialization for SmartMatch on XBOX, covering managed initialization stages and Quality of Service checks between peers before gameplay.","sidebarTitle":"Target session initialization and QoS","icon":"people-group","href":"/services/xbox-services/multiplayer/matchmaking/concepts/live-matchmaking-target-session"}]},{"group":"Portal config","pages":[{"title":"Config","description":"Reference and configuration for multiplayer matchmaking in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/multiplayer/matchmaking/config/index"},{"title":"Configuring matchmaking in Partner Center","description":"Configure SmartMatch matchmaking in Partner Center for XBOX titles, including session templates, hopper rules, and team rules for compatible player matching.","sidebarTitle":"Configuring matchmaking in partner","icon":"users-line","href":"/services/xbox-services/multiplayer/matchmaking/config/live-matchmaking-config"}]}]}]},{"group":"Community","pages":[{"title":"Community","description":"Landing page for XBOX Live community features: People system, Presence, Reputation, and Social Manager for building social gameplay experiences.","sidebarTitle":"Overview","icon":"comments","href":"/services/xbox-services/community/index"},{"title":"Overview of Social features","description":"How XBOX Live social features - profile, friends list, presence, gamerscore, achievements, and reputation - help connect players around your title.","sidebarTitle":"Overview of social features","icon":"users","href":"/services/xbox-services/community/live-social-overview"},{"group":"Social manager","pages":[{"title":"Social manager","description":"Landing page for the XBOX services Social Manager API that keeps friends, presence, and social graph data current for your title with minimal effort.","sidebarTitle":"Overview","icon":"comments","href":"/services/xbox-services/community/social-manager/index"},{"title":"Social Manager overview","description":"How the XBOX services Social Manager API simplifies the social graph, using Real-Time Activity to keep friends and presence data fresh with synchronous calls.","sidebarTitle":"Social manager","icon":"circle-info","href":"/services/xbox-services/community/social-manager/live-social-manager-overview"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Concepts for the XBOX Live Social Manager in the XBOX Game Development Kit (XBOX Services), including social graph queries and event handling.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/community/social-manager/concepts/index"},{"title":"Privilege codes for Social Manager","description":"Reference table of Social Manager privilege codes for XBOX Live, including multiplayer parties, voice chat, cloud saves, broadcasting, and shared content.","sidebarTitle":"Privilege codes for social manager","icon":"lightbulb","href":"/services/xbox-services/community/social-manager/concepts/live-socmgr-privilege-codes"},{"title":"Social Manager memory and performance","description":"Social Manager memory and CPU limits on XBOX, including the 100 additional user cap, RTA subscription budget, and XblSocialManagerDoWork timings.","sidebarTitle":"Social manager memory and performance","icon":"gauge-high","href":"/services/xbox-services/community/social-manager/concepts/live-socmgr-mem-perf"}]}]},{"group":"People system (friends list)","pages":[{"title":"People system","description":"Documentation hub for the XBOX Live People System that powers the friends list, followers, and social relationships in your title.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/community/people-system/index"},{"title":"People System (Friends List) overview","description":"How the XBOX Live People System tracks player relationships, follows, and friends so titles can present real names, favorites, and social graphs.","sidebarTitle":"People system (friends list)","icon":"circle-info","href":"/services/xbox-services/community/people-system/live-people-system-overview"},{"group":"Concepts","pages":[{"title":"Displaying people from the People System","description":"Call patterns for displaying XBOX Live People List data by combining People, Presence, Profile, and Leaderboards services with the People moniker.","sidebarTitle":"Displaying people from the people system","icon":"display","href":"/services/xbox-services/community/people-system/concepts/live-pplsys-displaying-people"},{"group":"Example code","pages":[{"title":"How to","description":"Reference and how-to guides for people system and social graph in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/community/people-system/how-to/index"},{"title":"Getting a social relationship","description":"Sample XSAPI flat C code that uses XblSocialGetSocialRelationshipsAsync to retrieve an XBOX Live user's friends and their public relationship properties.","sidebarTitle":"Getting a social relationship","icon":"users","href":"/services/xbox-services/community/people-system/how-to/live-getting-a-social-relationship"},{"title":"Handling a social relationship change","description":"XSAPI code for subscribing to XBOX Live social relationship change events and adding or removing handlers when a user's friends list is updated.","sidebarTitle":"Handling a social relationship change","icon":"book-open","href":"/services/xbox-services/community/people-system/how-to/live-handling-a-relationship-change"}]}]}]},{"group":"Rich presence","pages":[{"title":"Presence","description":"Landing page for XBOX Live Presence and Rich Presence: concepts, Partner Center configuration, and code samples for surfacing player activity.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/community/presence/index"},{"title":"Rich Presence","description":"Guide to XBOX Live Rich Presence covering the feature overview, string concepts, Partner Center portal configuration, and XSAPI example code.","sidebarTitle":"Rich presence","icon":"map","href":"/services/xbox-services/community/presence/live-presence-nav"},{"title":"Rich Presence overview","description":"Introduction to XBOX Live Rich Presence explaining how titles advertise a player's current activity and location beyond the default Basic Presence.","sidebarTitle":"Rich presence","icon":"circle-info","href":"/services/xbox-services/community/presence/live-presence-overview"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Concepts and best practices for XBOX Live rich presence in the XBOX Game Development Kit (XBOX Services), including presence strings and appendices.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/community/presence/concepts/index"},{"title":"Rich Presence concepts","description":"Conceptual topics for XBOX Live Rich Presence strings, including best practices, policies and limits, and using Player Data stats as parameters.","sidebarTitle":"Rich presence concepts","icon":"lightbulb","href":"/services/xbox-services/community/presence/concepts/live-presence-concepts-nav"},{"title":"Best practices for Rich Presence","description":"Tips for writing effective XBOX Live Rich Presence strings that use player stats, drive engagement, and localize the current in-game activity.","sidebarTitle":"Best practices for rich presence","icon":"lightbulb","href":"/services/xbox-services/community/presence/concepts/live-presence-best-practices"},{"title":"Policies and limits for Rich Presence strings","description":"Rules for XBOX Live Rich Presence strings including the 44-character limit, string-set requirements, enumerations, statistics, and friendly name syntax.","sidebarTitle":"Policies and limits for rich presence","icon":"lightbulb","href":"/services/xbox-services/community/presence/concepts/live-presence-limits"},{"title":"Rich Presence appendix","description":"Reference notes on using XBOX Live Player Data stats and state values, such as kills or current map, as parameters inside Rich Presence strings.","sidebarTitle":"Rich presence appendix","icon":"lightbulb","href":"/services/xbox-services/community/presence/concepts/live-presence-apx"}]},{"group":"Portal config","pages":[{"title":"Rich Presence portal config","description":"Guides for setting up XBOX Live Rich Presence strings in Partner Center so a player's in-game activity appears next to your title on XBOX.","sidebarTitle":"Rich presence portal config","icon":"gauge","href":"/services/xbox-services/community/presence/config/live-presence-config-nav"},{"title":"Configuring Rich Presence strings","description":"How to define XBOX Live Rich Presence string-sets with localized values, enumerations, and event-based statistics parameters for dynamic activity text.","sidebarTitle":"Configuring rich presence strings","icon":"compass","href":"/services/xbox-services/community/presence/config/live-presence-config"},{"title":"Configuring Rich Presence strings in Partner Center","description":"Walkthrough for adding XBOX Live Rich Presence strings in Partner Center so a player's activity appears in the Friends and clubs list and profile.","sidebarTitle":"Configuring rich presence strings in","icon":"gauge","href":"/services/xbox-services/community/presence/config/live-presence-config2"},{"group":"Example code","pages":[{"title":"How to","description":"Reference and how-to guides for rich presence in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/community/presence/how-to/index"},{"title":"Rich Presence example code","description":"Sample code index for XBOX Live Rich Presence covering getting user Presence, handling title and device changes, and updating strings via XSAPI or REST.","sidebarTitle":"Rich presence example code","icon":"code","href":"/services/xbox-services/community/presence/how-to/live-presence-howto-nav"},{"title":"Getting a user's Presence","description":"XSAPI flat C example that calls XblPresenceGetPresenceAsync to fetch an XBOX Live user's Presence record and read the returned online status data.","sidebarTitle":"Getting a user's presence","icon":"user","href":"/services/xbox-services/community/presence/how-to/live-getting-a-users-presence"},{"title":"Handling a title Presence change","description":"XSAPI examples for subscribing to XBOX Live title Presence changes and wiring up handlers when a user starts, stops, or suspends a specific title.","sidebarTitle":"Handling a title presence change","icon":"book-open","href":"/services/xbox-services/community/presence/how-to/live-handling-a-title-presence-change"},{"title":"Handling a device Presence change","description":"Code samples for subscribing to XBOX Live device Presence change events and adding or removing handlers when a user logs on or off a device.","sidebarTitle":"Handling a device presence change","icon":"book-open","href":"/services/xbox-services/community/presence/how-to/live-handling-a-device-presence-change"},{"title":"Updating a user's Presence via XSAPI C","description":"Flat C sample using XblPresenceSetPresenceAsync to update an XBOX Live user's online Presence status and advertise current in-game activity.","sidebarTitle":"Updating a user's presence via XSAPI c","icon":"user","href":"/services/xbox-services/community/presence/how-to/live-updating-user-presence"},{"title":"Updating a user's Presence via REST","description":"REST reference for updating XBOX Live Rich Presence with the Write Title URI, including TitleRequest, ActivityRequest, and RichPresenceRequest fields.","sidebarTitle":"Updating a user's presence via REST","icon":"user","href":"/services/xbox-services/community/presence/how-to/live-updating-presence-rest"}]}]}]},{"group":"Localized strings","pages":[{"title":"Localized strings","description":"Guides for configuring XBOX services localized strings in Partner Center and understanding the language-region fallback logic for achievements.","sidebarTitle":"Localized strings","icon":"clipboard-list","href":"/services/xbox-services/community/localized-strings/live-localized-strings-nav"},{"title":"Configuring localized strings in Partner Center","description":"Configure localized strings for XBOX Live achievements and XSAPI values in Partner Center using the localization.xml download and upload workflow.","sidebarTitle":"Configuring localized strings in","icon":"gauge","href":"/services/xbox-services/community/localized-strings/live-localized-strings-config"},{"title":"XBOX Services Language Fallback","description":"Locale fallback table used by XBOX services when a user's system language has no localized string, including the default en-US fallback rules.","sidebarTitle":"XBOX services language fallback","icon":"language","href":"/services/xbox-services/community/localized-strings/live-language-fallback"},{"group":"Reputation","pages":[{"title":"Reputation","description":"Landing page for the XBOX Live Reputation service, covering the overview, feedback concepts, and code samples for encouraging positive multiplayer play.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/community/reputation/index"},{"title":"Reputation overview","description":"Introduction to XBOX Live Reputation as a global user statistic, including feedback handling, positive rewards, and impact on multiplayer privileges.","sidebarTitle":"Reputation","icon":"circle-info","href":"/services/xbox-services/community/reputation/live-reputation-overview"},{"title":"Sending reputation feedback from a title","description":"How your title can submit player feedback to the XBOX Live Reputation service, including feedback types, API calls, and reporting best practices.","sidebarTitle":"Sending reputation feedback from a title","icon":"lightbulb","href":"/services/xbox-services/community/reputation/concepts/live-sending-reputation-feedback"},{"group":"Example code","pages":[{"title":"How to","description":"Reference and how-to guides for player reputation in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/community/reputation/how-to/index"},{"title":"Reputation example code","description":"Sample code index for the XBOX Live Reputation service, focused on submitting single and batched player feedback items through XSAPI calls.","sidebarTitle":"Reputation example code","icon":"code","href":"/services/xbox-services/community/reputation/how-to/live-reputation-howto-nav"},{"title":"Submitting Reputation feedback","description":"XSAPI C examples for calling XblSocialSubmitReputationFeedbackAsync to send positive or negative player Reputation feedback from your XBOX title.","sidebarTitle":"Submitting reputation feedback","icon":"paper-plane","href":"/services/xbox-services/community/reputation/how-to/live-submitting-reputation-feedback"}]}]}]}]},{"group":"Player data","pages":[{"title":"Player data","description":"XBOX Live Player Data documentation for GDK titles, covering achievements, user stats, leaderboards, featured stats, and social experience design.","sidebarTitle":"Overview","icon":"database","href":"/services/xbox-services/player-data/index"},{"title":"XBOX Player Data overview","description":"How the XBOX Player Data Platform powers achievements, stats, leaderboards, and social features across your title, XBOX shell, and the XBOX app.","sidebarTitle":"XBOX player data","icon":"circle-info","href":"/services/xbox-services/player-data/live-playerdata-overview"},{"title":"Designing XBOX services Experiences","description":"Walkthrough for planning XBOX services Player Data, including user stats, achievements, and leaderboards, using a sample racing game scenario.","sidebarTitle":"Designing XBOX services experiences","icon":"right-to-bracket","href":"/services/xbox-services/player-data/live-designing-experiences"},{"group":"Stats and leaderboards","pages":[{"title":"Stats leaderboards","description":"Documentation for XBOX Live user stats and leaderboards, covering event-based, title-managed, and featured stats options for GDK game titles.","sidebarTitle":"Overview","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/index"},{"title":"Event-based Stats VS. title-managed Stats","description":"Compare XBOX Live event-based Stats (Stats 2013) with title-managed Stats (Stats 2017) to pick the right user stats and leaderboards model for your title.","sidebarTitle":"Event-based stats VS. title-managed","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/live-stats-eb-vs-tm"},{"group":"Event-based stats and leaderboards","pages":[{"title":"Event based","description":"Documentation for event-based stats and leaderboards in the XBOX Game Development Kit (XBOX Services): concepts, config, and how-to guides.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/index"},{"title":"Event-based Stats and Leaderboards","description":"Guide to XBOX Live event-based Stats and Leaderboards, including the Data Platform, Partner Center configuration, events, and XSAPI code samples.","sidebarTitle":"Event-based stats and leaderboards","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/live-statslb-eb-nav"},{"title":"Event-based Player Data overview","description":"How the XBOX Live event-based Data Platform receives game events and applies service configuration rules to update user stats, leaderboards, and achievements.","sidebarTitle":"Event-based player data","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/live-how-data-platform-works"},{"title":"Event-based Stats overview","description":"How event-based XBOX Live user stats are calculated from title events using stat rules and templates defined in the Partner Center configuration.","sidebarTitle":"Event-based stats","icon":"circle-info","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/live-stats-eb-overview"},{"title":"Event-based Leaderboards overview","description":"How XBOX Live event-based Leaderboards compare players via global rankings across the XBOX population or social rankings among a player's friends.","sidebarTitle":"Event-based leaderboards","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/live-leaderboards-eb-overview"},{"group":"Portal config","pages":[{"title":"Config","description":"Configuration reference for event-based stats and leaderboards in the XBOX Game Development Kit (XBOX Services), covering Partner Center setup.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/config/index"},{"title":"Event-based Stats and leaderboards portal config","description":"Partner Center configuration guides for event-based XBOX Live stats and leaderboards, including stat rules, change notifications, and scenarios.","sidebarTitle":"Event-based stats and leaderboards","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-statslb-eb-config-nav"},{"title":"First glance for event-based Stats","description":"First-look walkthrough for configuring an XBOX Live event and stat in Partner Center, then adding code to send events and update stats.","sidebarTitle":"First glance for event-based stats","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-stats-first-glance"},{"title":"Event-based Stat rules overview","description":"How event-based XBOX Live user stat rules work, including producer events, naming, operators, parameters, and stat templates for player stats.","sidebarTitle":"Event-based stat rules","icon":"user","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-user-stat-rules"},{"title":"User stats scenarios","description":"Common XBOX Live user stat scenarios for event-based Stats, including Boolean flags, cumulative counters, personal bests, and most-recent values.","sidebarTitle":"User stats scenarios","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-user-stats-scenarios"},{"title":"Portal configuration of stat change notifications","description":"Subscribe to XBOX Live stat change notifications via the Real-Time Activity service by configuring event-based stats in Partner Center.","sidebarTitle":"Portal configuration of stat change","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-stat-change-notif-portal"},{"title":"Adding a field value to a stat rule","description":"Guidance on using event field names versus field values in XBOX Live event-based stat rule templates to avoid unintended stat instances.","sidebarTitle":"Adding a field value to a stat rule","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-stat-name-value"},{"title":"Portal configuration of event-based Stats","description":"Add, edit, copy, and delete event-based XBOX Live stat rules in Partner Center so game events update player stats and drive leaderboards.","sidebarTitle":"Portal configuration of event-based","icon":"gauge","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-stats-eb-portal"},{"title":"Portal configuration of event-based Leaderboards","description":"Create and manage global XBOX Live leaderboards backed by event-based stats in Partner Center, including naming, ranking, and stat selection.","sidebarTitle":"Portal configuration of event-based","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-eb-leaderboards-portal"}]},{"group":"Example code","pages":[{"title":"Event-based Stats \u0026 Leaderboards example code","description":"XSAPI example code index for XBOX Live event-based Stats and Leaderboards, including writing events, reading stats, and paging leaderboards.","sidebarTitle":"Event-based stats \u0026 leaderboards","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/how-to/live-statslb-eb-howto-nav"},{"title":"Writing an event to power an event-based stat","description":"Sample XblEventsWriteInGameEvent code that fires an XBOX Live event so configured stat rules update event-based user stats on the service.","sidebarTitle":"Writing an event to power an","icon":"book-open","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/how-to/live-sending-eb-stat"},{"title":"Getting event-based stats","description":"XSAPI example code for reading XBOX Live event-based stats, including batched queries across users and SCIDs to minimize service calls.","sidebarTitle":"Getting event-based stats","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/how-to/live-getting-eb-stat"},{"title":"Handling an event-based stat change","description":"Example XSAPI code for subscribing to XBOX Live event-based stat change notifications and cleaning up handlers using the Real-Time Activity service.","sidebarTitle":"Handling an event-based stat change","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/how-to/live-handling-eb-stat-change"},{"title":"Example code for event-based Leaderboards","description":"XSAPI code samples for XBOX Live event-based Leaderboards, including top results, paging, and centering around a specified rank or player.","sidebarTitle":"Example code for event-based","icon":"code","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/how-to/live-leaderboards-eb-howto"},{"group":"Events","pages":[{"title":"Events","description":"XBOX Live events documentation for the event-based Data Platform, covering event configuration, sending code samples, and how events drive user stats.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/events/index"},{"title":"Events","description":"Player Data section covering XBOX Live events used for event-based user stats, including overview, Partner Center config, and example code.","sidebarTitle":"Events","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/events/live-events-nav"},{"title":"Events overview","description":"How XBOX Live game events feed the User Statistics service to update stats, leaderboards, and matchmaking for event-based Player Data titles.","sidebarTitle":"Events","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/events/live-game-events"},{"group":"Portal config","pages":[{"title":"Config","description":"Configuration reference for stats and leaderboard events in the XBOX Game Development Kit (XBOX Services), covering event schemas and manifests.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/events/config/index"},{"title":"Events portal config","description":"Partner Center configuration steps for XBOX Live events that drive event-based user stats, leaderboards, and achievement unlocks in your title.","sidebarTitle":"Events portal config","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/events/config/live-events-config-nav"},{"title":"Portal configuration of events","description":"Create, edit, copy, and delete XBOX Live event definitions in Partner Center so your title can send telemetry that updates stats and achievements.","sidebarTitle":"Portal configuration of events","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/events/config/live-events-portal"}]}]},{"group":"Example code","pages":[{"title":"How to","description":"How-to guides for stats and leaderboard events in the XBOX Game Development Kit (XBOX Services), including sample event schemas and API usage.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/events/how-to/index"},{"title":"Events example code","description":"Sample code for writing XBOX Live events that feed event-based user stats and leaderboards through the Data Platform pipeline in GDK titles.","sidebarTitle":"Events example code","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/events/how-to/live-events-howto-nav"},{"title":"Sending an event","description":"Example XblEventsWriteInGameEvent code that writes an XBOX Live in-game event to update event-based user stats using rules configured in Partner Center.","sidebarTitle":"Sending an event","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/event-based/events/how-to/live-sending-an-event"}]}]}]},{"group":"Title-managed stats and leaderboards","pages":[{"title":"Title managed","description":"Documentation for title-managed stats and leaderboards in the XBOX Game Development Kit (XBOX Services): concepts, config, and how-to guides.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/index"},{"title":"Title-managed Stats \u0026 Leaderboards","description":"Guide to title-managed XBOX Live Stats and Leaderboards, including overview, Partner Center configuration, and XSAPI example code for GDK titles.","sidebarTitle":"Title-managed stats \u0026 leaderboards","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/live-statslb-tm-nav"},{"title":"Title-managed Stats overview","description":"How title-managed XBOX Live Stats (Stats 2017) let games send key-value stat updates to power leaderboards, featured stats, and player comparisons.","sidebarTitle":"Title-managed stats","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/live-stats-tm-overview"},{"group":"Portal config","pages":[{"title":"Config","description":"Configuration reference for title-managed stats and leaderboards in the XBOX Game Development Kit (XBOX Services), covering Partner Center setup.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/config/index"},{"title":"Title-managed Stats and Leaderboards portal config","description":"Partner Center configuration steps for title-managed XBOX Live Stats and Leaderboards, including featured stats shown on a player's GameHub.","sidebarTitle":"Title-managed stats and leaderboards","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/config/live-statslb-tm-config-nav"},{"title":"Configure title-managed Stats and Leaderboards","description":"Use Partner Center to configure title-managed XBOX Live Featured Stats and social leaderboards that appear on your title's GameHub page.","sidebarTitle":"Configuring title-managed featured","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/config/live-tm-leaderboards-portal"}]},{"group":"Example code","pages":[{"title":"How to","description":"How-to guides for title-managed stats and leaderboards in the XBOX Game Development Kit (XBOX Services), covering setup and API workflows.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/how-to/index"},{"title":"Title-managed Stats and Leaderboards example code","description":"XSAPI example code index for title-managed XBOX Live Stats and Leaderboards, including reading leaderboards and writing player stat updates.","sidebarTitle":"Title-managed stats and leaderboards","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/how-to/live-statslb-tm-howto-nav"},{"title":"Getting a title-managed leaderboard","description":"XSAPI example code for reading a title-managed XBOX Live leaderboard, including full results, around-rank views, and around-player queries.","sidebarTitle":"Getting a title-managed leaderboard","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/how-to/live-getting-tm-leaderboard"},{"title":"Writing title-managed stats","description":"XSAPI example code that calls XblTitleManagedStatsUpdateStatsAsync to selectively update a player's title-managed XBOX Live stat values.","sidebarTitle":"Writing title-managed stats","icon":"book-open","href":"/services/xbox-services/player-data/stats-leaderboards/title-managed/how-to/live-writing-tm-stats"}]}]},{"group":"Featured stats","pages":[{"title":"Featured stats","description":"XBOX Live Featured Stats documentation for GDK titles, covering overview, Partner Center configuration, and how featured user stats surface in GameHubs.","sidebarTitle":"Overview","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/featured-stats/index"},{"title":"Featured Stats","description":"Guide to XBOX Live Featured Stats (formerly Hero Stats), including how they highlight selected user stats and how to configure them in Partner Center.","sidebarTitle":"Featured stats","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/featured-stats/live-featured-stats-nav"},{"title":"Featured Stats overview","description":"How XBOX Live Featured Stats (formerly Hero Stats) let publishers surface a player's most relevant progress across the shell, GameHubs, and the XBOX app.","sidebarTitle":"Featured stats","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/featured-stats/live-featuredstats-overview"},{"group":"Portal config","pages":[{"title":"Config","description":"Configuration reference for featured stats in the XBOX Game Development Kit (XBOX Services), including Partner Center setup and display fields.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/stats-leaderboards/featured-stats/config/index"},{"title":"Featured stats portal config","description":"Partner Center configuration steps for XBOX Live Featured Stats, covering both event-based and title-managed models used in GameHub displays.","sidebarTitle":"Featured stats portal config","icon":"ranking-star","href":"/services/xbox-services/player-data/stats-leaderboards/featured-stats/config/live-featured-stats-config-nav"},{"title":"Portal configuration of title-managed Featured Stats","description":"Pointer to the Partner Center guide for configuring title-managed XBOX Live Featured Stats and social leaderboards shown on a title's GameHub.","sidebarTitle":"Portal configuration of title-managed","icon":"gauge","href":"/services/xbox-services/player-data/stats-leaderboards/featured-stats/config/live-featuredstats-tm-portal"},{"title":"Portal configuration of event-based Featured Stats","description":"Create, reorder, edit, and delete event-based XBOX Live Featured Stats in Partner Center to surface up to 20 key player stats across XBOX UI.","sidebarTitle":"Portal configuration of event-based","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/featured-stats/config/live-featuredstats-eb-portal"}]}]}]}]},{"group":"Storage","pages":[{"title":"Storage","description":"Documentation for title and connected storage in the XBOX Game Development Kit (XBOX Services). Covers concepts, tools, configuration, and workflows.","sidebarTitle":"Overview","icon":"hard-drive","href":"/services/xbox-services/storage/index"},{"title":"Cloud Storage","description":"Add XBOX services Cloud Storage to your game using Connected Storage for game state and Title Storage for player stats, assets, and cloud save data.","sidebarTitle":"Cloud storage","icon":"hard-drive","href":"/services/xbox-services/storage/live-cloud-storage-nav"},{"title":"Connected Storage VS. Title Storage","description":"Compare XBOX services Connected Storage and Title Storage to choose the right cloud save option for game state, player statistics, and shared title assets.","sidebarTitle":"Connected storage VS. title storage","icon":"cloud-arrow-up","href":"/services/xbox-services/storage/live-connected-storage-vs-title-storage"},{"title":"Connected Storage","description":"Learn how XBOX Live Connected Storage syncs gameplay saves and state data across PC and XBOX consoles, with offline access and fault-tolerant cloud sync.","sidebarTitle":"Connected storage","icon":"cloud-arrow-up","href":"/services/xbox-services/storage/connected-storage/live-connected-storage-nav"},{"group":"Title storage","pages":[{"title":"Title storage","description":"Explore XBOX services Title Storage docs: cloud storage for per-player and per-game data such as saved games, statistics, and shared title assets on XBOX.","sidebarTitle":"Overview","icon":"hard-drive","href":"/services/xbox-services/storage/title-storage/index"},{"title":"XBOX services Title Storage overview","description":"Learn what XBOX services Title Storage is, its features, storage types and quotas, throttle limits, and supported data formats for cloud game data.","sidebarTitle":"XBOX services title storage","icon":"circle-info","href":"/services/xbox-services/storage/title-storage/live-title-storage-overview"},{"group":"Portal config","pages":[{"title":"Config","description":"Reference and configuration for title storage in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/storage/title-storage/config/index"},{"title":"Configuring Title Storage in Partner Center","description":"Step-by-step guide to configuring XBOX services Title Storage in Partner Center, including storage types, visibility settings, and Global Storage uploads.","sidebarTitle":"Configuring title storage in partner","icon":"gauge","href":"/services/xbox-services/storage/title-storage/config/live-title-storage-portal-config"}]},{"group":"Example code","pages":[{"title":"How to","description":"Reference and how-to guides for title storage in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/storage/title-storage/how-to/index"},{"title":"Uploading a blob to Title Storage","description":"Flat C code sample for uploading a blob to XBOX services Title Storage using XblTitleStorageUploadBlobAsync, with block size and buffer lifetime guidance.","sidebarTitle":"Uploading a blob to title storage","icon":"hard-drive","href":"/services/xbox-services/storage/title-storage/how-to/live-uploading-title-storage-blob"},{"title":"Downloading a blob from Title Storage","description":"Flat C code sample for downloading a blob from XBOX services Title Storage using XblTitleStorageDownloadBlobAsync, with buffer sizing and block size guidance.","sidebarTitle":"Downloading a blob from title storage","icon":"download","href":"/services/xbox-services/storage/title-storage/how-to/live-downloading-title-storage-blob"},{"title":"Deleting a blob from Title Storage","description":"Flat C code sample showing how to delete a blob from XBOX services Title Storage using XblTitleStorageDeleteBlobAsync with ETag match support for cloud saves.","sidebarTitle":"Deleting a blob from title storage","icon":"hard-drive","href":"/services/xbox-services/storage/title-storage/how-to/live-deleting-title-storage-blob"},{"title":"Getting Title Storage blob metadata","description":"Flat C code example for retrieving XBOX Title Storage blob metadata with XblTitleStorageGetBlobMetadataAsync, including paging through result handles.","sidebarTitle":"Getting title storage blob metadata","icon":"book-open","href":"/services/xbox-services/storage/title-storage/how-to/live-getting-title-storage-blob-metadata"},{"title":"Get quota info for a Title Storage service configuration","description":"Flat C code sample for retrieving XBOX Title Storage quota and used bytes for a service configuration and storage type via XblTitleStorageGetQuotaAsync.","sidebarTitle":"Getting quota information for a title","icon":"sliders","href":"/services/xbox-services/storage/title-storage/how-to/live-getting-title-storage-quota-info"}]}]}]},{"group":"Develop and test","pages":[{"title":"Develop","description":"Develop XBOX Live-enabled titles with guidance on XSAPI best practices, Partner Center test accounts, and troubleshooting sign-in and services issues.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/develop/index"},{"title":"Types of error handling","description":"Common failure modes when calling XBOX Live services, including HTTP 400, 401, 403, and 503 responses, and how titles should catch and handle exceptions.","sidebarTitle":"Types of error handling","icon":"brackets-curly","href":"/services/xbox-services/develop/error-handling/live-types-of-error-handling"},{"group":"Best practices for XBOX services","pages":[{"title":"Best practices","description":"Best practices for XBOX Live services development, including XSAPI calling patterns, offline play handling, and fine-grained rate limiting guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/develop/best-practices/index"},{"title":"Best practices for calling XBOX services","description":"Guidance for calling XBOX Live services with XSAPI or REST, covering idempotent vs non-idempotent endpoints and proper retry logic for network failures.","sidebarTitle":"Best practices for calling XBOX services","icon":"note-sticky","href":"/services/xbox-services/develop/best-practices/live-best-practices-calling-xbl"},{"title":"Fine-Grained Rate Limiting","description":"Overview of XBOX services fine-grained rate limiting (FGRL), including burst and sustain limits, HTTP 429 responses, and how to detect throttling with XSTA.","sidebarTitle":"Fine-grained rate limiting","icon":"bookmark","href":"/services/xbox-services/develop/best-practices/live-fine-grained-rate-limiting"},{"title":"Best practices for handling offline play","description":"How XBOX console games should detect connectivity loss, support offline modes, and gracefully handle XBOX Live and XBOX network disconnection scenarios.","sidebarTitle":"Best practices for handling offline play","icon":"compass","href":"/services/xbox-services/develop/best-practices/live-best-practices-offline-play"}]},{"group":"Test accounts","pages":[{"title":"Test accounts","description":"Create, manage, and export XBOX test accounts in Partner Center for development sandbox testing, including adult and child accounts for XBOX Live titles.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/develop/test-accounts/index"},{"title":"XBOX test accounts","description":"Use XBOX test accounts to sign into development sandboxes, validate achievements and social scenarios, and handle child account privileges during title testing.","sidebarTitle":"XBOX test accounts","icon":"map","href":"/services/xbox-services/develop/test-accounts/live-test-accounts"},{"title":"Creating test accounts in Partner Center","description":"Step-by-step guide to creating XBOX test accounts in Partner Center, including sandbox access, adult and child account batches, and required permissions.","sidebarTitle":"Creating test accounts in partner center","icon":"gauge","href":"/services/xbox-services/develop/test-accounts/live-setup-testaccounts"},{"title":"Exporting XBOX test accounts","description":"Managed Partners can export XBOX test accounts from Partner Center to CSV; steps for importing into Excel while preserving the Xuid column as text.","sidebarTitle":"Exporting XBOX test accounts","icon":"bookmark","href":"/services/xbox-services/develop/test-accounts/live-exporting-test-accounts"}]},{"group":"Troubleshooting XBOX services","pages":[{"title":"Troubleshooting","description":"Troubleshoot XBOX Live sign-in errors, development sandbox misconfiguration on PC, and XBOX services API failures with logging and diagnostic guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/develop/troubleshooting/index"},{"title":"Troubleshooting XBOX Live Services APIs","description":"Enable XSAPI response logging and verbose debug tracing with HCSettingsSetTraceLevel to diagnose XBOX Live services REST calls and HTTP response failures.","sidebarTitle":"Troubleshooting XBOX live services APIs","icon":"triangle-exclamation","href":"/services/xbox-services/develop/troubleshooting/live-troubleshooting-apis"},{"title":"Troubleshooting Sign-in and Sandbox Errors","description":"Diagnose XBOX Live sign-in and sandbox errors on PC using XblPCSandbox, a preflight checklist, error code reference, and Partner Center configuration checks.","sidebarTitle":"Troubleshooting sign-in and sandbox","icon":"right-to-bracket","href":"/services/xbox-services/develop/troubleshooting/live-troubleshoot-sandboxes"}]}]},{"group":"Additional pages","pages":[{"title":"PlayFab integration for XBOX services titles","sidebarTitle":"PlayFab integration","description":"Sign players in to XBOX services and PlayFab, provision linked accounts, and wire up Microsoft Store in-app purchase via PlayFab economy for GDK titles.","icon":"puzzle-piece","keywords":["PlayFab","GDK","sign in","authentication","PlayFab Party","PlayFab Services SDK","Microsoft Store","in-app purchase","ConsumeMicrosoftStoreEntitlements","XUser"],"related":["/xbox-services/identity","/xbox-services/multiplayer","/xbox-services/game-chat","/xbox-services/multiplayer-activity"],"href":"/services/xbox-services/playfab-integration"},{"group":"Community","pages":[{"group":"People system","pages":[{"title":"People System (Friends List)","description":"Guide to the XBOX Live People System, covering friends list functionality, one-way and two-way relationships, concepts, and code samples.","sidebarTitle":"People system (friends list)","icon":"users","href":"/services/xbox-services/community/people-system/live-people-system-nav"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for people system and social graph in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/community/people-system/concepts/index"},{"title":"People System (Friends List) concepts","description":"Conceptual topics for the XBOX Live People System (Friends List), including the code flow for displaying friends and other player data in your title.","sidebarTitle":"People system (friends list) concepts","icon":"users","href":"/services/xbox-services/community/people-system/concepts/live-people-system-concepts-nav"}]},{"group":"How to","pages":[{"title":"People System (Friends List) example code","description":"Sample code index for the XBOX Live People System covering retrieving social relationships and handling friends list change notifications via XSAPI.","sidebarTitle":"People system (friends list) example","icon":"code","href":"/services/xbox-services/community/people-system/how-to/live-pplsys-howto-nav"}]}]},{"group":"Reputation","pages":[{"title":"Reputation","description":"Section index for XBOX Live Reputation, linking to the overview, service concepts, and example code for reporting positive and negative player feedback.","sidebarTitle":"Reputation","icon":"clipboard-list","href":"/services/xbox-services/community/reputation/live-reputation-nav"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for player reputation in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/community/reputation/concepts/index"},{"title":"Reputation concepts","description":"Conceptual topics for the XBOX Live Reputation service, including how titles send player feedback that shapes the reputation of XBOX members.","sidebarTitle":"Reputation concepts","icon":"lightbulb","href":"/services/xbox-services/community/reputation/concepts/live-reputation-concepts-nav"}]}]},{"group":"Social manager","pages":[{"title":"Social Manager","description":"Guide to the XBOX services Social Manager API, with the overview and concept topics for tracking online friends and their gaming activity.","sidebarTitle":"Social manager","icon":"users","href":"/services/xbox-services/community/social-manager/live-social-manager-nav"},{"group":"Concepts","pages":[{"title":"Social Manager concepts","description":"Conceptual topics for the XBOX services Social Manager API, covering privilege codes and memory and performance considerations for the social graph.","sidebarTitle":"Social manager concepts","icon":"users","href":"/services/xbox-services/community/social-manager/concepts/live-socmgr-concepts-nav"}]}]}]},{"group":"Fundamentals","pages":[{"group":"Identity","pages":[{"group":"Auth","pages":[{"title":"User sign-in","description":"Overview of XBOX services user sign-in, account access, and identity APIs including XAL and XUser for GDK and cross-platform title development.","sidebarTitle":"User sign-in","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/identity/auth/live-authentication-nav"}]},{"group":"Privacy","pages":[{"title":"Privacy","description":"XBOX services privacy topics for game developers, covering permission checks, mute and avoid lists, and cross-network communication rules via XSAPI.","sidebarTitle":"Overview","icon":"lock","href":"/services/xbox-services/fundamentals/identity/privacy/index"},{"title":"Privacy and permissions","description":"Section index for XBOX services privacy settings and permission checks that titles use to gate voice, text, and video communication between players.","sidebarTitle":"Privacy and permissions","icon":"user-shield","href":"/services/xbox-services/fundamentals/identity/privacy/live-privacy-permissions-nav"}]},{"group":"Privileges","pages":[{"title":"Privileges","description":"XBOX services privileges hub covering concepts, client and server checks, and Partner Center configuration that gate features like multiplayer and streaming.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/identity/privileges/index"},{"title":"Privileges","description":"Section index for XBOX services user privileges, linking to overview, concepts, and Partner Center configuration articles that shape player access.","sidebarTitle":"Privileges","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/identity/privileges/live-privileges-nav"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for identity and privileges in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/fundamentals/identity/privileges/concepts/index"},{"title":"XBOX services user privileges","description":"Concept articles that explain how XBOX services user privileges are checked client-side and enforced server-side through XSTS tokens and claims.","sidebarTitle":"XBOX services user privileges","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/identity/privileges/concepts/live-privileges-concepts-nav"}]},{"group":"Config","pages":[{"title":"Config","description":"Reference and configuration for identity and privileges in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/fundamentals/identity/privileges/config/index"},{"title":"Privileges configuration in Partner Center","description":"Index for configuring XBOX services user privileges in Partner Center, covering broadcasting rules and multiplayer access settings that affect players.","sidebarTitle":"Privileges configuration in partner","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/identity/privileges/config/live-privileges-config-nav"}]}]},{"group":"User profile","pages":[{"title":"User profile","description":"XBOX services user profile hub, covering gamertags and profile data that titles can retrieve to represent players in menus, rosters, and social features.","sidebarTitle":"Overview","icon":"id-card","href":"/services/xbox-services/fundamentals/identity/user-profile/index"},{"title":"User profile","description":"Section index for XBOX services user profile topics, linking gamertags articles and details about how titles display player identity and reputation.","sidebarTitle":"User profile","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/identity/user-profile/live-user-profile-toc"},{"group":"Gamertags","pages":[{"title":"Gamertags","description":"Table of contents for XBOX gamertag topics, from classic gamertag basics to modern gamertag definitions, UTF-8 ranges, testing, and backwards compatibility.","sidebarTitle":"Gamertags","icon":"right-to-bracket","href":"/services/xbox-services/fundamentals/identity/user-profile/gamertags/live-modern-gamertags-toc"}]}]}]},{"group":"Rta","pages":[{"title":"Real-Time Activity (RTA) service","description":"Section index for the XBOX Real-Time Activity (RTA) service, linking the overview, conceptual articles, and XSAPI example code for stat subscriptions.","sidebarTitle":"Real-time activity (rta) service","icon":"lightbulb","href":"/services/xbox-services/fundamentals/rta/live-rta-nav"},{"group":"Concepts","pages":[{"title":"Real-Time Activity (RTA) service concepts","description":"Conceptual articles for the XBOX Real-Time Activity (RTA) service, including registering for player stat change notifications and connection best practices.","sidebarTitle":"Real-time activity (rta) service","icon":"lightbulb","href":"/services/xbox-services/fundamentals/rta/concepts/live-rta-concepts-nav"}]},{"group":"How to","pages":[{"title":"Real-Time Activity (RTA) service example code","description":"How-to examples for calling the XBOX Real-Time Activity (RTA) service, including registering statistic change handlers and unregistering with XSAPI.","sidebarTitle":"Real-time activity (rta) service","icon":"code","href":"/services/xbox-services/fundamentals/rta/how-to/live-rta-howto-nav"}]}]},{"group":"Sandboxes","pages":[{"title":"Sandboxes","description":"Index of XBOX Live sandbox topics covering sandbox setup, IDs, isolating development content, and pulling save files from the CERT sandbox.","sidebarTitle":"Sandboxes","icon":"lightbulb","href":"/services/xbox-services/fundamentals/sandboxes/live-sandboxes-nav"}]}]},{"group":"Multiplayer","pages":[{"group":"Chat","pages":[{"title":"Chat","description":"Overview of chat features in the Microsoft Game Development Kit, covering Game Chat 2 and PlayFab Party voice and text chat implementation options.","sidebarTitle":"Chat","icon":"users-line","href":"/services/xbox-services/multiplayer/chat/gc-chat-toc"},{"group":"Game chat2","pages":[{"title":"Game Chat 2 overview","description":"Learn how the Game Chat 2 tool adds voice and text chat to your XBOX GDK game while respecting each player's privacy settings and platform policies.","sidebarTitle":"Game chat 2","icon":"comments","href":"/services/xbox-services/multiplayer/chat/game-chat2/game-chat-2-overview"}]}]},{"group":"Concepts","pages":[{"title":"Multiplayer concepts","description":"Configure and implement XBOX multiplayer services, with topics on session templates, MPSD, roles, session browse, arbiter migration, and XR-007 examples.","sidebarTitle":"Multiplayer concepts","icon":"users-line","href":"/services/xbox-services/multiplayer/concepts/live-multiplayer-concepts-nav"}]},{"group":"Invites","pages":[{"title":"Invite players to game sessions","description":"Invite players to XBOX game sessions with conceptual guidance, invite flow diagrams, and code samples for sending and receiving multiplayer invites.","sidebarTitle":"Invite players to game sessions","icon":"people-group","href":"/services/xbox-services/multiplayer/invites/live-invites-nav"},{"group":"Concepts","pages":[{"title":"Invites concepts","description":"Conceptual information about XBOX multiplayer invites, including invite flow diagrams and support across XBOX One SDK and Microsoft GDK title versions.","sidebarTitle":"Invites concepts","icon":"users-line","href":"/services/xbox-services/multiplayer/invites/concepts/live-invites-concepts-nav"}]},{"group":"How to","pages":[{"title":"Invites example code","description":"Example code and how-to guides for sending and receiving XBOX multiplayer game invites, including registering for multiplayer protocol and invite callbacks.","sidebarTitle":"Invites example code","icon":"users-line","href":"/services/xbox-services/multiplayer/invites/how-to/live-invites-howto-nav"}]}]},{"group":"Matchmaking","pages":[{"title":"SmartMatch matchmaking","description":"Learn how XBOX SmartMatch matchmaking selects compatible players, groups them into game sessions, and is configured in Partner Center for your title.","sidebarTitle":"Smartmatch matchmaking","icon":"shuffle","href":"/services/xbox-services/multiplayer/matchmaking/live-matchmaking-nav"},{"group":"Concepts","pages":[{"title":"Matchmaking concepts","description":"SmartMatch matchmaking concepts for XBOX, including how players are grouped, target session initialization, and Quality of Service checks between peers.","sidebarTitle":"Matchmaking concepts","icon":"shuffle","href":"/services/xbox-services/multiplayer/matchmaking/concepts/live-matchmaking-concepts-nav"}]},{"group":"Config","pages":[{"title":"Matchmaking portal configuration","description":"Configure XBOX SmartMatch matchmaking in Partner Center, including session template setup and hopper rules for selecting compatible multiplayer players.","sidebarTitle":"Matchmaking portal configuration","icon":"shuffle","href":"/services/xbox-services/multiplayer/matchmaking/config/live-matchmaking-config-nav"}]}]},{"group":"Mpa","pages":[{"title":"Multiplayer Activity (MPA)","description":"Explore XBOX Multiplayer Activity (MPA) features, concepts, and example code for advertising activities, sending invites, and tracking recent players.","sidebarTitle":"Multiplayer activity (mpa)","icon":"users-line","href":"/services/xbox-services/multiplayer/mpa/live-mpa-nav"},{"group":"Concepts","pages":[{"title":"Multiplayer Activity (MPA) concepts","description":"Multiplayer Activity (MPA) concepts for XBOX, including activities, invites, recent players, PlayFab Lobby integration, and MPA troubleshooting guidance.","sidebarTitle":"Multiplayer activity (mpa) concepts","icon":"lightbulb","href":"/services/xbox-services/multiplayer/mpa/concepts/live-mpa-concepts-nav"}]},{"group":"How to","pages":[{"title":"Multiplayer Activity example code","description":"Example code for XBOX Multiplayer Activity, including setting, updating, and deleting activities, sending invites, and posting recent player interactions.","sidebarTitle":"Multiplayer activity example code","icon":"code","href":"/services/xbox-services/multiplayer/mpa/how-to/live-mpa-how-to-nav"}]}]},{"group":"Mpm","pages":[{"title":"Multiplayer Manager (MPM)","description":"Landing page for Multiplayer Manager (MPM), a high-level XBOX Live API for sessions, matchmaking, and invites with a state- and event-based model.","sidebarTitle":"Multiplayer manager (mpm)","icon":"users-line","href":"/services/xbox-services/multiplayer/mpm/live-multiplayer-manager-nav"},{"group":"Concepts","pages":[{"title":"Multiplayer Manager concepts","description":"Conceptual information about XBOX Multiplayer Manager (MPM), including an API overview and flowcharts for implementing common multiplayer scenarios.","sidebarTitle":"Multiplayer manager concepts","icon":"users-line","href":"/services/xbox-services/multiplayer/mpm/concepts/live-mm-concepts-nav"},{"group":"Flowcharts","pages":[{"title":"Multiplayer Manager flowcharts","description":"Flowcharts of Multiplayer Manager (MPM) scenarios for XBOX, including matchmaking, invites, protocol activation, host migration, and session shutdown.","sidebarTitle":"Multiplayer manager flowcharts","icon":"users-line","href":"/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mm-flowcharts-nav"}]}]},{"group":"How to","pages":[{"title":"Multiplayer Manager example code","description":"Example code for XBOX Multiplayer Manager scenarios, including playing with friends, SmartMatch matchmaking, sending game invites, and protocol activation.","sidebarTitle":"Multiplayer manager example code","icon":"code","href":"/services/xbox-services/multiplayer/mpm/how-to/live-mm-howto-nav"}]}]},{"group":"Mpsd","pages":[{"title":"Multiplayer Session Directory (MPSD)","description":"Landing page for Multiplayer Session Directory (MPSD) topics that describe how to share session state and coordinate XBOX Live invites and gamercard joins.","sidebarTitle":"Multiplayer session directory (mpsd)","icon":"people-group","href":"/services/xbox-services/multiplayer/mpsd/live-mpsd-nav"},{"group":"Concepts","pages":[{"title":"Multiplayer Session Directory (MPSD) concepts","description":"Index of Multiplayer Session Directory (MPSD) concepts including session templates, visibility, joinability, large sessions, and troubleshooting guides.","sidebarTitle":"Multiplayer session directory (mpsd)","icon":"lightbulb","href":"/services/xbox-services/multiplayer/mpsd/concepts/live-mpsd-concepts-nav"}]},{"group":"How to","pages":[{"title":"Multiplayer Session Directory (MPSD) example code","description":"Index of MPSD example code and task walkthroughs, including 2015 Multiplayer implementation steps and reference tables for session status codes.","sidebarTitle":"Multiplayer session directory (mpsd)","icon":"people-group","href":"/services/xbox-services/multiplayer/mpsd/how-to/live-mpsd-howto-nav"}]}]},{"group":"Overviews","pages":[{"title":"XBOX services for matchmaking, invites, chat, and networking","description":"Navigate XBOX services multiplayer topics: MPSD, Multiplayer Manager, Multiplayer Activity, matchmaking, invites, voice and text chat, and networking guides.","sidebarTitle":"XBOX services for matchmaking, invites,","icon":"shuffle","href":"/services/xbox-services/multiplayer/overviews/live-multiplayer-nav"}]}]},{"group":"Player data","pages":[{"title":"Player Data","description":"Section entry for XBOX Live Player Data, spanning user stats, leaderboards, achievements, featured stats, and experience design guidance.","sidebarTitle":"Player data","icon":"database","href":"/services/xbox-services/player-data/live-playerdata-nav"},{"group":"Achievements","pages":[{"title":"Achievements","description":"XBOX Live Achievements documentation covering event-based and title-managed models, the Achievements Manager, and user achievement systems for GDK titles.","sidebarTitle":"Overview","icon":"trophy","href":"/services/xbox-services/player-data/achievements/index"},{"title":"Event-based vs. title-managed Achievements","description":"Compare event-based (Achievements 2013) and title-managed (Achievements 2017) XBOX Live systems to choose the right unlock model for your title.","sidebarTitle":"Event-based vs. title-managed","icon":"trophy","href":"/services/xbox-services/player-data/achievements/live-achievements-eb-vs-tm"},{"title":"User achievements systems","description":"Overview of the ways to track and manage XBOX Live user achievements, including event-based, title-managed, and Achievements Manager options.","sidebarTitle":"User achievements systems","icon":"user","href":"/services/xbox-services/player-data/achievements/live-achievements-nav"},{"group":"Achievements manager","pages":[{"title":"Achievements manager","description":"Landing page for the XBOX Achievements Manager API, which simplifies tracking and updating XBOX Live user achievement state for GDK titles.","sidebarTitle":"Overview","icon":"trophy","href":"/services/xbox-services/player-data/achievements/achievements-manager/index"},{"title":"Achievements Manager","description":"Section entry for the XBOX Live Achievements Manager API, which keeps user achievement state current for XBOX game titles using XSAPI.","sidebarTitle":"Achievements manager","icon":"trophy","href":"/services/xbox-services/player-data/achievements/achievements-manager/live-achievements-manager-nav"},{"title":"Overview of the XBOX Achievements Manager API","description":"How the XBOX Achievements Manager API in XSAPI simplifies polling, RTA subscriptions, and up-to-date state for a user's XBOX Live achievements.","sidebarTitle":"Overview of the XBOX achievements","icon":"circle-info","href":"/services/xbox-services/player-data/achievements/achievements-manager/live-achievements-manager-overview"}]},{"group":"Event based","pages":[{"title":"Event based","description":"Documentation for event-based flow covering achievements in the XBOX Game Development Kit (XBOX Services). Covers concepts, tools, configuration, and workflows.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/achievements/event-based/index"},{"title":"Event-based Achievements","description":"Learn the event-based XBOX Live Achievements service, which uses Data Platform telemetry and stat rules to track and unlock player achievements.","sidebarTitle":"Event-based achievements","icon":"trophy","href":"/services/xbox-services/player-data/achievements/event-based/live-achievements-eb-nav"},{"title":"Overview of event-based Achievements","description":"How the event-based XBOX Live Achievements service uses Data Platform telemetry and user statistics to unlock achievements without direct API calls.","sidebarTitle":"Overview of event-based achievements","icon":"circle-info","href":"/services/xbox-services/player-data/achievements/event-based/live-achievements-eb-overview"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for event-based flow covering achievements in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/player-data/achievements/event-based/concepts/index"},{"title":"Event-based achievements concepts","description":"Conceptual guidance for designing event-based XBOX Live achievements, including scenarios, stat rules, and cross-platform progression.","sidebarTitle":"Event-based achievements concepts","icon":"trophy","href":"/services/xbox-services/player-data/achievements/event-based/concepts/live-achievements-eb-concepts-nav"},{"title":"Scenarios for creating event-based achievements","description":"Common patterns for event-based XBOX Live achievements, covering AND/OR logic, repeated actions, collections, personal bests, and Boolean flags.","sidebarTitle":"Scenarios for creating event-based","icon":"lightbulb","href":"/services/xbox-services/player-data/achievements/event-based/concepts/live-achievements-scenarios"}]},{"group":"Config","pages":[{"title":"Config","description":"Reference and configuration for event-based flow covering achievements in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/achievements/event-based/config/index"},{"title":"Event-based achievements portal configuration","description":"Guides for adding and updating event-based XBOX Live achievements and challenges in Partner Center service configuration for your title.","sidebarTitle":"Event-based achievements portal","icon":"trophy","href":"/services/xbox-services/player-data/achievements/event-based/config/live-achievements-eb-config-nav"},{"title":"Portal configuration of event-based Achievements","description":"Use Partner Center to create, edit, and delete event-based XBOX Live achievements driven by player stat rules and service-side unlock logic.","sidebarTitle":"Portal configuration of event-based","icon":"gauge","href":"/services/xbox-services/player-data/achievements/event-based/config/live-achievements-eb-portal"},{"title":"Portal configuration of event-based Challenges","description":"Add and change time-limited XBOX Live challenges in Partner Center for event-based Achievements, using player stat values to trigger unlocks.","sidebarTitle":"Portal configuration of event-based","icon":"sliders","href":"/services/xbox-services/player-data/achievements/event-based/config/live-challenges-eb-portal"}]},{"group":"How to","pages":[{"title":"How to","description":"Reference and how-to guides for event-based flow covering achievements in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/achievements/event-based/how-to/index"},{"title":"Event-based achievements example code","description":"Example code snippets for event-based XBOX Live achievements, including reading achievement state and writing events that drive unlocks.","sidebarTitle":"Event-based achievements example code","icon":"trophy","href":"/services/xbox-services/player-data/achievements/event-based/how-to/live-achievements-eb-howto-nav"},{"title":"Getting event-based achievements","description":"Retrieve event-based XBOX Live achievements using the same XSAPI calls used for title-managed achievements, with links to sample get code.","sidebarTitle":"Getting event-based achievements","icon":"book-open","href":"/services/xbox-services/player-data/achievements/event-based/how-to/live-getting-event-based-achievements"},{"title":"Writing an event to power an event-based achievement","description":"Sample XblEventsWriteInGameEvent code that fires a game event so XBOX Live stat rules update stats and unlock event-based achievements.","sidebarTitle":"Writing an event to power an","icon":"trophy","href":"/services/xbox-services/player-data/achievements/event-based/how-to/live-writing-event-based-achievement"}]}]},{"group":"Title managed","pages":[{"title":"Title managed","description":"Documentation for title-managed achievements in the XBOX Game Development Kit (XBOX Services): concepts, configuration, and how-to guides.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/achievements/title-managed/index"},{"title":"Title-managed Achievements","description":"Overview, concepts, Partner Center configuration, and XSAPI example code for building title-managed XBOX Live Achievements in your game.","sidebarTitle":"Title-managed achievements","icon":"trophy","href":"/services/xbox-services/player-data/achievements/title-managed/live-achievements-tm-nav"},{"title":"Title-managed Achievements overview","description":"Introduction to title-managed XBOX Live Achievements, including reward types like gamerscore, art, maps, characters, and stat boosts for players.","sidebarTitle":"Title-managed achievements","icon":"circle-info","href":"/services/xbox-services/player-data/achievements/title-managed/live-achievements-tm-overview"},{"group":"Concepts","pages":[{"title":"Concepts","description":"Reference and concepts for title-managed flow covering achievements in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"lightbulb","href":"/services/xbox-services/player-data/achievements/title-managed/concepts/index"},{"title":"Configure XBOX achievement rewards","description":"Configure rewards for a title-managed XBOX Live achievement, including gamerscore, digital art, and in-app rewards used to drive player engagement.","sidebarTitle":"Configure XBOX achievement rewards","icon":"trophy","href":"/services/xbox-services/player-data/achievements/title-managed/concepts/live-achievement-rewards"},{"title":"Title-managed Achievements concepts","description":"Concepts for title-managed XBOX Live Achievements, including how to configure gamerscore, digital art, and in-app rewards for player unlocks.","sidebarTitle":"Title-managed achievements concepts","icon":"lightbulb","href":"/services/xbox-services/player-data/achievements/title-managed/concepts/live-achievements-tm-concepts-nav"}]},{"group":"Config","pages":[{"title":"Config","description":"Reference and configuration for title-managed flow covering achievements in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/achievements/title-managed/config/index"},{"title":"Configuring title-managed Achievements in Partner Center","description":"Use Partner Center to add, edit, and localize title-managed XBOX Live Achievements, including names, descriptions, images, and reward configuration.","sidebarTitle":"Configuring title-managed achievements","icon":"gauge","href":"/services/xbox-services/player-data/achievements/title-managed/config/live-achievements-tm-config"},{"title":"Title-managed Achievements portal config","description":"Steps for configuring title-managed XBOX Live Achievements in Partner Center, including reward setup so titles can unlock achievements directly.","sidebarTitle":"Title-managed achievements portal config","icon":"trophy","href":"/services/xbox-services/player-data/achievements/title-managed/config/live-achievements-tm-config-nav"}]},{"group":"How to","pages":[{"title":"How to","description":"Reference and how-to guides for title-managed flow covering achievements in the XBOX Game Development Kit (XBOX Services). Includes concepts and API guidance.","sidebarTitle":"Overview","icon":"folder-open","href":"/services/xbox-services/player-data/achievements/title-managed/how-to/index"},{"title":"Title-managed Achievements example code","description":"How-to code samples that use the title-managed XBOX Live Achievements XSAPI to read achievement lists and update player achievement progress.","sidebarTitle":"Title-managed achievements example code","icon":"trophy","href":"/services/xbox-services/player-data/achievements/title-managed/how-to/live-achievements-howto-nav"},{"title":"Getting title-managed Achievements","description":"Sample XSAPI code to retrieve a player's title-managed XBOX Live achievements list, page through results, and fetch a single achievement by ID.","sidebarTitle":"Getting title-managed achievements","icon":"book-open","href":"/services/xbox-services/player-data/achievements/title-managed/how-to/live-how-to-get-achievements"},{"title":"Updating title-managed Achievements","description":"Example XSAPI code showing how to unlock a title-managed XBOX Live achievement or report completion progress with XblAchievementsUpdateAchievementAsync.","sidebarTitle":"Updating title-managed achievements","icon":"trophy","href":"/services/xbox-services/player-data/achievements/title-managed/how-to/live-how-to-update-achievements"}]}]}]},{"group":"Stats leaderboards","pages":[{"title":"Stats and Leaderboards","description":"Section entry for working with XBOX Live user stats and leaderboards, spanning event-based, title-managed, and featured stats implementations.","sidebarTitle":"Stats and leaderboards","icon":"chart-line","href":"/services/xbox-services/player-data/stats-leaderboards/live-stats-leaderboards-nav"}]}]},{"group":"Storage","pages":[{"group":"Title storage","pages":[{"title":"Title Storage","description":"Overview of XBOX services Title Storage: cloud storage for player statistics and title assets, plus Partner Center configuration and flat C code samples.","sidebarTitle":"Title storage","icon":"hard-drive","href":"/services/xbox-services/storage/title-storage/live-title-storage-nav"},{"group":"Config","pages":[{"title":"Title Storage portal configuration","description":"Overview of configuring XBOX Title Storage in Partner Center, covering storage types, cloud save settings, and Global Storage file management options.","sidebarTitle":"Title storage portal configuration","icon":"hard-drive","href":"/services/xbox-services/storage/title-storage/config/live-title-storage-config-nav"}]},{"group":"How to","pages":[{"title":"Title Storage example code","description":"Flat C example code index for common XBOX services Title Storage tasks: uploading, downloading, deleting blobs, reading metadata, and checking quota usage.","sidebarTitle":"Title storage example code","icon":"code","href":"/services/xbox-services/storage/title-storage/how-to/live-title-storage-howto-nav"}]}]}]}]}]},{"group":"PlayFab","pages":[{"group":"PlayFab fundamentals","icon":"rocket","pages":[{"title":"PlayFab fundamentals","description":"Explore PlayFab documentation covering identity, live service management, economy, multiplayer, community, analytics, and Foundation Mode onboarding.","sidebarTitle":"PlayFab fundamentals","href":"/services/playfab/get-started/index"},{"title":"What is PlayFab?","description":"Learn how PlayFab, the complete Azure-backed backend platform, provides managed game services, real-time analytics, and LiveOps tools for live games.","sidebarTitle":"Overview","href":"/services/playfab/get-started/what-is-playfab"},{"title":"PlayFab concepts","description":"Learn core PlayFab building blocks including namespaces, titles, entities, developer identity, Game Manager, and PlayStream for game backend architecture.","sidebarTitle":"Concepts","href":"/services/playfab/get-started/concepts"},{"title":"Foundation Mode overview","description":"Foundation Mode gives eligible XBOX developers free PlayFab access, including identity, multiplayer, progression, economy, and community backend services.","sidebarTitle":"Foundation Mode overview","href":"/services/playfab/get-started/mode-overview"},{"title":"Foundation Mode onboarding","description":"Set up PlayFab Foundation Mode for your XBOX game: request preview access in Game Manager, create a title, and link your Partner Center account.","sidebarTitle":"Foundation Mode onboarding","href":"/services/playfab/get-started/foundation-onboarding"}]},{"group":"PlayFab services","icon":"layer-group","expanded":true,"pages":[{"group":"Identity","icon":"id-card","expanded":false,"pages":[{"title":"PlayFab Identity documentation","description":"Overviews, quickstarts, and tutorials for PlayFab player login, developer accounts, session tickets, and platform-specific authentication in Game Manager.","sidebarTitle":"Identity","href":"/services/playfab/identity/index"},{"title":"Identity overview page","description":"Overview of PlayFab Identity for managing player accounts, cross-platform authentication, linked login providers, and unified player profiles.","sidebarTitle":"Overview","href":"/services/playfab/identity/identity-overview"},{"group":"Player identity","expanded":false,"pages":[{"title":"Authentication","description":"Overview of PlayFab player authentication, supported login providers, account linking, and recoverable versus anonymous sign-in mechanisms for games.","sidebarTitle":"Overview","href":"/services/playfab/identity/player-identity/authentication/index"},{"group":"Player login","expanded":false,"pages":[{"title":"Player Login","description":"Overview of PlayFab player login options, including anonymous and recoverable login providers, session tickets, and how to authenticate players in-game.","sidebarTitle":"Overview","href":"/services/playfab/identity/player-identity/login/index"},{"title":"Login basics and best Practices","description":"Understand PlayFab player login options, anonymous versus recoverable sign-in mechanisms, and best practices for choosing an authentication method.","sidebarTitle":"Login basics and Best Practices","href":"/services/playfab/identity/player-identity/login/login-basics-best-practices"},{"title":"Handling Multiple PlayFab Logins","description":"Use PlayFab SDK instanced API classes to manage multiple concurrent player logins from a single client or server without conflicting static state.","sidebarTitle":"Handling multiple logins","href":"/services/playfab/identity/player-identity/login/multiple-logins"},{"title":"Account linking quickstart","description":"Link a PlayFab player account to multiple devices and login methods, adding recoverable sign-ins like username, Facebook, or Google to anonymous accounts.","sidebarTitle":"Quickstart","href":"/services/playfab/identity/player-identity/login/quickstart"}]},{"group":"Platform-specific authentication","expanded":false,"pages":[{"title":"Platform-Specific Authentication","description":"Overview of PlayFab platform-specific authentication providers, including Apple, Google, Steam, XBOX, PlayStation, Battle.net, and other player sign-in options.","sidebarTitle":"Overview","href":"/services/playfab/identity/player-identity/platform-specific-authentication/index"},{"title":"Running an HTTP server for testing","description":"How to install Node.js http-server and serve static HTML files locally so you can follow PlayFab authentication tutorials for Facebook, Google, or Twitch.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/running-an-http-server-for-testing"},{"title":"Set up Sign In with Battle.net for PlayFab","description":"Configure PlayFab authentication with Battle.net using HTML5 and JavaScript, including Blizzard app setup, OAuth flow, and player sign-in integration.","sidebarTitle":"Setting up PlayFab authentication using Battle.net and HTML5","href":"/services/playfab/identity/player-identity/platform-specific-authentication/battlenet-login"},{"title":"Setting up PlayFab authentication using Facebook and HTML5","description":"Step-by-step tutorial for adding Facebook login to a PlayFab title with HTML5 and JavaScript, covering Facebook app registration and player authentication.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/facebook-html5"},{"title":"Setting up PlayFab authentication using Facebook and Unity","description":"Step-by-step tutorial for integrating Facebook login into a Unity project with the PlayFab SDK, covering Facebook app setup and player authentication code.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/facebook-unity"},{"title":"Setting up PlayFab authentication using Google and HTML5","description":"Step-by-step tutorial for adding Google sign-in to a PlayFab title using HTML5 and JavaScript, covering Google API setup and OAuth player authentication.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/google-html5"},{"title":"PlayFab auth with Google Play Games Sign-In in Unity","description":"Step-by-step tutorial for adding Google Play Games Sign-In to a Unity project with the PlayFab SDK, covering Play Console setup and player authentication.","sidebarTitle":"Setting up PlayFab authentication using Google Play Games Sign-In in Unity","href":"/services/playfab/identity/player-identity/platform-specific-authentication/google-sign-in-unity"},{"group":"Migrating from Google Sign-in to Google Play Games Sign-in in Unity","expanded":false,"pages":[{"title":"Migrate from Google Sign-in to Google Play Games in Unity","description":"Detailed migration steps for switching Unity players from Google Account sign-in to LoginWithGooglePlayGamesServices, including linking and verification.","sidebarTitle":"Migration Steps","href":"/services/playfab/identity/player-identity/platform-specific-authentication/google-play-games-sign-in-migration-details"},{"title":"Google Sign-in to Play Games sign-in migration fallback","description":"Fallback method for players that are still not using Google Play Games identity after upgrading Play Games Plugin for Unity plugin.","sidebarTitle":"Migration Fallback","href":"/services/playfab/identity/player-identity/platform-specific-authentication/google-play-games-sign-in-migration-fallback"}]},{"title":"Setting up PlayFab authentication using Kongregate and HTML5","description":"Step-by-step tutorial for adding Kongregate authentication to a PlayFab title with HTML5 and JavaScript, covering Kongregate app upload and player login.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/kongregate-html5"},{"title":"Setting up PlayFab authentication using Kongregate and Unity","description":"Step-by-step tutorial for adding Kongregate authentication to a PlayFab title in Unity with WebGL, covering Kongregate app upload and player sign-in code.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/kongregate-unity"},{"title":"Setting up PlayFab authentication using Steam and Unity","description":"Step-by-step tutorial for adding Steam sign-in to a Unity game with the PlayFab SDK and Steamworks, covering AppID setup and player authentication code.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/steam-unity"},{"title":"Setting up PlayFab authentication using Twitch and HTML5","description":"Step-by-step tutorial for adding Twitch login to a PlayFab title with HTML5 and JavaScript, covering Twitch app registration and OAuth player authentication.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/twitch-html5"},{"title":"Set up PlayFab authentication with UWP apps","description":"Step-by-step tutorial for adding PlayFab authentication to a Universal Windows Platform app using Windows Hello for account creation and player sign-in.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/uwp"},{"title":"XBOX Live Title Association","description":"Configure scoped XBOX Live token validation in PlayFab by linking your Partner Center product ID to a title ID for LoginWithXbox and related APIs.","sidebarTitle":"Setting up XBOX Live title association in PlayFab","href":"/services/playfab/identity/player-identity/platform-specific-authentication/xbox-live-add-on"},{"title":"Integrating the Universal Windows Platform with PlayFab","description":"Integrate a Universal Windows Platform app with PlayFab by linking a Windows Hello account, signing in players, and validating Windows Store purchases.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/uwp-integration"},{"title":"Server Anonymous Login Authentication","description":"Set up PlayFab anonymous login with server-side player creation using CustomID authentication, protecting HTML5 and JavaScript titles from unauthorized signups.","sidebarTitle":"Setting up PlayFab Authentication using Anonymous Login","href":"/services/playfab/identity/player-identity/platform-specific-authentication/anonymous-login"},{"title":"Migrate Unity games to Google Play Games Sign-in","description":"Overview of migrating Unity Android players from PlayFab's LoginWithGoogleAccount API to Google Play Games Sign-In and updated Play Games Plugin versions.","sidebarTitle":"Migrating from Google Sign-in to Google Play Games Sign-In in Unity","href":"/services/playfab/identity/player-identity/platform-specific-authentication/google-play-games-sign-in-migration"},{"group":"Apple Open ID","pages":[{"title":"Set up Sign In with Apple for PlayFab","description":"Set up Sign in with Apple for PlayFab, including Application Identifier setup, Apple certificates, and OpenID configuration for player authentication.","href":"/services/playfab/identity/player-identity/platform-specific-authentication/apple-open-id/overview"}]}]},{"group":"Player encryption","expanded":false,"pages":[{"title":"Player Encryption Services","description":"Learn about PlayFab player shared secrets, title public keys, and RSA-encrypted registration payloads used to secure account creation and client login requests.","sidebarTitle":"Player encryption services","href":"/services/playfab/identity/player-identity/encryption/player-encryption-services"},{"title":"Encrypted Logins","description":"Enable custom encryption for PlayFab client login API calls to protect authentication payloads and strengthen application security against tampering.","href":"/services/playfab/identity/player-identity/encryption/encrypted-logins"}]}]},{"group":"Developer identity","expanded":false,"pages":[{"title":"Creating a PlayFab Account","description":"Step-by-step guide to creating a PlayFab developer account so you can access Game Manager, register a title, and begin calling PlayFab APIs.","sidebarTitle":"Create a PlayFab Account","href":"/services/playfab/identity/dev-identity/pfab-account"},{"group":"Authentication","expanded":false,"pages":[{"title":"Microsoft Accounts Authentication for PlayFab","description":"Learn how to sign up for PlayFab with a Microsoft Account, invite new Microsoft-authenticated users to your studio, and use Entra ID sign-in for Game Manager.","sidebarTitle":"Microsoft Entra ID Authentication for Game Manager","href":"/services/playfab/identity/dev-identity/authentication/aad-authentication"},{"title":"Microsoft Entra ID authentication for PlayFab APIs","description":"Authenticate to PlayFab Admin, Server, and entity APIs with Microsoft Entra ID delegated tokens using OAuth 2.0 flows like PKCE, device code, or implicit grant.","sidebarTitle":"Microsoft Entra ID Authentication for PlayFab APIs","href":"/services/playfab/identity/dev-identity/authentication/entra-id-api-authentication"},{"title":"Two-Factor Authentication","description":"Add an extra layer of security to your PlayFab Game Manager account by pairing an authenticator app on your device to enable two-factor sign-in verification.","sidebarTitle":"Two factor authentication","href":"/services/playfab/identity/dev-identity/authentication/two-factor-authentication"}]},{"group":"Permissions","expanded":false,"pages":[{"title":"PlayFab User Roles","description":"Create User Roles in PlayFab Game Manager, assign fine-grained permissions per title, and manage studio access for admins, support, and product teams.","sidebarTitle":"PlayFab user roles","href":"/services/playfab/identity/dev-identity/permissions/playfab-user-roles"}]}]}]},{"group":"Live service management","icon":"sliders","expanded":false,"pages":[{"title":"Live Service Management Overview","description":"Overview of PlayFab live ops tools for game configuration, player segmentation, A/B experiments, and player communications through Game Manager.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/overview"},{"title":"PlayFab Live service management documentation","description":"Manage live PlayFab games with title data and configuration, player segmentation for targeting and A/B testing, and title-wide communication tools.","sidebarTitle":"Live service management","href":"/services/playfab/live-service-management/index"},{"group":"Game Manager","expanded":false,"pages":[{"title":"Game Manager","description":"Introduction to PlayFab Game Manager, the web-based developer portal for managing studios, titles, team access, secret keys, and backend service configuration.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/gamemanager/index"},{"title":"Game Manager quickstart","description":"Get started with PlayFab Game Manager by creating a developer account, setting up your studio, and defining your first title to start configuring your game.","sidebarTitle":"Quickstart","href":"/services/playfab/live-service-management/gamemanager/quickstart"},{"title":"Game Manager reference","description":"Tour the PlayFab Game Manager sections — Title Overview, Build, Engage, and Analyze — to configure titles, manage live ops, and monitor player behavior.","sidebarTitle":"Reference","href":"/services/playfab/live-service-management/gamemanager/reference"},{"group":"Tutorials","expanded":false,"pages":[{"title":"API Feature Settings in the PlayFab Game Manager","description":"Configure API Feature settings in PlayFab Game Manager, including JSON validation for custom data, privacy options, and other title-wide API behaviors.","href":"/services/playfab/live-service-management/gamemanager/api-feature-settings-in-the-playfab-game-manager"},{"title":"Audit Logs","description":"Track changes made by developers to your PlayFab title using Game Manager audit logs, and inspect the raw JSON body of each event for security review.","href":"/services/playfab/live-service-management/gamemanager/audit-logs"},{"title":"API Access Policy in Game Manager","description":"View and edit your PlayFab title's API access policy in Game Manager to allow or deny client calls and lock down unused endpoints and CloudScript features.","sidebarTitle":"API Access Policy","href":"/services/playfab/live-service-management/gamemanager/api-access-page-doc"},{"title":"Secret key management","description":"Create, rotate, disable, and expire PlayFab developer secret keys in Game Manager to secure Admin and Server API calls and grant temporary title access.","href":"/services/playfab/live-service-management/gamemanager/secret-key-management"},{"title":"Signing into Game Manager","description":"Choose the correct sign-in flow for PlayFab Game Manager, whether you use a Microsoft account or a retiring legacy PlayFab-authenticated developer account.","sidebarTitle":"Game Manager Sign In","href":"/services/playfab/live-service-management/gamemanager/game-manager-login"}]}]},{"group":"Game server configuration","expanded":false,"pages":[{"title":"Game Server Configuration overview","description":"Learn about Game Server Configuration in PlayFab, which provides server-side key/value and file storage for your title's game server entities.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/game-configuration/index"},{"group":"Entity model","expanded":false,"pages":[{"title":"Entity Programming Model","description":"Introduction to the PlayFab entity programming model, EntityKey identifiers, profiles, and how entity APIs compare with the classic PlayFab APIs.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/game-configuration/entities/index"},{"title":"Entities quickstart","description":"Get started with PlayFab entities in Unity C#: authenticate to obtain an EntityKey, then read and write entity objects and entity files with SDK samples.","sidebarTitle":"Quickstart","href":"/services/playfab/live-service-management/game-configuration/entities/quickstart"},{"group":"Concepts","expanded":false,"pages":[{"title":"Available Built-In Entity Types","description":"Reference for PlayFab built-in entity types: namespace, title, master_player_account, title_player_account, character, group, and game_server EntityKey values.","sidebarTitle":"Available built-in Entity types","href":"/services/playfab/live-service-management/game-configuration/entities/available-built-in-entity-types"},{"title":"Entities migration information","description":"Move title, player, and character data from PlayFab account and data APIs to the entity API, including terminology and access pattern changes.","sidebarTitle":"Migration information","href":"/services/playfab/live-service-management/game-configuration/entities/migration-information"},{"title":"Entity files","description":"Read, write, and upload files attached to a PlayFab entity in any format, with a full Unity C# entity file loop covering login, load, and upload.","href":"/services/playfab/live-service-management/game-configuration/entities/entity-files"},{"title":"Use entity objects to store player data","description":"Store and retrieve small JSON objects on PlayFab entities using SetObjects and GetObjects, with C# samples for player data and Game Manager review.","href":"/services/playfab/live-service-management/game-configuration/entities/entity-objects"}]},{"group":"Tutorials","expanded":false,"pages":[{"title":"Entity API Restructure Upgrade Tutorial","description":"Upgrade PlayFab code that uses the old PlayFabEntityModel API group to the new logical entity API groups, with a C# SDK migration walkthrough.","href":"/services/playfab/live-service-management/game-configuration/entities/entity-api-restructure-upgrade-tutorial"}]}]}]},{"group":"Title data","expanded":false,"pages":[{"title":"Title Data","description":"Overview of PlayFab Title Data: global key/value configuration scoped to title and namespace entities for remote game settings, including internal Title Data.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/game-configuration/titledata/index"},{"title":"Title Data quickstart","description":"Read and write PlayFab Title Data key-value pairs from game clients and servers using GetTitleData and SetTitleData APIs with C# code samples.","sidebarTitle":"Quickstart","href":"/services/playfab/live-service-management/game-configuration/titledata/quickstart"},{"group":"Tutorials","expanded":true,"pages":[{"title":"Using publisher data","description":"Share configuration and player key-value data across multiple titles in a PlayFab studio using SetPublisherData, GetPublisherData, and related APIs.","href":"/services/playfab/live-service-management/game-configuration/titledata/using-publisher-data"}]}]},{"group":"Title communications","expanded":false,"pages":[{"title":"PlayFab Engagement Overview","description":"Learn about an overview of PlayFab features. PlayFab Engagement is a set of tools to engage your player community and keeping them coming back for more.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/game-configuration/title-communications/overview"},{"group":"Title news","expanded":false,"pages":[{"title":"News","description":"Broadcast Title News about events, patch notes, and downtime to PlayFab players via Game Manager, the AddNews API, and GetTitleNews client retrieval.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/game-configuration/title-communications/news/index"},{"title":"Title News quickstart","description":"Create and publish localized PlayFab Title News posts with title, body, date, status, and language fields to share patch notes and event updates with players.","sidebarTitle":"Quickstart","href":"/services/playfab/live-service-management/game-configuration/title-communications/news/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Setting default languages","description":"Configure a PlayFab title default language and per-player preferred language so localized strings, emails, and news reach players in the right language.","href":"/services/playfab/live-service-management/game-configuration/title-communications/news/setting-default-languages"}]}]},{"group":"Push notifications templates","expanded":false,"pages":[{"title":"Push Notifications","description":"Improve player retention with PlayFab push notifications: send unlimited customized messages to Android and iOS devices to re-engage players and reduce churn.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/game-configuration/title-communications/push-notifications/index"},{"title":"Push Notifications quickstart","description":"Set up PlayFab push notifications for iOS APNS and Android GCM channels via Game Manager or the SetupPushNotification Admin API with Amazon SNS routing.","sidebarTitle":"Quickstart","href":"/services/playfab/live-service-management/game-configuration/title-communications/push-notifications/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Getting Started with Android Studio and Push Notifications","description":"Wire up Android Studio, Google Play Services, Firebase Cloud Messaging, and PlayFab to send push notifications to your Android client applications.","sidebarTitle":"Getting Started with Android Push Notifications","href":"/services/playfab/live-service-management/game-configuration/title-communications/push-notifications/getting-started-android-studio-push-notifications"},{"title":"Push notification templates","description":"Build a PlayFab push notification template with strings for multiple languages under one template ID, then trigger it from rules or scheduled tasks.","href":"/services/playfab/live-service-management/game-configuration/title-communications/push-notifications/push-notification-templates"},{"title":"Push Notification for Android","description":"Configure PlayFab push notifications for Android by setting up your Firebase project, uploading the server private key, and testing with a Unity3D client.","sidebarTitle":"Push Notifications for Android","href":"/services/playfab/live-service-management/game-configuration/title-communications/push-notifications/push-notifications-for-android"},{"title":"Push Notification for iOS","description":"Configure PlayFab push notifications for iOS by creating an APNS certificate, exporting it to .p12, and uploading it in Game Manager for delivery.","sidebarTitle":"Push Notifications for iOS","href":"/services/playfab/live-service-management/game-configuration/title-communications/push-notifications/push-notifications-for-ios"}]}]},{"group":"Email templates","expanded":false,"pages":[{"title":"Emails","description":"Send customized PlayFab emails to players on a schedule, from PlayStream event rules, or via API calls using HTML templates and your own SMTP server.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/game-configuration/title-communications/emails/index"},{"title":"Email messaging quickstart","description":"Send PlayFab emails by connecting an external SMTP server, verifying contact addresses, and using email templates for account recovery and player outreach.","sidebarTitle":"Quickstart","href":"/services/playfab/live-service-management/game-configuration/title-communications/emails/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Localized email templates","description":"Create PlayFab email templates with multiple translated versions under one template ID so players receive account emails in their preferred language.","href":"/services/playfab/live-service-management/game-configuration/title-communications/emails/localized-email-templates"},{"title":"Setting up an SMTP server with Add-ons","description":"Install and configure the SMTP add-on in PlayFab Game Manager with your host, port, and credentials to send custom account and marketing emails to players.","sidebarTitle":"Setting up an SMTP server with add-ons","href":"/services/playfab/live-service-management/game-configuration/title-communications/emails/setting-up-an-smtp-server-with-add-ons"},{"title":"Using a rule to verify a contact email address","href":"/services/playfab/live-service-management/game-configuration/title-communications/emails/using-a-rule-to-verify-a-contact-email-address"},{"title":"Using email templates to send an account recovery email","href":"/services/playfab/live-service-management/game-configuration/title-communications/emails/using-email-templates-to-send-an-account-recovery-email"}]}]}]},{"group":"Segments","expanded":false,"pages":[{"group":"Overview","expanded":false,"pages":[{"title":"Segmentation","description":"Overview of PlayFab player segmentation: build real-time targeted groups from player properties and PlayStream events, then trigger grants or push actions.","href":"/services/playfab/live-service-management/game-configuration/segmentation/segmentation-overview"},{"title":"Player Custom Properties","description":"Overview of PlayFab Player Custom Properties: key-value pairs storing string, numeric, boolean, or datetime data on title_player_account entities, with limits.","sidebarTitle":"Player Custom Properties (Preview)","href":"/services/playfab/live-service-management/game-configuration/segmentation/player-custom-properties"}]},{"group":"Quickstart","expanded":false,"pages":[{"title":"Player segmentation","description":"Define PlayFab player segments in Game Manager based on statistics, tags, or currency and trigger CloudScript actions when players enter a segment.","sidebarTitle":"Segmentation QuickStart","href":"/services/playfab/live-service-management/game-configuration/segmentation/segmentation-quickstart"},{"title":"Player Custom Properties Quickstart","description":"Create, modify, and delete PlayFab Player Custom Properties in Game Manager and via the UpdatePlayerCustomProperties API on title_player_account entities.","sidebarTitle":"Player Custom Properties QuickStart (Preview)","href":"/services/playfab/live-service-management/game-configuration/segmentation/player-custom-properties-qs"}]},{"group":"Tutorials","expanded":false,"pages":[{"title":"Segment Configuration","description":"Configure PlayFab player segments in Game Manager by defining filter criteria, naming rules, and assigning enter/leave actions or CloudScript tasks.","sidebarTitle":"Configure a Segment","href":"/services/playfab/live-service-management/game-configuration/segmentation/segmentation-configuration"},{"title":"Tutorial to export players in a Segment","description":"Export PlayFab player profiles from a segment using the ExportPlayersInSegment and GetSegmentExport APIs, the newer replacements for GetPlayersInSegment.","sidebarTitle":"Export Players of a Segment","href":"/services/playfab/live-service-management/game-configuration/segmentation/segmentation-export-players-in-a-segment"},{"title":"Advanced Segmentation with Player Custom Properties","description":"Build dynamic PlayFab player segments from Custom Properties set via APIs, Game Manager, or PlayStream rules to power actions and scheduled live ops tasks.","sidebarTitle":"Advanced Segmentation with Player Custom Properties (Preview)","href":"/services/playfab/live-service-management/game-configuration/segmentation/advanced-segmentation"},{"title":"Tutorial to Count Players of a Segment","description":"Retrieve the player count for a PlayFab segment using the new GetSegmentPlayerCount API (preview), which replaces the retired GetPlayersInSegment endpoint.","sidebarTitle":"Count Players of a Segment (Preview)","href":"/services/playfab/live-service-management/game-configuration/segmentation/segmentation-player-count"}]}]},{"group":"Experiments","expanded":false,"pages":[{"title":"Experimentation","description":"Overview of PlayFab Experiments for running A/B and multivariate tests on live games to optimize engagement, monetization, and retention with statistical rigor.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/game-configuration/experiments/index"},{"title":"Experiments Pricing","description":"How PlayFab Experiments is metered and billed under the Insights credit system for development mode and live titles on Standard, Premium, and Enterprise plans.","sidebarTitle":"Pricing","href":"/services/playfab/live-service-management/game-configuration/experiments/pricing"},{"group":"Concepts","expanded":false,"pages":[{"title":"Scorecard metrics","description":"Reference for PlayFab experiment scorecard metrics covering acquisition, activation, revenue (ARPU), and Day N retention across configured experiment durations.","href":"/services/playfab/live-service-management/game-configuration/experiments/scorecard-metrics"},{"title":"Experimentation APIs","description":"Reference of PlayFab Experimentation REST APIs to create, update, start, stop, and retrieve experiment configurations, variants, and treatment assignments.","href":"/services/playfab/live-service-management/game-configuration/experiments/experimentation-apis"},{"title":"Integrating Experiments with other PlayFab services","description":"Combine PlayFab Experiments with CloudScript, PlayStream events, Player Profile, and Insights Explorer to drive configuration variants and A/B test analysis.","href":"/services/playfab/live-service-management/game-configuration/experiments/experiments-other-services"},{"title":"Experiments Best Practices and Recommendations","description":"Best practices for running PlayFab experiments in live games, including test design, audience sizing, sample ratio mismatch, and data-driven decision making.","sidebarTitle":"Benefits and recommendations","href":"/services/playfab/live-service-management/game-configuration/experiments/experimentation-keys"},{"title":"Experimentation Key-terms","description":"Glossary of PlayFab experimentation concepts covering A/B testing, multivariate tests, variants, conversion rate, hypothesis, and statistical significance.","sidebarTitle":"Key terms","href":"/services/playfab/live-service-management/game-configuration/experiments/experimentation-key-terms"}]},{"title":"Experiments Quickstart","description":"Create a codeless PlayFab experiment in Game Manager with control and treatment variants, audience segments, exclusion groups, and traffic allocation settings.","sidebarTitle":"Quickstart","href":"/services/playfab/live-service-management/game-configuration/experiments/quickstart"},{"group":"How-to","expanded":false,"pages":[{"title":"Manage Experiments","description":"Manage PlayFab experiments across Running, Scheduled, Drafted, and Completed states in Game Manager using timeline views, player counts, and lifecycle actions.","href":"/services/playfab/live-service-management/game-configuration/experiments/manage-experiments"},{"title":"Analyze Experiments","description":"Review PlayFab experiment scorecards for p-value, delta, statistical significance, and sample ratio mismatch to interpret A/B and multivariate test results.","href":"/services/playfab/live-service-management/game-configuration/experiments/analyze-experiments"},{"title":"Exclusion Group in Experiments","description":"Use PlayFab exclusion groups to run mutually exclusive experiments, prevent player overlap between concurrent A/B tests, and avoid skewed live ops results.","sidebarTitle":"Prevent interaction effects with exclusion groups","href":"/services/playfab/live-service-management/game-configuration/experiments/exclusion-groups"}]}]},{"group":"Throttling","expanded":false,"pages":[{"title":"Throttling in PlayFab","description":"How PlayFab throttling uses a fixed window rate limit with title-wide, namespace-wide, and per-entity keys derived from request headers and bodies.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/service-gateway/throttling/what-is-throttling"},{"title":"Throttling best practices","description":"Handle PlayFab HTTP 429 throttling responses with Retry-After headers, request batching, and rate mitigation strategies to keep API traffic within limits.","sidebarTitle":"Best practices","href":"/services/playfab/live-service-management/service-gateway/throttling/best-practices"}]},{"group":"Extensions","expanded":false,"pages":[{"group":"Add-ons","expanded":false,"pages":[{"title":"PlayFab Add-ons","description":"Extend your PlayFab title with Marketplace add-ons for analytics, community, payments, authentication, and platform stores, configured from Game Manager.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/service-gateway/add-ons/add-ons"},{"title":"Photon Quickstart","description":"Connect Photon Realtime and PUN multiplayer with PlayFab to authenticate players and receive room events through CloudScript callbacks in a Unity project.","href":"/services/playfab/live-service-management/service-gateway/add-ons/photon/quickstart"}]},{"group":"CloudScript","expanded":false,"pages":[{"title":"CloudScript","description":"Overview of legacy PlayFab CloudScript for running server-side JavaScript logic triggered by clients, PlayStream event rules, or scheduled tasks.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript/index"},{"title":"CloudScript quickstart","description":"Upload, revise, and invoke PlayFab CloudScript JavaScript files from Game Manager, then call them from your Unity game client or PlayStream actions.","sidebarTitle":"Quickstart","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"ES6 features in CloudScript","description":"Use ECMAScript 6 features like string interpolation, arrow functions, and destructuring to write cleaner PlayFab CloudScript handlers in strict mode.","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript/es6-features-in-cloudscript"},{"title":"Handling Errors in CloudScript","description":"Catch and inspect PlayFab CloudScript errors using try/catch blocks, extract API error codes, and monitor unhandled errors from the CloudScript dashboard.","sidebarTitle":"Handling errors in CloudScript","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript/handling-errors-in-cloudscript"},{"title":"Making Webhook calls from CloudScript","description":"Call external REST endpoints and webhooks from PlayFab CloudScript for both nonsecure requests and OAuth-secured integrations with your own web APIs.","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript/making-webhook-calls-from-cloudscript"},{"title":"SDK error handling Best Practices","description":"Best practices for detecting, inspecting, and handling PlayFab API errors returned by the admin, server, and client SDKs across different languages.","sidebarTitle":"SDK error handling best practices","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript/sdk-error-handling-best-practices"},{"title":"Writing custom CloudScript","description":"Write custom PlayFab CloudScript JavaScript functions callable from Unity clients, PlayStream rules, and scheduled tasks, with helloWorld examples.","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript/writing-custom-cloudscript"}]}]},{"group":"Azure Functions","expanded":false,"pages":[{"title":"PlayFab CloudScript using Azure Functions","description":"Overview of PlayFab CloudScript on Azure Functions for serverless C# and JavaScript backend code with Visual Studio debugging and queued long-running functions.","sidebarTitle":"Overview","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/index"},{"title":"PlayFab CloudScript using Azure Functions Quickstart Guide","description":"Write PlayFab CloudScript with Azure Functions in C# using Visual Studio Code and Unity, then link functions to rules, scheduled tasks, or client calls.","sidebarTitle":"Quickstart","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/quickstart"},{"title":"PlayFab CloudScript using Azure Functions Context Models","description":"Reference for the PlayFab CloudScript context models exposed to Azure Functions when scripts run via ExecuteFunction, scheduled tasks, players, or entities.","sidebarTitle":"Using CloudScript context models","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/CloudScript-af-context"},{"title":"Local debugging for Cloudscript using Azure Functions","description":"Run and debug PlayFab CloudScript locally with Azure Functions by adding an ExecuteFunction implementation and routing SDK calls from Unity, Unreal, or C#.","sidebarTitle":"Local Debugging for Cloudscript using Azure Functions","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/local-debugging-for-cloudscript-using-azure-functions"},{"title":"Debug CloudScript with Azure Functions in Visual Studio Code","description":"Debug PlayFab CloudScript Azure Functions from Visual Studio Code by using the Azure Functions extension to stream logs directly into the terminal.","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/debugging-with-CloudScript-AF-VSCode"},{"title":"Debug CloudScript Azure Functions with Visual Studio","description":"Debug PlayFab CloudScript Azure Functions from Visual Studio using Cloud Explorer to attach to your Functions app and stream log output while it runs.","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/debugging-with-CloudScript-AF-VS"},{"title":"Debug CloudScript Azure Functions in the Azure portal","description":"Debug PlayFab CloudScript Azure Functions from the Azure portal by opening your Functions app and streaming live logs from the Monitoring section.","sidebarTitle":"Debugging CloudScript using Azure Functions with the Azure Portal","href":"/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/debugging-with-CloudScript-AF-Azure"}]}]}]},{"group":"Economy, monetization, \u0026 UGC","icon":"cart-shopping","expanded":false,"pages":[{"title":"PlayFab Economy v2 documentation","description":"Learn to build PlayFab Economy v2 catalogs, inventories, virtual currencies, marketplaces, and UGC that scale to millions of players in your game.","sidebarTitle":"Economy, Monetization, \u0026 UGC","href":"/services/playfab/economy-monetization/index"},{"title":"What is PlayFab Economy?","description":"Learn what PlayFab Economy is and how it helps you design virtual economies with catalogs, currencies, inventory, stores, and monetization tools.","href":"/services/playfab/economy-monetization/economy-what-is"},{"group":"Economy v2 and UGC","expanded":false,"pages":[{"title":"Economy v2 overview","description":"Explore PlayFab Economy v2 architecture, including idempotent transactions, batch operations, large catalogs, and inventory support for high-scale titles.","sidebarTitle":"Overview","href":"/services/playfab/economy-monetization/economy-v2/overview"},{"title":"Economy version 2 (V2) FAQ","description":"Frequently asked questions about PlayFab Economy v2, covering catalogs, inventory, migration from v1, pricing, quotas, and marketplace support.","sidebarTitle":"FAQ","href":"/services/playfab/economy-monetization/economy-v2/faq"},{"title":"Quickstart","description":"PlayFab Economy v2 quickstart for setting up a Catalog v2, configuring permissions, adding items, and enabling receipt validation in Game Manager.","href":"/services/playfab/economy-monetization/economy-v2/quickstart"},{"group":"Catalogs and items","expanded":false,"pages":[{"title":"Catalog Overview","description":"Overview of the PlayFab Economy v2 Catalog in Game Manager, including catalog items, pricing, permissions, and how to publish game content.","sidebarTitle":"Catalog overview","href":"/services/playfab/economy-monetization/economy-v2/catalog/catalog-overview"},{"title":"Economy v2 Bundles","description":"Learn how to group multiple items into PlayFab Economy v2 bundles, configure bundle contents, pricing, and grant contents into player inventory.","sidebarTitle":"Bundles","href":"/services/playfab/economy-monetization/economy-v2/catalog/bundles"},{"title":"Economy v2 Real Money Prices","description":"Configure RealMoneyPriceDetails on PlayFab Economy v2 catalog items to set per-marketplace pricing and track revenue from Apple, Google, and Steam.","sidebarTitle":"Real money prices","href":"/services/playfab/economy-monetization/economy-v2/catalog/real-money-prices"},{"title":"Economy v2 Stores","description":"Create PlayFab Economy v2 Stores to curate item lists, override catalog prices, and run in-game promotions, discounts, and limited-time offers.","sidebarTitle":"Stores","href":"/services/playfab/economy-monetization/economy-v2/catalog/stores"},{"title":"Economy v2 Subscriptions","description":"Create PlayFab Economy v2 virtual subscriptions to grant time-based access to durable in-game items and manage recurring player benefits.","sidebarTitle":"Subscriptions","href":"/services/playfab/economy-monetization/economy-v2/catalog/subscriptions"},{"title":"Economy v2 Catalog Content Types, Tags, \u0026 Properties","description":"Configure PlayFab Economy v2 catalog items using content types, tags, keywords, descriptions, and display properties via the APIs and Game Manager.","sidebarTitle":"Content types, tags, and properties","href":"/services/playfab/economy-monetization/economy-v2/catalog/content-types-tags-and-properties"},{"title":"Economy v2 deep links","description":"Configure PlayFab Economy v2 deep links to route players directly to platform store listings, UGC items, or in-game content from URLs and ads.","sidebarTitle":"Deep links","href":"/services/playfab/economy-monetization/economy-v2/catalog/deep-links"},{"title":"Economy v2 ETags","description":"Use ETags with PlayFab Economy v2 catalog draft items to manage concurrent updates and prevent conflicting writes across UpdateDraftItem calls.","sidebarTitle":"Etags and concurrency","href":"/services/playfab/economy-monetization/economy-v2/catalog/etags"},{"title":"Item Status \u0026 Moderation","description":"Understand PlayFab Economy v2 item states, including draft, published, scheduled, expired, and hidden, and how each affects catalog visibility.","sidebarTitle":"Item status and moderation","href":"/services/playfab/economy-monetization/economy-v2/catalog/item-status"},{"title":"Economy v2 Localization","description":"Localize PlayFab Economy v2 catalog items using locale keys for Title, Description, and Keywords fields across Game Manager and Catalog APIs.","sidebarTitle":"Localization","href":"/services/playfab/economy-monetization/economy-v2/catalog/localization"},{"title":"Adding ratings to your content","description":"Add player ratings and reviews to PlayFab Economy v2 catalog items using ReviewItem, GetEntityItemReview, and related review management APIs.","sidebarTitle":"Ratings and reviews","href":"/services/playfab/economy-monetization/economy-v2/catalog/ratings"},{"title":"Search","description":"Query the PlayFab Economy v2 public catalog with the SearchItems API using OData filters, ordering, pagination, and continuation tokens.","href":"/services/playfab/economy-monetization/economy-v2/catalog/search"}]},{"group":"Player inventory","expanded":false,"pages":[{"title":"PlayFab Inventory APIs","description":"Overview of the PlayFab Economy v2 Inventory APIs for managing player inventories, granting items, tracking currency balances, and reading stacks.","sidebarTitle":"Overview","href":"/services/playfab/economy-monetization/economy-v2/inventory/index"},{"title":"Player Inventory Quickstart","description":"Use the PlayFab Beta SDK to authenticate a player, search the catalog, purchase an item, and verify it appears in the player's Economy v2 inventory.","sidebarTitle":"Quickstart","href":"/services/playfab/economy-monetization/economy-v2/inventory/quickstart"},{"title":"Items and Inventory Overview","description":"Learn PlayFab Economy v2 catalog and inventory concepts, including item types, bundles, stores, virtual currencies, and player ownership tracking.","sidebarTitle":"Items and inventory","href":"/services/playfab/economy-monetization/economy-v2/inventory/items-and-inventory-overview"},{"title":"Inventory Collections","description":"Use PlayFab Economy v2 Inventory Collections to partition player inventory into named groups for characters, loadouts, or storage containers.","sidebarTitle":"Collections","href":"/services/playfab/economy-monetization/economy-v2/inventory/collections"},{"title":"Inventory Stacks","description":"Understand PlayFab Economy v2 Inventory Stacks to group identical items with unique data, quantities, and expirations in a player's inventory.","sidebarTitle":"Stacks","href":"/services/playfab/economy-monetization/economy-v2/inventory/stacks"},{"title":"Transaction History","description":"Query the PlayFab Economy v2 Transaction History API to audit inventory operations, purchases, and item grants performed on a player's account.","href":"/services/playfab/economy-monetization/economy-v2/inventory/transaction-history"},{"title":"Inventory ETags","description":"Use ETags and X-PlayFab-Economy-If-Match headers with the PlayFab Inventory APIs to enable optimistic concurrency and prevent conflicting writes.","sidebarTitle":"ETags","href":"/services/playfab/economy-monetization/economy-v2/inventory/etags"},{"title":"Economy V2 TurboLoading","description":"Use PlayFab Economy v2 TurboLoading with GetInventoryItems to fetch a full player inventory in one request, reducing startup latency and API calls.","sidebarTitle":"TurboLoading","href":"/services/playfab/economy-monetization/economy-v2/inventory/turboloading"}]},{"group":"Player-segmented monetization","expanded":false,"pages":[{"title":"Economy V2 targeted offers","description":"Deliver PlayFab Economy v2 targeted offers with dynamic pricing and personalized store items tailored to specific player segments for better retention.","sidebarTitle":"Targeted offers","href":"/services/playfab/economy-monetization/economy-v2/player-segmented-monetization/targeted-offers"},{"title":"Economy V2 Segment Actions","description":"Use PlayFab Economy v2 segment actions to trigger inventory grants, currency rewards, and monetization events based on player segment membership.","sidebarTitle":"Segment actions","href":"/services/playfab/economy-monetization/economy-v2/player-segmented-monetization/segment-actions"}]},{"group":"User-generated content (UGC)","expanded":false,"pages":[{"title":"PlayFab User Generated Content","description":"Overview of PlayFab User Generated Content (UGC) services for uploading, searching, moderating, and monetizing player-created items in your game.","sidebarTitle":"Overview","href":"/services/playfab/economy-monetization/economy-v2/ugc/overview"},{"title":"PlayFab UGC documentation","description":"PlayFab User Generated Content (UGC) documentation for enabling players to create, upload, moderate, and discover custom content in your game.","sidebarTitle":"PlayFab UGC","href":"/services/playfab/economy-monetization/economy-v2/ugc/index"},{"title":"User Generated Content (UGC) quickstart","description":"Quickstart for PlayFab UGC using service-to-service calls to connect to draft content items, publish them, and expose player-created content in-game.","sidebarTitle":"Quickstart","href":"/services/playfab/economy-monetization/economy-v2/ugc/quickstart"},{"title":"Moderating your user generated content","description":"Build UGC moderation flows in PlayFab Economy v2 using ReportItem and review APIs to flag, review, and take down inappropriate user generated content.","sidebarTitle":"Moderation","href":"/services/playfab/economy-monetization/economy-v2/ugc/moderation"}]},{"group":"Marketplaces","expanded":false,"pages":[{"group":"Marketplace integrations","expanded":false,"pages":[{"title":"Marketplace integration - Overview","description":"Overview of PlayFab Economy v2 marketplace integrations that connect your game to digital storefronts like Steam for in-game purchases and content.","sidebarTitle":"Overview","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-integrations/overview"},{"title":"Marketplace integration - Google","description":"Link a Google Play app to your PlayFab title in Game Manager using a Google Cloud service account and the Google Play Android Developer API.","sidebarTitle":"Google Play Store","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-integrations/google"},{"title":"Marketplace Integration - Apple","description":"Connect an Apple App Store app to your PlayFab title in Game Manager using the iOS bundle ID and App Store Connect credentials for Economy v2.","sidebarTitle":"Apple App Store","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-integrations/apple"},{"title":"Marketplace integration - Microsoft Store","description":"Set up Partner Center add-ons and link Microsoft Store products to PlayFab Economy v2 bundles for XBOX and Windows in-app purchase redemption.","sidebarTitle":"Microsoft Store","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-integrations/microsoft"},{"title":"Marketplace integration - Steam","description":"Tutorial for integrating a Steam application with PlayFab Game Manager, including SteamWorks Partner setup, app configuration, and credentials.","sidebarTitle":"Steam","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-integrations/steam"}]},{"group":"Marketplace redemption","expanded":false,"pages":[{"title":"Marketplace redemption - Overview","description":"Overview of PlayFab Economy v2 marketplace redemption flows for granting purchased items and subscriptions from external stores into player inventory.","sidebarTitle":"Overview","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-redemption/overview"},{"title":"Redemption with the Google Marketplace","description":"Create Google Play in-app products, map them to PlayFab Economy v2 bundles, and redeem purchases into player inventory using the redemption API.","sidebarTitle":"Google redemption","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-redemption/google"},{"title":"Redemption with the Microsoft Store Marketplace","description":"Create Microsoft Store add-ons, link them to PlayFab bundles, and redeem XBOX and Windows purchases with RedeemMicrosoftStoreInventoryItems.","sidebarTitle":"Microsoft Store redemption","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-redemption/microsoft"},{"title":"Redemption with the Steam Marketplace","description":"Configure PlayFab and Steam to enable in-game purchase flows and redeem Steam marketplace items into a player's Economy v2 inventory.","sidebarTitle":"Steam redemption","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-redemption/steam"},{"title":"Redeem Apple App Store In-App Purchases","description":"Create an Apple App Store IAP, map it to a PlayFab catalog bundle, and guide players through redemption using the Economy v2 redemption APIs.","sidebarTitle":"Apple redemption","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-redemption/apple"}]},{"title":"Marketplace Error Handling","description":"Handle PlayFab marketplace redemption errors using APIErrorWrapper, MarketplaceErrorCode details, and recovery patterns for failed store API calls.","sidebarTitle":"Marketplace error handling","href":"/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-error-handling"}]},{"group":"Fraud prevention, redemption, receipt validation","expanded":false,"pages":[{"title":"Fraud prevention, redemption, receipt validation","description":"Protect PlayFab Economy v2 purchases from spoofing, duplicate requests, and refunds using idempotent transactions, receipt validation, and refund checks.","sidebarTitle":"Overview","href":"/services/playfab/economy-monetization/economy-v2/fraud-prevention/index"},{"title":"Fraud prevention quickstart","description":"Quickstart guide to enable receipt validation and fraud prevention in PlayFab Economy v2 for Microsoft Store, iOS, Google Play, and other platforms.","sidebarTitle":"Quickstart","href":"/services/playfab/economy-monetization/economy-v2/fraud-prevention/quickstart"}]},{"title":"Economy v2 settings overview","description":"Configure PlayFab Economy v2 catalog settings in Game Manager, including permissions, content types, platforms, tags, and display properties.","sidebarTitle":"Settings","href":"/services/playfab/economy-monetization/economy-v2/settings"},{"title":"Economy V2 Limits","description":"Reference throttling and rate limits for PlayFab Economy v2 catalog and inventory APIs, including per-player and per-title request-per-second quotas.","sidebarTitle":"Limits","href":"/services/playfab/economy-monetization/economy-v2/limits"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Getting started with Economy v2, Unity IAP, and Android","description":"Wire up Unity IAP and the Android Billing API to PlayFab Economy v2 bundles so players can purchase real-money items and redeem them into inventory.","sidebarTitle":"Getting started with Unity and Android","href":"/services/playfab/economy-monetization/economy-v2/tutorials/getting-started-with-unity-and-android"},{"title":"Publish your first user generated content","description":"Publish user-generated content in PlayFab Economy v2 with Postman or Game Manager, using CreateUploadUrls, Azure Blob Storage, and draft item APIs.","href":"/services/playfab/economy-monetization/economy-v2/tutorials/publish-ugc"},{"group":"Crafting game","expanded":false,"pages":[{"title":"Crafting Game - Context","description":"Introduction to the PlayFab Economy V2 crafting game tutorial: a text-based C# example that uses inventories, stores, and bundles to craft ice cream items.","sidebarTitle":"Game context","href":"/services/playfab/economy-monetization/economy-v2/tutorials/craftingGame/game-context"},{"title":"Crafting Game Part 1 - Setup","description":"Part 1 of the PlayFab Economy V2 crafting game tutorial: set up a Visual Studio 2022 C# console project and install the PlayFab SDK to start coding.","sidebarTitle":"Part 1 - Environment setup","href":"/services/playfab/economy-monetization/economy-v2/tutorials/craftingGame/crafting-game-environment"},{"title":"Crafting Game Part 2 - Game Manager","description":"Part 2 of the PlayFab Economy V2 crafting game tutorial: use Game Manager to create your studio and title, then configure items, stores, and bundles.","sidebarTitle":"Part 2 - Using Game Manager","href":"/services/playfab/economy-monetization/economy-v2/tutorials/craftingGame/crafting-game-game-manager"},{"title":"Crafting Game Part 3 - Coding","description":"Part 3 of the PlayFab Economy V2 crafting game tutorial: write C# code that calls the Economy V2 API to manage inventories, recipes, and crafted items.","sidebarTitle":"Part 3 - Coding and examples","href":"/services/playfab/economy-monetization/economy-v2/tutorials/craftingGame/crafting-game-coding"}]},{"title":"Economy v2 Virtual Currency Quickstart","description":"Create and configure your first PlayFab Economy v2 virtual currency using Game Manager or the Catalog APIs with a title entity token.","sidebarTitle":"Virtual currencies","href":"/services/playfab/economy-monetization/economy-v2/tutorials/currencies"},{"title":"Containers with fixed contents in Economy v2","description":"Recreate legacy PlayFab container items in Economy v2 by combining a virtual currency token with a bundle that unpacks fixed rewards on purchase.","sidebarTitle":"Containers with fixed contents","href":"/services/playfab/economy-monetization/economy-v2/tutorials/containers-with-fixed-contents"},{"title":"Drop tables and randomized loot in Economy v2","description":"Build weighted random loot drops in PlayFab Economy v2 using Title Data, Azure Functions, and ExecuteInventoryOperations to grant items atomically.","sidebarTitle":"Drop tables and randomized loot","href":"/services/playfab/economy-monetization/economy-v2/tutorials/drop-tables-and-randomized-loot"},{"title":"Idempotent transactions and retry patterns in Economy v2","description":"Use IdempotencyId on PlayFab Economy v2 inventory writes to safely retry after network failures and prevent duplicate purchases or grants.","sidebarTitle":"Idempotent transactions and retries","href":"/services/playfab/economy-monetization/economy-v2/tutorials/idempotent-transactions-and-retries"},{"title":"ETags and concurrency control in Economy v2","description":"Prevent overlapping PlayFab Economy v2 inventory writes with ETags and the X-PlayFab-Economy-If-Match header for optimistic concurrency control.","sidebarTitle":"ETags and concurrency control","href":"/services/playfab/economy-monetization/economy-v2/tutorials/etags-and-concurrency-control"},{"title":"Real money price tracking in Economy v2","description":"Set RealMoneyPriceDetails on PlayFab Economy v2 bundles and track revenue via the marketplace_transaction_redeemed event for analytics reporting.","sidebarTitle":"Real money price tracking","href":"/services/playfab/economy-monetization/economy-v2/tutorials/real-money-price-tracking"}]}]},{"group":"Legacy economy","expanded":false,"pages":[{"title":"PlayFab Economy documentation","description":"Explore PlayFab Economy (Legacy) features for items, stores, virtual currencies, sales, and promotions to help you engage and monetize your game.","sidebarTitle":"PlayFab Economy","href":"/services/playfab/economy-monetization/economy/index"},{"group":"Items","expanded":false,"pages":[{"title":"Items (Legacy Economy)","description":"Overview of PlayFab Legacy Economy (v1) items, including catalog items, virtual currencies, item classes, and inventory management for your title.","sidebarTitle":"Overview","href":"/services/playfab/economy-monetization/economy/items/index"},{"title":"Items (Legacy Economy) quickstart","description":"Quickstart for creating catalog items in PlayFab Legacy Economy (v1), including item properties, virtual currencies, and granting items to players.","sidebarTitle":"Quickstart","href":"/services/playfab/economy-monetization/economy/items/quickstart"},{"title":"Catalogs (Legacy Economy)","description":"Create and manage items in the PlayFab Legacy Economy Catalogs tab of Game Manager, including virtual currency prices, grants, and item purchasing.","sidebarTitle":"Catalogs","href":"/services/playfab/economy-monetization/economy/items/catalogs"}]},{"group":"Stores","expanded":false,"pages":[{"title":"Stores (Legacy Economy)","description":"Overview of PlayFab Legacy Economy (v1) stores for curating item lists, overriding catalog prices, and offering targeted purchase surfaces in-game.","sidebarTitle":"Overview","href":"/services/playfab/economy-monetization/economy/stores/index"},{"title":"Stores (Economy Legacy) Quickstart","description":"Quickstart for creating PlayFab Legacy Economy (v1) stores, adding items, setting store-specific prices, and displaying stores to players in-game.","sidebarTitle":"Quickstart","href":"/services/playfab/economy-monetization/economy/stores/quickstart"}]},{"group":"Trading","expanded":false,"pages":[{"title":"Trading","description":"Overview of PlayFab Legacy Economy player-to-player trading APIs, allowing players to safely exchange inventory items directly through your game.","href":"/services/playfab/economy-monetization/economy/trading/index"},{"title":"Trading quickstart","description":"Quickstart for PlayFab player-to-player trading using OpenTrade, AcceptTrade, and related APIs to exchange inventory items between two players.","sidebarTitle":"Quickstart","href":"/services/playfab/economy-monetization/economy/trading/trading-quickstart"}]},{"title":"Economy (Legacy) quickstart","description":"Quickstart for PlayFab Legacy Economy (v1) covering initial catalog setup, virtual currency configuration, and basic item and store creation.","sidebarTitle":"Quickstart","href":"/services/playfab/economy-monetization/economy/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Best Practices for Store Segmentation in Economy (Legacy)","description":"Follow PlayFab Legacy Economy best practices for store segmentation, including varying content instead of pricing and securing client API access.","sidebarTitle":"Best Practices for Store Segmentation","href":"/services/playfab/economy-monetization/economy/tutorials/best-practices-for-store-segmentation"},{"title":"Coupons and Promotions in Economy (Legacy)","description":"Generate and redeem PlayFab Legacy Economy coupons from Game Manager and pair them with bundles or CloudScript to power in-game promotions.","sidebarTitle":"Coupons and Promotions","href":"/services/playfab/economy-monetization/economy/tutorials/coupons-and-promotions"},{"title":"Manage Virtual Currencies in Economy (Legacy)","description":"Configure PlayFab Legacy Economy virtual currencies in the Game Manager Currency tab to power in-game purchases, grants, and player rewards.","sidebarTitle":"Currencies","href":"/services/playfab/economy-monetization/economy/tutorials/currencies"},{"title":"Custom Stores for Player Segments in Economy (Legacy)","description":"Tutorial for Economy (Legacy) that describes how to create alternate stores that are available only to players from defined Player Segments.","sidebarTitle":"Custom Stores for Player Segments","href":"/services/playfab/economy-monetization/economy/tutorials/custom-stores-for-player-segments"},{"title":"Drop Tables in Economy (Legacy)","description":"Create weighted and sequential drop tables in PlayFab Legacy Economy using Game Manager to grant randomized loot and player rewards from your catalog.","sidebarTitle":"Drop Tables","href":"/services/playfab/economy-monetization/economy/tutorials/drop-tables"},{"title":"Getting a player's Value-to-Date (VTD) in Economy (Legacy)","description":"Retrieve a PlayFab player's lifetime spend using GetPlayerProfile and read totalValueToDateInUSD and valuesToDate from the PlayerProfileModel.","sidebarTitle":"Getting a Player's Value-to-Date (VTD)","href":"/services/playfab/economy-monetization/economy/tutorials/getting-a-players-vtd"},{"title":"Get started with PlayFab Economy Legacy, Unity IAP, Android","description":"Connect Unity IAP and the Android Billing API to PlayFab Legacy Economy catalog items for a working in-app purchase flow on Android devices.","sidebarTitle":"Getting started with PlayFab, Unity IAP, and Android","href":"/services/playfab/economy-monetization/economy/tutorials/getting-started-with-unity-iap-android"},{"title":"Non receipt payment processing","href":"/services/playfab/economy-monetization/economy/tutorials/non-receipt-payment-processing"},{"title":"Stores and sales in Economy (Legacy)","description":"Build PlayFab Legacy Economy stores from your catalog and run timed sales with custom virtual currency or real-money pricing for selected items.","sidebarTitle":"Stores and Sales","href":"/services/playfab/economy-monetization/economy/tutorials/stores-and-sales"},{"title":"Timed Consumables in Economy (Legacy)","description":"Configure PlayFab Legacy Economy timed consumables in Game Manager so items auto-consume from a player's inventory after a set duration.","sidebarTitle":"Timed Consumables","href":"/services/playfab/economy-monetization/economy/tutorials/timed-consumables"}]}]}]},{"group":"Rewarded Ads","icon":"circle-play","pages":[{"title":"What are rewarded Ads?","description":"Overview of PlayFab rewarded ads, a monetization strategy that grants in-game currency or items when players opt in to watch short video ads.","sidebarTitle":"Overview","href":"/services/playfab/economy-monetization/rewarded-ads/index"},{"title":"Getting started with rewarded Ads.","description":"Quickstart for setting up a PlayFab rewarded ad placement in Game Manager, configuring rewards, and integrating video ads into your game client.","sidebarTitle":"Quickstart","href":"/services/playfab/economy-monetization/rewarded-ads/quickstart"}]},{"group":"Multiplayer","icon":"users","expanded":false,"pages":[{"title":"PlayFab Multiplayer documentation","description":"PlayFab Multiplayer services support real-time multiplayer capabilities for matchmaking, grouping, networking, and server hosting.","sidebarTitle":"Multiplayer","href":"/services/playfab/multiplayer/index"},{"title":"Multiplayer with PlayFab","description":"Introduction to PlayFab multiplayer services covering Lobby, Matchmaking, Party networking and voice chat, and Multiplayer Servers for hosted game builds.","sidebarTitle":"Overview","href":"/services/playfab/multiplayer/mpintro"},{"group":"Servers","expanded":false,"pages":[{"title":"Servers","description":"Overview of PlayFab Multiplayer Servers (MPS), an Azure-based game server hosting service that dynamically scales Windows and Linux dedicated servers on demand.","sidebarTitle":"Overview","href":"/services/playfab/multiplayer/servers/index"},{"title":"Enable PlayFab Multiplayer Server feature","description":"Enable the PlayFab Multiplayer Servers feature on a game title using Game Manager or the API and PowerShell, including payment method and quota prerequisites.","sidebarTitle":"Enable feature for game title","href":"/services/playfab/multiplayer/servers/enable-playfab-multiplayer-servers"},{"title":"Deploying PlayFab multiplayer server builds","description":"Create PlayFab Multiplayer Servers VMs by defining build parameters that determine how Azure virtual machines are spun up globally to host your game servers.","sidebarTitle":"Create VMs","href":"/services/playfab/multiplayer/servers/deploying-playfab-multiplayer-server-builds"},{"title":"Create your first server","description":"Create your first PlayFab Multiplayer Server using the Wrapper sample: enable the feature in Game Manager, upload assets, deploy a build, and allocate a server.","href":"/services/playfab/multiplayer/servers/create-your-first-server"},{"title":"Build definition and configuration","description":"Build definition and configuration parameters for PlayFab Multiplayer Servers VMs, including immutable build settings, VM size selection, and container assets.","sidebarTitle":"Build definition","href":"/services/playfab/multiplayer/servers/build-definition"},{"title":"Builds overview page","description":"Tour the Builds overview page in PlayFab Game Manager to view multiplayer server build settings and manage aliases, title assets, and shared services.","sidebarTitle":"Builds overview","href":"/services/playfab/multiplayer/servers/build-overview"},{"title":"Servers overview page","description":"Use the Servers overview page in PlayFab Game Manager to inspect VMs, session state, and player counts for a multiplayer server build and request servers.","sidebarTitle":"Servers overview","href":"/services/playfab/multiplayer/servers/build-server-overview"},{"title":"Basics of a PlayFab game server","description":"Learn how PlayFab multiplayer game servers are packaged as Windows or Linux containers, uploaded as assets, and integrated with GSDK for hosting.","sidebarTitle":"Game server and container basics","href":"/services/playfab/multiplayer/servers/basics-of-a-playfab-game-server"},{"title":"PlayFab Multiplayer Server terms","description":"Terminology reference for PlayFab Multiplayer Servers, clarifying terms like build, VM, container, game server session, and allocation used across MPS.","sidebarTitle":"Terminology","href":"/services/playfab/multiplayer/servers/server-terms"},{"title":"Quickstart for multiplayer servers game manager","href":"/services/playfab/multiplayer/servers/quickstart-for-multiplayer-servers-game-manager"},{"title":"Walkthrough: Deploy builds using PowerShell/API","description":"Walkthrough for deploying Windows OS PlayFab Multiplayer Servers builds using PowerShell and the Multiplayer Servers API with the Windows Runner C# sample.","sidebarTitle":"Deploy Windows builds using PowerShell/API","href":"/services/playfab/multiplayer/servers/quickstart-for-multiplayer-servers-api-powershell"},{"title":"Using PlayFab Multiplayer Servers to host multiplayer games","description":"Overview of hosting multiplayer game sessions on PlayFab Multiplayer Servers, including build creation, containerized VM deployment, and dynamic scaling.","sidebarTitle":"Host multiplayer games","href":"/services/playfab/multiplayer/servers/using-playfab-servers-to-host-games"},{"title":"Connecting clients to game servers","description":"Connect game clients to PlayFab Multiplayer Servers hosted game servers by resolving virtualized Azure networking and using allocated IPs and port mappings.","href":"/services/playfab/multiplayer/servers/connecting-clients-to-game-servers"},{"title":"Best practices and launch checklist","description":"Best practices and a launch checklist for PlayFab Multiplayer Servers, covering development, testing with LocalMultiplayerAgent, scaling, and live operations.","href":"/services/playfab/multiplayer/servers/best-practices"},{"title":"Multiplayer servers comparison","description":"Compare Azure VM series and regions supported by PlayFab Multiplayer Servers, including recommended CPU tiers for game hosting and their pricing impact.","sidebarTitle":"Server comparison","href":"/services/playfab/multiplayer/servers/server-comparison"},{"group":"Builds \u0026 Deployment","icon":"server","pages":[{"title":"Author a game server build","description":"Author a PlayFab Multiplayer Servers (MPS) game server build by packaging your executable and assets and integrating the GSDK for the hosted environment.","href":"/services/playfab/multiplayer/servers/author-a-game-server-build"},{"title":"Integrate game servers with the PlayFab GSDK","description":"Integrate your game server with the PlayFab Game Server SDK (GSDK) in C++, C#, or Java to signal readiness, heartbeat, and manage multiplayer allocations.","sidebarTitle":"Integrate game server build with GSDK","href":"/services/playfab/multiplayer/servers/integrating-game-servers-with-gsdk"},{"title":"Deploy builds using Game Manager","description":"Steps to deploy PlayFab Multiplayer Servers VM builds through Game Manager, including uploading assets, selecting VM sizes, and configuring regions and standby.","href":"/services/playfab/multiplayer/servers/deploy-using-game-manager"},{"title":"Deploy builds using PowerShell/API","description":"Deploy PlayFab Multiplayer Servers VM builds from PowerShell and the Multiplayer Servers API, including uploading assets and creating Windows OS builds.","href":"/services/playfab/multiplayer/servers/deploy-using-powershell-api"},{"title":"Create and deploy Linux Builds","description":"Create and deploy Linux game server builds on PlayFab Multiplayer Servers using Linux container images or process-based servers with the GSDK.","href":"/services/playfab/multiplayer/servers/deploying-linux-based-builds"},{"title":"Determining required DLLs for Windows game servers","description":"Describes how to determine the list of dlls required for your game servers and how to compare that list to the set of dlls in PlayFab MPS.","sidebarTitle":"Determining required DLLs","href":"/services/playfab/multiplayer/servers/determining-required-dlls"},{"title":"Manage secrets (Preview)","description":"This document provides information on the secret management feature that enables customers to deploy secrets into game servers securely.","sidebarTitle":"Manage secrets (preview)","href":"/services/playfab/multiplayer/servers/manage-secrets"},{"title":"Run custom script during VM creation (preview)","description":"Use the VmStartupScript preview feature to run custom scripts during VM creation for PlayFab Multiplayer Servers, enabling agent installs and log routing.","href":"/services/playfab/multiplayer/servers/vmstartupscript"},{"title":"Integrating the PlayFab GSDK into Unity","description":"Integrate the PlayFab Game Server SDK (GSDK) into a Unity dedicated server project to host builds on PlayFab Multiplayer Servers with the UnityGsdk library.","sidebarTitle":"Integrate Unity with GSDK","href":"/services/playfab/multiplayer/servers/mps-unity"},{"title":"Quickstart for multiplayer servers (MpsAllocator Sample)","description":"Quickstart for the MpsAllocator .NET sample that calls PlayFab Multiplayer APIs to list builds, view VMs, and allocate game servers on demand.","sidebarTitle":"MpsAllocator","href":"/services/playfab/multiplayer/servers/mps-allocator-sample"}]},{"group":"Scaling \u0026 Standby","icon":"arrow-up-right-dots","pages":[{"title":"Dynamic Standby","description":"Auto-scaling enhancement that monitors standby server threshold levels and dynamically increases game server provisioning to meet demand at scale.","href":"/services/playfab/multiplayer/servers/dynamic-standby"},{"title":"Scheduled Standby","description":"Scheduled Standby is an auto scaling enhancement that adjusts standby server levels at a single or recurring scheduled date \u0026 time.","href":"/services/playfab/multiplayer/servers/scheduled-standby"},{"title":"Scaling Standby","description":"Tune PlayFab standby targets and scaling settings to match multiplayer game server capacity with real player demand while controlling hosting cost.","href":"/services/playfab/multiplayer/servers/scaling-standby"},{"title":"Scaling Programmatically","description":"Scale PlayFab Multiplayer Servers programmatically using the Multiplayer Servers API and the DynamicStandby BuildRegionParams object for demand-based standby.","href":"/services/playfab/multiplayer/servers/scaling-programmatically"},{"title":"Accessing increased core limits and additional Azure regions","description":"View current core quotas and request increased core limits or additional Azure regions and VM series for PlayFab Multiplayer Servers game titles.","sidebarTitle":"Get increased core limits and additional Azure regions","href":"/services/playfab/multiplayer/servers/identifying-and-increasing-core-limits"}]},{"group":"Lifecycle \u0026 Operations","icon":"gear","pages":[{"title":"Lifecycle of multiplayer server builds","description":"PlayFab Multiplayer Servers build lifecycle and states like Deploying, DeletingRegion, and Unhealthy, and how per-region status rolls up to the whole build.","sidebarTitle":"Server build lifecycle","href":"/services/playfab/multiplayer/servers/multiplayer-build-lifecycle"},{"title":"Lifecycle of a multiplayer server build region","description":"Understand the Initialized, Deploying, Deployed, and Deleting states of a PlayFab multiplayer server build region and how VMs transition between them.","sidebarTitle":"Build region lifecycle","href":"/services/playfab/multiplayer/servers/multiplayer-build-region-lifecycle"},{"title":"Lifecycle of a multiplayer server","description":"Lifecycle of a PlayFab Multiplayer Servers game server session, from GSDK Initialize and ReadyForPlayers through active state, terminated state, and log upload.","sidebarTitle":"Game server lifecycle","href":"/services/playfab/multiplayer/servers/multiplayer-game-server-lifecycle"},{"title":"Allocate game servers and connect Visual Studio debugger","description":"Learn how to allocate PlayFab multiplayer game servers with RequestMultiplayerServer and attach Visual Studio debugging tools to a running session.","sidebarTitle":"Allocate game servers and connect VS debugging tools","href":"/services/playfab/multiplayer/servers/allocating-game-servers-and-configuring-vs-debugging-tools"},{"title":"Managing a build alias and allocating to it","description":"Use PlayFab build aliases to distribute multiplayer server allocation across weighted builds for safe rollout, backward compatibility, and game modes.","sidebarTitle":"Use aliases to aggregate and manage multiple VM builds","href":"/services/playfab/multiplayer/servers/allocating-with-build-alias"},{"title":"OS Patch level updates for Windows","description":"How PlayFab Multiplayer Servers rolls out monthly Windows OS patch updates on managed containers, keeping hosted game server VMs on Azure-certified images.","sidebarTitle":"OS patch level updates for Windows","href":"/services/playfab/multiplayer/servers/os-patch-updates"},{"title":"Managing quota changes","description":"Request and review server core quota changes for PlayFab Multiplayer Servers titles, increasing the simultaneous VM cores available for hosted builds.","sidebarTitle":"Request and review quota changes","href":"/services/playfab/multiplayer/servers/quota-changes"},{"title":"Managing Summary","description":"Monitor PlayFab Multiplayer Servers capacity by tracking simultaneous VM core usage against quota to avoid allocation failures and diagnose scaling problems.","sidebarTitle":"Monitor server capacity","href":"/services/playfab/multiplayer/servers/quota-summary"},{"title":"VM metrics","description":"VM performance metrics for PlayFab Multiplayer Servers VMs, exposing CPU, RAM, and system-level counters to help tune capacity and monitor hosted game servers.","sidebarTitle":"VM performance metrics","href":"/services/playfab/multiplayer/servers/vm-metrics"},{"title":"Archiving and retrieving multiplayer server logs","description":"Archive PlayFab multiplayer server logs and retrieve them through GSDK, Game Manager, or ListArchivedMultiplayerServers and GetMultiplayerServerLogs APIs.","sidebarTitle":"Archive and retrieve server logs","href":"/services/playfab/multiplayer/servers/archiving-and-retrieving-multiplayer-server-logs"},{"title":"Use QoS beacons to measure player latency to Azure","description":"Use PlayFab QoS beacons to measure player latency to Azure regions and rank them when calling RequestMultiplayerServer for lower-latency matchmaking.","sidebarTitle":"Use QoS beacons to measure player latency to Azure","href":"/services/playfab/multiplayer/servers/using-qos-beacons-to-measure-player-latency-to-azure"}]},{"group":"Debugging","icon":"bug","pages":[{"title":"Attaching a profiler","description":"Attach profilers such as dotnet trace or PIX to PlayFab Multiplayer Servers builds to debug graphics and performance, and retrieve the resulting output logs.","href":"/services/playfab/multiplayer/servers/attaching-a-profiler"},{"title":"Automatic crash dump collection","description":"Enable automatic crash dump collection on PlayFab Multiplayer Servers Windows container builds to capture minidumps when a hosted game server process crashes.","sidebarTitle":"Enabling automatic collection of crash dump","href":"/services/playfab/multiplayer/servers/crash-dump-collection"},{"title":"Connect directly to debug game servers","description":"Connect directly to a PlayFab multiplayer server VM via RDP or SSH to debug game server health, attach a profiler, or view real-time logs on Windows and Linux.","href":"/services/playfab/multiplayer/servers/directly-debugging-game-servers"},{"title":"Locally debugging game servers and integration with PlayFab","description":"Describes how to integrate PlayFab multiplayer game servers with the PlayFab Game Server SDK (GSDK) and verify and debug the integration.","sidebarTitle":"Locally debugging game servers and integration","href":"/services/playfab/multiplayer/servers/locally-debugging-game-servers-and-integration-with-playfab"}]},{"group":"Local Multiplayer Agent","icon":"laptop-code","pages":[{"title":"LocalMultiplayerAgent Overview","description":"LocalMultiplayerAgent (LMA) overview for locally testing PlayFab Multiplayer Servers integrations, mocking GSDK responses without deploying to the cloud.","href":"/services/playfab/multiplayer/servers/LocalMultiplayerAgent/local-multiplayer-agent-overview"},{"title":"Debug container game servers with LocalMultiplayerAgent","description":"Debug a PlayFab multiplayer game server locally by packaging it as a Linux or Windows container and running it under LocalMultiplayerAgent in container mode.","sidebarTitle":"Debug Container-based game server","href":"/services/playfab/multiplayer/servers/LocalMultiplayerAgent/run-container-gameserver"},{"title":"Debug Process-based game servers using LocalMultiplayerAgent","description":"Debug a PlayFab multiplayer game server locally by wrapping your existing server and running it under LocalMultiplayerAgent in process (non-container) mode.","sidebarTitle":"Debug Process-based game server","href":"/services/playfab/multiplayer/servers/LocalMultiplayerAgent/run-process-based-gameserver"}]},{"group":"Unreal GSDK","icon":"unreal-engine","pages":[{"title":"PlayFab Unreal GSDK Plugin Overview","description":"Overview of the PlayFab Unreal GSDK plugin for integrating dedicated game servers with PlayFab Multiplayer Servers using Blueprint or C++ APIs.","href":"/services/playfab/multiplayer/servers/server-sdks/unreal-gsdk/index"},{"title":"GSDK Example Project Creation","description":"Create an Unreal ThirdPersonMP example project with networking, multiplayer, and dedicated server support as a starting point for PlayFab GSDK integration.","href":"/services/playfab/multiplayer/servers/server-sdks/unreal-gsdk/third-person-mp-example-project-setup"},{"title":"GSDK Project Setup","description":"Add and configure the PlayFab GSDK plugin in an Unreal Engine ThirdPersonMP project so the dedicated server build can be hosted on PlayFab Multiplayer Servers.","href":"/services/playfab/multiplayer/servers/server-sdks/unreal-gsdk/third-person-mp-example-gsdk-project-setup"},{"title":"Building your Unreal Example Project","description":"Build the Unreal ThirdPersonMP example project for PlayFab Multiplayer Servers, covering Development Editor, game client, and dedicated server configurations.","href":"/services/playfab/multiplayer/servers/server-sdks/unreal-gsdk/building-the-third-person-mp-example-project"},{"title":"GSDK Project Testing and Debugging","description":"Test and debug your Unreal GSDK ThirdPersonMP multiplayer game server locally with LocalMultiplayerAgent and attach a debugger before uploading to PlayFab.","href":"/services/playfab/multiplayer/servers/server-sdks/unreal-gsdk/third-person-mp-example-project-local-deployment-and-debugging"},{"title":"GSDK Project Cloud Deployment","description":"Deploy an Unreal Engine GSDK Windows server build to the PlayFab Multiplayer Servers (MPS) cloud for iterative testing before switching to Linux for production.","href":"/services/playfab/multiplayer/servers/server-sdks/unreal-gsdk/third-person-mp-example-project-cloud-deployment"},{"title":"Deploy Linux Unreal Server to MPS Cloud","description":"Build and deploy an Unreal Engine 5 Linux dedicated server to PlayFab Multiplayer Servers (MPS), with notes on cross-compiling from Windows and UE 4.26 or 4.27.","href":"/services/playfab/multiplayer/servers/server-sdks/unreal-gsdk/setting-up-a-linux-dedicated-server-on-playfab"},{"title":"Connect to Cloud-Hosted Unreal Server","description":"Connect Unreal Engine clients to a PlayFab Multiplayer Servers (MPS) hosted dedicated server build using a dev utility that bypasses standard allocation.","href":"/services/playfab/multiplayer/servers/server-sdks/unreal-gsdk/connect-to-mps-hosted-build"}]},{"group":"Billing \u0026 Samples","icon":"file-invoice-dollar","pages":[{"title":"Billing for PlayFab Multiplayer Servers 2.0","description":"How billing works for PlayFab Multiplayer Servers (Thunderhead), a service for operating a dynamically scaling pool of custom game servers in Azure.","sidebarTitle":"PlayFab services billing","href":"/services/playfab/multiplayer/servers/billing-for-thunderhead"},{"title":"Azure Enterprise Agreement (EA) billing for PlayFab services","description":"How high-volume customers can bill PlayFab Multiplayer Servers, Party, and other services through an Azure Enterprise Agreement (EA) subscription.","sidebarTitle":"Enterprise Agreement (EA) billing","href":"/services/playfab/multiplayer/servers/ea-billing"},{"title":"PlayFab incident response procedures","description":"How PlayFab handles multiplayer service incidents, including severity levels, customer emergency tickets, and status communication during mitigation.","sidebarTitle":"Incident response commitment","href":"/services/playfab/multiplayer/servers/comm-sla"},{"title":"Windows Runner sample","description":"Set up the Windows Runner C# sample for PlayFab Multiplayer Servers to build and deploy a minimal GSDK-integrated Windows game server for testing MPS features.","sidebarTitle":"Windows Runner C#","href":"/services/playfab/multiplayer/servers/windows-runner-sample"},{"title":"Wrapper sample","description":"Use the Wrapper (wrappingGsdk) sample to run an existing Windows or Linux game server on PlayFab Multiplayer Servers without adding GSDK calls to your binary.","sidebarTitle":"Wrapper","href":"/services/playfab/multiplayer/servers/wrapper-sample"}]}]},{"group":"Matchmaking","expanded":false,"pages":[{"title":"Matchmaking","description":"Overview of PlayFab Matchmaking, a SmartMatch-based service for pairing players into balanced sessions using rules, attributes, teams, and regional queues.","sidebarTitle":"Overview","href":"/services/playfab/multiplayer/matchmaking/index"},{"title":"How matchmaking works","description":"Understand the PlayFab matchmaking loop: how tickets are seeded, ranked by distance score, validated against queue rules, and grouped into complete matches.","href":"/services/playfab/multiplayer/matchmaking/how-matchmaking-works"},{"title":"Matchmaking SDK quickstart","description":"Quickstart walkthrough for the PlayFab Multiplayer SDK matchmaking client flow: initialize the library, submit a ticket, and receive match results.","sidebarTitle":"Quickstart - Client SDK","href":"/services/playfab/multiplayer/matchmaking/quickstart-client-sdk"},{"title":"Matchmaking quickstart","description":"Quickstart walkthrough of a full PlayFab Matchmaking flow in Unity: create tickets, poll status, and retrieve match results using the Multiplayer SDK.","sidebarTitle":"Quickstart - REST API","href":"/services/playfab/multiplayer/matchmaking/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Configuring matchmaking queues","description":"Configure PlayFab Matchmaking queues with rules, teams, attributes, and expansion policies in Game Manager to shape how players are matched together.","href":"/services/playfab/multiplayer/matchmaking/config-queues"},{"title":"Displaying queue statistics in your title","description":"Query and display PlayFab Matchmaking queue statistics such as ticket counts and wait times to give players feedback while searching for a match.","href":"/services/playfab/multiplayer/matchmaking/display-statistics"},{"title":"Handling common error cases","description":"Handle common PlayFab Matchmaking error cases including ticket cancellation, timeouts, invalid attributes, and match creation failures in your title.","href":"/services/playfab/multiplayer/matchmaking/error-cases"},{"title":"Integrating with PlayFab Multiplayer Servers","description":"Learn how to configure a PlayFab matchmaking queue to automatically allocate a Multiplayer Server build or build alias for each completed match.","href":"/services/playfab/multiplayer/matchmaking/multiplayer-servers"},{"title":"Matchmaking scenario and configuration examples","description":"Sample PlayFab Matchmaking queue configurations covering skill-based matching, region selection, team rules, and attribute expansion for common game modes.","href":"/services/playfab/multiplayer/matchmaking/config-examples"},{"title":"Specifying attributes with your tickets","description":"Learn how to attach player and ticket attributes to PlayFab matchmaking tickets so queue rules can evaluate skill, latency, and other criteria.","href":"/services/playfab/multiplayer/matchmaking/ticket-attributes"},{"title":"Understanding rule weight in matchmaking","description":"Understand how the Weight property on PlayFab matchmaking rules controls candidate ranking, match quality, and how tickets are sorted during matching.","href":"/services/playfab/multiplayer/matchmaking/rule-weights"},{"title":"Matchmaking scaling","description":"How PlayFab Matchmaking partitions large queues to scale under load, and how partitioning affects match quality, wait times, and ticket distribution.","sidebarTitle":"How matchmaking scales under load","href":"/services/playfab/multiplayer/matchmaking/matchmaking-partition"},{"title":"Using Server Backfill Tickets - Multiplayer SDK","description":"Learn how to create and use PlayFab server backfill tickets with the Multiplayer SDK to fill vacant slots in an in-progress matchmaking game session.","sidebarTitle":"Using server backfill tickets - Multiplayer SDK","href":"/services/playfab/multiplayer/matchmaking/backfill-tickets-multiplayer-sdk"},{"title":"Using Server Backfill Tickets - REST API","description":"Create and manage PlayFab Matchmaking backfill tickets via the REST API to add players to matches already in progress and keep game servers full.","sidebarTitle":"Using server backfill tickets - REST API","href":"/services/playfab/multiplayer/matchmaking/backfill-tickets"},{"title":"Analyzing Your Matchmaking Queue Usage","description":"Learn how to interpret the PlayFab Matchmaking Usage Charts in Game Manager to analyze queue throughput, ticket volume, and match wait times.","href":"/services/playfab/multiplayer/matchmaking/usage"},{"title":"Workaround for peer-to-peer connection","description":"Use PlayFab Matchmaking to exchange IP addresses and connection information between matched players for peer-to-peer multiplayer session hosting.","href":"/services/playfab/multiplayer/matchmaking/peer-to-peer"}]}]},{"group":"Lobby","expanded":false,"pages":[{"title":"PlayFab Lobby overview","description":"Overview of PlayFab Lobby: a cross-platform service for grouping players before a match, managing membership, invites, properties, and lobby ownership.","sidebarTitle":"Overview","href":"/services/playfab/multiplayer/lobby/index"},{"title":"Lobby SDK Quickstart","description":"Set up the PlayFab Multiplayer C/C++ SDK and create your first PlayFab Lobby with this quickstart covering prerequisites, integration, and initial API calls.","sidebarTitle":"Quickstart","href":"/services/playfab/multiplayer/lobby/lobby-getting-started"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Create a lobby","description":"Create client-owned or server-owned PlayFab Lobby instances, configure max players, access policy, and initial member properties for multiplayer sessions.","href":"/services/playfab/multiplayer/lobby/create-a-lobby"},{"title":"Lobby invites","description":"Send and accept PlayFab Lobby invitations, use invitation listeners, and control who can invite others through lobby member and owner privileges.","sidebarTitle":"Invites","href":"/services/playfab/multiplayer/lobby/lobby-invites"},{"title":"Join lobbies","description":"Join PlayFab Lobbies using a lobby ID, connection string, or invitation, and handle member joins, initial properties, and access policy restrictions.","href":"/services/playfab/multiplayer/lobby/join-lobbies"},{"title":"PlayFab Lobby custom properties","description":"Use PlayFab Lobby custom properties to store lobby-level and member-level state, control visibility, and expose searchable properties for lobby discovery.","sidebarTitle":"Lobby properties","href":"/services/playfab/multiplayer/lobby/lobby-properties"},{"title":"Create searchable lobbies","description":"Define search keys and searchable string or number properties on PlayFab Lobby so players can filter and discover public game sessions efficiently.","href":"/services/playfab/multiplayer/lobby/define-search-keywords"},{"title":"Find lobbies","description":"Search public PlayFab Lobbies using filter and sort strings on searchable properties, member count, and distance-based ordering for lobby discovery.","href":"/services/playfab/multiplayer/lobby/find-lobbies"},{"title":"Lobby ownership","description":"Understand PlayFab Lobby ownership models — client, server, and shared — plus owner privileges, migration policies, and handling owner disconnects.","href":"/services/playfab/multiplayer/lobby/owner-requirements-and-privileges"},{"title":"Lobby ownership changes","description":"Configure PlayFab Lobby owner migration policies and proactive owner promotion to control how ownership transfers when the current lobby owner leaves.","href":"/services/playfab/multiplayer/lobby/ownership-changes"},{"title":"Lobby lifetime and expiration","description":"Understand PlayFab Lobby TTL, default expiration, and how client-owned, server-owned, and connected lobbies affect lifetime and automatic deletion behavior.","href":"/services/playfab/multiplayer/lobby/lobby-ttl"},{"title":"Use lobby and matchmaking together","description":"Learn how to combine PlayFab Lobby and Matchmaking, including arranged lobbies, to build multiplayer scenarios that group players and coordinate game sessions.","href":"/services/playfab/multiplayer/lobby/lobby-and-matchmaking"},{"title":"Game Servers and Lobbies","description":"Use PlayFab Lobbies from a dedicated game server by enabling server APIs, authenticating game_server entities, and creating or claiming server-owned lobbies.","sidebarTitle":"Game servers and Lobbies","href":"/services/playfab/multiplayer/lobby/lobby-server-overview"},{"title":"Async Lobby and Matchmaking C++ SDK operations guide","description":"Understand async operations, polling, and state change notifications in the PlayFab Lobby and Matchmaking C++ SDK, with best practices for multiplayer titles.","sidebarTitle":"Client SDK async model","href":"/services/playfab/multiplayer/lobby/lobby-and-matchmaking-client-sdk-async"},{"title":"Handling Lobby and Matchmaking C++ SDK errors","description":"Reference for handling synchronous and asynchronous errors surfaced by the PlayFab Lobby and Matchmaking C++ SDK, including HRESULT codes and error messages.","sidebarTitle":"Handling Client SDK errors","href":"/services/playfab/multiplayer/lobby/lobby-and-matchmaking-client-sdk-errors"}]},{"title":"Lobby and Matchmaking real-time messages","description":"How the PlayFab Lobby and Matchmaking SDK delivers real-time PubSub messages for lobby membership, property changes, and matchmaking ticket state updates.","href":"/services/playfab/multiplayer/lobby/lobby-and-matchmaking-real-time-messages"},{"group":"Reference","expanded":false,"pages":[{"title":"PFMultiplayer C/C++ API overview - PFLobby.h","description":"PFMultiplayer C/C++ API overview - PFLobby.h","sidebarTitle":"C++ SDK reference","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members"},{"title":"PlayFab Multiplayer C++ SDK Error Codes","description":"Error codes used by the PlayFab Multiplayer, Lobby, and Matchmaking APIs","sidebarTitle":"Client SDK Error Codes","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayererrors"},{"group":"Playfabmultiplayerreference Cpp","pages":[{"group":"Pflobby","pages":[{"group":"Constants","pages":[{"title":"PFLobby Search Keys","description":"Reference for the predefined PFLobby search keys used by the PlayFab Multiplayer C++ SDK when querying lobbies through matchmaking and lobby search APIs.","sidebarTitle":"Pre-defined Search Keys","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/constants/pflobbysearchkeys"}]},{"group":"Enums","pages":[{"title":"PFLobbyAccessPolicy","description":"Enumeration of PFLobbyAccessPolicy values in the PlayFab Multiplayer C++ SDK that control whether a lobby is public, friends-only, or private to invitees.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbyaccesspolicy"},{"title":"PFLobbyDisconnectingReason","description":"PFLobbyDisconnectingReason values in the PlayFab Multiplayer C++ SDK describing why a client lost access to a lobby, useful for reconnection handling.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbydisconnectingreason"},{"title":"PFLobbyInviteListenerStatus","description":"PFLobbyInviteListenerStatus values in the PlayFab Multiplayer C++ SDK that report whether a title's lobby invite listener is active, stopped, or has failed.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbyinvitelistenerstatus"},{"title":"PFLobbyMemberConnectionStatus","description":"PFLobbyMemberConnectionStatus values indicating whether a PlayFab lobby member is connected to the real-time notification service in the Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbymemberconnectionstatus"},{"title":"PFLobbyMemberRemovedReason","description":"PFLobbyMemberRemovedReason values in the PlayFab Multiplayer C++ SDK that explain why a member was removed from a lobby, such as leaving, kick, or disconnect.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbymemberremovedreason"},{"title":"PFLobbyMembershipLock","description":"PFLobbyMembershipLock enum values in the PlayFab Multiplayer C++ SDK describing whether a lobby is locked or unlocked to new members joining the session.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbymembershiplock"},{"title":"PFLobbyOwnerMigrationPolicy","description":"PFLobbyOwnerMigrationPolicy values in the PlayFab Multiplayer C++ SDK that control how lobby ownership transfers between members when the current owner leaves.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbyownermigrationpolicy"},{"title":"PFLobbyServerConnectionStatus","description":"PFLobbyServerConnectionStatus values indicating whether a PlayFab lobby server is connected to the real-time notification service in the Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbyserverconnectionstatus"},{"title":"PFLobbyStateChangeType","description":"PFLobbyStateChangeType enum in the PlayFab Multiplayer C++ SDK identifies which asynchronous lobby state change occurred so titles can dispatch and handle it.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbystatechangetype"}]},{"group":"Functions","pages":[{"title":"PFLobbyAddMember","description":"PFLobbyAddMember reference for the PlayFab Multiplayer C++ SDK, used to add a local user as a new member of an existing lobby created or joined by the title.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyaddmember"},{"title":"PFLobbyForceRemoveMember","description":"PFLobbyForceRemoveMember reference in the PlayFab Multiplayer C++ SDK, letting the lobby owner forcibly remove another PlayFab entity from a lobby it owns.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyforceremovemember"},{"title":"PFLobbyGetAccessPolicy","description":"PFLobbyGetAccessPolicy reference for reading the current PFLobbyAccessPolicy value on a PlayFab lobby using the PlayFab Multiplayer C++ SDK lobby APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetaccesspolicy"},{"title":"PFLobbyGetConnectionString","description":"PFLobbyGetConnectionString reference for retrieving the default connection string used to join a PlayFab lobby via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetconnectionstring"},{"title":"PFLobbyGetCustomContext","description":"PFLobbyGetCustomContext reference for reading the app-defined pointer context previously attached to a lobby handle in the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetcustomcontext"},{"title":"PFLobbyGetLobbyId","description":"PFLobbyGetLobbyId reference for retrieving the unique lobby identifier from a PFLobbyHandle using the PlayFab Multiplayer C++ SDK lobby APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetlobbyid"},{"title":"PFLobbyGetLobbyProperty","description":"PFLobbyGetLobbyProperty reference for reading a lobby-scoped custom property value by key from a PlayFab lobby in the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetlobbyproperty"},{"title":"PFLobbyGetLobbyPropertyKeys","description":"PFLobbyGetLobbyPropertyKeys reference for enumerating the keys of custom lobby properties set on a PlayFab lobby via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetlobbypropertykeys"},{"title":"PFLobbyGetMaxMemberCount","description":"PFLobbyGetMaxMemberCount reference for reading the maximum number of members allowed in a PlayFab lobby using the PlayFab Multiplayer C++ SDK APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmaxmembercount"},{"title":"PFLobbyGetMemberConnectionStatus","description":"PFLobbyGetMemberConnectionStatus reference for querying whether a PlayFab lobby member is connected to the notification service in the Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmemberconnectionstatus"},{"title":"PFLobbyGetMemberProperty","description":"PFLobbyGetMemberProperty reference for reading a specific member's custom property value by key on a PlayFab lobby via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmemberproperty"},{"title":"PFLobbyGetMemberPropertyKeys","description":"PFLobbyGetMemberPropertyKeys reference for enumerating a member's custom property keys on a PlayFab lobby with the PlayFab Multiplayer C++ SDK APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmemberpropertykeys"},{"title":"PFLobbyGetMembers","description":"PFLobbyGetMembers reference for retrieving the list of PlayFab entities currently joined as members of a lobby using the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmembers"},{"title":"PFLobbyGetMembershipLock","description":"PFLobbyGetMembershipLock reference for reading the current membership lock state of a PlayFab lobby via the PlayFab Multiplayer C++ SDK lobby APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmembershiplock"},{"title":"PFLobbyGetOwner","description":"PFLobbyGetOwner reference for retrieving the PlayFab entity that currently owns a lobby using the PlayFab Multiplayer C++ SDK for multiplayer titles.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetowner"},{"title":"PFLobbyGetOwnerMigrationPolicy","description":"PFLobbyGetOwnerMigrationPolicy reference for reading the configured owner migration policy on a PlayFab lobby via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetownermigrationpolicy"},{"title":"PFLobbyGetRestrictInvitesToLobbyOwner","description":"PFLobbyGetRestrictInvitesToLobbyOwner reference for checking whether only the lobby owner is permitted to send invites in the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetrestrictinvitestolobbyowner"},{"title":"PFLobbyGetSearchProperty","description":"PFLobbyGetSearchProperty reference for reading a searchable property value by key on a PlayFab lobby using the PlayFab Multiplayer C++ SDK lobby APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetsearchproperty"},{"title":"PFLobbyGetSearchPropertyKeys","description":"PFLobbyGetSearchPropertyKeys reference for enumerating the keys of searchable properties on a PlayFab lobby via the PlayFab Multiplayer C++ SDK APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetsearchpropertykeys"},{"title":"PFLobbyGetServer","description":"PFLobbyGetServer reference for retrieving the game_server entity currently joined to a PlayFab lobby using the PlayFab Multiplayer C++ SDK lobby APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetserver"},{"title":"PFLobbyGetServerConnectionStatus","description":"PFLobbyGetServerConnectionStatus reference for querying the lobby server's connection state to the notification service in the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetserverconnectionstatus"},{"title":"PFLobbyGetServerProperty","description":"PFLobbyGetServerProperty reference for reading a server-scoped custom property value by key on a PlayFab lobby via the PlayFab Multiplayer C++ SDK APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetserverproperty"},{"title":"PFLobbyGetServerPropertyKeys","description":"PFLobbyGetServerPropertyKeys reference for enumerating the keys of server-scoped custom properties on a PlayFab lobby with the Multiplayer C++ SDK APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetserverpropertykeys"},{"title":"PFLobbyLeave","description":"PFLobbyLeave reference for requesting that one or all local users leave a PlayFab lobby using the asynchronous PlayFab Multiplayer C++ SDK lobby APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyleave"},{"title":"PFLobbyPostUpdate","description":"PFLobbyPostUpdate reference for posting a lobby or member data update as a player from the client using the PlayFab Multiplayer C++ SDK async lobby APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbypostupdate"},{"title":"PFLobbySendInvite","description":"PFLobbySendInvite reference for sending a lobby invitation from the local PlayFab user to another entity using the PlayFab Multiplayer C++ SDK lobby APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbysendinvite"},{"title":"PFLobbyServerDeleteLobby","description":"PFLobbyServerDeleteLobby reference for deleting a server-owned PlayFab lobby on behalf of the game_server entity through the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverdeletelobby"},{"title":"PFLobbyServerLeaveAsServer","description":"PFLobbyServerLeaveAsServer reference for having a game_server leave a client-owned PlayFab lobby it previously joined via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverleaveasserver"},{"title":"PFLobbyServerPostUpdate","description":"PFLobbyServerPostUpdate reference for posting a lobby data update as the server owner of a server-owned PlayFab lobby via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverpostupdate"},{"title":"PFLobbyServerPostUpdateAsServer","description":"PFLobbyServerPostUpdateAsServer reference for posting an update to a client-owned PlayFab lobby from a joined game_server via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverpostupdateasserver"},{"title":"PFLobbySetCustomContext","description":"PFLobbySetCustomContext reference for attaching an app-defined pointer context value to a PlayFab lobby handle using the PlayFab Multiplayer C++ SDK APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbysetcustomcontext"},{"title":"PFMultiplayerClaimServerLobby","description":"PFMultiplayerClaimServerLobby reference for claiming ownership of an existing server-owned PlayFab lobby as a game_server via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerclaimserverlobby"},{"title":"PFMultiplayerConnectToLobby","description":"PFMultiplayerConnectToLobby reference for connecting a local PlayFab entity to a lobby it was previously added to via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerconnecttolobby"},{"title":"PFMultiplayerCreateAndClaimServerLobby","description":"PFMultiplayerCreateAndClaimServerLobby reference for creating a new server-owned PlayFab lobby as a game_server entity through the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayercreateandclaimserverlobby"},{"title":"PFMultiplayerCreateAndJoinLobby","description":"PFMultiplayerCreateAndJoinLobby reference for creating a new PlayFab lobby and adding the creating client entity to it via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayercreateandjoinlobby"},{"title":"PFMultiplayerFindLobbies","description":"PFMultiplayerFindLobbies reference for searching PlayFab lobbies on behalf of a local user using filter and sort strings in the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfindlobbies"},{"title":"PFMultiplayerFinishProcessingLobbyStateChanges","description":"PFMultiplayerFinishProcessingLobbyStateChanges reference for returning previously delivered lobby state change entries in the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfinishprocessinglobbystatechanges"},{"title":"PFMultiplayerGetLobbyInviteListenerStatus","description":"PFMultiplayerGetLobbyInviteListenerStatus reference for retrieving an entity's current lobby invite listener status via the PlayFab Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayergetlobbyinvitelistenerstatus"},{"title":"PFMultiplayerJoinArrangedLobby","description":"Join a PlayFab lobby using an arrangement string from matchmaking or another service; the lobby initializes from configuration if no one has joined.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerjoinarrangedlobby"},{"title":"PFMultiplayerJoinLobby","description":"PFMultiplayerJoinLobby reference for joining an existing PlayFab lobby as the local PlayFab entity using a connection string in the Multiplayer C++ SDK.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerjoinlobby"},{"title":"PFMultiplayerJoinLobbyAsServer","description":"PFMultiplayerJoinLobbyAsServer reference for joining a client-owned PlayFab lobby as a game_server entity through the PlayFab Multiplayer C++ SDK lobby APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerjoinlobbyasserver"},{"title":"PFMultiplayerStartListeningForLobbyInvites","description":"PFMultiplayerStartListeningForLobbyInvites reference for enabling the lobby invite listener for a PlayFab entity via the PlayFab Multiplayer C++ SDK APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerstartlisteningforlobbyinvites"},{"title":"PFMultiplayerStartProcessingLobbyStateChanges","description":"Retrieves the array of PFLobbyStateChange entries for a PlayFab Multiplayer lobby to process since the last call, letting the title update state or UI.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerstartprocessinglobbystatechanges"},{"title":"PFMultiplayerStopListeningForLobbyInvites","description":"Disables the PlayFab Multiplayer Lobby invite listener for a given entity so it stops receiving incoming lobby invitation notifications.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerstoplisteningforlobbyinvites"}]},{"group":"Structs","pages":[{"title":"PFLobbyAddMemberCompletedStateChange","description":"Details of the AddMemberCompleted PlayFab Multiplayer lobby state change, delivered when a local user has finished being added to a lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyaddmembercompletedstatechange"},{"title":"PFLobbyArrangedJoinConfiguration","description":"Initial configuration data passed when joining an arranged PlayFab Multiplayer lobby, including member properties and access policy settings.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyarrangedjoinconfiguration"},{"title":"PFLobbyClaimServerLobbyCompletedStateChange","description":"Details of the ClaimServerLobbyCompleted PlayFab Multiplayer state change, provided when a game server has finished claiming an existing lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyclaimserverlobbycompletedstatechange"},{"title":"PFLobbyConnectToLobbyCompletedStateChange","description":"Details of the ConnectToLobbyCompleted PlayFab Multiplayer state change, delivered when a client has finished connecting to a lobby via a connection string.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyconnecttolobbycompletedstatechange"},{"title":"PFLobbyCreateAndClaimServerLobbyCompletedStateChange","description":"Details of the CreateAndClaimServerLobbyCompleted PlayFab Multiplayer state change, raised when a game server finishes creating and claiming a lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbycreateandclaimserverlobbycompletedstatechange"},{"title":"PFLobbyCreateAndJoinLobbyCompletedStateChange","description":"Details of the CreateAndJoinLobbyCompleted PlayFab Multiplayer state change, delivered when a client finishes creating and joining a new lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbycreateandjoinlobbycompletedstatechange"},{"title":"PFLobbyCreateConfiguration","description":"Initial configuration data used when creating a PlayFab Multiplayer lobby, including max member count, access policy, and searchable properties.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbycreateconfiguration"},{"title":"PFLobbyDataUpdate","description":"Request structure used to update the shared portion of a PlayFab Multiplayer lobby, including properties, search data, and owner or membership settings.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbydataupdate"},{"title":"PFLobbyDisconnectedStateChange","description":"Details of the Disconnected PlayFab Multiplayer lobby state change, delivered once the client has fully disconnected from the lobby service.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbydisconnectedstatechange"},{"title":"PFLobbyDisconnectingStateChange","description":"Details of the Disconnecting PlayFab Multiplayer lobby state change, raised when a client begins the process of disconnecting from a lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbydisconnectingstatechange"},{"title":"PFLobbyFindLobbiesCompletedStateChange","description":"Details of the FindLobbiesCompleted PlayFab Multiplayer state change, delivered when a lobby search finishes and returns matching lobby results.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyfindlobbiescompletedstatechange"},{"title":"PFLobbyForceRemoveMemberCompletedStateChange","description":"Details of the ForceRemoveMemberCompleted PlayFab Multiplayer state change, delivered when the lobby owner finishes forcibly removing a member.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyforceremovemembercompletedstatechange"},{"title":"PFLobbyInviteListenerStatusChangedStateChange","description":"Details of the InviteListenerStatusChanged PlayFab Multiplayer state change, raised when a lobby invite listener transitions to a new status.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyinvitelistenerstatuschangedstatechange"},{"title":"PFLobbyInviteReceivedStateChange","description":"Details of the InviteReceived PlayFab Multiplayer state change, delivered when a listening entity receives an incoming invitation to join a lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyinvitereceivedstatechange"},{"title":"PFLobbyJoinArrangedLobbyCompletedStateChange","description":"Details of the JoinArrangedLobbyCompleted PlayFab Multiplayer state change, raised when a client finishes joining an arranged matchmaking lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange"},{"title":"PFLobbyJoinConfiguration","description":"Initial configuration data used when a client joins an existing PlayFab Multiplayer lobby, including the joining member's initial property values.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinconfiguration"},{"title":"PFLobbyJoinLobbyAsServerCompletedStateChange","description":"Details of the JoinLobbyAsServerCompleted PlayFab Multiplayer state change, raised when a game server finishes joining a client-owned lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinlobbyasservercompletedstatechange"},{"title":"PFLobbyJoinLobbyCompletedStateChange","description":"Details of the JoinLobbyCompleted PlayFab Multiplayer state change, delivered when a client user finishes joining a lobby via a connection string.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinlobbycompletedstatechange"},{"title":"PFLobbyLeaveLobbyCompletedStateChange","description":"Details of the LeaveLobbyCompleted PlayFab Multiplayer state change, raised when one or more local users have finished leaving a lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyleavelobbycompletedstatechange"},{"title":"PFLobbyMemberAddedStateChange","description":"Details of the MemberAdded PlayFab Multiplayer state change, raised when a new member has been added to the lobby by a remote or local client.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberaddedstatechange"},{"title":"PFLobbyMemberDataUpdate","description":"Request structure used to update the member-owned portion of a PlayFab Multiplayer lobby, including per-member properties for a local user.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberdataupdate"},{"title":"PFLobbyMemberRemovedStateChange","description":"Details of the MemberRemoved PlayFab Multiplayer state change, raised when a member has left or been removed from the lobby along with the reason.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberremovedstatechange"},{"title":"PFLobbyMemberUpdateSummary","description":"Hints describing an update successfully applied to a PlayFab Multiplayer lobby on behalf of a member, listing changed properties and connection status.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberupdatesummary"},{"title":"PFLobbyPostUpdateCompletedStateChange","description":"Details of the PostUpdateCompleted PlayFab Multiplayer state change, raised when a requested lobby data or member update has finished processing.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbypostupdatecompletedstatechange"},{"title":"PFLobbySearchConfiguration","description":"Configuration struct for PFMultiplayerFindLobbies: specifies friends filter, filter string, sort string, and client search result count for lobby searches.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbysearchconfiguration"},{"title":"PFLobbySearchFriendsFilter","description":"Filter structure that restricts PlayFab Multiplayer lobby search results to lobbies owned by the searching player's friends, including external friend sources.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbysearchfriendsfilter"},{"title":"PFLobbySearchResult","description":"PFLobbySearchResult struct: an entry in the collection of lobby search results returned upon successful completion of a PFMultiplayerFindLobbies call.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbysearchresult"},{"title":"PFLobbySendInviteCompletedStateChange","description":"Details of the SendInviteCompleted PlayFab Multiplayer state change, raised when a request to send a lobby invitation to another entity finishes.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbysendinvitecompletedstatechange"},{"title":"PFLobbyServerDataUpdate","description":"Request structure used by a game server to update the server-owned state of a client-owned PlayFab Multiplayer lobby, including properties and search data.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverdataupdate"},{"title":"PFLobbyServerDeleteLobbyCompletedStateChange","description":"Details of the ServerDeleteLobbyCompleted PlayFab Multiplayer state change, raised when a game server finishes deleting a lobby it previously claimed.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverdeletelobbycompletedstatechange"},{"title":"PFLobbyServerJoinConfiguration","description":"Initial configuration data used when a game server joins a client-owned PlayFab Multiplayer lobby, including initial server properties and search data.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverjoinconfiguration"},{"title":"PFLobbyServerLeaveLobbyAsServerCompletedStateChange","description":"Details of the ServerLeaveLobbyAsServerCompleted PlayFab Multiplayer state change, raised when a game server finishes leaving a client-owned lobby.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverleavelobbyasservercompletedstatechange"},{"title":"PFLobbyServerPostUpdateAsServerCompletedStateChange","description":"Details of the ServerPostUpdateAsServerCompleted PlayFab Multiplayer state change, raised when a server update to a client-owned lobby finishes processing.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverpostupdateasservercompletedstatechange"},{"title":"PFLobbyServerPostUpdateCompletedStateChange","description":"Details of the ServerPostUpdateCompleted PlayFab Multiplayer state change, raised when a server-owned lobby data update has finished processing.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverpostupdatecompletedstatechange"},{"title":"PFLobbyStateChange","description":"Generic base structure representing an event or state change delivered by the PlayFab Multiplayer Lobby library, used to dispatch specific derived changes.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbystatechange"},{"title":"PFLobbyUpdatedStateChange","description":"Details of the Updated PlayFab Multiplayer state change, raised when a lobby's shared or member data has been modified and clients should refresh state.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyupdatedstatechange"}]}]},{"group":"Pfmatchmaking","pages":[{"title":"PFMultiplayer C/C++ API overview - PFMatchmaking.h","description":"Overview of the PFMatchmaking.h header in the PlayFab Multiplayer C/C++ API, listing the functions, structs, and enums used to manage matchmaking tickets.","sidebarTitle":"Client SDK reference","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/pfmatchmaking_members"},{"group":"Enums","pages":[{"title":"PFMatchmakingStateChangeType","description":"Enumerates the types of state changes that can be produced by the PlayFab Multiplayer Matchmaking library, such as ticket status and completion events.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/enums/pfmatchmakingstatechangetype"},{"title":"PFMatchmakingTicketStatus","description":"Enumerates the possible states of a PlayFab Multiplayer matchmaking ticket, including creating, waiting for players, matched, canceled, and failed.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/enums/pfmatchmakingticketstatus"},{"title":"PFMultiplayerProtocolType","description":"Enumerates the network protocol types (TCP or UDP) used when connecting a client to a PlayFab Multiplayer game server port returned from matchmaking.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/enums/pfmultiplayerprotocoltype"}]},{"group":"Functions","pages":[{"title":"PFMatchmakingTicketCancel","description":"Cancels an in-progress PlayFab Multiplayer matchmaking ticket, stopping the search for a match and transitioning the ticket to a canceled status.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmatchmakingticketcancel"},{"title":"PFMatchmakingTicketGetCustomContext","description":"Retrieves the app's private, pointer-sized custom context value previously associated with a PlayFab Multiplayer matchmaking ticket via the setter function.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmatchmakingticketgetcustomcontext"},{"title":"PFMatchmakingTicketGetMatch","description":"Provides the resulting match details for a completed PlayFab Multiplayer matchmaking ticket, including matched members and server connection info.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmatchmakingticketgetmatch"},{"title":"PFMatchmakingTicketGetStatus","description":"Retrieves the current status of a PlayFab Multiplayer matchmaking ticket, such as creating, waiting for players, matched, canceled, or failed.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmatchmakingticketgetstatus"},{"title":"PFMatchmakingTicketGetTicketId","description":"Retrieves the unique ticket ID assigned to a PlayFab Multiplayer matchmaking ticket, used to join or reference the ticket from other client sessions.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmatchmakingticketgetticketid"},{"title":"PFMatchmakingTicketSetCustomContext","description":"Attaches an optional pointer-sized custom context value to a PlayFab Multiplayer matchmaking ticket for later retrieval by the application.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmatchmakingticketsetcustomcontext"},{"title":"PFMultiplayerCreateMatchmakingTicket","description":"Creates a PlayFab Multiplayer matchmaking ticket for one or more local users, submitting them to a specified queue to be matched with other players.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmultiplayercreatematchmakingticket"},{"title":"PFMultiplayerCreateServerBackfillTicket","description":"Creates a PlayFab Multiplayer server backfill ticket so a game server with open slots can be matched with additional players from a matchmaking queue.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmultiplayercreateserverbackfillticket"},{"title":"PFMultiplayerDestroyMatchmakingTicket","description":"Destroys a PlayFab Multiplayer matchmaking ticket and releases associated resources, without canceling the underlying matchmaking service request.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmultiplayerdestroymatchmakingticket"},{"title":"PFMultiplayerFinishProcessingMatchmakingStateChanges","description":"Returns the array of PlayFab Multiplayer matchmaking state changes previously retrieved for processing, releasing resources back to the library.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmultiplayerfinishprocessingmatchmakingstatechanges"},{"title":"PFMultiplayerJoinMatchmakingTicketFromId","description":"Joins one or more local users to an existing PlayFab Multiplayer matchmaking ticket using a ticket ID and queue name shared by the initial ticket creator.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmultiplayerjoinmatchmakingticketfromid"},{"title":"PFMultiplayerStartProcessingMatchmakingStateChanges","description":"Retrieves the array of PlayFab Multiplayer matchmaking state changes to process since the last call, letting the title respond to ticket and match updates.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/functions/pfmultiplayerstartprocessingmatchmakingstatechanges"}]},{"group":"Structs","pages":[{"title":"PFMatchmakingMatchDetails","description":"Detailed match information returned by a completed PlayFab Multiplayer matchmaking ticket, including matched members, team assignments, and server details.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingmatchdetails"},{"title":"PFMatchmakingMatchMember","description":"Represents a single member of a PlayFab Multiplayer matchmaking match result, including the player's entity key, team ID, and attribute payload.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingmatchmember"},{"title":"PFMatchmakingServerBackfillTicketConfiguration","description":"Configuration data used to create a PlayFab Multiplayer server backfill ticket, including timeout, queue name, and the existing matched members list.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingserverbackfillticketconfiguration"},{"title":"PFMatchmakingStateChange","description":"Generic base structure representing an event or state change delivered by the PlayFab Multiplayer Matchmaking library, dispatched to specific derived types.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingstatechange"},{"title":"PFMatchmakingTicketCompletedStateChange","description":"Details of the TicketCompleted PlayFab Multiplayer state change, raised when a matchmaking ticket has finished either by matching, canceling, or failing.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingticketcompletedstatechange"},{"title":"PFMatchmakingTicketConfiguration","description":"Configuration data used to create a PlayFab Multiplayer matchmaking ticket, including timeout, queue name, and options such as latency measurement usage.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingticketconfiguration"},{"title":"PFMatchmakingTicketStatusChangedStateChange","description":"Details of the TicketStatusChanged PlayFab Multiplayer state change, raised when a matchmaking ticket transitions between statuses such as waiting or matched.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingticketstatuschangedstatechange"},{"title":"PFMultiplayerPort","description":"Represents a network port exposed by a PlayFab Multiplayer game server, including the port name, number, and protocol used to connect matched clients.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmultiplayerport"},{"title":"PFMultiplayerServerDetails","description":"Reference for the PFMultiplayerServerDetails struct, which describes a PlayFab Multiplayer Server connection: FQDN, IPv4 address, ports, and region.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmultiplayerserverdetails"}]}]},{"group":"Pfmultiplayer","pages":[{"title":"PFMultiplayer C/C++ API overview - PFMultiplayer.h","description":"Index of the PFMultiplayer.h C/C++ API: functions, callbacks, enums, and structs for initializing and managing the PlayFab Multiplayer library.","sidebarTitle":"PFMultiplayer overview","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/pfmultiplayer_members"},{"title":"PFEntityKey - PlayFab Multiplayer SDK","description":"PFEntityKey in the PlayFab Multiplayer C++ SDK: a combined entity type and ID structure that uniquely identifies a single entity in Lobby and Matchmaking APIs.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/pfentitykey_clientsdk"},{"group":"Callbacks","pages":[{"title":"PFMultiplayerAllocateMemoryCallback","description":"Reference for the PFMultiplayerAllocateMemoryCallback used by the PlayFab Multiplayer C/C++ library to request a dynamically allocated memory buffer.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/callbacks/pfmultiplayerallocatememorycallback"},{"title":"PFMultiplayerFreeMemoryCallback","description":"A callback invoked every time a previously allocated memory buffer is no longer needed by the PlayFab Multiplayer library and can be freed.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/callbacks/pfmultiplayerfreememorycallback"}]},{"group":"Enums","pages":[{"title":"PFMultiplayerThreadId","description":"Reference for the PFMultiplayerThreadId enum, identifying internal PlayFab Multiplayer library threads used for setting CPU affinity, such as networking.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/enums/pfmultiplayerthreadid"}]},{"group":"Functions","pages":[{"title":"PFMultiplayerGetErrorMessage","description":"Reference for PFMultiplayerGetErrorMessage, which returns the human-readable message for an HRESULT error from the PlayFab Multiplayer C/C++ library.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayergeterrormessage"},{"title":"PFMultiplayerInitialize","description":"Reference for PFMultiplayerInitialize, which creates and initializes an instance of the PlayFab Multiplayer C/C++ library for lobby and matchmaking use.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayerinitialize"},{"title":"PFMultiplayerSetEntityToken","description":"Sets the authentication token used when performing library actions on behalf of an entity, replacing any previously set token for that entity.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayersetentitytoken"},{"title":"PFMultiplayerSetMemoryCallbacks","description":"Reference for PFMultiplayerSetMemoryCallbacks, letting you install custom allocate and free callbacks used by the PlayFab Multiplayer C/C++ library.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayersetmemorycallbacks"},{"title":"PFMultiplayerSetThreadAffinityMask","description":"Reference for PFMultiplayerSetThreadAffinityMask, which pins internal PlayFab Multiplayer library threads to specific CPU cores using an affinity mask.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayersetthreadaffinitymask"},{"title":"PFMultiplayerUninitialize","description":"Reference for PFMultiplayerUninitialize, which immediately reclaims resources for all objects tied to a PlayFab Multiplayer C/C++ library instance.","href":"/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayeruninitialize"}]}]}]},{"group":"Unity Multiplayer Api Reference","pages":[{"title":"PlayFab Multiplayer Unity SDK","description":"Reference index for the PlayFab Multiplayer Unity SDK, listing classes, enums, and delegates used for lobby and matchmaking integration in Unity games.","sidebarTitle":"Overview","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/index"},{"group":"PlayFab.Multiplayer","pages":[{"title":"LobbyAccessPolicy","description":"LobbyAccessPolicy members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyAccessPolicy"},{"title":"LobbyDisconnectingReason","description":"LobbyDisconnectingReason members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDisconnectingReason"},{"title":"LobbyInviteListenerStatus","description":"LobbyInviteListenerStatus members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyInviteListenerStatus"},{"title":"LobbyMemberConnectionStatus","description":"Values representing the current status of a member's connection status to the notification service","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyMemberConnectionStatus"},{"title":"LobbyMemberRemovedReason","description":"LobbyMemberRemovedReason members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyMemberRemovedReason"},{"title":"LobbyMembershipLock","description":"LobbyMembershipLock members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyMembershipLock"},{"title":"LobbyOwnerMigrationPolicy","description":"LobbyOwnerMigrationPolicy members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyOwnerMigrationPolicy"},{"title":"LobbyServerConnectionStatus","description":"LobbyServerConnectionStatus","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyServerConnectionStatus"},{"title":"LogLevelType enum","description":"LogLevelType members","sidebarTitle":"LogLevelType","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LogLevelType"},{"title":"MatchmakingTicketStatus","description":"MatchmakingTicketStatus members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicketStatus"},{"title":"MultiplayerProtocolType","description":"MultiplayerProtocolType members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerProtocolType"},{"group":"Lobby","pages":[{"title":"Lobby.AccessPolicy","description":"Lobby.AccessPolicy","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/AccessPolicy"},{"title":"Lobby.AddMember","description":"Lobby.AddMember","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/AddMember"},{"title":"Lobby.ConnectionString","description":"Lobby.ConnectionString","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/ConnectionString"},{"title":"Lobby.Context","description":"Lobby.Context","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/Context"},{"title":"Lobby.ForceRemoveMember","description":"Lobby.ForceRemoveMember","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/ForceRemoveMember"},{"title":"Lobby.GetLobbyProperties","description":"Lobby.GetLobbyProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetLobbyProperties"},{"title":"GetMemberConnectionStatus","description":"Retrieves a member's connection status to the notification service.","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetMemberConnectionStatus"},{"title":"Lobby.GetMemberProperties","description":"Lobby.GetMemberProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetMemberProperties"},{"title":"Lobby.GetMembers","description":"Lobby.GetMembers","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetMembers"},{"title":"Lobby.GetSearchProperties","description":"Lobby.GetSearchProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetSearchProperties"},{"title":"Lobby.GetServerConnectionStatus","description":"Lobby.GetServerConnectionStatus","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetServerConnectionStatus"},{"title":"Lobby.GetServerProperties","description":"Lobby.GetServerProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetServerProperties"},{"title":"Lobby.Id","description":"Lobby.Id","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/Id"},{"title":"Lobby.Leave","description":"Lobby.Leave","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/Leave"},{"title":"Lobby.LeaveAllLocalUsers","description":"Lobby.LeaveAllLocalUsers","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/LeaveAllLocalUsers"},{"title":"Lobby.LeaveAsServer","description":"Lobby.LeaveAsServer","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/LeaveAsServer"},{"title":"Lobby.MaxMemberCount","description":"Lobby.MaxMemberCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/MaxMemberCount"},{"title":"Lobby.MembershipLock","description":"Lobby.MembershipLock","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/MembershipLock"},{"title":"Lobby","description":"Lobby members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/overview"},{"title":"Lobby.OwnerMigrationPolicy","description":"Lobby.OwnerMigrationPolicy","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/OwnerMigrationPolicy"},{"title":"Lobby.PostUpdate","description":"Lobby.PostUpdate","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/PostUpdate"},{"title":"Lobby.PostUpdateAsServer","description":"Lobby.PostUpdateAsServer","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/PostUpdateAsServer"},{"title":"Lobby.SendInvite","description":"Lobby.SendInvite","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/SendInvite"},{"title":"Lobby.ServerDeleteLobby","description":"Lobby.ServerDeleteLobby","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/ServerDeleteLobby"},{"title":"Lobby.ServerPostUpdate","description":"Lobby.ServerPostUpdate","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/ServerPostUpdate"},{"title":"Lobby.TryGetOwner","description":"Lobby.TryGetOwner","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/TryGetOwner"},{"title":"Lobby.TryGetServer","description":"Lobby.TryGetServer","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/TryGetServer"}]},{"group":"LobbyArrangedJoinConfiguration","pages":[{"title":"LobbyArrangedJoinConfiguration.AccessPolicy","description":"LobbyArrangedJoinConfiguration.AccessPolicy","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyArrangedJoinConfiguration/AccessPolicy"},{"title":"LobbyArrangedJoinConfiguration","description":"LobbyArrangedJoinConfiguration","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyArrangedJoinConfiguration/LobbyArrangedJoinConfiguration"},{"title":"LobbyArrangedJoinConfiguration.MaxMemberCount","description":"LobbyArrangedJoinConfiguration.MaxMemberCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyArrangedJoinConfiguration/MaxMemberCount"},{"title":"LobbyArrangedJoinConfiguration.MemberProperties","description":"LobbyArrangedJoinConfiguration.MemberProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyArrangedJoinConfiguration/MemberProperties"},{"title":"LobbyArrangedJoinConfiguration class","description":"LobbyArrangedJoinConfiguration members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyArrangedJoinConfiguration/overview"},{"title":"LobbyArrangedJoinConfiguration.OwnerMigrationPolicy","description":"LobbyArrangedJoinConfiguration.OwnerMigrationPolicy","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyArrangedJoinConfiguration/OwnerMigrationPolicy"}]},{"group":"LobbyConstants","pages":[{"title":"LobbyConstants.LobbyAmMemberSearchKey","description":"Lobby.LobbyAmMemberSearchKey","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyAmMemberSearchKey"},{"title":"LobbyConstants.LobbyAmOwnerSearchKey","description":"LobbyConstants.LobbyAmOwnerSearchKey","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyAmOwnerSearchKey"},{"title":"LobbyConstants.LobbyClientRequestedSearchResultCountUpperLimit","description":"Maximum number of Lobby search results a client-entity caller may request in a FindLobbies call, defined on the PlayFab Multiplayer Unity LobbyConstants class.","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyClientRequestedSearchResultCountUpperLimit"},{"title":"LobbyConstants","description":"LobbyConstants","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyConstants"},{"title":"LobbyConstants.LobbyMaxLobbyPropertyCount","description":"LobbyConstants.LobbyMaxLobbyPropertyCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyMaxLobbyPropertyCount"},{"title":"Lobby.LobbyMaxMemberCountLowerLimit","description":"Lobby.LobbyMaxMemberCountLowerLimit","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyMaxMemberCountLowerLimit"},{"title":"Lobby.LobbyMaxMemberCountUpperLimit","description":"Lobby.LobbyMaxMemberCountUpperLimit","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyMaxMemberCountUpperLimit"},{"title":"Lobby.LobbyMaxMemberPropertyCount","description":"Lobby.LobbyMaxMemberPropertyCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyMaxMemberPropertyCount"},{"title":"Lobby.LobbyMaxSearchPropertyCount","description":"Lobby.LobbyMaxSearchPropertyCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyMaxSearchPropertyCount"},{"title":"Lobby.LobbyMemberCountRemainingKey","description":"Lobby.LobbyMemberCountRemainingKey","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyMemberCountRemainingSearchKey"},{"title":"Lobby.LobbyMemberCountSearchKey","description":"Lobby.LobbyMemberCountSearchKey","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyMemberCountSearchKey"},{"title":"LobbyConstants class","description":"LobbyConstants members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/overview"}]},{"group":"LobbyCreateConfiguration","pages":[{"title":"LobbyCreateConfiguration.AccessPolicy","description":"LobbyCreateConfiguration.AccessPolicy","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyCreateConfiguration/AccessPolicy"},{"title":"LobbyCreateConfiguration","description":"LobbyCreateConfiguration","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyCreateConfiguration/LobbyCreateConfiguration"},{"title":"LobbyCreateConfiguration.LobbyProperties","description":"LobbyCreateConfiguration.LobbyProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyCreateConfiguration/LobbyProperties"},{"title":"LobbyCreateConfiguration.MaxMemberCount","description":"LobbyCreateConfiguration.MaxMemberCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyCreateConfiguration/MaxMemberCount"},{"title":"LobbyCreateConfiguration class","description":"LobbyCreateConfiguration members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyCreateConfiguration/overview"},{"title":"LobbyCreateConfiguration.OwnerMigrationPolicy","description":"LobbyCreateConfiguration.OwnerMigrationPolicy","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyCreateConfiguration/OwnerMigrationPolicy"},{"title":"LobbyCreateConfiguration.SearchProperties","description":"LobbyCreateConfiguration.SearchProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyCreateConfiguration/SearchProperties"}]},{"group":"LobbyDataUpdate","pages":[{"title":"LobbyDataUpdate.AccessPolicy","description":"LobbyDataUpdate.AccessPolicy","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDataUpdate/AccessPolicy"},{"title":"LobbyDataUpdate","description":"LobbyDataUpdate","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDataUpdate/LobbyDataUpdate"},{"title":"LobbyDataUpdate.LobbyProperties","description":"LobbyDataUpdate.LobbyProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDataUpdate/LobbyProperties"},{"title":"LobbyDataUpdate.MaxMemberCount","description":"LobbyDataUpdate.MaxMemberCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDataUpdate/MaxMemberCount"},{"title":"LobbyDataUpdate.MembershipLock","description":"LobbyDataUpdate.MembershipLock","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDataUpdate/MembershipLock"},{"title":"LobbyDataUpdate.NewOwner","description":"LobbyDataUpdate.NewOwner","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDataUpdate/NewOwner"},{"title":"LobbyDataUpdate class","description":"LobbyDataUpdate members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDataUpdate/overview"},{"title":"LobbyDataUpdate.SearchProperties","description":"LobbyDataUpdate.SearchProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDataUpdate/SearchProperties"}]},{"group":"LobbyError","pages":[{"title":"LobbyError.FAILED","description":"LobbyError.FAILED","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyError/FAILED"},{"title":"LobbyError.InvalidArg","description":"LobbyError.InvalidArg","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyError/InvalidArg"},{"title":"LobbyError","description":"LobbyError","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyError/LobbyError"},{"title":"LobbyError class","description":"LobbyError members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyError/overview"},{"title":"LobbyError.SUCCEEDED","description":"LobbyError.SUCCEEDED","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyError/SUCCEEDED"},{"title":"LobbyError.Success","description":"LobbyError.Success","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyError/Success"}]},{"group":"LobbyJoinConfiguration","pages":[{"title":"LobbyJoinConfiguration","description":"LobbyJoinConfiguration","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyJoinConfiguration/LobbyJoinConfiguration"},{"title":"LobbyJoinConfiguration.MemberProperties","description":"LobbyJoinConfiguration.MemberProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyJoinConfiguration/MemberProperties"},{"title":"LobbyJoinConfiguration class","description":"LobbyJoinConfiguration members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyJoinConfiguration/overview"}]},{"group":"LobbyMemberUpdateSummary","pages":[{"title":"LobbyMemberUpdateSummary.ConnectionStatusUpdated","description":"LobbyMemberUpdateSummary.ConnectionStatusUpdated","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyMemberUpdateSummary/ConnectionStatusUpdated"},{"title":"LobbyMemberUpdateSummary.Member","description":"LobbyMemberUpdateSummary.Member","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyMemberUpdateSummary/Member"},{"title":"LobbyMemberUpdateSummary","description":"LobbyMemberUpdateSummary members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyMemberUpdateSummary/overview"},{"title":"LobbyMemberUpdateSummary.UpdatedMemberPropertyKeys","description":"LobbyMemberUpdateSummary.UpdatedMemberPropertyKeys","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyMemberUpdateSummary/UpdatedMemberPropertyKeys"}]},{"group":"LobbySearchConfiguration","pages":[{"title":"LobbySearchConfiguration.ClientSearchResultCount","description":"LobbySearchConfiguration.ClientSearchResultCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchConfiguration/ClientSearchResultCount"},{"title":"LobbySearchConfiguration.FilterString","description":"LobbySearchConfiguration.FilterString","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchConfiguration/FilterString"},{"title":"LobbySearchConfiguration.FriendsFilter","description":"LobbySearchConfiguration.FriendsFilter","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchConfiguration/FriendsFilter"},{"title":"LobbySearchConfiguration","description":"LobbySearchConfiguration","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchConfiguration/LobbySearchConfiguration"},{"title":"LobbySearchConfiguration class","description":"LobbySearchConfiguration members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchConfiguration/overview"},{"title":"LobbySearchConfiguration.SortString","description":"LobbySearchConfiguration.SortString","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchConfiguration/SortString"}]},{"group":"LobbySearchFriendsFilter","pages":[{"title":"LobbySearchFriendsFilter.IncludeFacebookFriends","description":"LobbySearchFriendsFilter.IncludeFacebookFriends","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchFriendsFilter/IncludeFacebookFriends"},{"title":"LobbySearchFriendsFilter.IncludeSteamFriends","description":"LobbySearchFriendsFilter.IncludeSteamFriends","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchFriendsFilter/IncludeSteamFriends"},{"title":"LobbySearchFriendsFilter.IncludeXboxFriendsToken","description":"LobbySearchFriendsFilter.IncludeXboxFriendsToken","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchFriendsFilter/IncludeXboxFriendsToken"},{"title":"LobbySearchFriendsFilter","description":"LobbySearchFriendsFilter members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchFriendsFilter/overview"}]},{"group":"LobbySearchResult","pages":[{"title":"LobbySearchResult.ConnectionString","description":"LobbySearchResult.ConnectionString","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/ConnectionString"},{"title":"LobbySearchResult.CurrentMemberCount","description":"LobbySearchResult.CurrentMemberCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/CurrentMemberCount"},{"title":"LobbySearchResult.Friends","description":"LobbySearchResult.Friends","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/Friends"},{"title":"LobbySearchResult.LobbyId","description":"LobbySearchResult.LobbyId","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/LobbyId"},{"title":"LobbySearchResult.MaxMemberCount","description":"LobbySearchResult.MaxMemberCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/MaxMemberCount"},{"title":"LobbySearchResult.MembershipLock","description":"LobbySearchResult.MembershipLock","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/MembershipLock"},{"title":"LobbySearchResult","description":"LobbySearchResult members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/overview"},{"title":"LobbySearchResult.OwnerEntity","description":"LobbySearchResult.OwnerEntity","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/OwnerEntity"},{"title":"LobbySearchResult.SearchProperties","description":"LobbySearchResult.SearchProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/SearchProperties"}]},{"group":"LobbyServerDataUpdate","pages":[{"title":"LobbyServerDataUpdate method","description":"This document describes the LobbyServerDataUpdate method.","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyServerDataUpdate/LobbyServerDataUpdate"},{"title":"LobbyServerDataUpdate.NewServer","description":"LobbyServerDataUpdate.NewServer","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyServerDataUpdate/NewServer"},{"title":"LobbyServerDataUpdate class","description":"This document describes the LobbyServerDataUpdate class.","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyServerDataUpdate/overview"},{"title":"LobbyServerDataUpdate.SearchProperties","description":"LobbyServerDataUpdate.SearchProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyServerDataUpdate/SearchProperties"}]},{"group":"LobbyServerJoinConfiguration","pages":[{"title":"LobbyServerJoinConfiguration method","description":"This document describes the LobbyServerJoinConfiguration method.","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyServerJoinConfiguration/LobbyServerJoinConfiguration"},{"title":"LobbyServerJoinConfiguration class","description":"This document describes the LobbyServerJoinConfiguration class.","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyServerJoinConfiguration/overview"},{"title":"LobbyServerJoinConfiguration.ServerProperties","description":"LobbyServerJoinConfiguration.ServerProperties","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyServerJoinConfiguration/ServerProperties"}]},{"group":"MatchmakingMatchDetails","pages":[{"title":"MatchmakingMatchDetails.LobbyArrangementString","description":"MatchmakingMatchDetails.LobbyArrangementString","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingMatchDetails/LobbyArrangementString"},{"title":"MatchmakingMatchDetails.MatchId","description":"MatchmakingMatchDetails.MatchId","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingMatchDetails/MatchId"},{"title":"MatchmakingMatchDetails.Members","description":"MatchmakingMatchDetails.Members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingMatchDetails/Members"},{"title":"MatchmakingMatchDetails","description":"MatchmakingMatchDetails members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingMatchDetails/overview"},{"title":"MatchmakingMatchDetails.RegionPreferences","description":"MatchmakingMatchDetails.RegionPreferences","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingMatchDetails/RegionPreferences"},{"title":"MatchmakingMatchDetails.ServerDetails","description":"MatchmakingMatchDetails.ServerDetails","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingMatchDetails/ServerDetails"}]},{"group":"MatchmakingTicket","pages":[{"title":"MatchmakingTicket.Cancel","description":"MatchmakingTicket.Cancel","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicket/Cancel"},{"title":"MatchmakingTicket.Context","description":"MatchmakingTicket.Context","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicket/Context"},{"title":"MatchmakingTicket.GetMatchDetails","description":"MatchmakingTicket.GetMatchDetails","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicket/GetMatchDetails"},{"title":"MatchmakingTicket","description":"MatchmakingTicket members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicket/overview"},{"title":"MatchmakingTicket.Status","description":"MatchmakingTicket.Status","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicket/Status"},{"title":"MatchmakingTicket.TicketId","description":"MatchmakingTicket.TicketId","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicket/TicketId"}]},{"group":"MatchmakingTicketMatchMember","pages":[{"title":"MatchmakingTicketMatchMember.AttributesJSON","description":"MatchmakingTicketMatchMember.AttributesJSON","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicketMatchMember/AttributesJSON"},{"title":"MatchmakingTicketMatchMember.EntityKey","description":"MatchmakingTicketMatchMember.EntityKey","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicketMatchMember/EntityKey"},{"title":"MatchmakingTicketMatchMember","description":"MatchmakingTicketMatchMember members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicketMatchMember/overview"},{"title":"MatchmakingTicketMatchMember.TeamId","description":"MatchmakingTicketMatchMember.TeamId","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingTicketMatchMember/TeamId"}]},{"group":"MatchUser","pages":[{"title":"MatchUser.LocalUser","description":"MatchUser.LocalUser","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchUser/LocalUser"},{"title":"MatchUser.LocalUserJsonAttributesJSON","description":"MatchUser.LocalUserJsonAttributesJSON","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchUser/LocalUserJsonAttributesJSON"},{"title":"MatchUser","description":"MatchUser constructor","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchUser/MatchUser"},{"title":"MatchUser struct","description":"MatchUser members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchUser/overview"},{"title":"MatchUser.TeamId","description":"MatchUser.TeamId","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchUser/TeamId"}]},{"group":"MultiplayerPort","pages":[{"title":"MultiplayerPort","description":"MultiplayerPort constructor","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerPort/MultiplayerPort"},{"title":"MultiplayerPort.Name","description":"MultiplayerPort.Name","sidebarTitle":"Name","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerPort/Name"},{"title":"MultiplayerPort.Num","description":"MultiplayerPort.Num","sidebarTitle":"Num","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerPort/Num"},{"title":"MultiplayerPort struct","description":"MultiplayerPort members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerPort/overview"},{"title":"MultiplayerPort.Protocol","description":"MultiplayerPort.Protocol","sidebarTitle":"Protocol","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerPort/Protocol"}]},{"group":"MultiplayerServerDetails","pages":[{"title":"MultiplayerServerDetails.Fqdn","description":"MultiplayerServerDetails.Fqdn","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerServerDetails/Fqdn"},{"title":"MultiplayerServerDetails.Ipv4Address","description":"MultiplayerServerDetails.Ipv4Address","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerServerDetails/Ipv4Address"},{"title":"MultiplayerServerDetails","description":"MultiplayerServerDetails constructor","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerServerDetails/MultiplayerServerDetails"},{"title":"MultiplayerServerDetails struct","description":"MultiplayerServerDetails members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerServerDetails/overview"},{"title":"MultiplayerServerDetails.Ports","description":"MultiplayerServerDetails.Ports","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerServerDetails/Ports"},{"title":"MultiplayerServerDetails.Region","description":"MultiplayerServerDetails.Region","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MultiplayerServerDetails/Region"}]},{"group":"PFEntityKey","pages":[{"title":"PFEntityKey.Id","description":"PFEntityKey.Id","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PFEntityKey/Id"},{"title":"PFEntityKey class","description":"PFEntityKey members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PFEntityKey/overview"},{"title":"PFEntityKey","description":"PFEntityKey","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PFEntityKey/PFEntityKey"},{"title":"PFEntityKey.Type","description":"PFEntityKey.Type","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PFEntityKey/Type"}]},{"group":"PlayFabMultiplayer","pages":[{"title":"PlayFabMultiplayer.CreateAndJoinLobby","description":"PlayFabMultiplayer.CreateAndJoinLobby","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/CreateAndJoinLobby"},{"title":"PlayFabMultiplayer.CreateMatchmakingTicket","description":"PlayFabMultiplayer.CreateMatchmakingTicket","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/CreateMatchmakingTicket"},{"title":"PlayFabMultiplayer.FindLobbies","description":"PlayFabMultiplayer.FindLobbies","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/FindLobbies"},{"title":"PlayFabMultiplayer.GetLobbyInviteListenerStatus","description":"PlayFabMultiplayer.GetLobbyInviteListenerStatus","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/GetLobbyInviteListenerStatus"},{"title":"PlayFabMultiplayer.Initialize","description":"PlayFabMultiplayer.Initialize","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/Initialize"},{"title":"PlayFabMultiplayer.IsInitialized","description":"PlayFabMultiplayer.IsInitialized","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/IsInitialized"},{"title":"PlayFabMultiplayer.JoinArrangedLobby","description":"PlayFabMultiplayer.JoinArrangedLobby","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/JoinArrangedLobby"},{"title":"PlayFabMultiplayer.JoinLobby","description":"PlayFabMultiplayer.JoinLobby","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/JoinLobby"},{"title":"PlayFabMultiplayer.JoinMatchmakingTicketFromId","description":"PlayFabMultiplayer.JoinMatchmakingTicketFromId","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/JoinMatchmakingTicketFromId"},{"title":"PlayFabMultiplayer.LobbyClientRequestedSearchResultCountUpperLimit","description":"Maximum number of Lobby search results a client-entity caller may request in a FindLobbies call, defined on the PlayFab Multiplayer Unity PlayFabMultiplayer.","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/LobbyClientRequestedSearchResultCountUpperLimit"},{"title":"PlayFabMultiplayer.LobbyMaxLobbyPropertyCount","description":"PlayFabMultiplayer.LobbyMaxLobbyPropertyCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/LobbyMaxLobbyPropertyCount"},{"title":"PlayFabMultiplayer.LobbyMaxMemberCountLowerLimit","description":"PlayFabMultiplayer.LobbyMaxMemberCountLowerLimit","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/LobbyMaxMemberCountLowerLimit"},{"title":"PlayFabMultiplayer.LobbyMaxMemberCountUpperLimit","description":"PlayFabMultiplayer.LobbyMaxMemberCountUpperLimit","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/LobbyMaxMemberCountUpperLimit"},{"title":"PlayFabMultiplayer.LobbyMaxMemberPropertyCount","description":"PlayFabMultiplayer.LobbyMaxMemberPropertyCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/LobbyMaxMemberPropertyCount"},{"title":"PlayFabMultiplayer.LobbyMaxSearchPropertyCount","description":"PlayFabMultiplayer.LobbyMaxSearchPropertyCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/LobbyMaxSearchPropertyCount"},{"title":"PlayFabMultiplayer.LobbyMaxServerPropertyCount","description":"PlayFabMultiplayer.LobbyMaxServerPropertyCount","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/LobbyMaxServerPropertyCount"},{"title":"PlayFabMultiplayer.LogLevel","description":"PlayFabMultiplayer.LogLevel","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/LogLevel"},{"title":"PlayFabMultiplayer.OnAddMemberCompleted","description":"PlayFabMultiplayer.OnAddMemberCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnAddMemberCompleted"},{"title":"PlayFabMultiplayer.OnError","description":"PlayFabMultiplayer.OnError","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnError"},{"title":"PlayFabMultiplayer.OnForceRemoveMemberCompleted","description":"PlayFabMultiplayer.OnForceRemoveMemberCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnForceRemoveMemberCompleted"},{"title":"PlayFabMultiplayer.OnLobbyCreateAndJoinCompleted","description":"PlayFabMultiplayer.OnLobbyCreateAndJoinCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyCreateAndJoinCompleted"},{"title":"PlayFabMultiplayer.OnLobbyDisconnected","description":"PlayFabMultiplayer.OnLobbyDisconnected","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyDisconnected"},{"title":"PlayFabMultiplayer.OnLobbyFindLobbiesCompleted","description":"PlayFabMultiplayer.OnLobbyFindLobbiesCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyFindLobbiesCompleted"},{"title":"PlayFabMultiplayer.OnLobbyInviteListenerStatusChanged","description":"PlayFabMultiplayer.OnLobbyInviteListenerStatusChanged","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyInviteListenerStatusChanged"},{"title":"PlayFabMultiplayer.OnLobbyInviteReceived","description":"PlayFabMultiplayer.OnLobbyInviteReceived","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyInviteReceived"},{"title":"PlayFabMultiplayer.OnLobbyJoinArrangedLobbyCompleted","description":"PlayFabMultiplayer.OnLobbyJoinArrangedLobbyCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyJoinArrangedLobbyCompleted"},{"title":"PlayFabMultiplayer.OnLobbyJoinCompleted","description":"PlayFabMultiplayer.OnLobbyJoinCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyJoinCompleted"},{"title":"PlayFabMultiplayer.OnLobbyLeaveCompleted","description":"PlayFabMultiplayer.OnLobbyLeaveCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyLeaveCompleted"},{"title":"PlayFabMultiplayer.OnLobbyMemberAdded","description":"PlayFabMultiplayer.OnLobbyMemberAdded","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyMemberAdded"},{"title":"PlayFabMultiplayer.OnLobbyMemberRemoved","description":"PlayFabMultiplayer.OnLobbyMemberRemoved","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyMemberRemoved"},{"title":"PlayFabMultiplayer.OnLobbyPostUpdateCompleted","description":"PlayFabMultiplayer.OnLobbyPostUpdateCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyPostUpdateCompleted"},{"title":"PlayFabMultiplayer.OnLobbySendInviteCompleted","description":"PlayFabMultiplayer.OnLobbySendInviteCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbySendInviteCompleted"},{"title":"PlayFabMultiplayer.OnLobbyUpdated","description":"PlayFabMultiplayer.OnLobbyUpdated","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyUpdated"},{"title":"PlayFabMultiplayer.OnMatchmakingTicketCompleted","description":"PlayFabMultiplayer.OnMatchmakingTicketCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnMatchmakingTicketCompleted"},{"title":"PlayFabMultiplayer.OnMatchmakingTicketStatusChanged","description":"PlayFabMultiplayer.OnMatchmakingTicketStatusChanged","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnMatchmakingTicketStatusChanged"},{"title":"PlayFabMultiplayer class","description":"PlayFabMultiplayer members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/overview"},{"title":"PlayFabMultiplayer","description":"PlayFabMultiplayer","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/PlayFabMultiplayer"},{"title":"PlayFabMultiplayer.ProcessLobbyStateChanges","description":"PlayFabMultiplayer.ProcessLobbyStateChanges","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/ProcessLobbyStateChanges"},{"title":"PlayFabMultiplayer.ProcessMatchmakingStateChanges","description":"PlayFabMultiplayer.ProcessMatchmakingStateChanges","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/ProcessMatchmakingStateChanges"},{"title":"PlayFabMultiplayer.SetEntityToken","description":"PlayFabMultiplayer.SetEntityToken","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/SetEntityToken"},{"title":"PlayFabMultiplayer.StartListeningForLobbyInvites","description":"PlayFabMultiplayer.StartListeningForLobbyInvites","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/StartListeningForLobbyInvites"},{"title":"PlayFabMultiplayer.StopListeningForLobbyInvites","description":"PlayFabMultiplayer.StopListeningForLobbyInvites","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/StopListeningForLobbyInvites"},{"title":"PlayFabMultiplayer.Uninitialize","description":"PlayFabMultiplayer.Uninitialize","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/Uninitialize"}]},{"group":"PlayFabMultiplayer.PlayFabMultiplayerServer","pages":[{"title":"ClaimServerLobby","description":"ClaimServerLobby","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/ClaimServerLobby"},{"title":"CreateAndClaimServerLobby","description":"CreateAndClaimServerLobby","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/CreateAndClaimServerLobby"},{"title":"CreateServerBackfillTicket","description":"CreateServerBackfillTicket","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/CreateServerBackfillTicket"},{"title":"PlayFabMultiplayerServer.JoinLobbyAsServer method","description":"This document describes the PlayFabMultiplayer.PlayFabMultiplayerServer.JoinLobbyAsServer.","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/JoinLobbyAsServer"},{"title":"PlayFabMultiplayerServer.OnJoinLobbyAsServerCompleted event","description":"PlayFabMultiplayer.PlayFabMultiplayerServer.OnJoinLobbyAsServerCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/OnJoinLobbyAsServerCompleted"},{"title":"PlayFabMultiplayerServer.OnServerLobbyClaimCompleted","description":"PlayFabMultiplayer.PlayFabMultiplayerServer.OnServerLobbyClaimCompleted","sidebarTitle":"OnServerLobbyClaimCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/OnServerLobbyClaimCompleted"},{"title":"OnServerLobbyCreateAndClaimCompleted event","description":"PlayFabMultiplayer.PlayFabMultiplayerServer.OnServerLobbyCreateAndClaimCompleted","sidebarTitle":"OnServerLobbyCreateAndClaimCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/OnServerLobbyCreateAndClaimCompleted"},{"title":"PlayFabMultiplayerServer.OnServerLobbyDeleteCompleted","description":"PlayFabMultiplayer.PlayFabMultiplayerServer.OnServerLobbyDeleteCompleted","sidebarTitle":"OnServerLobbyDeleteCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/OnServerLobbyDeleteCompleted"},{"title":"PlayFabMultiplayerServer.OnServerLobbyLeaveAsServerCompleted","description":"PlayFabMultiplayer.PlayFabMultiplayerServer.OnServerLobbyLeaveAsServerCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/OnServerLobbyLeaveAsServerCompleted"},{"title":"OnServerLobbyPostUpdateAsServerCompleted event","description":"PlayFabMultiplayer.PlayFabMultiplayerServer.OnServerLobbyPostUpdateAsServerCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/OnServerLobbyPostUpdateAsServerCompleted"},{"title":"PlayFabMultiplayerServer.OnServerLobbyPostUpdateCompleted","description":"PlayFabMultiplayer.PlayFabMultiplayerServer.OnServerLobbyPostUpdateCompleted","sidebarTitle":"OnServerLobbyPostUpdateCompleted","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/OnServerLobbyPostUpdateCompleted"},{"title":"PlayFabMultiplayerServer class","description":"PlayFabMultiplayerServer members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/overview"},{"title":"PlayFabMultiplayer.PlayFabMultiplayerServer","description":"PlayFabMultiplayer.PlayFabMultiplayerServer","sidebarTitle":"PlayFabMultiplayerServer","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer.PlayFabMultiplayerServer/PlayFabMultiplayerServer"}]},{"group":"PlayFabMultiplayerErrorArgs","pages":[{"title":"PlayFabMultiplayerErrorArgs.Code","description":"PlayFabMultiplayerErrorArgs.Code","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayerErrorArgs/Code"},{"title":"PlayFabMultiplayerErrorArgs.Message","description":"PlayFabMultiplayerErrorArgs.Message","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayerErrorArgs/Message"},{"title":"PlayFabMultiplayerErrorArgs","description":"PlayFabMultiplayerErrorArgs members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayerErrorArgs/overview"}]},{"group":"PlayfabMultiplayerEventProcessor","pages":[{"title":"PlayfabMultiplayerEventProcessor class","description":"PlayfabMultiplayerEventProcessor members","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayfabMultiplayerEventProcessor/overview"},{"title":"PlayfabMultiplayerEventProcessor","description":"PlayfabMultiplayerEventProcessor","href":"/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayfabMultiplayerEventProcessor/PlayfabMultiplayerEventProcessor"}]}]}]}]},{"group":"Real Time Messages","pages":[{"title":"Real-time messages for Lobby and Matchmaking APIs","description":"Overview of PlayFab Lobby and Matchmaking real-time messages, letting game clients subscribe over a persistent SignalR WebSocket to receive service updates.","sidebarTitle":"Overview","href":"/services/playfab/multiplayer/real-time-messages/overview"},{"title":"Real-time messages SignalR Hub","description":"Connect PlayFab Lobby and Matchmaking clients to the real-time messages SignalR Hub, including HubConnection setup, MsgPack encoding, and KeepAlive intervals.","sidebarTitle":"SignalR Hub","href":"/services/playfab/multiplayer/real-time-messages/signalr-hub"},{"title":"Subscribing to resources for real-time messages","description":"Subscribe PlayFab Lobby and Matchmaking clients to resource topics over the real-time messages SignalR Hub using a connection handle from StartOrRecoverSession.","sidebarTitle":"Subscribing To Resources","href":"/services/playfab/multiplayer/real-time-messages/subscribing-to-resources"},{"group":"Client Methods","pages":[{"title":"ReceiveMessage SignalR client method","description":"ReceiveMessage SignalR client method for PlayFab Lobby and Matchmaking real-time messages, invoked by the hub to deliver payloads from subscribed resources.","sidebarTitle":"ReceiveMessage","href":"/services/playfab/multiplayer/real-time-messages/client-methods/receive-message"},{"title":"ReceiveSubscriptionChangeMessage SignalR client method","description":"ReceiveSubscriptionChangeMessage SignalR client method notifying PlayFab Lobby and Matchmaking clients when a subscribe or unsubscribe request completes.","sidebarTitle":"ReceiveSubscriptionChangeMessage","href":"/services/playfab/multiplayer/real-time-messages/client-methods/receive-subscription-change-message"}]},{"group":"Server Methods","pages":[{"title":"AddEntityToSession SignalR server method","description":"AddEntityToSession SignalR server method for PlayFab real-time messages, adding another local entity to a shared session for multi-account devices.","sidebarTitle":"AddEntityToSession","href":"/services/playfab/multiplayer/real-time-messages/server-methods/add-entity-to-session"},{"title":"EndSession SignalR server method","description":"EndSession SignalR server method for PlayFab Lobby and Matchmaking real-time messages, cleanly closing an active subscription session and its connection handle.","sidebarTitle":"EndSession","href":"/services/playfab/multiplayer/real-time-messages/server-methods/end-session"},{"title":"RemoveEntityFromSession SignalR server method","description":"RemoveEntityFromSession SignalR server method for PlayFab real-time messages, detaching an entity previously joined to a shared subscription session.","sidebarTitle":"RemoveEntityFromSession","href":"/services/playfab/multiplayer/real-time-messages/server-methods/remove-entity-from-session"},{"title":"StartOrRecoverSession SignalR server method","description":"StartOrRecoverSession SignalR server method for PlayFab real-time messages, starting a session or restoring subscriptions after an unexpected disconnect.","sidebarTitle":"StartOrRecoverSession","href":"/services/playfab/multiplayer/real-time-messages/server-methods/start-or-recover-session"}]},{"group":"Types","pages":[{"title":"EndSessionRequest real-time messages type","description":"EndSessionRequest type for the PlayFab real-time messages SignalR Hub, carrying the W3C TraceContext traceParent header used to end an active session.","sidebarTitle":"EndSessionRequest","href":"/services/playfab/multiplayer/real-time-messages/types/end-session-request"},{"title":"EndSessionResponse real-time messages type","description":"EndSessionResponse type returned by the PlayFab real-time messages EndSession server method, containing ResponseStatus and a W3C TraceContext traceId.","sidebarTitle":"EndSessionResponse","href":"/services/playfab/multiplayer/real-time-messages/types/end-session-response"},{"title":"Message real-time messages type","description":"Message type delivered by ReceiveMessage on the PlayFab real-time messages SignalR Hub, carrying a topic string, binary payload, and TraceContext traceId.","sidebarTitle":"Message","href":"/services/playfab/multiplayer/real-time-messages/types/message"},{"title":"Response Status Values","description":"ResponseStatus values returned by PlayFab real-time messages SignalR server methods, including Success, InvalidRequest, TooManyRequests, and Unavailable.","sidebarTitle":"ResponseStatus","href":"/services/playfab/multiplayer/real-time-messages/types/response-status"},{"title":"SharedSessionRequest real-time messages type","description":"SharedSessionRequest type for PlayFab real-time messages AddEntityToSession and RemoveEntityFromSession, identifying a title_player_account by type and ID.","sidebarTitle":"SharedSessionRequest","href":"/services/playfab/multiplayer/real-time-messages/types/shared-session-request"},{"title":"SharedSessionResponse real-time messages type","description":"SharedSessionResponse type returned by PlayFab real-time messages AddEntityToSession and RemoveEntityFromSession, reporting entity count, status, and traceId.","sidebarTitle":"SharedSessionResponse","href":"/services/playfab/multiplayer/real-time-messages/types/shared-session-response"},{"title":"StartOrRecoverSessionRequest real-time messages type","description":"StartOrRecoverSessionRequest type for the PlayFab real-time messages SignalR Hub, optionally supplying an oldConnectionHandle to recover prior subscriptions.","sidebarTitle":"StartOrRecoverSessionRequest","href":"/services/playfab/multiplayer/real-time-messages/types/start-or-recover-session-request"},{"title":"StartOrRecoverSessionResponse real-time messages type","description":"StartOrRecoverSessionResponse type from the PlayFab real-time messages Hub, returning a newConnectionHandle plus any recoveredTopics after reconnecting.","sidebarTitle":"StartOrRecoverSessionResponse","href":"/services/playfab/multiplayer/real-time-messages/types/start-or-recover-session-response"},{"title":"SubscriptionChangeMessage real-time messages type","description":"SubscriptionChangeMessage type for PlayFab real-time messages, reporting subscribe or unsubscribe results like SubscribeSuccess or NoSubscription.","sidebarTitle":"SubscriptionChangeMessage","href":"/services/playfab/multiplayer/real-time-messages/types/subscription-change-message"}]}]}]},{"group":"Party networking","expanded":false,"pages":[{"group":"Overview","expanded":false,"pages":[{"title":"PlayFab Party overview","description":"Overview of PlayFab Party, the cross-platform, low-latency voice chat, text chat, and data communication service for multiplayer games on all major platforms.","sidebarTitle":"Overview","href":"/services/playfab/multiplayer/networking/index"},{"title":"PlayFab Party features","description":"Feature overview of PlayFab Party including low-latency data messaging, real-time voice chat, text-to-speech accessibility, and cross-platform networking.","sidebarTitle":"Features","href":"/services/playfab/multiplayer/networking/party-features"},{"title":"PlayFab Party objects and their relationships","description":"Learn the core PlayFab Party objects such as networks, devices, endpoints, and chat controls, and how they relate in real-time chat and data communication.","sidebarTitle":"Party objects and their relationships","href":"/services/playfab/multiplayer/networking/concepts-objects"}]},{"group":"Quickstart","expanded":false,"pages":[{"title":"Party Quickstart","description":"Quickstart for integrating the PlayFab Party SDK into a game: initialize the library, connect endpoints, and send voice and data across a network.","sidebarTitle":"Quickstart","href":"/services/playfab/multiplayer/networking/quickstart"},{"title":"Enabling PlayFab Party","description":"Step-by-step tutorial for enabling PlayFab Party on your title and validating chat and data communication using the Party sample and demo app.","sidebarTitle":"Enable Party in Game Manager","href":"/services/playfab/multiplayer/networking/enable-party"},{"title":"Linux getting started","description":"Linux-specific setup for the PlayFab Party SDK, covering supported distributions, required system libraries, and dedicated game server integration steps.","sidebarTitle":"Linux quickstart","href":"/services/playfab/multiplayer/networking/linux-specific-requirements"},{"title":"Android getting started","description":"Android-specific setup for the PlayFab Party SDK, including NDK requirements, JNI initialization, and audio and microphone permissions in the manifest.","sidebarTitle":"Android quickstart","href":"/services/playfab/multiplayer/networking/android-specific-requirements"},{"title":"iOS and macOS getting started","description":"iOS and macOS integration requirements for PlayFab Party, including Xcode framework linking, microphone entitlements, and background audio configuration.","sidebarTitle":"iOS and macOS quickstart","href":"/services/playfab/multiplayer/networking/apple-specific-requirements"},{"title":"Party Unity plugin quickstart","description":"Quickstart for adding the PlayFab Party plugin to a Unity project: install the package, authenticate players, and enable voice chat between endpoints.","sidebarTitle":"Party Unity Plugin quickstart","href":"/services/playfab/multiplayer/networking/party-unity-plugin-quickstart"}]},{"group":"Networking","expanded":false,"pages":[{"group":"Tutorials","expanded":false,"pages":[{"title":"PlayFab Party invitations and the security model","description":"Conceptual overview of how PlayFab Party invitations authorize players to join a network and how the security model gates access to chat and data.","sidebarTitle":"Invitations and the security model","href":"/services/playfab/multiplayer/networking/concepts-invitations-security-model"},{"title":"PlayFab Party networks and network discovery flows","description":"Conceptual guide to PlayFab Party network discovery: how players find, invite, and connect to Party chat and data networks in your multiplayer game.","sidebarTitle":"Integrate discovery with Party","href":"/services/playfab/multiplayer/networking/concepts-discovery"},{"title":"Transport options","description":"Compare PlayFab Party transport options including transparent cloud relay and direct peer connectivity, and how each affects latency, NAT, and reliability.","sidebarTitle":"Configuring transport behavior","href":"/services/playfab/multiplayer/networking/transport-options"},{"title":"Using direct peer-to-peer connections","description":"Enable direct peer connectivity in PlayFab Party to cut latency by routing traffic between endpoints directly rather than through the transparent cloud relay.","sidebarTitle":"Direct peer-to-peer connections","href":"/services/playfab/multiplayer/networking/concepts-direct-peer-connectivity"},{"title":"PlayFab Party port usage and firewall requirements","description":"Reference for the network ports and firewall rules required by PlayFab Party for real-time voice chat, text chat, and data communication traffic.","sidebarTitle":"Port Usage and Firewall Requirements","href":"/services/playfab/multiplayer/networking/concepts-port-usage"},{"title":"Using multiple PlayFab Party networks","description":"Guidance on when a multiplayer title should connect to more than one PlayFab Party network at once, and how to manage chat and data across them.","sidebarTitle":"Multiple network usage","href":"/services/playfab/multiplayer/networking/concepts-multiple-networks"},{"title":"Integrate Party with Lobby using Multiplayer SDK","description":"Walkthrough for combining the PlayFab Party SDK with the PlayFab Multiplayer SDK so players in a lobby share a single voice chat and data network.","sidebarTitle":"Integrate Party with Lobby","href":"/services/playfab/multiplayer/networking/party-lobby-integration"},{"title":"Request parties from your services with RequestPartyService","description":"Tutorial for calling the PlayFab RequestPartyService API from your own game services to provision Party networks for multiplayer chat and data sessions.","sidebarTitle":"Request Party from your own services","href":"/services/playfab/multiplayer/networking/party-tutorial-requestpartyservice"}]},{"group":"Regions and QoS","expanded":false,"pages":[{"title":"PlayFab Party QoS measurements","description":"How PlayFab Party uses QoS latency measurements to pick regions for network sessions and how titles can influence region selection for voice and data.","sidebarTitle":"QoS","href":"/services/playfab/multiplayer/networking/concepts-regions"},{"title":"Supported Azure regions","description":"Reference list of Azure regions where PlayFab Party is available for real-time voice chat and data communication, with region identifiers for network setup.","href":"/services/playfab/multiplayer/networking/supported-azure-regions"}]}]},{"group":"Reference","expanded":false,"pages":[{"title":"Party C/C++ API overview","description":"Party C/C++ API overview","sidebarTitle":"C++ SDK Reference","href":"/services/playfab/multiplayer/networking/reference/party_members"},{"title":"PlayFab Party Error Codes","description":"Error codes used by PlayFab Party APIs","sidebarTitle":"C++ SDK Error Codes","href":"/services/playfab/multiplayer/networking/reference/partyerrors"},{"title":"Party samples","description":"Sample projects for PlayFab Party demonstrating voice chat, data messaging, and cross-platform networking on PC, console, Unity, and Unreal Engine.","sidebarTitle":"Samples","href":"/services/playfab/multiplayer/networking/party-samples"},{"group":"C++ SDK Details","pages":[{"title":"PlayFab Party Typedefs","description":"Convenience typedefs defined for PlayFab Party","sidebarTitle":"Typedefs","href":"/services/playfab/multiplayer/networking/reference/typedefs"},{"group":"Callbacks","pages":[{"title":"PartyAllocateMemoryCallback","description":"A callback invoked every time the Party Library dynamically allocates a new memory buffer.","href":"/services/playfab/multiplayer/networking/reference/callbacks/partyallocatememorycallback"},{"title":"PartyFreeMemoryCallback","description":"A callback invoked every time a previously allocated memory buffer is no longer needed by the Party library and can be freed.","href":"/services/playfab/multiplayer/networking/reference/callbacks/partyfreememorycallback"},{"title":"PartyProfilingMethodEntranceCallback","description":"A callback invoked every time the Party library enters an instrumented method.","href":"/services/playfab/multiplayer/networking/reference/callbacks/partyprofilingmethodentrancecallback"},{"title":"PartyProfilingMethodExitCallback","description":"A callback invoked every time the Party library is about to exit an instrumented method.","href":"/services/playfab/multiplayer/networking/reference/callbacks/partyprofilingmethodexitcallback"}]},{"group":"Classes","pages":[{"group":"PartyAudioManipulationSinkStream","pages":[{"title":"PartyAudioManipulationSinkStream","description":"The management class for submitting audio to an audio sink stream.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/partyaudiomanipulationsinkstream"},{"group":"Methods","pages":[{"title":"PartyAudioManipulationSinkStream::GetConfiguration","description":"Retrieves the sink stream configuration.","sidebarTitle":"GetConfiguration","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_getconfiguration"},{"title":"PartyAudioManipulationSinkStream::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this sink stream object.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_getcustomcontext"},{"title":"PartyAudioManipulationSinkStream::GetFormat","description":"Retrieves the format of the buffers that will be submitted to.","sidebarTitle":"GetFormat","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_getformat"},{"title":"PartyAudioManipulationSinkStream::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this sink stream object.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_setcustomcontext"},{"title":"PartyAudioManipulationSinkStream::SubmitBuffer","description":"Submits audio to be processed by this sink. Depending on the type of sink, this audio may be transmitted to other chat controls or rendered to the audio output.","sidebarTitle":"SubmitBuffer","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_submitbuffer"}]}]},{"group":"PartyAudioManipulationSourceStream","pages":[{"title":"PartyAudioManipulationSourceStream","description":"The management class for obtaining audio from an audio source stream.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSourceStream/partyaudiomanipulationsourcestream"},{"group":"Methods","pages":[{"title":"PartyAudioManipulationSourceStream::GetAvailableBufferCount","description":"Retrieves the total number of buffers available to retrieve from this stream via.","sidebarTitle":"GetAvailableBufferCount","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSourceStream/methods/partyaudiomanipulationsourcestream_getavailablebuffercount"},{"title":"PartyAudioManipulationSourceStream::GetConfiguration","description":"Retrieves the source stream configuration.","sidebarTitle":"GetConfiguration","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSourceStream/methods/partyaudiomanipulationsourcestream_getconfiguration"},{"title":"PartyAudioManipulationSourceStream::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this source stream object.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSourceStream/methods/partyaudiomanipulationsourcestream_getcustomcontext"},{"title":"PartyAudioManipulationSourceStream::GetFormat","description":"Retrieves the format of the buffers that will be provided by.","sidebarTitle":"GetFormat","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSourceStream/methods/partyaudiomanipulationsourcestream_getformat"},{"title":"PartyAudioManipulationSourceStream::GetNextBuffer","description":"Gets the next buffer available in the stream.","sidebarTitle":"GetNextBuffer","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSourceStream/methods/partyaudiomanipulationsourcestream_getnextbuffer"},{"title":"PartyAudioManipulationSourceStream::ReturnBuffer","description":"Tells the library it can reclaim memory associated with this buffer.","sidebarTitle":"ReturnBuffer","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSourceStream/methods/partyaudiomanipulationsourcestream_returnbuffer"},{"title":"PartyAudioManipulationSourceStream::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this source stream object.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSourceStream/methods/partyaudiomanipulationsourcestream_setcustomcontext"}]}]},{"group":"PartyChatControl","pages":[{"title":"PartyChatControl","description":"The management class for chat operations.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/partychatcontrol"},{"group":"Methods","pages":[{"title":"PartyChatControl::ConfigureAudioManipulationVoiceStream","description":"Queues an asynchronous operation to configure the audio manipulation voice stream associated with this chat control.","sidebarTitle":"ConfigureAudioManipulationVoiceStream","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_configureaudiomanipulationvoicestream"},{"title":"PartyChatControl::GetAudioManipulationVoiceStream","description":"Retrieves the audio manipulation voice stream associated with this chat control.","sidebarTitle":"GetAudioManipulationVoiceStream","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getaudiomanipulationvoicestream"},{"title":"PartyChatControl::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this chat control object.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getcustomcontext"},{"title":"PartyChatControl::GetDevice","description":"Returns the device this chat control is associated with.","sidebarTitle":"GetDevice","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getdevice"},{"title":"PartyChatControl::GetEntityId","description":"Gets the PlayFab Entity ID of the user associated with this chat control.","sidebarTitle":"GetEntityId","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getentityid"},{"title":"PartyChatControl::GetEntityType","description":"Gets the PlayFab entity type of the user associated with this chat control.","sidebarTitle":"GetEntityType","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getentitytype"},{"title":"PartyChatControl::GetLocal","description":"Gets the [PartyLocalChatControl](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/partylocalchatcontrol) version of this chat.","sidebarTitle":"GetLocal","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getlocal"},{"title":"PartyChatControl::GetNetworks","description":"Gets the networks to which this chat control is connected.","sidebarTitle":"GetNetworks","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_getnetworks"},{"title":"PartyChatControl::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this chat control object.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyChatControl/methods/partychatcontrol_setcustomcontext"}]}]},{"group":"PartyDevice","pages":[{"title":"PartyDevice","description":"Represents a device across networks.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyDevice/partydevice"},{"group":"Methods","pages":[{"title":"PartyDevice::GetChatControls","description":"Gets the chat controls on this device.","sidebarTitle":"GetChatControls","href":"/services/playfab/multiplayer/networking/reference/classes/PartyDevice/methods/partydevice_getchatcontrols"},{"title":"PartyDevice::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this device object.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyDevice/methods/partydevice_getcustomcontext"},{"title":"PartyDevice::GetLocal","description":"Gets the [PartyLocalDevice](/services/playfab/multiplayer/networking/reference/classes/PartyLocalDevice/partylocaldevice) version of this device.","sidebarTitle":"GetLocal","href":"/services/playfab/multiplayer/networking/reference/classes/PartyDevice/methods/partydevice_getlocal"},{"title":"PartyDevice::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this device object.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyDevice/methods/partydevice_setcustomcontext"}]}]},{"group":"PartyEndpoint","pages":[{"title":"PartyEndpoint","description":"Represents an endpoint in a network.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/partyendpoint"},{"group":"Methods","pages":[{"title":"PartyEndpoint::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this endpoint object.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getcustomcontext"},{"title":"PartyEndpoint::GetDevice","description":"Gets the device associated with this endpoint.","sidebarTitle":"GetDevice","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getdevice"},{"title":"PartyEndpoint::GetEntityId","description":"Gets the PlayFab Entity ID of the user associated with this endpoint.","sidebarTitle":"GetEntityId","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getentityid"},{"title":"PartyEndpoint::GetEntityType","description":"Gets the PlayFab entity type of the user associated with this endpoint.","sidebarTitle":"GetEntityType","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getentitytype"},{"title":"PartyEndpoint::GetLocal","description":"Gets the [PartyLocalEndpoint](/services/playfab/multiplayer/networking/reference/classes/PartyLocalEndpoint/partylocalendpoint) version of this endpoint.","sidebarTitle":"GetLocal","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getlocal"},{"title":"PartyEndpoint::GetNetwork","description":"Gets the network associated with this endpoint.","sidebarTitle":"GetNetwork","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getnetwork"},{"title":"PartyEndpoint::GetSharedProperty","description":"Gets the value of a shared property.","sidebarTitle":"GetSharedProperty","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getsharedproperty"},{"title":"PartyEndpoint::GetUniqueIdentifier","description":"Gets the network-unique identifier for this endpoint.","sidebarTitle":"GetUniqueIdentifier","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_getuniqueidentifier"},{"title":"PartyEndpoint::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this endpoint object.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyEndpoint/methods/partyendpoint_setcustomcontext"}]}]},{"group":"PartyInvitation","pages":[{"title":"PartyInvitation","description":"Represents an invitation used to authenticate a user into a network.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyInvitation/partyinvitation"},{"group":"Methods","pages":[{"title":"PartyInvitation::GetCreatorEntityId","description":"Gets the PlayFab Entity ID of the user that created this invitation or nullptr if this invitation was generated as part of a.","sidebarTitle":"GetCreatorEntityId","href":"/services/playfab/multiplayer/networking/reference/classes/PartyInvitation/methods/partyinvitation_getcreatorentityid"},{"title":"PartyInvitation::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this invitation object.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyInvitation/methods/partyinvitation_getcustomcontext"},{"title":"PartyInvitation::GetInvitationConfiguration","description":"Gets this invitation's configuration.","sidebarTitle":"GetInvitationConfiguration","href":"/services/playfab/multiplayer/networking/reference/classes/PartyInvitation/methods/partyinvitation_getinvitationconfiguration"},{"title":"PartyInvitation::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this invitation object.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyInvitation/methods/partyinvitation_setcustomcontext"}]}]},{"group":"PartyLocalChatControl","pages":[{"title":"PartyLocalChatControl","description":"The management class for chat operations related to the local device.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/partylocalchatcontrol"},{"group":"Methods","pages":[{"title":"PartyLocalChatControl::ConfigureAudioManipulationCaptureStream","description":"Queues an asynchronous operation to configure the audio manipulation capture stream.","sidebarTitle":"ConfigureAudioManipulationCaptureStream","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_configureaudiomanipulationcapturestream"},{"title":"PartyLocalChatControl::ConfigureAudioManipulationRenderStream","description":"Queues an asynchronous operation to configure the audio manipulation render stream.","sidebarTitle":"ConfigureAudioManipulationRenderStream","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_configureaudiomanipulationrenderstream"},{"title":"PartyLocalChatControl::GetAudioInput","description":"Provides the preferred microphone or recording device that the chat control has been configured to use for audio input.","sidebarTitle":"GetAudioInput","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getaudioinput"},{"title":"PartyLocalChatControl::GetAudioInputMuted","description":"Provides whether the user's audio input is in the mute state.","sidebarTitle":"GetAudioInputMuted","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getaudioinputmuted"},{"title":"PartyLocalChatControl::GetAudioManipulationCaptureStream","description":"Retrieves the audio manipulation capture stream associated with this chat control.","sidebarTitle":"GetAudioManipulationCaptureStream","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getaudiomanipulationcapturestream"},{"title":"PartyLocalChatControl::GetAudioManipulationRenderStream","description":"Retrieves the manipulation render stream associated with this chat control.","sidebarTitle":"GetAudioManipulationRenderStream","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getaudiomanipulationrenderstream"},{"title":"PartyLocalChatControl::GetAudioOutput","description":"Provides the preferred speakers or headset device that the chat control has been configured to use for audio output.","sidebarTitle":"GetAudioOutput","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getaudiooutput"},{"title":"PartyLocalChatControl::GetAudioRenderVolume","description":"Provides the volume setting for audio received from a target chat control that will be used for the local chat control.","sidebarTitle":"GetAudioRenderVolume","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getaudiorendervolume"},{"title":"PartyLocalChatControl::GetAvailableTextToSpeechProfiles","description":"Gets the text-to-speech profiles for this chat control.","sidebarTitle":"GetAvailableTextToSpeechProfiles","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getavailabletexttospeechprofiles"},{"title":"PartyLocalChatControl::GetChatIndicator","description":"Provides a chat indicator specifying the audio state of a target chat control in relation to the local chat control.","sidebarTitle":"GetChatIndicator","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getchatindicator"},{"title":"PartyLocalChatControl::GetIncomingAudioMuted","description":"Provides whether the incoming audio from the target chat control, in relation to the local chat control, has previously been muted.","sidebarTitle":"GetIncomingAudioMuted","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getincomingaudiomuted"},{"title":"PartyLocalChatControl::GetIncomingTextMuted","description":"Provides whether the incoming text messages from the target chat control, in relation to the local chat control, has previously been muted.","sidebarTitle":"GetIncomingTextMuted","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getincomingtextmuted"},{"title":"PartyLocalChatControl::GetLanguage","description":"Gets the language associated with this chat control.","sidebarTitle":"GetLanguage","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getlanguage"},{"title":"PartyLocalChatControl::GetLocalChatIndicator","description":"Provides a chat indicator specifying the audio state of the local chat control.","sidebarTitle":"GetLocalChatIndicator","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getlocalchatindicator"},{"title":"PartyLocalChatControl::GetLocalUser","description":"Gets the local user associated with this local chat control.","sidebarTitle":"GetLocalUser","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getlocaluser"},{"title":"PartyLocalChatControl::GetPermissions","description":"Gets the voice communication relationship between the local chat control and a target chat control.","sidebarTitle":"GetPermissions","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getpermissions"},{"title":"PartyLocalChatControl::GetTextChatOptions","description":"Provides the text chat options associated with text chat for this chat control.","sidebarTitle":"GetTextChatOptions","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_gettextchatoptions"},{"title":"PartyLocalChatControl::GetTextToSpeechProfile","description":"Gets the profile that was last configured from a successfully completed.","sidebarTitle":"GetTextToSpeechProfile","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_gettexttospeechprofile"},{"title":"PartyLocalChatControl::GetTranscriptionOptions","description":"Provides the transcription options associated with voice chat audio for this chat control.","sidebarTitle":"GetTranscriptionOptions","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_gettranscriptionoptions"},{"title":"PartyLocalChatControl::GetVoiceAudioOptions","description":"Provides the voice audio options associated with this chat control.","sidebarTitle":"GetVoiceAudioOptions","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getvoiceaudiooptions"},{"title":"PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles","description":"Populates the local chat control's list of supported text-to-speech profiles.","sidebarTitle":"PopulateAvailableTextToSpeechProfiles","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_populateavailabletexttospeechprofiles"},{"title":"PartyLocalChatControl::SendText","description":"Transmits a chat text string to each specified target chat control.","sidebarTitle":"SendText","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_sendtext"},{"title":"PartyLocalChatControl::SetAudioInput","description":"Configures the preferred microphone or recording device that the chat control will use for audio input.","sidebarTitle":"SetAudioInput","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setaudioinput"},{"title":"PartyLocalChatControl::SetAudioInputMuted","description":"Configures whether the user's audio input is in the mute state.","sidebarTitle":"SetAudioInputMuted","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setaudioinputmuted"},{"title":"PartyLocalChatControl::SetAudioOutput","description":"Configures the preferred speakers or headset device that the chat control will use for audio output.","sidebarTitle":"SetAudioOutput","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setaudiooutput"},{"title":"PartyLocalChatControl::SetAudioRenderVolume","description":"Configures the volume setting for audio received from a target chat control that will be used for the local chat control.","sidebarTitle":"SetAudioRenderVolume","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setaudiorendervolume"},{"title":"PartyLocalChatControl::SetIncomingAudioMuted","description":"Configures whether the incoming audio from the target chat control, in relation to the local chat control, is muted.","sidebarTitle":"SetIncomingAudioMuted","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setincomingaudiomuted"},{"title":"PartyLocalChatControl::SetIncomingTextMuted","description":"Configures whether the incoming text messages from the target chat control, in relation to the local chat control, is muted.","sidebarTitle":"SetIncomingTextMuted","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setincomingtextmuted"},{"title":"PartyLocalChatControl::SetPermissions","description":"Sets the chat permissions between the local chat control and a target chat control.","sidebarTitle":"SetPermissions","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setpermissions"},{"title":"PartyLocalChatControl::SetTextChatOptions","description":"Configures the text chat options associated with text chat for this chat control.","sidebarTitle":"SetTextChatOptions","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_settextchatoptions"},{"title":"PartyLocalChatControl::SetTextToSpeechProfile","description":"Configures the profile to use for a specified type of text-to-speech operation.","sidebarTitle":"SetTextToSpeechProfile","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_settexttospeechprofile"},{"title":"PartyLocalChatControl::SetTranscriptionOptions","description":"Configures the transcription options associated with voice chat audio for this chat control.","sidebarTitle":"SetTranscriptionOptions","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_settranscriptionoptions"},{"title":"PartyLocalChatControl::SetVoiceAudioOptions","description":"Configures the voice audio options for this chat control.","sidebarTitle":"SetVoiceAudioOptions","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setvoiceaudiooptions"},{"title":"PartyLocalChatControl::SynthesizeTextToSpeech","description":"Generates text-to-speech audio that is used to either displace the microphone audio associated with this chat control or render directly to the chat.","sidebarTitle":"SynthesizeTextToSpeech","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_synthesizetexttospeech"}]}]},{"group":"PartyLocalDevice","pages":[{"title":"PartyLocalDevice","description":"Represents the local device.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalDevice/partylocaldevice"},{"group":"Methods","pages":[{"title":"PartyLocalDevice::CreateChatControl","description":"Queues an asynchronous operation to create a local chat control for the specified user.","sidebarTitle":"CreateChatControl","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalDevice/methods/partylocaldevice_createchatcontrol"},{"title":"PartyLocalDevice::DestroyChatControl","description":"Queues an asynchronous operation to destroy a local chat control.","sidebarTitle":"DestroyChatControl","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalDevice/methods/partylocaldevice_destroychatcontrol"}]}]},{"group":"PartyLocalEndpoint","pages":[{"title":"PartyLocalEndpoint","description":"Represents a local endpoint.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalEndpoint/partylocalendpoint"},{"group":"Methods","pages":[{"title":"PartyLocalEndpoint::FlushMessages","description":"Forces all queued messages to the specified endpoints from this local endpoint to be sent as soon as possible regardless of their coalesce settings.","sidebarTitle":"FlushMessages","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalEndpoint/methods/partylocalendpoint_flushmessages"},{"title":"PartyLocalEndpoint::GetEndpointStatistics","description":"Gets one or more statistic counter values for the specified target endpoints.","sidebarTitle":"GetEndpointStatistics","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalEndpoint/methods/partylocalendpoint_getendpointstatistics"},{"title":"PartyLocalEndpoint::GetLocalUser","description":"Gets the local user associated with this local endpoint.","sidebarTitle":"GetLocalUser","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalEndpoint/methods/partylocalendpoint_getlocaluser"},{"title":"PartyLocalEndpoint::SendMessage","description":"Sends a message to other endpoints in the network.","sidebarTitle":"SendMessage","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalEndpoint/methods/partylocalendpoint_sendmessage"}]}]},{"group":"PartyLocalUser","pages":[{"title":"PartyLocalUser","description":"Represents a local user.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/partylocaluser"},{"group":"Methods","pages":[{"title":"PartyLocalUser::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this local user object.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_getcustomcontext"},{"title":"PartyLocalUser::GetEntityId","description":"Gets the PlayFab Entity ID associated with this local user.","sidebarTitle":"GetEntityId","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_getentityid"},{"title":"PartyLocalUser::GetEntityType","description":"Gets the PlayFab entity type associated with this local user.","sidebarTitle":"GetEntityType","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_getentitytype"},{"title":"PartyLocalUser::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this local user object.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_setcustomcontext"},{"title":"PartyLocalUser::UpdateEntityToken","description":"Updates the PlayFab Entity Token associated with this local user, for use in future authenticated operations.","sidebarTitle":"UpdateEntityToken","href":"/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/methods/partylocaluser_updateentitytoken"}]}]},{"group":"PartyManager","pages":[{"title":"PartyManager","description":"The primary management class for interacting with the Party library.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/partymanager"},{"group":"Methods","pages":[{"title":"PartyManager::Cleanup","description":"Immediately reclaims all resources associated with all Party library objects.","sidebarTitle":"Cleanup","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_cleanup"},{"title":"PartyManager::ConnectToNetwork","description":"Queues an asynchronous attempt to connect to a network.","sidebarTitle":"ConnectToNetwork","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_connecttonetwork"},{"title":"PartyManager::CreateLocalUser","description":"Creates a local user object that is used to represent a local player when performing networking and chat operations.","sidebarTitle":"CreateLocalUser","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser"},{"title":"PartyManager::CreateLocalUserWithEntityType","description":"Creates a local user object that is used to represent a supported PlayFab Entity ID and type when performing networking and chat operations.","sidebarTitle":"CreateLocalUserWithEntityType","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype"},{"title":"PartyManager::CreateNewNetwork","description":"Queues an asynchronous attempt to create a new network.","sidebarTitle":"CreateNewNetwork","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createnewnetwork"},{"title":"PartyManager::DeserializeNetworkDescriptor","description":"Deserializes a network descriptor structure from an opaque string serialized via a prior call to.","sidebarTitle":"DeserializeNetworkDescriptor","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_deserializenetworkdescriptor"},{"title":"PartyManager::DestroyLocalUser","description":"Starts an asynchronous operation to destroy a local user.","sidebarTitle":"DestroyLocalUser","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_destroylocaluser"},{"title":"PartyManager::DoWork","description":"Synchronously performs the processing task associated with `threadId`.","sidebarTitle":"DoWork","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_dowork"},{"title":"PartyManager::FinishProcessingStateChanges","description":"Returns an array of PartyStateChanges that were being processed.","sidebarTitle":"FinishProcessingStateChanges","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_finishprocessingstatechanges"},{"title":"PartyManager::GetChatControls","description":"Gets an array that contains a combined list of all chat controls on the local device and all remote devices.","sidebarTitle":"GetChatControls","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getchatcontrols"},{"title":"PartyManager::GetErrorMessage","description":"Get the human-readable form of an error generated by the Party library.","sidebarTitle":"GetErrorMessage","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage"},{"title":"PartyManager::GetLocalDevice","description":"Gets the local device.","sidebarTitle":"GetLocalDevice","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getlocaldevice"},{"title":"PartyManager::GetLocalUsers","description":"Gets an array containing all local users created by.","sidebarTitle":"GetLocalUsers","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getlocalusers"},{"title":"PartyManager::GetMemoryCallbacks","description":"Retrieves the memory allocation and freeing callbacks the Party library is using.","sidebarTitle":"GetMemoryCallbacks","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getmemorycallbacks"},{"title":"PartyManager::GetNetworks","description":"Gets an array of all networks to which the local device is connected or connecting.","sidebarTitle":"GetNetworks","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getnetworks"},{"title":"PartyManager::GetOption","description":"Retrieves an option used to fine-tune Party library functionality.","sidebarTitle":"GetOption","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getoption"},{"title":"PartyManager::GetProfilingCallbacksForMethodEntryExit","description":"Retrieves the profiling event callbacks the Party library is configured to use when entering or exiting instrumented methods.","sidebarTitle":"GetProfilingCallbacksForMethodEntryExit","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getprofilingcallbacksformethodentryexit"},{"title":"PartyManager::GetRegions","description":"Gets an array containing the set of regions for which your title is configured, along with round trip latency information.","sidebarTitle":"GetRegions","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getregions"},{"title":"PartyManager::GetSingleton","description":"Retrieves a reference to the PartyManager singleton instance.","sidebarTitle":"GetSingleton","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getsingleton"},{"title":"PartyManager::GetThreadAffinityMask","description":"Retrieves the current set of processors on which internal Party library threads will run or are running as an affinity mask.","sidebarTitle":"GetThreadAffinityMask","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getthreadaffinitymask"},{"title":"PartyManager::GetWorkMode","description":"Retrieves the current work mode of the Party library's internal processing task associated with `threadId`.","sidebarTitle":"GetWorkMode","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getworkmode"},{"title":"PartyManager::Initialize","description":"Initializes the PartyManager object instance.","sidebarTitle":"Initialize","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_initialize"},{"title":"PartyManager::SerializeNetworkDescriptor","description":"Serializes a network descriptor structure into an opaque string that is safe to communicate over title and platform-specific communication channels.","sidebarTitle":"SerializeNetworkDescriptor","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_serializenetworkdescriptor"},{"title":"PartyManager::SetMemoryCallbacks","description":"Optionally configures the memory allocation and freeing callbacks the Party library should use.","sidebarTitle":"SetMemoryCallbacks","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setmemorycallbacks"},{"title":"PartyManager::SetOption","description":"Configures an option to fine-tune Party library functionality.","sidebarTitle":"SetOption","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setoption"},{"title":"PartyManager::SetProfilingCallbacksForMethodEntryExit","description":"Optionally configures the profiling event callbacks the Party library will make when entering or exiting instrumented methods.","sidebarTitle":"SetProfilingCallbacksForMethodEntryExit","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setprofilingcallbacksformethodentryexit"},{"title":"PartyManager::SetThreadAffinityMask","description":"Optionally configures the processor on which internal Party library threads run.","sidebarTitle":"SetThreadAffinityMask","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setthreadaffinitymask"},{"title":"PartyManager::SetWorkMode","description":"Configures the work mode of the Party library processing task associated with `threadId`.","sidebarTitle":"SetWorkMode","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setworkmode"},{"title":"PartyManager::StartProcessingStateChanges","description":"Retrieves an array of all PartyStateChanges to process since the last such call.","sidebarTitle":"StartProcessingStateChanges","href":"/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_startprocessingstatechanges"}]}]},{"group":"PartyNetwork","pages":[{"title":"PartyNetwork","description":"Represents a network.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/partynetwork"},{"group":"Methods","pages":[{"title":"PartyNetwork::AuthenticateLocalUser","description":"Queues an asynchronous operation to authenticate the specified local user into the network.","sidebarTitle":"AuthenticateLocalUser","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_authenticatelocaluser"},{"title":"PartyNetwork::ConnectChatControl","description":"Connects the local chat control to the network.","sidebarTitle":"ConnectChatControl","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_connectchatcontrol"},{"title":"PartyNetwork::CreateEndpoint","description":"Queues an asynchronous attempt to create a local endpoint.","sidebarTitle":"CreateEndpoint","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_createendpoint"},{"title":"PartyNetwork::CreateInvitation","description":"Queues an asynchronous attempt to create an invitation for the network.","sidebarTitle":"CreateInvitation","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_createinvitation"},{"title":"PartyNetwork::DestroyEndpoint","description":"Queues an asynchronous operation to destroy a local endpoint.","sidebarTitle":"DestroyEndpoint","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_destroyendpoint"},{"title":"PartyNetwork::DisconnectChatControl","description":"Disconnects the local chat control from the network.","sidebarTitle":"DisconnectChatControl","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_disconnectchatcontrol"},{"title":"PartyNetwork::FindEndpointByUniqueIdentifier","description":"Finds the endpoint with the corresponding network-unique identifier in this network, if it exists.","sidebarTitle":"FindEndpointByUniqueIdentifier","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_findendpointbyuniqueidentifier"},{"title":"PartyNetwork::GetChatControls","description":"Gets the chat controls connected to this network.","sidebarTitle":"GetChatControls","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getchatcontrols"},{"title":"PartyNetwork::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this network object.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getcustomcontext"},{"title":"PartyNetwork::GetDeviceConnectionType","description":"Retrieves the type of connection used by the local device for transmitting messages or chat data to the specified target device in this network.","sidebarTitle":"GetDeviceConnectionType","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getdeviceconnectiontype"},{"title":"PartyNetwork::GetDevices","description":"Gets the devices in this network.","sidebarTitle":"GetDevices","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getdevices"},{"title":"PartyNetwork::GetEndpoints","description":"Gets the endpoints in this network.","sidebarTitle":"GetEndpoints","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getendpoints"},{"title":"PartyNetwork::GetEndpointsByUserType","description":"Gets a subset of endpoints in this network filtered by user type and owning device location.","sidebarTitle":"GetEndpointsByUserType","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getendpointsbyusertype"},{"title":"PartyNetwork::GetInvitations","description":"Gets an array containing all invitations exposed to the local device.","sidebarTitle":"GetInvitations","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getinvitations"},{"title":"PartyNetwork::GetLocalUsers","description":"Gets an array containing the local users that are authenticated or authenticating into the network.","sidebarTitle":"GetLocalUsers","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getlocalusers"},{"title":"PartyNetwork::GetNetworkConfiguration","description":"Gets the network configuration which was set when creating the network.","sidebarTitle":"GetNetworkConfiguration","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getnetworkconfiguration"},{"title":"PartyNetwork::GetNetworkDescriptor","description":"Gets the network descriptor for this network.","sidebarTitle":"GetNetworkDescriptor","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getnetworkdescriptor"},{"title":"PartyNetwork::GetNetworkStatistics","description":"Gets one or more statistic counter values for the network.","sidebarTitle":"GetNetworkStatistics","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_getnetworkstatistics"},{"title":"PartyNetwork::LeaveNetwork","description":"Queues an asynchronous operation to leave the network gracefully.","sidebarTitle":"LeaveNetwork","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_leavenetwork"},{"title":"PartyNetwork::RemoveLocalUser","description":"Queues an asynchronous operation to remove a local user from the network.","sidebarTitle":"RemoveLocalUser","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_removelocaluser"},{"title":"PartyNetwork::RevokeInvitation","description":"Queues an asynchronous attempt to revoke an invitation from the network.","sidebarTitle":"RevokeInvitation","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_revokeinvitation"},{"title":"PartyNetwork::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this network object.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_setcustomcontext"}]}]},{"group":"PartyTextToSpeechProfile","pages":[{"title":"PartyTextToSpeechProfile","description":"Represents the voice profile used to synthesize speech.","href":"/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/partytexttospeechprofile"},{"group":"Methods","pages":[{"title":"PartyTextToSpeechProfile::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this profile.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getcustomcontext"},{"title":"PartyTextToSpeechProfile::GetGender","description":"Gets the gender associated with this profile.","sidebarTitle":"GetGender","href":"/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getgender"},{"title":"PartyTextToSpeechProfile::GetIdentifier","description":"Gets the unique identifier associated with this profile.","sidebarTitle":"GetIdentifier","href":"/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getidentifier"},{"title":"PartyTextToSpeechProfile::GetLanguageCode","description":"Gets the language code associated with this profile.","sidebarTitle":"GetLanguageCode","href":"/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getlanguagecode"},{"title":"PartyTextToSpeechProfile::GetName","description":"Gets the human-readable name of this profile.","sidebarTitle":"GetName","href":"/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getname"},{"title":"PartyTextToSpeechProfile::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this profile.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_setcustomcontext"}]}]}]},{"group":"Enums","pages":[{"title":"PartyAudioDeviceSelectionType","description":"Options for selecting audio devices","href":"/services/playfab/multiplayer/networking/reference/enums/partyaudiodeviceselectiontype"},{"title":"PartyAudioInputState","description":"States of an audio input associated with a local chat control.","href":"/services/playfab/multiplayer/networking/reference/enums/partyaudioinputstate"},{"title":"PartyAudioOutputState","description":"States of an audio output associated with a local chat control.","href":"/services/playfab/multiplayer/networking/reference/enums/partyaudiooutputstate"},{"title":"PartyAudioSampleType","description":"Types of Party audio samples.","href":"/services/playfab/multiplayer/networking/reference/enums/partyaudiosampletype"},{"title":"PartyAudioSourceType","description":"Types of Party audio sources.","href":"/services/playfab/multiplayer/networking/reference/enums/partyaudiosourcetype"},{"title":"PartyChatControlChatIndicator","description":"Audio states for a target chat control in relation to a local chat control.","href":"/services/playfab/multiplayer/networking/reference/enums/partychatcontrolchatindicator"},{"title":"PartyChatPermissionOptions","description":"Options for defining the communication relationship between two chat controls.","href":"/services/playfab/multiplayer/networking/reference/enums/partychatpermissionoptions"},{"title":"PartyChatTextReceivedOptions","description":"Flags describing the received text message in PartyChatTextReceivedStateChange.","href":"/services/playfab/multiplayer/networking/reference/enums/partychattextreceivedoptions"},{"title":"PartyDestroyedReason","description":"Reasons an object might be destroyed.","href":"/services/playfab/multiplayer/networking/reference/enums/partydestroyedreason"},{"title":"PartyDeviceConnectionType","description":"The type of connection used for transmitting endpoint message or chat data to a device.","href":"/services/playfab/multiplayer/networking/reference/enums/partydeviceconnectiontype"},{"title":"PartyDirectPeerConnectivityOptions","description":"Flags controlling the attempted use of direct peer-to-peer connectivity among devices in a network.","href":"/services/playfab/multiplayer/networking/reference/enums/partydirectpeerconnectivityoptions"},{"title":"PartyEndpointLocationFilter","description":"Categories of owning device locations of endpoints that can be used to filter the results returned by PartyNetwork::GetEndpointsByUserType().","href":"/services/playfab/multiplayer/networking/reference/enums/partyendpointlocationfilter"},{"title":"PartyEndpointStatistic","description":"Types of statistics that can be retrieved for an endpoint.","href":"/services/playfab/multiplayer/networking/reference/enums/partyendpointstatistic"},{"title":"PartyEndpointUserTypeFilter","description":"Categories of users associated with endpoints that can be used to filter the results returned by PartyNetwork::GetEndpointsByUserType().","href":"/services/playfab/multiplayer/networking/reference/enums/partyendpointusertypefilter"},{"title":"PartyGender","description":"Genders for text-to-speech profiles.","href":"/services/playfab/multiplayer/networking/reference/enums/partygender"},{"title":"PartyInvitationRevocability","description":"Options for who may revoke an invitation.","href":"/services/playfab/multiplayer/networking/reference/enums/partyinvitationrevocability"},{"title":"PartyLocalChatControlChatIndicator","description":"Audio states for a local chat control.","href":"/services/playfab/multiplayer/networking/reference/enums/partylocalchatcontrolchatindicator"},{"title":"PartyLocalUdpSocketBindAddressOptions","description":"Additional options to control how the Party library binds to the UDP socket specified by the.","href":"/services/playfab/multiplayer/networking/reference/enums/partylocaludpsocketbindaddressoptions"},{"title":"PartyLocalUserRemovedReason","description":"Reasons for removing a local user from a network.","href":"/services/playfab/multiplayer/networking/reference/enums/partylocaluserremovedreason"},{"title":"PartyMessageReceivedOptions","description":"Flags describing how a message was received.","href":"/services/playfab/multiplayer/networking/reference/enums/partymessagereceivedoptions"},{"title":"PartyNetworkStatistic","description":"Types of statistics that can be retrieved for a network.","href":"/services/playfab/multiplayer/networking/reference/enums/partynetworkstatistic"},{"title":"PartyOption","description":"Additional options that can be set to fine-tune Party library functionality.","href":"/services/playfab/multiplayer/networking/reference/enums/partyoption"},{"title":"PartyRegionUpdateMode","description":"Configuration modes representing how the Party library performs automatic region discovery and connection quality measurement as part of the.","href":"/services/playfab/multiplayer/networking/reference/enums/partyregionupdatemode"},{"title":"PartySendMessageOptions","description":"Options for controlling how a message is sent.","href":"/services/playfab/multiplayer/networking/reference/enums/partysendmessageoptions"},{"title":"PartyStateChangeResult","description":"Results for Party library operations that generate state changes.","href":"/services/playfab/multiplayer/networking/reference/enums/partystatechangeresult"},{"title":"PartyStateChangeType","description":"The types of state changes that can occur in the Party library.","href":"/services/playfab/multiplayer/networking/reference/enums/partystatechangetype"},{"title":"PartySynthesizeTextToSpeechType","description":"Types of text-to-speech operations.","href":"/services/playfab/multiplayer/networking/reference/enums/partysynthesizetexttospeechtype"},{"title":"PartyTextChatFilterLevel","description":"The level of filtering that applies to incoming text chat when text moderation is enabled with.","href":"/services/playfab/multiplayer/networking/reference/enums/partytextchatfilterlevel"},{"title":"PartyTextChatOptions","description":"Text chat options.","href":"/services/playfab/multiplayer/networking/reference/enums/partytextchatoptions"},{"title":"PartyThreadId","description":"High-level categorization of internal processing tasks.","href":"/services/playfab/multiplayer/networking/reference/enums/partythreadid"},{"title":"PartyTranslationReceivedOptions","description":"Flags describing how a translation was received.","href":"/services/playfab/multiplayer/networking/reference/enums/partytranslationreceivedoptions"},{"title":"PartyVoiceAudioOptions","description":"Voice audio options.","href":"/services/playfab/multiplayer/networking/reference/enums/partyvoiceaudiooptions"},{"title":"PartyVoiceChatTranscriptionOptions","description":"Voice chat transcription options.","href":"/services/playfab/multiplayer/networking/reference/enums/partyvoicechattranscriptionoptions"},{"title":"PartyVoiceChatTranscriptionPhraseType","description":"Types of transcription phrases.","href":"/services/playfab/multiplayer/networking/reference/enums/partyvoicechattranscriptionphrasetype"},{"title":"PartyWorkMode","description":"Configuration modes representing how the Party library will manage an internal processing task.","href":"/services/playfab/multiplayer/networking/reference/enums/partyworkmode"}]},{"group":"Structs","pages":[{"title":"PartyAudioFormat","description":"The format information needed to interpret Party audio data.","href":"/services/playfab/multiplayer/networking/reference/structs/partyaudioformat"},{"title":"PartyAudioManipulationSinkStreamConfiguration","description":"The configuration information needed to set up an audio sink stream.","href":"/services/playfab/multiplayer/networking/reference/structs/partyaudiomanipulationsinkstreamconfiguration"},{"title":"PartyAudioManipulationSourceStreamConfiguration","description":"The configuration information needed to set up an audio source stream.","href":"/services/playfab/multiplayer/networking/reference/structs/partyaudiomanipulationsourcestreamconfiguration"},{"title":"PartyAuthenticateLocalUserCompletedStateChange","description":"Information specific to the *AuthenticateLocalUserCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyauthenticatelocalusercompletedstatechange"},{"title":"PartyChatControlCreatedStateChange","description":"Information specific to the *ChatControlCreated* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partychatcontrolcreatedstatechange"},{"title":"PartyChatControlDestroyedStateChange","description":"Information specific to the *ChatControlDestroyed* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partychatcontroldestroyedstatechange"},{"title":"PartyChatControlJoinedNetworkStateChange","description":"Information specific to the *ChatControlJoinedNetwork* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partychatcontroljoinednetworkstatechange"},{"title":"PartyChatControlLeftNetworkStateChange","description":"Information specific to the *ChatControlLeftNetwork* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partychatcontrolleftnetworkstatechange"},{"title":"PartyChatTextReceivedStateChange","description":"Information specific to the *ChatTextReceived* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partychattextreceivedstatechange"},{"title":"PartyConfigureAudioManipulationCaptureStreamCompletedStateChange","description":"Information specific to the *ConfigureAudioManipulationCaptureStreamCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyconfigureaudiomanipulationcapturestreamcompletedstatechange"},{"title":"PartyConfigureAudioManipulationRenderStreamCompletedStateChange","description":"Information specific to the *ConfigureAudioManipulationRenderStreamCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyconfigureaudiomanipulationrenderstreamcompletedstatechange"},{"title":"PartyConfigureAudioManipulationVoiceStreamCompletedStateChange","description":"Information specific to the *ConfigureAudioManipulationVoiceStreamCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyconfigureaudiomanipulationvoicestreamcompletedstatechange"},{"title":"PartyConnectChatControlCompletedStateChange","description":"Information specific to the *ConnectChatControlCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyconnectchatcontrolcompletedstatechange"},{"title":"PartyConnectToNetworkCompletedStateChange","description":"Information specific to the *ConnectToNetworkCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyconnecttonetworkcompletedstatechange"},{"title":"PartyCreateChatControlCompletedStateChange","description":"Information specific to the *CreateChatControlCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partycreatechatcontrolcompletedstatechange"},{"title":"PartyCreateEndpointCompletedStateChange","description":"Information specific to the *CreateEndpointCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partycreateendpointcompletedstatechange"},{"title":"PartyCreateInvitationCompletedStateChange","description":"Information specific to the *CreateInvitationCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partycreateinvitationcompletedstatechange"},{"title":"PartyCreateNewNetworkCompletedStateChange","description":"Information specific to the *CreateNewNetworkCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partycreatenewnetworkcompletedstatechange"},{"title":"PartyDataBuffer","description":"A data buffer.","href":"/services/playfab/multiplayer/networking/reference/structs/partydatabuffer"},{"title":"PartyDataBuffersReturnedStateChange","description":"Information specific to the *DataBuffersReturned* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partydatabuffersreturnedstatechange"},{"title":"PartyDestroyChatControlCompletedStateChange","description":"Information specific to the *DestroyChatControlCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partydestroychatcontrolcompletedstatechange"},{"title":"PartyDestroyEndpointCompletedStateChange","description":"Information specific to the *DestroyEndpointCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partydestroyendpointcompletedstatechange"},{"title":"PartyDestroyLocalUserCompletedStateChange","description":"Information specific to the *DestroyLocalUserCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partydestroylocalusercompletedstatechange"},{"title":"PartyDisconnectChatControlCompletedStateChange","description":"Information specific to the *DisconnectChatControlCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partydisconnectchatcontrolcompletedstatechange"},{"title":"PartyEndpointCreatedStateChange","description":"Information specific to the *EndpointCreated* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyendpointcreatedstatechange"},{"title":"PartyEndpointDestroyedStateChange","description":"Information specific to the *EndpointDestroyed* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyendpointdestroyedstatechange"},{"title":"PartyEndpointMessageReceivedStateChange","description":"Information specific to the *EndpointMessageReceived* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyendpointmessagereceivedstatechange"},{"title":"PartyInvitationConfiguration","description":"Invitation configuration data.","href":"/services/playfab/multiplayer/networking/reference/structs/partyinvitationconfiguration"},{"title":"PartyInvitationCreatedStateChange","description":"Information specific to the *InvitationCreated* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyinvitationcreatedstatechange"},{"title":"PartyInvitationDestroyedStateChange","description":"Information specific to the *InvitationDestroyed* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyinvitationdestroyedstatechange"},{"title":"PartyLeaveNetworkCompletedStateChange","description":"Information specific to the *LeaveNetworkCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyleavenetworkcompletedstatechange"},{"title":"PartyLocalChatAudioInputChangedStateChange","description":"Information specific to the *LocalChatAudioInputChanged* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partylocalchataudioinputchangedstatechange"},{"title":"PartyLocalChatAudioOutputChangedStateChange","description":"Information specific to the *LocalChatAudioOutputChanged* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partylocalchataudiooutputchangedstatechange"},{"title":"PartyLocalUdpSocketBindAddressConfiguration","description":"The configuration used by the Party library to bind to a UDP socket.","href":"/services/playfab/multiplayer/networking/reference/structs/partylocaludpsocketbindaddressconfiguration"},{"title":"PartyLocalUserRemovedStateChange","description":"Information specific to the *LocalUserRemoved* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partylocaluserremovedstatechange"},{"title":"PartyMutableDataBuffer","description":"A data buffer that can be modified by the app.","href":"/services/playfab/multiplayer/networking/reference/structs/partymutabledatabuffer"},{"title":"PartyNetworkConfiguration","description":"Network configuration data.","href":"/services/playfab/multiplayer/networking/reference/structs/partynetworkconfiguration"},{"title":"PartyNetworkConfigurationMadeAvailableStateChange","description":"Information specific to the *NetworkConfigurationMadeAvailable* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partynetworkconfigurationmadeavailablestatechange"},{"title":"PartyNetworkDescriptor","description":"A descriptor containing the data required for a device to connect to a network.","href":"/services/playfab/multiplayer/networking/reference/structs/partynetworkdescriptor"},{"title":"PartyNetworkDescriptorChangedStateChange","description":"Information specific to the *NetworkDescriptorChanged* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partynetworkdescriptorchangedstatechange"},{"title":"PartyNetworkDestroyedStateChange","description":"Information specific to the *NetworkDestroyed* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partynetworkdestroyedstatechange"},{"title":"PartyPopulateAvailableTextToSpeechProfilesCompletedStateChange","description":"Information specific to the *PopulateAvailableTextToSpeechProfilesCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partypopulateavailabletexttospeechprofilescompletedstatechange"},{"title":"PartyProfilingMethodEntranceEventData","description":"Information specific to the *MethodEntrance* type of profiling event.","href":"/services/playfab/multiplayer/networking/reference/structs/partyprofilingmethodentranceeventdata"},{"title":"PartyProfilingMethodExitEventData","description":"Information specific to the *MethodExit* type of profiling event.","href":"/services/playfab/multiplayer/networking/reference/structs/partyprofilingmethodexiteventdata"},{"title":"PartyRegion","description":"Represents a Party library region.","href":"/services/playfab/multiplayer/networking/reference/structs/partyregion"},{"title":"PartyRegionQualityMeasurementConfiguration","description":"The configuration used by the Party library to control region quality measurement behavior.","href":"/services/playfab/multiplayer/networking/reference/structs/partyregionqualitymeasurementconfiguration"},{"title":"PartyRegionsChangedStateChange","description":"Information specific to the *RegionsChanged* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyregionschangedstatechange"},{"title":"PartyRegionUpdateConfiguration","description":"The configuration used by the Party library to control how it performs automatic region discovery and connection quality measurement updates.","href":"/services/playfab/multiplayer/networking/reference/structs/partyregionupdateconfiguration"},{"title":"PartyRemoteDeviceCreatedStateChange","description":"Information specific to the *RemoteDeviceCreated* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyremotedevicecreatedstatechange"},{"title":"PartyRemoteDeviceDestroyedStateChange","description":"Information specific to the *RemoteDeviceDestroyed* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyremotedevicedestroyedstatechange"},{"title":"PartyRemoteDeviceJoinedNetworkStateChange","description":"Information specific to the *RemoteDeviceJoinedNetwork* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyremotedevicejoinednetworkstatechange"},{"title":"PartyRemoteDeviceLeftNetworkStateChange","description":"Information specific to the *RemoteDeviceLeftNetwork* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyremotedeviceleftnetworkstatechange"},{"title":"PartyRemoveLocalUserCompletedStateChange","description":"Information specific to the *RemoveLocalUserCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyremovelocalusercompletedstatechange"},{"title":"PartyRevokeInvitationCompletedStateChange","description":"Information specific to the *RevokeInvitationCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyrevokeinvitationcompletedstatechange"},{"title":"PartySendMessageQueuingConfiguration","description":"Optional configuration parameters for modifying local queuing behavior when sending a message.","href":"/services/playfab/multiplayer/networking/reference/structs/partysendmessagequeuingconfiguration"},{"title":"PartySetChatAudioInputCompletedStateChange","description":"Information specific to the *SetChatAudioInputCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partysetchataudioinputcompletedstatechange"},{"title":"PartySetChatAudioOutputCompletedStateChange","description":"Information specific to the *SetChatAudioOutputCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partysetchataudiooutputcompletedstatechange"},{"title":"PartySetTextChatOptionsCompletedStateChange","description":"Information specific to the *PartySetTextChatOptionsCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partysettextchatoptionscompletedstatechange"},{"title":"PartySetTextToSpeechProfileCompletedStateChange","description":"Information specific to the *SetTextToSpeechProfileCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partysettexttospeechprofilecompletedstatechange"},{"title":"PartySetTranscriptionOptionsCompletedStateChange","description":"Information specific to the *SetTranscriptionOptionsCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partysettranscriptionoptionscompletedstatechange"},{"title":"PartyStateChange","description":"A generic, base structure representation of an event or change in state in the Party library.","href":"/services/playfab/multiplayer/networking/reference/structs/partystatechange"},{"title":"PartySynthesizeTextToSpeechCompletedStateChange","description":"Information specific to the *SynthesizeTextToSpeechCompleted* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partysynthesizetexttospeechcompletedstatechange"},{"title":"PartyTranslation","description":"A translation.","href":"/services/playfab/multiplayer/networking/reference/structs/partytranslation"},{"title":"PartyVoiceChatTranscriptionReceivedStateChange","description":"Information specific to the *VoiceChatTranscriptionReceived* type of state change.","href":"/services/playfab/multiplayer/networking/reference/structs/partyvoicechattranscriptionreceivedstatechange"}]}]},{"group":"Unity Party Api Reference","pages":[{"group":"Classes","pages":[{"group":"Playfablocalplayer","pages":[{"title":"Class PlayFabLocalPlayer","description":"Reference for the PlayFabLocalPlayer class in the PlayFab Party Unity SDK, exposing the local player's chat control, language code, and platform user ID.","sidebarTitle":"PlayFabLocalPlayer","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfablocalplayer/index"},{"group":"Properties","pages":[{"title":"PlayFabLocalPlayer.IsChatControlAvailable","description":"Reference for PlayFabLocalPlayer.IsChatControlAvailable in the Party Unity SDK, indicating whether the local player's chat control is ready to be used.","sidebarTitle":"IsChatControlAvailable","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfablocalplayer/properties/playfabunityischatcontrolavailable"},{"title":"PlayFabLocalPlayer.LanguageCode","description":"Reference for PlayFabLocalPlayer.LanguageCode in the Party Unity SDK, used to get or set the BCP-47 language code applied to the local player's chat control.","sidebarTitle":"LanguageCode","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfablocalplayer/properties/playfabunitylanguagecode"},{"title":"PlayFabLocalPlayer.PlatformSpecificUserId","description":"Reference for PlayFabLocalPlayer.PlatformSpecificUserId in the Party Unity SDK, returning the platform-specific user identifier for the local Party player.","sidebarTitle":"PlatformSpecificUserId","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfablocalplayer/properties/playfabunityplatformspecificuserid"}]}]},{"group":"Playfabmultiplayermanager","pages":[{"title":"Class PlayFabMultiplayerManager","description":"Reference for the PlayFabMultiplayerManager class in the Party Unity SDK, the singleton that manages Party networks, chat, and data messaging for a game.","sidebarTitle":"PlayFabMultiplayerManager","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/index"},{"group":"Events","pages":[{"title":"OnChatMessageReceived","description":"Reference for the OnChatMessageReceived event on PlayFabMultiplayerManager in the Party Unity SDK, raised when the local player receives a chat message.","sidebarTitle":"partyunityonchatmessagereceived","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/events/partyunityonchatmessagereceived"},{"title":"OnDataMessageNoCopyReceived","description":"Reference for the OnDataMessageNoCopyReceived event on PlayFabMultiplayerManager in the Party Unity SDK, raised for zero-copy incoming data messages.","sidebarTitle":"partyunityondatamessagenocopyreceived","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/events/partyunityondatamessagenocopyreceived"},{"title":"OnDataMessageReceived","description":"Reference for the OnDataMessageReceived event on PlayFabMultiplayerManager in the Party Unity SDK, raised whenever the local player receives a data message.","sidebarTitle":"partyunityondatamessagereceived","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/events/partyunityondatamessagereceived"},{"title":"OnErrorEventHandler","description":"Reference for the OnError event handler on PlayFabMultiplayerManager in the Party Unity SDK, raised when the library reports a Party or network error.","sidebarTitle":"partyunityonerroreventhandler","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/events/partyunityonerroreventhandler"},{"title":"OnNetworkChanged","description":"Reference for the OnNetworkChanged event on PlayFabMultiplayerManager in the Party Unity SDK, raised when the connected Party network's state changes.","sidebarTitle":"partyunityonnetworkchanged","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/events/partyunityonnetworkchanged"},{"title":"OnNetworkJoined","description":"Reference for the OnNetworkJoined event on PlayFabMultiplayerManager in the Party Unity SDK, raised when the local player successfully joins a Party network.","sidebarTitle":"partyunityonnetworkjoined","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/events/partyunityonnetworkjoined"},{"title":"OnNetworkLeft","description":"Reference for the OnNetworkLeft event on PlayFabMultiplayerManager in the Party Unity SDK, raised after the local player disconnects from a Party network.","sidebarTitle":"partyunityonnetworkleft","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/events/partyunityonnetworkleft"},{"title":"OnRemotePlayerJoined","description":"Reference for the OnRemotePlayerJoined event on PlayFabMultiplayerManager in the Party Unity SDK, raised when another player joins the current Party network.","sidebarTitle":"partyunityonremoteplayerjoined","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/events/partyunityonremoteplayerjoined"},{"title":"OnRemotePlayerLeft","description":"Reference for the OnRemotePlayerLeft event on PlayFabMultiplayerManager in the Party Unity SDK, raised when a remote player disconnects from the Party network.","sidebarTitle":"partyunityonremoteplayerleft","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/events/partyunityonremoteplayerleft"}]},{"group":"Methods","pages":[{"title":"PlayFabMultiplayerManager.Get().SendChatMessage","description":"Reference for PlayFabMultiplayerManager.SendChatMessage in the Party Unity SDK, which sends a text chat message to a targeted list of remote players.","sidebarTitle":"SendChatMessage","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/partyunitysendchatmessage"},{"title":"PlayFabMultiplayerManager.Get().SendChatMessageToAllPlayers","description":"Reference for PlayFabMultiplayerManager.SendChatMessageToAllPlayers in the Party Unity SDK, which broadcasts a text chat message to every player in the network.","sidebarTitle":"SendChatMessageToAllPlayers","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/partyunitysendchatmessagetoallplayers"},{"title":"PlayFabMultiplayerManager.Get().CreateAndJoinNetwork","description":"Reference for PlayFabMultiplayerManager.CreateAndJoinNetwork in the Party Unity SDK, which provisions a new Party network and joins the local player to it.","sidebarTitle":"CreateAndJoinNetwork","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/playfabunitycreateandjoinnetwork"},{"title":"PlayFabMultiplayerManager.Get","description":"Reference for PlayFabMultiplayerManager.Get in the Party Unity SDK, which returns the singleton instance used to manage Party networks, chat, and data messages.","sidebarTitle":"Get","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/playfabunityget"},{"title":"PlayFabMultiplayerManager.Get().LeaveNetwork","description":"Reference for PlayFabMultiplayerManager.LeaveNetwork in the Party Unity SDK, which disconnects the local player from the currently joined Party network.","sidebarTitle":"LeaveNetwork","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/playfabunityleavenetwork"},{"title":"PlayFabMultiplayerManager.Get().ResetParty","description":"Reference for PlayFabMultiplayerManager.ResetParty in the Party Unity SDK, which clears the Party state so the manager can be reinitialized for a new session.","sidebarTitle":"ResetParty","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/playfabunityresetparty"},{"title":"PlayFabMultiplayerManager.Get().Resume","description":"Reference for PlayFabMultiplayerManager.Resume in the Party Unity SDK, which resumes Party chat and data processing after a previous Suspend call.","sidebarTitle":"Resume","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/playfabunityresume"},{"title":"PlayFabMultiplayerManager.Get().SendDataMessage","description":"Reference for PlayFabMultiplayerManager.SendDataMessage in the Party Unity SDK, which sends a binary data message to a specific list of remote Party players.","sidebarTitle":"SendDataMessage","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/playfabunitysenddatamessage"},{"title":"PlayFabMultiplayerManager.Get().SendDataMessageToAllPlayers","description":"Reference for PlayFabMultiplayerManager.SendDataMessageToAllPlayers in the Party Unity SDK, which broadcasts a binary data message to all players.","sidebarTitle":"SendDataMessageToAllPlayers","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/playfabunitysenddatamessagetoallplayers"},{"title":"PlayFabMultiplayerManager.Get().Suspend","description":"Reference for PlayFabMultiplayerManager.Suspend in the Party Unity SDK, which pauses Party chat and data processing so the app can move to the background.","sidebarTitle":"Suspend","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/playfabunitysuspend"},{"title":"PlayFabMultiplayerManager.Get().UpdateEntityToken","description":"Reference for PlayFabMultiplayerManager.UpdateEntityToken in the Party Unity SDK, which refreshes the PlayFab entity token authenticating the local player.","sidebarTitle":"UpdateEntityToken","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/methods/playfabunityupdateentitytoken"}]},{"group":"Properties","pages":[{"title":"PlayFabMultiplayerManager.LocalPlayer","description":"Reference for PlayFabMultiplayerManager.LocalPlayer in the Party Unity SDK, returning the PlayFabLocalPlayer object representing the client's local user.","sidebarTitle":"LocalPlayer","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/properties/playfabunitylocalplayer"},{"title":"PlayFabMultiplayerManager.LogLevel","description":"Reference for PlayFabMultiplayerManager.LogLevel in the Party Unity SDK, used to get or set how verbose diagnostic logging is for Party chat and networking.","sidebarTitle":"LogLevel","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/properties/playfabunityloglevel"},{"title":"PlayFabMultiplayerManager.NetworkId","description":"Reference for PlayFabMultiplayerManager.NetworkId in the Party Unity SDK, returning the identifier of the Party network to which the local player is connected.","sidebarTitle":"NetworkId","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/properties/playfabunitynetworkid"},{"title":"PlayFabMultiplayerManager.RemotePlayers","description":"Reference for PlayFabMultiplayerManager.RemotePlayers in the Party Unity SDK, returning the collection of remote players currently in the Party network.","sidebarTitle":"RemotePlayers","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/properties/playfabunityremoteplayers"},{"title":"PlayFabMultiplayerManager.SpeechToTextMode","description":"Reference for the PlayFabMultiplayerManager.SpeechToTextMode property that controls speech-to-text accessibility in Unity PlayFab Party voice chat.","sidebarTitle":"SpeechToTextMode","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/properties/playfabunityspeechtotextmode"},{"title":"PlayFabMultiplayerManager.State","description":"Reference for the PlayFabMultiplayerManager.State property that reports the current PlayFab Party network state in the Unity multiplayer plugin.","sidebarTitle":"State","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/properties/playfabunitystate"},{"title":"PlayFabMultiplayerManager.TextToSpeechMode","description":"Reference for the PlayFabMultiplayerManager.TextToSpeechMode property that toggles text-to-speech accessibility in Unity PlayFab Party voice chat.","sidebarTitle":"TextToSpeechMode","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/properties/playfabunitytexttospeechmode"},{"title":"PlayFabMultiplayerManager.TranslateChat","description":"Reference for the PlayFabMultiplayerManager.TranslateChat property that enables automatic translation of incoming chat into the local player's language.","sidebarTitle":"TranslateChat","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabmultiplayermanager/properties/playfabunitytranslatechat"}]}]},{"group":"Playfabplayer","pages":[{"title":"Class PlayFabPlayer","description":"Reference for the PlayFabPlayer class in the PlayFab Party Unity SDK, listing properties that represent a local or remote player in a multiplayer network.","sidebarTitle":"PlayFabPlayer","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabplayer/index"},{"group":"Properties","pages":[{"title":"PlayFabPlayer.ChatState","description":"Reference for the PlayFabPlayer.ChatState property that reports the visual voice chat state for a player, for use in Unity PlayFab Party game UI.","sidebarTitle":"ChatState","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabplayer/properties/playfabunitychatstate"},{"title":"PlayFabPlayer.EntityKey","description":"Reference for the PlayFabPlayer.EntityKey property that returns the PlayFab EntityKey identifying a player in the Unity PlayFab Party multiplayer SDK.","sidebarTitle":"EntityKey","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabplayer/properties/playfabunityentitykey"},{"title":"PlayFabPlayer.IsLocal","description":"Reference for the PlayFabPlayer.IsLocal boolean property, used in the Unity PlayFab Party SDK to distinguish the local player from remote multiplayer peers.","sidebarTitle":"IsLocal","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabplayer/properties/playfabunityislocal"},{"title":"bool PlayFabPlayer.IsMuted","description":"Reference for the PlayFabPlayer.IsMuted property that gets or sets whether a player is muted in Unity PlayFab Party voice chat multiplayer sessions.","sidebarTitle":"IsMuted","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabplayer/properties/playfabunityismuted"},{"title":"PlayFabPlayer.VoiceLevel","description":"Reference for the PlayFabPlayer.VoiceLevel property, a float from 0 to 1 that controls player playback volume in Unity PlayFab Party voice chat.","sidebarTitle":"VoiceLevel","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/classes/playfabplayer/properties/playfabunityvoicelevel"}]}]}]},{"group":"Enums","pages":[{"title":"AccessibilityMode","description":"Reference for the AccessibilityMode enum in the Unity PlayFab Party SDK, used to configure speech-to-text and text-to-speech chat accessibility options.","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/enums/partyunityaccessibilitymode"},{"title":"ChatMessageType","description":"Reference for the ChatMessageType enum in the Unity PlayFab Party SDK, identifying text, speech-to-text, or text-to-speech multiplayer chat messages.","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/enums/partyunitychatmessagetype"},{"title":"ChatState","description":"Reference for the ChatState enum in the Unity PlayFab Party SDK, describing player voice states such as talking, silent, muted, or no audio input.","sidebarTitle":"ChatMessageState","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/enums/partyunitychatstate"},{"title":"DeliveryOption","description":"Reference for the DeliveryOption enum in the Unity PlayFab Party SDK, selecting best-effort or guaranteed reliability for multiplayer network messages.","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/enums/partyunitydeliveryoption"},{"title":"DirectPeerConnectivityOptions","description":"Reference for the DirectPeerConnectivityOptions flags in the Unity PlayFab Party SDK, controlling peer-to-peer connections between multiplayer devices.","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/enums/partyunitydirectpeerconnectivityoptions"},{"title":"PlayFabMultiplayerManager.LogLevelType","description":"Reference for the PlayFabMultiplayerManager.LogLevelType enum in the Unity PlayFab Party SDK, selecting None, Minimal, or Verbose logging output.","sidebarTitle":"LogLevelType","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/enums/partyunitylogleveltype"},{"title":"PlayFabMultiplayerManagerErrorType","description":"Reference for the PlayFabMultiplayerManagerErrorType enum in the Unity PlayFab Party SDK, categorizing network create, join, and leave multiplayer errors.","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/enums/partyunityplayfabmultiplayermanagererrortype"},{"title":"PlayFabMultiplayerManagerState","description":"Reference for the PlayFabMultiplayerManagerState enum in the Unity PlayFab Party SDK, tracking manager initialization and network connection multiplayer states.","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/enums/partyunityplayfabmultiplayermanagerstate"}]}]},{"group":"Xblreference","pages":[{"title":"PlayFab Party XBOX Live Helper Error Codes","description":"Reference table of numeric error codes returned by the PlayFab Party XBOX Live Helper library, useful for troubleshooting PartyXbl multiplayer failures.","sidebarTitle":"Error Codes","href":"/services/playfab/multiplayer/networking/xblreference/partyxblerrors"},{"title":"PlayFab Party XBOX Live Helper Typedefs","description":"Reference for the array typedefs provided by the PlayFab Party XBOX Live Helper library, used for state change and chat user collections in multiplayer code.","sidebarTitle":"Typedefs","href":"/services/playfab/multiplayer/networking/xblreference/xbltypedefs"},{"group":"Classes","pages":[{"group":"PartyXblChatUser","pages":[{"title":"PartyXblChatUser","description":"The management class for XBOX Live operations related to a chat user.","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblChatUser/partyxblchatuser"},{"group":"Methods","pages":[{"title":"PartyXblChatUser::GetCustomContext","description":"Retrieves the app's private, custom pointer-sized context value previously associated with this local chat user object.","sidebarTitle":"GetCustomContext","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblChatUser/methods/partyxblchatuser_getcustomcontext"},{"title":"PartyXblChatUser::GetLocal","description":"PartyXblChatUser::GetLocal in PartyXboxLive.h returns the PartyXblLocalChatUser view of a chat user when local, used with the PlayFab Party XBOX Live helper.","sidebarTitle":"GetLocal","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblChatUser/methods/partyxblchatuser_getlocal"},{"title":"PartyXblChatUser::GetXboxUserId","description":"PartyXblChatUser::GetXboxUserId in PartyXboxLive.h returns the XBOX Live user ID (XUID) tied to a chat user in the PlayFab Party XBOX Live helper library.","sidebarTitle":"GetXboxUserId","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblChatUser/methods/partyxblchatuser_getxboxuserid"},{"title":"PartyXblChatUser::SetCustomContext","description":"Configures an optional, custom pointer-sized context value with this local chat user object.","sidebarTitle":"SetCustomContext","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblChatUser/methods/partyxblchatuser_setcustomcontext"}]}]},{"group":"PartyXblLocalChatUser","pages":[{"title":"PartyXblLocalChatUser","description":"PartyXblLocalChatUser class: manages XBOX Live operations for a local chat user in PlayFab Party. Inherits from the PartyXblChatUser base class.","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblLocalChatUser/partyxbllocalchatuser"},{"group":"Methods","pages":[{"title":"PartyXblLocalChatUser::GetAccessibilitySettings","description":"Returns the accessibility settings associated with this chat user.","sidebarTitle":"GetAccessibilitySettings","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblLocalChatUser/methods/partyxbllocalchatuser_getaccessibilitysettings"},{"title":"PartyXbl GetCrossNetworkCommunicationPrivacySetting","description":"Gets the cross-network communication privacy setting for this chat user.","sidebarTitle":"GetCrossNetworkCommunicationPrivacySetting","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblLocalChatUser/methods/partyxbllocalchatuser_getcrossnetworkcommunicationprivacysetting"},{"title":"PartyXblLocalChatUser::GetRequiredChatPermissionInfo","description":"Gets the cached required chat permission information related to a target chat user.","sidebarTitle":"GetRequiredChatPermissionInfo","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblLocalChatUser/methods/partyxbllocalchatuser_getrequiredchatpermissioninfo"}]}]},{"group":"PartyXblManager","pages":[{"title":"PartyXblManager","description":"The primary management class for interacting with the Party XBOX Live Helper library.","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/partyxblmanager"},{"group":"Methods","pages":[{"title":"PartyXblManager::Cleanup","description":"Immediately reclaims all resources associated with the object.","sidebarTitle":"Cleanup","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_cleanup"},{"title":"PartyXblManager::CompleteGetTokenAndSignatureRequest","description":"PartyXblManager::CompleteGetTokenAndSignatureRequest in PartyXboxLive.h supplies the XBOX Live token and signature back to the PlayFab Party helper library.","sidebarTitle":"CompleteGetTokenAndSignatureRequest","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_completegettokenandsignaturerequest"},{"title":"PartyXblManager::CreateLocalChatUser","description":"Queues an asynchronous attempt to create a local chat user. Privacy and privilege information related to this user will be tracked by the helper library.","sidebarTitle":"CreateLocalChatUser","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_createlocalchatuser"},{"title":"PartyXblManager::CreateRemoteChatUser","description":"Creates a remote chat user — an XBOX Live user communicating with a local user — so the Party library tracks privacy state with local chat users.","sidebarTitle":"CreateRemoteChatUser","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_createremotechatuser"},{"title":"PartyXblManager::DestroyChatUser","description":"PartyXblManager::DestroyChatUser in PartyXboxLive.h destroys a PartyXblChatUser instance, releasing XBOX Live resources managed by the PlayFab Party helper.","sidebarTitle":"DestroyChatUser","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_destroychatuser"},{"title":"PartyXblManager::FinishProcessingStateChanges","description":"Returns an array of Party XBOX Live state changes that were being processed.","sidebarTitle":"FinishProcessingStateChanges","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_finishprocessingstatechanges"},{"title":"PartyXblManager::GetChatUsers","description":"Get an array of all chat users created by PartyXblManager::CreateLocalChatUser and CreateRemoteChatUser in the PlayFab Party XBOX Live helper library.","sidebarTitle":"GetChatUsers","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_getchatusers"},{"title":"PartyXblManager::GetEntityIdsFromXboxLiveUserIds","description":"Queues an asynchronous operation to retrieve a list of mappings between PlayFab Entity Ids and known XBOX Live User Ids.","sidebarTitle":"GetEntityIdsFromXboxLiveUserIds","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_getentityidsfromxboxliveuserids"},{"title":"PartyXblManager::GetErrorMessage","description":"Get the human-readable form of an error generated by the Party XBOX Live Helper library.","sidebarTitle":"GetErrorMessage","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_geterrormessage"},{"title":"PartyXblManager::GetMemoryCallbacks","description":"Retrieves the current memory allocation and freeing callbacks the Party XBOX Live library is using.","sidebarTitle":"GetMemoryCallbacks","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_getmemorycallbacks"},{"title":"PartyXblManager::GetProfilingCallbacksForMethodEntryExit","description":"Retrieves the profiling event callbacks the Party XBOX Live library is configured to use when entering or exiting instrumented methods.","sidebarTitle":"GetProfilingCallbacksForMethodEntryExit","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_getprofilingcallbacksformethodentryexit"},{"title":"PartyXblManager::GetSingleton","description":"Retrieves a reference to the PartyXblManager singleton instance.","sidebarTitle":"GetSingleton","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_getsingleton"},{"title":"PartyXblManager::GetThreadAffinityMask","description":"Retrieves the current set of processors on which internal Party XBOX Live Helper library threads will run or are running as an affinity mask.","sidebarTitle":"GetThreadAffinityMask","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_getthreadaffinitymask"},{"title":"PartyXblManager::Initialize","description":"PartyXblManager::Initialize in PartyXboxLive.h initializes the singleton manager used to bridge XBOX Live identities with the PlayFab Party SDK helper library.","sidebarTitle":"Initialize","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_initialize"},{"title":"PartyXblManager::LoginToPlayFab","description":"Signs a user in to PlayFab with an XBOX Live token, asynchronously returning an Entity ID and Token for PlayFab API calls or PartyLocalUser creation.","sidebarTitle":"LoginToPlayFab","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_logintoplayfab"},{"title":"PartyXblManager::SetMemoryCallbacks","description":"Optionally configures the memory allocation and freeing callbacks the Party XBOX Live Helper library should use.","sidebarTitle":"SetMemoryCallbacks","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_setmemorycallbacks"},{"title":"PartyXblManager::SetProfilingCallbacksForMethodEntryExit","description":"Optionally configures the profiling event callbacks the Party XBOX Live library will make when entering or exiting instrumented methods.","sidebarTitle":"SetProfilingCallbacksForMethodEntryExit","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_setprofilingcallbacksformethodentryexit"},{"title":"PartyXblManager::SetThreadAffinityMask","description":"Optionally configures the processor on which internal Party XBOX Live Helper library threads will run.","sidebarTitle":"SetThreadAffinityMask","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_setthreadaffinitymask"},{"title":"PartyXblManager::StartProcessingStateChanges","description":"Retrieves an array of all Party XBOX Live state changes to process since the last such call.","sidebarTitle":"StartProcessingStateChanges","href":"/services/playfab/multiplayer/networking/xblreference/classes/PartyXblManager/methods/partyxblmanager_startprocessingstatechanges"}]}]}]},{"group":"Enums","pages":[{"title":"PartyXblChatPermissionMaskReason","description":"PartyXblChatPermissionMaskReason in PartyXboxLive.h enumerates why XBOX Live may restrict voice or text communication between chat users in PlayFab Party.","href":"/services/playfab/multiplayer/networking/xblreference/enums/partyxblchatpermissionmaskreason"},{"title":"PartyXblCrossNetworkCommunicationPrivacySetting","description":"Reference for the PartyXblCrossNetworkCommunicationPrivacySetting enum controlling XBOX Live cross-network chat privacy in the PlayFab Party helper library.","href":"/services/playfab/multiplayer/networking/xblreference/enums/partyxblcrossnetworkcommunicationprivacysetting"},{"title":"PartyXblLocalChatUserDestroyedReason","description":"PartyXblLocalChatUserDestroyedReason in PartyXboxLive.h enumerates reasons a local chat user was destroyed in the PlayFab Party XBOX Live helper library.","href":"/services/playfab/multiplayer/networking/xblreference/enums/partyxbllocalchatuserdestroyedreason"},{"title":"PartyXblStateChangeResult","description":"Reference for the PartyXblStateChangeResult enum listing success and error results for asynchronous PlayFab Party XBOX Live Helper library operations.","href":"/services/playfab/multiplayer/networking/xblreference/enums/partyxblstatechangeresult"},{"title":"PartyXblStateChangeType","description":"Reference for the PartyXblStateChangeType enum enumerating the asynchronous events reported by the PlayFab Party XBOX Live Helper multiplayer library.","href":"/services/playfab/multiplayer/networking/xblreference/enums/partyxblstatechangetype"},{"title":"PartyXblThreadId","description":"Reference for the PartyXblThreadId enum identifying internal worker threads used by the PlayFab Party XBOX Live Helper library, including the WebRequest thread.","href":"/services/playfab/multiplayer/networking/xblreference/enums/partyxblthreadid"}]},{"group":"Structs","pages":[{"title":"PartyXblAccessibilitySettings","description":"Reference for the PartyXblAccessibilitySettings struct exposing an XBOX Live user's speech-to-text, text-to-speech, language, and gender chat settings.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxblaccessibilitysettings"},{"title":"PartyXblChatPermissionInfo","description":"PartyXblChatPermissionInfo struct in PartyXboxLive.h describes the required chat permission and mask reason between two XBOX Live users in PlayFab Party.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxblchatpermissioninfo"},{"title":"PartyXblCreateLocalChatUserCompletedStateChange","description":"Reference for the PartyXblCreateLocalChatUserCompleted state change reporting the result of creating an XBOX Live local chat user in PlayFab Party.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxblcreatelocalchatusercompletedstatechange"},{"title":"PartyXblGetEntityIdsFromXboxLiveUserIdsCompletedStateChange","description":"Reference for the PartyXblGetEntityIdsFromXboxLiveUserIdsCompleted state change returning PlayFab Entity IDs mapped from XBOX Live user IDs.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxblgetentityidsfromxboxliveuseridscompletedstatechange"},{"title":"PartyXblHttpHeader","description":"PartyXblHttpHeader struct reference from PartyXboxLive.h in the PlayFab Party XBOX Live SDK, holding an HTTP header name and value string pair.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxblhttpheader"},{"title":"PartyXblLocalChatUserDestroyedStateChange","description":"Reference for the PartyXblLocalChatUserDestroyed state change, reporting when an XBOX Live local chat user is destroyed in the PlayFab Party helper library.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxbllocalchatuserdestroyedstatechange"},{"title":"PartyXblLoginToPlayFabCompletedStateChange","description":"Reference for the PartyXblLoginToPlayFabCompleted state change, reporting the outcome and entity token when signing an XBOX Live user into PlayFab Party.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxbllogintoplayfabcompletedstatechange"},{"title":"PartyXblRequiredChatPermissionInfoChangedStateChange","description":"Reference for the PartyXblRequiredChatPermissionInfoChanged state change, signaling updated XBOX Live chat permissions between local and target Party users.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxblrequiredchatpermissioninfochangedstatechange"},{"title":"PartyXblStateChange","description":"Reference for the PartyXblStateChange base struct returned from the PlayFab Party XBOX Live Helper library, cast to derived types by stateChangeType.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxblstatechange"},{"title":"PartyXblTokenAndSignatureRequestedStateChange","description":"Reference for the PartyXblTokenAndSignatureRequested state change, requesting an XBOX Live token and signature to complete a PlayFab Party HTTP call.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxbltokenandsignaturerequestedstatechange"},{"title":"PartyXblXboxUserIdToPlayFabEntityIdMapping","description":"Reference for the PartyXblXboxUserIdToPlayFabEntityIdMapping struct that pairs an XBOX Live user ID with its linked PlayFab Party entity ID.","href":"/services/playfab/multiplayer/networking/xblreference/structs/partyxblxboxuseridtoplayfabentityidmapping"}]}]}]}]}]},{"group":"Community","icon":"comments","expanded":false,"pages":[{"title":"PlayFab Community documentation","description":"Cross-platform PlayFab Community tools and services for building social experiences: friends, groups, leaderboards, and real-time voice and text chat.","sidebarTitle":"Community","href":"/services/playfab/community/index"},{"title":"Community overview page","description":"Overview of PlayFab Community services: friends lists, player groups and guilds, synchronous voice and text chat via Party, and cross-platform leaderboards.","sidebarTitle":"Overview","href":"/services/playfab/community/what-is-community"},{"group":"Player associations","expanded":false,"pages":[{"group":"Friends","expanded":false,"pages":[{"title":"Friends","description":"Manage PlayFab friends lists in your game, integrate external social networks like Facebook, Steam, or XBOX Live, and handle one-way friendship rules.","sidebarTitle":"Overview","href":"/services/playfab/community/associations/friends/index"},{"title":"Friends lists","description":"Quickstart tutorial for building PlayFab friends lists in Unity, covering how to add, remove, and display friends plus link Steam, Facebook, and XBOX friends.","sidebarTitle":"Quickstart","href":"/services/playfab/community/associations/friends/quickstart"}]},{"group":"Groups","expanded":false,"pages":[{"title":"Groups, Guilds and Clans","description":"Build guilds, clans, and player groups in PlayFab with the group entity, membership roles, permissions, and group-scoped data storage for your title.","sidebarTitle":"Overview","href":"/services/playfab/community/associations/groups/index"},{"title":"Entity Groups","description":"Learn how PlayFab Entity Groups model guilds, clans, parties, and chat channels, with member roles, invitations, and shared object and file data.","href":"/services/playfab/community/associations/groups/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Using Shared Group Data","description":"Use PlayFab Shared Group Data with CloudScript to store turn-based game state, small party data, and manage read/write permissions for group members.","href":"/services/playfab/community/associations/groups/using-shared-group-data"}]}]}]},{"group":"Leaderboards","expanded":false,"pages":[{"title":"PlayFab Leaderboards overview","description":"Overview of the PlayFab Leaderboards service: cross-platform rankings with multi-column tie-breaking, versioning, metadata rows, and statistic linking.","sidebarTitle":"Overview","href":"/services/playfab/community/leaderboards/index"},{"title":"Quickstart on leaderboards","description":"Quickstart for PlayFab Leaderboards: create your first leaderboard in Game Manager and configure the C# SDK with your TitleId and developer secret key.","sidebarTitle":"Quickstart","href":"/services/playfab/community/leaderboards/quickstart-leaderboards"},{"title":"Limits on Leaderboards","description":"Rate limits and per-API request quotas for the PlayFab Leaderboards service, covering caller and target entity throttles across create, read, and update calls.","sidebarTitle":"Limits","href":"/services/playfab/community/leaderboards/limits-leaderboards"},{"title":"Quota Leaderboards","description":"PlayFab Leaderboards quota limits for Development and Live modes, including maximum leaderboard definitions, row counts, versions, and columns per definition.","sidebarTitle":"Quota","href":"/services/playfab/community/leaderboards/quota-leaderboards"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Create basic leaderboard","description":"Create a basic PlayFab leaderboard with the C# SDK: define columns and sort direction, add player entries, query rankings, and handle score tie-breaking.","sidebarTitle":"Create a basic leaderboard","href":"/services/playfab/community/leaderboards/create-basic-leaderboard"},{"title":"Seasonal leaderboards","description":"Configure seasonal PlayFab leaderboards with VersionConfiguration to reset rankings on a monthly or custom cadence and query previous tournament versions.","href":"/services/playfab/community/leaderboards/seasonal-leaderboards"},{"title":"Doing with more leaderboards","description":"Advanced PlayFab leaderboard features: build multi-column leaderboards, enhanced tie-breaking, external entities, and query rankings around a player.","sidebarTitle":"Doing more with leaderboards","href":"/services/playfab/community/leaderboards/doing-more-with-leaderboards"},{"title":"Add contextual data to leaderboards","description":"Attach custom metadata to each PlayFab leaderboard row to track match context, device details, or anti-cheat signals alongside player scores and rank.","href":"/services/playfab/community/leaderboards/metadata-leaderboards"},{"title":"Ranking players by statistics","description":"Link a PlayFab leaderboard to a Statistic definition so updates to player stats automatically feed leaderboard entries, ranking players by tracked values.","href":"/services/playfab/community/leaderboards/leaderboards-linked-to-stats"},{"title":"Group Leaderboards","description":"Rank guilds, clans, and alliances by creating PlayFab leaderboards that use the group entity type to compare team scores alongside player leaderboards.","href":"/services/playfab/community/leaderboards/group-leaderboards"},{"title":"Manual Tier Leaderboards","description":"Learn how to build a manual tiering system on top of PlayFab leaderboards, ranking players into Bronze, Silver, Gold, Platinum, Diamond, and Savior tiers.","sidebarTitle":"Manual Tiers","href":"/services/playfab/community/leaderboards/manual-tiers"},{"title":"Leaderboards with PlayStream and Telemetry","description":"Emit PlayFab leaderboard version-ended and entity rank events to PlayStream or Telemetry to trigger CloudScript, Azure Functions, or reward top players.","href":"/services/playfab/community/leaderboards/leaderboards-with-playstream-and-telemetry"},{"title":"Leaderboards using Azure Functions","description":"Tutorial for building PlayFab leaderboards with Azure Functions CloudScript, showing how to submit scores and query rankings from server-side code.","sidebarTitle":"Leaderboards with Cloud Script","href":"/services/playfab/community/leaderboards/leaderboards-cloudscript"},{"title":"API Leaderboard reference","description":"Reference for PlayFab Leaderboards APIs, including create, update, delete leaderboard definitions, update entries, and get friend or entity rankings.","sidebarTitle":"API reference","href":"/services/playfab/community/leaderboards/api-reference"}]},{"group":"Tournaments and leaderboards (deprecated)","expanded":false,"pages":[{"title":"Tournaments \u0026 Leaderboards","description":"Design PlayFab tournaments and legacy leaderboards to drive engagement, rank players by statistics, and reward winners with recurring competitive events.","sidebarTitle":"Overview","href":"/services/playfab/community/leaderboards/tournaments-leaderboards/index"},{"title":"Tournaments \u0026 Leaderboards quickstart","description":"Quickstart for legacy PlayFab tournaments: create a HighScore statistic and leaderboard in Game Manager, then submit player scores from the client with C#.","sidebarTitle":"Quickstart","href":"/services/playfab/community/leaderboards/tournaments-leaderboards/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Accessing Archived Tournament results","description":"Access archived PlayFab tournament leaderboard snapshots after a manual or scheduled reset, and retrieve the previous version's player rankings and stats.","sidebarTitle":"Accessing Archived Tournament Results","href":"/services/playfab/community/leaderboards/tournaments-leaderboards/accessing-archived-tournament-results"},{"title":"Using Prize Tables","description":"Create PlayFab prize tables that grant virtual currency, inventory items, push notifications, or CloudScript actions to top ranks when a leaderboard resets.","href":"/services/playfab/community/leaderboards/tournaments-leaderboards/using-prize-tables"},{"title":"Using resettable statistics and leaderboards","description":"Configure versioned PlayFab statistics and leaderboards that reset on set intervals, and query current or archived versions with Admin, Client, and Server APIs.","href":"/services/playfab/community/leaderboards/tournaments-leaderboards/using-resettable-statistics-and-leaderboards"},{"title":"Using the Profile for Advanced Leaderboards","description":"Configure PlayFab PlayerProfileViewConstraints to fetch richer player profile data such as avatar URLs and display names in leaderboard and ranking results.","href":"/services/playfab/community/leaderboards/tournaments-leaderboards/using-the-profile-for-advanced-leaderboards"},{"title":"Friends Leaderboards","description":"Tutorial for creating PlayFab friends leaderboards that mirror standard leaderboard APIs but restrict rankings to a player's friends list and nearby friends.","href":"/services/playfab/community/leaderboards/tournaments-leaderboards/friends-leaderboards"},{"title":"Using player statistics","description":"Learn how to create, update, and query PlayFab player statistics as key value pairs, and how to configure client and server permissions in Game Manager.","href":"/services/playfab/community/leaderboards/tournaments-leaderboards/using-player-statistics"}]}]}]},{"group":"Synchronous player communications","expanded":false,"pages":[{"title":"Understanding How PlayFab Party chat works","description":"Overview of PlayFab Party voice and text chat, covering PartyLocalChatControl, networks, hardware codecs, and built-in speech-to-text and translation features.","sidebarTitle":"Player communications overview","href":"/services/playfab/community/voice-communications/concepts-chat"},{"title":"Troubleshooting Voice Chat","description":"Troubleshoot PlayFab Party voice chat problems using chat indicators, audio device diagnostics, and mute state checks to fix players who can't hear each other.","sidebarTitle":"Troubleshooting voice chat","href":"/services/playfab/community/voice-communications/concepts-audio-troubleshooting"},{"group":"Accessibility best practices","expanded":false,"pages":[{"title":"PlayFab Party text-to-speech and text input UX Guidelines","description":"Describes the PlayFab Party APIs, and focuses on text input and text-to-speech implementation, requirements, and console and PC UI solutions.","sidebarTitle":"Text-to-speech and text input UX guidelines","href":"/services/playfab/community/voice-communications/party-text-to-speech-ux-guidelines"},{"title":"PlayFab Party speech-to-text and text display UX guidelines","description":"Describes the PlayFab Party APIs, and focuses on speech-to-text and text display implementation, requirements, and custom console and PC UI solutions.","sidebarTitle":"Speech-to-text and text display UX guidelines","href":"/services/playfab/community/voice-communications/party-speech-to-text-ux-guidelines"}]},{"group":"Tutorials","expanded":false,"pages":[{"title":"PlayFab Party Chat Permissions and Muting","description":"Configure PlayFab Party chat permissions and muting between pairs of chat controls to control incoming and outgoing voice and text between teams and players.","sidebarTitle":"Chat permissions and muting","href":"/services/playfab/community/voice-communications/concepts-chat-permissions-and-muting"},{"title":"Apply custom voice effects with real-time audio manipulation","description":"Use PlayFab Party real-time audio manipulation streams to intercept voice chat buffers and apply custom effects like spatial audio and voice filters.","sidebarTitle":"Custom voice effects via real-time audio manipulation","href":"/services/playfab/community/voice-communications/concepts-realtime-audio-manipulation"},{"title":"Using text moderation","description":"Enable PlayFab Party text moderation backed by Azure AI Content Safety to auto-detect languages and filter offensive words from in-game text chat messages.","href":"/services/playfab/community/voice-communications/concepts-text-moderation"},{"title":"Voice Audio Noise Suppression","description":"Enable dynamic microphone noise suppression in PlayFab Party voice chat to improve player voice quality in noisy environments on Android and iOS devices.","sidebarTitle":"Voice audio noise suppression","href":"/services/playfab/community/voice-communications/concepts-noise-suppression"}]}]}]},{"group":"Player progression","icon":"chart-line-up","expanded":false,"pages":[{"title":"PlayFab Player progression documentation","description":"Explore PlayFab player progression services for storing player data, statistics, leaderboards, and game saves that sync across devices and platforms.","sidebarTitle":"Player progression","href":"/services/playfab/player-progression/index"},{"title":"Progression with PlayFab","description":"Overview of PlayFab player progression services including Statistics, Leaderboards, Game Saves, and Player Data for tracking progress and rewards.","sidebarTitle":"Overview","href":"/services/playfab/player-progression/player-progression-overview"},{"group":"Player data","expanded":false,"pages":[{"title":"Player Data","description":"Explore PlayFab Player Data for storing custom key-value fields per player, including internal, read-only, and title data used for progression.","sidebarTitle":"Overview","href":"/services/playfab/player-progression/player-data/index"},{"title":"Quickstart Player Data","description":"PlayFab Player Data quickstart shows how to create, read, and update custom player key-value fields from client and server SDKs step by step.","sidebarTitle":"Quickstart","href":"/services/playfab/player-progression/player-data/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Tutorial Get a player profile","description":"Retrieve PlayFab player profile data in Unity using GetPlayerProfile, configure PlayerProfileViewConstraints, and read created and last login timestamps.","sidebarTitle":"Getting Player Profiles","href":"/services/playfab/player-progression/player-data/getting-player-profiles"},{"title":"How to set internal player data","description":"Set internal PlayFab player data through server APIs to store private key-value fields tied to a player that are inaccessible from game clients.","sidebarTitle":"Setting internal player data","href":"/services/playfab/player-progression/player-data/how-to-set-internal-player-data"},{"title":"How to get internal player data","description":"Retrieve internal PlayFab player data from server APIs to access private fields that stay hidden from clients and remain secure to your title.","sidebarTitle":"Getting internal player data","href":"/services/playfab/player-progression/player-data/how-to-get-internal-player-data"},{"title":"How to set read-only player data","description":"Write read-only PlayFab player data from server APIs so clients can read authoritative progression values without being able to modify them.","sidebarTitle":"Setting read-only player data","href":"/services/playfab/player-progression/player-data/how-to-set-read-only-player-data"},{"title":"How to get read-only player data","description":"Fetch read-only PlayFab player data from client or server APIs to expose progression values players can view but cannot modify directly.","sidebarTitle":"Getting read-only player data","href":"/services/playfab/player-progression/player-data/how-to-get-read-only-player-data"},{"title":"Modify read-only or internal player data via CloudScript","description":"Safely update read-only and internal PlayFab player data from CloudScript using server.UpdateUserInternalData with C# and JavaScript sample code.","sidebarTitle":"Modifying read-only or internal player data from CloudScript","href":"/services/playfab/player-progression/player-data/how-to-modify-read-only-internal-player-data"},{"title":"Use player publisher data to reward multi-title play","description":"Use PlayFab player publisher data and CloudScript to track cross-title logins and grant virtual currency rewards to players who play multiple titles.","sidebarTitle":"Using player publisher data to grant a reward for playing multiple titles","href":"/services/playfab/player-progression/player-data/using-player-publisher-data"},{"title":"Using Player inventory","description":"Work with PlayFab player inventory using server-authoritative client and server APIs to purchase items, grant currency, and manage catalog-backed content.","sidebarTitle":"Player Inventory","href":"/services/playfab/player-progression/player-data/player-inventory"},{"title":"Using the Players Page","description":"Search the PlayFab Game Manager Players page with plain-text lookups or KQL complex queries against PlayerProfile columns to inspect and filter accounts.","sidebarTitle":"Using the Players page","href":"/services/playfab/player-progression/player-data/using-the-players-page"},{"title":"Using Player details","description":"Navigate the PlayFab Game Manager Player details page to view account info, linked accounts, and run CloudScript on behalf of an individual player.","href":"/services/playfab/player-progression/player-data/player-details"},{"title":"Player Logins","description":"Review a PlayFab player's login history in Game Manager, including attempt dates, IP addresses, login source, and success or failure results per entry.","sidebarTitle":"Player Logins report","href":"/services/playfab/player-progression/player-data/player-logins"},{"title":"Player Ban system","description":"Apply PlayFab player bans to invalidate authentication tokens for rule-breakers using Game Manager, ReportPlayer, and server API ban management calls.","sidebarTitle":"Player Ban System","href":"/services/playfab/player-progression/player-data/player-bans"},{"title":"Player Segments","description":"Group PlayFab players into segments in Game Manager, monitor matching player counts, and trigger automatic or manual custom actions on each segment.","href":"/services/playfab/player-progression/player-data/player-segments"},{"title":"Player Segment configuration","description":"Configure PlayFab player segments to group players by data, behavior, and progression rules that drive targeted actions and analytics.","href":"/services/playfab/player-progression/player-data/player-segment-configuration"},{"title":"IP Ban System","description":"Block suspicious PlayFab logins by creating single-address or CIDR range IP bans from Game Manager or the Services SDK, with permanent or timed expiration.","sidebarTitle":"IP Ban System","href":"/services/playfab/player-progression/player-data/ip-bans"}]}]},{"group":"Statistics","expanded":false,"pages":[{"title":"PlayFab Statistics overview","description":"Introduction to the PlayFab Statistics service for tracking player scores, progression values, and leaderboard-ready numeric data across your title.","sidebarTitle":"Overview","href":"/services/playfab/player-progression/statistics/index"},{"title":"Create a basic statistic","description":"Create a basic PlayFab statistic by defining its name, aggregation, and reset behavior, then writing player values to track progression over time.","href":"/services/playfab/player-progression/statistics/create-basic-statistics"},{"title":"Doing more with statistics","description":"Explore advanced PlayFab Statistics features including versioning, metadata, transactional writes, and integrations that extend progression tracking","href":"/services/playfab/player-progression/statistics/doing-more-statistics"},{"title":"Seasonal statistics","description":"Use PlayFab seasonal statistics and versioning to reset player scores on a schedule, powering seasons, ladders, and time-boxed progression events.","href":"/services/playfab/player-progression/statistics/seasonal-statistics"},{"title":"Metadata statistics","description":"Attach metadata to PlayFab statistics to carry contextual details alongside numeric values, enriching leaderboard entries and player progression data.","sidebarTitle":"Add contextual data to Statistics","href":"/services/playfab/player-progression/statistics/metadata-statistics"},{"title":"Transaction writes","description":"Use PlayFab Statistics transactional writes to update multiple player statistics atomically and preserve consistency across progression updates.","sidebarTitle":"Transactional writes","href":"/services/playfab/player-progression/statistics/transactional-writes"},{"title":"Community Statistics","description":"Create PlayFab community statistics that aggregate values across all players in your title to power global goals, events, and shared milestones.","sidebarTitle":"Community statistics","href":"/services/playfab/player-progression/statistics/community-statistics"},{"title":"Statistics with PlayStream and Telemetry","description":"Integrate PlayFab Statistics with PlayStream and telemetry base events to trigger automation, analytics, and reactions to progression changes.","href":"/services/playfab/player-progression/statistics/statistics-with-playstream-and-telemetry"},{"title":"API Statistics reference","description":"API reference for the PlayFab Statistics service, listing endpoints and operations for creating definitions, writing values, and querying player stats.","sidebarTitle":"API reference","href":"/services/playfab/player-progression/statistics/api-reference"},{"title":"Quickstart on statistics","description":"PlayFab Statistics quickstart shows how to define a statistic, write player values, and read results using the SDK to bootstrap progression tracking.","sidebarTitle":"Quickstart","href":"/services/playfab/player-progression/statistics/quickstart-statistics"},{"title":"Limits on statistics","description":"Review PlayFab Statistics service limits including maximum definitions per title, values per player, and other bounds that shape progression design.","sidebarTitle":"Limits","href":"/services/playfab/player-progression/statistics/limits-statistics"},{"title":"Quota Statistics","description":"Understand PlayFab Statistics quotas covering request rates and write throughput so your title stays within service limits during progression updates.","sidebarTitle":"Quota","href":"/services/playfab/player-progression/statistics/quota-statistics"}]},{"group":"Game saves","expanded":false,"pages":[{"title":"Game Saves overview","description":"Overview of PlayFab Game Saves, a cross-device cloud save service for storing, syncing, and restoring player progress across sessions and platforms.","sidebarTitle":"Overview","href":"/services/playfab/player-progression/game-saves/overview"},{"title":"Game Saves onboarding","description":"Onboard your title to PlayFab Game Saves with setup steps for enabling the cloud save service, configuring titles, and preparing SDK integration.","sidebarTitle":"Onboarding","href":"/services/playfab/player-progression/game-saves/onboarding"},{"title":"Game Saves quickstart","description":"PlayFab Game Saves quickstart walks through initial setup, SDK calls, and reading and writing cloud save data so you can integrate saves quickly.","sidebarTitle":"Quickstart","href":"/services/playfab/player-progression/game-saves/quickstart"},{"title":"Account linking strategies for PlayFab Game Saves","description":"Compare cross-progression strategies for PlayFab Game Saves, including primary linking identities and required vs optional platform account linking.","sidebarTitle":"Account Linking","href":"/services/playfab/player-progression/game-saves/linking"},{"title":"Game Saves Implementation with October 2025 GDK","description":"Essential guide for implementing PlayFab Game Saves with October 2025 GDK (2510), including requirements for new implementations and migration guidance","sidebarTitle":"October 2025 GDK Implementation","href":"/services/playfab/player-progression/game-saves/october-2025-gdk-changes"},{"title":"Steam Deck Implementation Guide for PlayFab Game Saves","description":"Comprehensive guide for implementing PlayFab Game Saves on Steam Deck with October 2025 GDK, including authentication, UI callbacks, and sync strategies","sidebarTitle":"Steam Deck Implementation","href":"/services/playfab/player-progression/game-saves/steam-deck-implementation"},{"title":"Game Saves conflicts","description":"Resolve PlayFab Game Saves conflicts when local and cloud save data diverge, using sync strategies to protect cross-device player progress.","sidebarTitle":"Conflicts","href":"/services/playfab/player-progression/game-saves/conflicts"},{"title":"Game Saves rollback","description":"Restore a PlayFab Game Saves player save to an earlier state using RollbackToLastKnownGood or RollbackToLastConflict options on the add user API.","sidebarTitle":"Rollback","href":"/services/playfab/player-progression/game-saves/rollback"},{"title":"Game Saves UI callbacks","description":"Implement custom sync UI for PlayFab Game Saves by registering callbacks, handling the state machine, and calling response APIs for conflicts and retries.","sidebarTitle":"UI callbacks","href":"/services/playfab/player-progression/game-saves/ui-callbacks"},{"title":"Game Saves offline mode","description":"Use PlayFab Game Saves offline mode to let players continue progress without connectivity and sync cloud saves once the network returns.","sidebarTitle":"Offline mode","href":"/services/playfab/player-progression/game-saves/offline"},{"title":"Game Saves error handling FAQ","description":"Game Saves error handling FAQ covering transient failures, invalid input, and when the system goes offline instead of returning an error.","href":"/services/playfab/player-progression/game-saves/error-handling-faq"},{"title":"Game Saves PlayStream events","description":"Reference for PlayFab Game Saves PlayStream events, covering version finalization, conflict resolution, and known-good rollback telemetry fields.","sidebarTitle":"PlayStream Events","href":"/services/playfab/player-progression/game-saves/playstream-events"},{"title":"Game Saves Active Device Changes","description":"Handle PlayFab Game Saves active device changes to prevent progress loss when players switch devices mid-session across multiple platforms.","sidebarTitle":"Active Device Changes","href":"/services/playfab/player-progression/game-saves/activedevicechanges"},{"title":"Game Saves limits","description":"Review PlayFab Game Saves limits including file size, number of slots per player, and quotas that shape cloud save design for your title.","sidebarTitle":"Limits","href":"/services/playfab/player-progression/game-saves/limits"}]}]},{"group":"Game data","icon":"chart-mixed","expanded":false,"pages":[{"title":"PlayFab data and analytics documentation","description":"Manage PlayFab game data with reporting for weekly reports and trends, segmentation and experimentation tools, and data ingestion and export utilities.","sidebarTitle":"Game data","href":"/services/playfab/data-analytics/index"},{"group":"Ingesting data","expanded":false,"pages":[{"group":"PlayStream","expanded":false,"pages":[{"group":"Overviews","expanded":false,"pages":[{"title":"PlayStream","description":"PlayStream is PlayFab's real-time event pipeline for tracking player behavior, custom events, and LiveOps insights across engagement, retention, and revenue.","href":"/services/playfab/data-analytics/ingest-data/playstream-overview"},{"title":"PlayStream events","description":"Compare PlayFabGenerated and UserGenerated PlayStream events, then ingest them with WriteEvents, WritePlayerEvent, WriteCharacterEvent, or WriteTitleEvent APIs.","sidebarTitle":"PlayStream Events","href":"/services/playfab/data-analytics/ingest-data/playstream-events"},{"title":"PlayStream with entity events","description":"Send batched entity events to PlayStream with the WriteEvents API and use the unified entity event model for players, titles, characters, groups, and more.","sidebarTitle":"PlayStream with Entity events","href":"/services/playfab/data-analytics/ingest-data/playstream-with-entity-events"}]},{"group":"Concepts","expanded":false,"pages":[{"title":"Real-time Analytics Core Concepts","description":"Introduces the core concepts of PlayFab real-time analytics, including events, event flow, and the tools used to aggregate, query, and report on game data.","sidebarTitle":"Real-time analytics","href":"/services/playfab/data-analytics/ingest-data/real-time-analytics-core-concepts"},{"title":"PlayStream event capabilities","description":"Explore PlayStream event pipeline capabilities including the real-time rules engine, live segmentation, event debugger, webhooks, and custom WriteEvent APIs.","sidebarTitle":"PlayStream Event Capabilities","href":"/services/playfab/data-analytics/ingest-data/playstream-event-capabilities"},{"title":"Using Custom Tag to Customize Your Events","description":"Learn about using custom tags to customize your events. Custom tags are a collection of key-value-pairs that studios can optionally include with an API request.","sidebarTitle":"Custom tags with PlayStream events","href":"/services/playfab/data-analytics/ingest-data/playstream-custom-tags"}]}]},{"group":"Telemetry","expanded":false,"pages":[{"title":"Telemetry","description":"Send high-volume UserGenerated events to PlayFab with the WriteTelemetryEvents API, bypassing real-time processing for cost-effective analytics and reporting.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/ingest-data/telemetry-overview"},{"title":"Telemetry Keys QuickStart","description":"Create a PlayFab Telemetry Key in the Data section of Game Manager and use it as the X-TelemetryKey HTTP header when calling the WriteTelemetryEvents API.","sidebarTitle":"QuickStart","href":"/services/playfab/data-analytics/ingest-data/telemetry-keys-qs"},{"group":"Concepts","expanded":false,"pages":[{"title":"Telemetry Keys","description":"Use PlayFab Telemetry Keys as a lightweight credential to call WriteTelemetryEvents from your game client without an Entity Token or Title Secret exposure.","href":"/services/playfab/data-analytics/ingest-data/telemetry-keys-overview"},{"title":"Sessions","description":"How to enable and manage PlayFab session events in the Unity SDK to log focus time and session duration for players from the client automatically.","sidebarTitle":"Manage Session Events","href":"/services/playfab/data-analytics/ingest-data/sessions"}]},{"group":"Tutorials","expanded":false,"pages":[{"title":"Delete Telemetry Keys","description":"Step-by-step instructions to permanently delete a PlayFab Telemetry Key from the Data section of Game Manager, including warnings about non-reversible deletion.","href":"/services/playfab/data-analytics/ingest-data/ht-telemetry-keys-delete"},{"title":"Activate or Deactivate Telemetry Keys","description":"Steps for activating or deactivating PlayFab Telemetry Keys in Game Manager to enable or temporarily disable event ingestion without deleting the key.","href":"/services/playfab/data-analytics/ingest-data/ht-activate-deactivate-telemetry-keys"},{"title":"Enable or Disable Service Generated Events","description":"Learn how to configure PlayStream, Telemetry, and disabled event types in PlayFab Game Manager to optimize data collection and automation.","href":"/services/playfab/data-analytics/ingest-data/opt-in-events"}]}]}]},{"group":"Exporting data","expanded":false,"pages":[{"group":"Data connections","expanded":false,"pages":[{"title":"Data Connections - Overview","description":"PlayFab Data Connections stream PlayStream and telemetry events into Azure Blob Storage, Azure Data Explorer, Microsoft Fabric KQL, or AWS S3 in near real time.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/export-data/data-connection-overview"},{"title":"Data Connections quickstart","description":"Create your first PlayFab Data Connection from Game Manager to route PlayStream and telemetry events into Azure Blob, ADX, Fabric KQL, or AWS S3 storage.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/export-data/data-connection-quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Connecting to Azure Data Explorer","description":"Configure a PlayFab Data Connection to Azure Data Explorer for near real-time ingestion of PlayStream and telemetry events into your ADX cluster and database.","sidebarTitle":"Azure Data Explorer Export","href":"/services/playfab/data-analytics/export-data/data-connection-adx"},{"title":"Connecting to Azure Blob","description":"Set up a PlayFab Data Connection to Azure Blob Storage using a SAS token to export PlayStream and telemetry events as Parquet files for downstream analytics.","sidebarTitle":"Azure Blob Export","href":"/services/playfab/data-analytics/export-data/data-connection-azure-blob"}]}]},{"group":"Event sampling","expanded":false,"pages":[{"title":"Manage Events with Sampling","description":"Use PlayFab Manage Events with sampling to reduce storage costs and improve query performance by ingesting only a percentage of PlayStream and telemetry events.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/export-data/event-sampling-overview"},{"title":"Event Sampling quickstart","description":"Configure per-event sampling percentages in the PlayFab Game Manager Manage Events page to control ingestion volume for PlayStream and custom telemetry events.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/export-data/event-sampling-quickstart"}]},{"group":"Event partitioning (preview)","expanded":false,"pages":[{"title":"Event Partitioning overview (Preview)","description":"Learn how PlayFab Event Partitioning writes selected events to dedicated Azure Blob folders and separate ADX tables for faster targeted queries and analysis.","sidebarTitle":"Overview (Preview)","href":"/services/playfab/data-analytics/export-data/event-partitioning-overview"},{"title":"Event Partitioning quickstart (Preview)","description":"Add, edit, and remove Managed Events in Game Manager to enable PlayFab Event Partitioning for Data Connections into Azure Blob Storage and Azure Data Explorer.","sidebarTitle":"Quickstart (Preview)","href":"/services/playfab/data-analytics/export-data/event-partitioning-quickstart"}]}]},{"group":"Learning with data","expanded":false,"pages":[{"group":"Reporting","expanded":false,"pages":[{"title":"Reports","description":"Access PlayFab pre-generated Reports in Game Manager for daily, monthly, and 30-day views of engagement and monetization, with CSV export and email digests.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/learn-data/reports/overview"},{"title":"Reports quickstart","description":"Quickstart for accessing PlayFab Reports in Game Manager, filtering by report type and date, and downloading CSV files of event-based analytics data.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/learn-data/reports/quickstart"},{"group":"Concepts","expanded":false,"pages":[{"title":"Metrics and Terminology","description":"Reference tables defining PlayFab analytics terminology and standard engagement and revenue metrics such as DAU, MAU, ARPU, ARPPU, and retention.","href":"/services/playfab/data-analytics/learn-data/reports/metrics-and-terminology"}]},{"group":"Tutorials","expanded":false,"pages":[{"title":"Daily A/B Test KPI Report","description":"Overview of the PlayFab Daily A/B Test KPI report, which breaks down DAU, ARPDAU, retention, and transactions per bucket to evaluate experiments.","href":"/services/playfab/data-analytics/learn-data/reports/daily-ab-test-kpi-report"},{"title":"Daily Abuse Reports History Report","description":"Overview of the PlayFab Daily Abuse Reports History report, a CSV log of player-submitted reports used to investigate cheating and abusive behavior.","href":"/services/playfab/data-analytics/learn-data/reports/daily-abuse-reports-history-report"},{"title":"Daily and Monthly CDN Usage Report","description":"Overview of the PlayFab Daily and Monthly CDN Usage reports, which track content download counts and transferred byte volume from your players.","href":"/services/playfab/data-analytics/learn-data/reports/daily-and-monthly-cdn-usage-report"},{"title":"Daily and Monthly Top Items Report","description":"Overview of the PlayFab Daily and Monthly Top Items report, which lists the top 100 selling catalog items and bundles with sales counts and revenue.","href":"/services/playfab/data-analytics/learn-data/reports/daily-and-monthly-top-items-report"},{"title":"Daily and Monthly Top Spender Report","description":"Overview of the PlayFab Daily and Monthly Top Spender report, which ranks the top 100 paying players in your game by transaction amount for a given period.","href":"/services/playfab/data-analytics/learn-data/reports/daily-and-monthly-top-spender-report"},{"title":"Daily API Usage Details Report","description":"Overview of the PlayFab Daily API Usage Details report, showing hourly call counts, errors, response times, and payload sizes per API for your title.","sidebarTitle":"Daily and Monthly Top Details Report","href":"/services/playfab/data-analytics/learn-data/reports/daily-api-usage-details-report"},{"title":"Daily, monthly, and rolling 30-day overview reports","description":"Overview of PlayFab daily, monthly, and rolling 30-day KPI reports covering logins, new users, revenue, purchases, ARPU, ARPPU, and API usage totals.","sidebarTitle":"Daily and Monthly Rolling 30-Day Overview and Totals Reports","href":"/services/playfab/data-analytics/learn-data/reports/daily-monthly-and-rolling-30-day-overview-and-totals-reports"},{"title":"Thirty-day New User Conversion Report","description":"Overview of the PlayFab Thirty-Day New User Conversion report, showing cumulative percentages of new-player cohorts who make a purchase within 30 days.","href":"/services/playfab/data-analytics/learn-data/reports/thirty-day-new-user-conversion-report"},{"title":"thirty-day New User Retention Report","description":"Overview of the PlayFab Thirty-Day New User Retention report, showing the percentage of each new-player cohort that returns to your game across 30 days.","sidebarTitle":"Thirty-day New User Retention Report","href":"/services/playfab/data-analytics/learn-data/reports/thirty-day-new-user-retention-report"},{"title":"thirty-day Retention Report","description":"Overview of the PlayFab Thirty-Day Retention report, tracking the percentage of all active player cohorts, new and returning, who come back over 30 days.","sidebarTitle":"Thirty-day Retention Report","href":"/services/playfab/data-analytics/learn-data/reports/thirty-day-retention-report"},{"title":"Daily email report","description":"Overview of the PlayFab Daily Title email report, which delivers engagement and revenue metrics like DAU, MAU, ARPU, and retention, plus how to unsubscribe.","sidebarTitle":"Daily Email Report","href":"/services/playfab/data-analytics/learn-data/reports/daily-email-report"},{"title":"PlayFab and Microsoft Fabric Real-Time Analytics tutorial","description":"End-to-end tutorial for integrating PlayFab with Microsoft Fabric Real-Time Analytics to stream game events and explore KPIs in a Power BI dashboard.","sidebarTitle":"PlayFab and Microsoft Fabric real-time analytics (RTA) for game creators","href":"/services/playfab/data-analytics/learn-data/reports/real-time-analytics-tutorial"},{"title":"Title Overview","description":"Review your game's KPIs on the PlayFab Title Overview page including unique users, API calls, logins, purchases, multiplayer servers, and CloudScript runtime.","href":"/services/playfab/data-analytics/learn-data/reports/title-overview-report"}]}]},{"group":"Trends","expanded":false,"pages":[{"group":"Overview","expanded":false,"pages":[{"title":"Trends","description":"Track PlayFab Trends KPIs including DAU, MAU, new players, retention, screen time, and revenue, and slice them by platform, region, or segment dimensions.","href":"/services/playfab/data-analytics/learn-data/trends/trends-overview"},{"title":"Segments as a dimension","description":"Filter the PlayFab Trends dashboard by up to ten player segments to visualize KPI changes over time and compare engagement across audience cohorts.","sidebarTitle":"Segments as a Dimension (Preview)","href":"/services/playfab/data-analytics/learn-data/trends/segments-dimension-overview"}]},{"group":"Quickstart","expanded":false,"pages":[{"title":"Metrics quickstart","description":"Explore PlayFab metrics in Game Manager using the Trends tab to filter by time, platform, and region across MAU, DAU, retention, revenue, and stickiness.","sidebarTitle":"Trends QuickStart","href":"/services/playfab/data-analytics/learn-data/trends/trends-quickstart"},{"title":"Segments as a dimension quickstart","description":"Manage segments as a Trends dashboard dimension through Game Manager or the GetAllAnalyticsSegments, AddAnalyticsSegment, and RemoveAnalyticsSegment APIs.","sidebarTitle":"Segments as a Dimension (Preview)","href":"/services/playfab/data-analytics/learn-data/trends/segments-dimension-qs"}]}]},{"group":"Player churn prediction","expanded":false,"pages":[{"group":"Overviews","expanded":false,"pages":[{"title":"Churn Prediction Overview","description":"PlayFab Churn Prediction uses Azure AI and ML to score eligible players by risk so you can segment likely churners and target them with retention actions.","sidebarTitle":"What is Player Churn Prediction?","href":"/services/playfab/data-analytics/learn-data/churn-prediction/overview"},{"title":"Churn Prediction Pricing","description":"Understand PlayFab Player Churn Prediction pricing based on the cumulative count of Eligible Players scored daily by the machine learning pipeline.","sidebarTitle":"Pricing","href":"/services/playfab/data-analytics/learn-data/churn-prediction/pricing"}]},{"title":"Churn Prediction Quickstart","description":"Create a PlayFab Churn Prediction segment for high-risk players and attach mitigation actions like granting virtual currency to reduce attrition automatically.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/learn-data/churn-prediction/churn-prediction-quickstart"}]},{"group":"Data Explorer","expanded":false,"pages":[{"title":"Data Explorer","description":"Query PlayFab Insights event data with Data Explorer using basic mode for guided exploration or advanced Kusto Query Language for deep, ad hoc analysis.","sidebarTitle":"Data Explorer overview","href":"/services/playfab/data-analytics/learn-data/data-explorer/index"},{"title":"Data Explorer quickstart","description":"Quickstart for querying event data from PlayFab API calls in Game Manager using Data Explorer basic and advanced modes to run and view your first queries.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/learn-data/data-explorer/quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Getting started with Data Explorer basic mode","description":"Use PlayFab Data Explorer basic mode to build event queries without code, combining conditions and clauses to explore player events and analytics.","sidebarTitle":"Get started with Data Explorer Basic mode","href":"/services/playfab/data-analytics/learn-data/data-explorer/getting-started-with-data-explorer-basic"},{"title":"Getting started with Data Explorer advanced mode","description":"Learn to write custom PlayFab Data Explorer queries in advanced mode using the Kusto Query Language against the events.all table for deeper analytics.","sidebarTitle":"Get started with Data Explorer Advanced mode","href":"/services/playfab/data-analytics/learn-data/data-explorer/getting-started-with-data-explorer-advanced"}]}]}]},{"group":"Acting on data","expanded":false,"pages":[{"title":"Webhooks","description":"Overview of the PlayFab Webhooks panel in Game Manager, including how to access it and configure a webhook endpoint to forward event data to your server.","href":"/services/playfab/data-analytics/acting-data/webhooks-overview"},{"group":"Event schemas","expanded":false,"pages":[{"title":"Schemas","description":"Understand PlayFab Insights schemas that store event data streamed from your title and processed data sets generated by PlayFab services on a schedule.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/acting-data/schemas-overview"},{"title":"Getting Started with PlayFab Explorer","description":"Reference for the PlayFab Insights events.all Kusto table, including the schema, entity fields, and payload columns that power Event History and Explorer.","sidebarTitle":"About the events.all table","href":"/services/playfab/data-analytics/acting-data/schemas-events-all"},{"title":"Schemas quickstart","description":"Get started with PlayFab Insights schemas, including how event data lands in the events.all table via WriteEvents and where processed data sets appear.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/acting-data/schemas-quickstart"}]},{"group":"Actions and rules","expanded":false,"pages":[{"title":"Actions \u0026 Rules","description":"Use PlayStream Actions and Rules to react to real-time events with triggers, conditions, and actions like granting rewards or sending push notifications.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/acting-data/action-rules-overview"},{"title":"Actions \u0026 Rules quickstart","description":"Build your first PlayStream Rule with triggers, conditions, and actions to react to player events in real time and drive automated LiveOps responses.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/acting-data/action-rules-quickstart"},{"group":"Tutorials","expanded":false,"pages":[{"title":"Bulk Actions for an entire Player Segment","description":"Tutorial for creating a PlayFab task that runs one or more bulk actions, such as granting rewards, on every player in a target segment.","sidebarTitle":"Bulk Actions for an entire player segment","href":"/services/playfab/data-analytics/acting-data/action-rules-bulk-actions-for-an-entire-player-segment"},{"title":"Using CloudScript actions with PlayStream","description":"Explains the context data available inside a CloudScript handler triggered by a PlayStream action, and how to use it to drive PlayFab server logic.","href":"/services/playfab/data-analytics/acting-data/action-rules-using-cloudscript-actions-with-playstream"}]}]},{"group":"Scheduled tasks","expanded":false,"pages":[{"title":"Scheduled tasks","description":"Automate LiveOps routines with PlayFab Scheduled Tasks that update title data, run CloudScript, adjust virtual currencies, or re-engage lapsed players.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/acting-data/scheduled-tasks/index"},{"title":"Scheduled tasks quickstart","description":"Create a recurring PlayFab scheduled task in Game Manager that invokes CloudScript with a cron expression to adjust title data on a fixed cadence.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/acting-data/scheduled-tasks/quickstart"}]}]},{"group":"Legacy","expanded":false,"pages":[{"group":"Overview","expanded":false,"pages":[{"title":"Insights","description":"Legacy PlayFab Insights is a managed Kusto data environment for game telemetry with automatic ingestion, retention controls, and connectivity to external tools.","href":"/services/playfab/data-analytics/legacy/insights/overview"},{"title":"Insights pricing","description":"Understand legacy PlayFab Insights pricing with Insights Credits for performance levels, retention, and event exports across Standard, Premium, and PAYG plans.","sidebarTitle":"Insights Pricing","href":"/services/playfab/data-analytics/legacy/insights/pricing"},{"title":"Connecting external tools with Insights","description":"Pair legacy PlayFab Insights with external tools like Power BI, Kusto Explorer, Azure Data Explorer, Azure Data Factory, Grafana, Python, and the Kusto C# SDK.","sidebarTitle":"Insights Connectivity","href":"/services/playfab/data-analytics/legacy/connectivity/index"}]},{"group":"Concepts","expanded":false,"pages":[{"title":"Performance and retention","description":"Tune legacy PlayFab Insights performance levels and retention settings to balance cache size, compute, concurrent query limits, and event ingestion throughput.","sidebarTitle":"Insights Management","href":"/services/playfab/data-analytics/legacy/insights/performance-retention"},{"title":"Insights Management Commands","description":"Reference for PlayFab Insights management and data control Kusto commands to inspect queries, alter retention, create custom tables, and ingest or purge data.","sidebarTitle":"Insights management Commands","href":"/services/playfab/data-analytics/legacy/insights/management-commands"},{"title":"Scheduled Scaling","description":"Automate legacy PlayFab Insights performance level scaling with cron-based scheduled tasks so cluster capacity matches demand and reduces analytics spend.","sidebarTitle":"Insights Scheduled Scaling","href":"/services/playfab/data-analytics/legacy/insights/scheduled-scaling"}]},{"group":"Tutorials","expanded":false,"pages":[{"title":"Insights Export","description":"Use legacy Insights Event Export in Game Manager to bulk export game event data to external storage; migrate to Data Connections before Insights retirement.","sidebarTitle":"Export Data","href":"/services/playfab/data-analytics/legacy/insights/export"},{"title":"Insights Best Practices","description":"Follow PlayFab Insights best practices for sizing cache, tuning performance levels, and running efficient Kusto queries, plus answers to common FAQ questions.","sidebarTitle":"Best Practices and FAQ","href":"/services/playfab/data-analytics/legacy/insights/best-practices"},{"title":"Create a Microsoft Entra ID app for PlayFab Insights","description":"Create a Microsoft Entra ID app and connect it to your PlayFab Insights title database so Azure Data Factory, Grafana, or Python can query it.","sidebarTitle":"Create a Microsoft Entra ID Application to use with Insights","href":"/services/playfab/data-analytics/legacy/connectivity/creating-AAD-app-for-insights"},{"title":"Connecting Power BI to Insights","description":"Connect Power BI Desktop to legacy PlayFab Insights with Microsoft Entra ID authentication and build visualizations, dashboards, and reports on your game data.","href":"/services/playfab/data-analytics/legacy/connectivity/connecting-power-bi-to-insights"},{"title":"Connecting Kusto Explorer to Insights","description":"Set up Kusto Explorer with Microsoft Entra ID authentication to run KQL queries and explore legacy PlayFab Insights game telemetry from a desktop client.","href":"/services/playfab/data-analytics/legacy/connectivity/connecting-kusto-explorer-to-insights"},{"title":"Connecting Azure Data Explorer to Insights","description":"Connect Azure Data Explorer (ADX) to legacy PlayFab Insights using Microsoft Entra ID authentication so you can query game telemetry with Kusto Query Language.","href":"/services/playfab/data-analytics/legacy/connectivity/connecting-azure-data-explorer-to-insights"},{"title":"Connecting Azure Data Factory (ADF) to Insights","description":"Build an Azure Data Factory pipeline against legacy PlayFab Insights to orchestrate data movement and transform game event data at scale for downstream systems.","sidebarTitle":"Connecting Azure Data Factory to Insights","href":"/services/playfab/data-analytics/legacy/connectivity/connecting-azure-data-factory-to-insights"},{"title":"Connecting Grafana to Insights","description":"Connect Grafana to legacy PlayFab Insights, add a data source, and build dashboards that run Kusto queries on your game telemetry for monitoring and alerts.","href":"/services/playfab/data-analytics/legacy/connectivity/connecting-grafana-to-insights"},{"title":"Connecting Python to Insights","description":"Query legacy PlayFab Insights from Python and Jupyter Notebooks with the Azure Kusto Python SDK, using Microsoft Entra ID authentication for your game data.","href":"/services/playfab/data-analytics/legacy/connectivity/connecting-python-to-insights"},{"title":"Connecting Kusto C# SDK to Insights","description":"Use the Kusto C# SDK with Microsoft Entra ID authentication to query legacy PlayFab Insights game data from Azure Functions or custom .NET applications.","href":"/services/playfab/data-analytics/legacy/connectivity/connecting-kusto-csharp-to-insights"}]},{"title":"Set up an Amazon S3 bucket","description":"Step-by-step guide to creating and configuring an Amazon S3 bucket, including permissions and access keys, ready for PlayFab event archiving.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/legacy/configure-s3-bucket"},{"title":"S3 Event Archiving","description":"Set up PlayFab legacy event archiving to an Amazon S3 bucket from scratch, covering bucket creation, credentials, and enabling event flow export.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/legacy/s3-event-archiving"},{"group":"Content Delivery Network","icon":"cloud","pages":[{"title":"Content Delivery Network","description":"PlayFab CDN is a legacy content delivery service for game assets billed by egress; new projects should use Azure CDN for image, audio, and binary distribution.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/legacy/content-delivery-network/index"},{"title":"Content Delivery Network quickstart","description":"Store and serve game assets by key from the legacy PlayFab CDN, including folder paths, edge caching behavior, and delays for uploads, overwrites, and deletes.","sidebarTitle":"Quickstart","href":"/services/playfab/data-analytics/legacy/content-delivery-network/quickstart"}]}]},{"group":"Privacy \u0026 compliance","icon":"shield-halved","pages":[{"title":"PlayFab GDPR - Delete Player Data","description":"How to delete PlayFab player data for GDPR compliance, including using DeleteMasterPlayerAccount to remove accounts or clearing data while keeping the account.","sidebarTitle":"Deleting Player Data","href":"/services/playfab/data-analytics/privacy-compliance/gdpr-deleting-player-data"},{"title":"PlayFab GDPR - Export Player Data","description":"How to export a PlayFab player's data for GDPR compliance using ExportMasterPlayerData, covering statistics, inventory, purchases, and event history.","sidebarTitle":"Exporting Player Data","href":"/services/playfab/data-analytics/privacy-compliance/gdpr-exporting-player-data"},{"title":"PlayFab GDPR - Deleting and Exporting Player Data","description":"How to use PlayFab Admin APIs to export or delete a player’s data so that you can be General Data Protection Regulation (GDPR) compliant.","sidebarTitle":"Overview","href":"/services/playfab/data-analytics/privacy-compliance/playfab-gdpr-deleting-and-exporting-player-data"}]}]}]},{"group":"What's new","icon":"sparkles","pages":[{"group":"Previous release notes","pages":[{"title":"PlayFab Multiplayer C++ SDK Release Notes","description":"Version history, new features, fixes, and breaking changes for the PlayFab Lobby and Matchmaking C++ SDK across supported platforms and releases.","sidebarTitle":"Lobby and Matchmaking SDK Release Notes","href":"/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/lobby-and-matchmaking-release-notes"}]}]},{"group":"Demo game","icon":"gamepad","pages":[{"title":"Winter Starfall PlayFab demo game overview","description":"Explore Winter Starfall, PlayFab's playable demo game that showcases live-service features like accounts, economy, matchmaking, and analytics end to end.","sidebarTitle":"Overview","href":"/services/playfab/demo-game/overview"},{"title":"Source code and best practices - Winter Starfall","description":"Download the Winter Starfall PlayFab demo game source code and walk through best-practice code samples for player login and in-game purchase scenarios.","sidebarTitle":"Source code and best practices","href":"/services/playfab/demo-game/source-code-and-best-practices"},{"title":"Vanguard Outrider (legacy)","description":"Explore Vanguard Outrider, a legacy PlayFab demo game showcasing legacy Economy and CloudScript, available through Game Manager alongside Winter Starfall.","sidebarTitle":"Legacy demo game","href":"/services/playfab/demo-game/legacy-vanguard-outrider"}]},{"group":"Recipes and samples","icon":"book-open","pages":[{"title":"General PlayFab samples","description":"Explore PlayFab code samples across SDKs and engines that demonstrate how to integrate features like authentication, economy, and multiplayer services.","sidebarTitle":"General samples","href":"/services/playfab/resources/playfab-samples"},{"title":"Multiplayer Servers samples and resources","description":"Samples and resources for PlayFab Multiplayer Game Servers, including the Wrapper, Windows Runner, Unity, and Unreal GSDK examples from the MpsSamples repo.","sidebarTitle":"Multiplayer Servers samples","href":"/services/playfab/multiplayer/servers/server-samples-resources"},{"title":"Party samples","description":"Sample projects for PlayFab Party demonstrating voice chat, data messaging, and cross-platform networking on PC, console, Unity, and Unreal Engine.","sidebarTitle":"Samples","href":"/services/playfab/multiplayer/networking/party-samples"},{"title":"Recipes","description":"Browse PlayFab recipes with step-by-step solutions that combine services and SDKs to solve common live-game scenarios and integration patterns.","href":"/services/playfab/resources/playfab-recipes"}]},{"group":"Pricing","icon":"tag","pages":[{"title":"PlayFab pricing overview","description":"Learn how PlayFab pricing works with links to billing summaries, meters, multiplayer server rates, Economy V2 catalog costs, and account plan upgrades.","sidebarTitle":"Overview","href":"/services/playfab/pricing/pricing-overview"},{"title":"Billing Summary + Base Rate","description":"Review the PlayFab billing details page in Game Manager to see charges, usage, and cost breakdowns across services and meters for your titles.","sidebarTitle":"Billing summary and base rates","href":"/services/playfab/pricing/billingdetails"},{"title":"Development Mode","description":"Evaluate PlayFab risk-free in Development Mode with no monthly billing up to 1,000 unique users, then launch titles through Game Manager when ready to scale.","sidebarTitle":"Development Mode titles","href":"/services/playfab/pricing/development-mode"},{"group":"Pricing meters","pages":[{"title":"Pricing Meters","description":"Overview of PlayFab consumption-based pricing meters for Events, Profile, Content and Configuration, CloudScript, Insights, and Multiplayer Services.","sidebarTitle":"Meters Overview","href":"/services/playfab/pricing/meters/meters"},{"title":"Profile Reads Meter API Description","description":"Reference list of PlayFab APIs for player profiles, entities, characters, groups, and inventory KVPs that increment the profile reads meter.","sidebarTitle":"Profile Reads","href":"/services/playfab/pricing/meters/profile-reads"},{"title":"Profile Writes Meter API Description","description":"Reference list of PlayFab APIs, including AddPlayerTag and virtual currency updates, that increment the profile writes meter for player and entity data.","sidebarTitle":"Profile Writes","href":"/services/playfab/pricing/meters/profile-writes"},{"title":"Leaderboards Meters","description":"Learn how PlayFab Leaderboards billable meters work, what operations they count, and how leaderboard activity contributes to service charges.","sidebarTitle":"Leaderboard Meters","href":"/services/playfab/pricing/meters/leaderboard-meters"},{"title":"Statistics Meters","description":"Learn how PlayFab Statistics billable meters work, which reads and writes they measure, and how Statistics usage becomes charges on your bill.","href":"/services/playfab/pricing/meters/statistics-meters"},{"title":"Content \u0026 Configuration Reads Meter API Description","description":"Reference list of PlayFab Admin and Client APIs for entity files, actions, rules, and title news that increment the Content \u0026 Configuration reads meter.","sidebarTitle":"Content \u0026 Configuration Reads","href":"/services/playfab/pricing/meters/file-reads"},{"title":"Content \u0026 Configuration Writes Meter API Description","description":"Reference list of PlayFab APIs for news, content files, push notifications, and scheduled tasks that increment the Content \u0026 Configuration writes meter.","sidebarTitle":"Content \u0026 Configuration Writes","href":"/services/playfab/pricing/meters/file-writes"},{"title":"Inventory Reads Meter API Description","description":"Reference list of PlayFab Economy v2 inventory APIs, including GetInventoryItems and store redemption calls, that increment the inventory reads meter.","sidebarTitle":"Economy v2 Inventory Reads","href":"/services/playfab/pricing/meters/economy-reads"},{"title":"Inventory Writes Meter API Description","description":"Reference list of PlayFab Economy v2 inventory write APIs, such as AddInventoryItems and PurchaseInventoryItems, that increment the inventory writes meter.","sidebarTitle":"Economy v2 Inventory Writes","href":"/services/playfab/pricing/meters/economy-writes"},{"title":"Economy Pricing Meters","description":"Understand PlayFab Economy Catalog billable meters, what actions they measure, and how catalog usage translates into charges on your PlayFab bill.","sidebarTitle":"Economy v2 Catalog Meters","href":"/services/playfab/pricing/meters/catalog-meters"}]},{"title":"PlayFab Support","description":"Compare PlayFab support options including documentation, Discord community, account help, support tickets, and emergency escalations by account plan.","sidebarTitle":"Technical support","href":"/services/playfab/pricing/support"},{"title":"Account upgrades","description":"Upgrade your PlayFab account plan from Free-to-start, Pay-as-you-go, Standard, Premium, or Enterprise using self-serve options in Game Manager.","sidebarTitle":"Account upgrades","href":"/services/playfab/pricing/account-upgrades"},{"title":"Title launches","description":"Launch PlayFab titles in Game Manager, understand billing implications of moving from development to launched status, and prepare your title for release.","sidebarTitle":"Title launches","href":"/services/playfab/pricing/title-launches"},{"title":"PlayFab consumption best practices","description":"Optimize PlayFab consumption meters for Events, Profile, CloudScript, and Multiplayer to reduce costs before moving titles from Development Mode to Live.","sidebarTitle":"Consumption best practices","href":"/services/playfab/pricing/consumption-best-practices"}]},{"group":"SDKs","icon":"code","pages":[{"title":"PlayFab SDK Products","description":"Compare PlayFab v1 standalone SDKs and the v2 Unified SDK product lines, and choose the right client library for new or existing game projects.","sidebarTitle":"SDK Products","href":"/services/playfab/sdks/sdk-products"},{"title":"Request access for secured SDKs and samples","description":"How to request access to gated PlayFab SDKs and samples for Nintendo Switch, PlayStation 4, PlayStation 5, and XBOX GDK as a registered developer.","sidebarTitle":"Request access","href":"/services/playfab/sdks/request-access-for-sdks-samples"},{"group":"PlayFab Unified SDK (v2)","pages":[{"title":"PlayFab Unified SDK","description":"Overview of the PlayFab Unified SDK v2 that consolidates Core, Services, Multiplayer, Party, and GameSave with unified authentication and token refresh.","sidebarTitle":"Overview","href":"/services/playfab/sdks/unified-sdk/overview"},{"group":"Quick Start","pages":[{"title":"PlayFab Unified SDK Quickstart Setup","description":"Windows prerequisites and Visual Studio project setup for the PlayFab Unified SDK bundled with the October 2025 GDK, including include, lib, and DLL steps.","sidebarTitle":"Quick Start (Windows) - Prerequisites","href":"/services/playfab/sdks/unified-sdk/quickstart-setup"},{"title":"Quickstart (Windows) - Core SDK Setup","description":"Add the PlayFab Unified SDK to a Windows project, initialize Core, and authenticate a player with XBOX or Steam to obtain a PFEntityHandle.","sidebarTitle":"Quick Start (Windows) - PlayFab Core","href":"/services/playfab/sdks/unified-sdk/quickstart-core"},{"title":"Quickstart (Windows) - Calling PlayFab Services","description":"Use the authenticated PFEntityHandle from the PlayFab Unified SDK to retrieve entity keys and call PlayFab service APIs from a Windows title.","sidebarTitle":"Quick Start (Windows) - PlayFab Services","href":"/services/playfab/sdks/unified-sdk/quickstart-services"},{"title":"Quickstart (Windows) - Party and Multiplayer","description":"Integrate PlayFab Party voice, chat, and networking with PlayFab Multiplayer lobby and matchmaking on Windows using the PlayFab Unified SDK.","sidebarTitle":"Quick Start (Windows) - PlayFab Party","href":"/services/playfab/sdks/unified-sdk/quickstart-windows-party"}]},{"group":"Core Concepts","pages":[{"title":"Making async calls in the PlayFab Unified SDK","description":"Use XAsyncBlock and XTaskQueueHandle with the PlayFab Unified SDK to control which threads run async work and completion callbacks across Core and Services.","sidebarTitle":"Async Model for Core and Services","href":"/services/playfab/sdks/unified-sdk/async-model"},{"title":"Memory management in the PlayFab Unified SDK","description":"Manage memory in the PlayFab Unified SDK with PFMemoryHooks custom allocators, safe XAsyncBlock lifetime patterns, and explicit handle cleanup.","sidebarTitle":"Memory Management","href":"/services/playfab/sdks/unified-sdk/memory-management"},{"title":"Debug tracing in the PlayFab Unified SDK","description":"Enable and configure debug tracing in the PlayFab Unified SDK: set HCTraceLevel verbosity, route output to Visual Studio, or forward to custom game logs.","sidebarTitle":"Debug Tracing for Core and Services","href":"/services/playfab/sdks/unified-sdk/debug-trace"}]},{"title":"Migrate from PlayFab standalone SDK v1 to Unified SDK v2","description":"Migrate a PlayFab title from v1 standalone SDKs to the v2 Unified SDK, covering project layout, authentication, and token management changes.","sidebarTitle":"Migrating from PlayFab standalone SDKs (v1)","href":"/services/playfab/sdks/unified-sdk/migrating-from-v1"}]},{"group":"PlayFab Unified SDK for Unreal Engine (v2)","pages":[{"title":"PlayFab for Unreal Engine Overview","description":"Get started with PlayFab for Unreal Engine (v2 Unified), the plugin bundle covering authentication, services, Lobby, Matchmaking, and Party.","sidebarTitle":"Overview","href":"/services/playfab/sdks/unified-unreal/overview"}]},{"group":"PlayFab Unified SDK for Unity (v2)","pages":[{"title":"PlayFab for Unity (v2 Unified)","description":"Get started with PlayFab for Unity (v2 Unified), the single UPM package that replaces v1 Services, Multiplayer, and Party plugins for Unity.","sidebarTitle":"Overview","href":"/services/playfab/sdks/unified-unity/overview"}]},{"group":"PlayFab Standalone SDKs (v1)","pages":[{"title":"Standalone SDKs overview","description":"Overview of the four standalone PlayFab SDK families: Services, Party, Multiplayer Game Server, and Lobby and Matchmaking, with version support guidance.","sidebarTitle":"Overview","href":"/services/playfab/sdks/sdk-overview"},{"group":"Services SDKs (v1)","pages":[{"title":"PlayFab SDKs","description":"Choose a PlayFab Services SDK by language, platform, or game engine, covering LiveOps, economy, matchmaking, data analytics, and player identity.","sidebarTitle":"Overview","href":"/services/playfab/sdks/playfab-sdk-intro"},{"group":"Release notes","pages":[{"group":"C/C++ SDK release notes","pages":[{"title":"PlayFab Services C/C++ SDK Release Notes","description":"Release notes index for the PlayFab Services C/C++ SDK (PlayFabCSdk), tracking SDK versions, new APIs, deprecations, and bug fixes across releases.","sidebarTitle":"C/C++ SDK Release Notes","href":"/services/playfab/release-notes/playfab-c/index"}]},{"group":"Other SDK release notes","pages":[{"title":"PlayFab Services SDK release notes 2026","description":"PlayFab Services SDK release notes for 2026 with SDK version updates, new API additions, feature changes, deprecations, and bug fixes across releases.","sidebarTitle":"2026 SDK release notes","href":"/services/playfab/release-notes/index"},{"title":"PlayFab Services SDK Release Notes 2025","description":"PlayFab Services SDK release notes for 2025, listing SDK updates, added and deprecated APIs, and bug fixes shipped throughout the year's releases.","sidebarTitle":"2025 SDK Release Notes","href":"/services/playfab/release-notes/2025"},{"title":"PlayFab Services SDK Release Notes 2024","description":"PlayFab Services SDK release notes for 2024, including SDK versions, new APIs, feature additions, breaking changes, and bug fixes from the year.","sidebarTitle":"2024 SDK Release Notes","href":"/services/playfab/release-notes/2024"},{"title":"PlayFab Services SDK Release Notes 2023","description":"PlayFab Services SDK release notes for 2023, covering SDK version updates, new API additions, deprecations, and fixes rolled out across the year.","sidebarTitle":"2023 SDK Release Notes","href":"/services/playfab/release-notes/2023"},{"title":"PlayFab Release Notes 2022","description":"PlayFab Services SDK release notes for 2022, detailing SDK versions, new API surfaces, feature improvements, and fixes shipped during the year.","sidebarTitle":"2022 SDK Release Notes","href":"/services/playfab/release-notes/2022"},{"title":"PlayFab Release Notes 2021","description":"PlayFab Services SDK release notes for 2021, listing SDK version updates, added APIs, deprecations, and bug fixes released across the year.","sidebarTitle":"2021 SDK Release Notes","href":"/services/playfab/release-notes/2021"},{"title":"PlayFab Release Notes 2020","description":"PlayFab Services SDK release notes for 2020, capturing SDK updates, new API endpoints, feature additions, and bug fixes shipped throughout the year.","sidebarTitle":"2020 SDK Release Notes","href":"/services/playfab/release-notes/2020"},{"title":"PlayFab Release Notes 2019","description":"PlayFab Services SDK release notes for 2019, including SDK versions, new APIs, deprecations, and platform improvements delivered during that year.","sidebarTitle":"2019 SDK Release Notes","href":"/services/playfab/release-notes/2019"},{"title":"PlayFab Release Notes 2018","description":"PlayFab Services SDK release notes for 2018, documenting SDK updates, new API features, breaking changes, and bug fixes across the year's releases.","sidebarTitle":"2018 SDK Release Notes","href":"/services/playfab/release-notes/2018"},{"title":"2017","href":"/services/playfab/release-notes/2017"},{"title":"2016","href":"/services/playfab/release-notes/2016"},{"title":"PlayFab Release Notes 2015","description":"PlayFab Services SDK release notes for 2015, covering SDK versions, new API endpoints, bug fixes, and platform updates from that year's releases.","sidebarTitle":"2015 SDK Release Notes","href":"/services/playfab/release-notes/2015"}]}]},{"group":"Languages","pages":[{"title":"PlayFab supported languages","description":"Browse PlayFab SDKs and quickstarts by language, including C/C++, C#, Java, JavaScript, Lua, Node.js, and Python for game and service development.","sidebarTitle":"Languages","href":"/services/playfab/sdks/languages/index"},{"group":"C/C++","pages":[{"title":"PlayFab Services SDK","description":"Introduction to the PlayFab Services C/C++ SDK, with supported platforms (Win32, GDK, Switch, PlayStation, iOS, macOS, Android, Linux) and download links.","sidebarTitle":"C/C++","href":"/services/playfab/sdks/c/index"},{"title":"Quickstart Win32","description":"Add the PlayFab Services C SDK to a Visual Studio 2022 project and make your first PlayFab API call from a native Win32 desktop application.","sidebarTitle":"Quickstart - Win32","href":"/services/playfab/sdks/c/quickstart-win32"},{"title":"Quickstart GDK","description":"Add the PlayFab Services C SDK extension library to a Microsoft GDK title and make your first PlayFab API call from XBOX or Windows GDK code.","sidebarTitle":"Quickstart - GDK","href":"/services/playfab/sdks/c/quickstart-gdk"},{"title":"Quickstart Android","description":"Set up the PlayFab Services C SDK in Android Studio, add the native libraries, and make your first PlayFab API call from an Android project.","sidebarTitle":"Quickstart - Android","href":"/services/playfab/sdks/c/quickstart-android"},{"title":"Quickstart iOS","description":"Add the PlayFab Services C SDK to an Xcode project and make your first PlayFab API call from an iOS app built with the native C client library.","sidebarTitle":"Quickstart - iOS","href":"/services/playfab/sdks/c/quickstart-ios"},{"title":"Quickstart macOS","description":"Add the PlayFab Services C SDK to an Xcode project on macOS and make your first PlayFab API call using the native C client library.","sidebarTitle":"Quickstart - macOS","href":"/services/playfab/sdks/c/quickstart-macos"},{"title":"Quickstart Linux","description":"Add the PlayFab Services C SDK to a Linux project on Ubuntu or WSL and make your first PlayFab API call using the native C client library.","sidebarTitle":"Quickstart - Linux","href":"/services/playfab/sdks/c/quickstart-linux"},{"title":"Making Async Calls","description":"Make asynchronous calls in the PlayFab Services C/C++ SDK using XAsyncBlock, XTaskQueueHandle, and dispatch modes for thread control.","href":"/services/playfab/sdks/c/async"},{"title":"SDK Lifecycle","description":"Initialize, configure, and shut down the PlayFab Services C SDK in the correct order, including memory hooks, Core, and service configuration.","href":"/services/playfab/sdks/c/lifecycle"},{"title":"Entity Handles","description":"Manage PFEntityHandle credentials, ref counting, and entity token lifetime for authenticated player and title calls in the PlayFab C SDK.","href":"/services/playfab/sdks/c/entity-handles"},{"title":"Memory hooking","description":"Control PlayFab Services SDK memory allocations by installing custom alloc and free hooks with PFMemSetFunctions before PFInitialize.","sidebarTitle":"Managing Memory","href":"/services/playfab/sdks/c/memory"},{"title":"HTTP Configuration","description":"Configure HTTP retry, timeout, and response compression settings for the PlayFab Services C SDK using PFSetHttpRetrySettings and related APIs.","href":"/services/playfab/sdks/c/http-config"},{"title":"Handling PlayFab Errors","description":"Handle synchronous, asynchronous, token, throttling, and network errors returned by the PlayFab Services C/C++ SDK, with common HRESULT codes.","sidebarTitle":"Handling Errors","href":"/services/playfab/sdks/c/errors"},{"title":"Handling Token Expiration","description":"Handle PlayFab entity token expiration, background token refresh, and manual relogin in the C SDK, including GDK suspend and resume flows.","href":"/services/playfab/sdks/c/relogin"},{"title":"Debug Tracing","description":"Enable PlayFab Services SDK debug tracing: set verbosity, route output to the Visual Studio debugger, forward to game logs, or write traces to file.","href":"/services/playfab/sdks/c/tracing"},{"group":"Event Pipeline","pages":[{"title":"PlayFab Services SDK - Event Pipeline","description":"Send batched telemetry and PlayStream events with the PlayFab Services SDK event pipeline: auth types, configuration, GZIP compression, and handlers.","sidebarTitle":"Event Pipeline","href":"/services/playfab/sdks/c/event-pipeline/eventpipeline"},{"title":"Event Pipeline Tutorial","description":"Step-by-step tutorial for creating a PlayFab Services SDK event pipeline: initialize, telemetry key auth, emit events, attach an entity, and close.","href":"/services/playfab/sdks/c/event-pipeline/eventpipeline-tutorial"}]},{"title":"Game servers from title entity","description":"Authenticate as a title entity in the PlayFab Services SDK using PFAuthenticationGetEntityWithSecretKeyAsync to call server-only APIs on Win32.","sidebarTitle":"Initializing Servers","href":"/services/playfab/sdks/c/server"}]},{"group":"Legacy C++","pages":[{"title":"Legacy C++ PlayFab SDK","description":"Overview of the legacy cross-platform PlayFab C++ SDK for Android, iOS, Linux, and Win32 x64, with GitHub repo, NuGet package, and quickstart links.","sidebarTitle":"Legacy C++","href":"/services/playfab/sdks/playfab-cpp/index"},{"title":"Quickstart C/C++ for GDK","description":"Add the PlayFab Services SDK bundled with the Microsoft GDK to your native C++ project and make your first PlayFab API call on XBOX or Windows.","sidebarTitle":"Quickstart - GDK","href":"/services/playfab/sdks/playfab-cpp/quickstart-gdk"},{"title":"Quickstart C++ for Linux","description":"Set up a native C++ project on Ubuntu 18.04 LTS and make your first PlayFab API call using the cross-platform PlayFab XPlatCppSdk library.","sidebarTitle":"Quickstart - Linux","href":"/services/playfab/sdks/playfab-cpp/quickstart-linux"},{"title":"Quickstart C++ for Windows","description":"Set up a native C++ project in Visual Studio on Windows and make your first PlayFab API call using the PlayFab XPlatCppSdk client library.","sidebarTitle":"Quickstart - Windows","href":"/services/playfab/sdks/playfab-cpp/quickstart-windows"}]},{"group":"C#","pages":[{"title":"C# PlayFab SDK","description":"Overview of the PlayFab C# SDK for .NET games, tools, and cloud services, with download links, NuGet package, and quickstart guidance.","sidebarTitle":"C#","href":"/services/playfab/sdks/c-sharp/index"},{"title":"Quickstart - PlayFab Client library for C#","description":"Install the PlayFabAllSDK NuGet package and make your first PlayFab client API call in a C# .NET Core console app using Visual Studio.","sidebarTitle":"Quickstart","href":"/services/playfab/sdks/c-sharp/quickstart"}]},{"group":"Java","pages":[{"title":"Java SDK","description":"Overview of the PlayFab Java SDK for Java runtime, Android tools, and service integrations, with GitHub repo, download links, and license details.","sidebarTitle":"Java","href":"/services/playfab/sdks/java/index"},{"title":"Java quickstart for Native and Android Studio","description":"Download the PlayFab Java client SDK JAR files, set up the classpath, and make your first LoginWithCustomID API call in native Java or Android.","sidebarTitle":"Quickstart","href":"/services/playfab/sdks/java/quickstart"},{"title":"Java SDK licenses","description":"License information and third-party license links for libraries bundled with the PlayFab Java SDK, including Google Gson, Hamcrest, and JUnit.","sidebarTitle":"License","href":"/services/playfab/sdks/java/license"},{"title":"google-gson license","description":"google-gson license.","sidebarTitle":"License","href":"/services/playfab/sdks/java/Licenses/google-gson-license"},{"title":"hamcrest license","description":"hamcrest license.","sidebarTitle":"License","href":"/services/playfab/sdks/java/Licenses/hamcrest-license"},{"title":"junit license","description":"junit license.","sidebarTitle":"License","href":"/services/playfab/sdks/java/Licenses/junit-license"}]},{"group":"JavaScript","pages":[{"title":"JavaScript SDK","description":"Overview of the PlayFab JavaScript SDK for web development and browser games, available via GitHub, CDN, or the playfab-web-sdk NPM package.","sidebarTitle":"JavaScript","href":"/services/playfab/sdks/javascript/index"},{"title":"JavaScript quickstart for Native and Phaser","description":"Install the PlayFab JavaScript client library and make your first PlayFab API call in a browser or Phaser game to authenticate a player.","sidebarTitle":"Quickstart","href":"/services/playfab/sdks/javascript/quickstart"},{"title":"JavaScript SDK licenses","description":"License information and third-party license links for libraries included in the PlayFab JavaScript SDK, covering jQuery and QUnit dependencies.","sidebarTitle":"License","href":"/services/playfab/sdks/javascript/license"},{"title":"jQuery license","description":"jQuery license.","sidebarTitle":"License","href":"/services/playfab/sdks/javascript/Licenses/jquery-license"},{"title":"QUnit license","description":"QUnit license.","sidebarTitle":"License","href":"/services/playfab/sdks/javascript/Licenses/qunit-license"}]},{"group":"Lua","pages":[{"title":"Lua SDK","description":"Overview of the PlayFab Lua SDK with support for the Defold and Corona (Solar2D) game engines, plus GitHub repo and download links.","sidebarTitle":"Lua","href":"/services/playfab/sdks/lua/index"},{"title":"Lua quickstart for Corona","description":"Set up a Corona project on Windows or Mac and make your first PlayFab API call in Lua using the PlayFab Corona SDK client library.","sidebarTitle":"Quickstart - Corona","href":"/services/playfab/sdks/lua/quickstart-corona"},{"title":"Lua quickstart for Defold","description":"Set up a Defold project and make your first PlayFab API call in Lua using the PlayFab Defold client SDK for cross-platform game development.","sidebarTitle":"Quickstart - Defold","href":"/services/playfab/sdks/lua/quickstart-defold"},{"title":"Lua SDK licenses","description":"License information and third-party license links for libraries used by the PlayFab Lua SDK, including JSON for Lua and LuaSec dependencies.","sidebarTitle":"License","href":"/services/playfab/sdks/lua/license"},{"title":"Json Lua license","description":"Json Lua license.","sidebarTitle":"License","href":"/services/playfab/sdks/lua/Licenses/json-lua-license"},{"title":"LuaSec license","description":"LuaSec license.","sidebarTitle":"License","href":"/services/playfab/sdks/lua/Licenses/luasec-license"}]},{"group":"Node.js","pages":[{"title":"NodeJS SDK","description":"Overview of the PlayFab Node.js SDK for server-side scripting and cloud services, available via GitHub or the playfab-sdk NPM package.","sidebarTitle":"Node.js","href":"/services/playfab/sdks/nodejs/index"},{"title":"NodeJS quickstart","description":"Install the PlayFab Node.js client library from npm and make your first PlayFab API call from a Node.js script to authenticate a player.","sidebarTitle":"Quickstart","href":"/services/playfab/sdks/nodejs/quickstart"},{"title":"Node.js Nodeunit license","description":"MIT-style license text for the Nodeunit unit-test library used by the PlayFab Node.js SDK, including the copyright notice and permission terms.","sidebarTitle":"License","href":"/services/playfab/sdks/nodejs/nodeunit-license"}]},{"group":"Python","pages":[{"title":"Python SDK","description":"Overview of the community-supported PlayFab Python 3 SDK for automation and server-side scripting, with GitHub repo and PyPI package links.","sidebarTitle":"Python","href":"/services/playfab/sdks/python/index"},{"title":"Python quickstart","description":"Install the PlayFab Python 3 SDK and make your first PlayFab API call from a native Python script for admin tools or game engine integration.","sidebarTitle":"Quickstart","href":"/services/playfab/sdks/python/quickstart"}]}]},{"group":"Platforms","pages":[{"title":"PlayFab supported platforms","description":"Find PlayFab Services SDKs and quickstarts by platform: GDK, PlayStation, Nintendo Switch, Windows, Android, iOS, macOS, Linux, and cloud services.","sidebarTitle":"Platforms","href":"/services/playfab/sdks/platforms/index"},{"title":"PlayFab Services for Android","description":"Compare PlayFab Services SDK options for Android game development: C/C++, Unreal, Unity, Java, and Legacy C++ with quickstart links.","sidebarTitle":"Android","href":"/services/playfab/sdks/platforms/android"},{"title":"PlayFab Services for iOS","description":"Compare PlayFab Services SDK options for iOS game development: C/C++ with quickstart, Unreal Engine plugin, and Unity3D SDK integrations.","sidebarTitle":"iOS","href":"/services/playfab/sdks/platforms/ios"},{"title":"PlayFab Services for macOS","description":"Compare PlayFab Services SDK options for macOS game development: C/C++ with quickstart, Unreal Engine marketplace plugin, and Unity3D SDK.","sidebarTitle":"macOS","href":"/services/playfab/sdks/platforms/macos"},{"title":"PlayFab Services for Linux","description":"Compare PlayFab Services SDK options for Linux game development: C/C++, Unreal, Unity, and Legacy C++ with quickstart links and guidance.","sidebarTitle":"Linux","href":"/services/playfab/sdks/platforms/linux"},{"title":"PlayFab Services for GDK","description":"Compare PlayFab Services SDK options for the Microsoft GDK on XBOX and Windows: C/C++, Unreal, Unity, and Legacy C++ with quickstart links.","sidebarTitle":"Microsoft GDK","href":"/services/playfab/sdks/platforms/gdk"},{"title":"PlayFab Services for Nintendo Switch","description":"PlayFab Services SDK options for Nintendo Switch: C/C++, Unreal, Unity, and Legacy C++, with details on required Nintendo middleware approval.","sidebarTitle":"Nintendo Switch","href":"/services/playfab/sdks/platforms/switch"},{"title":"PlayFab Services for PlayStation","description":"PlayFab Services SDK options for PlayStation 4 and PlayStation 5, including C/C++, Unreal, Unity, and Legacy C++, plus DevNet access requirements.","sidebarTitle":"PS5 | PS4","href":"/services/playfab/sdks/platforms/playstation"},{"title":"PlayFab Services for Windows","description":"Compare PlayFab Services SDK options for Windows game development: C/C++ Win32, Unreal, Unity, and Legacy C++ with quickstart links.","sidebarTitle":"Windows","href":"/services/playfab/sdks/platforms/windows"},{"title":"PlayFab Services for Backend Services and Tools","description":"PlayFab Services SDKs for backend services, Azure Functions, and tools development, including C#, Java, JavaScript, Node.js, and Python options.","sidebarTitle":"Services and Tools","href":"/services/playfab/sdks/platforms/services"}]},{"group":"Game engines","pages":[{"title":"PlayFab supported game engines","description":"Find PlayFab SDKs and quickstarts for popular game engines including Unity3D, Unreal Engine, and Cocos2d-x for integrating PlayFab services.","sidebarTitle":"Game engines","href":"/services/playfab/sdks/game-engines/index"},{"group":"Cocos2d-x","pages":[{"title":"Cocos2D-x (C++) SDK","description":"Overview of the community-supported PlayFab Cocos2d-x C++ SDK, with GitHub download links, supported Cocos platforms, and license information.","sidebarTitle":"Cocos2d-x","href":"/services/playfab/sdks/cocos2d-x/index"},{"title":"Cocos2D-x Quickstart","description":"Set up a Cocos2d-x project in Visual Studio on Windows and make your first PlayFab API call using the PlayFab Cocos2d-x client library.","sidebarTitle":"Quickstart","href":"/services/playfab/sdks/cocos2d-x/quickstart"},{"title":"Cocos2d-x SDK licenses","description":"License information and third-party license links for libraries included in the PlayFab Cocos2d-x SDK, including libcurl, OpenSSL, and zlib.","sidebarTitle":"License","href":"/services/playfab/sdks/cocos2d-x/license"},{"title":"libcurl license","description":"libcurl license.","sidebarTitle":"License","href":"/services/playfab/sdks/cocos2d-x/Licenses/libcurl-License"},{"title":"OpenSSL license","description":"OpenSSL license.","sidebarTitle":"License","href":"/services/playfab/sdks/cocos2d-x/Licenses/openssl-license"},{"title":"RapidJSON license","description":"RapidJSON license.","sidebarTitle":"License","href":"/services/playfab/sdks/cocos2d-x/Licenses/rapidjson-license"},{"title":"zlib license","description":"zlib license.","sidebarTitle":"License","href":"/services/playfab/sdks/cocos2d-x/Licenses/zlib-license"}]},{"group":"Unity3D","pages":[{"title":"Unity3D (C#) SDK","description":"Overview of the PlayFab Unity3D (C#) SDK with Editor Extensions, download links, and guidance on adding multiplayer via the PlayFab Party Unity plugin.","sidebarTitle":"Unity3D","href":"/services/playfab/sdks/unity3d/index"},{"title":"Unity quickstart","description":"Install the PlayFab Unity SDK and make your first PlayFab client API call in C# from a Unity project using the Editor and Client library.","sidebarTitle":"Quickstart","href":"/services/playfab/sdks/unity3d/quickstart"},{"title":"Install the PlayFab SDK without Editor Extensions in Unity","description":"Install the PlayFab Unity 3D SDK in your Unity project without the Editor Extensions asset package, and configure Title ID from your code.","sidebarTitle":"Installing the PlayFab SDK for Unity","href":"/services/playfab/sdks/unity3d/installing-unity3d-sdk"},{"title":"Unity3D SDK licenses","description":"License information and third-party license links for libraries bundled with the PlayFab Unity3D SDK, including Newtonsoft.Json and SignalR.","sidebarTitle":"License","href":"/services/playfab/sdks/unity3d/license"},{"title":"Ionic Zlib license","description":"Ionic Zlib license.","sidebarTitle":"License","href":"/services/playfab/sdks/unity3d/Licenses/ionic-zlib-license"},{"title":"Newtonsoft Json license","description":"Newtonsoft Json license.","sidebarTitle":"License","href":"/services/playfab/sdks/unity3d/Licenses/newtonsoft-json-license"},{"title":"SignalR license","description":"SignalR license.","sidebarTitle":"License","href":"/services/playfab/sdks/unity3d/Licenses/signalr-license"},{"title":"SimpleJson license","description":"SimpleJson license.","sidebarTitle":"License","href":"/services/playfab/sdks/unity3d/Licenses/simplejson-license"},{"title":"UUnit license","description":"UUnit license.","sidebarTitle":"License","href":"/services/playfab/sdks/unity3d/Licenses/uunit-license"}]},{"group":"Unreal Engine","pages":[{"title":"Unreal Engine (C++, Blueprints) SDK","description":"Landing page for the PlayFab Unreal SDK and Unreal Marketplace Plugin, with download links, C++ and Blueprint interfaces, and API references.","sidebarTitle":"Unreal Engine","href":"/services/playfab/sdks/unreal/index"},{"title":"Unreal Engine quickstart","description":"Install the PlayFab Unreal Marketplace Plugin and make your first PlayFab API call from an Unreal Engine project using C++ or Blueprints.","sidebarTitle":"Quickstart","href":"/services/playfab/sdks/unreal/quickstart"}]}]}]},{"group":"Lobby and Matchmaking SDKs (v1)","pages":[{"title":"PlayFab Lobby and Matchmaking SDKs","description":"Available PlayFab Lobby and Matchmaking SDKs including the C++ SDK, Unity plugin, and Unreal integration, with supported platforms and download details.","sidebarTitle":"Overview","href":"/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/lobby-matchmaking-sdks"},{"title":"PlayFab Multiplayer C++ SDK Release Notes","description":"Version history, new features, fixes, and breaking changes for the PlayFab Lobby and Matchmaking C++ SDK across supported platforms and releases.","sidebarTitle":"Lobby and Matchmaking SDK Release Notes","href":"/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/lobby-and-matchmaking-release-notes"},{"title":"Multiplayer Android getting started","description":"Android build setup, NDK, JNI initialization, and manifest permissions required to integrate the PlayFab Lobby and Matchmaking C++ SDK on Android.","sidebarTitle":"Android Getting Started","href":"/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/android-specific-requirements"},{"group":"Unreal Engine 4 and 5","pages":[{"title":"PlayFab Online Subsystem (OSS)","description":"Overview of the PlayFab Party Online Subsystem (OSS) for Unreal Engine, providing voice chat and networking integration with Unreal multiplayer sessions.","sidebarTitle":"Unreal Engine PlayFab OnlineSubsystem (OSS)","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-overview"},{"title":"PlayFab Online Subsystem (OSS) Quickstart","description":"Quickstart for the PlayFab Online Subsystem in Unreal Engine, covering setup for Party voice chat, lobbies, and matchmaking with the Multiplayer SDK.","sidebarTitle":"PlayFab OnlineSubsystem Quickstart","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-quickstart"},{"title":"Obtaining PlayFab Party and Multiplayer libraries","description":"How to download and integrate the PlayFab Party and Multiplayer native libraries required by the PlayFab Online Subsystem plugin for Unreal Engine.","sidebarTitle":"Get Party and Multiplayer Libraries","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-obtaining-playfab-party-libraries"},{"title":"Party unreal engine oss cognitive services interface","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-cognitive-services-interface"},{"title":"Integrate the PlayFab Unreal Engine Marketplace plugin","description":"Guidance on how to integrate the PlayFab SDK UE Marketplace Plugin into your existing PlayFab Online Subsystem integrated project.","sidebarTitle":"PlayFab SDK UE Marketplace Plugin Integration Guide","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-playfab-plugin-integration"},{"title":"PlayFab Online Subsystem (OSS) Dedicated Server Setup","description":"Steps to set up dedicated servers with the PlayFab Online Subsystem (OSS) in Unreal Engine, including Party integration and server-side configuration.","sidebarTitle":"Dedicated Server Setup Guide","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-dedicated-servers"},{"title":"Using older versions of Unreal Engine 4","description":"Integrate the PlayFab Party Online Subsystem with older Unreal Engine 4 versions, including source patches and compatibility notes for legacy UE4 projects.","sidebarTitle":"Using Older Versions of Unreal Engine 4","href":"/services/playfab/multiplayer/networking/party-unreal-engine-using-older-versions"},{"title":"PlayFab OnlineSubsystem for Unreal Engine release notes","description":"Version history and release notes for the PlayFab OnlineSubsystem plugin for Unreal Engine 4 and 5, covering Party, multiplayer, and lobby updates.","sidebarTitle":"PlayFab OnlineSubsystem Release notes","href":"/services/playfab/multiplayer/networking/unreal-release-notes"}]},{"group":"Unity","pages":[{"title":"PlayFab Multiplayer getting started for Unity","description":"Get started with the PlayFab Multiplayer Unity plugin: install the package, authenticate, and make your first Lobby and Matchmaking calls from a Unity project.","sidebarTitle":"Multiplayer Unity getting started","href":"/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/multiplayer-unity-sdk-getting-started"},{"title":"PlayFab Multiplayer Unity plugin overview","description":"Overview of the PlayFab Multiplayer Unity plugin that wraps the Lobby and Matchmaking C++ SDK, including supported Unity versions and integration notes.","sidebarTitle":"Multiplayer Unity plugin overview","href":"/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/multiplayer-unity-overview"},{"title":"Multiplayer Unity plugin quickstart","description":"Install the PlayFab Multiplayer Unity plugin and make your first Lobby and Matchmaking API calls from a Unity project, including GDK setup considerations.","href":"/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/multiplayer-unity-plugin-quickstart"}]},{"title":"Diagnostic tracing in PlayFab Lobby and Matchmaking SDKs","description":"Capture diagnostic traces and logs from the PlayFab Lobby and Matchmaking SDKs across Android, Linux, Windows, and console platforms for troubleshooting.","sidebarTitle":"Logging","href":"/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/lobby-matchmaking-logging"}]},{"group":"Party SDKs (v1)","pages":[{"title":"PlayFab Party SDKs","description":"Available PlayFab Party SDKs including the native C++ SDK, Unity plugin, and Unreal OSS, with supported platforms and links to downloads and documentation.","href":"/services/playfab/multiplayer/networking/party-sdks/overview"},{"title":"PlayFab Party release notes","description":"Version history, new features, fixes, and breaking changes across releases of the PlayFab Party SDK for voice chat and low-latency data networking.","sidebarTitle":"Release notes","href":"/services/playfab/multiplayer/networking/release-notes"},{"title":"Android getting started","description":"Android-specific setup for the PlayFab Party SDK, including NDK requirements, JNI initialization, and audio and microphone permissions in the manifest.","sidebarTitle":"Android quickstart","href":"/services/playfab/multiplayer/networking/android-specific-requirements"},{"title":"iOS and macOS getting started","description":"iOS and macOS integration requirements for PlayFab Party, including Xcode framework linking, microphone entitlements, and background audio configuration.","sidebarTitle":"iOS and macOS quickstart","href":"/services/playfab/multiplayer/networking/apple-specific-requirements"},{"group":"Unity","pages":[{"title":"Party Unity plugin overview","description":"Overview of the PlayFab Party Unity plugin that adds real-time voice chat and low-latency data messaging to Unity games across supported platforms.","sidebarTitle":"Party Unity Plugin Overview","href":"/services/playfab/multiplayer/networking/party-unity-overview"},{"title":"Party Unity plugin quickstart","description":"Quickstart for adding the PlayFab Party plugin to a Unity project: install the package, authenticate players, and enable voice chat between endpoints.","sidebarTitle":"Party Unity Plugin quickstart","href":"/services/playfab/multiplayer/networking/party-unity-plugin-quickstart"},{"title":"PlayFab Party Unity SDK","description":"API reference index for the PlayFab Party Unity plugin, listing classes and enums for adding voice chat and multiplayer networking to Unity games.","sidebarTitle":"Party Unity Plugin API Reference","href":"/services/playfab/multiplayer/networking/unity-party-api-reference/index"},{"title":"PlayFab Party Unity plugin Release Notes","description":"Version history, new features, bug fixes, and breaking changes for the PlayFab Party Unity plugin across supported Unity versions and target platforms.","sidebarTitle":"Party Unity Plugin Release Notes","href":"/services/playfab/multiplayer/networking/party-unity-release-notes"}]},{"group":"Unreal Engine 4 and 5","pages":[{"title":"PlayFab Online Subsystem (OSS)","description":"Overview of the PlayFab Party Online Subsystem (OSS) for Unreal Engine, providing voice chat and networking integration with Unreal multiplayer sessions.","sidebarTitle":"Unreal Engine PlayFab OnlineSubsystem (OSS)","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-overview"},{"title":"PlayFab Online Subsystem (OSS) Quickstart","description":"Quickstart for the PlayFab Online Subsystem in Unreal Engine, covering setup for Party voice chat, lobbies, and matchmaking with the Multiplayer SDK.","sidebarTitle":"PlayFab OnlineSubsystem Quickstart","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-quickstart"},{"title":"Obtaining PlayFab Party and Multiplayer libraries","description":"How to download and integrate the PlayFab Party and Multiplayer native libraries required by the PlayFab Online Subsystem plugin for Unreal Engine.","sidebarTitle":"Get Party and Multiplayer Libraries","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-obtaining-playfab-party-libraries"},{"title":"Party unreal engine oss cognitive services interface","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-cognitive-services-interface"},{"title":"Integrate the PlayFab Unreal Engine Marketplace plugin","description":"Guidance on how to integrate the PlayFab SDK UE Marketplace Plugin into your existing PlayFab Online Subsystem integrated project.","sidebarTitle":"PlayFab SDK UE Marketplace Plugin Integration Guide","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-playfab-plugin-integration"},{"title":"PlayFab Online Subsystem (OSS) Dedicated Server Setup","description":"Steps to set up dedicated servers with the PlayFab Online Subsystem (OSS) in Unreal Engine, including Party integration and server-side configuration.","sidebarTitle":"Dedicated Server Setup Guide","href":"/services/playfab/multiplayer/networking/party-unreal-engine-oss-dedicated-servers"},{"title":"Using older versions of Unreal Engine 4","description":"Integrate the PlayFab Party Online Subsystem with older Unreal Engine 4 versions, including source patches and compatibility notes for legacy UE4 projects.","sidebarTitle":"Using Older Versions of Unreal Engine 4","href":"/services/playfab/multiplayer/networking/party-unreal-engine-using-older-versions"},{"title":"PlayFab OnlineSubsystem for Unreal Engine release notes","description":"Version history and release notes for the PlayFab OnlineSubsystem plugin for Unreal Engine 4 and 5, covering Party, multiplayer, and lobby updates.","sidebarTitle":"PlayFab OnlineSubsystem Release notes","href":"/services/playfab/multiplayer/networking/unreal-release-notes"}]},{"group":"XBOX and XBOX Network","pages":[{"title":"XBOX Requirements","description":"Best practices for using PlayFab Party on XBOX consoles to satisfy XBOX Requirements (XRs) for chat, privacy, cross-network play, and multiplayer sessions.","href":"/services/playfab/multiplayer/networking/xbox-requirements"},{"title":"Using PlayFab Party with MPSD","description":"Combine PlayFab Party voice and data networking with the XBOX Multiplayer Session Directory (MPSD) for cross-network session management and invites.","sidebarTitle":"Use Party with MPSD","href":"/services/playfab/multiplayer/networking/using-mpsd"},{"group":"XBOX Network Helper Library","pages":[{"title":"XBOX Live helper library for PlayFab Party","description":"Use the PartyXboxLive helper library to bridge XBOX Live identities, chat permissions, and privacy settings with PlayFab Party voice and networking.","sidebarTitle":"Overview","href":"/services/playfab/multiplayer/networking/party-xbox-live-guide"},{"title":"PlayFab Party XBOX Live Helper Release Notes","description":"Version history, new features, and fixes for the PartyXboxLive helper library that integrates XBOX Live chat permissions with the PlayFab Party SDK.","sidebarTitle":"Release Notes","href":"/services/playfab/multiplayer/networking/party-xboxlive-relnotes"},{"title":"PartyXboxLive C/C++ API overview","description":"Reference overview of the PartyXboxLive C/C++ API: classes, methods, enums, and structs used to integrate XBOX Live chat permissions with PlayFab Party.","sidebarTitle":"API Reference","href":"/services/playfab/multiplayer/networking/xblreference/partyxboxlive_members"}]}]},{"title":"Diagnostic tracing/logging in PlayFab Party SDKs","description":"Enable tracing and logging in the PlayFab Party SDK to diagnose connectivity, voice chat, and networking issues across supported platforms and build types.","sidebarTitle":"Logging","href":"/services/playfab/multiplayer/networking/party-logging"}]}]},{"group":"Multiplayer Server SDKs","pages":[{"title":"PlayFab Multiplayer Game Server SDKs","description":"Overview of PlayFab Game Server SDKs (GSDK) for Multiplayer Servers, including Unity, C++ for Windows and Linux, C#, Java, and Unreal Engine integrations.","href":"/services/playfab/multiplayer/servers/server-sdks/overview"}]},{"group":"Tools and utilities","pages":[{"title":"PlayFab tools and extensions","description":"PlayFab SDK tools and extensions: SDK Generator plus editor and CLI utilities that help you generate, extend, and integrate PlayFab client and server SDKs.","sidebarTitle":"Tools and utilities","href":"/services/playfab/sdks/tools/index"},{"group":"SDK Generator","pages":[{"title":"SDK Generator","description":"Overview of the open-source PlayFab SDK Generator used to build and maintain PlayFab SDKs across languages, with GitHub source and usage guide.","href":"/services/playfab/sdks/sdkgenerator/index"},{"title":"Quickstart","href":"/services/playfab/sdks/sdkgenerator/quickstart"}]},{"group":"Postman","pages":[{"title":"Postman (REST) SDK","description":"Overview of the PlayFab Postman REST collection for exploring and testing the PlayFab API with variable-based URLs and multi-environment setup.","sidebarTitle":"Postman","href":"/services/playfab/sdks/postman/index"},{"title":"Quickstart PlayFab REST API collection for Postman","description":"Import the PlayFab REST API collection into Postman, get an entity token, and make your first PlayFab API call to manage titles and entities.","sidebarTitle":"Quickstart","href":"/services/playfab/sdks/postman/postman-quickstart"}]}]}]}]}]},{"tab":"Tools","groups":[{"group":"Tools","pages":[{"title":"Tools","description":"XBOX GDK developer tools index: emulators, command-line utilities, Visual Studio integration, PIX, and remote-console tooling for console and PC titles.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/tools"},{"title":"Additional standalone tools","description":"Overview of standalone XBOX and PC game development tools not bundled with the GDK, including Package Uploader and other utilities and how to obtain them.","sidebarTitle":"Additional standalone tools","icon":"file-lines","href":"/tools/additional-tools"},{"title":"Tools and middleware providers","description":"How licensed XBOX developers request access to GDK middleware and tools providers through the Microsoft Games automated support request form.","sidebarTitle":"Tools and middleware providers","icon":"note-sticky","href":"/tools/tools-and-middleware-providers"},{"group":"Tools console","pages":[{"title":"XBOX console developer tools (GDK)","description":"PIX, DevHome, XBOX Manager, DevKit Agent, xbWatson, shader compiler, and other GDK developer tools that run on or target the XBOX console.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/tools/tools-console/index"},{"title":"XBOX console game development environment and tools","description":"Overview of the XBOX console development environment and GDK tools for building XBOX One and XBOX Series X|S titles, including XBOX Manager and GDK Tools.","sidebarTitle":"XBOX console game development:","icon":"map","href":"/tools/tools-console/gc-tools-console-toc"},{"title":"XBOX environment tools and APIs","description":"Index of tools and APIs for the XBOX development environment, including GDK Tools, XBOX Manager, and XBOX Device Portal for dev kit setup and control.","sidebarTitle":"XBOX environment tools and APIs","icon":"clipboard-list","href":"/tools/tools-console/gc-xbox-tools-and-apis-toc"},{"title":"XBOX One and XBOX Series X|S GDK Tools","description":"Overview of the XBOX One and XBOX Series X|S GDK Tools, a separate download that supports both console families and updates independently of the GDK.","sidebarTitle":"Microsoft game development kit tools","icon":"toolbox","href":"/tools/tools-console/tools-sdk"},{"title":"XBOX console video server","description":"How to use the XBOX console video server to share H264 or HEVC video and stereo AAC audio over an RTSP stream to third-party capture and analysis tools.","sidebarTitle":"XBOX video server","icon":"video","href":"/tools/tools-console/xbox-video-server"},{"group":"Commandlinetools","pages":[{"title":"Commandlinetools","description":"Documentation for command-line in the XBOX Game Development Kit (developer tools) on console. Covers concepts, tools, configuration, and workflows.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/tools/tools-console/commandlinetools/index"},{"title":"Command-line tools for console development","description":"Command-line tools for console development","sidebarTitle":"Command-line tools for console","icon":"terminal","href":"/tools/tools-console/commandlinetools/commandlinetools"},{"title":"Command prompts","description":"Command prompts","sidebarTitle":"Command prompts","icon":"terminal","href":"/tools/tools-console/commandlinetools/commandprompt"},{"title":"Xbapp","href":"/tools/tools-console/commandlinetools/xbapp"},{"title":"Screen-capture tool (xbcapture.exe)","description":"Screen-capture tool (xbcapture.exe)","sidebarTitle":"Screen-capture tool (xbcapture.exe)","icon":"display","href":"/tools/tools-console/commandlinetools/xbcapture"},{"title":"Clean (xbcleanup.exe)","description":"Clean (xbcleanup.exe)","sidebarTitle":"Clean (xbcleanup.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbcleanup"},{"title":"Xbconfig","href":"/tools/tools-console/commandlinetools/xbconfig"},{"title":"Connect (xbconnect.exe)","description":"Connect (xbconnect.exe)","sidebarTitle":"Connect (xbconnect.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbconnect"},{"title":"xbCopy (xbcopy.exe)","description":"xbCopy (xbcopy.exe)","sidebarTitle":"Xbcopy (xbcopy.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbcopy"},{"title":"File copy (xbcp.exe)","description":"File copy (xbcp.exe)","sidebarTitle":"File copy (xbcp.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbcp"},{"title":"Credentials (xbcred.exe)","description":"Credentials (xbcred.exe)","sidebarTitle":"Credentials (xbcred.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbcred"},{"title":"Debug string monitoring (xbdbgmon.exe)","description":"Debug string monitoring (xbdbgmon.exe)","sidebarTitle":"Debug string monitoring (xbdbgmon.exe)","icon":"bug","href":"/tools/tools-console/commandlinetools/xbdbgmon"},{"title":"File delete (xbdel.exe)","description":"File delete (xbdel.exe)","sidebarTitle":"File delete (xbdel.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbdel"},{"title":"Diagnostics information (xbdiaginfo.exe)","description":"Diagnostics information (xbdiaginfo.exe)","sidebarTitle":"Diagnostics information (xbdiaginfo.exe)","icon":"triangle-exclamation","href":"/tools/tools-console/commandlinetools/xbdiaginfo"},{"title":"Directory (xbdir.exe)","description":"Directory (xbdir.exe)","sidebarTitle":"Directory (xbdir.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbdir"},{"title":"Error Lookup (xberror.exe)","description":"Error Lookup (xberror.exe)","sidebarTitle":"Error lookup (xberror.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xberror"},{"title":"Manage game streaming (xbgamestream.exe)","description":"Manage game streaming (xbgamestream.exe)","sidebarTitle":"Manage game streaming (xbgamestream.exe)","icon":"video","href":"/tools/tools-console/commandlinetools/xbgamestream"},{"title":"Make directory (xbmkdir.exe)","description":"Make directory (xbmkdir.exe)","sidebarTitle":"Make directory (xbmkdir.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbmkdir"},{"title":"Xbperf","href":"/tools/tools-console/commandlinetools/xbperf"},{"title":"Provision (xbprovision.exe)","description":"Provision (xbprovision.exe)","sidebarTitle":"Provision (xbprovision.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbprovision"},{"title":"Reboot (xbreboot.exe)","description":"Reboot (xbreboot.exe)","sidebarTitle":"Reboot (xbreboot.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbreboot"},{"title":"Remote recovery (xbremoterecovery.exe)","description":"Remote recovery (xbremoterecovery.exe)","sidebarTitle":"Remote recovery (xbremoterecovery.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbremoterecovery"},{"title":"Delete directory (xbrmdir.exe)","description":"Delete directory (xbrmdir.exe)","sidebarTitle":"Delete directory (xbrmdir.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbrmdir"},{"title":"Xbrun","href":"/tools/tools-console/commandlinetools/xbrun"},{"title":"Manage XGameSave storage on console (xbstorage.exe)","description":"Manage XGameSave storage on console (xbstorage.exe)","sidebarTitle":"Manage xgamesave storage on console","icon":"hard-drive","href":"/tools/tools-console/commandlinetools/xbstorage"},{"title":"Xbstress","href":"/tools/tools-console/commandlinetools/xbstress"},{"title":"Process list (xbtlist.exe)","description":"Process list (xbtlist.exe)","sidebarTitle":"Process list (xbtlist.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbtlist"},{"title":"Transfer Protocol Service (XbtpLinkSvc.exe)","description":"Transfer Protocol Service (XbtpLinkSvc.exe)","sidebarTitle":"Transfer protocol service","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbtplinksvc"},{"title":"Trace (xbtrace.exe)","description":"Trace (xbtrace.exe)","sidebarTitle":"Trace (xbtrace.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbtrace"},{"title":"Xbttd","href":"/tools/tools-console/commandlinetools/xbttd"},{"title":"Update hosts (XbUpdateHosts.exe)","description":"Update hosts (XbUpdateHosts.exe)","sidebarTitle":"Update hosts (xbupdatehosts.exe)","icon":"terminal","href":"/tools/tools-console/commandlinetools/xbupdatehosts"},{"title":"User management (xbuser.exe)","description":"User management (xbuser.exe)","sidebarTitle":"User management (xbuser.exe)","icon":"user","href":"/tools/tools-console/commandlinetools/xbuser"},{"title":"Version information (xbVersionInfo.exe)","description":"Version information (xbVersionInfo.exe)","sidebarTitle":"Version information (xbversioninfo.exe)","icon":"clock-rotate-left","href":"/tools/tools-console/commandlinetools/xbversioninfo"},{"title":"Xtf transport errors","href":"/tools/tools-console/commandlinetools/xtf-transport-errors"}]},{"group":"Console commandlinetools","pages":[{"title":"Console-based command-line tools for XBOX","description":"Command-line tools that run in the XBOX System OS and Game OS, including calling conventions and diagnostic utilities available on the console itself.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/tools/tools-console/console_commandlinetools/index"},{"title":"Console-based command-line tools","description":"Console-based command-line tools","sidebarTitle":"Console-based command-line tools","icon":"terminal","href":"/tools/tools-console/console_commandlinetools/consolecommandlinetools"},{"title":"Calling wd tools from your title","description":"Calling wd tools from your title","sidebarTitle":"Calling wd tools from your title","icon":"video","href":"/tools/tools-console/console_commandlinetools/titlecodecallingwdtools"},{"title":"Wdapp","href":"/tools/tools-console/console_commandlinetools/wdapp"},{"title":"Screen-capture tool (wdcapture.exe)","description":"Screen-capture tool (wdcapture.exe)","sidebarTitle":"Screen-capture tool (wdcapture.exe)","icon":"display","href":"/tools/tools-console/console_commandlinetools/wdcapture"},{"title":"Long duration game captures (wdcapturesession.exe)","description":"Long duration game captures (wdcapturesession.exe)","sidebarTitle":"Long duration game captures","icon":"people-group","href":"/tools/tools-console/console_commandlinetools/wdcapturesession"},{"title":"Wdconfig","href":"/tools/tools-console/console_commandlinetools/wdconfig"},{"title":"Credentials (wdCred.exe)","description":"Credentials (wdCred.exe)","sidebarTitle":"Credentials (wdcred.exe)","icon":"terminal","href":"/tools/tools-console/console_commandlinetools/wdcred"},{"title":"Manage game streaming (wdgamestream.exe)","description":"Manage game streaming (wdgamestream.exe)","sidebarTitle":"Manage game streaming (wdgamestream.exe)","icon":"video","href":"/tools/tools-console/console_commandlinetools/wdgamestream"},{"title":"View and manipulate the console's front panel (wdpanel.exe)","description":"View and manipulate the console's front panel (wdpanel.exe)","sidebarTitle":"View and manipulate the console's front","icon":"terminal","href":"/tools/tools-console/console_commandlinetools/wdpanel"},{"title":"Recovery (wdRecovery.exe)","description":"Recovery (wdRecovery.exe)","sidebarTitle":"Recovery (wdrecovery.exe)","icon":"terminal","href":"/tools/tools-console/console_commandlinetools/wdrecovery"},{"title":"Run (wdRun.exe)","description":"Run (wdRun.exe)","sidebarTitle":"Run (wdrun.exe)","icon":"terminal","href":"/tools/tools-console/console_commandlinetools/wdrun"},{"title":"Event tracing (wdtrace.exe)","description":"Event tracing (wdtrace.exe)","sidebarTitle":"Event tracing (wdtrace.exe)","icon":"terminal","href":"/tools/tools-console/console_commandlinetools/wdtrace"},{"title":"Manage user accounts (wduser.exe)","description":"Manage user accounts (wduser.exe)","sidebarTitle":"Manage user accounts (wduser.exe)","icon":"user","href":"/tools/tools-console/console_commandlinetools/wduser"}]},{"group":"Devhome","pages":[{"title":"Developer Home (DevHome) on XBOX dev kits","description":"Overview of the DevHome experience on XBOX dev kits, including the Home page, XBOX Live page, and everyday console management tasks for GDK developers.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/devhome/index"},{"title":"Developer Home on the console (Dev Home)","description":"Developer Home on the console (Dev Home)","sidebarTitle":"Developer home on the console (dev home)","icon":"map","href":"/tools/tools-console/devhome/devhome"},{"title":"Home page (Dev Home)","description":"Home page (Dev Home)","sidebarTitle":"Home page (dev home)","icon":"bookmark","href":"/tools/tools-console/devhome/devhome-home"},{"title":"XBOX Live page for Dev Home","description":"XBOX Live page for Dev Home","sidebarTitle":"XBOX live page for dev home","icon":"compass","href":"/tools/tools-console/devhome/devhome-live"},{"title":"Networking page","description":"Networking page","sidebarTitle":"Networking page","icon":"network-wired","href":"/tools/tools-console/devhome/devhome-networking"},{"title":"Manage overlay folders","description":"Manage overlay folders","sidebarTitle":"Manage overlay folders","icon":"clipboard-list","href":"/tools/tools-console/devhome/devhome-overlay-folders"},{"title":"Devhome performance","href":"/tools/tools-console/devhome/devhome-performance"},{"title":"Report a Problem page","description":"Report a Problem page","sidebarTitle":"Report a problem page","icon":"file-lines","href":"/tools/tools-console/devhome/devhome-report-a-problem"},{"title":"Settings page (Dev Home)","description":"Settings page (Dev Home)","sidebarTitle":"Settings page (dev home)","icon":"sliders","href":"/tools/tools-console/devhome/devhome-settings"},{"title":"Streaming page (Dev Home)","description":"Streaming page (Dev Home)","sidebarTitle":"Streaming page (dev home)","icon":"video","href":"/tools/tools-console/devhome/devhome-streaming"}]},{"group":"Devkitagent","pages":[{"title":"DevKit Agent process on XBOX consoles","description":"The DevKit Agent process runs on every XBOX Development Kit and hosts remote tooling, deployment, and diagnostics used by PC tools targeting the console.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/devkitagent/index"},{"title":"DevKit Agent for managing XBOX development kits","description":"How the DevKit Agent on every XBOX dev kit polls your service and executes jobs for console configuration, title execution, and file operations via OpenAPI.","sidebarTitle":"Devkit agent","icon":"server","href":"/tools/tools-console/devkitagent/devkitagent-overview"}]},{"group":"Hix","pages":[{"title":"Hang Investigation for XBOX (HIX) tool","description":"Use the Hang Investigation for XBOX (HIX) tool for offline analysis of GPU hangs, including live debugging integration with Visual Studio.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/hix/index"},{"title":"Hix","href":"/tools/tools-console/hix/hix"},{"title":"Live debugging","href":"/tools/tools-console/hix/live-debugging"},{"title":"Live Debugging in Visual Studio for Hang Investigation","description":"Live Debugging in Visual Studio for Hang Investigation","sidebarTitle":"Live debugging in visual studio for","icon":"bug","href":"/tools/tools-console/hix/live-debugging-in-vs"},{"title":"On-demand Live Debugging in Visual Studio","description":"On-demand Live Debugging in Visual Studio","sidebarTitle":"On-demand live debugging in visual","icon":"bug","href":"/tools/tools-console/hix/on-demand-live-debugging-in-vs"},{"title":"Live Debugging in Visual Studio on Shader Exceptions","description":"Live Debugging in Visual Studio on Shader Exceptions","sidebarTitle":"Live debugging in visual studio on","icon":"palette","href":"/tools/tools-console/hix/shader-exceptions-live-debugging-in-vs"}]},{"group":"PGO","pages":[{"title":"Profile-Guided Optimization (PGO) for XBOX titles","description":"Apply Profile-Guided Optimization (PGO) to XBOX GDK titles during the link phase, and drive PGO runs from Visual Studio for measurable binary speedups.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/pgo/index"},{"title":"Profile-guided optimization","description":"Profile-guided optimization","sidebarTitle":"Profile-guided optimization","icon":"user","href":"/tools/tools-console/pgo/pgo"},{"title":"Profile-guided optimization in Visual Studio","description":"Profile-guided optimization in Visual Studio","sidebarTitle":"Profile-guided optimization in visual","icon":"gauge-high","href":"/tools/tools-console/pgo/pgo_full"}]},{"group":"PIX","pages":[{"title":"PIX on XBOX and Windows for GDK titles","description":"PIX performance-tuning and debugging tool for XBOX and Windows GDK titles, including GPU captures, GPU traces, shader explorer, and PIX extensibility.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/pix/index"},{"title":"Analyzing system performance","href":"/tools/tools-console/pix/analyzing-system-performance"},{"title":"Configuring pix","href":"/tools/tools-console/pix/configuring-pix"},{"title":"Cpu performance","href":"/tools/tools-console/pix/cpu-performance"},{"title":"Fileio performance","href":"/tools/tools-console/pix/fileio-performance"},{"title":"Launching and connecting","href":"/tools/tools-console/pix/launching-and-connecting"},{"title":"Memory performance","href":"/tools/tools-console/pix/memory-performance"},{"title":"New timing captures","href":"/tools/tools-console/pix/new-timing-captures"},{"title":"Open offline timing captures","href":"/tools/tools-console/pix/open-offline-timing-captures"},{"title":"Pix","href":"/tools/tools-console/pix/pix"},{"title":"Pix api reference","href":"/tools/tools-console/pix/pix-api-reference"},{"title":"Pix capture from launch","href":"/tools/tools-console/pix/pix-capture-from-launch"},{"title":"Pix context switches","href":"/tools/tools-console/pix/pix-context-switches"},{"title":"Pix convert etl files","href":"/tools/tools-console/pix/pix-convert-etl-files"},{"title":"Pix convert timing captures","href":"/tools/tools-console/pix/pix-convert-timing-captures"},{"title":"Pix cpu pdb config","href":"/tools/tools-console/pix/pix-cpu-pdb-config"},{"title":"Pix critical path","href":"/tools/tools-console/pix/pix-critical-path"},{"title":"Pix custom memory allocators","href":"/tools/tools-console/pix/pix-custom-memory-allocators"},{"title":"Pix directstorage","href":"/tools/tools-console/pix/pix-directstorage"},{"title":"Pix gpu debugging","href":"/tools/tools-console/pix/pix-gpu-debugging"},{"title":"Pix input sync","href":"/tools/tools-console/pix/pix-input-sync"},{"title":"Pix instruction trace captures","href":"/tools/tools-console/pix/pix-instruction-trace-captures"},{"title":"Pix live","href":"/tools/tools-console/pix/pix-live"},{"title":"Pix live memory pies","href":"/tools/tools-console/pix/pix-live-memory-pies"},{"title":"Pix mappingfiles","href":"/tools/tools-console/pix/pix-mappingfiles"},{"title":"Pix metrics view","href":"/tools/tools-console/pix/pix-metrics-view"},{"title":"Pix nvme write monitor","href":"/tools/tools-console/pix/pix-nvme-write-monitor"},{"title":"Pix on demand live debugging","href":"/tools/tools-console/pix/pix-on-demand-live-debugging"},{"title":"Pix sampling profiler","href":"/tools/tools-console/pix/pix-sampling-profiler"},{"title":"Pix save load settings","href":"/tools/tools-console/pix/pix-save-load-settings"},{"title":"Pix shader exception detection","href":"/tools/tools-console/pix/pix-shader-exception-detection"},{"title":"Pix shader exceptions live debugging","href":"/tools/tools-console/pix/pix-shader-exceptions-live-debugging"},{"title":"Pix system monitor","href":"/tools/tools-console/pix/pix-system-monitor"},{"title":"Pix timing capture bookmarks","href":"/tools/tools-console/pix/pix-timing-capture-bookmarks"},{"title":"Pix timing capture compare","href":"/tools/tools-console/pix/pix-timing-capture-compare"},{"title":"Pix timing capture sqlite queries","href":"/tools/tools-console/pix/pix-timing-capture-sqlite-queries"},{"title":"Pix timing capture summary layout","href":"/tools/tools-console/pix/pix-timing-capture-summary-layout"},{"title":"Pix timing captures d3d objects","href":"/tools/tools-console/pix/pix-timing-captures-d3d-objects"},{"title":"Pix timing captures memory","href":"/tools/tools-console/pix/pix-timing-captures-memory"},{"title":"PIX videos","description":"PIX videos","sidebarTitle":"PIX videos","icon":"video","href":"/tools/tools-console/pix/pix-videos"},{"title":"Pix win32 fileio","href":"/tools/tools-console/pix/pix-win32-fileio"},{"title":"Required xconfig settings","href":"/tools/tools-console/pix/required-xconfig-settings"},{"title":"Setup getting started","href":"/tools/tools-console/pix/setup-getting-started"},{"group":"Extensibility","pages":[{"title":"PIX extensibility APIs (HLSL and mesh viewer)","description":"Extend PIX with the HLSL extensibility API and mesh viewer plugins to add custom visualizations, capture logic, and analysis to your GPU captures.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/pix/extensibility/index"},{"title":"Pix extensibility","href":"/tools/tools-console/pix/extensibility/pix-extensibility"},{"title":"Pix extensibility hlsl","href":"/tools/tools-console/pix/extensibility/pix-extensibility-hlsl"},{"title":"Pix extensibility mesh viewer","href":"/tools/tools-console/pix/extensibility/pix-extensibility-mesh-viewer"},{"title":"Pix extensibility settings","href":"/tools/tools-console/pix/extensibility/pix-extensibility-settings"},{"title":"Pix extensibility texture viewer","href":"/tools/tools-console/pix/extensibility/pix-extensibility-texture-viewer"}]},{"group":"Gpu","pages":[{"title":"PIX GPU capture and performance analysis","description":"Analyze GPU performance and debug rendering with PIX GPU captures, PIX API objects, and XBOX Series X|S GPU features exposed through PIX on Windows.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/pix/gpu/index"},{"title":"Gpu performance","href":"/tools/tools-console/pix/gpu/gpu-performance"},{"title":"Pix api objects","href":"/tools/tools-console/pix/gpu/pix-api-objects"},{"title":"Pix bottlenecks","href":"/tools/tools-console/pix/gpu/pix-bottlenecks"},{"title":"Pix bvh viewer","href":"/tools/tools-console/pix/gpu/pix-bvh-viewer"},{"title":"Pix counters","href":"/tools/tools-console/pix/gpu/pix-counters"},{"title":"Pix drpix","href":"/tools/tools-console/pix/gpu/pix-drpix"},{"title":"Pix edit and continue","href":"/tools/tools-console/pix/gpu/pix-edit-and-continue"},{"title":"Pix edits","href":"/tools/tools-console/pix/gpu/pix-edits"},{"title":"Pix event details","href":"/tools/tools-console/pix/gpu/pix-event-details"},{"title":"Pix gpu capture","href":"/tools/tools-console/pix/gpu/pix-gpu-capture"},{"title":"Pix gpu executeindirect","href":"/tools/tools-console/pix/gpu/pix-gpu-executeindirect"},{"title":"Pix gpu input assembly","href":"/tools/tools-console/pix/gpu/pix-gpu-input-assembly"},{"title":"Pix gpu overview page","href":"/tools/tools-console/pix/gpu/pix-gpu-overview-page"},{"title":"Pix gpu pipeline view","href":"/tools/tools-console/pix/gpu/pix-gpu-pipeline-view"},{"title":"Pix gpu resources","href":"/tools/tools-console/pix/gpu/pix-gpu-resources"},{"title":"Pix gpu timeline tab","href":"/tools/tools-console/pix/gpu/pix-gpu-timeline-tab"},{"title":"Pix gpu timing","href":"/tools/tools-console/pix/gpu/pix-gpu-timing"},{"title":"Pix memory viewer","href":"/tools/tools-console/pix/gpu/pix-memory-viewer"},{"title":"Pix mesh viewer","href":"/tools/tools-console/pix/gpu/pix-mesh-viewer"},{"title":"Pix pipeline states","href":"/tools/tools-console/pix/gpu/pix-pipeline-states"},{"title":"Pix resources tab","href":"/tools/tools-console/pix/gpu/pix-resources-tab"},{"title":"Pix shader debugging","href":"/tools/tools-console/pix/gpu/pix-shader-debugging"},{"title":"Pix shader pdbs","href":"/tools/tools-console/pix/gpu/pix-shader-pdbs"},{"title":"Pix shader trace durpio","href":"/tools/tools-console/pix/gpu/pix-shader-trace-durpio"},{"title":"Pix shader trace scarlett","href":"/tools/tools-console/pix/gpu/pix-shader-trace-scarlett"},{"title":"Pix state","href":"/tools/tools-console/pix/gpu/pix-state"},{"title":"Pix table of hardware counters","href":"/tools/tools-console/pix/gpu/pix-table-of-hardware-counters"},{"title":"Pix texture mip stats","href":"/tools/tools-console/pix/gpu/pix-texture-mip-stats"},{"title":"Pix texture viewer","href":"/tools/tools-console/pix/gpu/pix-texture-viewer"},{"title":"Pix vrs","href":"/tools/tools-console/pix/gpu/pix-vrs"},{"title":"Pix with shaders","href":"/tools/tools-console/pix/gpu/pix-with-shaders"}]},{"group":"Gpu trace","pages":[{"title":"PIX GPU Trace captures on XBOX Series consoles","description":"Take lightweight PIX GPU Trace captures on XBOX Series X|S consoles to profile GPU work over time and diagnose frame-rate and pipeline stalls.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/pix/gpu-trace/index"},{"title":"Pix gpu trace capture","href":"/tools/tools-console/pix/gpu-trace/pix-gpu-trace-capture"},{"title":"Pix gpu trace overview","href":"/tools/tools-console/pix/gpu-trace/pix-gpu-trace-overview"},{"title":"Pix gpu trace ui","href":"/tools/tools-console/pix/gpu-trace/pix-gpu-trace-ui"}]},{"group":"Shader explorer","pages":[{"title":"PIX Shader Explorer for GPU shader analysis","description":"Use PIX Shader Explorer to see the factors that affect shader performance, including GPR pressure, register allocation, and variable-to-register mapping.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/pix/shader-explorer/index"},{"title":"Pix shader explorer overview","href":"/tools/tools-console/pix/shader-explorer/pix-shader-explorer-overview"}]}]},{"group":"Shadercompiler","pages":[{"title":"HLSL shader compiler (DXC) for the XBOX GDK","description":"Compile HLSL shaders for the XBOX GDK with DXC, including porting existing shaders from FXC and D3DCompiler and integrating the compiler into your build.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/shadercompiler/index"},{"title":"Dxc port from fxc","href":"/tools/tools-console/shadercompiler/dxc-port-from-fxc"},{"title":"Dxc usage","href":"/tools/tools-console/shadercompiler/dxc-usage"},{"title":"Dxc xbox defines","href":"/tools/tools-console/shadercompiler/dxc-xbox-defines"},{"title":"Dxc xbox extensions","href":"/tools/tools-console/shadercompiler/dxc-xbox-extensions"},{"title":"Dxc xbox intrinsics","href":"/tools/tools-console/shadercompiler/dxc-xbox-intrinsics"},{"title":"Shader compiler","href":"/tools/tools-console/shadercompiler/shader-compiler"}]},{"group":"Titleperfoverlay","pages":[{"title":"Title Performance Overlay for XBOX titles","description":"Use the Title Performance Overlay on XBOX dev kits to spot short-duration frame-rate hitches and locate transient performance drops in a running title.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/titleperfoverlay/index"},{"title":"Titleperfoverlay","href":"/tools/tools-console/titleperfoverlay/titleperfoverlay"}]},{"group":"Visualstudio","pages":[{"title":"Visualstudio","description":"Documentation for Visual Studio in the XBOX Game Development Kit (developer tools) on console. Covers concepts, tools, configuration, and workflows.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/visualstudio/index"},{"title":"Address Sanitizer Support for XBOX","description":"Address Sanitizer Support for XBOX","sidebarTitle":"Address sanitizer support","icon":"bookmark","href":"/tools/tools-console/visualstudio/address-sanitizer-support"},{"title":"Visual C++ compiler resources","description":"Visual C++ compiler resources","sidebarTitle":"Visual c++ compiler resources","icon":"compass","href":"/tools/tools-console/visualstudio/compiler-resources"},{"title":"Visual C++ compiler and linker switch recommendations","description":"Visual C++ compiler and linker switch recommendations","sidebarTitle":"Visual c++ compiler and linker switch","icon":"note-sticky","href":"/tools/tools-console/visualstudio/compiler-switch-recommendations"},{"title":"XBOX compiler technology","description":"XBOX compiler technology","sidebarTitle":"XBOX compiler technology","icon":"map","href":"/tools/tools-console/visualstudio/compiler-technology"},{"title":"Debugging XBOX projects by using Visual Studio","description":"Debugging XBOX projects by using Visual Studio","sidebarTitle":"Debugging XBOX projects by using visual","icon":"bug","href":"/tools/tools-console/visualstudio/debugging-with-visualstudio"},{"title":"Deployment errors","href":"/tools/tools-console/visualstudio/deployment-errors"},{"title":"Visual Studio properties for XBOX development","description":"Visual Studio properties for XBOX development","sidebarTitle":"Visual studio properties for XBOX","icon":"bug","href":"/tools/tools-console/visualstudio/durango-property-pages"},{"title":"Project templates in Visual Studio for XBOX development","description":"Project templates in Visual Studio for XBOX development","sidebarTitle":"Project templates in visual studio for","icon":"bug","href":"/tools/tools-console/visualstudio/durango-visual-studio-templates"},{"title":"How to: deploying game resource files by using Visual Studio","description":"How to: deploying game resource files by using Visual Studio","sidebarTitle":"How to: deploying game resource files","icon":"book-open","href":"/tools/tools-console/visualstudio/how-to-deploy-resources"},{"title":"Enable multiple build configurations in one deployment","description":"How to: enabling multiple build configurations in a single deployment","sidebarTitle":"How to: enabling multiple build","icon":"sliders","href":"/tools/tools-console/visualstudio/multiple-build-configurations"},{"title":"GDK on XBOX preprocessor definitions","description":"Microsoft Game Development Kit on XBOX preprocessor definitions","sidebarTitle":"Microsoft game development kit on XBOX","icon":"square-pen","href":"/tools/tools-console/visualstudio/preprocessor-definitions"},{"title":"Table of intrinsics","description":"Table of intrinsics","sidebarTitle":"Table of intrinsics","icon":"clipboard-list","href":"/tools/tools-console/visualstudio/table-of-intrinsics"},{"title":"Visual Studio for console development","description":"Visual Studio for console development","sidebarTitle":"Visual studio for console development","icon":"bug","href":"/tools/tools-console/visualstudio/visualstudio"},{"title":"Visual Studio 2019 GDK support notes","description":"Visual Studio 2019 Microsoft Game Development Kit (GDK) support notes","sidebarTitle":"Visual studio 2019 microsoft game","icon":"cube","href":"/tools/tools-console/visualstudio/vs-2019-support-notes"},{"title":"Visual Studio 2022 GDK support notes","description":"Visual Studio 2022 Microsoft Game Development Kit (GDK) support notes","sidebarTitle":"Visual studio 2022 microsoft game","icon":"cube","href":"/tools/tools-console/visualstudio/vs-2022-support-notes"},{"title":"Visual Studio 2026 GDK support notes","description":"Visual Studio 2026 Microsoft Game Development Kit (GDK) support notes","sidebarTitle":"Visual studio 2026 microsoft game","icon":"cube","href":"/tools/tools-console/visualstudio/vs-2026-support-notes"},{"title":"Use Clang/LLVM with the GDK for consoles","description":"Using Clang/LLVM with the Microsoft Game Development Kit (GDK) for consoles","sidebarTitle":"Using clang/llvm with the microsoft","icon":"cube","href":"/tools/tools-console/visualstudio/vs-clang"},{"title":"Configure Visual Studio for XBOX Series X|S and XBOX One","description":"Configuring Visual Studio for XBOX Series X|S and XBOX One builds","sidebarTitle":"Configuring visual studio for XBOX","icon":"arrows-left-right","href":"/tools/tools-console/visualstudio/vs-cross-gen"},{"title":"XBOX Game View","description":"XBOX Game View","sidebarTitle":"XBOX game view","icon":"file-lines","href":"/tools/tools-console/visualstudio/xbox-game-view"},{"title":"XBOX Gaming Explorer","description":"XBOX Gaming Explorer","sidebarTitle":"XBOX gaming explorer","icon":"file-lines","href":"/tools/tools-console/visualstudio/xbox-gaming-explorer"},{"title":"XBOX Gaming Project Control","description":"XBOX Gaming Project Control","sidebarTitle":"XBOX gaming project control","icon":"file-lines","href":"/tools/tools-console/visualstudio/xbox-gaming-project-control"},{"title":"XBOX System Monitor","description":"XBOX System Monitor","sidebarTitle":"XBOX system monitor","icon":"file-lines","href":"/tools/tools-console/visualstudio/xbox-system-monitor"}]},{"group":"Wdp","pages":[{"title":"XBOX Device Portal (Windows Device Portal on XBOX)","description":"Enable and script against the XBOX Device Portal (Windows Device Portal on XBOX) to manage a dev kit remotely from a browser or automation script.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/wdp/index"},{"title":"Enabling XBOX Device Portal","description":"Enabling XBOX Device Portal","sidebarTitle":"Enabling XBOX Device Portal","icon":"gauge","href":"/tools/tools-console/wdp/enabling-wdp-on-xbox"},{"title":"Script authoring tool","description":"Script authoring tool","sidebarTitle":"Script authoring tool","icon":"right-to-bracket","href":"/tools/tools-console/wdp/script-authoring-tool"},{"title":"XBOX Device Portal (Windows Device Portal on XBOX)","description":"XBOX Device Portal (Windows Device Portal on XBOX)","sidebarTitle":"XBOX device portal (windows device","icon":"gauge","href":"/tools/tools-console/wdp/wdp"},{"title":"Adding tools to XBOX Device Portal workspaces","description":"Adding tools to XBOX Device Portal workspaces","sidebarTitle":"Adding tools to XBOX device portal","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-adding-tools"},{"title":"Crash data page","description":"Crash data page","sidebarTitle":"Crash data page","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-crash-data"},{"title":"File explorer page","description":"File explorer page","sidebarTitle":"File explorer page","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-file-explorer"},{"title":"Game event data page","description":"Game event data page","sidebarTitle":"Game event data page","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-game-event-data"},{"title":"Home page","description":"Home page","sidebarTitle":"Home page","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-home"},{"title":"HTTP monitor page","description":"HTTP monitor page","sidebarTitle":"HTTP monitor page","icon":"plug","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-http-monitor"},{"title":"Media capture page","description":"Media capture page","sidebarTitle":"Media capture page","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-media-capture"},{"title":"Network page","description":"Network page","sidebarTitle":"Network page","icon":"network-wired","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-network"},{"title":"OS update page","description":"OS update page","sidebarTitle":"Os update page","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-os-update"},{"title":"Managing overlay folders","description":"Managing overlay folders","sidebarTitle":"Managing overlay folders","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-overlay-folders"},{"title":"Performance page","description":"Performance page","sidebarTitle":"Performance page","icon":"gauge-high","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-performance"},{"title":"Scratch page","description":"Scratch page","sidebarTitle":"Scratch page","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-scratch"},{"title":"Managing console settings with XBOX Device Portal","description":"Managing console settings with XBOX Device Portal","sidebarTitle":"Managing console settings with XBOX","icon":"sliders","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-settings"},{"title":"XBOX Live page","description":"XBOX Live page","sidebarTitle":"XBOX live page","icon":"gauge","href":"/tools/tools-console/wdp/windows-device-portal-on-xbox-xbl"}]},{"group":"Xbom","pages":[{"title":"XBOX Manager tool for managing dev consoles","description":"Manage XBOX dev consoles from your PC with XBOX Manager, including automation via the XBOX Device Portal integration and multi-console operations.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/xbom/index"},{"title":"XBOX Manager: managing console automation","description":"XBOX Manager: managing console automation","sidebarTitle":"XBOX manager: managing console","icon":"bookmark","href":"/tools/tools-console/xbom/manager-tool-automation"},{"title":"XBOX Manager: managing console settings","description":"XBOX Manager: managing console settings","sidebarTitle":"XBOX manager: managing console settings","icon":"sliders","href":"/tools/tools-console/xbom/manager-tool-console-settings"},{"title":"XBOX Manager: remote control","description":"XBOX Manager: remote control","sidebarTitle":"XBOX manager: remote control","icon":"gamepad","href":"/tools/tools-console/xbom/manager-tool-gamepad-input"},{"title":"XBOX Manager: group remote control","description":"XBOX Manager: group remote control","sidebarTitle":"XBOX manager: group remote control","icon":"users","href":"/tools/tools-console/xbom/manager-tool-group-remote-control"},{"title":"XBOX Manager: managing consoles and groups","description":"XBOX Manager: managing consoles and groups","sidebarTitle":"XBOX manager: managing consoles and","icon":"users","href":"/tools/tools-console/xbom/manager-tool-groups"},{"title":"XBOX Manager: managing apps and files","description":"XBOX Manager: managing apps and files","sidebarTitle":"XBOX manager: managing apps and files","icon":"square-pen","href":"/tools/tools-console/xbom/manager-tool-managing-applications"},{"title":"XBOX Manager: media capture","description":"XBOX Manager: media capture","sidebarTitle":"XBOX manager: media capture","icon":"compass","href":"/tools/tools-console/xbom/manager-tool-media-capture"},{"title":"XBOX Manager best practices for multiplayer testing","description":"Best practices for using XBOX Manager when testing multiplayer scenarios","sidebarTitle":"Best practices for using XBOX manager","icon":"users-line","href":"/tools/tools-console/xbom/manager-tool-multiplayer"},{"title":"XBOX Manager: manage test accounts","description":"XBOX Manager: manage test accounts","sidebarTitle":"XBOX manager: manage test accounts","icon":"user","href":"/tools/tools-console/xbom/manager-tool-profiles"},{"title":"XBOX Manager: updating a console","description":"XBOX Manager: updating a console","sidebarTitle":"XBOX manager: updating a console","icon":"clipboard-list","href":"/tools/tools-console/xbom/manager-tool-updating-console"},{"title":"XBOX Manager","description":"XBOX Manager","sidebarTitle":"XBOX manager","icon":"note-sticky","href":"/tools/tools-console/xbom/xbom"}]},{"group":"Xbwatson","pages":[{"title":"xbWatson debug-output monitor for XBOX","description":"Use xbWatson on your development PC to monitor system-wide debug output and critical system events streamed from an XBOX dev console in real time.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/xbWatson/index"},{"title":"xbWatson","description":"xbWatson","sidebarTitle":"Xbwatson","icon":"note-sticky","href":"/tools/tools-console/xbWatson/xbwatson"}]},{"group":"Xhit","pages":[{"title":"XBOX Hang Investigation Tool (XHIT)","description":"Use the XBOX Hang Investigation Tool (XHIT) for offline analysis of GPU hang dumps captured on the XBOX One family of development consoles.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-console/xhit/index"},{"title":"Xhit tool","href":"/tools/tools-console/xhit/xhit-tool"}]}]},{"group":"Tools pc","pages":[{"title":"PC developer tools for the XBOX GDK","description":"Command-line tools, Visual Studio integration, XBOX PC Remote Tools, and XBOX PC Toolbox that run on Windows PCs to target XBOX and Windows GDK titles.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/tools/tools-pc/index"},{"title":"PC game development environment and tools","description":"Overview of Microsoft Game Development Kit (GDK) tools for PC game development, including Visual Studio setup, command-line tools, and PIX for Windows.","sidebarTitle":"Pc game development: environment and","icon":"map","href":"/tools/tools-pc/gc-tools-pc-toc"},{"title":"Install and launch your PC title with GDK tools","description":"How to use Microsoft Game Development Kit (GDK) tools to install, launch, and troubleshoot PC titles that run on the Microsoft Gaming Runtime.","sidebarTitle":"Utilizing microsoft game development","icon":"rocket","href":"/tools/tools-pc/launching-on-pc"},{"title":"Profile Windows titles with PIX (Performance Investigator)","description":"How to install and use PIX for Windows to profile DirectX 12 game titles on Windows 10 and later PCs, alongside the GXDK build of PIX for XBOX dev kits.","sidebarTitle":"Using performance investigator (PIX) to","icon":"user","href":"/tools/tools-pc/pix-for-windows"},{"title":"PC game registration with wdapp.exe","description":"When and how to register a PC game with wdapp.exe under the June 2022 GDK, so start menu and desktop tile icons appear and can launch the game correctly.","sidebarTitle":"Pc game registration","icon":"clipboard-list","href":"/tools/tools-pc/title-registration-pc"},{"group":"Commandlinetools","pages":[{"title":"Commandlinetools","description":"Documentation for command-line in the XBOX Game Development Kit (developer tools) on Windows PC. Covers concepts, tools, configuration, and workflows.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/tools/tools-pc/commandlinetools/index"},{"title":"Command-line tools for PC development","description":"Command-line tools for PC development","sidebarTitle":"Command-line tools for pc development","icon":"terminal","href":"/tools/tools-pc/commandlinetools/gr-commandlinetools-toc"},{"title":"Screen Capture (wdcapture.exe)","description":"Screen Capture (wdcapture.exe)","sidebarTitle":"Screen capture (wdcapture.exe)","icon":"display","href":"/tools/tools-pc/commandlinetools/gr-wdCapture"},{"title":"XBOX PC Remote listening endpoint (wdEndpoint.exe)","description":"XBOX PC Remote listening endpoint (wdEndpoint.exe)","sidebarTitle":"XBOX PC Remote listening endpoint","icon":"plug","href":"/tools/tools-pc/commandlinetools/gr-wdEndpoint"},{"title":"XBOX PC Remote (wdRemote.exe)","description":"XBOX PC Remote (wdRemote.exe)","sidebarTitle":"XBOX PC Remote (wdRemote.exe)","icon":"terminal","href":"/tools/tools-pc/commandlinetools/gr-wdRemote"},{"title":"Gr wdapp","href":"/tools/tools-pc/commandlinetools/gr-wdapp"},{"title":"Video Capture (wdcapturesession.exe)","description":"Video Capture (wdcapturesession.exe)","sidebarTitle":"Video capture (wdcapturesession.exe)","icon":"people-group","href":"/tools/tools-pc/commandlinetools/gr-wdcapturesession"},{"title":"Manage XGameSave data on PC (xgamesaveutil.exe)","description":"Manage XGameSave data on PC (xgamesaveutil.exe)","sidebarTitle":"Manage xgamesave data on pc","icon":"terminal","href":"/tools/tools-pc/commandlinetools/gr-xgamesaveutil"}]},{"group":"Visualstudio","pages":[{"title":"Visualstudio","description":"Documentation for Visual Studio in the XBOX Game Development Kit (developer tools) on Windows PC. Covers concepts, tools, configuration, and workflows.","sidebarTitle":"Overview","icon":"folder-open","href":"/tools/tools-pc/visualstudio/index"},{"title":"Visual Studio (contents)","description":"Visual Studio (contents)","sidebarTitle":"Visual studio (contents)","icon":"bug","href":"/tools/tools-pc/visualstudio/gr-visualstudio-toc"},{"title":"Visual Studio 2019 support notes","description":"Visual Studio 2019 support notes","sidebarTitle":"Visual studio 2019 support notes","icon":"bug","href":"/tools/tools-pc/visualstudio/gr-vs-2019-support-notes"},{"title":"Visual Studio 2022 support notes","description":"Visual Studio 2022 support notes","sidebarTitle":"Visual studio 2022 support notes","icon":"bug","href":"/tools/tools-pc/visualstudio/gr-vs-2022-support-notes"},{"title":"Use Clang/LLVM with the GDK","description":"Using Clang/LLVM with the Microsoft Game Development Kit (GDK)","sidebarTitle":"Using clang/llvm with the microsoft","icon":"cube","href":"/tools/tools-pc/visualstudio/gr-vs-clang"},{"title":"Debugging PC projects using Visual Studio","description":"Debugging PC projects using Visual Studio","sidebarTitle":"Debugging pc projects using visual","icon":"bug","href":"/tools/tools-pc/visualstudio/gr-vs-debugging-with-visualstudio"},{"title":"Debug PC projects on remote Windows devices in Visual Studio","description":"Attach the Visual Studio 2022 debugger to PC game builds running on a remote Windows machine using the GDK marketplace extension for deploy and debug.","sidebarTitle":"Debugging pc projects on remote windows","icon":"bug","href":"/tools/tools-pc/visualstudio/gr-vs-debugging-with-visualstudio-remote-windows"},{"title":"Visual Studio properties for PC game development","description":"Visual Studio properties for PC game development","sidebarTitle":"Visual studio properties for pc game","icon":"bug","href":"/tools/tools-pc/visualstudio/gr-vs-property-pages"},{"title":"Project templates in Visual Studio for PC game development","description":"Project templates in Visual Studio for PC game development","sidebarTitle":"Project templates in visual studio for","icon":"bug","href":"/tools/tools-pc/visualstudio/gr-vs-templates"}]},{"group":"Xboxpctoolbox","pages":[{"title":"XBOX PC Toolbox app for remote Windows devices","description":"Use the XBOX PC Toolbox to remotely set up, deploy to, and update Windows-based target devices when developing XBOX GDK titles for Windows PCs.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/tools/tools-pc/xboxpctoolbox/index"},{"title":"XBOX PC Toolbox","description":"XBOX PC Toolbox","sidebarTitle":"XBOX PC Toolbox","icon":"clipboard-list","href":"/tools/tools-pc/xboxpctoolbox/xboxpctoolbox"}]},{"group":"XBOX PC Remote Tools","pages":[{"title":"XBOX PC Remote Tools","description":"Provision, deploy, launch, debug, and iterate on remote Windows devices with the XBOX PC Remote Tools, including the XBOX PC Toolbox app and CLI tools.","sidebarTitle":"Overview","icon":"network-wired","href":"/tools/tools-pc/xbox-pc-remote-tools/index"},{"title":"XBOX PC Remote Tools quickstart guide","description":"Install the XBOX PC Toolbox app and configure your development PC and target device.","sidebarTitle":"Quickstart","href":"/tools/tools-pc/xbox-pc-remote-tools/quickstart"},{"title":"How to use the XBOX PC Remote Tools","description":"Set up devices, pair them, and use the XBOX PC Remote Tools to iterate on remote Windows devices.","sidebarTitle":"How to use the tools","href":"/tools/tools-pc/xbox-pc-remote-tools/how-to-use-tools"},{"title":"XBOX PC Remote Tools FAQ and troubleshooting guide","description":"Answers to common XBOX PC Remote Tools questions and troubleshooting guidance.","sidebarTitle":"FAQ and troubleshooting","href":"/tools/tools-pc/xbox-pc-remote-tools/faq"},{"group":"Release notes","pages":[{"title":"Release notes","description":"Review new features, fixes, and known issues in each XBOX PC Remote Tools release, with per-version release notes for the 2603, 2605, and later builds.","sidebarTitle":"Release notes","icon":"clipboard-list","href":"/tools/tools-pc/xbox-pc-remote-tools/release-notes/index"},{"title":"XBOX PC Remote Tools: May 2026 (2605) release notes","description":"Describes new features, improvements, and known issues in the May 2026 release of the XBOX PC Remote Tools.","sidebarTitle":"May 2026 (2605)","href":"/tools/tools-pc/xbox-pc-remote-tools/release-notes/2605"},{"title":"XBOX PC Remote Tools: March 2026 (2603) release notes","description":"Describes new features, improvements, and known issues in the March 2026 release of the XBOX PC Remote Tools.","sidebarTitle":"March 2026 (2603)","href":"/tools/tools-pc/xbox-pc-remote-tools/release-notes/2603"}]}]}]},{"group":"Tools services","pages":[{"title":"Live services tools for XBOX and PlayFab","description":"PC tools for XBOX Live and PlayFab live-service development, including xblconfig config-as-source, connected storage, dev accounts, and entitlement tools.","sidebarTitle":"Overview","icon":"screwdriver-wrench","href":"/tools/tools-services/index"},{"title":"Config as Source tools (XblConfig.exe)","description":"Config as Source (XblConfig.exe) tools and APIs for advanced integration with XBOX services configuration for leaderboards, achievements, and other features.","sidebarTitle":"Config as source tools (xblconfig.exe)","icon":"note-sticky","href":"/tools/tools-services/live-config-as-source"},{"title":"XBOX Connected Storage tool (XblConnectedStorage.exe)","description":"Command-line tool XblConnectedStorage.exe that downloads XBOX game saves from any sandbox, including RETAIL, to help debug hard-to-repro save issues.","sidebarTitle":"XBOX connected storage tool","icon":"cloud-arrow-up","href":"/tools/tools-services/live-connected-storage-tool"},{"title":"XBOX services Developer Account tool (XblDevAccount.exe)","description":"Command-line XblDevAccount.exe tool that manages Partner Center authentication for other XBOX services dev tools like Player Reset and Global Storage.","sidebarTitle":"XBOX services developer account tool","icon":"bookmark","href":"/tools/tools-services/live-dev-account-tool"},{"title":"Store Development Entitlements Tool (DevEntitlementTool.exe)","description":"Command-line DevEntitlementTool.exe that queries, adds, and removes Microsoft Store entitlements for XBOX test accounts in development sandboxes.","sidebarTitle":"Store development entitlements tool","icon":"store","href":"/tools/tools-services/live-dev-entitlements-tool"},{"title":"Using Fiddler to inspect web service calls","description":"How to use Fiddler Classic as a web debugging proxy to log and inspect HTTP and HTTPS traffic between your device and XBOX Live services or relying-party APIs.","sidebarTitle":"Using fiddler to inspect web service","icon":"compass","href":"/tools/tools-services/live-fiddler-inspect-web-calls"},{"title":"Global Storage tool (GlobalStorage.exe)","description":"Command-line GlobalStorage.exe tool that manages global title storage in XBOX test sandboxes for shared data like rosters, maps, challenges, and art.","sidebarTitle":"Global storage tool (globalstorage.exe)","icon":"hard-drive","href":"/tools/tools-services/live-global-storage-tool"},{"title":"Multiplayer Session History Viewer tool","description":"Multiplayer Session History Viewer tool that shows a timeline of all changes to an MPSD session document, including deleted documents, for the last few days.","sidebarTitle":"Multiplayer session history viewer","icon":"people-group","href":"/tools/tools-services/live-mp-session-history-viewer"},{"title":"PC Sandbox Switcher (XblPCSandbox.exe)","description":"Command-line XblPCSandbox.exe tool that shows, switches, and relaunches PC apps in XBOX services sandboxes, including the Microsoft Store and XBOX App.","sidebarTitle":"Pc sandbox switcher (xblpcsandbox.exe)","icon":"map","href":"/tools/tools-services/live-pc-sandbox-switcher"},{"title":"Player Data Reset tool (XblPlayerDataReset.exe)","description":"XblPlayerDataReset.exe command-line tool that resets a player or group's achievements, leaderboards, stats, and title history in XBOX services sandboxes.","sidebarTitle":"Player data reset tool","icon":"database","href":"/tools/tools-services/live-player-data-reset"},{"title":"Development tools for XBOX services","description":"Overview of GDK development tools for XBOX services titles, how to launch them from a GDK command prompt, and where to download the XboxLiveTools package.","sidebarTitle":"Development tools for XBOX services","icon":"clipboard-list","href":"/tools/tools-services/live-tools"},{"title":"Tools for XBOX services","description":"Index of XBOX services developer tools including XblConfig, Connected Storage, Dev Account, Player Reset, Trace Analyzer, and Test Account tools.","sidebarTitle":"Tools for XBOX services","icon":"square-pen","href":"/tools/tools-services/live-tools-nav"},{"title":"XBOX services Trace Analyzer (XblTraceAnalyzer.exe)","description":"Command-line XblTraceAnalyzer.exe tool that reviews XBOX services traffic captured from a title offline to flag violations in service call patterns.","sidebarTitle":"XBOX services trace analyzer","icon":"file-lines","href":"/tools/tools-services/live-trace-analyzer"},{"title":"Live xbox common events tool","href":"/tools/tools-services/live-xbox-common-events-tool"},{"title":"XBOX Live Test Account tool (XblTestAccountGui.exe)","description":"XBOX Live Test Account tool (XBLAT) that helps title developers set up existing dev accounts for testing scenarios such as gamertag and friends list changes.","sidebarTitle":"XBOX live test account tool","icon":"file-lines","href":"/tools/tools-services/live-xbox-live-account-tool"},{"title":"Inspect and modify network traffic with XMAT","description":"Use XMAT to capture, inspect, analyze, and modify network traffic from XBOX development consoles and Windows PCs.","sidebarTitle":"XBOX Multiplayer Analysis Tool (XMAT)","icon":"network-wired","href":"/tools/tools-services/live-xbox-multiplayer-analysis-tool"}]}]}]},{"tab":"Publishing","pages":[{"title":"Publishing overview","description":"Learn how to create, manage, publish, and update XBOX and PC games with Partner Center, from onboarding through your first title release.","icon":"house","sidebarTitle":"Overview","href":"/publishing/game-publishing/overview"},{"group":"XBOX publishing overviews","icon":"rocket","pages":[{"title":"XBOX game publishing overview","description":"Overview of the end-to-end XBOX game publishing process for managed creators, from concept and setup through certification and RETAIL release.","sidebarTitle":"Overview","icon":"circle-info","href":"/publishing/game-publishing/publishing-processes/managed-creators/overview"},{"title":"Submit game concepts","description":"Submit an XBOX game concept for approval before publishing, including details about the developer, publisher, and game required for review.","sidebarTitle":"Submit game concepts","icon":"lightbulb","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-game-concepts"},{"group":"Product planning","icon":"clipboard-list","pages":[{"title":"SKU planning","description":"Plan and submit XBOX SKU plans for digital and physical editions of your game, and align with XBOX Games Store and Microsoft Store policies.","icon":"sitemap","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-sku-planning"},{"title":"XBOX Game Preview","description":"XBOX Game Preview overview for creators: preview and sell in-development games, including how to apply and required game concept approval.","icon":"flask","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-xbox-game-preview"}]},{"title":"Set up XBOX products in Partner Center","description":"Create and onboard XBOX games, demos, bundles, and add-ons in Partner Center, including how to choose the right product type for your release.","sidebarTitle":"Set up products","icon":"box","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-product-onboarding-and-configuration"},{"group":"Microsoft Store and monetization","icon":"store","pages":[{"title":"Configuring pre-order products","description":"Configure pre-order products in Partner Center, including submitting pre-order plans for approval and setting up games, bundles, and durables.","icon":"cart-plus","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-configuring-pre-orders"},{"title":"Post-sale monetization","description":"Plan post-sale monetization for XBOX games with durables, consumables, add-on bundles, and Season Passes for downloadable content (DLC).","icon":"dollar-sign","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-post-sale-monetization"},{"title":"Ordering promotional codes","description":"Order promotional codes, 5x5 tokens, for retail XBOX products in Partner Center, including sample token allowances and policy considerations.","icon":"ticket","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-promo-codes"},{"title":"Game wishlist pages","description":"Set up a wishlist page in the Microsoft Store for your XBOX game, including required modules, Revenue SKU, and pre-launch marketing benefits.","icon":"heart","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-wishlist-pages"}]},{"title":"Prerelease testing options","description":"Prerelease testing options for XBOX products in dev and RETAIL sandboxes, including sideloading, local install, private audience, and flighting.","sidebarTitle":"Prerelease testing","icon":"flask","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-prerelease"},{"group":"Submit to XBOX Certification","icon":"paper-plane","pages":[{"title":"Submit game packages for Final Certification","description":"Submit XBOX game packages, Store Listings, and Pricing and Availability for Final Certification in Partner Center using modular publishing.","icon":"circle-check","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-disc-and-digital-certification"},{"title":"Submit game packages for Optional Certification","description":"Submit game packages for Optional Certification in Partner Center, including selecting a tier, completing the questionnaire, and PO guidance.","icon":"circle-plus","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-optional-certification"},{"title":"Submitting to XBOX certification in Partner Center","description":"Submit XBOX and PC game packages, Store listings, and Pricing and availability to XBOX certification in Partner Center for testing and approval.","icon":"paper-plane","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-submitting-to-certification"}]},{"group":"Disc releases","icon":"compact-disc","pages":[{"title":"Disc packaging requirements","description":"Meet XBOX disc packaging requirements, including standard templates, iconography, logos, fonts, and Optimized for XBOX Series X icon usage.","icon":"box","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-disc-packaging"},{"title":"Order discs for manufacture","description":"Order XBOX discs for manufacture, including royalty tier approval, packaging artwork, test discs, and Release to Manufacturing (RTM) prerequisites.","icon":"industry","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-ordering-discs"},{"title":"Approve discs for manufacture","description":"Request approval to Release to Manufacturing (RTM) for XBOX disc binaries, including certified binary and approved packaging prerequisites.","icon":"circle-check","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-rtm"}]},{"group":"Publish to RETAIL","icon":"rocket-launch","pages":[{"title":"XBOX game publishing readiness checklist","description":"A publishing readiness checklist for XBOX creators to validate Partner Center settings, metadata, packages, and release schedule before launch.","icon":"list-check","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-game-publishing-readiness-checklist"},{"title":"Publishing and testing in the RETAIL sandbox","description":"Publish and test XBOX products in the RETAIL sandbox, including module validation for Packages, Properties, Age Ratings, and Store Listings.","icon":"rocket","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-retail-publishing-and-testing"}]},{"title":"Product changes and Content Updates","description":"Support released XBOX games with Content Updates, configuration changes, and add-on content, including CU versioning and identity requirements.","sidebarTitle":"Post-release updates","icon":"arrows-rotate","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-post-release-lifecycle"},{"group":"More programs","icon":"layer-group","pages":[{"title":"Publishing programs available to XBOX creators.","description":"Explore XBOX publishing programs for managed creators, including discount programs, tentpole sales, Free Play Days, and other targeted offers.","icon":"layer-group","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-managed-programs"},{"title":"Sub-publishing","description":"Set up digital or physical sub-publishing on XBOX using the XBOX Sub-Publishing Form so another publisher can release your game in specific markets.","icon":"sitemap","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-subpublishing"}]},{"title":"Recommendations for testing in the RETAIL sandbox","description":"Recommendations for testing XBOX and PC products in the RETAIL sandbox, including device configuration, sandbox switching, and product-type tips.","sidebarTitle":"Testing in RETAIL","icon":"vial","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-recommendations-for-testing-in-retail"}]},{"group":"XBOX Partner onboarding","icon":"user-plus","hidden":true,"pages":[{"title":"XBOX partner onboarding overview","description":"Overview of the four-step XBOX partner onboarding path: register, enroll to Partner Center, join ID@XBOX, and complete supplier setup.","sidebarTitle":"Overview","icon":"circle-info","href":"/publishing/game-publishing/onboarding/overview","hiddenSetByFrontmatter":true},{"title":"Register as an XBOX partner","description":"Step 1 of XBOX partner onboarding. Create your Microsoft account, sign in to the XBOX Partner Dashboard, and submit your business information.","icon":"user-plus","href":"/publishing/game-publishing/onboarding/onboarding-register","hiddenSetByFrontmatter":true},{"title":"Enroll to Partner Center","description":"Step 2 of XBOX onboarding. Accept the App Developer Agreement, complete enrollment in the Windows and XBOX program, and share your Seller ID with the XBOX team.","icon":"clipboard-user","href":"/publishing/game-publishing/onboarding/onboarding-register-partner-center","hiddenSetByFrontmatter":true},{"title":"Join ID@XBOX","description":"Step 3 of XBOX onboarding. Submit a game concept and join ID@XBOX to unlock publishing support, development resources, and release opportunities.","icon":"user-plus","href":"/publishing/game-publishing/onboarding/onboarding-join-id-at-xbox","hiddenSetByFrontmatter":true},{"title":"Complete XBOX onboarding","description":"Step 4 of XBOX onboarding. Finish your Microsoft supplier setup and get access to the Entertainment Developer Store so you can order XBOX development kits.","icon":"flag-checkered","href":"/publishing/game-publishing/onboarding/onboarding-complete-setup","hiddenSetByFrontmatter":true},{"title":"Pitch your game for funding opportunities","description":"Pitch your ID@XBOX game to unlock strategic funding opportunities, including XBOX Game Pass deals and the Developer Acceleration Program.","icon":"bullhorn","href":"/publishing/game-publishing/onboarding/onboarding-pitch-your-game","hiddenSetByFrontmatter":true}]},{"group":"Partner Center features","icon":"sliders","pages":[{"title":"Partner Center features overview","description":"Explore Partner Center features for XBOX products, including Packages, Store listings, Properties, Pricing and availability, and gaming metadata.","sidebarTitle":"Overview","icon":"circle-info","href":"/publishing/game-publishing/concepts/overview"},{"title":"Partner Center account and access management","description":"Here's an overview of how to register for a Partner Center account to publish games to the Microsoft Store, and manage account users.","sidebarTitle":"Account \u0026 access","href":"/publishing/game-publishing/concepts/developer-account"},{"group":"Add-ons","icon":"puzzle-piece","pages":[{"title":"Add-ons","description":"Learn how to create durable, consumable, and store-managed add-ons for your XBOX game, including in-app purchases and downloadable content.","icon":"puzzle-piece","href":"/publishing/game-publishing/concepts/add-ons"},{"title":"Add-on bundle and Season Pass","description":"Create Add-on bundles and Season Passes in Partner Center so customers acquire multiple downloadable content items under one parent product in one purchase.","icon":"gift","href":"/publishing/game-publishing/concepts/add-ons/add-on-bundle"},{"title":"Consumable add-ons","description":"Configure Store-managed and developer-managed consumable add-ons to sell limited-use in-game items such as virtual currency and multi-purchase inventory.","icon":"coins","href":"/publishing/game-publishing/concepts/add-ons/consumable-add-ons"},{"title":"Durable add-ons","description":"Configure Durable and Durable with packages add-ons to unlock persistent content or features that customers buy once, with optional expiration windows.","icon":"infinity","href":"/publishing/game-publishing/concepts/add-ons/durable-add-ons"}]},{"title":"Branches","description":"Understand branches in Partner Center: isolated workspaces per module for Packages, Store listings, and Pricing and availability configuration.","icon":"code-branch","href":"/publishing/game-publishing/concepts/branches"},{"title":"Age ratings","description":"Configure age ratings for your XBOX game in Partner Center using the IARC questionnaire, and meet certification requirements before submission.","icon":"shield-check","href":"/publishing/game-publishing/concepts/age-ratings"},{"title":"Age ratings guidance for countries/regions","description":"Country and region age rating guidance for XBOX games, covering authorities like ESRB, PEGI, and USK, pre-order rules, timelines, and Store Rating Values.","href":"/publishing/game-publishing/concepts/age-ratings-guidance"},{"title":"Bundles","description":"Group multiple games or apps into a single Microsoft Store bundle so customers can buy related titles together at a combined price.","icon":"gift","href":"/publishing/game-publishing/concepts/bundle"},{"group":"Game publisher insights","icon":"chart-line","pages":[{"title":"XBOX Game Publisher Insights FAQ","description":"Frequently asked questions about XBOX Game Publisher Insights covering onboarding, reporting, scheduling, the Downloads Hub, and analytics APIs.","icon":"circle-question","href":"/publishing/game-publishing/concepts/game-publisher-insights/game-publisher-insights-faq"}]},{"title":"Game reparenting","description":"Move a gaming product and its add-ons between publishers in Partner Center using reparenting, and learn eligibility, prerequisites, and steps.","icon":"arrows-turn-right","href":"/publishing/game-publishing/concepts/reparenting"},{"group":"Discs","icon":"compact-disc","pages":[{"title":"Discs overview","description":"Order XBOX game discs through Partner Center: submit disc requests, select Authorized Replicators, approve test discs, and track production status.","icon":"circle-info","href":"/publishing/game-publishing/concepts/discs-overview"},{"title":"Discs royalty configuration","href":"/publishing/game-publishing/concepts/discs-royalty-configuration"}]},{"group":"Gaming metadata","icon":"tags","pages":[{"title":"Metadata overview","description":"Configure Gaming Metadata module tags in Partner Center — accessibility, supported languages, and features — that appear on your Store Product Details Page.","href":"/publishing/game-publishing/concepts/metadata-overview"},{"title":"Supported languages","description":"Declare the in-game languages your product supports — interface, audio, and subtitles — so Store customers see accurate localization information.","href":"/publishing/game-publishing/concepts/metadata-supported-languages"},{"title":"Accessibility metadata","description":"Learn the criteria for tagging accessibility features on your game's Catalog Listing so players can filter for subtitles and other supports.","href":"/publishing/game-publishing/concepts/metadata-accessibility"}]},{"group":"Packages","icon":"box","pages":[{"title":"Packages","description":"Use the new Packages experience in Partner Center to upload, validate, certify, and publish XBOX and PC game builds, or switch to the classic UI.","icon":"box","href":"/publishing/game-publishing/concepts/game-package-management"},{"title":"Packages (classic experience)","description":"Manage XBOX and PC game packages in Partner Center with the classic experience: upload, validate, certify, test, publish, and roll back builds.","icon":"boxes-stacked","href":"/publishing/game-publishing/concepts/packages-overview"},{"title":"XVC packages","description":"Upload GDK-generated XVC packages for XBOX consoles in Partner Center, including EKB, ContentId, layout files, submission validator logs, and symbols.","href":"/publishing/game-publishing/concepts/packages-xvc"}]},{"group":"Properties","icon":"sliders","pages":[{"title":"Properties basic info","href":"/publishing/game-publishing/concepts/properties-basic-info"},{"title":"Properties","description":"Learn about the Properties module in Partner Center: configure basic info, technical capabilities, and XBOX services for your game's Store PDP.","icon":"list","href":"/publishing/game-publishing/concepts/properties-overview"},{"title":"Technical capabilities","description":"Set technical capabilities for your game in Partner Center: delivery, audio, visuals, inputs, 4K, and Optimized for XBOX Series X|S declarations.","icon":"microchip","href":"/publishing/game-publishing/concepts/properties-technical-capabilities"}]},{"title":"Open and restrictive licensing models","description":"Compare the default, open, and restrictive Microsoft Store licensing models for Windows, XBOX, and HoloLens apps, and when to request each option.","sidebarTitle":"Licensing","href":"/publishing/game-publishing/concepts/licensing/open-and-restrictive-licensing"},{"title":"Product relationship management","description":"Configure product relationships in Partner Center to link products with can sell, can use and sell, and generation of relationship types for XBOX.","sidebarTitle":"Relationships","href":"/publishing/game-publishing/concepts/relationship-management"},{"group":"Pricing and availability","icon":"tag","pages":[{"title":"Pricing and Availability overview","description":"How to use the Pricing and availability page in Partner Center to set your game's markets, price, visibility, release schedule, and free trial options.","icon":"circle-info","href":"/publishing/game-publishing/concepts/availability/availability-overview"},{"group":"Visibility","icon":"eye","pages":[{"title":"Visibility","description":"Configure your product's visibility in the Microsoft Store, including public and private audiences, discoverability, and known user group access.","icon":"eye","href":"/publishing/game-publishing/concepts/availability/visibility"},{"title":"Visibility - Audiences","description":"How audience visibility options in Partner Center determine which groups of customers can view your Store Product Details Page for a game.","icon":"users","href":"/publishing/game-publishing/concepts/availability/visibility-audiences"}]},{"group":"Schedule","icon":"calendar","pages":[{"title":"Configuring a Schedule","description":"Configure Schedule options in Partner Center to set your product's release, pre-order, discoverable, and stop-acquisition dates for the Microsoft Store.","icon":"calendar-days","href":"/publishing/game-publishing/concepts/availability/availability-schedule"},{"title":"Pre-orders","description":"Let customers browse, purchase, and pre-download your XBOX title before release. Learn the pre-order process, token behavior, and hidden pre-order options.","icon":"cart-plus","href":"/publishing/game-publishing/concepts/availability/preorder-overview"}]},{"group":"Pricing","icon":"dollar-sign","pages":[{"title":"Price adjustment preference","description":"Set a preference in Partner Center so tax-driven price changes update either the suggested retail price or the wholesale price across all your products.","icon":"sliders","href":"/publishing/game-publishing/concepts/availability/managed-creators/price-adjustment-preference"},{"title":"Pricing models","description":"Compare the Agency and Reseller pricing models available for Microsoft Store products, and understand how each affects retail and wholesale prices.","icon":"money-bill","href":"/publishing/game-publishing/concepts/availability/managed-creators/reseller-pricing"},{"title":"Sale Pricing","description":"Configure limited-time price reductions on games, bundles, add-ons, and Season Passes so Microsoft Store customers see strikethrough pricing during the sale.","icon":"percent","href":"/publishing/game-publishing/concepts/availability/sale-pricing"},{"title":"Trials overview","description":"Compare time-limited, usage-limited, and unlimited trial configurations for XBOX games and pick the option that fits your acquisition and gameplay flow.","icon":"hourglass-half","href":"/publishing/game-publishing/concepts/availability/trials"},{"title":"Pricing considerations for managed creators","description":"Explore pricing options for managed creators, including price tiers, market customization, target platform selection, and scheduled price changes.","href":"/publishing/game-publishing/concepts/availability/managed-creators/pricing-additional-considerations"}]}]},{"group":"Product setup","icon":"gear","pages":[{"title":"Game setup","description":"Configure the Game setup and Bundle setup pages in Partner Center, including product groups and general product configuration options for XBOX.","icon":"gears","href":"/publishing/game-publishing/concepts/game-setup-overview"},{"title":"Create and reserve your game name","description":"Reserve and manage your XBOX game name in Partner Center, including codename usage, availability checks, and the three-month reservation rule.","icon":"signature","href":"/publishing/game-publishing/concepts/name"},{"title":"Product groups","description":"Organize your Partner Center titles into product groups, associate them with dev studios, and scope user permissions to specific groups of products.","icon":"layer-group","href":"/publishing/game-publishing/concepts/product-groups"}]},{"title":"Sandboxes","description":"Learn how XBOX sandboxes isolate content for development and testing, including creating products in sandboxes and controlling access with MSAs.","icon":"box-archive","href":"/publishing/game-publishing/concepts/sandboxes"},{"title":"Store listing for titles on XBOX devices","description":"Create XBOX Store listings in Partner Center with text, images, and trailers for your Product Details Page, tailored to each supported device.","href":"/publishing/game-publishing/concepts/store-listing"},{"title":"Review and publish","description":"Review your modular submission in Partner Center, resolve outstanding validation issues, and publish updates to selected sections independently.","icon":"circle-check","href":"/publishing/game-publishing/concepts/modular-submission"},{"group":"XBOX Insider Program","icon":"users","pages":[{"title":"XBOX Insider Program flighting FAQ","description":"Frequently asked questions about the XBOX Insider Program flighting for managed creators, including eligibility, bug reporting, and audiences.","icon":"circle-question","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-xbox-flighting-faq"},{"title":"XBOX Insider Program flighting","description":"Set up XBOX Insider Program flighting as a managed creator to distribute in-progress builds of your game to Insider audiences on XBOX and PC.","icon":"paper-plane","href":"/publishing/game-publishing/publishing-processes/managed-creators/publishing-processes-xbox-insider-flighting"}]},{"title":"Configuring XBOX services","description":"Configure XBOX services for managed creators, including sign-in, Achievements, Rich Presence, and Multiplayer, after enabling them in Game setup.","icon":"gear","href":"/publishing/game-publishing/concepts/xbox-services"},{"group":"Playtest","pages":[{"title":"Playtest overview","description":"Learn how Playtest lets studios distribute in-development builds to controlled groups, plus current Preview scope and planned GA capabilities.","icon":"flask","href":"/publishing/game-publishing/concepts/playtest"},{"title":"Use Playtest during Preview","description":"Set up and run prerelease XBOX playtests during Preview: request access, create audience groups, distribute packages, and share deep links with testers.","icon":"flask-vial","href":"/publishing/game-publishing/concepts/playtest-preview"}]}]},{"group":"XStore commerce","icon":"cart-shopping","pages":[{"title":"XStore commerce overview","sidebarTitle":"Commerce overview","icon":"cart-shopping","description":"Learn how XStore APIs, Partner Center, and Microsoft Store REST services fit together for XBOX and PC commerce, base games, DLC, and more.","href":"/publishing/xstore-commerce/xstore-commerce-overview"},{"group":"Getting started","icon":"rocket","pages":[{"title":"Choosing the right product type","description":"Choose the right Microsoft Store product type for your monetization plan, including bundles, consumables, and durable add-ons in Partner Center.","icon":"list-check","keywords":["Choosing the right product type"],"href":"/publishing/xstore-commerce/xstore-choosing-product-type"},{"title":"Initial configuration in Partner Center","description":"Set up the initial Partner Center configuration to enable XBOX commerce features during development, including PDP visibility in your dev sandbox.","icon":"sliders","href":"/publishing/xstore-commerce/xstore-initial-configuration"},{"title":"Enabling licensing testing","description":"Set up a licensable XBOX development build to test XStore licensing APIs, including relevant scenarios and required configuration steps in Partner.","icon":"key","href":"/publishing/xstore-commerce/xstore-licensing-setup"},{"title":"GDK Commerce Systems Overview","description":"Overview of the Microsoft Store commerce systems available in the GDK — purchases, entitlements, consumables, DLC, trials, subscriptions, and licensing APIs.","icon":"circle-info","keywords":["Commerce Systems Overview"],"href":"/publishing/xstore-commerce/xstore-overview"},{"title":"Enabling XStore development and testing","description":"Set up your XBOX product for XStore API development and testing in a sandbox, including entitlement, licensing, and test account requirements.","icon":"flask","href":"/publishing/xstore-commerce/xstore-product-testing-setup"},{"title":"Troubleshooting XStore development","description":"Troubleshoot common XStore API issues during XBOX game development and testing, including entitlements, sandboxes, and PC sign-in problems.","icon":"wrench","keywords":["Troubleshooting XStore development"],"href":"/publishing/xstore-commerce/xstore-troubleshooting"}]},{"group":"Fundamentals","icon":"cube","pages":[{"title":"Basic store operations","description":"Implement an in-game store with XStore APIs, including determining what users can purchase, checking entitlements, and completing purchases.","icon":"cube","keywords":["Basic store operations"],"href":"/publishing/xstore-commerce/xstore-basic-operations"},{"title":"Bundles and Season Passes","description":"Learn how to use Bundles and Season Passes in the Microsoft Store, including game bundles, add-on bundles, and long-term player engagement gains.","icon":"box-archive","keywords":["Bundles and Season Passes"],"href":"/publishing/xstore-commerce/xstore-bundles-season-passes"},{"title":"Checking for updates","description":"Check for and apply XBOX game and DLC package updates in your title using XStoreQueryGameAndDlcPackageUpdatesAsync for multiplayer parity.","icon":"arrows-rotate","keywords":["Checking for updates"],"href":"/publishing/xstore-commerce/xstore-checking-updates"},{"title":"Consumable-based ecosystems","description":"Configure and implement consumable products in the Microsoft Store — durable consumable ecosystems, purchase and fulfillment flow, and inventory tracking.","icon":"coins","keywords":["Consumable-based ecosystems"],"href":"/publishing/xstore-commerce/xstore-consumables"},{"title":"Manage and license downloadable content (DLC)","description":"Use durable products as downloadable content (DLC) in your title — Partner Center setup, licensing checks, install management, and runtime entitlement code.","icon":"puzzle-piece","keywords":["Manage and license downloadable content (DLC)"],"href":"/publishing/xstore-commerce/xstore-dlc"},{"title":"How to use a durable without a package","description":"Use a durable without a package (DWOB) in your title — licensing setup, entitlement checks, and how DWOBs differ from packaged downloadable content products.","icon":"box","href":"/publishing/xstore-commerce/xstore-dwob"},{"title":"Granting players access to add-on content","description":"Grant players access to XBOX add-on content using entitlements and licensing, including durables, consumables, bundles, and shared entitlements.","icon":"unlock","href":"/publishing/xstore-commerce/xstore-granting-access"},{"title":"Product sharing model for games","description":"How games, add-ons, and digital content are shared between users on XBOX consoles and Windows PCs, and what to expect on devices shared by multiple users.","icon":"share-nodes","href":"/publishing/xstore-commerce/xstore-product-sharing"},{"title":"Implementing Trials for your game","description":"Trial options available in the Microsoft Store for GDK titles — configuring usage-limited free trials in Partner Center and implementing trial checks in-game.","icon":"hourglass-half","href":"/publishing/xstore-commerce/xstore-trials"}]},{"group":"Manage from your services","icon":"network-wired","pages":[{"title":"Authenticating your service with the Microsoft Store APIs","description":"Describes how to get and use either delegated authentication X-tokens or User Store IDs to authenticate with Microsoft Store Services.","icon":"shield","href":"/publishing/xstore-commerce/xstore-authenticating-service"},{"title":"Detect XBOX Game Pass subscription access from your service","description":"Detect XBOX Game Pass subscription status from your service using the collections publisherQuery API, and grant rewards to active subscribers.","icon":"gamepad","href":"/publishing/xstore-commerce/xstore-detecting-game-pass"},{"title":"Fine Grained Rate Limiting for Microsoft Store APIs","description":"Expected calling patterns and Fine Grained Rate Limiting (FGRL) for Microsoft Store service APIs — per-endpoint limits and throttling behavior on XBOX and PC.","icon":"gift","href":"/publishing/xstore-commerce/xstore-fgrl"},{"title":"Managing consumable products from your service","description":"Describes how to build a robust system that manages consumables on your game service including managing user refunds of consumed items.","icon":"coins","href":"/publishing/xstore-commerce/xstore-managing-consumables"},{"title":"Managing refunds and chargebacks from your service","description":"Describes how to configure and use a Clawback event queue to detect refunds, returns, and chargebacks of your products across all product types.","icon":"rotate-left","href":"/publishing/xstore-commerce/xstore-managing-refunds"},{"title":"Managing subscription products from your service","description":"Describes how to use the Recurrence service to query and manage your subscription products and handle the different subscription states of a user.","icon":"repeat","href":"/publishing/xstore-commerce/xstore-managing-subscriptions"},{"title":"Query user entitlements from your services","description":"Query user entitlements from your services using the Microsoft Store Collections Query APIs, including satisfying entitlements and ownership state.","icon":"magnifying-glass","href":"/publishing/xstore-commerce/xstore-query-entitlements"},{"title":"Renewing a User Store ID key","description":"Renew a User Store ID key in Microsoft Store services before its 30-day lifetime expires, so your backend can continue authenticating calls.","icon":"arrows-rotate","href":"/publishing/xstore-commerce/xstore-renew-userstoreid"},{"title":"Request a User Store ID for service-to-service auth","description":"Describes the required configuration and steps to get a User Store ID for service-to-service authentication with the Microsoft Store service APIs.","icon":"id-card","href":"/publishing/xstore-commerce/xstore-requesting-userstoreid"},{"title":"Request a User Store ID with X-tokens or OAuth 2.0","description":"Generate User Store IDs on your service using OAuth 2.0 or XBOX X-tokens (XSTS), without exchanging tokens through the game client for auth.","icon":"key","href":"/publishing/xstore-commerce/xstore-requesting-userstoreid-oauth"}]},{"group":"PC-specific considerations","icon":"windows","pages":[{"title":"Basic DRM and license checks","description":"Outlines considerations and preventative measures PC titles should take to avoid piracy and ensure the game is running with a valid license.","icon":"lock","href":"/publishing/xstore-commerce/xstore-basic-drm"},{"title":"Using License Tokens to validate licensing on your services","description":"Use License Tokens to validate a user's XBOX game or add-on license on your backend services, including token structure and verification flows.","icon":"ticket","href":"/publishing/xstore-commerce/xstore-license-tokens"},{"title":"Handling mismatched store account scenarios on PC","description":"Handle mismatched Microsoft Store and XBOX account scenarios on PC, so players still receive purchases when accounts differ between apps.","icon":"user-slash","href":"/publishing/xstore-commerce/xstore-mismatched-accounts"},{"title":"Open and restrictive licensing","description":"How Microsoft Store default, open, and restrictive licensing models work for PC titles, including device limits and how to request each option.","icon":"scale-balanced","href":"/publishing/xstore-commerce/xstore-open-restrictive-licensing"},{"title":"XStore on PC — DRM, license tokens, and sandboxes","sidebarTitle":"PC considerations overview","icon":"windows","description":"PC-specific XStore considerations: basic DRM, license tokens for service validation, mismatched-store-account handling, and sandbox switching.","href":"/publishing/xstore-commerce/xstore-pc"},{"title":"Switching sandboxes properly for store operations","description":"Switch sandboxes correctly for Microsoft Store operations on PC using Xblpcsandbox.exe, so XBOX users are signed out and store scope updates.","icon":"shuffle","href":"/publishing/xstore-commerce/xstore-switching-sandbox"}]}]},{"group":"Game setup tutorials","icon":"gamepad","pages":[{"title":"Create and publish an XBOX GDK game in Partner Center","description":"Step-by-step tutorial for XBOX creators and Microsoft Store developers to create, configure, package, and publish a GDK game in Partner Center.","sidebarTitle":"Overview","icon":"circle-info","href":"/publishing/game-publishing/tutorial-xbox-managed/overview"},{"title":"Create a game and configure game setup","description":"Tutorial for creating an XBOX game in Partner Center and completing the Game setup page, including prerequisites and product configuration.","sidebarTitle":"Create \u0026 configure game","icon":"plus","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-create-a-title-and-configure-game-setup"},{"title":"Create a game package and upload it in Partner Center","description":"Tutorial for creating an XBOX game package with the GDK and uploading it to Partner Center, so you can validate, certify, and publish builds.","sidebarTitle":"Create \u0026 upload package","icon":"box","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-create-a-package"},{"title":"Configure properties for a game","description":"Tutorial for configuring properties for an XBOX game in Partner Center, including genre, contact info, technical capabilities, and XBOX services.","sidebarTitle":"Configure properties","icon":"sliders","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-configure-properties"},{"title":"Acquire and upload age ratings for a game","description":"Tutorial for acquiring and uploading age ratings for an XBOX game in Partner Center by using the IARC questionnaire or a ratings certificate.","sidebarTitle":"Configure age ratings","icon":"shield-check","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-set-age-ratings"},{"title":"Configure Store listings for a game","description":"Tutorial for creating an English Microsoft Store listing for an XBOX game in Partner Center, including text and visual assets for the PDP.","sidebarTitle":"Configure Store listings","icon":"store","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-create-a-store-listing"},{"title":"Configure pricing and availability for a game","description":"Tutorial for completing the Pricing and availability module in Partner Center for an XBOX game, including markets, price tiers, and visibility.","sidebarTitle":"Configure pricing","icon":"tag","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-configure-pricing-and-availability"},{"title":"Configure gaming metadata for a game","description":"Tutorial for configuring gaming metadata in Partner Center for an XBOX game, highlighting product features and accessibility to reach more players.","sidebarTitle":"Configure metadata","icon":"database","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-add-metadata"},{"title":"Configure XBOX services for a game","description":"Tutorial for configuring XBOX settings and XBOX services gameplay features for your XBOX game in Partner Center, including required prerequisites.","sidebarTitle":"Configure XBOX services","icon":"server","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-configure-xbox-services"},{"group":"Add-ons","icon":"puzzle-piece","pages":[{"title":"Configure a durable add-on for a game","description":"Tutorial for configuring a durable add-on for your XBOX game in Partner Center, including prerequisites, product setup, and publishing steps.","icon":"infinity","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-configure-a-durable"},{"title":"Create and publish add-ons for a game","description":"Tutorial for creating and publishing add-ons for your XBOX game in Partner Center, including expansions, character skins, and virtual currencies.","icon":"puzzle-piece","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-create-use-publish-add-ons"}]},{"title":"Configure product relationships for a game","description":"Tutorial for configuring product relationships between XBOX game products in Partner Center, including generation, sellable, and usable links.","sidebarTitle":"Configure relationships","icon":"diagram-project","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-create-product-relationships"},{"title":"Certify a game","description":"Tutorial for submitting an XBOX game for certification in Partner Center, including Store listings, Pricing and availability, and Packages review.","sidebarTitle":"Certify","icon":"clipboard-check","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-certify-a-game"},{"title":"Use Review and Publish to publish a game","description":"Tutorial for using Review and Publish in Partner Center to publish your certified XBOX game to the RETAIL sandbox and make it live to customers.","sidebarTitle":"Review \u0026 publish","icon":"circle-check","href":"/publishing/game-publishing/tutorial-xbox-managed/how-to-publish-a-base-game"}]},{"group":"XBOX Certification","icon":"clipboard-check","pages":[{"title":"Policies and XBOX Requirements","sidebarTitle":"Certification","icon":"clipboard-check","description":"Provides an overview of policies and requirements to submit your Microsoft Game Development Kit (GDK) game to Microsoft and add XBOX permissions.","href":"/publishing/certification/overview"},{"title":"Change history for XBOX Requirements and test cases","sidebarTitle":"XR change history","icon":"clock-rotate-left","description":"Version history of XBOX Requirements and test cases, which change generally on a monthly cadence, covering console, PC, mobile, and the Creators Program.","href":"/publishing/certification/xr-change-history"},{"group":"XBOX requirements for XBOX games","icon":"list-check","pages":[{"title":"XBOX Requirements for XBOX games","sidebarTitle":"XBOX requirements","icon":"clipboard-check","description":"Policies, technical requirements, and product component requirements that all XBOX titles must meet, including base requirements, stability, and quality.","href":"/publishing/certification/xbox-requirements"},{"title":"Certification tested XBOX Requirements for XBOX games","sidebarTitle":"Tested XBOX requirements","icon":"list-check","description":"Policies, technical requirements, and test cases that XBOX games must pass in certification, covering XBOX One, XBOX Series X|S, PC, and XBOX Cloud Gaming.","href":"/publishing/certification/console-cert-tested-requirements"},{"title":"Terminology","sidebarTitle":"Cert terminology","icon":"book","description":"The XBOX Required Terminology List of official terms for certified games and apps, covering controller hardware, xCloud terminology, and change history.","href":"/publishing/certification/console-cert-terminology"},{"title":"Top failing test cases","sidebarTitle":"Top failing tests","icon":"chart-line-down","description":"Certification test cases where games fail most often on XBOX console and PC, with tips for title stability, achievements, joinability, and save roaming.","href":"/publishing/certification/xr-top-failing"}]},{"title":"Requirements for beta and XBOX Game Preview titles","sidebarTitle":"Beta \u0026 Game Preview cert","icon":"flask","description":"XBOX lets Betas and Game Previews test against a reduced set of XBOX Requirements. See which XRs apply to these unfinished releases and recent changes.","href":"/publishing/certification/cert-beta-game-preview"},{"group":"Certification Failure Mode Analysis (FMA)","icon":"triangle-exclamation","pages":[{"title":"XBOX Certification Failure Mode Analysis (FMA)","sidebarTitle":"FMA overview","icon":"triangle-exclamation","description":"How Certification uses FMA to score issues by severity, probability, and repeatability, then classify them as CFR, SRI, or ION for consistent decisions.","href":"/publishing/certification/fma/overview"},{"title":"XR001 Title Stability","sidebarTitle":"FMA XR-001","icon":"triangle-exclamation","description":"FMA severity scenarios for XR-001 Title Stability, from non-interactive pauses and loading screens to crashes, unresponsive states, and lost save data.","href":"/publishing/certification/fma/xr-001"},{"title":"XR003 Title Quality for Submission","sidebarTitle":"FMA XR-003","icon":"broom","description":"FMA severity scenarios for XR-003 test case 003-02 Title Integrity, covering audio and visual corruption, debug text, localization, and broken features.","href":"/publishing/certification/fma/xr-003"},{"title":"XR013 Linking Microsoft Accounts with Publisher Accounts","sidebarTitle":"FMA XR-013","icon":"link","description":"FMA severity scenarios for XR-013 on linking publisher accounts to XBOX profiles, covering Terms of Service notice, unlinking, and use on multiple devices.","href":"/publishing/certification/fma/xr-013"},{"title":"XR014 Player Data and Personal Information","sidebarTitle":"FMA XR-014","icon":"user-shield","description":"FMA severity scenarios for XR-014 Personal Information, covering titles that share personal information or access, transmit, or display sensitive data.","href":"/publishing/certification/fma/xr-014"},{"title":"XR015 Managing Player Communication","sidebarTitle":"FMA XR-015","icon":"comments","description":"FMA severity scenarios for XR-015 User Communication, covering error messages and how titles honor privileges that allow or block voice and text chat.","href":"/publishing/certification/fma/xr-015"},{"title":"XR018 User Generated Content","sidebarTitle":"FMA XR-018","icon":"user-pen","description":"FMA severity scenarios for XR-018 on UGC text-string verification, forbidden terms filtering, and letting users report other users' inappropriate content.","href":"/publishing/certification/fma/xr-018"},{"title":"XR022 Official Naming Standards","sidebarTitle":"FMA XR-022","icon":"font-awesome","description":"FMA severity scenarios for XR-022 Official Naming Standards, covering incorrect terms, controller iconography, competitor platform mentions, and XBOX Live.","href":"/publishing/certification/fma/xr-022"},{"title":"XR037 Dependencies on Content Packages","sidebarTitle":"FMA XR-037","icon":"boxes-stacked","description":"FMA severity scenarios for content package dependencies, covering save-game access after DLC deletion, dependencies between packages, and multiplayer DLC.","href":"/publishing/certification/fma/xr-037"},{"title":"XR045 XBOX network and Account Privileges","sidebarTitle":"FMA XR-045","icon":"key","description":"FMA severity scenarios for how titles respect XBOX network user privileges and XBOX Family settings, including UGC, multiplayer, and privilege messaging.","href":"/publishing/certification/fma/xr-045"},{"title":"XR046 Display Name and Gamerpic","sidebarTitle":"FMA XR-046","icon":"user","description":"FMA severity scenarios for showing a user's gamertag and gamerpic correctly, including all 15 characters, modern gamertag Unicode, and visibility areas.","href":"/publishing/certification/fma/xr-046"},{"title":"XR047 User-Profile Access","sidebarTitle":"FMA XR-047","icon":"id-card","description":"FMA severity scenarios for accessing another XBOX network user's gamercard from leaderboards and other areas where gamertags and display names appear.","href":"/publishing/certification/fma/xr-047"},{"title":"XR048 Profile Settings Usage","sidebarTitle":"FMA XR-048","icon":"gear","description":"FMA severity scenarios for reflecting gamertag and gamerpic changes made before boot, and for loading previously created save data after those changes.","href":"/publishing/certification/fma/xr-048"},{"title":"XR052 User State, Save Location, Roaming, and Dependencies","sidebarTitle":"FMA XR-052","icon":"floppy-disk","description":"FMA severity scenarios for user state and saves, covering sign-in and sign-out, user change while suspended, correct user association, and cloud roaming.","href":"/publishing/certification/fma/xr-052"},{"title":"XR055 Achievements and Gamerscore","sidebarTitle":"FMA XR-055","icon":"trophy","description":"FMA severity scenarios for achievements and gamerscore, covering early or delayed unlocks, offline unlocks, difficulty criteria, and unlock pacing.","href":"/publishing/certification/fma/xr-055"},{"title":"XR057 Unlocking Achievements","sidebarTitle":"FMA XR-057","icon":"trophy","description":"FMA severity scenarios for unlocking achievements defined by the base title, where users must not need to purchase additional in-title content or DLC.","href":"/publishing/certification/fma/xr-057"},{"title":"XR064 Joinable Game Sessions and Online Play","sidebarTitle":"FMA XR-064","icon":"door-open","description":"FMA severity scenarios for joinable game sessions, covering joins from the guide or the same game, in-game invitations, and non-joinable games.","href":"/publishing/certification/fma/xr-064"},{"title":"XR067 Maintaining Recently Played With Interactions","sidebarTitle":"FMA XR-067","icon":"circle-nodes","description":"FMA severity scenarios for populating the 'Recently played with' list in synchronous multiplayer titles and MMOs, including voice and text interactions.","href":"/publishing/certification/fma/xr-067"},{"title":"XR070 Friends List","sidebarTitle":"FMA XR-070","icon":"user-group","description":"FMA severity scenarios for friends lists, covering use of XBOX APIs, duplicate core contact lists, stored friends lists, and blended friends lists.","href":"/publishing/certification/fma/xr-070"},{"title":"XR074 Loss of Connectivity to XBOX and Partner Services","sidebarTitle":"FMA XR-074","icon":"wifi-slash","description":"FMA severity scenarios for losing connection to XBOX services, covering WAN and direct disconnection, suspend, reconnection, and pre-launch downtime.","href":"/publishing/certification/fma/xr-074"},{"title":"XR112 User and Controller at Initial Activation and Resume","sidebarTitle":"FMA XR-112","icon":"user-check","description":"FMA severity scenarios for establishing a user and controller at launch and resume, covering no signed-in user, the account picker, and profile change.","href":"/publishing/certification/fma/xr-112"},{"title":"XR115 Adding and Removing Users or Controllers in Gameplay","sidebarTitle":"FMA XR-115","icon":"gamepad","description":"FMA severity scenarios for adding users and removing controllers or users during gameplay, including powering off the XBOX controller mid-session.","href":"/publishing/certification/fma/xr-115"},{"title":"Beta/Game Preview Notification","sidebarTitle":"FMA XR-117","icon":"flask","description":"FMA severity scenarios for notifying users that a title is a beta or Game Preview, covering splash screen messaging, wording, and on-screen duration.","href":"/publishing/certification/fma/xr-117"},{"title":"XR130 XBOX Series X|S Generation","sidebarTitle":"FMA XR-130","icon":"server","description":"FMA severity scenarios for the XBOX Series X|S generation, covering save game roaming, online segmentation, and featured game modes across console types.","href":"/publishing/certification/fma/xr-130"},{"title":"XR132 Service Access Limitations","sidebarTitle":"FMA XR-132","icon":"gauge-high","description":"FMA severity scenarios for service access limitations, covering titles that exceed the sustain limit where rate limiting applies and Legacy exemptions.","href":"/publishing/certification/fma/xr-132"}]},{"group":"XBOX Requirements and Policies Supporting Content","icon":"clipboard-list","pages":[{"title":"XBOX Requirements and Policies supporting content","sidebarTitle":"Supporting content","icon":"folder-tree","description":"Supporting content for individual XBOX Requirements, from XR-001 Title Stability through XR-074 connectivity loss, to help prepare your game for release.","href":"/publishing/certification/xr/overview"},{"title":"XR-001 Title stability","sidebarTitle":"XR-001 Title stability","icon":"shield-halved","description":"Titles must be compliant with Windows Store policy regarding Title Stability.","href":"/publishing/certification/xr/xr-001"},{"title":"XR-003 Title quality for submission","sidebarTitle":"XR-003 Title quality","icon":"broom","description":"Titles must be functionally complete, testable and meet XBOX quality standards when they are submitted for certification.","href":"/publishing/certification/xr/xr-003"},{"title":"XR-013 Linking Microsoft accounts with publisher accounts","sidebarTitle":"XR-013 Account linking","icon":"link","description":"Describes the XBOX requirements for linking Microsoft accounts with publisher accounts.","href":"/publishing/certification/xr/xr-013"},{"title":"XR-014 Player data and personal information","sidebarTitle":"XR-014 Personal information","icon":"user-shield","description":"Game publishers are solely responsible for collecting and processing end user data in accordance with applicable law especially when the user is a child.","href":"/publishing/certification/xr/xr-014"},{"title":"XR-015 Managing player communication","sidebarTitle":"XR-015 Communications","icon":"comment-slash","description":"Titles must not allow communication over the XBOX network when the user’s privacy settings do not allow it.","href":"/publishing/certification/xr/xr-015"},{"title":"XR-018: User generated content","sidebarTitle":"XR-018 UGC","icon":"user-pen","description":"Rules for user generated content (UGC) and mods, including reporting, proactive detection of harmful text, content guidelines, and respecting UGC settings.","href":"/publishing/certification/xr/xr-018"},{"title":"XR-037 Dependencies on content packages","sidebarTitle":"XR-037 Content dependencies","icon":"boxes-stacked","description":"Purchase of add-on content (durable or consumable) must not be required for users to complete any of the main features or content of the base game.","href":"/publishing/certification/xr/xr-037"},{"title":"XR-045 XBOX network and account privileges","sidebarTitle":"XR-045 Privileges","icon":"key","description":"Titles must check the XBOX network service for privileges to complete certain actions on the XBOX network service or in a title experience.","href":"/publishing/certification/xr/xr-045"},{"title":"XR-046 Display name and gamerpic","sidebarTitle":"XR-046 Display name","icon":"id-badge","description":"How titles must display the modern or classic gamertag as the primary display name on XBOX consoles, plus the 046-01 test case for gamertags and gamerpics.","href":"/publishing/certification/xr/xr-046"},{"title":"XR-047 User profile access","sidebarTitle":"XR-047 Profile access","icon":"id-card","description":"Titles must give users the option to access gamercards for any other XBOX users encountered within the title.","href":"/publishing/certification/xr/xr-047"},{"title":"XR-048 Profile settings usage","sidebarTitle":"XR-048 Profile settings","icon":"user-gear","description":"Titles must not store XBOX network profile data like gamertags beyond a local cache for disconnection. Covers exemptions and the 048-01 certification test.","href":"/publishing/certification/xr/xr-048"},{"title":"XR-052 User state, title-save location, and roaming","sidebarTitle":"XR-052 User state \u0026 roaming","icon":"cloud-arrow-up","description":"How titles associate saved progress and rewards with the correct user, handle user changes, and roam game saves across XBOX consoles and PCs by SDK.","href":"/publishing/certification/xr/xr-052"},{"title":"XR-057 Unlocking achievements","sidebarTitle":"XR-057 Achievements unlock","icon":"trophy","description":"Achievements in the base title must be earnable without extra purchases and unlocked through gameplay, not via cheat codes, real-money purchases, or menus.","href":"/publishing/certification/xr/xr-057"},{"title":"XR-064 Joinable game sessions and online play","sidebarTitle":"XR-064 Joinable sessions","icon":"users-viewfinder","description":"How titles advertise joinable multiplayer sessions with Multiplayer Activity (MPA), handle join failures, and support XBOX shell and in-game invitations.","href":"/publishing/certification/xr/xr-064"},{"title":"XR-067 Maintaining Recently Played With interactions","sidebarTitle":"XR-067 Session state","icon":"circle-nodes","description":"How online multiplayer titles record player interactions with MPA Recent Players or legacy MPSD so players appear in the Recently Played With list.","href":"/publishing/certification/xr/xr-067"},{"title":"XR-074 Loss of connectivity to XBOX and partner services","sidebarTitle":"XR-074 Connectivity loss","icon":"plug-circle-xmark","description":"How titles handle lost connectivity to XBOX and partner services, including retry policies, user-friendly error messages, and the RequireXboxLive flag.","href":"/publishing/certification/xr/xr-074"},{"title":"XR-112 Establishing a user and controller during initial activation and resume","sidebarTitle":"XR-112 Activation","icon":"user-check","description":"Titles must establish one or more active users to function as the primary user or users in the title, and handle the user or users when resuming from suspend, sleep, or hibernate.","href":"/publishing/certification/xr/xr-112"},{"title":"XR-115 Addition and removal of users or controllers during gameplay","sidebarTitle":"XR-115 User \u0026 controller changes","icon":"user-plus","description":"Titles which support multiple users must respond to the addition and removal of users or scenarios in which an active player has no controller assigned or a controller loss during gameplay.","href":"/publishing/certification/xr/xr-115"},{"title":"XR-130 XBOX Series X|S generation","sidebarTitle":"XR-130 Console families","icon":"gamepad","description":"All game titles targeting a console generation must support the entire family of devices for that generation.","href":"/publishing/certification/xr/xr-130"},{"title":"XR-132 Service access limitations","sidebarTitle":"XR-132 Service limits","icon":"gauge","description":"XR-132 Service Access Limitations","href":"/publishing/certification/xr/xr-132"}]}]},{"group":"XBOX Certification submissions","icon":"file-check","pages":[{"title":"Certification (Certify)","sidebarTitle":"Certification","description":"Get your product certified in Partner Center using the Certify workflow.","href":"/publishing/game-publishing/concepts/certification/certification-overview"},{"title":"Certification step-by-step guide","sidebarTitle":"Step-by-step guide","icon":"list-ol","description":"A step-by-step guide to the Certification workflow from submitting a game to final reporting.","href":"/publishing/game-publishing/concepts/certification/certification-guide"},{"title":"Certification console BVT guide","sidebarTitle":"Console BVT guide","icon":"gamepad","description":"Describes streamlining and preparing developers for successful BVT processing by identifying common pain points.","href":"/publishing/game-publishing/concepts/certification/certification-console-bvt-guide"},{"title":"Certification PC BVT guide","sidebarTitle":"PC BVT guide","icon":"desktop","description":"A step-by-step guide to Xbox Certification PC BVTs.","href":"/publishing/game-publishing/concepts/certification/certification-pc-bvt-guide"},{"title":"Certification optional submissions","sidebarTitle":"Optional submissions","icon":"circle-plus","description":"Certification optional submissions guide.","href":"/publishing/game-publishing/concepts/certification/certification-optional-submissions"},{"title":"XBOX Rapid Updates","sidebarTitle":"XBOX Rapid Updates","icon":"bolt","description":"The XBOX Rapid Updates program is designed to help games that have a proven record of certification results.","href":"/publishing/game-publishing/concepts/certification/xbox-rapid-updates"},{"title":"Certification Paid Services Program","sidebarTitle":"Paid Services","icon":"hand-holding-dollar","description":"Describes pricing for XBOX Certification Paid Services Program","href":"/publishing/game-publishing/concepts/certification/certification-paid-services"},{"title":"Media validation test steps","sidebarTitle":"Media validation","icon":"compact-disc","description":"Describes the media validation test steps required before the title can release.","href":"/publishing/game-publishing/concepts/certification/certification-media-validation-test-steps"},{"title":"Supplemental info","sidebarTitle":"Supplemental info","icon":"circle-plus","description":"Explains the supplemental info pages in Partner Center.","href":"/publishing/game-publishing/concepts/certification/certification-supplemental-info"}]},{"group":"XBOX resources and terminology","icon":"book","pages":[{"title":"Glossary","description":"Common terms, acronyms, and initialisms used across the Microsoft gaming ecosystem and the XBOX game publishing guide, from AR and BVT to XR.","icon":"book-open","href":"/publishing/game-publishing/glossary"},{"title":"Branding and marketing assets","description":"Access XBOX brand assets: advertising guidelines, logos, hardware imagery, video mnemonics, and packaging templates from the Game Dev Portal.","icon":"palette","href":"/publishing/game-publishing/resources/managed-support/how-to-access-branding-and-marketing-assets"},{"title":"Overview microsoft representatives and contacts","href":"/publishing/game-publishing/resources/managed-support/overview-microsoft-representatives-and-contacts"},{"title":"Licensed Test Vendors","description":"List of third-party test vendors licensed by Microsoft to work with XBOX development tools, the XBOX GDK software, and XBOX development hardware.","icon":"user-tie","href":"/publishing/game-publishing/resources/third-party-authorized-test-vendors"},{"title":"Useful links","description":"Curated list of useful links for XBOX managed creators, including ID@XBOX registration, the XBOX Publisher Guide, and XBOX game publishing tools.","icon":"link","href":"/publishing/game-publishing/resources/useful-links"}]},{"group":"Partner Center how-to guides","icon":"directions","pages":[{"title":"How to create new products","description":"Create Games, Game Demos, Game Bundles, and add-on products in Partner Center from the Apps and Games overview and from a Game product's add-ons menu.","sidebarTitle":"Create new products","icon":"plus","href":"/publishing/game-publishing/how-to/how-to-create-new-products"},{"title":"How to add and edit products in a Bundle","description":"Add or edit products in a Game Bundle or Add-on Bundle in Partner Center, including bundle composition changes and configuration updates.","sidebarTitle":"Add/edit bundle products","icon":"pen","href":"/publishing/game-publishing/how-to/how-to-addeditproductstobundle"},{"title":"How to delist items from the Store","description":"Delist products from the Microsoft Store in all markets or specific markets, and learn how direct PDP links behave for delisted XBOX products.","sidebarTitle":"Delist from Store","icon":"eye-slash","href":"/publishing/game-publishing/how-to/how-to-delist-from-retail"},{"title":"Create and manage development sandboxes","description":"Create and manage XBOX development sandboxes in Partner Center to test packages, services, and Store experiences before your retail release.","sidebarTitle":"Manage sandboxes","icon":"box-archive","href":"/publishing/game-publishing/how-to/how-to-create-and-manage-sandboxes"},{"title":"Create and manage XBOX test accounts","description":"Create and manage XBOX test accounts in Partner Center to sign in to development sandboxes and validate builds, pricing, and Store metadata.","sidebarTitle":"Manage test accounts","icon":"user-gear","href":"/publishing/game-publishing/how-to/how-to-create-and-manage-test-accounts"},{"title":"Manage Free to Use scenarios","description":"Grant selected users a time-boxed Free to Use entitlement to a game, bundle, demo, or durable so they can install without a purchase transaction.","icon":"hand-holding-heart","href":"/publishing/game-publishing/how-to/how-to-freetouse"},{"title":"How to make price changes","description":"Submit immediate or scheduled permanent price changes to base and market-specific prices in Partner Center, and understand the price approval process.","sidebarTitle":"Price changes","icon":"tag","href":"/publishing/game-publishing/how-to/how-to-priceupdate"},{"title":"How to set age ratings manually","description":"Manually configure age ratings in Partner Center for games distributed on physical discs or when using ratings obtained directly from a board.","sidebarTitle":"Set age ratings manually","icon":"shield-check","href":"/publishing/game-publishing/how-to/how-to-set-age-ratings"},{"group":"Package management","icon":"box-open","pages":[{"title":"Advanced settings for packages","description":"Manage advanced settings on the Packages page in Partner Center, including device family availability and pre-order placeholder package sizes.","icon":"sliders","href":"/publishing/game-publishing/how-to/how-to-manage-advanced-settings-for-packages"},{"title":"How to configure package flights for game packages","description":"Create package flights for XVC and MSIXVC game packages, and distribute them to known XBOX device groups or known user groups for testing.","icon":"plane","href":"/publishing/game-publishing/how-to/how-to-package-flights-for-xvc-packages"},{"title":"How to rollback a game to a previous package submission","description":"Roll back an XBOX game to a previously published retail GA package submission in Partner Center without re-uploading or recertifying builds.","icon":"rotate-left","href":"/publishing/game-publishing/how-to/how-to-package-rollback"}]},{"group":"Configure visible products","icon":"eye","pages":[{"title":"Configure visible-only products in the Microsoft Store","description":"Configure visible-only products in the Microsoft Store to display a PDP for marketing and wishlisting without making the product purchasable.","href":"/publishing/game-publishing/how-to/how-to-visible-only-pdp"},{"title":"Make a product visible and purchasable in Microsoft Store","description":"Detailed instructions for configuring the pricing and availability page to make a product visible and purchasable in the Microsoft Store.","href":"/publishing/game-publishing/how-to/how-to-visible-release"}]},{"group":"Configure hidden products","icon":"eye-slash","pages":[{"title":"Configure add-ons for in-game store-only availability","description":"Configure Durable and Consumable add-ons that skip a Microsoft Store listing and are sold only in-game using the XStore APIs from the XBOX GDK.","icon":"shop","href":"/publishing/game-publishing/how-to/how-to-does-not-have-store-listing"},{"title":"How to configure a product to be hidden and purchasable","description":"Configure a hidden but purchasable product that stays out of Store search yet remains accessible and buyable through direct links or in-game.","icon":"eye-slash","href":"/publishing/game-publishing/how-to/how-to-hiddenrelease"},{"title":"Create a hidden product redeemable only by promo code","description":"Configure a hidden token-only product in Partner Center that customers can acquire only by redeeming a promotional code or 5x5 token.","icon":"ticket","href":"/publishing/game-publishing/how-to/how-to-hiddentokenonly"}]},{"group":"Trials","icon":"hourglass","pages":[{"title":"Set up a usage-limited trial","description":"Configure a usage-limited free trial that lets customers play your game for a defined number of minutes or hours before prompting them to buy the full title.","icon":"gauge","href":"/publishing/game-publishing/how-to/how-to-create-usage-limited-free-trials"},{"title":"Set up a curated trial","description":"Set up a curated trial where your game itself gates access — by level, feature, or in-game timer — rather than the Store limiting play by calendar time.","icon":"hand-pointer","href":"/publishing/game-publishing/how-to/how-to-curated-trial"},{"title":"Set up a time-limited trial","description":"Configure a time-limited trial that expires after a set number of calendar days from download, regardless of how long the customer actually plays.","icon":"clock","href":"/publishing/game-publishing/how-to/how-to-timedtrial"}]},{"group":"Pre-orders","icon":"cart-plus","pages":[{"title":"How to configure a pre-order early access bundle","description":"Configure a pre-order early access Game Bundle so purchasers can use included products before the release date as a pre-order incentive.","icon":"unlock-keyhole","href":"/publishing/game-publishing/how-to/how-to-create-preorder-early-access-bundle"},{"title":"How to configure a hidden pre-order","description":"Configure hidden pre-order products on the Pricing and Availability page in Partner Center, including how direct links can still expose them.","icon":"eye-slash","href":"/publishing/game-publishing/how-to/how-to-create-preorder-hidden-products"},{"title":"Create a pre-order unlock Bundle","description":"Create a hidden pre-order unlock Game Bundle redeemable by promo code, so reviewers or testers can use pre-order products before release.","icon":"key","href":"/publishing/game-publishing/how-to/how-to-create-preorder-unlock-bundle"},{"title":"How to configure a pre-order bundle","description":"Configure a visible pre-order Game Bundle in Partner Center, including bundles that remain purchasable or expire after the pre-order period ends.","icon":"gift","href":"/publishing/game-publishing/how-to/how-to-create-preorder-visible-bundle"},{"title":"How to configure a Game or Durable pre-order","description":"Configure a visible pre-order for a Game or Durable product in Partner Center that remains purchasable after the pre-order period ends.","icon":"gamepad","href":"/publishing/game-publishing/how-to/how-to-create-preorder-visible-product"},{"title":"How to configure a pre-order","description":"Use the Pricing and Availability page in Partner Center to configure Visibility and Schedule options for pre-order products on the Microsoft Store.","icon":"cart-plus","href":"/publishing/game-publishing/how-to/how-to-preorder"}]},{"group":"Discs","icon":"compact-disc","pages":[{"title":"Request and manage discs","description":"Submit disc requests, order test discs, approve test discs, and create a Bill of Materials (BOM) for physical XBOX releases in Partner Center.","icon":"compact-disc","href":"/publishing/game-publishing/how-to/how-to-request-and-manage-discs"},{"title":"How to submit royalty tiers","href":"/publishing/game-publishing/how-to/how-to-submit-royalty-tiers"}]},{"group":"Configure XBOX services (Data Platform 2013)","icon":"database","pages":[{"title":"Configure achievements in Partner Center","description":"Add and change XBOX Live Achievements 2013 in the Partner Center service configuration, including stat-triggered unlock rules for your title.","icon":"trophy","href":"/publishing/game-publishing/how-to/data-platform-2013/how-to-configure-achievements-2013"},{"title":"Configure challenges in Partner Center","description":"Add and change time-limited XBOX Challenges in Partner Center service configuration using data platform 2013 stat rules and unlock logic.","icon":"flag","href":"/publishing/game-publishing/how-to/data-platform-2013/how-to-configure-challenges"},{"title":"Configure XBOX data platform 2013 in Partner Center","description":"Configure the XBOX Live data platform 2013 service in Partner Center, including events, stats, achievements, leaderboards, and challenges.","icon":"database","href":"/publishing/game-publishing/how-to/data-platform-2013/how-to-configure-data-platform-2013"},{"title":"Configure XBOX events in Partner Center","description":"Add and change XBOX events in Partner Center using data platform 2013 to send gameplay data that updates stats, leaderboards, and achievements.","icon":"calendar-check","href":"/publishing/game-publishing/how-to/data-platform-2013/how-to-configure-events-2013"},{"title":"Configure featured stats in Partner Center","description":"Configure up to 20 featured stats for your XBOX title in Partner Center to highlight player progress in the activity hub and player comparisons.","icon":"star","href":"/publishing/game-publishing/how-to/data-platform-2013/how-to-configure-featured-stats"},{"title":"Configure leaderboards in Partner Center","description":"Configure global leaderboards for your XBOX title in Partner Center using data platform 2013, including storing and retrieving score data.","icon":"ranking-star","href":"/publishing/game-publishing/how-to/data-platform-2013/how-to-configure-leaderboards-2013"},{"title":"Configure stat change notifications in Partner Center","description":"Subscribe to stat change notifications in Partner Center using the Real-Time Activity (RTA) service to react when player stats update in-game.","icon":"bell","href":"/publishing/game-publishing/how-to/data-platform-2013/how-to-configure-stat-notifications"},{"title":"Configure XBOX stats and stat rules in Partner Center","description":"Add and change stat rules in Partner Center for data platform 2013, so player stats update when your title sends events to XBOX services.","icon":"chart-column","href":"/publishing/game-publishing/how-to/data-platform-2013/how-to-configure-stats"},{"title":"Download the Events Manifest file from Partner Center","description":"Download the Events Manifest XML file from Partner Center for a selected sandbox, and use it with the XBOX Common Events Tool to generate headers.","icon":"download","href":"/publishing/game-publishing/how-to/data-platform-2013/how-to-download-events-manifest"}]},{"title":"Create a separate Store listing for an add-on","description":"Walkthrough for configuring a Microsoft Store add-on with its own dedicated product detail page instead of using the parent game's listing.","href":"/publishing/game-publishing/how-to/how-to-create-a-separate-store-listing-for-an-add-on"}]},{"group":"Microsoft Store Policies and Code of Conduct","icon":"shield-check","pages":[{"title":"Microsoft Store product ranking and marketing disclosure","description":"Read Microsoft's disclosure statement covering how products are ranked, placed, and marketed on the Microsoft Store for developers and publishers.","sidebarTitle":"Product Ranking \u0026 Disclosure","icon":"ranking-star","href":"/publishing/game-publishing/disclosure-policy"},{"title":"Microsoft Store Developer Code of Conduct","description":"Review the Microsoft Store Developer Code of Conduct that outlines expected behavior, standards, and responsibilities for developers publishing on the Store.","icon":"handshake","href":"/publishing/game-publishing/store-developer-code-of-conduct"},{"title":"Microsoft Store Policies","description":"Full Microsoft Store Policies that games and apps must meet to be certified, published, and listed on the Microsoft Store across Windows and XBOX.","sidebarTitle":"Store Policies","icon":"scale-balanced","href":"/publishing/game-publishing/store-policies"},{"title":"Microsoft Store Policies and Code of Conduct","description":"Overview of Microsoft Store submission policies and developer Code of Conduct that apply to games and apps published to the Microsoft Store.","sidebarTitle":"Overview","icon":"circle-info","href":"/publishing/game-publishing/store-policies-and-code-of-conduct-overview"},{"title":"Microsoft Store Policies change history","description":"Track updates and revisions to the Microsoft Store Policies over time, including dates and summaries of the changes affecting Store submissions.","sidebarTitle":"Change history","icon":"clock-rotate-left","href":"/publishing/game-publishing/store-policies-change-history"}]},{"group":"Includes (reusable snippets)","hidden":true,"pages":[{"title":"Both apps and games share the same info","description":"Reusable notice explaining that apps and games share the same Partner Center instructions for this feature, so follow the shared guidance here.","href":"/publishing/game-publishing/includes/both-apps-and-games-share-same-info"},{"title":"XBOX creators only feature","description":"Reusable notice indicating a feature is available only to registered XBOX creators enrolled in an XBOX developer program such as ID@XBOX.","href":"/publishing/game-publishing/includes/managed-creators-only-feature"},{"title":"Games have specific info","description":"Reusable notice explaining that apps and games share most instructions here, but XBOX games have specific sections and options to follow.","href":"/publishing/game-publishing/includes/same-as-apps-with-specific-info"},{"title":"Select add-on tab","description":"Reusable warning that reminds authors to select the add-on tab for games when following shared Partner Center instructions for apps and games.","href":"/publishing/game-publishing/includes/select-add-on-tab"},{"title":"Select MSIX tab","description":"Reusable warning telling readers to follow the MSIX app instructions and select the MSIX tab when configuring a game in Partner Center.","href":"/publishing/game-publishing/includes/select-msix-tab"},{"title":"Use only MSIXVC instructions","description":"Reusable notice reminding you that Microsoft Store games must be submitted in the .MSIXVC format and to follow game-specific instructions here.","href":"/publishing/game-publishing/includes/use-only-msixvc"},{"title":"Web scraping disclaimer","description":"Reusable notice about web scraping risk before the first scheduled date, and how Private Audience or Disable Store Presence can protect PDPs.","href":"/publishing/game-publishing/includes/web-scraping-disclaimer"}]}]},{"tab":"GDK APIs","groups":[{"group":"(all) API references","pages":[{"title":"API reference","description":"API reference for the Microsoft Game Development Kit (GDK): audio, chat, graphics, input, networking, system, tools, XBOX services, and error codes.","sidebarTitle":"API reference","href":"/reference/gc-reference-toc"}]},{"group":"Error codes","pages":[{"title":"Error codes","sidebarTitle":"Error codes","description":"GDK error code constants declared in XGameErr.h, organized by subsystem with HRESULT values sorted numerically for lookup by XBOX and PC developers.","icon":"circle-exclamation","href":"/reference/errorcodes"}]},{"group":"Audio API reference","pages":[{"title":"Audio API reference","description":"Audio API reference for the Microsoft Game Development Kit (GDK), covering AcpHal, APU, AudioStateMonitor, XAudio2, XDSP, and related audio subsystems.","sidebarTitle":"Audio API reference","href":"/reference/audio/gc-reference-audio-toc"},{"group":"AcpHal","pages":[{"title":"AcpHal","description":"AcpHal","sidebarTitle":"AcpHal","href":"/reference/audio/acphal/acphal_members"},{"group":"Enums","pages":[{"title":"ACP_COMMAND_TYPE","description":"ACP_COMMAND_TYPE","sidebarTitle":"ACP_COMMAND_TYPE","href":"/reference/audio/acphal/enums/acp_command_type"},{"title":"ACP_FLOWGRAPH_TERMINATED_REASON","description":"ACP_FLOWGRAPH_TERMINATED_REASON","sidebarTitle":"ACP_FLOWGRAPH_TERMINATED_REASON","href":"/reference/audio/acphal/enums/acp_flowgraph_terminated_reason"},{"title":"ACP_MESSAGE_TYPE","description":"ACP_MESSAGE_TYPE","sidebarTitle":"ACP_MESSAGE_TYPE","href":"/reference/audio/acphal/enums/acp_message_type"},{"title":"ACP_SUBMIT_COMMAND_TYPE","description":"ACP_SUBMIT_COMMAND_TYPE","sidebarTitle":"ACP_SUBMIT_COMMAND_TYPE","href":"/reference/audio/acphal/enums/acp_submit_command_type"}]},{"group":"Functions","pages":[{"title":"AcpHalAllocateShapeContexts","description":"AcpHalAllocateShapeContexts","sidebarTitle":"AcpHalAllocateShapeContexts","href":"/reference/audio/acphal/functions/acphalallocateshapecontexts"},{"title":"AcpHalCreate","description":"AcpHalCreate","sidebarTitle":"AcpHalCreate","href":"/reference/audio/acphal/functions/acphalcreate"},{"title":"AcpHalReleaseShapeContexts","description":"AcpHalReleaseShapeContexts","sidebarTitle":"AcpHalReleaseShapeContexts","href":"/reference/audio/acphal/functions/acphalreleaseshapecontexts"}]},{"group":"Interfaces","pages":[{"group":"IAcpHal","pages":[{"title":"IAcpHal","description":"IAcpHal","sidebarTitle":"IAcpHal","href":"/reference/audio/acphal/interfaces/IAcpHal/iacphal"},{"group":"Methods","pages":[{"title":"IAcpHal::Connect","description":"IAcpHal::Connect","sidebarTitle":"IAcpHal::Connect","href":"/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_connect"},{"title":"IAcpHal::Disconnect","description":"IAcpHal::Disconnect","sidebarTitle":"IAcpHal::Disconnect","href":"/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_disconnect"},{"title":"IAcpHal::GetNumMessages","description":"IAcpHal::GetNumMessages","sidebarTitle":"IAcpHal::GetNumMessages","href":"/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_getnummessages"},{"title":"IAcpHal::PopMessage","description":"IAcpHal::PopMessage","sidebarTitle":"IAcpHal::PopMessage","href":"/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_popmessage"},{"title":"IAcpHal::SubmitCommand","description":"IAcpHal::SubmitCommand","sidebarTitle":"IAcpHal::SubmitCommand","href":"/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_submitcommand"}]}]}]},{"group":"Structs","pages":[{"title":"ACP_COMMAND_ENABLE_OR_DISABLE_XMA_CONTEXT","description":"ACP_COMMAND_ENABLE_OR_DISABLE_XMA_CONTEXT","sidebarTitle":"ACP_COMMAND_ENABLE_OR_DISABLE_XMA_CONTEXT","href":"/reference/audio/acphal/structs/acp_command_enable_or_disable_xma_context"},{"title":"ACP_COMMAND_ENABLE_OR_DISABLE_XMA_CONTEXTS","description":"ACP_COMMAND_ENABLE_OR_DISABLE_XMA_CONTEXTS","sidebarTitle":"ACP_COMMAND_ENABLE_OR_DISABLE_XMA_CONTEXTS","href":"/reference/audio/acphal/structs/acp_command_enable_or_disable_xma_contexts"},{"title":"ACP_COMMAND_INCREMENT_DMA_POINTER","description":"ACP_COMMAND_INCREMENT_DMA_POINTER","sidebarTitle":"ACP_COMMAND_INCREMENT_DMA_POINTER","href":"/reference/audio/acphal/structs/acp_command_increment_dma_pointer"},{"title":"ACP_COMMAND_INCREMENT_PCM_WRITE_POINTER","description":"ACP_COMMAND_INCREMENT_PCM_WRITE_POINTER","sidebarTitle":"ACP_COMMAND_INCREMENT_PCM_WRITE_POINTER","href":"/reference/audio/acphal/structs/acp_command_increment_pcm_write_pointer"},{"title":"ACP_COMMAND_INCREMENT_XMA_WRITE_BUFFER_OFFSET_READ","description":"ACP_COMMAND_INCREMENT_XMA_WRITE_BUFFER_OFFSET_READ","sidebarTitle":"ACP_COMMAND_INCREMENT_XMA_WRITE_BUFFER_OFFSET_READ","href":"/reference/audio/acphal/structs/acp_command_increment_xma_write_buffer_offset_read"},{"title":"ACP_COMMAND_LOAD_SHAPE_FLOWGRAPH","description":"ACP_COMMAND_LOAD_SHAPE_FLOWGRAPH","sidebarTitle":"ACP_COMMAND_LOAD_SHAPE_FLOWGRAPH","href":"/reference/audio/acphal/structs/acp_command_load_shape_flowgraph"},{"title":"ACP_COMMAND_MESSAGE","description":"ACP_COMMAND_MESSAGE","sidebarTitle":"ACP_COMMAND_MESSAGE","href":"/reference/audio/acphal/structs/acp_command_message"},{"title":"ACP_COMMAND_UPDATE_ALL_CONTEXTS","description":"ACP_COMMAND_UPDATE_ALL_CONTEXTS","sidebarTitle":"ACP_COMMAND_UPDATE_ALL_CONTEXTS","href":"/reference/audio/acphal/structs/acp_command_update_all_contexts"},{"title":"ACP_COMMAND_UPDATE_CONTEXTS","description":"ACP_COMMAND_UPDATE_CONTEXTS","sidebarTitle":"ACP_COMMAND_UPDATE_CONTEXTS","href":"/reference/audio/acphal/structs/acp_command_update_contexts"},{"title":"ACP_COMMAND_UPDATE_DMA_CONTEXT","description":"ACP_COMMAND_UPDATE_DMA_CONTEXT","sidebarTitle":"ACP_COMMAND_UPDATE_DMA_CONTEXT","href":"/reference/audio/acphal/structs/acp_command_update_dma_context"},{"title":"ACP_COMMAND_UPDATE_DMA_READ_CONTEXT_ENTRY","description":"ACP_COMMAND_UPDATE_DMA_READ_CONTEXT_ENTRY","sidebarTitle":"ACP_COMMAND_UPDATE_DMA_READ_CONTEXT_ENTRY","href":"/reference/audio/acphal/structs/acp_command_update_dma_read_context_entry"},{"title":"ACP_COMMAND_UPDATE_DMA_WRITE_CONTEXT_ENTRY","description":"ACP_COMMAND_UPDATE_DMA_WRITE_CONTEXT_ENTRY","sidebarTitle":"ACP_COMMAND_UPDATE_DMA_WRITE_CONTEXT_ENTRY","href":"/reference/audio/acphal/structs/acp_command_update_dma_write_context_entry"},{"title":"ACP_COMMAND_UPDATE_EQCOMP_CONTEXT","description":"ACP_COMMAND_UPDATE_EQCOMP_CONTEXT","sidebarTitle":"ACP_COMMAND_UPDATE_EQCOMP_CONTEXT","href":"/reference/audio/acphal/structs/acp_command_update_eqcomp_context"},{"title":"ACP_COMMAND_UPDATE_EQCOMP_CONTEXT_ENTRY","description":"ACP_COMMAND_UPDATE_EQCOMP_CONTEXT_ENTRY","sidebarTitle":"ACP_COMMAND_UPDATE_EQCOMP_CONTEXT_ENTRY","href":"/reference/audio/acphal/structs/acp_command_update_eqcomp_context_entry"},{"title":"ACP_COMMAND_UPDATE_FILTVOL_CONTEXT","description":"ACP_COMMAND_UPDATE_FILTVOL_CONTEXT","sidebarTitle":"ACP_COMMAND_UPDATE_FILTVOL_CONTEXT","href":"/reference/audio/acphal/structs/acp_command_update_filtvol_context"},{"title":"ACP_COMMAND_UPDATE_FILTVOL_CONTEXT_ENTRY","description":"ACP_COMMAND_UPDATE_FILTVOL_CONTEXT_ENTRY","sidebarTitle":"ACP_COMMAND_UPDATE_FILTVOL_CONTEXT_ENTRY","href":"/reference/audio/acphal/structs/acp_command_update_filtvol_context_entry"},{"title":"ACP_COMMAND_UPDATE_PCM_CONTEXT","description":"ACP_COMMAND_UPDATE_PCM_CONTEXT","sidebarTitle":"ACP_COMMAND_UPDATE_PCM_CONTEXT","href":"/reference/audio/acphal/structs/acp_command_update_pcm_context"},{"title":"ACP_COMMAND_UPDATE_PCM_CONTEXT_ENTRY","description":"ACP_COMMAND_UPDATE_PCM_CONTEXT_ENTRY","sidebarTitle":"ACP_COMMAND_UPDATE_PCM_CONTEXT_ENTRY","href":"/reference/audio/acphal/structs/acp_command_update_pcm_context_entry"},{"title":"ACP_COMMAND_UPDATE_SRC_CONTEXT","description":"ACP_COMMAND_UPDATE_SRC_CONTEXT","sidebarTitle":"ACP_COMMAND_UPDATE_SRC_CONTEXT","href":"/reference/audio/acphal/structs/acp_command_update_src_context"},{"title":"ACP_COMMAND_UPDATE_SRC_CONTEXT_ENTRY","description":"ACP_COMMAND_UPDATE_SRC_CONTEXT_ENTRY","sidebarTitle":"ACP_COMMAND_UPDATE_SRC_CONTEXT_ENTRY","href":"/reference/audio/acphal/structs/acp_command_update_src_context_entry"},{"title":"ACP_COMMAND_UPDATE_XMA_CONTEXT","description":"ACP_COMMAND_UPDATE_XMA_CONTEXT","sidebarTitle":"ACP_COMMAND_UPDATE_XMA_CONTEXT","href":"/reference/audio/acphal/structs/acp_command_update_xma_context"},{"title":"ACP_COMMAND_UPDATE_XMA_CONTEXT_ENTRY","description":"ACP_COMMAND_UPDATE_XMA_CONTEXT_ENTRY","sidebarTitle":"ACP_COMMAND_UPDATE_XMA_CONTEXT_ENTRY","href":"/reference/audio/acphal/structs/acp_command_update_xma_context_entry"},{"title":"ACP_COMMAND_UPDATE_XMA_READ_BUFFER","description":"ACP_COMMAND_UPDATE_XMA_READ_BUFFER","sidebarTitle":"ACP_COMMAND_UPDATE_XMA_READ_BUFFER","href":"/reference/audio/acphal/structs/acp_command_update_xma_read_buffer"},{"title":"ACP_MESSAGE","description":"ACP_MESSAGE","sidebarTitle":"ACP_MESSAGE","href":"/reference/audio/acphal/structs/acp_message"},{"title":"ACP_MESSAGE_AUDIO_FRAME_START","description":"ACP_MESSAGE_AUDIO_FRAME_START","sidebarTitle":"ACP_MESSAGE_AUDIO_FRAME_START","href":"/reference/audio/acphal/structs/acp_message_audio_frame_start"},{"title":"ACP_MESSAGE_COMMAND_COMPLETED","description":"ACP_MESSAGE_COMMAND_COMPLETED","sidebarTitle":"ACP_MESSAGE_COMMAND_COMPLETED","href":"/reference/audio/acphal/structs/acp_message_command_completed"},{"title":"ACP_MESSAGE_ERROR","description":"ACP_MESSAGE_ERROR","sidebarTitle":"ACP_MESSAGE_ERROR","href":"/reference/audio/acphal/structs/acp_message_error"},{"title":"ACP_MESSAGE_FLOWGRAPH_COMPLETED","description":"ACP_MESSAGE_FLOWGRAPH_COMPLETED","sidebarTitle":"ACP_MESSAGE_FLOWGRAPH_COMPLETED","href":"/reference/audio/acphal/structs/acp_message_flowgraph_completed"},{"title":"ACP_MESSAGE_FLOWGRAPH_TERMINATED","description":"ACP_MESSAGE_FLOWGRAPH_TERMINATED","sidebarTitle":"ACP_MESSAGE_FLOWGRAPH_TERMINATED","href":"/reference/audio/acphal/structs/acp_message_flowgraph_terminated"},{"title":"ACP_MESSAGE_SHAPE_COMMAND_BLOCKED","description":"ACP_MESSAGE_SHAPE_COMMAND_BLOCKED","sidebarTitle":"ACP_MESSAGE_SHAPE_COMMAND_BLOCKED","href":"/reference/audio/acphal/structs/acp_message_shape_command_blocked"},{"title":"SHAPE_CONTEXTS","description":"SHAPE_CONTEXTS","sidebarTitle":"SHAPE_CONTEXTS","href":"/reference/audio/acphal/structs/shape_contexts"},{"title":"SHARED_SHAPE_CONTEXTS","description":"SHARED_SHAPE_CONTEXTS","sidebarTitle":"SHARED_SHAPE_CONTEXTS","href":"/reference/audio/acphal/structs/shared_shape_contexts"}]}]},{"group":"APU (Audio Processing Unit)","pages":[{"title":"APU (Audio Processing Unit)","description":"APU (Audio Processing Unit)","sidebarTitle":"APU (Audio Processing Unit)","href":"/reference/audio/apu/apu_members"},{"group":"Functions","pages":[{"title":"ApuAlloc","description":"ApuAlloc","sidebarTitle":"ApuAlloc","href":"/reference/audio/apu/functions/apualloc"},{"title":"ApuCreateHeap","description":"ApuCreateHeap","sidebarTitle":"ApuCreateHeap","href":"/reference/audio/apu/functions/apucreateheap"},{"title":"ApuFree","description":"ApuFree","sidebarTitle":"ApuFree","href":"/reference/audio/apu/functions/apufree"},{"title":"ApuHeapGetState","description":"ApuHeapGetState","sidebarTitle":"ApuHeapGetState","href":"/reference/audio/apu/functions/apuheapgetstate"},{"title":"ApuIsVirtualAddressValid","description":"ApuIsVirtualAddressValid","sidebarTitle":"ApuIsVirtualAddressValid","href":"/reference/audio/apu/functions/apuisvirtualaddressvalid"},{"title":"ApuMapApuAddress","description":"ApuMapApuAddress","sidebarTitle":"ApuMapApuAddress","href":"/reference/audio/apu/functions/apumapapuaddress"},{"title":"ApuMapVirtualAddress","description":"ApuMapVirtualAddress","sidebarTitle":"ApuMapVirtualAddress","href":"/reference/audio/apu/functions/apumapvirtualaddress"}]},{"group":"Structs","pages":[{"title":"ApuHeapState","description":"ApuHeapState","sidebarTitle":"ApuHeapState","href":"/reference/audio/apu/structs/apuheapstate"}]}]},{"group":"AudioStateMonitor","pages":[{"title":"AudioStateMonitor","description":"AudioStateMonitor","sidebarTitle":"AudioStateMonitor","href":"/reference/audio/audiostatemonitor/audiostatemonitor_members"},{"title":"AudioStateMonitorRegistrationHandle","description":"AudioStateMonitorRegistrationHandle","sidebarTitle":"AudioStateMonitorRegistrationHandle","href":"/reference/audio/audiostatemonitor/types/audiostatemonitorregistrationhandle"},{"group":"Functions","pages":[{"title":"CreateCaptureAudioStateMonitor","description":"CreateCaptureAudioStateMonitor","sidebarTitle":"CreateCaptureAudioStateMonitor","href":"/reference/audio/audiostatemonitor/functions/createcaptureaudiostatemonitor"},{"title":"CreateCaptureAudioStateMonitorForCategory","description":"CreateCaptureAudioStateMonitorForCategory","sidebarTitle":"CreateCaptureAudioStateMonitorForCategory","href":"/reference/audio/audiostatemonitor/functions/createcaptureaudiostatemonitorforcategory"},{"title":"CreateCaptureAudioStateMonitorForCategoryAndDeviceId","description":"CreateCaptureAudioStateMonitorForCategoryAndDeviceId","sidebarTitle":"CreateCaptureAudioStateMonitorForCategoryAndDeviceId","href":"/reference/audio/audiostatemonitor/functions/createcaptureaudiostatemonitorforcategoryanddeviceid"},{"title":"CreateCaptureAudioStateMonitorForCategoryAndDeviceRole","description":"CreateCaptureAudioStateMonitorForCategoryAndDeviceRole","sidebarTitle":"CreateCaptureAudioStateMonitorForCategoryAndDeviceRole","href":"/reference/audio/audiostatemonitor/functions/createcaptureaudiostatemonitorforcategoryanddevicerole"},{"title":"CreateRenderAudioStateMonitor","description":"CreateRenderAudioStateMonitor","sidebarTitle":"CreateRenderAudioStateMonitor","href":"/reference/audio/audiostatemonitor/functions/createrenderaudiostatemonitor"},{"title":"CreateRenderAudioStateMonitorForCategory","description":"CreateRenderAudioStateMonitorForCategory","sidebarTitle":"CreateRenderAudioStateMonitorForCategory","href":"/reference/audio/audiostatemonitor/functions/createrenderaudiostatemonitorforcategory"},{"title":"CreateRenderAudioStateMonitorForCategoryAndDeviceId","description":"CreateRenderAudioStateMonitorForCategoryAndDeviceId","sidebarTitle":"CreateRenderAudioStateMonitorForCategoryAndDeviceId","href":"/reference/audio/audiostatemonitor/functions/createrenderaudiostatemonitorforcategoryanddeviceid"},{"title":"CreateRenderAudioStateMonitorForCategoryAndDeviceRole","description":"CreateRenderAudioStateMonitorForCategoryAndDeviceRole","sidebarTitle":"CreateRenderAudioStateMonitorForCategoryAndDeviceRole","href":"/reference/audio/audiostatemonitor/functions/createrenderaudiostatemonitorforcategoryanddevicerole"}]},{"group":"Enums","pages":[{"title":"AudioStateMonitorSoundLevel enumeration","description":"AudioStateMonitorSoundLevel enumeration","sidebarTitle":"AudioStateMonitorSoundLevel enumeration","href":"/reference/audio/audiostatemonitor/enums/audiostatemonitorsoundlevel"}]},{"group":"Interfaces","pages":[{"title":"IAudioStateMonitor interface","description":"IAudioStateMonitor interface","sidebarTitle":"IAudioStateMonitor interface","href":"/reference/audio/audiostatemonitor/interfaces/iaudiostatemonitor"},{"title":"IAudioStateMonitor::GetSoundLevel method","description":"IAudioStateMonitor::GetSoundLevel method","sidebarTitle":"IAudioStateMonitor::GetSoundLevel method","href":"/reference/audio/audiostatemonitor/interfaces/iaudiostatemonitor-getsoundlevel"},{"title":"IAudioStateMonitor::RegisterCallback method","description":"IAudioStateMonitor::RegisterCallback method","sidebarTitle":"IAudioStateMonitor::RegisterCallback method","href":"/reference/audio/audiostatemonitor/interfaces/iaudiostatemonitor-registercallback"},{"title":"IAudioStateMonitor::UnregisterCallback method","description":"IAudioStateMonitor::UnregisterCallback method","sidebarTitle":"IAudioStateMonitor::UnregisterCallback method","href":"/reference/audio/audiostatemonitor/interfaces/iaudiostatemonitor-unregistercallback"}]}]},{"group":"ShapeContexts","pages":[{"title":"ShapeContexts","description":"ShapeContexts","sidebarTitle":"ShapeContexts","href":"/reference/audio/shapecontexts/shapecontexts_members"},{"group":"Functions","pages":[{"title":"ShapePeakMagnitudeToDecibel","description":"ShapePeakMagnitudeToDecibel","sidebarTitle":"ShapePeakMagnitudeToDecibel","href":"/reference/audio/shapecontexts/functions/shapepeakmagnitudetodecibel"}]}]},{"group":"ShapeDmaContext","pages":[{"title":"ShapeDmaContext","description":"ShapeDmaContext","sidebarTitle":"ShapeDmaContext","href":"/reference/audio/shapedmacontext/shapedmacontext_members"},{"group":"Functions","pages":[{"title":"GetShapeDmaAudioBuffer","description":"GetShapeDmaAudioBuffer","sidebarTitle":"GetShapeDmaAudioBuffer","href":"/reference/audio/shapedmacontext/functions/getshapedmaaudiobuffer"},{"title":"GetShapeDmaBufferFull","description":"GetShapeDmaBufferFull","sidebarTitle":"GetShapeDmaBufferFull","href":"/reference/audio/shapedmacontext/functions/getshapedmabufferfull"},{"title":"GetShapeDmaBytesPerFrame","description":"GetShapeDmaBytesPerFrame","sidebarTitle":"GetShapeDmaBytesPerFrame","href":"/reference/audio/shapedmacontext/functions/getshapedmabytesperframe"},{"title":"GetShapeDmaChannel","description":"GetShapeDmaChannel","sidebarTitle":"GetShapeDmaChannel","href":"/reference/audio/shapedmacontext/functions/getshapedmachannel"},{"title":"GetShapeDmaFloatSamples","description":"GetShapeDmaFloatSamples","sidebarTitle":"GetShapeDmaFloatSamples","href":"/reference/audio/shapedmacontext/functions/getshapedmafloatsamples"},{"title":"GetShapeDmaFramesAvailable","description":"GetShapeDmaFramesAvailable","sidebarTitle":"GetShapeDmaFramesAvailable","href":"/reference/audio/shapedmacontext/functions/getshapedmaframesavailable"},{"title":"GetShapeDmaFramesFree","description":"GetShapeDmaFramesFree","sidebarTitle":"GetShapeDmaFramesFree","href":"/reference/audio/shapedmacontext/functions/getshapedmaframesfree"},{"title":"GetShapeDmaMixBufferPeakMagnitude","description":"GetShapeDmaMixBufferPeakMagnitude","sidebarTitle":"GetShapeDmaMixBufferPeakMagnitude","href":"/reference/audio/shapedmacontext/functions/getshapedmamixbufferpeakmagnitude"},{"title":"GetShapeDmaNumBytes","description":"GetShapeDmaNumBytes","sidebarTitle":"GetShapeDmaNumBytes","href":"/reference/audio/shapedmacontext/functions/getshapedmanumbytes"},{"title":"GetShapeDmaNumChannels","description":"GetShapeDmaNumChannels","sidebarTitle":"GetShapeDmaNumChannels","href":"/reference/audio/shapedmacontext/functions/getshapedmanumchannels"},{"title":"GetShapeDmaNumFrames","description":"GetShapeDmaNumFrames","sidebarTitle":"GetShapeDmaNumFrames","href":"/reference/audio/shapedmacontext/functions/getshapedmanumframes"},{"title":"GetShapeDmaPeakMagnitude","description":"GetShapeDmaPeakMagnitude","sidebarTitle":"GetShapeDmaPeakMagnitude","href":"/reference/audio/shapedmacontext/functions/getshapedmapeakmagnitude"},{"title":"GetShapeDmaReadPointer","description":"GetShapeDmaReadPointer","sidebarTitle":"GetShapeDmaReadPointer","href":"/reference/audio/shapedmacontext/functions/getshapedmareadpointer"},{"title":"GetShapeDmaReadWriteFull","description":"GetShapeDmaReadWriteFull","sidebarTitle":"GetShapeDmaReadWriteFull","href":"/reference/audio/shapedmacontext/functions/getshapedmareadwritefull"},{"title":"GetShapeDmaTimestamp","description":"GetShapeDmaTimestamp","sidebarTitle":"GetShapeDmaTimestamp","href":"/reference/audio/shapedmacontext/functions/getshapedmatimestamp"},{"title":"GetShapeDmaWritePointer","description":"GetShapeDmaWritePointer","sidebarTitle":"GetShapeDmaWritePointer","href":"/reference/audio/shapedmacontext/functions/getshapedmawritepointer"},{"title":"IncrementShapeDmaReadPointer","description":"IncrementShapeDmaReadPointer","sidebarTitle":"IncrementShapeDmaReadPointer","href":"/reference/audio/shapedmacontext/functions/incrementshapedmareadpointer"},{"title":"IncrementShapeDmaWritePointer","description":"IncrementShapeDmaWritePointer","sidebarTitle":"IncrementShapeDmaWritePointer","href":"/reference/audio/shapedmacontext/functions/incrementshapedmawritepointer"},{"title":"SetShapeDmaAudioBuffer function","description":"SetShapeDmaAudioBuffer function","sidebarTitle":"SetShapeDmaAudioBuffer function","href":"/reference/audio/shapedmacontext/functions/setshapedmaaudiobuffer"},{"title":"SetShapeDmaAudioBuffer","description":"SetShapeDmaAudioBuffer","sidebarTitle":"SetShapeDmaAudioBuffer","href":"/reference/audio/shapedmacontext/functions/setshapedmaaudiobuffer_2"},{"title":"SetShapeDmaBufferFull","description":"SetShapeDmaBufferFull","sidebarTitle":"SetShapeDmaBufferFull","href":"/reference/audio/shapedmacontext/functions/setshapedmabufferfull"},{"title":"SetShapeDmaChannel","description":"SetShapeDmaChannel","sidebarTitle":"SetShapeDmaChannel","href":"/reference/audio/shapedmacontext/functions/setshapedmachannel"},{"title":"SetShapeDmaFloatSamples","description":"SetShapeDmaFloatSamples","sidebarTitle":"SetShapeDmaFloatSamples","href":"/reference/audio/shapedmacontext/functions/setshapedmafloatsamples"},{"title":"SetShapeDmaNumChannels","description":"SetShapeDmaNumChannels","sidebarTitle":"SetShapeDmaNumChannels","href":"/reference/audio/shapedmacontext/functions/setshapedmanumchannels"},{"title":"SetShapeDmaNumFrames","description":"SetShapeDmaNumFrames","sidebarTitle":"SetShapeDmaNumFrames","href":"/reference/audio/shapedmacontext/functions/setshapedmanumframes"},{"title":"SetShapeDmaReadPointer","description":"SetShapeDmaReadPointer","sidebarTitle":"SetShapeDmaReadPointer","href":"/reference/audio/shapedmacontext/functions/setshapedmareadpointer"},{"title":"SetShapeDmaReadWriteFull","description":"SetShapeDmaReadWriteFull","sidebarTitle":"SetShapeDmaReadWriteFull","href":"/reference/audio/shapedmacontext/functions/setshapedmareadwritefull"},{"title":"SetShapeDmaWritePointer","description":"SetShapeDmaWritePointer","sidebarTitle":"SetShapeDmaWritePointer","href":"/reference/audio/shapedmacontext/functions/setshapedmawritepointer"}]},{"group":"Structs","pages":[{"title":"SHAPE_DMA_CONTEXT","description":"SHAPE_DMA_CONTEXT","sidebarTitle":"SHAPE_DMA_CONTEXT","href":"/reference/audio/shapedmacontext/structs/shape_dma_context"},{"title":"SHAPE_DMA_READ_WRITE_FULL","description":"SHAPE_DMA_READ_WRITE_FULL","sidebarTitle":"SHAPE_DMA_READ_WRITE_FULL","href":"/reference/audio/shapedmacontext/structs/shape_dma_read_write_full"}]}]},{"group":"ShapeEqCompContext","pages":[{"title":"ShapeEqCompContext","description":"ShapeEqCompContext","sidebarTitle":"ShapeEqCompContext","href":"/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members"},{"group":"Enums","pages":[{"title":"SHAPE_EQCOMP_COMPRESSOR_MODE","description":"SHAPE_EQCOMP_COMPRESSOR_MODE","sidebarTitle":"SHAPE_EQCOMP_COMPRESSOR_MODE","href":"/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_compressor_mode"},{"title":"SHAPE_EQCOMP_EXPAND_MODE","description":"SHAPE_EQCOMP_EXPAND_MODE","sidebarTitle":"SHAPE_EQCOMP_EXPAND_MODE","href":"/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_expand_mode"},{"title":"SHAPE_EQCOMP_FILTER_INDEX","description":"SHAPE_EQCOMP_FILTER_INDEX","sidebarTitle":"SHAPE_EQCOMP_FILTER_INDEX","href":"/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_filter_index"},{"title":"SHAPE_EQCOMP_LOG_GAIN","description":"SHAPE_EQCOMP_LOG_GAIN","sidebarTitle":"SHAPE_EQCOMP_LOG_GAIN","href":"/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_log_gain"},{"title":"SHAPE_EQCOMP_SIDECHAIN_MODE","description":"SHAPE_EQCOMP_SIDECHAIN_MODE","sidebarTitle":"SHAPE_EQCOMP_SIDECHAIN_MODE","href":"/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_sidechain_mode"}]},{"group":"Functions","pages":[{"title":"GetShapeEqCompAttack","description":"GetShapeEqCompAttack","sidebarTitle":"GetShapeEqCompAttack","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompattack"},{"title":"GetShapeEqCompCompressorMode","description":"GetShapeEqCompCompressorMode","sidebarTitle":"GetShapeEqCompCompressorMode","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompcompressormode"},{"title":"GetShapeEqCompDelayElement2","description":"GetShapeEqCompDelayElement2","sidebarTitle":"GetShapeEqCompDelayElement2","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompdelayelement2"},{"title":"GetShapeEqCompDelayElement3","description":"GetShapeEqCompDelayElement3","sidebarTitle":"GetShapeEqCompDelayElement3","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompdelayelement3"},{"title":"GetShapeEqCompDelayElement4","description":"GetShapeEqCompDelayElement4","sidebarTitle":"GetShapeEqCompDelayElement4","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompdelayelement4"},{"title":"GetShapeEqCompDelayElement5","description":"GetShapeEqCompDelayElement5","sidebarTitle":"GetShapeEqCompDelayElement5","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompdelayelement5"},{"title":"GetShapeEqCompDelayElement6","description":"GetShapeEqCompDelayElement6","sidebarTitle":"GetShapeEqCompDelayElement6","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompdelayelement6"},{"title":"GetShapeEqCompDelayElement7","description":"GetShapeEqCompDelayElement7","sidebarTitle":"GetShapeEqCompDelayElement7","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompdelayelement7"},{"title":"GetShapeEqCompEnableCompressor","description":"GetShapeEqCompEnableCompressor","sidebarTitle":"GetShapeEqCompEnableCompressor","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompenablecompressor"},{"title":"GetShapeEqCompExpandMode","description":"GetShapeEqCompExpandMode","sidebarTitle":"GetShapeEqCompExpandMode","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompexpandmode"},{"title":"GetShapeEqCompFilterCoefficients","description":"GetShapeEqCompFilterCoefficients","sidebarTitle":"GetShapeEqCompFilterCoefficients","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompfiltercoefficients"},{"title":"GetShapeEqCompFilterTargetCoefficients","description":"GetShapeEqCompFilterTargetCoefficients","sidebarTitle":"GetShapeEqCompFilterTargetCoefficients","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompfiltertargetcoefficients"},{"title":"GetShapeEqCompGain","description":"GetShapeEqCompGain","sidebarTitle":"GetShapeEqCompGain","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompgain"},{"title":"GetShapeEqCompGainReduction","description":"GetShapeEqCompGainReduction","sidebarTitle":"GetShapeEqCompGainReduction","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompgainreduction"},{"title":"GetShapeEqCompGainTarget","description":"GetShapeEqCompGainTarget","sidebarTitle":"GetShapeEqCompGainTarget","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompgaintarget"},{"title":"GetShapeEqCompInputDelay0","description":"GetShapeEqCompInputDelay0","sidebarTitle":"GetShapeEqCompInputDelay0","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompinputdelay0"},{"title":"GetShapeEqCompInputDelay1","description":"GetShapeEqCompInputDelay1","sidebarTitle":"GetShapeEqCompInputDelay1","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompinputdelay1"},{"title":"GetShapeEqCompInputLevel","description":"GetShapeEqCompInputLevel","sidebarTitle":"GetShapeEqCompInputLevel","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompinputlevel"},{"title":"GetShapeEqCompInternalSaturate","description":"GetShapeEqCompInternalSaturate","sidebarTitle":"GetShapeEqCompInternalSaturate","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompinternalsaturate"},{"title":"GetShapeEqCompLogGain","description":"GetShapeEqCompLogGain","sidebarTitle":"GetShapeEqCompLogGain","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcomploggain"},{"title":"GetShapeEqCompMixBufferPeakMagnitude","description":"GetShapeEqCompMixBufferPeakMagnitude","sidebarTitle":"GetShapeEqCompMixBufferPeakMagnitude","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompmixbufferpeakmagnitude"},{"title":"GetShapeEqCompPeakMagnitude","description":"GetShapeEqCompPeakMagnitude","sidebarTitle":"GetShapeEqCompPeakMagnitude","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcomppeakmagnitude"},{"title":"GetShapeEqCompRatio","description":"GetShapeEqCompRatio","sidebarTitle":"GetShapeEqCompRatio","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompratio"},{"title":"GetShapeEqCompRawFilterCoefficients","description":"GetShapeEqCompRawFilterCoefficients","sidebarTitle":"GetShapeEqCompRawFilterCoefficients","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcomprawfiltercoefficients"},{"title":"GetShapeEqCompRawFilterTargetCoefficients","description":"GetShapeEqCompRawFilterTargetCoefficients","sidebarTitle":"GetShapeEqCompRawFilterTargetCoefficients","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcomprawfiltertargetcoefficients"},{"title":"GetShapeEqCompRelease","description":"GetShapeEqCompRelease","sidebarTitle":"GetShapeEqCompRelease","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcomprelease"},{"title":"GetShapeEqCompSidechainMode","description":"GetShapeEqCompSidechainMode","sidebarTitle":"GetShapeEqCompSidechainMode","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompsidechainmode"},{"title":"GetShapeEqCompThreshold","description":"GetShapeEqCompThreshold","sidebarTitle":"GetShapeEqCompThreshold","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcompthreshold"},{"title":"GetShapeEqCompTimestamp","description":"GetShapeEqCompTimestamp","sidebarTitle":"GetShapeEqCompTimestamp","href":"/reference/audio/shapeeqcompcontext/functions/getshapeeqcomptimestamp"},{"title":"SetShapeEqCompAttack","description":"SetShapeEqCompAttack","sidebarTitle":"SetShapeEqCompAttack","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompattack"},{"title":"SetShapeEqCompCompressorMode","description":"SetShapeEqCompCompressorMode","sidebarTitle":"SetShapeEqCompCompressorMode","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompcompressormode"},{"title":"SetShapeEqCompEnableCompressor","description":"SetShapeEqCompEnableCompressor","sidebarTitle":"SetShapeEqCompEnableCompressor","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompenablecompressor"},{"title":"SetShapeEqCompExpandMode","description":"SetShapeEqCompExpandMode","sidebarTitle":"SetShapeEqCompExpandMode","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompexpandmode"},{"title":"SetShapeEqCompFilterCoefficients","description":"SetShapeEqCompFilterCoefficients","sidebarTitle":"SetShapeEqCompFilterCoefficients","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompfiltercoefficients"},{"title":"SetShapeEqCompFilterTargetCoefficients","description":"SetShapeEqCompFilterTargetCoefficients","sidebarTitle":"SetShapeEqCompFilterTargetCoefficients","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompfiltertargetcoefficients"},{"title":"SetShapeEqCompGain","description":"SetShapeEqCompGain","sidebarTitle":"SetShapeEqCompGain","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompgain"},{"title":"SetShapeEqCompGainTarget","description":"SetShapeEqCompGainTarget","sidebarTitle":"SetShapeEqCompGainTarget","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompgaintarget"},{"title":"SetShapeEqCompLogGain","description":"SetShapeEqCompLogGain","sidebarTitle":"SetShapeEqCompLogGain","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcomploggain"},{"title":"SetShapeEqCompRatio","description":"SetShapeEqCompRatio","sidebarTitle":"SetShapeEqCompRatio","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompratio"},{"title":"SetShapeEqCompRawFilterCoefficients","description":"SetShapeEqCompRawFilterCoefficients","sidebarTitle":"SetShapeEqCompRawFilterCoefficients","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcomprawfiltercoefficients"},{"title":"SetShapeEqCompRawFilterTargetCoefficients","description":"SetShapeEqCompRawFilterTargetCoefficients","sidebarTitle":"SetShapeEqCompRawFilterTargetCoefficients","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcomprawfiltertargetcoefficients"},{"title":"SetShapeEqCompRelease","description":"SetShapeEqCompRelease","sidebarTitle":"SetShapeEqCompRelease","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcomprelease"},{"title":"SetShapeEqCompSidechainMode","description":"SetShapeEqCompSidechainMode","sidebarTitle":"SetShapeEqCompSidechainMode","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompsidechainmode"},{"title":"SetShapeEqCompThreshold","description":"SetShapeEqCompThreshold","sidebarTitle":"SetShapeEqCompThreshold","href":"/reference/audio/shapeeqcompcontext/functions/setshapeeqcompthreshold"},{"title":"ShapeSignedFromU16_8","description":"ShapeSignedFromU16_8","sidebarTitle":"ShapeSignedFromU16_8","href":"/reference/audio/shapeeqcompcontext/functions/shapesignedfromu16_8"},{"title":"ShapeSignedFromU24","description":"ShapeSignedFromU24","sidebarTitle":"ShapeSignedFromU24","href":"/reference/audio/shapeeqcompcontext/functions/shapesignedfromu24"},{"title":"ShapeSignedFromU8_16","description":"ShapeSignedFromU8_16","sidebarTitle":"ShapeSignedFromU8_16","href":"/reference/audio/shapeeqcompcontext/functions/shapesignedfromu8_16"},{"title":"ShapeSignedToHighU16","description":"ShapeSignedToHighU16","sidebarTitle":"ShapeSignedToHighU16","href":"/reference/audio/shapeeqcompcontext/functions/shapesignedtohighu16"},{"title":"ShapeSignedToHighU8","description":"ShapeSignedToHighU8","sidebarTitle":"ShapeSignedToHighU8","href":"/reference/audio/shapeeqcompcontext/functions/shapesignedtohighu8"},{"title":"ShapeSignedToLowU16","description":"ShapeSignedToLowU16","sidebarTitle":"ShapeSignedToLowU16","href":"/reference/audio/shapeeqcompcontext/functions/shapesignedtolowu16"},{"title":"ShapeSignedToLowU8","description":"ShapeSignedToLowU8","sidebarTitle":"ShapeSignedToLowU8","href":"/reference/audio/shapeeqcompcontext/functions/shapesignedtolowu8"},{"title":"ShapeSignedToU16","description":"ShapeSignedToU16","sidebarTitle":"ShapeSignedToU16","href":"/reference/audio/shapeeqcompcontext/functions/shapesignedtou16"},{"title":"ShapeSignedToU24","description":"ShapeSignedToU24","sidebarTitle":"ShapeSignedToU24","href":"/reference/audio/shapeeqcompcontext/functions/shapesignedtou24"},{"title":"ShapeUnsignedToU16","description":"ShapeUnsignedToU16","sidebarTitle":"ShapeUnsignedToU16","href":"/reference/audio/shapeeqcompcontext/functions/shapeunsignedtou16"},{"title":"ShapeUnsignedToU24","description":"ShapeUnsignedToU24","sidebarTitle":"ShapeUnsignedToU24","href":"/reference/audio/shapeeqcompcontext/functions/shapeunsignedtou24"}]},{"group":"Structs","pages":[{"title":"SHAPE_EQCOMP_CONTEXT","description":"SHAPE_EQCOMP_CONTEXT","sidebarTitle":"SHAPE_EQCOMP_CONTEXT","href":"/reference/audio/shapeeqcompcontext/structs/shape_eqcomp_context"}]}]},{"group":"ShapeFiltVolContext","pages":[{"title":"ShapeFiltVolContext","description":"ShapeFiltVolContext","sidebarTitle":"ShapeFiltVolContext","href":"/reference/audio/shapefiltvolcontext/shapefiltvolcontext_members"},{"group":"Enums","pages":[{"title":"SHAPE_FILTER_HEADROOM","description":"SHAPE_FILTER_HEADROOM","sidebarTitle":"SHAPE_FILTER_HEADROOM","href":"/reference/audio/shapefiltvolcontext/enums/shape_filter_headroom"},{"title":"SHAPE_FILTER_MODE","description":"SHAPE_FILTER_MODE","sidebarTitle":"SHAPE_FILTER_MODE","href":"/reference/audio/shapefiltvolcontext/enums/shape_filter_mode"}]},{"group":"Functions","pages":[{"title":"GetShapeFiltVolDelay1","description":"GetShapeFiltVolDelay1","sidebarTitle":"GetShapeFiltVolDelay1","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvoldelay1"},{"title":"GetShapeFiltVolDelay2","description":"GetShapeFiltVolDelay2","sidebarTitle":"GetShapeFiltVolDelay2","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvoldelay2"},{"title":"GetShapeFiltVolFrequency","description":"GetShapeFiltVolFrequency","sidebarTitle":"GetShapeFiltVolFrequency","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvolfrequency"},{"title":"GetShapeFiltVolFrequencyTarget","description":"GetShapeFiltVolFrequencyTarget","sidebarTitle":"GetShapeFiltVolFrequencyTarget","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvolfrequencytarget"},{"title":"GetShapeFiltVolInputHeadroom","description":"GetShapeFiltVolInputHeadroom","sidebarTitle":"GetShapeFiltVolInputHeadroom","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvolinputheadroom"},{"title":"GetShapeFiltVolInternalSaturate","description":"GetShapeFiltVolInternalSaturate","sidebarTitle":"GetShapeFiltVolInternalSaturate","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvolinternalsaturate"},{"title":"GetShapeFiltVolMixBufferPeakMagnitude","description":"GetShapeFiltVolMixBufferPeakMagnitude","sidebarTitle":"GetShapeFiltVolMixBufferPeakMagnitude","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvolmixbufferpeakmagnitude"},{"title":"GetShapeFiltVolMode","description":"GetShapeFiltVolMode","sidebarTitle":"GetShapeFiltVolMode","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvolmode"},{"title":"GetShapeFiltVolOutputGain","description":"GetShapeFiltVolOutputGain","sidebarTitle":"GetShapeFiltVolOutputGain","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvoloutputgain"},{"title":"GetShapeFiltVolOutputGainTarget","description":"GetShapeFiltVolOutputGainTarget","sidebarTitle":"GetShapeFiltVolOutputGainTarget","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvoloutputgaintarget"},{"title":"GetShapeFiltVolPeakMagnitude","description":"GetShapeFiltVolPeakMagnitude","sidebarTitle":"GetShapeFiltVolPeakMagnitude","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvolpeakmagnitude"},{"title":"GetShapeFiltVolQ","description":"GetShapeFiltVolQ","sidebarTitle":"GetShapeFiltVolQ","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvolq"},{"title":"GetShapeFiltVolQTarget","description":"GetShapeFiltVolQTarget","sidebarTitle":"GetShapeFiltVolQTarget","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvolqtarget"},{"title":"GetShapeFiltVolTimestamp","description":"GetShapeFiltVolTimestamp","sidebarTitle":"GetShapeFiltVolTimestamp","href":"/reference/audio/shapefiltvolcontext/functions/getshapefiltvoltimestamp"},{"title":"SetShapeFiltVolFrequency","description":"SetShapeFiltVolFrequency","sidebarTitle":"SetShapeFiltVolFrequency","href":"/reference/audio/shapefiltvolcontext/functions/setshapefiltvolfrequency"},{"title":"SetShapeFiltVolFrequencyTarget","description":"SetShapeFiltVolFrequencyTarget","sidebarTitle":"SetShapeFiltVolFrequencyTarget","href":"/reference/audio/shapefiltvolcontext/functions/setshapefiltvolfrequencytarget"},{"title":"SetShapeFiltVolInputHeadroom","description":"SetShapeFiltVolInputHeadroom","sidebarTitle":"SetShapeFiltVolInputHeadroom","href":"/reference/audio/shapefiltvolcontext/functions/setshapefiltvolinputheadroom"},{"title":"SetShapeFiltVolMode","description":"SetShapeFiltVolMode","sidebarTitle":"SetShapeFiltVolMode","href":"/reference/audio/shapefiltvolcontext/functions/setshapefiltvolmode"},{"title":"SetShapeFiltVolOutputGain","description":"SetShapeFiltVolOutputGain","sidebarTitle":"SetShapeFiltVolOutputGain","href":"/reference/audio/shapefiltvolcontext/functions/setshapefiltvoloutputgain"},{"title":"SetShapeFiltVolOutputGainTarget","description":"SetShapeFiltVolOutputGainTarget","sidebarTitle":"SetShapeFiltVolOutputGainTarget","href":"/reference/audio/shapefiltvolcontext/functions/setshapefiltvoloutputgaintarget"},{"title":"SetShapeFiltVolQ","description":"SetShapeFiltVolQ","sidebarTitle":"SetShapeFiltVolQ","href":"/reference/audio/shapefiltvolcontext/functions/setshapefiltvolq"},{"title":"SetShapeFiltVolQTarget","description":"SetShapeFiltVolQTarget","sidebarTitle":"SetShapeFiltVolQTarget","href":"/reference/audio/shapefiltvolcontext/functions/setshapefiltvolqtarget"}]},{"group":"Structs","pages":[{"title":"SHAPE_FILTVOL_CONTEXT","description":"SHAPE_FILTVOL_CONTEXT","sidebarTitle":"SHAPE_FILTVOL_CONTEXT","href":"/reference/audio/shapefiltvolcontext/structs/shape_filtvol_context"}]}]},{"group":"ShapeFlowGraph","pages":[{"title":"ShapeFlowGraph","description":"ShapeFlowGraph","sidebarTitle":"ShapeFlowGraph","href":"/reference/audio/shapeflowgraph/shapeflowgraph_members"},{"group":"Enums","pages":[{"title":"SHAPE_FLOWGRAPH_COMMAND_TYPE","description":"SHAPE_FLOWGRAPH_COMMAND_TYPE","sidebarTitle":"SHAPE_FLOWGRAPH_COMMAND_TYPE","href":"/reference/audio/shapeflowgraph/enums/shape_flowgraph_command_type"},{"title":"SHAPE_MIXBUFFER_ATTENUATION","description":"SHAPE_MIXBUFFER_ATTENUATION","sidebarTitle":"SHAPE_MIXBUFFER_ATTENUATION","href":"/reference/audio/shapeflowgraph/enums/shape_mixbuffer_attenuation"}]},{"group":"Functions","pages":[{"title":"SetShapeAllocMixBufferCommand","description":"SetShapeAllocMixBufferCommand","sidebarTitle":"SetShapeAllocMixBufferCommand","href":"/reference/audio/shapeflowgraph/functions/setshapeallocmixbuffercommand"},{"title":"SetShapeDmaCommand","description":"SetShapeDmaCommand","sidebarTitle":"SetShapeDmaCommand","href":"/reference/audio/shapeflowgraph/functions/setshapedmacommand"},{"title":"SetShapeEqCompCommand","description":"SetShapeEqCompCommand","sidebarTitle":"SetShapeEqCompCommand","href":"/reference/audio/shapeflowgraph/functions/setshapeeqcompcommand"},{"title":"SetShapeFiltVolCommand","description":"SetShapeFiltVolCommand","sidebarTitle":"SetShapeFiltVolCommand","href":"/reference/audio/shapeflowgraph/functions/setshapefiltvolcommand"},{"title":"SetShapeSrcCommand function","description":"SetShapeSrcCommand function","sidebarTitle":"SetShapeSrcCommand function","href":"/reference/audio/shapeflowgraph/functions/shapeflowgraph_setshapesrccommand"}]},{"group":"Structs","pages":[{"title":"SHAPE_FLOWGRAPH_ALLOC_MIXBUFFER_COMMAND","description":"SHAPE_FLOWGRAPH_ALLOC_MIXBUFFER_COMMAND","sidebarTitle":"SHAPE_FLOWGRAPH_ALLOC_MIXBUFFER_COMMAND","href":"/reference/audio/shapeflowgraph/structs/shape_flowgraph_alloc_mixbuffer_command"},{"title":"SHAPE_FLOWGRAPH_COMMAND","description":"SHAPE_FLOWGRAPH_COMMAND","sidebarTitle":"SHAPE_FLOWGRAPH_COMMAND","href":"/reference/audio/shapeflowgraph/structs/shape_flowgraph_command"},{"title":"SHAPE_FLOWGRAPH_COMMAND_HEADER","description":"SHAPE_FLOWGRAPH_COMMAND_HEADER","sidebarTitle":"SHAPE_FLOWGRAPH_COMMAND_HEADER","href":"/reference/audio/shapeflowgraph/structs/shape_flowgraph_command_header"},{"title":"SHAPE_FLOWGRAPH_DMA_COMMAND","description":"SHAPE_FLOWGRAPH_DMA_COMMAND","sidebarTitle":"SHAPE_FLOWGRAPH_DMA_COMMAND","href":"/reference/audio/shapeflowgraph/structs/shape_flowgraph_dma_command"},{"title":"SHAPE_FLOWGRAPH_EQCOMP_COMMAND","description":"SHAPE_FLOWGRAPH_EQCOMP_COMMAND","sidebarTitle":"SHAPE_FLOWGRAPH_EQCOMP_COMMAND","href":"/reference/audio/shapeflowgraph/structs/shape_flowgraph_eqcomp_command"},{"title":"SHAPE_FLOWGRAPH_FILTVOL_COMMAND","description":"SHAPE_FLOWGRAPH_FILTVOL_COMMAND","sidebarTitle":"SHAPE_FLOWGRAPH_FILTVOL_COMMAND","href":"/reference/audio/shapeflowgraph/structs/shape_flowgraph_filtvol_command"},{"title":"SHAPE_FLOWGRAPH_SRC_COMMAND","description":"SHAPE_FLOWGRAPH_SRC_COMMAND","sidebarTitle":"SHAPE_FLOWGRAPH_SRC_COMMAND","href":"/reference/audio/shapeflowgraph/structs/shape_flowgraph_src_command"}]}]},{"group":"ShapePcmContext","pages":[{"title":"ShapePcmContext","description":"ShapePcmContext","sidebarTitle":"ShapePcmContext","href":"/reference/audio/shapepcmcontext/shapepcmcontext_members"},{"group":"Enums","pages":[{"title":"SHAPE_PCM_FORMAT","description":"SHAPE_PCM_FORMAT","sidebarTitle":"SHAPE_PCM_FORMAT","href":"/reference/audio/shapepcmcontext/enums/shape_pcm_format"},{"title":"SHAPE_PCM_MODE","description":"SHAPE_PCM_MODE","sidebarTitle":"SHAPE_PCM_MODE","href":"/reference/audio/shapepcmcontext/enums/shape_pcm_mode"}]},{"group":"Functions","pages":[{"title":"GetShapePcmAudioBuffer","description":"GetShapePcmAudioBuffer","sidebarTitle":"GetShapePcmAudioBuffer","href":"/reference/audio/shapepcmcontext/functions/getshapepcmaudiobuffer"},{"title":"GetShapePcmBufferFull","description":"GetShapePcmBufferFull","sidebarTitle":"GetShapePcmBufferFull","href":"/reference/audio/shapepcmcontext/functions/getshapepcmbufferfull"},{"title":"GetShapePcmBufferLength","description":"GetShapePcmBufferLength","sidebarTitle":"GetShapePcmBufferLength","href":"/reference/audio/shapepcmcontext/functions/getshapepcmbufferlength"},{"title":"GetShapePcmFormat","description":"GetShapePcmFormat","sidebarTitle":"GetShapePcmFormat","href":"/reference/audio/shapepcmcontext/functions/getshapepcmformat"},{"title":"GetShapePcmLoopCount","description":"GetShapePcmLoopCount","sidebarTitle":"GetShapePcmLoopCount","href":"/reference/audio/shapepcmcontext/functions/getshapepcmloopcount"},{"title":"GetShapePcmLoopEnd","description":"GetShapePcmLoopEnd","sidebarTitle":"GetShapePcmLoopEnd","href":"/reference/audio/shapepcmcontext/functions/getshapepcmloopend"},{"title":"GetShapePcmLoopStartOrWritePointer","description":"GetShapePcmLoopStartOrWritePointer","sidebarTitle":"GetShapePcmLoopStartOrWritePointer","href":"/reference/audio/shapepcmcontext/functions/getshapepcmloopstartorwritepointer"},{"title":"GetShapePcmMode","description":"GetShapePcmMode","sidebarTitle":"GetShapePcmMode","href":"/reference/audio/shapepcmcontext/functions/getshapepcmmode"},{"title":"GetShapePcmReadPointer","description":"GetShapePcmReadPointer","sidebarTitle":"GetShapePcmReadPointer","href":"/reference/audio/shapepcmcontext/functions/getshapepcmreadpointer"},{"title":"SetShapePcmAudioBuffer function","description":"SetShapePcmAudioBuffer function","sidebarTitle":"SetShapePcmAudioBuffer function","href":"/reference/audio/shapepcmcontext/functions/setshapepcmaudiobuffer"},{"title":"SetShapePcmAudioBuffer","description":"SetShapePcmAudioBuffer","sidebarTitle":"SetShapePcmAudioBuffer","href":"/reference/audio/shapepcmcontext/functions/setshapepcmaudiobuffer_2"},{"title":"SetShapePcmBufferFull","description":"SetShapePcmBufferFull","sidebarTitle":"SetShapePcmBufferFull","href":"/reference/audio/shapepcmcontext/functions/setshapepcmbufferfull"},{"title":"SetShapePcmBufferLength","description":"SetShapePcmBufferLength","sidebarTitle":"SetShapePcmBufferLength","href":"/reference/audio/shapepcmcontext/functions/setshapepcmbufferlength"},{"title":"SetShapePcmFormat","description":"SetShapePcmFormat","sidebarTitle":"SetShapePcmFormat","href":"/reference/audio/shapepcmcontext/functions/setshapepcmformat"},{"title":"SetShapePcmLoopCount","description":"SetShapePcmLoopCount","sidebarTitle":"SetShapePcmLoopCount","href":"/reference/audio/shapepcmcontext/functions/setshapepcmloopcount"},{"title":"SetShapePcmLoopEnd","description":"SetShapePcmLoopEnd","sidebarTitle":"SetShapePcmLoopEnd","href":"/reference/audio/shapepcmcontext/functions/setshapepcmloopend"},{"title":"SetShapePcmLoopStartOrWritePointer","description":"SetShapePcmLoopStartOrWritePointer","sidebarTitle":"SetShapePcmLoopStartOrWritePointer","href":"/reference/audio/shapepcmcontext/functions/setshapepcmloopstartorwritepointer"},{"title":"SetShapePcmMode","description":"SetShapePcmMode","sidebarTitle":"SetShapePcmMode","href":"/reference/audio/shapepcmcontext/functions/setshapepcmmode"},{"title":"SetShapePcmReadPointer","description":"SetShapePcmReadPointer","sidebarTitle":"SetShapePcmReadPointer","href":"/reference/audio/shapepcmcontext/functions/setshapepcmreadpointer"}]},{"group":"Structs","pages":[{"title":"SHAPE_PCM_CONTEXT","description":"SHAPE_PCM_CONTEXT","sidebarTitle":"SHAPE_PCM_CONTEXT","href":"/reference/audio/shapepcmcontext/structs/shape_pcm_context"}]}]},{"group":"ShapeSrcContext","pages":[{"title":"ShapeSrcContext","description":"ShapeSrcContext","sidebarTitle":"ShapeSrcContext","href":"/reference/audio/shapesrccontext/shapesrccontext_members"},{"group":"Enums","pages":[{"title":"SHAPE_SRC_COMMAND_TYPE","description":"SHAPE_SRC_COMMAND_TYPE","sidebarTitle":"SHAPE_SRC_COMMAND_TYPE","href":"/reference/audio/shapesrccontext/enums/shape_src_command_type"}]},{"group":"Functions","pages":[{"title":"GetShapeSrcCommandType","description":"GetShapeSrcCommandType","sidebarTitle":"GetShapeSrcCommandType","href":"/reference/audio/shapesrccontext/functions/getshapesrccommandtype"},{"title":"GetShapeSrcInternalSaturate","description":"GetShapeSrcInternalSaturate","sidebarTitle":"GetShapeSrcInternalSaturate","href":"/reference/audio/shapesrccontext/functions/getshapesrcinternalsaturate"},{"title":"GetShapeSrcMixBufferPeakMagnitude0","description":"GetShapeSrcMixBufferPeakMagnitude0","sidebarTitle":"GetShapeSrcMixBufferPeakMagnitude0","href":"/reference/audio/shapesrccontext/functions/getshapesrcmixbufferpeakmagnitude0"},{"title":"GetShapeSrcMixBufferPeakMagnitude1","description":"GetShapeSrcMixBufferPeakMagnitude1","sidebarTitle":"GetShapeSrcMixBufferPeakMagnitude1","href":"/reference/audio/shapesrccontext/functions/getshapesrcmixbufferpeakmagnitude1"},{"title":"GetShapeSrcPeakMagnitude0","description":"GetShapeSrcPeakMagnitude0","sidebarTitle":"GetShapeSrcPeakMagnitude0","href":"/reference/audio/shapesrccontext/functions/getshapesrcpeakmagnitude0"},{"title":"GetShapeSrcPeakMagnitude1","description":"GetShapeSrcPeakMagnitude1","sidebarTitle":"GetShapeSrcPeakMagnitude1","href":"/reference/audio/shapesrccontext/functions/getshapesrcpeakmagnitude1"},{"title":"GetShapeSrcPitch","description":"GetShapeSrcPitch","sidebarTitle":"GetShapeSrcPitch","href":"/reference/audio/shapesrccontext/functions/getshapesrcpitch"},{"title":"GetShapeSrcPitchTarget","description":"GetShapeSrcPitchTarget","sidebarTitle":"GetShapeSrcPitchTarget","href":"/reference/audio/shapesrccontext/functions/getshapesrcpitchtarget"},{"title":"GetShapeSrcSampleCount","description":"GetShapeSrcSampleCount","sidebarTitle":"GetShapeSrcSampleCount","href":"/reference/audio/shapesrccontext/functions/getshapesrcsamplecount"},{"title":"GetShapeSrcSamplePointer","description":"GetShapeSrcSamplePointer","sidebarTitle":"GetShapeSrcSamplePointer","href":"/reference/audio/shapesrccontext/functions/getshapesrcsamplepointer"},{"title":"GetShapeSrcTimestamp","description":"GetShapeSrcTimestamp","sidebarTitle":"GetShapeSrcTimestamp","href":"/reference/audio/shapesrccontext/functions/getshapesrctimestamp"},{"title":"GetShapeSrcXmaBlocksToSkip","description":"GetShapeSrcXmaBlocksToSkip","sidebarTitle":"GetShapeSrcXmaBlocksToSkip","href":"/reference/audio/shapesrccontext/functions/getshapesrcxmablockstoskip"},{"title":"PitchToShapeSrcSamplingIncrement","description":"PitchToShapeSrcSamplingIncrement","sidebarTitle":"PitchToShapeSrcSamplingIncrement","href":"/reference/audio/shapesrccontext/functions/pitchtoshapesrcsamplingincrement"},{"title":"SetShapeSrcPitch","description":"SetShapeSrcPitch","sidebarTitle":"SetShapeSrcPitch","href":"/reference/audio/shapesrccontext/functions/setshapesrcpitch"},{"title":"SetShapeSrcPitchTarget","description":"SetShapeSrcPitchTarget","sidebarTitle":"SetShapeSrcPitchTarget","href":"/reference/audio/shapesrccontext/functions/setshapesrcpitchtarget"},{"title":"SetShapeSrcXmaBlocksToSkip","description":"SetShapeSrcXmaBlocksToSkip","sidebarTitle":"SetShapeSrcXmaBlocksToSkip","href":"/reference/audio/shapesrccontext/functions/setshapesrcxmablockstoskip"},{"title":"SetShapeSrcCommand","description":"SetShapeSrcCommand","sidebarTitle":"SetShapeSrcCommand","href":"/reference/audio/shapesrccontext/functions/shapesrccontext_setshapesrccommand"},{"title":"ShapeSrcSamplingIncrementToPitch","description":"ShapeSrcSamplingIncrementToPitch","sidebarTitle":"ShapeSrcSamplingIncrementToPitch","href":"/reference/audio/shapesrccontext/functions/shapesrcsamplingincrementtopitch"}]},{"group":"Structs","pages":[{"title":"SHAPE_SRC_CONTEXT","description":"SHAPE_SRC_CONTEXT","sidebarTitle":"SHAPE_SRC_CONTEXT","href":"/reference/audio/shapesrccontext/structs/shape_src_context"}]}]},{"group":"ShapeXmaContext","pages":[{"title":"ShapeXmaContext","description":"ShapeXmaContext","sidebarTitle":"ShapeXmaContext","href":"/reference/audio/shapexmacontext/shapexmacontext_members"},{"group":"Enums","pages":[{"title":"SHAPE_XMA_SAMPLE_RATE","description":"SHAPE_XMA_SAMPLE_RATE","sidebarTitle":"SHAPE_XMA_SAMPLE_RATE","href":"/reference/audio/shapexmacontext/enums/shape_xma_sample_rate"}]},{"group":"Functions","pages":[{"title":"GetShapeXmaCurrentInputBuffer","description":"GetShapeXmaCurrentInputBuffer","sidebarTitle":"GetShapeXmaCurrentInputBuffer","href":"/reference/audio/shapexmacontext/functions/getshapexmacurrentinputbuffer"},{"title":"GetShapeXmaErrorSet","description":"GetShapeXmaErrorSet","sidebarTitle":"GetShapeXmaErrorSet","href":"/reference/audio/shapexmacontext/functions/getshapexmaerrorset"},{"title":"GetShapeXmaErrorStatus","description":"GetShapeXmaErrorStatus","sidebarTitle":"GetShapeXmaErrorStatus","href":"/reference/audio/shapexmacontext/functions/getshapexmaerrorstatus"},{"title":"GetShapeXmaInputBuffer0","description":"GetShapeXmaInputBuffer0","sidebarTitle":"GetShapeXmaInputBuffer0","href":"/reference/audio/shapexmacontext/functions/getshapexmainputbuffer0"},{"title":"GetShapeXmaInputBuffer0Size","description":"GetShapeXmaInputBuffer0Size","sidebarTitle":"GetShapeXmaInputBuffer0Size","href":"/reference/audio/shapexmacontext/functions/getshapexmainputbuffer0size"},{"title":"GetShapeXmaInputBuffer0Valid","description":"GetShapeXmaInputBuffer0Valid","sidebarTitle":"GetShapeXmaInputBuffer0Valid","href":"/reference/audio/shapexmacontext/functions/getshapexmainputbuffer0valid"},{"title":"GetShapeXmaInputBuffer1","description":"GetShapeXmaInputBuffer1","sidebarTitle":"GetShapeXmaInputBuffer1","href":"/reference/audio/shapexmacontext/functions/getshapexmainputbuffer1"},{"title":"GetShapeXmaInputBuffer1Size","description":"GetShapeXmaInputBuffer1Size","sidebarTitle":"GetShapeXmaInputBuffer1Size","href":"/reference/audio/shapexmacontext/functions/getshapexmainputbuffer1size"},{"title":"GetShapeXmaInputBuffer1Valid","description":"GetShapeXmaInputBuffer1Valid","sidebarTitle":"GetShapeXmaInputBuffer1Valid","href":"/reference/audio/shapexmacontext/functions/getshapexmainputbuffer1valid"},{"title":"GetShapeXmaInputBufferReadOffset","description":"GetShapeXmaInputBufferReadOffset","sidebarTitle":"GetShapeXmaInputBufferReadOffset","href":"/reference/audio/shapexmacontext/functions/getshapexmainputbufferreadoffset"},{"title":"GetShapeXmaInputBufferValid","description":"GetShapeXmaInputBufferValid","sidebarTitle":"GetShapeXmaInputBufferValid","href":"/reference/audio/shapexmacontext/functions/getshapexmainputbuffervalid"},{"title":"GetShapeXmaInterruptWhenDone","description":"GetShapeXmaInterruptWhenDone","sidebarTitle":"GetShapeXmaInterruptWhenDone","href":"/reference/audio/shapexmacontext/functions/getshapexmainterruptwhendone"},{"title":"GetShapeXmaLoopEndOffset","description":"GetShapeXmaLoopEndOffset","sidebarTitle":"GetShapeXmaLoopEndOffset","href":"/reference/audio/shapexmacontext/functions/getshapexmaloopendoffset"},{"title":"GetShapeXmaLoopStartOffset","description":"GetShapeXmaLoopStartOffset","sidebarTitle":"GetShapeXmaLoopStartOffset","href":"/reference/audio/shapexmacontext/functions/getshapexmaloopstartoffset"},{"title":"GetShapeXmaLoopSubframeEnd","description":"GetShapeXmaLoopSubframeEnd","sidebarTitle":"GetShapeXmaLoopSubframeEnd","href":"/reference/audio/shapexmacontext/functions/getshapexmaloopsubframeend"},{"title":"GetShapeXmaLoopSubframeSkip","description":"GetShapeXmaLoopSubframeSkip","sidebarTitle":"GetShapeXmaLoopSubframeSkip","href":"/reference/audio/shapexmacontext/functions/getshapexmaloopsubframeskip"},{"title":"GetShapeXmaNumChannels","description":"GetShapeXmaNumChannels","sidebarTitle":"GetShapeXmaNumChannels","href":"/reference/audio/shapexmacontext/functions/getshapexmanumchannels"},{"title":"GetShapeXmaNumLoops","description":"GetShapeXmaNumLoops","sidebarTitle":"GetShapeXmaNumLoops","href":"/reference/audio/shapexmacontext/functions/getshapexmanumloops"},{"title":"GetShapeXmaNumSubframesToDecode","description":"GetShapeXmaNumSubframesToDecode","sidebarTitle":"GetShapeXmaNumSubframesToDecode","href":"/reference/audio/shapexmacontext/functions/getshapexmanumsubframestodecode"},{"title":"GetShapeXmaNumSubframesToSkip","description":"GetShapeXmaNumSubframesToSkip","sidebarTitle":"GetShapeXmaNumSubframesToSkip","href":"/reference/audio/shapexmacontext/functions/getshapexmanumsubframestoskip"},{"title":"GetShapeXmaOutputBuffer","description":"GetShapeXmaOutputBuffer","sidebarTitle":"GetShapeXmaOutputBuffer","href":"/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffer"},{"title":"GetShapeXmaOutputBufferNumBytesAvailable","description":"GetShapeXmaOutputBufferNumBytesAvailable","sidebarTitle":"GetShapeXmaOutputBufferNumBytesAvailable","href":"/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffernumbytesavailable"},{"title":"GetShapeXmaOutputBufferNumFramesAvailable","description":"GetShapeXmaOutputBufferNumFramesAvailable","sidebarTitle":"GetShapeXmaOutputBufferNumFramesAvailable","href":"/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffernumframesavailable"},{"title":"GetShapeXmaOutputBufferReadOffset","description":"GetShapeXmaOutputBufferReadOffset","sidebarTitle":"GetShapeXmaOutputBufferReadOffset","href":"/reference/audio/shapexmacontext/functions/getshapexmaoutputbufferreadoffset"},{"title":"GetShapeXmaOutputBufferSize","description":"GetShapeXmaOutputBufferSize","sidebarTitle":"GetShapeXmaOutputBufferSize","href":"/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffersize"},{"title":"GetShapeXmaOutputBufferValid","description":"GetShapeXmaOutputBufferValid","sidebarTitle":"GetShapeXmaOutputBufferValid","href":"/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffervalid"},{"title":"GetShapeXmaOutputBufferWriteOffset","description":"GetShapeXmaOutputBufferWriteOffset","sidebarTitle":"GetShapeXmaOutputBufferWriteOffset","href":"/reference/audio/shapexmacontext/functions/getshapexmaoutputbufferwriteoffset"},{"title":"GetShapeXmaOverlapAddBuffer","description":"GetShapeXmaOverlapAddBuffer","sidebarTitle":"GetShapeXmaOverlapAddBuffer","href":"/reference/audio/shapexmacontext/functions/getshapexmaoverlapaddbuffer"},{"title":"GetShapeXmaPacketMetadata","description":"GetShapeXmaPacketMetadata","sidebarTitle":"GetShapeXmaPacketMetadata","href":"/reference/audio/shapexmacontext/functions/getshapexmapacketmetadata"},{"title":"GetShapeXmaParserErrorSet","description":"GetShapeXmaParserErrorSet","sidebarTitle":"GetShapeXmaParserErrorSet","href":"/reference/audio/shapexmacontext/functions/getshapexmaparsererrorset"},{"title":"GetShapeXmaParserErrorStatus","description":"GetShapeXmaParserErrorStatus","sidebarTitle":"GetShapeXmaParserErrorStatus","href":"/reference/audio/shapexmacontext/functions/getshapexmaparsererrorstatus"},{"title":"GetShapeXmaSampleRate","description":"GetShapeXmaSampleRate","sidebarTitle":"GetShapeXmaSampleRate","href":"/reference/audio/shapexmacontext/functions/getshapexmasamplerate"},{"title":"GetShapeXmaStopWhenDone","description":"GetShapeXmaStopWhenDone","sidebarTitle":"GetShapeXmaStopWhenDone","href":"/reference/audio/shapexmacontext/functions/getshapexmastopwhendone"},{"title":"SetShapeXmaCurrentInputBuffer","description":"SetShapeXmaCurrentInputBuffer","sidebarTitle":"SetShapeXmaCurrentInputBuffer","href":"/reference/audio/shapexmacontext/functions/setshapexmacurrentinputbuffer"},{"title":"SetShapeXmaInputBuffer0(SHAPE_XMA_CONTEXT*, const void*)","description":"SetShapeXmaInputBuffer0(SHAPE_XMA_CONTEXT*, const void*)","sidebarTitle":"SetShapeXmaInputBuffer0(SHAPE_XMA_CONTEXT*, const void*)","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbuffer0"},{"title":"SetShapeXmaInputBuffer0(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","description":"SetShapeXmaInputBuffer0(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","sidebarTitle":"SetShapeXmaInputBuffer0(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbuffer0_2"},{"title":"SetShapeXmaInputBuffer0Size","description":"SetShapeXmaInputBuffer0Size","sidebarTitle":"SetShapeXmaInputBuffer0Size","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbuffer0size"},{"title":"SetShapeXmaInputBuffer0Valid","description":"SetShapeXmaInputBuffer0Valid","sidebarTitle":"SetShapeXmaInputBuffer0Valid","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbuffer0valid"},{"title":"SetShapeXmaInputBuffer1(SHAPE_XMA_CONTEXT*, const void*)","description":"SetShapeXmaInputBuffer1(SHAPE_XMA_CONTEXT*, const void*)","sidebarTitle":"SetShapeXmaInputBuffer1(SHAPE_XMA_CONTEXT*, const void*)","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbuffer1"},{"title":"SetShapeXmaInputBuffer1(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","description":"SetShapeXmaInputBuffer1(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","sidebarTitle":"SetShapeXmaInputBuffer1(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbuffer1_2"},{"title":"SetShapeXmaInputBuffer1Size","description":"SetShapeXmaInputBuffer1Size","sidebarTitle":"SetShapeXmaInputBuffer1Size","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbuffer1size"},{"title":"SetShapeXmaInputBuffer1Valid","description":"SetShapeXmaInputBuffer1Valid","sidebarTitle":"SetShapeXmaInputBuffer1Valid","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbuffer1valid"},{"title":"SetShapeXmaInputBufferReadOffset","description":"SetShapeXmaInputBufferReadOffset","sidebarTitle":"SetShapeXmaInputBufferReadOffset","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbufferreadoffset"},{"title":"SetShapeXmaInputBufferValid","description":"SetShapeXmaInputBufferValid","sidebarTitle":"SetShapeXmaInputBufferValid","href":"/reference/audio/shapexmacontext/functions/setshapexmainputbuffervalid"},{"title":"SetShapeXmaInterruptWhenDone","description":"SetShapeXmaInterruptWhenDone","sidebarTitle":"SetShapeXmaInterruptWhenDone","href":"/reference/audio/shapexmacontext/functions/setshapexmainterruptwhendone"},{"title":"SetShapeXmaLoopEndOffset","description":"SetShapeXmaLoopEndOffset","sidebarTitle":"SetShapeXmaLoopEndOffset","href":"/reference/audio/shapexmacontext/functions/setshapexmaloopendoffset"},{"title":"SetShapeXmaLoopStartOffset","description":"SetShapeXmaLoopStartOffset","sidebarTitle":"SetShapeXmaLoopStartOffset","href":"/reference/audio/shapexmacontext/functions/setshapexmaloopstartoffset"},{"title":"SetShapeXmaLoopSubframeEnd","description":"SetShapeXmaLoopSubframeEnd","sidebarTitle":"SetShapeXmaLoopSubframeEnd","href":"/reference/audio/shapexmacontext/functions/setshapexmaloopsubframeend"},{"title":"SetShapeXmaLoopSubframeSkip","description":"SetShapeXmaLoopSubframeSkip","sidebarTitle":"SetShapeXmaLoopSubframeSkip","href":"/reference/audio/shapexmacontext/functions/setshapexmaloopsubframeskip"},{"title":"SetShapeXmaNumChannels","description":"SetShapeXmaNumChannels","sidebarTitle":"SetShapeXmaNumChannels","href":"/reference/audio/shapexmacontext/functions/setshapexmanumchannels"},{"title":"SetShapeXmaNumLoops","description":"SetShapeXmaNumLoops","sidebarTitle":"SetShapeXmaNumLoops","href":"/reference/audio/shapexmacontext/functions/setshapexmanumloops"},{"title":"SetShapeXmaNumSubframesToDecode","description":"SetShapeXmaNumSubframesToDecode","sidebarTitle":"SetShapeXmaNumSubframesToDecode","href":"/reference/audio/shapexmacontext/functions/setshapexmanumsubframestodecode"},{"title":"SetShapeXmaNumSubframesToSkip","description":"SetShapeXmaNumSubframesToSkip","sidebarTitle":"SetShapeXmaNumSubframesToSkip","href":"/reference/audio/shapexmacontext/functions/setshapexmanumsubframestoskip"},{"title":"SetShapeXmaOutputBuffer(SHAPE_XMA_CONTEXT*, void*)","description":"SetShapeXmaOutputBuffer(SHAPE_XMA_CONTEXT*, void*)","sidebarTitle":"SetShapeXmaOutputBuffer(SHAPE_XMA_CONTEXT*, void*)","href":"/reference/audio/shapexmacontext/functions/setshapexmaoutputbuffer"},{"title":"SetShapeXmaOutputBuffer(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","description":"SetShapeXmaOutputBuffer(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","sidebarTitle":"SetShapeXmaOutputBuffer(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","href":"/reference/audio/shapexmacontext/functions/setshapexmaoutputbuffer_2"},{"title":"SetShapeXmaOutputBufferReadOffset","description":"SetShapeXmaOutputBufferReadOffset","sidebarTitle":"SetShapeXmaOutputBufferReadOffset","href":"/reference/audio/shapexmacontext/functions/setshapexmaoutputbufferreadoffset"},{"title":"SetShapeXmaOutputBufferSize","description":"SetShapeXmaOutputBufferSize","sidebarTitle":"SetShapeXmaOutputBufferSize","href":"/reference/audio/shapexmacontext/functions/setshapexmaoutputbuffersize"},{"title":"SetShapeXmaOutputBufferValid","description":"SetShapeXmaOutputBufferValid","sidebarTitle":"SetShapeXmaOutputBufferValid","href":"/reference/audio/shapexmacontext/functions/setshapexmaoutputbuffervalid"},{"title":"SetShapeXmaOverlapAddBuffer(SHAPE_XMA_CONTEXT*, void*)","description":"SetShapeXmaOverlapAddBuffer(SHAPE_XMA_CONTEXT*, void*)","sidebarTitle":"SetShapeXmaOverlapAddBuffer(SHAPE_XMA_CONTEXT*, void*)","href":"/reference/audio/shapexmacontext/functions/setshapexmaoverlapaddbuffer"},{"title":"SetShapeXmaOverlapAddBuffer(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","description":"SetShapeXmaOverlapAddBuffer(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","sidebarTitle":"SetShapeXmaOverlapAddBuffer(SHAPE_XMA_CONTEXT*, APU_ADDRESS)","href":"/reference/audio/shapexmacontext/functions/setshapexmaoverlapaddbuffer_2"},{"title":"SetShapeXmaPacketMetadata","description":"SetShapeXmaPacketMetadata","sidebarTitle":"SetShapeXmaPacketMetadata","href":"/reference/audio/shapexmacontext/functions/setshapexmapacketmetadata"},{"title":"SetShapeXmaSampleRate(SHAPE_XMA_CONTEXT*, SHAPE_XMA_SAMPLE_RATE)","description":"SetShapeXmaSampleRate(SHAPE_XMA_CONTEXT*, SHAPE_XMA_SAMPLE_RATE)","sidebarTitle":"SetShapeXmaSampleRate(SHAPE_XMA_CONTEXT*, SHAPE_XMA_SAMPLE_RATE)","href":"/reference/audio/shapexmacontext/functions/setshapexmasamplerate"},{"title":"SetShapeXmaSampleRate(SHAPE_XMA_CONTEXT*, UINT32)","description":"SetShapeXmaSampleRate(SHAPE_XMA_CONTEXT*, UINT32)","sidebarTitle":"SetShapeXmaSampleRate(SHAPE_XMA_CONTEXT*, UINT32)","href":"/reference/audio/shapexmacontext/functions/setshapexmasamplerate_2"},{"title":"SetShapeXmaStopWhenDone","description":"SetShapeXmaStopWhenDone","sidebarTitle":"SetShapeXmaStopWhenDone","href":"/reference/audio/shapexmacontext/functions/setshapexmastopwhendone"}]},{"group":"Structs","pages":[{"title":"SHAPE_XMA_CONTEXT","description":"SHAPE_XMA_CONTEXT","sidebarTitle":"SHAPE_XMA_CONTEXT","href":"/reference/audio/shapexmacontext/structs/shape_xma_context"}]}]},{"group":"XAPU","pages":[{"title":"XAPU","description":"XAPU","sidebarTitle":"XAPU","href":"/reference/audio/xapu/xapu_members"},{"group":"Enums","pages":[{"title":"XApuCommandOptions","description":"XApuCommandOptions","sidebarTitle":"XApuCommandOptions","href":"/reference/audio/xapu/enums/xapucommandoptions"},{"title":"XApuCommandType","description":"XApuCommandType","sidebarTitle":"XApuCommandType","href":"/reference/audio/xapu/enums/xapucommandtype"},{"title":"XApuConnectOptions","description":"XApuConnectOptions","sidebarTitle":"XApuConnectOptions","href":"/reference/audio/xapu/enums/xapuconnectoptions"},{"title":"XAPU Errors","description":"XAPU Errors","sidebarTitle":"XAPU Errors","href":"/reference/audio/xapu/enums/xapuerrors"},{"title":"XApuProcessType","description":"XApuProcessType","sidebarTitle":"XApuProcessType","href":"/reference/audio/xapu/enums/xapuprocesstype"},{"title":"XApuStateOptions","description":"XApuStateOptions","sidebarTitle":"XApuStateOptions","href":"/reference/audio/xapu/enums/xapustateoptions"}]},{"group":"Functions","pages":[{"title":"XApuConnect","description":"XApuConnect","sidebarTitle":"XApuConnect","href":"/reference/audio/xapu/functions/xapuconnect"},{"title":"XApuDequeueResult","description":"XApuDequeueResult","sidebarTitle":"XApuDequeueResult","href":"/reference/audio/xapu/functions/xapudequeueresult"},{"title":"XApuDisconnect","description":"XApuDisconnect","sidebarTitle":"XApuDisconnect","href":"/reference/audio/xapu/functions/xapudisconnect"},{"title":"XApuEnqueueCommand","description":"XApuEnqueueCommand","sidebarTitle":"XApuEnqueueCommand","href":"/reference/audio/xapu/functions/xapuenqueuecommand"},{"title":"XApuGetResultCount","description":"XApuGetResultCount","sidebarTitle":"XApuGetResultCount","href":"/reference/audio/xapu/functions/xapugetresultcount"},{"title":"XApuGetUtilization","description":"XApuGetUtilization","sidebarTitle":"XApuGetUtilization","href":"/reference/audio/xapu/functions/xapugetutilization"}]},{"group":"Structs","pages":[{"title":"XApuCommandId","description":"XApuCommandId","sidebarTitle":"XApuCommandId","href":"/reference/audio/xapu/structs/xapucommandid"},{"title":"XApuConnectInputParameters","description":"XApuConnectInputParameters","sidebarTitle":"XApuConnectInputParameters","href":"/reference/audio/xapu/structs/xapuconnectinputparameters"},{"title":"XApuConnectOutputParameters","description":"XApuConnectOutputParameters","sidebarTitle":"XApuConnectOutputParameters","href":"/reference/audio/xapu/structs/xapuconnectoutputparameters"},{"title":"XApuDecodeConvertActivateCommand","description":"XApuDecodeConvertActivateCommand","sidebarTitle":"XApuDecodeConvertActivateCommand","href":"/reference/audio/xapu/structs/xapudecodeconvertactivatecommand"},{"title":"XApuDecodeConvertCommand","description":"XApuDecodeConvertCommand","sidebarTitle":"XApuDecodeConvertCommand","href":"/reference/audio/xapu/structs/xapudecodeconvertcommand"},{"title":"Xapuresult","href":"/reference/audio/xapu/structs/xapuresult"},{"title":"XApuUtilization","description":"XApuUtilization","sidebarTitle":"XApuUtilization","href":"/reference/audio/xapu/structs/xapuutilization"}]}]},{"group":"XDSP","pages":[{"title":"XDSP audio","description":"XDSP audio","sidebarTitle":"XDSP audio","href":"/reference/audio/xdspaudio/xdspaudio_members"},{"group":"Functions","pages":[{"title":"ButterflyDIT4_1","description":"ButterflyDIT4_1","sidebarTitle":"ButterflyDIT4_1","href":"/reference/audio/xdsp/functions/butterflydit4_1"},{"title":"ButterflyDIT4_4","description":"ButterflyDIT4_4","sidebarTitle":"ButterflyDIT4_4","href":"/reference/audio/xdsp/functions/butterflydit4_4"},{"title":"Deinterleave","description":"Deinterleave","sidebarTitle":"Deinterleave","href":"/reference/audio/xdsp/functions/deinterleave"},{"title":"FFT","description":"FFT","sidebarTitle":"FFT","href":"/reference/audio/xdsp/functions/fft"},{"title":"FFT16","description":"FFT16","sidebarTitle":"FFT16","href":"/reference/audio/xdsp/functions/fft16"},{"title":"FFT4","description":"FFT4","sidebarTitle":"FFT4","href":"/reference/audio/xdsp/functions/fft4"},{"title":"FFT8","description":"FFT8","sidebarTitle":"FFT8","href":"/reference/audio/xdsp/functions/fft8"},{"title":"FFTInitializeUnityTable","description":"FFTInitializeUnityTable","sidebarTitle":"FFTInitializeUnityTable","href":"/reference/audio/xdsp/functions/fftinitializeunitytable"},{"title":"FFTInterleaved","description":"FFTInterleaved","sidebarTitle":"FFTInterleaved","href":"/reference/audio/xdsp/functions/fftinterleaved"},{"title":"FFTPolar","description":"FFTPolar","sidebarTitle":"FFTPolar","href":"/reference/audio/xdsp/functions/fftpolar"},{"title":"FFTUnswizzle","description":"FFTUnswizzle","sidebarTitle":"FFTUnswizzle","href":"/reference/audio/xdsp/functions/fftunswizzle"},{"title":"IFFTDeinterleaved","description":"IFFTDeinterleaved","sidebarTitle":"IFFTDeinterleaved","href":"/reference/audio/xdsp/functions/ifftdeinterleaved"},{"title":"Interleave","description":"Interleave","sidebarTitle":"Interleave","href":"/reference/audio/xdsp/functions/interleave"},{"title":"ISPOWEROF2","description":"ISPOWEROF2","sidebarTitle":"ISPOWEROF2","href":"/reference/audio/xdsp/functions/ispowerof2"},{"title":"vmulComplex function","description":"vmulComplex function","sidebarTitle":"vmulComplex function","href":"/reference/audio/xdsp/functions/vmulcomplex"},{"title":"vmulComplex","description":"vmulComplex","sidebarTitle":"vmulComplex","href":"/reference/audio/xdsp/functions/vmulcomplex_2"}]}]},{"group":"XMA2Defs","pages":[{"title":"XMA2Defs","description":"XMA2Defs","sidebarTitle":"XMA2Defs","href":"/reference/audio/xma2defs/xma2defs_members"},{"group":"Functions","pages":[{"title":"GetLastXmaFrameBitPosition","description":"GetLastXmaFrameBitPosition","sidebarTitle":"GetLastXmaFrameBitPosition","href":"/reference/audio/xma2defs/functions/getlastxmaframebitposition"},{"title":"GetStandardChannelMaskFromXmaMask","description":"GetStandardChannelMaskFromXmaMask","sidebarTitle":"GetStandardChannelMaskFromXmaMask","href":"/reference/audio/xma2defs/functions/getstandardchannelmaskfromxmamask"},{"title":"GetXmaBlockContainingSample","description":"GetXmaBlockContainingSample","sidebarTitle":"GetXmaBlockContainingSample","href":"/reference/audio/xma2defs/functions/getxmablockcontainingsample"},{"title":"GetXmaChannelMaskFromStandardMask","description":"GetXmaChannelMaskFromStandardMask","sidebarTitle":"GetXmaChannelMaskFromStandardMask","href":"/reference/audio/xma2defs/functions/getxmachannelmaskfromstandardmask"},{"title":"GetXmaDecodePositionForSample","description":"GetXmaDecodePositionForSample","sidebarTitle":"GetXmaDecodePositionForSample","href":"/reference/audio/xma2defs/functions/getxmadecodepositionforsample"},{"title":"GetXmaFrameBitPosition","description":"GetXmaFrameBitPosition","sidebarTitle":"GetXmaFrameBitPosition","href":"/reference/audio/xma2defs/functions/getxmaframebitposition"},{"title":"GetXmaFrameLengthInBits","description":"GetXmaFrameLengthInBits","sidebarTitle":"GetXmaFrameLengthInBits","href":"/reference/audio/xma2defs/functions/getxmaframelengthinbits"},{"title":"GetXmaPacketFirstFrameOffsetInBits","description":"GetXmaPacketFirstFrameOffsetInBits","sidebarTitle":"GetXmaPacketFirstFrameOffsetInBits","href":"/reference/audio/xma2defs/functions/getxmapacketfirstframeoffsetinbits"},{"title":"GetXmaPacketFrameCount","description":"GetXmaPacketFrameCount","sidebarTitle":"GetXmaPacketFrameCount","href":"/reference/audio/xma2defs/functions/getxmapacketframecount"},{"title":"GetXmaPacketMetadata","description":"GetXmaPacketMetadata","sidebarTitle":"GetXmaPacketMetadata","href":"/reference/audio/xma2defs/functions/getxmapacketmetadata"},{"title":"GetXmaPacketSkipCount","description":"GetXmaPacketSkipCount","sidebarTitle":"GetXmaPacketSkipCount","href":"/reference/audio/xma2defs/functions/getxmapacketskipcount"},{"title":"GetXmaSampleRate","description":"GetXmaSampleRate","sidebarTitle":"GetXmaSampleRate","href":"/reference/audio/xma2defs/functions/getxmasamplerate"},{"title":"LocalizeXma2Format","description":"LocalizeXma2Format","sidebarTitle":"LocalizeXma2Format","href":"/reference/audio/xma2defs/functions/localizexma2format"}]},{"group":"Structs","pages":[{"title":"XMA2PACKET","description":"XMA2PACKET","sidebarTitle":"XMA2PACKET","href":"/reference/audio/xma2defs/structs/xma2packet"},{"title":"XMA2STREAMFORMAT","description":"XMA2STREAMFORMAT","sidebarTitle":"XMA2STREAMFORMAT","href":"/reference/audio/xma2defs/structs/xma2streamformat"},{"title":"XMA2WAVEFORMAT","description":"XMA2WAVEFORMAT","sidebarTitle":"XMA2WAVEFORMAT","href":"/reference/audio/xma2defs/structs/xma2waveformat"},{"title":"XMA2WAVEFORMATEX","description":"XMA2WAVEFORMATEX","sidebarTitle":"XMA2WAVEFORMATEX","href":"/reference/audio/xma2defs/structs/xma2waveformatex"},{"title":"XMASTREAMFORMAT","description":"XMASTREAMFORMAT","sidebarTitle":"XMASTREAMFORMAT","href":"/reference/audio/xma2defs/structs/xmastreamformat"},{"title":"XMAWAVEFORMAT","description":"XMAWAVEFORMAT","sidebarTitle":"XMAWAVEFORMAT","href":"/reference/audio/xma2defs/structs/xmawaveformat"}]}]},{"group":"XAudio2 Helper APIs","pages":[{"title":"XAudio2 Helper APIs","description":"Reference for the XAudio2 Helper APIs in the Microsoft Game Development Kit (GDK), including XAudio2Xbox playback helpers and XDSP digital signal processing.","sidebarTitle":"XAudio2 Helper APIs","href":"/reference/audio/atoc-xaudio2helperapis-reference"}]},{"group":"XAudio2Xbox","pages":[{"group":"Functions","pages":[{"title":"XAudio2CreateWithSharedContexts","description":"XAudio2CreateWithSharedContexts","sidebarTitle":"XAudio2CreateWithSharedContexts","href":"/reference/audio/xaudio2xbox/functions/xaudio2createwithsharedcontexts"}]},{"group":"Structs","pages":[{"title":"FXLOUDNESS_PARAMETERS","description":"FXLOUDNESS_PARAMETERS","sidebarTitle":"FXLOUDNESS_PARAMETERS","href":"/reference/audio/xaudio2xbox/structs/fxloudness_parameters"}]}]},{"group":"XDSP audio","pages":[{"group":"Enums","pages":[{"title":"XDspActivationOptions","description":"XDspActivationOptions","sidebarTitle":"XDspActivationOptions","href":"/reference/audio/xdspaudio/enums/xdspactivationoptions"},{"title":"XDSP Errors","description":"XDSP Errors","sidebarTitle":"XDSP Errors","href":"/reference/audio/xdspaudio/enums/xdsperrors"},{"title":"XDspProcessType","description":"XDspProcessType","sidebarTitle":"XDspProcessType","href":"/reference/audio/xdspaudio/enums/xdspprocesstype"}]},{"group":"Functions","pages":[{"title":"XDspActivate","description":"XDspActivate","sidebarTitle":"XDspActivate","href":"/reference/audio/xdspaudio/functions/xdspactivate"},{"title":"XDspConnect","description":"XDspConnect","sidebarTitle":"XDspConnect","href":"/reference/audio/xdspaudio/functions/xdspconnect"},{"title":"XDspConnectWithMaximumStreamLimit","description":"XDspConnectWithMaximumStreamLimit","sidebarTitle":"XDspConnectWithMaximumStreamLimit","href":"/reference/audio/xdspaudio/functions/xdspconnectwithmaximumstreamlimit"},{"title":"XDspDeactivate","description":"XDspDeactivate","sidebarTitle":"XDspDeactivate","href":"/reference/audio/xdspaudio/functions/xdspdeactivate"},{"title":"XDspDisconnect","description":"XDspDisconnect","sidebarTitle":"XDspDisconnect","href":"/reference/audio/xdspaudio/functions/xdspdisconnect"},{"title":"XDspSubmitCommand","description":"XDspSubmitCommand","sidebarTitle":"XDspSubmitCommand","href":"/reference/audio/xdspaudio/functions/xdspsubmitcommand"},{"title":"XDspSubmitCommandWithEnvelope","description":"XDspSubmitCommandWithEnvelope","sidebarTitle":"XDspSubmitCommandWithEnvelope","href":"/reference/audio/xdspaudio/functions/xdspsubmitcommandwithenvelope"}]},{"group":"Structs","pages":[{"title":"XDspActivationParameters","description":"XDspActivationParameters","sidebarTitle":"XDspActivationParameters","href":"/reference/audio/xdspaudio/structs/xdspactivationparameters"},{"title":"XDspCommand","description":"XDspCommand","sidebarTitle":"XDspCommand","href":"/reference/audio/xdspaudio/structs/xdspcommand"},{"title":"XDspStatus","description":"XDspStatus","sidebarTitle":"XDspStatus","href":"/reference/audio/xdspaudio/structs/xdspstatus"}]}]}]},{"group":"Chat API reference","pages":[{"title":"Chat API reference","description":"Chat API reference for the Microsoft Game Development Kit (GDK), including Game Chat 2 voice APIs and links to PlayFab Party networking documentation.","sidebarTitle":"Chat API Reference","href":"/reference/chat/gc-reference-chat-toc"},{"group":"GameChat2","pages":[{"title":"GameChat2 members","description":"GameChat2 members","sidebarTitle":"GameChat2 members","href":"/reference/chat/gamechat2/gamechat2_members"},{"group":"Classes","pages":[{"group":"chat_manager","pages":[{"group":"Methods","pages":[{"title":"chat_manager::add_local_user","description":"chat_manager::add_local_user","sidebarTitle":"chat_manager::add_local_user","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_add_local_user"},{"title":"chat_manager::add_remote_user","description":"chat_manager::add_remote_user","sidebarTitle":"chat_manager::add_remote_user","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_add_remote_user"},{"title":"chat_manager::audio_encoding_bitrate","description":"chat_manager::audio_encoding_bitrate","sidebarTitle":"chat_manager::audio_encoding_bitrate","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_audio_encoding_bitrate"},{"title":"chat_manager::audio_manipulation_mode","description":"chat_manager::audio_manipulation_mode","sidebarTitle":"chat_manager::audio_manipulation_mode","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_audio_manipulation_mode"},{"title":"chat_manager::cleanup","description":"chat_manager::cleanup","sidebarTitle":"chat_manager::cleanup","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_cleanup"},{"title":"chat_manager::finish_processing_data_frames","description":"chat_manager::finish_processing_data_frames","sidebarTitle":"chat_manager::finish_processing_data_frames","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_finish_processing_data_frames"},{"title":"chat_manager::finish_processing_state_changes","description":"chat_manager::finish_processing_state_changes","sidebarTitle":"chat_manager::finish_processing_state_changes","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_finish_processing_state_changes"},{"title":"chat_manager::finish_processing_stream_state_changes","description":"chat_manager::finish_processing_stream_state_changes","sidebarTitle":"chat_manager::finish_processing_stream_state_changes","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_finish_processing_stream_state_changes"},{"title":"chat_manager::get_chat_users","description":"chat_manager::get_chat_users","sidebarTitle":"chat_manager::get_chat_users","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_get_chat_users"},{"title":"chat_manager::get_memory_callbacks","description":"chat_manager::get_memory_callbacks","sidebarTitle":"chat_manager::get_memory_callbacks","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_get_memory_callbacks"},{"title":"chat_manager::get_post_decode_audio_sink_streams","description":"chat_manager::get_post_decode_audio_sink_streams","sidebarTitle":"chat_manager::get_post_decode_audio_sink_streams","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_get_post_decode_audio_sink_streams"},{"title":"chat_manager::get_post_decode_audio_source_streams","description":"chat_manager::get_post_decode_audio_source_streams","sidebarTitle":"chat_manager::get_post_decode_audio_source_streams","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_get_post_decode_audio_source_streams"},{"title":"chat_manager::get_pre_encode_audio_streams","description":"chat_manager::get_pre_encode_audio_streams","sidebarTitle":"chat_manager::get_pre_encode_audio_streams","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_get_pre_encode_audio_streams"},{"title":"chat_manager::get_thread_affinity_mask","description":"chat_manager::get_thread_affinity_mask","sidebarTitle":"chat_manager::get_thread_affinity_mask","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_get_thread_affinity_mask"},{"title":"chat_manager::get_thread_processor","description":"chat_manager::get_thread_processor","sidebarTitle":"chat_manager::get_thread_processor","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_get_thread_processor"},{"title":"chat_manager::initialize","description":"chat_manager::initialize","sidebarTitle":"chat_manager::initialize","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_initialize"},{"title":"chat_manager::process_incoming_data","description":"chat_manager::process_incoming_data","sidebarTitle":"chat_manager::process_incoming_data","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_process_incoming_data"},{"title":"chat_manager::remove_user","description":"chat_manager::remove_user","sidebarTitle":"chat_manager::remove_user","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_remove_user"},{"title":"chat_manager::set_audio_encoding_bitrate","description":"chat_manager::set_audio_encoding_bitrate","sidebarTitle":"chat_manager::set_audio_encoding_bitrate","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_set_audio_encoding_bitrate"},{"title":"chat_manager::set_legacy_era_uwp_compat_mode_enabled","description":"chat_manager::set_legacy_era_uwp_compat_mode_enabled","sidebarTitle":"chat_manager::set_legacy_era_uwp_compat_mode_enabled","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_set_legacy_era_uwp_compat_mode_enabled"},{"title":"chat_manager::set_memory_callbacks","description":"chat_manager::set_memory_callbacks","sidebarTitle":"chat_manager::set_memory_callbacks","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_set_memory_callbacks"},{"title":"chat_manager::set_thread_affinity_mask","description":"chat_manager::set_thread_affinity_mask","sidebarTitle":"chat_manager::set_thread_affinity_mask","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_set_thread_affinity_mask"},{"title":"chat_manager::set_thread_processor","description":"chat_manager::set_thread_processor","sidebarTitle":"chat_manager::set_thread_processor","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_set_thread_processor"},{"title":"chat_manager::singleton_instance","description":"chat_manager::singleton_instance","sidebarTitle":"chat_manager::singleton_instance","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_singleton_instance"},{"title":"chat_manager::start_processing_data_frames","description":"chat_manager::start_processing_data_frames","sidebarTitle":"chat_manager::start_processing_data_frames","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_start_processing_data_frames"},{"title":"chat_manager::start_processing_state_changes","description":"chat_manager::start_processing_state_changes","sidebarTitle":"chat_manager::start_processing_state_changes","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_start_processing_state_changes"},{"title":"chat_manager::start_processing_stream_state_changes","description":"chat_manager::start_processing_stream_state_changes","sidebarTitle":"chat_manager::start_processing_stream_state_changes","href":"/reference/chat/gamechat2/classes/chat_manager/methods/chat_manager_start_processing_stream_state_changes"}]}]},{"group":"chat_user","pages":[{"group":"chat_user_local","pages":[{"group":"Methods","pages":[{"title":"chat_user_local::audio_render_volume","description":"chat_user_local::audio_render_volume","sidebarTitle":"chat_user_local::audio_render_volume","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_audio_render_volume"},{"title":"chat_user_local::get_effective_communication_relationship","description":"chat_user_local::get_effective_communication_relationship","sidebarTitle":"chat_user_local::get_effective_communication_relationship","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_get_effective_communication_relationship"},{"title":"chat_user_local::microphone_muted","description":"chat_user_local::microphone_muted","sidebarTitle":"chat_user_local::microphone_muted","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_microphone_muted"},{"title":"chat_user_local::remote_user_muted","description":"chat_user_local::remote_user_muted","sidebarTitle":"chat_user_local::remote_user_muted","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_remote_user_muted"},{"title":"chat_user_local::send_chat_text","description":"chat_user_local::send_chat_text","sidebarTitle":"chat_user_local::send_chat_text","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_send_chat_text"},{"title":"chat_user_local::set_audio_render_volume","description":"chat_user_local::set_audio_render_volume","sidebarTitle":"chat_user_local::set_audio_render_volume","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_set_audio_render_volume"},{"title":"chat_user_local::set_communication_relationship","description":"chat_user_local::set_communication_relationship","sidebarTitle":"chat_user_local::set_communication_relationship","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_set_communication_relationship"},{"title":"chat_user_local::set_microphone_muted","description":"chat_user_local::set_microphone_muted","sidebarTitle":"chat_user_local::set_microphone_muted","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_set_microphone_muted"},{"title":"chat_user_local::set_remote_user_muted","description":"chat_user_local::set_remote_user_muted","sidebarTitle":"chat_user_local::set_remote_user_muted","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_set_remote_user_muted"},{"title":"chat_user_local::speech_to_text_conversion_preference_enabled","description":"chat_user_local::speech_to_text_conversion_preference_enabled","sidebarTitle":"chat_user_local::speech_to_text_conversion_preference_enabled","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_speech_to_text_conversion_preference_enabled"},{"title":"chat_user_local::synthesize_text_to_speech","description":"chat_user_local::synthesize_text_to_speech","sidebarTitle":"chat_user_local::synthesize_text_to_speech","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_synthesize_text_to_speech"},{"title":"chat_user_local::text_to_speech_conversion_preference_enabled","description":"chat_user_local::text_to_speech_conversion_preference_enabled","sidebarTitle":"chat_user_local::text_to_speech_conversion_preference_enabled","href":"/reference/chat/gamechat2/classes/chat_user/chat_user_local/methods/chat_user_local_text_to_speech_conversion_preference_enabled"}]}]},{"group":"Methods","pages":[{"title":"chat_user::chat_indicator","description":"chat_user::chat_indicator","sidebarTitle":"chat_user::chat_indicator","href":"/reference/chat/gamechat2/classes/chat_user/methods/chat_user_chat_indicator"},{"title":"chat_user::custom_user_context","description":"chat_user::custom_user_context","sidebarTitle":"chat_user::custom_user_context","href":"/reference/chat/gamechat2/classes/chat_user/methods/chat_user_custom_user_context"},{"title":"chat_user::local function","description":"chat_user::local function","sidebarTitle":"chat_user::local function","href":"/reference/chat/gamechat2/classes/chat_user/methods/chat_user_local_function"},{"title":"chat_user::local","description":"chat_user::local","sidebarTitle":"chat_user::local","href":"/reference/chat/gamechat2/classes/chat_user/methods/chat_user_local_function_2"},{"title":"chat_user::local function - overloads","description":"chat_user::local function - overloads","sidebarTitle":"chat_user::local function - overloads","href":"/reference/chat/gamechat2/classes/chat_user/methods/chat_user_local_function-overloads"},{"title":"chat_user::set_custom_user_context","description":"chat_user::set_custom_user_context","sidebarTitle":"chat_user::set_custom_user_context","href":"/reference/chat/gamechat2/classes/chat_user/methods/chat_user_set_custom_user_context"},{"title":"chat_user::xbox_user_id","description":"chat_user::xbox_user_id","sidebarTitle":"chat_user::xbox_user_id","href":"/reference/chat/gamechat2/classes/chat_user/methods/chat_user_xbox_user_id"}]}]},{"group":"post_decode_audio_sink_stream","pages":[{"group":"Methods","pages":[{"title":"post_decode_audio_sink_stream::can_receive_audio_from_source_stream","description":"post_decode_audio_sink_stream::can_receive_audio_from_source_stream","sidebarTitle":"post_decode_audio_sink_stream::can_receive_audio_from_source_stream","href":"/reference/chat/gamechat2/classes/post_decode_audio_sink_stream/methods/post_decode_audio_sink_stream_can_receive_audio_from_source_stream"},{"title":"post_decode_audio_sink_stream::custom_stream_context","description":"post_decode_audio_sink_stream::custom_stream_context","sidebarTitle":"post_decode_audio_sink_stream::custom_stream_context","href":"/reference/chat/gamechat2/classes/post_decode_audio_sink_stream/methods/post_decode_audio_sink_stream_custom_stream_context"},{"title":"post_decode_audio_sink_stream::get_device_id","description":"post_decode_audio_sink_stream::get_device_id","sidebarTitle":"post_decode_audio_sink_stream::get_device_id","href":"/reference/chat/gamechat2/classes/post_decode_audio_sink_stream/methods/post_decode_audio_sink_stream_get_device_id"},{"title":"post_decode_audio_sink_stream::get_users","description":"post_decode_audio_sink_stream::get_users","sidebarTitle":"post_decode_audio_sink_stream::get_users","href":"/reference/chat/gamechat2/classes/post_decode_audio_sink_stream/methods/post_decode_audio_sink_stream_get_users"},{"title":"post_decode_audio_sink_stream::is_open","description":"post_decode_audio_sink_stream::is_open","sidebarTitle":"post_decode_audio_sink_stream::is_open","href":"/reference/chat/gamechat2/classes/post_decode_audio_sink_stream/methods/post_decode_audio_sink_stream_is_open"},{"title":"post_decode_audio_sink_stream::set_custom_stream_context","description":"post_decode_audio_sink_stream::set_custom_stream_context","sidebarTitle":"post_decode_audio_sink_stream::set_custom_stream_context","href":"/reference/chat/gamechat2/classes/post_decode_audio_sink_stream/methods/post_decode_audio_sink_stream_set_custom_stream_context"},{"title":"post_decode_audio_sink_stream::set_processed_format","description":"post_decode_audio_sink_stream::set_processed_format","sidebarTitle":"post_decode_audio_sink_stream::set_processed_format","href":"/reference/chat/gamechat2/classes/post_decode_audio_sink_stream/methods/post_decode_audio_sink_stream_set_processed_format"},{"title":"post_decode_audio_sink_stream::submit_mixed_buffer","description":"post_decode_audio_sink_stream::submit_mixed_buffer","sidebarTitle":"post_decode_audio_sink_stream::submit_mixed_buffer","href":"/reference/chat/gamechat2/classes/post_decode_audio_sink_stream/methods/post_decode_audio_sink_stream_submit_mixed_buffer"}]}]},{"group":"post_decode_audio_source_stream","pages":[{"group":"Methods","pages":[{"title":"post_decode_audio_source_stream::custom_stream_context","description":"post_decode_audio_source_stream::custom_stream_context","sidebarTitle":"post_decode_audio_source_stream::custom_stream_context","href":"/reference/chat/gamechat2/classes/post_decode_audio_source_stream/methods/post_decode_audio_source_stream_custom_stream_context"},{"title":"post_decode_audio_source_stream::get_available_buffer_count","description":"post_decode_audio_source_stream::get_available_buffer_count","sidebarTitle":"post_decode_audio_source_stream::get_available_buffer_count","href":"/reference/chat/gamechat2/classes/post_decode_audio_source_stream/methods/post_decode_audio_source_stream_get_available_buffer_count"},{"title":"post_decode_audio_source_stream::get_next_buffer","description":"post_decode_audio_source_stream::get_next_buffer","sidebarTitle":"post_decode_audio_source_stream::get_next_buffer","href":"/reference/chat/gamechat2/classes/post_decode_audio_source_stream/methods/post_decode_audio_source_stream_get_next_buffer"},{"title":"post_decode_audio_source_stream::get_pre_processed_format","description":"post_decode_audio_source_stream::get_pre_processed_format","sidebarTitle":"post_decode_audio_source_stream::get_pre_processed_format","href":"/reference/chat/gamechat2/classes/post_decode_audio_source_stream/methods/post_decode_audio_source_stream_get_pre_processed_format"},{"title":"post_decode_audio_source_stream::get_users","description":"post_decode_audio_source_stream::get_users","sidebarTitle":"post_decode_audio_source_stream::get_users","href":"/reference/chat/gamechat2/classes/post_decode_audio_source_stream/methods/post_decode_audio_source_stream_get_users"},{"title":"post_decode_audio_source_stream::is_open","description":"post_decode_audio_source_stream::is_open","sidebarTitle":"post_decode_audio_source_stream::is_open","href":"/reference/chat/gamechat2/classes/post_decode_audio_source_stream/methods/post_decode_audio_source_stream_is_open"},{"title":"post_decode_audio_source_stream::return_buffer","description":"post_decode_audio_source_stream::return_buffer","sidebarTitle":"post_decode_audio_source_stream::return_buffer","href":"/reference/chat/gamechat2/classes/post_decode_audio_source_stream/methods/post_decode_audio_source_stream_return_buffer"},{"title":"post_decode_audio_source_stream::set_custom_stream_context","description":"post_decode_audio_source_stream::set_custom_stream_context","sidebarTitle":"post_decode_audio_source_stream::set_custom_stream_context","href":"/reference/chat/gamechat2/classes/post_decode_audio_source_stream/methods/post_decode_audio_source_stream_set_custom_stream_context"}]}]},{"group":"pre_encode_audio_stream","pages":[{"group":"Methods","pages":[{"title":"pre_encode_audio_stream::custom_stream_context","description":"pre_encode_audio_stream::custom_stream_context","sidebarTitle":"pre_encode_audio_stream::custom_stream_context","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_custom_stream_context"},{"title":"pre_encode_audio_stream::get_available_buffer_count","description":"pre_encode_audio_stream::get_available_buffer_count","sidebarTitle":"pre_encode_audio_stream::get_available_buffer_count","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_get_available_buffer_count"},{"title":"pre_encode_audio_stream::get_next_buffer","description":"pre_encode_audio_stream::get_next_buffer","sidebarTitle":"pre_encode_audio_stream::get_next_buffer","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_get_next_buffer"},{"title":"pre_encode_audio_stream::get_pre_processed_format","description":"pre_encode_audio_stream::get_pre_processed_format","sidebarTitle":"pre_encode_audio_stream::get_pre_processed_format","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_get_pre_processed_format"},{"title":"pre_encode_audio_stream::get_users","description":"pre_encode_audio_stream::get_users","sidebarTitle":"pre_encode_audio_stream::get_users","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_get_users"},{"title":"pre_encode_audio_stream::is_open","description":"pre_encode_audio_stream::is_open","sidebarTitle":"pre_encode_audio_stream::is_open","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_is_open"},{"title":"pre_encode_audio_stream::return_buffer","description":"pre_encode_audio_stream::return_buffer","sidebarTitle":"pre_encode_audio_stream::return_buffer","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_return_buffer"},{"title":"pre_encode_audio_stream::set_custom_stream_context","description":"pre_encode_audio_stream::set_custom_stream_context","sidebarTitle":"pre_encode_audio_stream::set_custom_stream_context","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_set_custom_stream_context"},{"title":"pre_encode_audio_stream::set_processed_format","description":"pre_encode_audio_stream::set_processed_format","sidebarTitle":"pre_encode_audio_stream::set_processed_format","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_set_processed_format"},{"title":"pre_encode_audio_stream::submit_buffer","description":"pre_encode_audio_stream::submit_buffer","sidebarTitle":"pre_encode_audio_stream::submit_buffer","href":"/reference/chat/gamechat2/classes/pre_encode_audio_stream/methods/pre_encode_audio_stream_submit_buffer"}]}]}]},{"group":"Enums","pages":[{"title":"game_chat_audio_encoding_bitrate","description":"game_chat_audio_encoding_bitrate","sidebarTitle":"game_chat_audio_encoding_bitrate","href":"/reference/chat/gamechat2/enums/game_chat_audio_encoding_bitrate"},{"title":"game_chat_audio_manipulation_mode_flags","description":"game_chat_audio_manipulation_mode_flags","sidebarTitle":"game_chat_audio_manipulation_mode_flags","href":"/reference/chat/gamechat2/enums/game_chat_audio_manipulation_mode_flags"},{"title":"game_chat_communication_relationship_adjuster","description":"game_chat_communication_relationship_adjuster","sidebarTitle":"game_chat_communication_relationship_adjuster","href":"/reference/chat/gamechat2/enums/game_chat_communication_relationship_adjuster"},{"title":"game_chat_communication_relationship_flags","description":"game_chat_communication_relationship_flags","sidebarTitle":"game_chat_communication_relationship_flags","href":"/reference/chat/gamechat2/enums/game_chat_communication_relationship_flags"},{"title":"game_chat_data_transport_requirement","description":"game_chat_data_transport_requirement","sidebarTitle":"game_chat_data_transport_requirement","href":"/reference/chat/gamechat2/enums/game_chat_data_transport_requirement"},{"title":"game_chat_sample_type","description":"game_chat_sample_type","sidebarTitle":"game_chat_sample_type","href":"/reference/chat/gamechat2/enums/game_chat_sample_type"},{"title":"game_chat_shared_device_communication_relationship_resolution_mode","description":"game_chat_shared_device_communication_relationship_resolution_mode","sidebarTitle":"game_chat_shared_device_communication_relationship_resolution_mode","href":"/reference/chat/gamechat2/enums/game_chat_shared_device_communication_relationship_resolution_mode"},{"title":"game_chat_speech_to_text_conversion_mode","description":"game_chat_speech_to_text_conversion_mode","sidebarTitle":"game_chat_speech_to_text_conversion_mode","href":"/reference/chat/gamechat2/enums/game_chat_speech_to_text_conversion_mode"},{"title":"game_chat_state_change_type","description":"game_chat_state_change_type","sidebarTitle":"game_chat_state_change_type","href":"/reference/chat/gamechat2/enums/game_chat_state_change_type"},{"title":"game_chat_stream_state_change_type","description":"game_chat_stream_state_change_type","sidebarTitle":"game_chat_stream_state_change_type","href":"/reference/chat/gamechat2/enums/game_chat_stream_state_change_type"},{"title":"game_chat_thread_id","description":"game_chat_thread_id","sidebarTitle":"game_chat_thread_id","href":"/reference/chat/gamechat2/enums/game_chat_thread_id"},{"title":"game_chat_user_chat_indicator","description":"game_chat_user_chat_indicator","sidebarTitle":"game_chat_user_chat_indicator","href":"/reference/chat/gamechat2/enums/game_chat_user_chat_indicator"}]},{"group":"Functions","pages":[{"title":"game_chat_allocate_memory_callback","description":"game_chat_allocate_memory_callback","sidebarTitle":"game_chat_allocate_memory_callback","href":"/reference/chat/gamechat2/functions/game_chat_allocate_memory_callback"},{"title":"game_chat_free_memory_callback","description":"game_chat_free_memory_callback","sidebarTitle":"game_chat_free_memory_callback","href":"/reference/chat/gamechat2/functions/game_chat_free_memory_callback"}]},{"group":"Structs","pages":[{"title":"game_chat_audio_format","description":"game_chat_audio_format","sidebarTitle":"game_chat_audio_format","href":"/reference/chat/gamechat2/structs/game_chat_audio_format"},{"title":"game_chat_communication_relationship_adjuster_changed_state_change","description":"game_chat_communication_relationship_adjuster_changed_state_change","sidebarTitle":"game_chat_communication_relationship_adjuster_changed_state_change","href":"/reference/chat/gamechat2/structs/game_chat_communication_relationship_adjuster_changed_state_change"},{"title":"game_chat_data_frame","description":"game_chat_data_frame","sidebarTitle":"game_chat_data_frame","href":"/reference/chat/gamechat2/structs/game_chat_data_frame"},{"title":"game_chat_state_change","description":"game_chat_state_change","sidebarTitle":"game_chat_state_change","href":"/reference/chat/gamechat2/structs/game_chat_state_change"},{"title":"game_chat_stream_state_change","description":"game_chat_stream_state_change","sidebarTitle":"game_chat_stream_state_change","href":"/reference/chat/gamechat2/structs/game_chat_stream_state_change"},{"title":"game_chat_text_chat_received_state_change","description":"game_chat_text_chat_received_state_change","sidebarTitle":"game_chat_text_chat_received_state_change","href":"/reference/chat/gamechat2/structs/game_chat_text_chat_received_state_change"},{"title":"game_chat_text_conversion_preference_changed_state_change","description":"game_chat_text_conversion_preference_changed_state_change","sidebarTitle":"game_chat_text_conversion_preference_changed_state_change","href":"/reference/chat/gamechat2/structs/game_chat_text_conversion_preference_changed_state_change"},{"title":"game_chat_transcribed_chat_received_state_change","description":"game_chat_transcribed_chat_received_state_change","sidebarTitle":"game_chat_transcribed_chat_received_state_change","href":"/reference/chat/gamechat2/structs/game_chat_transcribed_chat_received_state_change"}]}]}]},{"group":"Developer kit only API reference","pages":[{"title":"Developer kit only API reference","description":"Reference for GDK APIs that only run on XBOX development kits, including XFrontPanelDisplay for controlling the XBOX One X dev kit front panel display.","sidebarTitle":"Developer Kit Only API Reference","href":"/reference/devkit/atoc-devkit-reference"},{"group":"XFrontPanelDisplay","pages":[{"title":"XFrontPanelDisplay","description":"XFrontPanelDisplay","sidebarTitle":"XFrontPanelDisplay","href":"/reference/devkit/xfrontpaneldisplay/xfrontpaneldisplay_members"},{"group":"Enums","pages":[{"title":"XFrontPanelButton","description":"XFrontPanelButton","sidebarTitle":"XFrontPanelButton","href":"/reference/devkit/xfrontpaneldisplay/enums/xfrontpanelbutton"},{"title":"XFrontPanelLight","description":"XFrontPanelLight","sidebarTitle":"XFrontPanelLight","href":"/reference/devkit/xfrontpaneldisplay/enums/xfrontpanellight"}]},{"group":"Functions","pages":[{"title":"XFrontPanelGetButtonStates","description":"XFrontPanelGetButtonStates","sidebarTitle":"XFrontPanelGetButtonStates","href":"/reference/devkit/xfrontpaneldisplay/functions/xfrontpanelgetbuttonstates"},{"title":"XFrontPanelGetLightStates","description":"XFrontPanelGetLightStates","sidebarTitle":"XFrontPanelGetLightStates","href":"/reference/devkit/xfrontpaneldisplay/functions/xfrontpanelgetlightstates"},{"title":"XFrontPanelGetScreenDimensions","description":"XFrontPanelGetScreenDimensions","sidebarTitle":"XFrontPanelGetScreenDimensions","href":"/reference/devkit/xfrontpaneldisplay/functions/xfrontpanelgetscreendimensions"},{"title":"XFrontPanelGetScreenPixelFormat","description":"XFrontPanelGetScreenPixelFormat","sidebarTitle":"XFrontPanelGetScreenPixelFormat","href":"/reference/devkit/xfrontpaneldisplay/functions/xfrontpanelgetscreenpixelformat"},{"title":"XFrontPanelIsSupported","description":"XFrontPanelIsSupported","sidebarTitle":"XFrontPanelIsSupported","href":"/reference/devkit/xfrontpaneldisplay/functions/xfrontpanelissupported"},{"title":"XFrontPanelPresentBuffer","description":"XFrontPanelPresentBuffer","sidebarTitle":"XFrontPanelPresentBuffer","href":"/reference/devkit/xfrontpaneldisplay/functions/xfrontpanelpresentbuffer"},{"title":"XFrontPanelSetDisplayName","description":"XFrontPanelSetDisplayName","sidebarTitle":"XFrontPanelSetDisplayName","href":"/reference/devkit/xfrontpaneldisplay/functions/xfrontpanelsetdisplayname"},{"title":"XFrontPanelSetLightStates","description":"XFrontPanelSetLightStates","sidebarTitle":"XFrontPanelSetLightStates","href":"/reference/devkit/xfrontpaneldisplay/functions/xfrontpanelsetlightstates"}]}]}]},{"group":"Graphics API reference","pages":[{"title":"Gc reference graphics toc","href":"/reference/graphics/gc-reference-graphics-toc"},{"group":"d3d12","icon":"cube","pages":[{"group":"enums","pages":[{"title":"D3D_ROOT_SIGNATURE_VERSION","description":"Specifies the version of root signature layout.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d_root_signature_version_public","hiddenSetByFrontmatter":true},{"title":"D3D_SHADER_MODEL","description":"Specifies a shader model.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d_shader_model_public","hiddenSetByFrontmatter":true},{"title":"D3D12_AUTO_BREADCRUMB_OP","description":"Defines constants that specify render/compute GPU operations. (D3D12_AUTO_BREADCRUMB_OP)","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_auto_breadcrumb_op_public","hiddenSetByFrontmatter":true},{"title":"D3D12_AXIS_SHADING_RATE (XBOX Series consoles)","description":"Defines constants that specify the shading rate (for variable-rate shading, or VRS) along a horizontal or vertical axis.","sidebarTitle":"D3D12_AXIS_SHADING_RATE","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_axis_shading_rate_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BACKGROUND_PROCESSING_MODE (XBOX Series consoles)","description":"Defines constants that specify a level of dynamic optimization to apply to GPU work that's subsequently submitted.","sidebarTitle":"D3D12_BACKGROUND_PROCESSING_MODE","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_background_processing_mode_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BLEND_OP","description":"Specifies RGB or alpha blending operations.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_blend_op_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BLEND","description":"Specifies blend factors, which modulate values for the pixel shader and render target.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_blend_public","hiddenSetByFrontmatter":true},{"title":"D3D12_CLEAR_FLAGS","description":"Specifies what to clear from the depth stencil view.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_clear_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_COLOR_WRITE_ENABLE","description":"Identifies which components of each pixel of a render target are writable during blending.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_color_write_enable_public","hiddenSetByFrontmatter":true},{"title":"D3D12_COMMAND_LIST_FLAGS (XBOX Series consoles)","description":"The D3D12_COMMAND_LIST_FLAGS enumeration specifies flags to be used when creating a command list.","sidebarTitle":"D3D12_COMMAND_LIST_FLAGS","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_command_list_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_COMMAND_LIST_SUPPORT_FLAGS","description":"Used to determine which kinds of command lists are capable of supporting various operations.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_command_list_support_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_COMMAND_QUEUE_PRIORITY","description":"Defines priority levels for a command queue.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_command_queue_priority_public","hiddenSetByFrontmatter":true},{"title":"D3D12_COMPARISON_FUNC","description":"Specifies comparison options.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_comparison_func_public","hiddenSetByFrontmatter":true},{"title":"D3D12_CONSERVATIVE_RASTERIZATION_MODE","description":"Identifies whether conservative rasterization is on or off. (D3D12_CONSERVATIVE_RASTERIZATION_MODE)","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_conservative_rasterization_mode_public","hiddenSetByFrontmatter":true},{"title":"D3D12_CONSERVATIVE_RASTERIZATION_TIER","description":"Identifies the tier level of conservative rasterization.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_conservative_rasterization_tier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_CPU_PAGE_PROPERTY","description":"Specifies the CPU-page properties for the heap.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_cpu_page_property_public","hiddenSetByFrontmatter":true},{"title":"D3D12_CROSS_NODE_SHARING_TIER","description":"Specifies the level of sharing across nodes of an adapter, such as Tier 1 Emulated, Tier 1, or Tier 2.","href":"/reference/graphics/d3d12/enums/d3d12_cross_node_sharing_tier_public"},{"title":"D3D12_CULL_MODE","description":"Specifies triangles facing a particular direction are not drawn.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_cull_mode_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DEPTH_WRITE_MASK","description":"Identifies the portion of a depth-stencil buffer for writing depth data.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_depth_write_mask_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DESCRIPTOR_HEAP_TYPE","description":"Specifies a type of descriptor heap.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_descriptor_heap_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DESCRIPTOR_RANGE_FLAGS","description":"Specifies the volatility of both descriptors and the data they reference in a Root Signature 1.1 description, which can enable some driver optimizations.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_descriptor_range_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DESCRIPTOR_RANGE_TYPE","description":"Specifies a range so that, for example, if part of a descriptor table has 100 shader-resource views (SRVs) that range can be declared in one entry rather.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_descriptor_range_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRED_ALLOCATION_TYPE","description":"Congruent with, and numerically equivalent to, 3D12DDI_HANDLETYPE enumeration values.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_dred_allocation_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRED_ENABLEMENT","description":"Defines constants that specify render/compute GPU operations. (D3D12_DRED_ENABLEMENT)","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_dred_enablement_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRED_FLAGS","description":"Defines constants used in the D3D12_DEVICE_REMOVED_EXTENDED_DATA structure to specify control flags for the Direct3D runtime.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_dred_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRED_VERSION","description":"Defines constants that specify a version of Device Removed Extended Data (DRED), as used by the D3D12_VERSIONED_DEVICE_REMOVED_EXTENDED_DATA structure.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_dred_version_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRIVER_MATCHING_IDENTIFIER_STATUS","description":"Specifies the result of a call to ID3D12Device5::CheckDriverMatchingIdentifier which queries whether serialized data is compatible with the current device.","sidebarTitle":"D3D12_DRIVER_MATCHING_IDENTIFIER_STATUS","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_driver_matching_identifier_status_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DSV_DIMENSION","description":"Specifies how to access a resource used in a depth-stencil view. (D3D12_DSV_DIMENSION)","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_dsv_dimension_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DSV_FLAGS","description":"Specifies depth-stencil view options.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_dsv_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ELEMENTS_LAYOUT (XBOX Series consoles)","description":"Describes how the locations of elements are identified.","sidebarTitle":"D3D12_ELEMENTS_LAYOUT","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_elements_layout_public","hiddenSetByFrontmatter":true},{"title":"D3D12_EXPORT_FLAGS (XBOX Series consoles)","description":"The flags to apply when exporting symbols from a state subobject.","sidebarTitle":"D3D12_EXPORT_FLAGS","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_export_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE","description":"Defines constants that specify a Direct3D 12 feature or feature set to query about.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_feature_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FENCE_FLAGS","description":"Specifies fence options. (D3D12_FENCE_FLAGS)","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_fence_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FILL_MODE","description":"Specifies the fill mode to use when rendering triangles.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_fill_mode_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FILTER","description":"Specifies filtering options during texture sampling.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_filter_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FILTER_REDUCTION_TYPE","description":"Specifies the type of filter reduction.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_filter_reduction_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FILTER_TYPE","description":"Specifies the type of magnification or minification sampler filters.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_filter_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FORMAT_SUPPORT1","description":"Specifies resources that are supported for a provided format.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_format_support1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FORMAT_SUPPORT2","description":"Specifies which unordered resource options are supported for a provided format.","href":"/reference/graphics/d3d12/enums/d3d12_format_support2_public"},{"title":"D3D12_GRAPHICS_STATES","description":"Defines flags that specify states related to a graphics command list. Values can be bitwise OR'd together.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_graphics_states_public","hiddenSetByFrontmatter":true},{"title":"D3D12_HEAP_SERIALIZATION_TIER","description":"Defines constants that specify heap serialization support.","href":"/reference/graphics/d3d12/enums/d3d12_heap_serialization_tier_public"},{"title":"D3D12_HEAP_TYPE","description":"Specifies the type of heap. When resident, heaps reside in a particular physical memory pool with certain CPU cache properties.","href":"/reference/graphics/d3d12/enums/d3d12_heap_type_public"},{"title":"D3D12_HIT_GROUP_TYPE (XBOX Series consoles)","description":"Specifies the type of a raytracing hit group state subobject. Use a value from this enumeration with the D3D12_HIT_GROUP_DESC structure.","sidebarTitle":"D3D12_HIT_GROUP_TYPE","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_hit_group_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_INPUT_CLASSIFICATION","description":"Identifies the type of data contained in an input slot.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_input_classification_public","hiddenSetByFrontmatter":true},{"title":"D3D12_LIFETIME_STATE","description":"Defines constants that specify the lifetime state of a lifetime-tracked object.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_lifetime_state_public","hiddenSetByFrontmatter":true},{"title":"D3D12_LOGIC_OP","description":"Specifies logical operations to configure for a render target. (D3D12_LOGIC_OP)","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_logic_op_public","hiddenSetByFrontmatter":true},{"title":"D3D12_MEMORY_POOL","description":"Specifies the memory pool for the heap.","href":"/reference/graphics/d3d12/enums/d3d12_memory_pool_public"},{"title":"D3D12_META_COMMAND_PARAMETER_FLAGS","description":"Defines constants that specify the flags for a parameter to a meta command. Values can be bitwise OR'd together.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_meta_command_parameter_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_META_COMMAND_PARAMETER_STAGE","description":"Defines constants that specify the stage of a parameter to a meta command.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_meta_command_parameter_stage_public","hiddenSetByFrontmatter":true},{"title":"D3D12_META_COMMAND_PARAMETER_TYPE","description":"Defines constants that specify the data type of a parameter to a meta command.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_meta_command_parameter_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_MULTIPLE_FENCE_WAIT_FLAGS","description":"Specifies multiple wait flags for multiple fences.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_multiple_fence_wait_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_PREDICATION_OP","description":"Specifies the predication operation to apply.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_predication_op_public","hiddenSetByFrontmatter":true},{"title":"D3D12_PROGRAMMABLE_SAMPLE_POSITIONS_TIER","description":"Specifies the level of support for programmable sample positions that's offered by the adapter.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_programmable_sample_positions_tier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_PROTECTED_RESOURCE_SESSION_FLAGS","description":"Defines constants that specify protected resource session flags.","href":"/reference/graphics/d3d12/enums/d3d12_protected_resource_session_flags_public"},{"title":"D3D12_PROTECTED_RESOURCE_SESSION_SUPPORT_FLAGS","description":"Defines constants that specify protected resource session support.","href":"/reference/graphics/d3d12/enums/d3d12_protected_resource_session_support_flags_public"},{"title":"D3D12_PROTECTED_SESSION_STATUS","description":"Defines constants that specify protected session status.","href":"/reference/graphics/d3d12/enums/d3d12_protected_session_status_public"},{"title":"D3d12 raytracing acceleration structure build flags public","href":"/reference/graphics/d3d12/enums/d3d12_raytracing_acceleration_structure_build_flags_public"},{"title":"D3d12 raytracing acceleration structure copy mode public","href":"/reference/graphics/d3d12/enums/d3d12_raytracing_acceleration_structure_copy_mode_public"},{"title":"D3d12 raytracing acceleration structure postbuild info type public","href":"/reference/graphics/d3d12/enums/d3d12_raytracing_acceleration_structure_postbuild_info_type_public"},{"title":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_TYPE","description":"Specifies the type of a raytracing acceleration structure.","sidebarTitle":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_TYPE","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_raytracing_acceleration_structure_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_GEOMETRY_FLAGS (XBOX Series consoles)","description":"Specifies flags for raytracing geometry in a D3D12_RAYTRACING_GEOMETRY_DESC structure.","sidebarTitle":"D3D12_RAYTRACING_GEOMETRY_FLAGS","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_raytracing_geometry_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_GEOMETRY_TYPE (XBOX Series consoles)","description":"Specifies the type of geometry used for raytracing. Use a value from this enumeration to specify the geometry type in a D3D12_RAYTRACING_GEOMETRY_DESC.","sidebarTitle":"D3D12_RAYTRACING_GEOMETRY_TYPE","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_raytracing_geometry_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_INSTANCE_FLAGS (XBOX Series consoles)","description":"Flags for a raytracing acceleration structure instance. These flags can be used to override D3D12_RAYTRACING_GEOMETRY_FLAGS for individual instances.","sidebarTitle":"D3D12_RAYTRACING_INSTANCE_FLAGS","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_raytracing_instance_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_PIPELINE_FLAGS (XBOX Series consoles)","description":"Defines constants that specify configuration flags for a raytracing pipeline.","sidebarTitle":"D3D12_RAYTRACING_PIPELINE_FLAGS","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_raytracing_pipeline_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_TIER","description":"Specifies the level of ray tracing support on the graphics device.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_raytracing_tier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_BEGINNING_ACCESS_TYPE","description":"Specifies the type of access that an application is given to the specified resource(s) at the transition into a render pass.","href":"/reference/graphics/d3d12/enums/d3d12_render_pass_beginning_access_type_public"},{"title":"D3D12_RENDER_PASS_ENDING_ACCESS_TYPE","description":"Specifies the type of access that an application is given to the specified resource(s) at the transition out of a render pass.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_render_pass_ending_access_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_FLAGS (XBOX Series consoles)","description":"Specifies the nature of the render pass; for example, whether it is a suspending or a resuming render pass.","sidebarTitle":"D3D12_RENDER_PASS_FLAGS","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_render_pass_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_TIER","description":"Specifies the level of support for render passes on a graphics device.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_render_pass_tier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESIDENCY_FLAGS","description":"Used with the EnqueuMakeResident function to choose how residency operations proceed when the memory budget is exceeded.","href":"/reference/graphics/d3d12/enums/d3d12_residency_flags_public"},{"title":"D3D12_RESIDENCY_PRIORITY","description":"Specifies broad residency priority buckets useful for quickly establishing an application priority scheme.","href":"/reference/graphics/d3d12/enums/d3d12_residency_priority_public"},{"title":"D3D12_RESOLVE_MODE","description":"Specifies a resolve operation.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_resolve_mode_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESOURCE_BARRIER_TYPE","description":"Specifies a type of resource barrier (transition in resource use) description.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_resource_barrier_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESOURCE_BINDING_TIER","description":"Identifies the tier of resource binding being used.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_resource_binding_tier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESOURCE_HEAP_TIER","description":"Specifies which resource heap tier the hardware and driver support.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_resource_heap_tier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_DESCRIPTOR_FLAGS","description":"Specifies the volatility of the data referenced by descriptors in a Root Signature 1.1 description, which can enable some driver optimizations.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_root_descriptor_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_PARAMETER_TYPE","description":"Specifies the type of root signature slot.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_root_parameter_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RTV_DIMENSION","description":"Identifies the type of resource to view as a render target.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_rtv_dimension_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SERIALIZED_DATA_TYPE (XBOX Series consoles)","description":"Specifies the type of serialized data. Use a value from this enumeration when calling ID3D12Device5::CheckDriverMatchingIdentifier.","sidebarTitle":"D3D12_SERIALIZED_DATA_TYPE","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_serialized_data_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SHADER_CACHE_CONTROL_FLAGS (XBOX Series consoles)","description":"Defines constants that specify shader cache control options.","sidebarTitle":"D3D12_SHADER_CACHE_CONTROL_FLAGS","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_shader_cache_control_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SHADER_CACHE_FLAGS","description":"Defines constants that specify shader cache flags.","href":"/reference/graphics/d3d12/enums/d3d12_shader_cache_flags_public"},{"title":"D3D12_SHADER_CACHE_KIND_FLAGS (XBOX Series consoles)","description":"Defines constants that specify a kind of shader cache.","sidebarTitle":"D3D12_SHADER_CACHE_KIND_FLAGS","href":"/reference/graphics/d3d12/enums/d3d12_shader_cache_kind_flags_public"},{"title":"D3D12_SHADER_CACHE_MODE","description":"Defines constants that specify a shader cache's mode.","href":"/reference/graphics/d3d12/enums/d3d12_shader_cache_mode_public"},{"title":"D3D12_SHADER_CACHE_SUPPORT_FLAGS","description":"Describes the level of support for shader caching in the current graphics driver. (D3D12_SHADER_CACHE_SUPPORT_FLAGS)","href":"/reference/graphics/d3d12/enums/d3d12_shader_cache_support_flags_public"},{"title":"D3D12_SHADER_COMPONENT_MAPPING","description":"Specifies how memory gets routed by a shader resource view (SRV).","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_shader_component_mapping_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SHADER_MIN_PRECISION_SUPPORT","description":"Describes minimum precision support options for shaders in the current graphics driver.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_shader_min_precision_support_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SHADER_VISIBILITY","description":"Specifies the shaders that can access the contents of a given root signature slot.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_shader_visibility_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SHADING_RATE_COMBINER","description":"Defines constants that specify a shading rate combiner (for variable-rate shading, or VRS).","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_shading_rate_combiner_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SHADING_RATE (XBOX Series consoles)","description":"Defines constants that specify the shading rate (for variable-rate shading, or VRS).","sidebarTitle":"D3D12_SHADING_RATE","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_shading_rate_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STATE_OBJECT_FLAGS","description":"Specifies constraints for state objects. Use values from this enumeration in the D3D12_STATE_OBJECT_CONFIG structure.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_state_object_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STATE_OBJECT_TYPE","description":"Specifies the type of a state object. Use with D3D12_STATE_OBJECT_DESC.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_state_object_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STATE_SUBOBJECT_TYPE","description":"D3D12_STATE_SUBOBJECT_TYPE (Direct3D 12 on XBOX) — The type of a state subobject. Use with D3D12_STATE_SUBOBJECT. Direct3D 12 graphics reference for XBOX.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_state_subobject_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STATIC_BORDER_COLOR","description":"Specifies the border color for a static sampler.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_static_border_color_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEXTURE_COPY_TYPE","description":"Specifies what type of texture copy is to take place.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_texture_copy_type_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TILE_COPY_FLAGS","description":"Specifies how to copy a tile.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_tile_copy_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TILE_MAPPING_FLAGS","description":"Specifies how to perform a tile-mapping operation.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_tile_mapping_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TILE_RANGE_FLAGS","description":"Specifies a range of tile mappings.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_tile_range_flags_public","hiddenSetByFrontmatter":true},{"title":"D3d12 tiled resources tier public","href":"/reference/graphics/d3d12/enums/d3d12_tiled_resources_tier_public"},{"title":"D3D12_TRI_STATE","description":"Defines constants that specify a tri-state","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_tri_state_public","hiddenSetByFrontmatter":true},{"title":"D3D12_UAV_DIMENSION","description":"Identifies unordered-access view options.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_uav_dimension_public","hiddenSetByFrontmatter":true},{"title":"D3D12_VARIABLE_SHADING_RATE_TIER","description":"Defines constants that specify a shading rate tier (for variable-rate shading, or VRS).","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_variable_shading_rate_tier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_VIEW_INSTANCING_FLAGS","description":"Specifies options for view instancing.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_view_instancing_flags_public","hiddenSetByFrontmatter":true},{"title":"D3D12_VIEW_INSTANCING_TIER","description":"Indicates the tier level at which view instancing is supported.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_view_instancing_tier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_WRITEBUFFERIMMEDIATE_MODE","description":"Specifies the mode used by a WriteBufferImmediate operation.","hidden":false,"href":"/reference/graphics/d3d12/enums/d3d12_writebufferimmediate_mode_public","hiddenSetByFrontmatter":true}]},{"group":"functions","pages":[{"title":"D3D12CreateRootSignatureDeserializer","description":"Deserializes a root signature so you can determine the layout definition (D3D12_ROOT_SIGNATURE_DESC).","hidden":false,"href":"/reference/graphics/d3d12/functions/d3d12createrootsignaturedeserializer_public","hiddenSetByFrontmatter":true},{"title":"D3D12CreateVersionedRootSignatureDeserializer","description":"Generates an interface that can return the deserialized data structure, via GetUnconvertedRootSignatureDesc.","hidden":false,"href":"/reference/graphics/d3d12/functions/d3d12createversionedrootsignaturedeserializer_public","hiddenSetByFrontmatter":true},{"title":"D3D12EnableExperimentalFeatures","description":"Enables a list of experimental features.","hidden":false,"href":"/reference/graphics/d3d12/functions/d3d12enableexperimentalfeatures_public","hiddenSetByFrontmatter":true},{"title":"D3D12GetDebugInterface","description":"Gets a debug interface.","hidden":false,"href":"/reference/graphics/d3d12/functions/d3d12getdebuginterface_public","hiddenSetByFrontmatter":true},{"title":"D3D12GetInterface (XBOX Series consoles)","description":"Selects an SDK version at runtime when the system is in Windows Developer Mode.","sidebarTitle":"D3D12GetInterface","hidden":false,"href":"/reference/graphics/d3d12/functions/d3d12getinterface_public","hiddenSetByFrontmatter":true},{"title":"D3D12SerializeRootSignature","description":"Serializes a root signature version 1.0 that can be passed to ID3D12Device::CreateRootSignature.","hidden":false,"href":"/reference/graphics/d3d12/functions/d3d12serializerootsignature_public","hiddenSetByFrontmatter":true},{"title":"D3d12serializeversionedrootsignature public","href":"/reference/graphics/d3d12/functions/d3d12serializeversionedrootsignature_public"}]},{"group":"interfaces","pages":[{"group":"id3d12commandallocator","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"ID3D12CommandAllocator::Reset","description":"Indicates to re-use the memory that is associated with the command allocator.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12commandallocator/methods/id3d12commandallocator_reset_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12commandlist","tag":"","pages":[{"title":"Id3d12commandlist public","href":"/reference/graphics/d3d12/interfaces/id3d12commandlist/id3d12commandlist_public"},{"group":"methods","tag":"","pages":[{"title":"GetType","description":"Gets the type of the command list, such as direct, bundle, compute, or copy.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12commandlist/methods/id3d12commandlist_gettype_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12commandqueue","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"Id3d12commandqueue beginevent public","href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_beginevent_public"},{"title":"CopyTileMappings","description":"Copies mappings from a source reserved resource to a destination reserved resource.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_copytilemappings_public","hiddenSetByFrontmatter":true},{"title":"Id3d12commandqueue endevent public","href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_endevent_public"},{"title":"GetClockCalibration","description":"This method samples the CPU and GPU timestamp counters at the same moment in time.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_getclockcalibration_public","hiddenSetByFrontmatter":true},{"title":"ID3D12CommandQueue::GetDesc","description":"Gets the description of the command queue.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_getdesc_public","hiddenSetByFrontmatter":true},{"title":"GetTimestampFrequency","description":"This method is used to determine the rate at which the GPU timestamp counter increments.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_gettimestampfrequency_public","hiddenSetByFrontmatter":true},{"title":"Id3d12commandqueue setmarker public","href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_setmarker_public"},{"title":"ID3D12CommandQueue::Signal","description":"ID3D12CommandQueue::Signal (Direct3D 12 on XBOX) — Updates a fence to a specified value. Direct3D 12 graphics API reference for XBOX game development.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_signal_public","hiddenSetByFrontmatter":true},{"title":"Id3d12commandqueue updatetilemappings public","href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_updatetilemappings_public"},{"title":"Wait","description":"Queues a GPU-side wait, and returns immediately. A GPU-side wait is where the GPU waits until the specified fence reaches or exceeds the specified value.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_wait_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12commandsignature","tag":"","pages":[{"title":"ID3D12CommandSignature","description":"A command signature object enables apps to specify indirect drawing, including the buffer format, command type and resource bindings to be used.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12commandsignature/id3d12commandsignature_public","hiddenSetByFrontmatter":true}]},{"group":"id3d12descriptorheap","tag":"","pages":[{"title":"ID3D12DescriptorHeap","description":"A descriptor heap is a collection of contiguous allocations of descriptors, one allocation for every descriptor.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12descriptorheap/id3d12descriptorheap_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetCPUDescriptorHandleForHeapStart","description":"Gets the CPU descriptor handle that represents the start of the heap.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12descriptorheap/methods/id3d12descriptorheap_getcpudescriptorhandleforheapstart_public","hiddenSetByFrontmatter":true},{"title":"ID3D12DescriptorHeap::GetDesc","description":"Gets the descriptor heap description.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12descriptorheap/methods/id3d12descriptorheap_getdesc_public","hiddenSetByFrontmatter":true},{"title":"GetGPUDescriptorHandleForHeapStart","description":"Gets the GPU descriptor handle that represents the start of the heap.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12descriptorheap/methods/id3d12descriptorheap_getgpudescriptorhandleforheapstart_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12device","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"CheckFeatureSupport","description":"Gets information about the features that are supported by the current graphics driver. (ID3D12Device.CheckFeatureSupport)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_checkfeaturesupport_public","hiddenSetByFrontmatter":true},{"title":"CopyDescriptors","description":"Copies descriptors from a source to a destination. (ID3D12Device.CopyDescriptors)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_copydescriptors_public","hiddenSetByFrontmatter":true},{"title":"CopyDescriptorsSimple","description":"Copies descriptors from a source to a destination. (ID3D12Device.CopyDescriptorsSimple)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_copydescriptorssimple_public","hiddenSetByFrontmatter":true},{"title":"CreateCommandAllocator","description":"Creates a command allocator object.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createcommandallocator_public","hiddenSetByFrontmatter":true},{"title":"CreateCommandList","description":"CreateCommandList (Direct3D 12 on XBOX) — Creates a command list. XBOX Direct3D 12 graphics reference.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createcommandlist_public","hiddenSetByFrontmatter":true},{"title":"CreateCommandQueue","description":"Creates a command queue.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createcommandqueue_public","hiddenSetByFrontmatter":true},{"title":"CreateCommandSignature","description":"This method creates a command signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createcommandsignature_public","hiddenSetByFrontmatter":true},{"title":"CreateCommittedResource","description":"Creates both a resource and an implicit heap, such that the heap is big enough to contain the entire resource, and the resource is mapped to the heap.","href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createcommittedresource_public"},{"title":"CreateComputePipelineState","description":"Creates a compute pipeline state object.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createcomputepipelinestate_public","hiddenSetByFrontmatter":true},{"title":"CreateConstantBufferView","description":"Creates a constant-buffer view for accessing resource data.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createconstantbufferview_public","hiddenSetByFrontmatter":true},{"title":"CreateDepthStencilView","description":"Creates a depth-stencil view for accessing resource data.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createdepthstencilview_public","hiddenSetByFrontmatter":true},{"title":"CreateDescriptorHeap","description":"Creates a descriptor heap object.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createdescriptorheap_public","hiddenSetByFrontmatter":true},{"title":"CreateFence","description":"Creates a fence object. (ID3D12Device.CreateFence)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createfence_public","hiddenSetByFrontmatter":true},{"title":"CreateGraphicsPipelineState","description":"Creates a graphics pipeline state object.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_creategraphicspipelinestate_public","hiddenSetByFrontmatter":true},{"title":"CreateHeap","description":"Creates a heap that can be used with placed resources and reserved resources.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createheap_public","hiddenSetByFrontmatter":true},{"title":"CreatePlacedResource","description":"ID3D12Device::CreatePlacedResource creates a lightweight resource placed in a specific heap on XBOX Direct3D 12, the fastest resource type to create.","href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createplacedresource_public"},{"title":"CreateQueryHeap","description":"Creates a query heap. A query heap contains an array of queries.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createqueryheap_public","hiddenSetByFrontmatter":true},{"title":"CreateRenderTargetView","description":"Creates a render-target view for accessing resource data. (ID3D12Device.CreateRenderTargetView)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createrendertargetview_public","hiddenSetByFrontmatter":true},{"title":"CreateReservedResource","description":"Creates a reserved D3D12 resource that is not yet mapped to any heap pages, for use with tiled resources on XBOX Series consoles via ID3D12Device.","href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createreservedresource_public"},{"title":"CreateRootSignature","description":"Creates a root signature layout.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createrootsignature_public","hiddenSetByFrontmatter":true},{"title":"CreateSampler","description":"Create a sampler object that encapsulates sampling information for a texture.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createsampler_public","hiddenSetByFrontmatter":true},{"title":"CreateShaderResourceView","description":"Creates a shader-resource view for accessing data in a resource. (ID3D12Device.CreateShaderResourceView)","href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createshaderresourceview_public"},{"title":"Id3d12device createsharedhandle public","href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createsharedhandle_public"},{"title":"Id3d12device createunorderedaccessview public","href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_createunorderedaccessview_public"},{"title":"Evict","description":"Enables the page-out of data, which precludes GPU access of that data.","href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_evict_public"},{"title":"GetAdapterLuid","description":"Gets a locally unique identifier for the current device (adapter).","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_getadapterluid_public","hiddenSetByFrontmatter":true},{"title":"GetCopyableFootprints","description":"Gets a resource layout that can be copied. Helps the app fill-in D3D12_PLACED_SUBRESOURCE_FOOTPRINT and D3D12_SUBRESOURCE_FOOTPRINT when suballocating space.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_getcopyablefootprints_public","hiddenSetByFrontmatter":true},{"title":"Id3d12device getcustomheapproperties public","href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_getcustomheapproperties_public"},{"title":"GetDescriptorHandleIncrementSize","description":"Gets the size of the handle increment for the given type of descriptor heap. This value is typically used to increment a handle into a descriptor array by.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_getdescriptorhandleincrementsize_public","hiddenSetByFrontmatter":true},{"title":"GetDeviceRemovedReason","description":"Gets the reason that the device was removed.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_getdeviceremovedreason_public","hiddenSetByFrontmatter":true},{"title":"GetNodeCount","description":"Reports the number of physical adapters (nodes) that are associated with this device.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_getnodecount_public","hiddenSetByFrontmatter":true},{"title":"GetResourceAllocationInfo","description":"GetResourceAllocationInfo (Direct3D 12 on XBOX) — Gets the size and alignment of memory required for a collection of resources on this adapter.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_getresourceallocationinfo_public","hiddenSetByFrontmatter":true},{"title":"GetResourceTiling","description":"Gets info about how a tiled resource is broken into tiles. (ID3D12Device.GetResourceTiling)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_getresourcetiling_public","hiddenSetByFrontmatter":true},{"title":"MakeResident","description":"Makes objects resident for the device.","href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_makeresident_public"},{"title":"OpenSharedHandle","description":"Opens a handle for shared resources, shared heaps, and shared fences, by using HANDLE and REFIID.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_opensharedhandle_public","hiddenSetByFrontmatter":true},{"title":"OpenSharedHandleByName","description":"Opens a handle for shared resources, shared heaps, and shared fences, by using Name and Access.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_opensharedhandlebyname_public","hiddenSetByFrontmatter":true},{"title":"SetStablePowerState","description":"A development-time aid for certain types of profiling and experimental prototyping.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device/methods/id3d12device_setstablepowerstate_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12device1","tag":"","pages":[{"title":"ID3D12Device1","description":"Represents a virtual adapter, and expands on the range of methods provided by ID3D12Device.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device1/id3d12device1_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"CreatePipelineLibrary","description":"Creates a cached pipeline library.","href":"/reference/graphics/d3d12/interfaces/id3d12device1/methods/id3d12device1_createpipelinelibrary_public"},{"title":"SetEventOnMultipleFenceCompletion","description":"Specifies an event that should be fired when one or more of a collection of fences reach specific values.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device1/methods/id3d12device1_seteventonmultiplefencecompletion_public","hiddenSetByFrontmatter":true},{"title":"SetResidencyPriority","description":"This method sets residency priorities of a specified list of objects.","href":"/reference/graphics/d3d12/interfaces/id3d12device1/methods/id3d12device1_setresidencypriority_public"}]}]},{"group":"id3d12device10","tag":"","pages":[{"title":"ID3D12Device10 (XBOX Series consoles)","description":"The 10th iteration of the ID3D12Device interface","sidebarTitle":"ID3D12Device10","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device10/id3d12device10_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"CreateCommittedResource3 (XBOX Series consoles)","description":"Creates a committed resource with an initial layout rather than an initial state.","sidebarTitle":"CreateCommittedResource3","href":"/reference/graphics/d3d12/interfaces/id3d12device10/methods/id3d12device10_createcommittedresource3_public"},{"title":"CreatePlacedResource2 (XBOX Series consoles)","description":"ID3D12Device10::CreatePlacedResource2 creates a placed resource in a heap on XBOX Series consoles Direct3D 12, with extended parameters over the original API.","sidebarTitle":"CreatePlacedResource2","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device10/methods/id3d12device10_createplacedresource2_public","hiddenSetByFrontmatter":true},{"title":"CreateReservedResource2 (XBOX Series consoles)","description":"CreateReservedResource2 on ID3D12Device10 creates a reserved D3D12 resource with an initial layout, not yet mapped to any heap pages, on XBOX Series consoles.","sidebarTitle":"CreateReservedResource2","href":"/reference/graphics/d3d12/interfaces/id3d12device10/methods/id3d12device10_createreservedresource2_public"}]}]},{"group":"id3d12device2","tag":"","pages":[{"title":"ID3D12Device2","description":"Represents a virtual adapter. This interface extends ID3D12Device1 to create pipeline state objects from pipeline state stream descriptions.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device2/id3d12device2_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"Id3d12device2 createpipelinestate public","href":"/reference/graphics/d3d12/interfaces/id3d12device2/methods/id3d12device2_createpipelinestate_public"}]}]},{"group":"id3d12device3","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"EnqueueMakeResident","description":"Asynchronously makes objects resident for the device.","href":"/reference/graphics/d3d12/interfaces/id3d12device3/methods/id3d12device3_enqueuemakeresident_public"},{"title":"OpenExistingHeapFromAddress","description":"Creates a special-purpose diagnostic heap in system memory from an address. The created heap can persist even in the event of a GPU-fault or device-removed.","href":"/reference/graphics/d3d12/interfaces/id3d12device3/methods/id3d12device3_openexistingheapfromaddress_public"},{"title":"OpenExistingHeapFromFileMapping","description":"Creates a special-purpose diagnostic heap in system memory from a file mapping object. The created heap can persist even in the event of a GPU-fault or.","href":"/reference/graphics/d3d12/interfaces/id3d12device3/methods/id3d12device3_openexistingheapfromfilemapping_public"}]}]},{"group":"id3d12device4","tag":"","pages":[{"title":"ID3D12Device4","description":"Represents a virtual adapter. This interface extends ID3D12Device3.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device4/id3d12device4_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"CreateCommandList1 (XBOX Series consoles)","description":"Creates a command list in the closed state.","sidebarTitle":"CreateCommandList1","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device4/methods/id3d12device4_createcommandlist1_public","hiddenSetByFrontmatter":true},{"title":"CreateCommittedResource1 (XBOX Series consoles)","description":"Creates both a resource and an implicit heap (optionally for a protected session), such that the heap is big enough to contain the entire resource, and the.","sidebarTitle":"CreateCommittedResource1","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device4/methods/id3d12device4_createcommittedresource1_public","hiddenSetByFrontmatter":true},{"title":"CreateHeap1 (XBOX Series consoles)","description":"Creates a heap (optionally for a protected session) that can be used with placed resources and reserved resources.","sidebarTitle":"CreateHeap1","href":"/reference/graphics/d3d12/interfaces/id3d12device4/methods/id3d12device4_createheap1_public"},{"title":"CreateProtectedResourceSession (XBOX Series consoles)","description":"Creates an object that represents a session for content protection.","sidebarTitle":"CreateProtectedResourceSession","href":"/reference/graphics/d3d12/interfaces/id3d12device4/methods/id3d12device4_createprotectedresourcesession_public"},{"title":"CreateReservedResource1 (XBOX Series consoles)","description":"Creates a resource (optionally for a protected session) that is reserved, and not yet mapped to any pages in a heap.","sidebarTitle":"CreateReservedResource1","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device4/methods/id3d12device4_createreservedresource1_public","hiddenSetByFrontmatter":true},{"title":"GetResourceAllocationInfo1 (XBOX Series consoles)","description":"Gets rich info about the size and alignment of memory required for a collection of resources on this adapter. (ID3D12Device4::GetResourceAllocationInfo1)","sidebarTitle":"GetResourceAllocationInfo1","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device4/methods/id3d12device4_getresourceallocationinfo1_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12device5","tag":"","pages":[{"title":"ID3D12Device5 (XBOX Series consoles)","description":"Represents a virtual adapter. This interface extends ID3D12Device4.","sidebarTitle":"ID3D12Device5","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device5/id3d12device5_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"CheckDriverMatchingIdentifier (XBOX Series consoles)","description":"Reports the compatibility of serialized data, such as a serialized raytracing acceleration structure resulting from a call to.","sidebarTitle":"CheckDriverMatchingIdentifier","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device5/methods/id3d12device5_checkdrivermatchingidentifier_public","hiddenSetByFrontmatter":true},{"title":"CreateLifetimeTracker (XBOX Series consoles)","description":"Creates a lifetime tracker associated with an application-defined callback; the callback receives notifications when the lifetime of a tracked object is.","sidebarTitle":"CreateLifetimeTracker","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device5/methods/id3d12device5_createlifetimetracker_public","hiddenSetByFrontmatter":true},{"title":"CreateMetaCommand (XBOX Series consoles)","description":"Creates an instance of the specified meta command.","sidebarTitle":"CreateMetaCommand","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device5/methods/id3d12device5_createmetacommand_public","hiddenSetByFrontmatter":true},{"title":"Id3d12device5 createstateobject public","href":"/reference/graphics/d3d12/interfaces/id3d12device5/methods/id3d12device5_createstateobject_public"},{"title":"EnumerateMetaCommandParameters (XBOX Series consoles)","description":"Queries reflection metadata about the parameters of the specified meta command.","sidebarTitle":"EnumerateMetaCommandParameters","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device5/methods/id3d12device5_enumeratemetacommandparameters_public","hiddenSetByFrontmatter":true},{"title":"EnumerateMetaCommands (XBOX Series consoles)","description":"Queries reflection metadata about available meta commands.","sidebarTitle":"EnumerateMetaCommands","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device5/methods/id3d12device5_enumeratemetacommands_public","hiddenSetByFrontmatter":true},{"title":"GetRaytracingAccelerationStructurePrebuildInfo","description":"Query the driver for resource requirements to build an acceleration structure.","sidebarTitle":"GetRaytracingAccelerationStructurePrebuildInfo","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device5/methods/id3d12device5_getraytracingaccelerationstructureprebuildinfo_public","hiddenSetByFrontmatter":true},{"title":"RemoveDevice (XBOX Series consoles)","description":"You can call **RemoveDevice** to indicate to the Direct3D 12 runtime that the GPU device encountered a problem, and can no longer be used.","sidebarTitle":"RemoveDevice","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device5/methods/id3d12device5_removedevice_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12device9","tag":"","pages":[{"title":"ID3D12Device9 (XBOX Series consoles)","description":"Represents a virtual adapter. This interface extends ID3D12Device8 to add methods to manage shader caches.","sidebarTitle":"ID3D12Device9","href":"/reference/graphics/d3d12/interfaces/id3d12device9/id3d12device9_public"},{"group":"methods","tag":"","pages":[{"title":"CreateCommandQueue1 (XBOX Series consoles)","description":"Creates a command queue with a creator ID.","sidebarTitle":"CreateCommandQueue1","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12device9/methods/id3d12device9_createcommandqueue1_public","hiddenSetByFrontmatter":true},{"title":"CreateShaderCacheSession (XBOX Series consoles)","description":"Creates an object that grants access to a shader cache, potentially opening an existing cache or creating a new one.","sidebarTitle":"CreateShaderCacheSession","href":"/reference/graphics/d3d12/interfaces/id3d12device9/methods/id3d12device9_createshadercachesession_public"},{"title":"ShaderCacheControl (XBOX Series consoles)","description":"Modifies the behavior of caches used internally by Direct3D or by the driver.","sidebarTitle":"ShaderCacheControl","href":"/reference/graphics/d3d12/interfaces/id3d12device9/methods/id3d12device9_shadercachecontrol_public"}]}]},{"group":"id3d12devicechild","tag":"","pages":[{"title":"ID3D12DeviceChild","description":"An interface from which other core interfaces inherit from, including (but not limited to) ID3D12PipelineLibrary, ID3D12CommandList, ID3D12Pageable, and.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12devicechild/id3d12devicechild_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetDevice","description":"Gets a pointer to the device that created this interface.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12devicechild/methods/id3d12devicechild_getdevice_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12deviceremovedextendeddata","tag":"","pages":[{"title":"ID3D12DeviceRemovedExtendedData","description":"Provides runtime access to Device Removed Extended Data (DRED) data.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12deviceremovedextendeddata/id3d12deviceremovedextendeddata_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetAutoBreadcrumbsOutput","description":"Retrieves the Device Removed Extended Data (DRED) auto-breadcrumbs output after device removal.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12deviceremovedextendeddata/methods/id3d12deviceremovedextendeddata_getautobreadcrumbsoutput_public","hiddenSetByFrontmatter":true},{"title":"GetPageFaultAllocationOutput","description":"Retrieves the Device Removed Extended Data (DRED) page fault data.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12deviceremovedextendeddata/methods/id3d12deviceremovedextendeddata_getpagefaultallocationoutput_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12deviceremovedextendeddatasettings","tag":"","pages":[{"title":"ID3D12DeviceRemovedExtendedDataSettings","description":"This interface controls Device Removed Extended Data (DRED) settings.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12deviceremovedextendeddatasettings/id3d12deviceremovedextendeddatasettings_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"Id3d12deviceremovedextendeddatasettings setautobreadcrumbsenablement public","href":"/reference/graphics/d3d12/interfaces/id3d12deviceremovedextendeddatasettings/methods/id3d12deviceremovedextendeddatasettings_setautobreadcrumbsenablement_public"},{"title":"SetPageFaultEnablement","description":"Configures the enablement settings for Device Removed Extended Data (DRED) page fault reporting.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12deviceremovedextendeddatasettings/methods/id3d12deviceremovedextendeddatasettings_setpagefaultenablement_public","hiddenSetByFrontmatter":true},{"title":"SetWatsonDumpEnablement","description":"Configures the enablement settings for Device Removed Extended Data (DRED) Watson dump creation.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12deviceremovedextendeddatasettings/methods/id3d12deviceremovedextendeddatasettings_setwatsondumpenablement_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12fence","tag":"","pages":[{"title":"ID3D12Fence","description":"Represents a fence, an object used for synchronization of the CPU and one or more GPUs. (ID3D12Fence)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12fence/id3d12fence_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetCompletedValue","description":"Gets the current value of the fence. (ID3D12Fence.GetCompletedValue)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12fence/methods/id3d12fence_getcompletedvalue_public","hiddenSetByFrontmatter":true},{"title":"SetEventOnCompletion","description":"Specifies an event that should be fired when the fence reaches a certain value. (ID3D12Fence.SetEventOnCompletion)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12fence/methods/id3d12fence_seteventoncompletion_public","hiddenSetByFrontmatter":true},{"title":"ID3D12Fence::Signal","description":"Sets the fence to the specified value.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12fence/methods/id3d12fence_signal_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12fence1","tag":"","pages":[{"title":"ID3D12Fence1","description":"Represents a fence. This interface extends ID3D12Fence, and supports the retrieval of the flags used to create the original fence.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12fence1/id3d12fence1_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetCreationFlags","description":"Gets the flags used to create the fence represented by the current instance.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12fence1/methods/id3d12fence1_getcreationflags_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12graphicscommandlist","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"Id3d12graphicscommandlist beginevent public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_beginevent_public"},{"title":"BeginQuery","description":"Starts a query running. (ID3D12GraphicsCommandList.BeginQuery)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_beginquery_public","hiddenSetByFrontmatter":true},{"title":"Id3d12graphicscommandlist cleardepthstencilview public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_cleardepthstencilview_public"},{"title":"ClearState","description":"Resets the state of a direct command list back to the state it was in when the command list was created. (ID3D12GraphicsCommandList.ClearState)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_clearstate_public","hiddenSetByFrontmatter":true},{"title":"ClearUnorderedAccessViewFloat","description":"Sets all the elements in a unordered access view to the specified float values.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_clearunorderedaccessviewfloat_public","hiddenSetByFrontmatter":true},{"title":"ClearUnorderedAccessViewUint","description":"Sets all the elements in a unordered-access view (UAV) to the specified integer values.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_clearunorderedaccessviewuint_public","hiddenSetByFrontmatter":true},{"title":"Id3d12graphicscommandlist close public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_close_public"},{"title":"CopyBufferRegion","description":"CopyBufferRegion (Direct3D 12 on XBOX) — Copies a region of a buffer from one resource to another. Direct3D 12 graphics API reference for XBOX game development.","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_copybufferregion_public"},{"title":"Id3d12graphicscommandlist copytextureregion public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_copytextureregion_public"},{"title":"CopyTiles","description":"Copies tiles from buffer to tiled resource or vice versa. (ID3D12GraphicsCommandList.CopyTiles)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_copytiles_public","hiddenSetByFrontmatter":true},{"title":"Id3d12graphicscommandlist discardresource public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_discardresource_public"},{"title":"Dispatch","description":"Executes a compute shader on a thread group.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_dispatch_public","hiddenSetByFrontmatter":true},{"title":"DrawIndexedInstanced","description":"Draws indexed, instanced primitives.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_drawindexedinstanced_public","hiddenSetByFrontmatter":true},{"title":"DrawInstanced","description":"Draws non-indexed, instanced primitives.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_drawinstanced_public","hiddenSetByFrontmatter":true},{"title":"Id3d12graphicscommandlist endevent public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_endevent_public"},{"title":"EndQuery","description":"EndQuery (Direct3D 12 on XBOX) — Ends a running query. XBOX Direct3D 12 graphics reference.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_endquery_public","hiddenSetByFrontmatter":true},{"title":"ExecuteBundle","description":"Executes a bundle.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_executebundle_public","hiddenSetByFrontmatter":true},{"title":"Id3d12graphicscommandlist executeindirect public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_executeindirect_public"},{"title":"IASetIndexBuffer","description":"Sets the view for the index buffer.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_iasetindexbuffer_public","hiddenSetByFrontmatter":true},{"title":"IASetPrimitiveTopology","description":"Bind information about the primitive type, and data order that describes input data for the input assembler stage.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_iasetprimitivetopology_public","hiddenSetByFrontmatter":true},{"title":"IASetVertexBuffers","description":"Sets a CPU descriptor handle for the vertex buffers.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_iasetvertexbuffers_public","hiddenSetByFrontmatter":true},{"title":"OMSetBlendFactor","description":"Sets the blend factor that modulate values for a pixel shader, render target, or both.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_omsetblendfactor_public","hiddenSetByFrontmatter":true},{"title":"OMSetRenderTargets","description":"Sets CPU descriptor handles for the render targets and depth stencil.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_omsetrendertargets_public","hiddenSetByFrontmatter":true},{"title":"OMSetStencilRef","description":"Sets the reference value for depth stencil tests.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_omsetstencilref_public","hiddenSetByFrontmatter":true},{"title":"Id3d12graphicscommandlist reset public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_reset_public"},{"title":"Id3d12graphicscommandlist resolvequerydata public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_resolvequerydata_public"},{"title":"Id3d12graphicscommandlist resolvesubresource public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_resolvesubresource_public"},{"title":"Id3d12graphicscommandlist resourcebarrier public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_resourcebarrier_public"},{"title":"RSSetScissorRects","description":"Binds an array of scissor rectangles to the rasterizer stage.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_rssetscissorrects_public","hiddenSetByFrontmatter":true},{"title":"Id3d12graphicscommandlist rssetviewports public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_rssetviewports_public"},{"title":"SetComputeRoot32BitConstant","description":"Sets a constant in the compute root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setcomputeroot32bitconstant_public","hiddenSetByFrontmatter":true},{"title":"SetComputeRoot32BitConstants","description":"Sets a group of constants in the compute root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setcomputeroot32bitconstants_public","hiddenSetByFrontmatter":true},{"title":"SetComputeRootConstantBufferView","description":"Sets a CPU descriptor handle for the constant buffer in the compute root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setcomputerootconstantbufferview_public","hiddenSetByFrontmatter":true},{"title":"SetComputeRootDescriptorTable","description":"Sets a descriptor table into the compute root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setcomputerootdescriptortable_public","hiddenSetByFrontmatter":true},{"title":"SetComputeRootShaderResourceView","description":"Sets a CPU descriptor handle for the shader resource in the compute root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setcomputerootshaderresourceview_public","hiddenSetByFrontmatter":true},{"title":"SetComputeRootSignature","description":"Sets the layout of the compute root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setcomputerootsignature_public","hiddenSetByFrontmatter":true},{"title":"SetComputeRootUnorderedAccessView","description":"Sets a CPU descriptor handle for the unordered-access-view resource in the compute root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setcomputerootunorderedaccessview_public","hiddenSetByFrontmatter":true},{"title":"SetDescriptorHeaps","description":"Changes the currently bound descriptor heaps that are associated with a command list.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setdescriptorheaps_public","hiddenSetByFrontmatter":true},{"title":"SetGraphicsRoot32BitConstant","description":"Sets a constant in the graphics root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setgraphicsroot32bitconstant_public","hiddenSetByFrontmatter":true},{"title":"SetGraphicsRoot32BitConstants","description":"Sets a group of constants in the graphics root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setgraphicsroot32bitconstants_public","hiddenSetByFrontmatter":true},{"title":"SetGraphicsRootConstantBufferView","description":"Sets a CPU descriptor handle for the constant buffer in the graphics root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setgraphicsrootconstantbufferview_public","hiddenSetByFrontmatter":true},{"title":"SetGraphicsRootDescriptorTable","description":"Sets a descriptor table into the graphics root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setgraphicsrootdescriptortable_public","hiddenSetByFrontmatter":true},{"title":"SetGraphicsRootShaderResourceView","description":"Sets a CPU descriptor handle for the shader resource in the graphics root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setgraphicsrootshaderresourceview_public","hiddenSetByFrontmatter":true},{"title":"SetGraphicsRootSignature","description":"Sets the layout of the graphics root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setgraphicsrootsignature_public","hiddenSetByFrontmatter":true},{"title":"SetGraphicsRootUnorderedAccessView","description":"Sets a CPU descriptor handle for the unordered-access-view resource in the graphics root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setgraphicsrootunorderedaccessview_public","hiddenSetByFrontmatter":true},{"title":"Id3d12graphicscommandlist setmarker public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setmarker_public"},{"title":"SetPipelineState","description":"Sets all shaders and programs most of the fixed-function state of the graphics processing unit (GPU) pipeline.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setpipelinestate_public","hiddenSetByFrontmatter":true},{"title":"SetPredication","description":"Sets a rendering predicate.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setpredication_public","hiddenSetByFrontmatter":true},{"title":"SOSetTargets","description":"Sets the stream output buffer views.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_sosettargets_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12graphicscommandlist1","tag":"","pages":[{"title":"ID3D12GraphicsCommandList1","description":"Encapsulates a list of graphics commands for rendering, extending the interface to support programmable sample positions, atomic copies for implementing.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist1/id3d12graphicscommandlist1_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"AtomicCopyBufferUINT","description":"Atomically copies a primary data element of type UINT from one resource to another, along with optional dependent resources.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist1/methods/id3d12graphicscommandlist1_atomiccopybufferuint_public","hiddenSetByFrontmatter":true},{"title":"AtomicCopyBufferUINT64","description":"Atomically copies a primary data element of type UINT64 from one resource to another, along with optional dependent resources.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist1/methods/id3d12graphicscommandlist1_atomiccopybufferuint64_public","hiddenSetByFrontmatter":true},{"title":"OMSetDepthBounds","description":"This method enables you to change the depth bounds dynamically.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist1/methods/id3d12graphicscommandlist1_omsetdepthbounds_public","hiddenSetByFrontmatter":true},{"title":"ResolveSubresourceRegion","description":"Copy a region of a multisampled or compressed resource into a non-multisampled or non-compressed resource.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist1/methods/id3d12graphicscommandlist1_resolvesubresourceregion_public","hiddenSetByFrontmatter":true},{"title":"SetSamplePositions","description":"This method configures the sample positions used by subsequent draw, copy, resolve, and similar operations.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist1/methods/id3d12graphicscommandlist1_setsamplepositions_public","hiddenSetByFrontmatter":true},{"title":"SetViewInstanceMask","description":"Set a mask that controls which view instances are enabled for subsequent draws.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist1/methods/id3d12graphicscommandlist1_setviewinstancemask_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12graphicscommandlist2","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"WriteBufferImmediate","description":"Writes a number of 32-bit immediate values to the specified buffer locations directly from the command stream. (ID3D12GraphicsCommandList2.WriteBufferImmediate)","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist2/methods/id3d12graphicscommandlist2_writebufferimmediate_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12graphicscommandlist3","tag":"","pages":[{"title":"ID3D12GraphicsCommandList3","description":"ID3D12GraphicsCommandList3 (Direct3D 12 on XBOX) — Encapsulates a list of graphics commands for rendering. Direct3D 12 graphics reference for XBOX.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist3/id3d12graphicscommandlist3_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"SetProtectedResourceSession","description":"Specifies whether or not protected resources can be accessed by subsequent commands in the command list.","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist3/methods/id3d12graphicscommandlist3_setprotectedresourcesession_public"}]}]},{"group":"id3d12graphicscommandlist4","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"BeginRenderPass (XBOX Series consoles)","description":"Marks the beginning of a render pass by binding a set of output resources for the duration of the render pass. These bindings are to one or more render.","sidebarTitle":"BeginRenderPass","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist4/methods/id3d12graphicscommandlist4_beginrenderpass_public","hiddenSetByFrontmatter":true},{"title":"BuildRaytracingAccelerationStructure (XBOX Series consoles)","description":"Performs a raytracing acceleration structure build on the GPU and optionally outputs post-build information immediately after the build.","sidebarTitle":"BuildRaytracingAccelerationStructure","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist4/methods/id3d12graphicscommandlist4_buildraytracingaccelerationstructure_public","hiddenSetByFrontmatter":true},{"title":"CopyRaytracingAccelerationStructure (XBOX Series consoles)","description":"Copies a source acceleration structure to destination memory while applying the specified transformation.","sidebarTitle":"CopyRaytracingAccelerationStructure","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist4/methods/id3d12graphicscommandlist4_copyraytracingaccelerationstructure_public","hiddenSetByFrontmatter":true},{"title":"DispatchRays (XBOX Series consoles)","description":"Launch the threads of a ray generation shader.","sidebarTitle":"DispatchRays","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist4/methods/id3d12graphicscommandlist4_dispatchrays_public","hiddenSetByFrontmatter":true},{"title":"EmitRaytracingAccelerationStructurePostbuildInfo","description":"Emits post-build properties for a set of acceleration structures. This enables applications to know the output resource requirements for performing.","sidebarTitle":"EmitRaytracingAccelerationStructurePostbuildInfo","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist4/methods/id3d12graphicscommandlist4_emitraytracingaccelerationstructurepostbuildinfo_public","hiddenSetByFrontmatter":true},{"title":"EndRenderPass (XBOX Series consoles)","description":"Marks the ending of a render pass.","sidebarTitle":"EndRenderPass","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist4/methods/id3d12graphicscommandlist4_endrenderpass_public","hiddenSetByFrontmatter":true},{"title":"Id3d12graphicscommandlist4 executemetacommand public","href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist4/methods/id3d12graphicscommandlist4_executemetacommand_public"},{"title":"InitializeMetaCommand (XBOX Series consoles)","description":"Initializes the specified meta command.","sidebarTitle":"InitializeMetaCommand","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist4/methods/id3d12graphicscommandlist4_initializemetacommand_public","hiddenSetByFrontmatter":true},{"title":"SetPipelineState1 (XBOX Series consoles)","description":"Sets a state object on the command list.","sidebarTitle":"SetPipelineState1","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist4/methods/id3d12graphicscommandlist4_setpipelinestate1_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12graphicscommandlist5","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"RSSetShadingRate (XBOX Series consoles)","description":"The ID3D12GraphicsCommandList5::RSSetShadingRate method (d3d12.h) sets the base shading rate, and combiners, for variable-rate shading (VRS).","sidebarTitle":"RSSetShadingRate","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist5/methods/id3d12graphicscommandlist5_rssetshadingrate_public","hiddenSetByFrontmatter":true},{"title":"RSSetShadingRateImage (XBOX Series consoles)","description":"The ID3D12GraphicsCommandList5::RSSetShadingRateImage method (d3d12.h) sets the screen-space shading-rate image for variable-rate shading (VRS).","sidebarTitle":"RSSetShadingRateImage","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist5/methods/id3d12graphicscommandlist5_rssetshadingrateimage_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12graphicscommandlist7","tag":"","pages":[{"title":"ID3D12GraphicsCommandList7 (XBOX Series consoles)","description":"Encapsulates a list of graphics commands for rendering. This interface extends ID3D12GraphicsCommandList6.","sidebarTitle":"ID3D12GraphicsCommandList7","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist7/id3d12graphicscommandlist7_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"Barrier (XBOX Series consoles)","description":"Adds a collection of barriers into a graphics command list recording.","sidebarTitle":"Barrier","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12graphicscommandlist7/methods/id3d12graphicscommandlist7_barrier_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12heap","tag":"","pages":[{"title":"ID3D12Heap","description":"A heap is an abstraction of contiguous memory allocation, used to manage physical memory. This heap can be used with ID3D12Resource objects to support placed.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12heap/id3d12heap_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"ID3D12Heap::GetDesc","description":"Gets the heap description.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12heap/methods/id3d12heap_getdesc_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12lifetimeowner","tag":"","pages":[{"title":"ID3D12LifetimeOwner","description":"Represents an application-defined callback used for being notified of lifetime changes of an object.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12lifetimeowner/id3d12lifetimeowner_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"LifetimeStateUpdated","description":"Called when the lifetime state of a lifetime-tracked object changes.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12lifetimeowner/methods/id3d12lifetimeowner_lifetimestateupdated_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12lifetimetracker","tag":"","pages":[{"title":"ID3D12LifetimeTracker","description":"Represents facilities for controlling the lifetime a lifetime-tracked object.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12lifetimetracker/id3d12lifetimetracker_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"DestroyOwnedObject","description":"Destroys a lifetime-tracked object.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12lifetimetracker/methods/id3d12lifetimetracker_destroyownedobject_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12metacommand","tag":"","pages":[{"title":"ID3D12MetaCommand","description":"Represents a meta command. A meta command is a Direct3D 12 object representing an algorithm that is accelerated by independent hardware vendors (IHVs).","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12metacommand/id3d12metacommand_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetRequiredParameterResourceSize","description":"Retrieves the amount of memory required for the specified runtime parameter resource for a meta command, for the specified stage.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12metacommand/methods/id3d12metacommand_getrequiredparameterresourcesize_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12object","tag":"","pages":[{"title":"ID3D12Object","description":"ID3D12Object (Direct3D 12 on XBOX) — An interface from which ID3D12Device and ID3D12DeviceChild inherit from. It provides methods to associate private data and.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12object/id3d12object_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetPrivateData","description":"Gets application-defined data from a device object.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12object/methods/id3d12object_getprivatedata_public","hiddenSetByFrontmatter":true},{"title":"SetName","description":"Associates a name with the device object. This name is for use in debug diagnostics and tools.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12object/methods/id3d12object_setname_public","hiddenSetByFrontmatter":true},{"title":"SetPrivateData","description":"Sets application-defined data to a device object and associates that data with an application-defined GUID.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12object/methods/id3d12object_setprivatedata_public","hiddenSetByFrontmatter":true},{"title":"SetPrivateDataInterface","description":"Associates an IUnknown-derived interface with the device object and associates that interface with an application-defined GUID.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12object/methods/id3d12object_setprivatedatainterface_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12pageable","tag":"","pages":[{"title":"ID3D12Pageable","description":"An interface from which many other core interfaces inherit from. It indicates that the object type encapsulates some amount of GPU-accessible memory; but.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pageable/id3d12pageable_public","hiddenSetByFrontmatter":true}]},{"group":"id3d12pipelinelibrary","tag":"","pages":[{"title":"ID3D12PipelineLibrary","description":"Manages a pipeline library, in particular loading and retrieving individual PSOs.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pipelinelibrary/id3d12pipelinelibrary_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetSerializedSize","description":"Returns the amount of memory required to serialize the current contents of the database.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pipelinelibrary/methods/id3d12pipelinelibrary_getserializedsize_public","hiddenSetByFrontmatter":true},{"title":"LoadComputePipeline","description":"Retrieves the requested PSO from the library. The input desc is matched against the data in the current library database, and remembered in order to prevent.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pipelinelibrary/methods/id3d12pipelinelibrary_loadcomputepipeline_public","hiddenSetByFrontmatter":true},{"title":"LoadGraphicsPipeline","description":"Retrieves the requested PSO from the library.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pipelinelibrary/methods/id3d12pipelinelibrary_loadgraphicspipeline_public","hiddenSetByFrontmatter":true},{"title":"Serialize","description":"Writes the contents of the library to the provided memory, to be provided back to the runtime at a later time.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pipelinelibrary/methods/id3d12pipelinelibrary_serialize_public","hiddenSetByFrontmatter":true},{"title":"StorePipeline","description":"Adds the input PSO to an internal database with the corresponding name.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pipelinelibrary/methods/id3d12pipelinelibrary_storepipeline_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12pipelinelibrary1","tag":"","pages":[{"title":"ID3D12PipelineLibrary1","description":"Manages a pipeline library. This interface extends ID3D12PipelineLibrary to load PSOs from a pipeline state stream description.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pipelinelibrary1/id3d12pipelinelibrary1_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"LoadPipeline","description":"Retrieves the requested PSO from the library. The pipeline stream description is matched against the library database and remembered in order to prevent.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pipelinelibrary1/methods/id3d12pipelinelibrary1_loadpipeline_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12pipelinestate","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"GetCachedBlob","description":"Gets the cached blob representing the pipeline state.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12pipelinestate/methods/id3d12pipelinestate_getcachedblob_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12protectedresourcesession","tag":"","pages":[{"title":"ID3D12ProtectedResourceSession","description":"Monitors the validity of a protected resource session. (ID3D12ProtectedResourceSession)","href":"/reference/graphics/d3d12/interfaces/id3d12protectedresourcesession/id3d12protectedresourcesession_public"},{"group":"methods","tag":"","pages":[{"title":"ID3D12ProtectedResourceSession::GetDesc","description":"Retrieves a description of the protected resource session. (ID3D12ProtectedResourceSession.GetDesc)","href":"/reference/graphics/d3d12/interfaces/id3d12protectedresourcesession/methods/id3d12protectedresourcesession_getdesc_public"}]}]},{"group":"id3d12protectedresourcesession1","tag":"","pages":[{"title":"ID3D12ProtectedResourceSession1","description":"Monitors the validity of a protected resource session. (ID3D12ProtectedResourceSession1)","href":"/reference/graphics/d3d12/interfaces/id3d12protectedresourcesession1/id3d12protectedresourcesession1_public"},{"group":"methods","tag":"","pages":[{"title":"GetDesc1","description":"Retrieves a description of the protected resource session. (ID3D12ProtectedResourceSession1::GetDesc1)","href":"/reference/graphics/d3d12/interfaces/id3d12protectedresourcesession1/methods/id3d12protectedresourcesession1_getdesc1_public"}]}]},{"group":"id3d12protectedsession","tag":"","pages":[{"title":"ID3D12ProtectedSession","description":"Offers base functionality that allows for a consistent way to monitor the validity of a session across the different types of sessions.","href":"/reference/graphics/d3d12/interfaces/id3d12protectedsession/id3d12protectedsession_public"},{"group":"methods","tag":"","pages":[{"title":"GetSessionStatus","description":"Gets the status of the protected session.","href":"/reference/graphics/d3d12/interfaces/id3d12protectedsession/methods/id3d12protectedsession_getsessionstatus_public"},{"title":"GetStatusFence","description":"Retrieves the fence for the protected session. From the fence, you can retrieve the current uniqueness validity value (using ID3D12Fence::GetCompletedValue).","href":"/reference/graphics/d3d12/interfaces/id3d12protectedsession/methods/id3d12protectedsession_getstatusfence_public"}]}]},{"group":"id3d12queryheap","tag":"","pages":[{"title":"ID3D12QueryHeap","description":"Manages a query heap. A query heap holds an array of queries, referenced by indexes.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12queryheap/id3d12queryheap_public","hiddenSetByFrontmatter":true}]},{"group":"id3d12resource","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"ID3D12Resource::GetDesc","description":"Gets the resource description.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12resource/methods/id3d12resource_getdesc_public","hiddenSetByFrontmatter":true},{"title":"GetGPUVirtualAddress","description":"This method returns the GPU virtual address of a buffer resource.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12resource/methods/id3d12resource_getgpuvirtualaddress_public","hiddenSetByFrontmatter":true},{"title":"GetHeapProperties","description":"Retrieves the properties of the resource heap, for placed and committed resources.","href":"/reference/graphics/d3d12/interfaces/id3d12resource/methods/id3d12resource_getheapproperties_public"},{"title":"Map","description":"Gets a CPU pointer to the specified subresource in the resource, but may not disclose the pointer value to applications. Map also invalidates the CPU cache.","href":"/reference/graphics/d3d12/interfaces/id3d12resource/methods/id3d12resource_map_public"},{"title":"ReadFromSubresource","description":"Uses the CPU to copy data from a subresource, enabling the CPU to read the contents of most textures with undefined layouts.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12resource/methods/id3d12resource_readfromsubresource_public","hiddenSetByFrontmatter":true},{"title":"Unmap","description":"Invalidates the CPU pointer to the specified subresource in the resource.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12resource/methods/id3d12resource_unmap_public","hiddenSetByFrontmatter":true},{"title":"Id3d12resource writetosubresource public","href":"/reference/graphics/d3d12/interfaces/id3d12resource/methods/id3d12resource_writetosubresource_public"}]}]},{"group":"id3d12rootsignature","tag":"","pages":[{"title":"ID3D12RootSignature","description":"The root signature defines what resources are bound to the graphics pipeline. A root signature is configured by the app and links command lists to the.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12rootsignature/id3d12rootsignature_public","hiddenSetByFrontmatter":true}]},{"group":"id3d12rootsignaturedeserializer","tag":"","pages":[{"title":"ID3D12RootSignatureDeserializer","description":"Contains a method to return the deserialized D3D12_ROOT_SIGNATURE_DESC data structure, of a serialized root signature version 1.0.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12rootsignaturedeserializer/id3d12rootsignaturedeserializer_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetRootSignatureDesc","description":"Gets the layout of the root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12rootsignaturedeserializer/methods/id3d12rootsignaturedeserializer_getrootsignaturedesc_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12shadercachesession","tag":"","pages":[{"title":"ID3D12ShaderCacheSession","description":"Represents a shader cache session.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12shadercachesession/id3d12shadercachesession_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"FindValue","description":"Looks up an entry in the cache whose key exactly matches the provided key.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12shadercachesession/methods/id3d12shadercachesession_findvalue_public","hiddenSetByFrontmatter":true},{"title":"ID3D12ShaderCacheSession::GetDesc","description":"Retrieves the description used to create the cache session.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12shadercachesession/methods/id3d12shadercachesession_getdesc_public","hiddenSetByFrontmatter":true},{"title":"SetDeleteOnDestroy","description":"When all cache session objects corresponding to a given cache are destroyed, the cache is cleared.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12shadercachesession/methods/id3d12shadercachesession_setdeleteondestroy_public","hiddenSetByFrontmatter":true},{"title":"StoreValue","description":"Adds an entry to the cache.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12shadercachesession/methods/id3d12shadercachesession_storevalue_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12stateobjectproperties","tag":"","pages":[{"group":"methods","tag":"","pages":[{"title":"GetPipelineStackSize (XBOX Series consoles)","description":"Gets the current pipeline stack size.","sidebarTitle":"GetPipelineStackSize","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12stateobjectproperties/methods/id3d12stateobjectproperties_getpipelinestacksize_public","hiddenSetByFrontmatter":true},{"title":"GetShaderIdentifier (XBOX Series consoles)","description":"Retrieves the unique identifier for a shader that can be used in a shader record.","sidebarTitle":"GetShaderIdentifier","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12stateobjectproperties/methods/id3d12stateobjectproperties_getshaderidentifier_public","hiddenSetByFrontmatter":true},{"title":"GetShaderStackSize (XBOX Series consoles)","description":"Gets the amount of stack memory required to invoke a raytracing shader in HLSL.","sidebarTitle":"GetShaderStackSize","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12stateobjectproperties/methods/id3d12stateobjectproperties_getshaderstacksize_public","hiddenSetByFrontmatter":true},{"title":"SetPipelineStackSize (XBOX Series consoles)","description":"Set the current pipeline stack size.","sidebarTitle":"SetPipelineStackSize","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12stateobjectproperties/methods/id3d12stateobjectproperties_setpipelinestacksize_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12tools","tag":"","pages":[{"title":"Id3d12tools public","href":"/reference/graphics/d3d12/interfaces/id3d12tools/id3d12tools_public"},{"group":"methods","tag":"","pages":[{"title":"Id3d12tools enableshaderinstrumentation public","href":"/reference/graphics/d3d12/interfaces/id3d12tools/methods/id3d12tools_enableshaderinstrumentation_public"},{"title":"Id3d12tools shaderinstrumentationenabled public","href":"/reference/graphics/d3d12/interfaces/id3d12tools/methods/id3d12tools_shaderinstrumentationenabled_public"}]}]},{"group":"id3d12versionedrootsignaturedeserializer","tag":"","pages":[{"title":"ID3D12VersionedRootSignatureDeserializer","description":"Contains methods to return the deserialized D3D12_ROOT_SIGNATURE_DESC1 data structure, of any version of a serialized root signature.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12versionedrootsignaturedeserializer/id3d12versionedrootsignaturedeserializer_public","hiddenSetByFrontmatter":true},{"group":"methods","tag":"","pages":[{"title":"GetRootSignatureDescAtVersion","description":"Converts root signature description structures to a requested version.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12versionedrootsignaturedeserializer/methods/id3d12versionedrootsignaturedeserializer_getrootsignaturedescatversion_public","hiddenSetByFrontmatter":true},{"title":"GetUnconvertedRootSignatureDesc","description":"Gets the layout of the root signature, without converting between root signature versions.","hidden":false,"href":"/reference/graphics/d3d12/interfaces/id3d12versionedrootsignaturedeserializer/methods/id3d12versionedrootsignaturedeserializer_getunconvertedrootsignaturedesc_public","hiddenSetByFrontmatter":true}]}]},{"group":"id3d12virtualizationguestdevice","tag":"","pages":[{"title":"Id3d12virtualizationguestdevice public","href":"/reference/graphics/d3d12/interfaces/id3d12virtualizationguestdevice/id3d12virtualizationguestdevice_public"},{"group":"methods","tag":"","pages":[{"title":"Id3d12virtualizationguestdevice createfencefd public","href":"/reference/graphics/d3d12/interfaces/id3d12virtualizationguestdevice/methods/id3d12virtualizationguestdevice_createfencefd_public"},{"title":"Id3d12virtualizationguestdevice sharewithhost public","href":"/reference/graphics/d3d12/interfaces/id3d12virtualizationguestdevice/methods/id3d12virtualizationguestdevice_sharewithhost_public"}]}]}]},{"group":"structs","pages":[{"title":"D3D12_AUTO_BREADCRUMB_NODE","description":"Represents Device Removed Extended Data (DRED) auto-breadcrumb data as a node in a linked list.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_auto_breadcrumb_node_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BARRIER_GROUP (XBOX Series consoles)","description":"Describes a group of barriers of a given type.","sidebarTitle":"D3D12_BARRIER_GROUP","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_barrier_group_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BARRIER_SUBRESOURCE_RANGE (XBOX Series consoles)","description":"Allows you to transition logically-adjacent ranges of subresources.","sidebarTitle":"D3D12_BARRIER_SUBRESOURCE_RANGE","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_barrier_subresource_range_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BLEND_DESC","description":"Describes the blend state. (D3D12_BLEND_DESC)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_blend_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BOX","description":"Describes a 3D box.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_box_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BUFFER_BARRIER (XBOX Series consoles)","description":"Describes a buffer memory access barrier. Used by buffer barriers to indicate when resource memory must be made visible for a specific access type.","sidebarTitle":"D3D12_BUFFER_BARRIER","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_buffer_barrier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BUFFER_RTV","description":"Describes the elements in a buffer resource to use in a render-target view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_buffer_rtv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BUFFER_SRV","description":"Describes the elements in a buffer resource to use in a shader-resource view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_buffer_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BUFFER_UAV","description":"Describes the elements in a buffer to use in a unordered-access view. (D3D12_BUFFER_UAV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_buffer_uav_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_DESC","description":"Describes a raytracing acceleration structure. Pass this structure into ID3D12GraphicsCommandList4::BuildRaytracingAccelerationStructure to describe the.","sidebarTitle":"D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_build_raytracing_acceleration_structure_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_INPUTS","description":"Defines the inputs for a raytracing acceleration structure build operation. This structure is used by.","sidebarTitle":"D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_INPUTS","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_build_raytracing_acceleration_structure_inputs_public","hiddenSetByFrontmatter":true},{"title":"D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_TOOLS_VISUALIZATION_HEADER (XBOX Series consoles)","description":"Describes the GPU memory layout of an acceleration structure visualization.","sidebarTitle":"D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_TOOLS_VISUALIZATION_HEADER","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_build_raytracing_acceleration_structure_tools_visualization_header_public","hiddenSetByFrontmatter":true},{"title":"D3D12_CACHED_PIPELINE_STATE","description":"Stores a pipeline state.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_cached_pipeline_state_public","hiddenSetByFrontmatter":true},{"title":"D3D12_CLEAR_VALUE","description":"Describes a value used to optimize clear operations for a particular resource.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_clear_value_public","hiddenSetByFrontmatter":true},{"title":"D3D12_COMMAND_QUEUE_DESC","description":"Describes a command queue.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_command_queue_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_COMMAND_SIGNATURE_DESC","description":"Describes the arguments (parameters) of a command signature.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_command_signature_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_COMPUTE_PIPELINE_STATE_DESC","description":"Describes a compute pipeline state object.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_compute_pipeline_state_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_CONSTANT_BUFFER_VIEW_DESC","description":"Describes a constant buffer to view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_constant_buffer_view_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_CPU_DESCRIPTOR_HANDLE","description":"Describes a CPU descriptor handle.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_cpu_descriptor_handle_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DEPTH_STENCIL_DESC","description":"Describes depth-stencil state. (D3D12_DEPTH_STENCIL_DESC)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_depth_stencil_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DEPTH_STENCIL_DESC1","description":"Describes depth-stencil state. (D3D12_DEPTH_STENCIL_DESC1)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_depth_stencil_desc1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DEPTH_STENCIL_VALUE","description":"Specifies a depth and stencil value.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_depth_stencil_value_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DEPTH_STENCIL_VIEW_DESC","description":"Describes the subresources of a texture that are accessible from a depth-stencil view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_depth_stencil_view_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DEPTH_STENCILOP_DESC","description":"Describes stencil operations that can be performed based on the results of stencil test.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_depth_stencilop_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DESCRIPTOR_HEAP_DESC","description":"Describes the descriptor heap.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_descriptor_heap_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DESCRIPTOR_RANGE","description":"Describes a descriptor range.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_descriptor_range_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DESCRIPTOR_RANGE1","description":"Describes a descriptor range, with flags to determine their volatility.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_descriptor_range1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DEVICE_REMOVED_EXTENDED_DATA","description":"Represents Device Removed Extended Data (DRED) version 1.0 data.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_device_removed_extended_data_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DEVICE_REMOVED_EXTENDED_DATA1","description":"Represents Device Removed Extended Data (DRED) version 1.1 data.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_device_removed_extended_data1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DISCARD_REGION","description":"Describes details for the discard-resource operation.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_discard_region_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DISPATCH_ARGUMENTS","description":"Describes dispatch parameters, for use by the compute shader.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_dispatch_arguments_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DISPATCH_RAYS_DESC (XBOX Series consoles)","description":"Describes the properties of a ray dispatch operation initiated with a call to ID3D12GraphicsCommandList4::DispatchRays.","sidebarTitle":"D3D12_DISPATCH_RAYS_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_dispatch_rays_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRAW_ARGUMENTS","description":"Describes parameters for drawing instances.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_draw_arguments_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRAW_INDEXED_ARGUMENTS","description":"Describes parameters for drawing indexed instances.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_draw_indexed_arguments_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRED_ALLOCATION_NODE","description":"Describes, as a node in a linked list, data about an allocation tracked by Device Removed Extended Data (DRED).","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_dred_allocation_node_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRED_AUTO_BREADCRUMBS_OUTPUT","description":"Contains a pointer to the head of a linked list of D3D12_AUTO_BREADCRUMB_NODE objects.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_dred_auto_breadcrumbs_output_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DRED_PAGE_FAULT_OUTPUT","description":"Describes allocation data related to a GPU page fault on a given virtual address (VA).","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_dred_page_fault_output_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DXIL_LIBRARY_DESC (XBOX Series consoles)","description":"Describes a DXIL library state subobject that can be included in a state object.","sidebarTitle":"D3D12_DXIL_LIBRARY_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_dxil_library_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_DXIL_SUBOBJECT_TO_EXPORTS_ASSOCIATION","description":"This subobject is unsupported in the current release.","sidebarTitle":"D3D12_DXIL_SUBOBJECT_TO_EXPORTS_ASSOCIATION","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_dxil_subobject_to_exports_association_public","hiddenSetByFrontmatter":true},{"title":"D3D12_EXISTING_COLLECTION_DESC (XBOX Series consoles)","description":"A state subobject describing an existing collection that can be included in a state object.","sidebarTitle":"D3D12_EXISTING_COLLECTION_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_existing_collection_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_EXPORT_DESC (XBOX Series consoles)","description":"Describes an export from a state subobject such as a DXIL library or a collection state object.","sidebarTitle":"D3D12_EXPORT_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_export_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_ARCHITECTURE","description":"Provides detail about the adapter architecture, so that your application can better optimize for certain adapter properties.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_architecture_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_ARCHITECTURE1","description":"Provides detail about each adapter's architectural details, so that your application can better optimize for certain adapter properties.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_architecture1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_COMMAND_QUEUE_PRIORITY","description":"Details the adapter's support for prioritization of different command queue types.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_command_queue_priority_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_CROSS_NODE","description":"Indicates the level of support for the sharing of resources between different adapters\u0026mdash;for example, multiple GPUs.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_cross_node_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_D3D12_OPTIONS","description":"Describes Direct3D 12 feature options in the current graphics driver.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_d3d12_options_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_D3D12_OPTIONS1","description":"Describes the level of support for HLSL 6.0 wave operations.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_d3d12_options1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_D3D12_OPTIONS12","description":"Indicates whether or not Enhanced Barriers are supported.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_d3d12_options12_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_D3D12_OPTIONS13","description":"Indicates whether a collection of smaller API features are supported.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_d3d12_options13_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_D3D12_OPTIONS2","description":"Indicates the level of support that the adapter provides for depth-bounds tests and programmable sample positions.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_d3d12_options2_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_D3D12_OPTIONS3","description":"Indicates the level of support that the adapter provides for timestamp queries, format-casting, immediate write, view instancing, and barycentrics.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_d3d12_options3_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_D3D12_OPTIONS4","description":"Indicates the level of support for 64KB-aligned MSAA textures, cross-API sharing, and native 16-bit shader operations.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_d3d12_options4_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_D3D12_OPTIONS5","description":"Indicates the level of support that the adapter provides for render passes, ray tracing, and shader-resource view tier 3 tiled resources.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_d3d12_options5_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_D3D12_OPTIONS6","description":"Indicates the level of support that the adapter provides for variable-rate shading (VRS), and indicates whether or not background processing is supported.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_d3d12_options6_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_EXISTING_HEAPS","description":"Provides detail about whether the adapter supports creating heaps from existing system memory.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_existing_heaps_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_FEATURE_LEVELS","description":"Describes info about the feature levels supported by the current graphics driver.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_feature_levels_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_FORMAT_INFO","description":"Describes a DXGI data format and plane count.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_format_info_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_FORMAT_SUPPORT","description":"Describes which resources are supported by the current graphics driver for a given format. (D3D12_FEATURE_DATA_FORMAT_SUPPORT)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_format_support_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_GPU_VIRTUAL_ADDRESS_SUPPORT","description":"Details the adapter's GPU virtual address space limitations, including maximum address bits per resource and per process.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_gpu_virtual_address_support_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_MULTISAMPLE_QUALITY_LEVELS","description":"Describes the multi-sampling image quality levels for a given format and sample count.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_multisample_quality_levels_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_QUERY_META_COMMAND","description":"Indicates the level of support that the adapter provides for metacommands.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_query_meta_command_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_ROOT_SIGNATURE","description":"Indicates root signature version support.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_root_signature_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_SERIALIZATION","description":"Indicates the level of support for heap serialization.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_serialization_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_SHADER_CACHE","description":"Describes the level of shader caching supported in the current graphics driver. (D3D12_FEATURE_DATA_SHADER_CACHE)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_shader_cache_public","hiddenSetByFrontmatter":true},{"title":"D3D12_FEATURE_DATA_SHADER_MODEL","description":"Contains the supported shader model.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_feature_data_shader_model_public","hiddenSetByFrontmatter":true},{"title":"D3D12_GLOBAL_BARRIER (XBOX Series consoles)","description":"Describes a resource memory access barrier. Used by global, texture, and buffer barriers to indicate when resource memory must be made visible for a specific.","sidebarTitle":"D3D12_GLOBAL_BARRIER","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_global_barrier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_GLOBAL_ROOT_SIGNATURE","description":"Defines a global root signature state suboject that will be used with associated shaders.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_global_root_signature_public","hiddenSetByFrontmatter":true},{"title":"D3D12_GPU_DESCRIPTOR_HANDLE","description":"Describes a GPU descriptor handle.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_gpu_descriptor_handle_public","hiddenSetByFrontmatter":true},{"title":"D3D12_GPU_VIRTUAL_ADDRESS_AND_STRIDE","description":"Represents a GPU virtual address and indexing stride.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_gpu_virtual_address_and_stride_public","hiddenSetByFrontmatter":true},{"title":"D3D12_GPU_VIRTUAL_ADDRESS_RANGE_AND_STRIDE","description":"Represents a GPU virtual address range and stride.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_gpu_virtual_address_range_and_stride_public","hiddenSetByFrontmatter":true},{"title":"D3D12_GPU_VIRTUAL_ADDRESS_RANGE","description":"Represents a GPU virtual address range.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_gpu_virtual_address_range_public","hiddenSetByFrontmatter":true},{"title":"D3d12 heap desc public","href":"/reference/graphics/d3d12/structs/d3d12_heap_desc_public"},{"title":"D3d12 heap properties public","href":"/reference/graphics/d3d12/structs/d3d12_heap_properties_public"},{"title":"D3D12_HIT_GROUP_DESC (XBOX Series consoles)","description":"Describes a raytracing hit group state subobject that can be included in a state object.","sidebarTitle":"D3D12_HIT_GROUP_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_hit_group_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_INDEX_BUFFER_VIEW","description":"Describes the index buffer to view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_index_buffer_view_public","hiddenSetByFrontmatter":true},{"title":"D3D12_INPUT_ELEMENT_DESC","description":"Describes a single element for the input-assembler stage of the graphics pipeline.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_input_element_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_INPUT_LAYOUT_DESC","description":"Describes the input-buffer data for the input-assembler stage.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_input_layout_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_LOCAL_ROOT_SIGNATURE","description":"Defines a local root signature state subobject that will be used with associated shaders.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_local_root_signature_public","hiddenSetByFrontmatter":true},{"title":"D3D12_MEMCPY_DEST","description":"Describes the destination of a memory copy operation.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_memcpy_dest_public","hiddenSetByFrontmatter":true},{"title":"D3D12_META_COMMAND_DESC","description":"Describes a meta command.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_meta_command_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_META_COMMAND_PARAMETER_DESC","description":"Describes a parameter to a meta command.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_meta_command_parameter_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_MIP_REGION","description":"Describes the dimensions of a mip region.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_mip_region_public","hiddenSetByFrontmatter":true},{"title":"D3D12_NODE_MASK","description":"A state subobject that identifies the GPU nodes to which the state object applies.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_node_mask_public","hiddenSetByFrontmatter":true},{"title":"D3d12 packed mip info public","href":"/reference/graphics/d3d12/structs/d3d12_packed_mip_info_public"},{"title":"D3D12_PIPELINE_STATE_STREAM_DESC","description":"Describes a pipeline state stream.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_pipeline_state_stream_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_PLACED_SUBRESOURCE_FOOTPRINT","description":"Describes the footprint of a placed subresource, including the offset and the D3D12_SUBRESOURCE_FOOTPRINT.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_placed_subresource_footprint_public","hiddenSetByFrontmatter":true},{"title":"D3D12_PROTECTED_RESOURCE_SESSION_DESC","description":"D3D12_PROTECTED_RESOURCE_SESSION_DESC (Direct3D 12 on XBOX) — Describes flags for a protected resource session, per adapter.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_protected_resource_session_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_PROTECTED_RESOURCE_SESSION_DESC1","description":"Describes flags and protection type for a protected resource session, per adapter.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_protected_resource_session_desc1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_QUERY_DATA_PIPELINE_STATISTICS","description":"Query information about graphics-pipeline activity in between calls to BeginQuery and EndQuery.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_query_data_pipeline_statistics_public","hiddenSetByFrontmatter":true},{"title":"D3D12_QUERY_DATA_SO_STATISTICS","description":"Describes query data for stream output.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_query_data_so_statistics_public","hiddenSetByFrontmatter":true},{"title":"D3D12_QUERY_HEAP_DESC","description":"Describes the purpose of a query heap. A query heap contains an array of individual queries.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_query_heap_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RANGE","description":"Describes a memory range.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_range_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RANGE_UINT64","description":"Describes a memory range in a 64-bit address space.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_range_uint64_public","hiddenSetByFrontmatter":true},{"title":"D3d12 rasterizer desc public","href":"/reference/graphics/d3d12/structs/d3d12_rasterizer_desc_public"},{"title":"D3D12_RAYTRACING_AABB (XBOX Series consoles)","description":"Represents an axis-aligned bounding box (AABB) used as raytracing geometry.","sidebarTitle":"D3D12_RAYTRACING_AABB","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_aabb_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_COMPACTED_SIZE_DESC (XBOX Series consoles)","description":"Describes the space requirement for acceleration structure after compaction.","sidebarTitle":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_COMPACTED_SIZE_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_acceleration_structure_postbuild_info_compacted_size_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_CURRENT_SIZE_DESC (XBOX Series consoles)","description":"Describes the space currently used by an acceleration structure.","sidebarTitle":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_CURRENT_SIZE_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_acceleration_structure_postbuild_info_current_size_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_DESC","description":"Description of the post-build information to generate from an acceleration structure. Use this structure in calls to.","sidebarTitle":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_acceleration_structure_postbuild_info_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_SERIALIZATION_DESC (XBOX Series consoles)","description":"Describes the size and layout of the serialized acceleration structure and header.","sidebarTitle":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_SERIALIZATION_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_acceleration_structure_postbuild_info_serialization_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_TOOLS_VISUALIZATION_DESC (XBOX Series consoles)","description":"Describes the space requirement for decoding an acceleration structure into a form that can be visualized by tools.","sidebarTitle":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_POSTBUILD_INFO_TOOLS_VISUALIZATION_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_acceleration_structure_postbuild_info_tools_visualization_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_PREBUILD_INFO","description":"Represents prebuild information about a raytracing acceleration structure. Get an instance of this structure by calling.","sidebarTitle":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_PREBUILD_INFO","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_acceleration_structure_prebuild_info_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_SRV","description":"A shader resource view (SRV) structure for storing a raytracing acceleration structure.","sidebarTitle":"D3D12_RAYTRACING_ACCELERATION_STRUCTURE_SRV","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_acceleration_structure_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_GEOMETRY_AABBS_DESC (XBOX Series consoles)","description":"Describes a set of Axis-aligned bounding boxes that are used in the D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_INPUTS structure to provide input data to a.","sidebarTitle":"D3D12_RAYTRACING_GEOMETRY_AABBS_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_geometry_aabbs_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_GEOMETRY_DESC (XBOX Series consoles)","description":"Describes a set of geometry that is used in the D3D12_BUILD_RAYTRACING_ACCELERATION_STRUCTURE_INPUTS structure to provide input data to a raytracing.","sidebarTitle":"D3D12_RAYTRACING_GEOMETRY_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_geometry_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_GEOMETRY_TRIANGLES_DESC","description":"Describes a set of triangles used as raytracing geometry. The geometry pointed to by this struct are always in triangle list form, indexed or non-indexed.","sidebarTitle":"D3D12_RAYTRACING_GEOMETRY_TRIANGLES_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_geometry_triangles_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_INSTANCE_DESC (XBOX Series consoles)","description":"Describes an instance of a raytracing acceleration structure used in GPU memory during the acceleration structure build process.","sidebarTitle":"D3D12_RAYTRACING_INSTANCE_DESC","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_instance_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_PIPELINE_CONFIG (XBOX Series consoles)","description":"A state subobject that represents a raytracing pipeline configuration.","sidebarTitle":"D3D12_RAYTRACING_PIPELINE_CONFIG","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_pipeline_config_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_PIPELINE_CONFIG1 (XBOX Series consoles)","description":"A state subobject that represents a raytracing pipeline configuration, with flags.","sidebarTitle":"D3D12_RAYTRACING_PIPELINE_CONFIG1","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_pipeline_config1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RAYTRACING_SHADER_CONFIG (XBOX Series consoles)","description":"A state subobject that represents a shader configuration.","sidebarTitle":"D3D12_RAYTRACING_SHADER_CONFIG","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_raytracing_shader_config_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_BEGINNING_ACCESS_CLEAR_PARAMETERS","description":"Describes the clear value to which resource(s) should be cleared at the beginning of a render pass.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_render_pass_beginning_access_clear_parameters_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_BEGINNING_ACCESS","description":"Describes the access to resource(s) that is requested by an application at the transition into a render pass.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_render_pass_beginning_access_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_DEPTH_STENCIL_DESC","description":"Describes a binding (fixed for the duration of the render pass) to a depth stencil view (DSV), as well as its beginning and ending access characteristics.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_render_pass_depth_stencil_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_ENDING_ACCESS","description":"Describes the access to resource(s) that is requested by an application at the transition out of a render pass.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_render_pass_ending_access_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_ENDING_ACCESS_RESOLVE_PARAMETERS","description":"Describes a resource to resolve to at the conclusion of a render pass.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_render_pass_ending_access_resolve_parameters_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_ENDING_ACCESS_RESOLVE_SUBRESOURCE_PARAMETERS","description":"Describes the subresources involved in resolving at the conclusion of a render pass.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_render_pass_ending_access_resolve_subresource_parameters_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_PASS_RENDER_TARGET_DESC","description":"Describes bindings (fixed for the duration of the render pass) to one or more render target views (RTVs), as well as their beginning and ending access.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_render_pass_render_target_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_TARGET_BLEND_DESC","description":"Describes the blend state for a render target. (D3D12_RENDER_TARGET_BLEND_DESC)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_render_target_blend_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RENDER_TARGET_VIEW_DESC","description":"Describes the subresources from a resource that are accessible by using a render-target view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_render_target_view_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESOURCE_ALIASING_BARRIER","description":"Describes the transition between usages of two different resources that have mappings into the same heap.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_resource_aliasing_barrier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESOURCE_ALLOCATION_INFO","description":"Describes parameters needed to allocate resources.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_resource_allocation_info_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESOURCE_ALLOCATION_INFO1","description":"Describes parameters needed to allocate resources, including offset.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_resource_allocation_info1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESOURCE_BARRIER","description":"Describes a resource barrier (transition in resource use).","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_resource_barrier_public","hiddenSetByFrontmatter":true},{"title":"D3d12 resource desc public","href":"/reference/graphics/d3d12/structs/d3d12_resource_desc_public"},{"title":"D3D12_RESOURCE_DESC1","description":"Describes a resource, such as a texture, including a mip region. This structure is used in several methods.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_resource_desc1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESOURCE_TRANSITION_BARRIER","description":"Describes the transition of subresources between different usages.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_resource_transition_barrier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RESOURCE_UAV_BARRIER","description":"Represents a resource in which all UAV accesses must complete before any future UAV accesses can begin.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_resource_uav_barrier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_CONSTANTS","description":"Describes constants inline in the root signature that appear in shaders as one constant buffer.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_root_constants_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_DESCRIPTOR","description":"Describes descriptors inline in the root signature version 1.0 that appear in shaders.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_root_descriptor_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_DESCRIPTOR_TABLE","description":"Describes the root signature 1.0 layout of a descriptor table as a collection of descriptor ranges that are all relative to a single base descriptor handle.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_root_descriptor_table_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_DESCRIPTOR_TABLE1","description":"Describes the root signature 1.1 layout of a descriptor table as a collection of descriptor ranges that are all relative to a single base descriptor handle.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_root_descriptor_table1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_DESCRIPTOR1","description":"Describes descriptors inline in the root signature version 1.1 that appear in shaders.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_root_descriptor1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_PARAMETER","description":"Describes the slot of a root signature version 1.0.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_root_parameter_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_PARAMETER1","description":"Describes the slot of a root signature version 1.1.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_root_parameter1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_SIGNATURE_DESC","description":"Describes the layout of a root signature version 1.0.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_root_signature_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_ROOT_SIGNATURE_DESC1","description":"Describes the layout of a root signature version 1.1.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_root_signature_desc1_public","hiddenSetByFrontmatter":true},{"title":"D3D12_RT_FORMAT_ARRAY","description":"Wraps an array of render target formats.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_rt_format_array_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SAMPLE_POSITION","description":"Describes a sub-pixel sample position for use with programmable sample positions.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_sample_position_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SAMPLER_DESC","description":"Describes a sampler state. (D3D12_SAMPLER_DESC)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_sampler_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SERIALIZED_DATA_DRIVER_MATCHING_IDENTIFIER","description":"Opaque data structure describing driver versioning for a serialized acceleration structure.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_serialized_data_driver_matching_identifier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SERIALIZED_RAYTRACING_ACCELERATION_STRUCTURE_HEADER","description":"Defines the header for a serialized raytracing acceleration structure.","sidebarTitle":"D3D12_SERIALIZED_RAYTRACING_ACCELERATION_STRUCTURE_HEADER","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_serialized_raytracing_acceleration_structure_header_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SHADER_BYTECODE","description":"Describes shader data. (D3D12_SHADER_BYTECODE)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_shader_bytecode_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SHADER_CACHE_SESSION_DESC","description":"Describes a shader cache session.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_shader_cache_session_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SHADER_RESOURCE_VIEW_DESC","description":"Describes a shader-resource view. (D3D12_SHADER_RESOURCE_VIEW_DESC)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_shader_resource_view_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SO_DECLARATION_ENTRY","description":"Describes a vertex element in a vertex buffer in an output slot.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_so_declaration_entry_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STATE_OBJECT_CONFIG","description":"Defines general properties of a state object.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_state_object_config_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STATE_OBJECT_DESC","description":"Description of a state object. Pass this structure into ID3D12Device::CreateStateObject.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_state_object_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STATE_SUBOBJECT","description":"Represents a subobject within a state object description. Use with D3D12_STATE_OBJECT_DESC.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_state_subobject_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STATIC_SAMPLER_DESC","description":"Describes a static sampler.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_static_sampler_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STREAM_OUTPUT_BUFFER_VIEW","description":"Describes a stream output buffer.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_stream_output_buffer_view_public","hiddenSetByFrontmatter":true},{"title":"D3D12_STREAM_OUTPUT_DESC","description":"Describes a streaming output buffer.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_stream_output_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SUBOBJECT_TO_EXPORTS_ASSOCIATION","description":"Associates a subobject defined directly in a state object with shader exports.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_subobject_to_exports_association_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SUBRESOURCE_DATA","description":"Describes subresource data. (D3D12_SUBRESOURCE_DATA)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_subresource_data_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SUBRESOURCE_FOOTPRINT","description":"Describes the format, width, height, depth, and row-pitch of the subresource into the parent resource.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_subresource_footprint_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SUBRESOURCE_INFO","description":"Describes subresource data. (D3D12_SUBRESOURCE_INFO)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_subresource_info_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SUBRESOURCE_RANGE_UINT64","description":"Describes a subresource memory range.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_subresource_range_uint64_public","hiddenSetByFrontmatter":true},{"title":"D3D12_SUBRESOURCE_TILING","description":"Describes a tiled subresource volume. (D3D12_SUBRESOURCE_TILING)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_subresource_tiling_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX1D_ARRAY_DSV","description":"Describes the subresources from an array of 1D textures to use in a depth-stencil view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex1d_array_dsv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX1D_ARRAY_RTV","description":"Describes the subresources from an array of 1D textures to use in a render-target view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex1d_array_rtv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX1D_ARRAY_SRV","description":"Describes the subresources from an array of 1D textures to use in a shader-resource view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex1d_array_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX1D_ARRAY_UAV","description":"Describes an array of unordered-access 1D texture resources. (D3D12_TEX1D_ARRAY_UAV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex1d_array_uav_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX1D_DSV","description":"Describes the subresource from a 1D texture that is accessible to a depth-stencil view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex1d_dsv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX1D_RTV","description":"Describes the subresource from a 1D texture to use in a render-target view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex1d_rtv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX1D_SRV","description":"Specifies the subresource from a 1D texture to use in a shader-resource view. (D3D12_TEX1D_SRV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex1d_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX1D_UAV","description":"Describes a unordered-access 1D texture resource. (D3D12_TEX1D_UAV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex1d_uav_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2D_ARRAY_DSV","description":"Describes the subresources from an array of 2D textures that are accessible to a depth-stencil view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2d_array_dsv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2D_ARRAY_RTV","description":"Describes the subresources from an array of 2D textures to use in a render-target view. (D3D12_TEX2D_ARRAY_RTV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2d_array_rtv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2D_ARRAY_SRV","description":"Describes the subresources from an array of 2D textures to use in a shader-resource view. (D3D12_TEX2D_ARRAY_SRV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2d_array_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2D_ARRAY_UAV","description":"Describes an array of unordered-access 2D texture resources. (D3D12_TEX2D_ARRAY_UAV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2d_array_uav_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2D_DSV","description":"Describes the subresource from a 2D texture that is accessible to a depth-stencil view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2d_dsv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2D_RTV","description":"Describes the subresource from a 2D texture to use in a render-target view. (D3D12_TEX2D_RTV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2d_rtv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2D_SRV","description":"Describes the subresource from a 2D texture to use in a shader-resource view. (D3D12_TEX2D_SRV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2d_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2D_UAV","description":"Describes a unordered-access 2D texture resource. (D3D12_TEX2D_UAV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2d_uav_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2DMS_ARRAY_DSV","description":"Describes the subresources from an array of multi sampled 2D textures for a depth-stencil view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2dms_array_dsv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2DMS_ARRAY_RTV","description":"Describes the subresources from an array of multi sampled 2D textures to use in a render-target view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2dms_array_rtv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2DMS_ARRAY_SRV","description":"Describes the subresources from an array of multi sampled 2D textures to use in a shader-resource view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2dms_array_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2DMS_DSV","description":"Describes the subresource from a multi sampled 2D texture that is accessible to a depth-stencil view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2dms_dsv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2DMS_RTV","description":"Describes the subresource from a multi sampled 2D texture to use in a render-target view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2dms_rtv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX2DMS_SRV","description":"Describes the subresources from a multi sampled 2D texture to use in a shader-resource view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex2dms_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX3D_RTV","description":"Describes the subresources from a 3D texture to use in a render-target view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex3d_rtv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX3D_SRV","description":"Describes the subresources from a 3D texture to use in a shader-resource view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex3d_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEX3D_UAV","description":"Describes a unordered-access 3D texture resource. (D3D12_TEX3D_UAV)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tex3d_uav_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEXCUBE_ARRAY_SRV","description":"Describes the subresources from an array of cube textures to use in a shader-resource view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_texcube_array_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEXCUBE_SRV","description":"Describes the subresource from a cube texture to use in a shader-resource view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_texcube_srv_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEXTURE_BARRIER (XBOX Series consoles)","description":"Expresses an access transition for a texture.","sidebarTitle":"D3D12_TEXTURE_BARRIER","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_texture_barrier_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TEXTURE_COPY_LOCATION","description":"Describes a portion of a texture for the purpose of texture copies.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_texture_copy_location_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TILE_REGION_SIZE","description":"Describes the size of a tiled region. (D3D12_TILE_REGION_SIZE)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tile_region_size_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TILE_SHAPE","description":"Describes the shape of a tile by specifying its dimensions. (D3D12_TILE_SHAPE)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tile_shape_public","hiddenSetByFrontmatter":true},{"title":"D3D12_TILED_RESOURCE_COORDINATE","description":"Describes the coordinates of a tiled resource. (D3D12_TILED_RESOURCE_COORDINATE)","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_tiled_resource_coordinate_public","hiddenSetByFrontmatter":true},{"title":"D3D12_UNORDERED_ACCESS_VIEW_DESC","description":"Describes the subresources from a resource that are accessible by using an unordered-access view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_unordered_access_view_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_VERSIONED_DEVICE_REMOVED_EXTENDED_DATA","description":"Represents versioned Device Removed Extended Data (DRED) data.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_versioned_device_removed_extended_data_public","hiddenSetByFrontmatter":true},{"title":"D3D12_VERSIONED_ROOT_SIGNATURE_DESC","description":"Holds any version of a root signature description, and is designed to be used with serialization/deserialization functions.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_versioned_root_signature_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_VERTEX_BUFFER_VIEW","description":"Describes a vertex buffer view.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_vertex_buffer_view_public","hiddenSetByFrontmatter":true},{"title":"D3D12_VIEW_INSTANCE_LOCATION","description":"Specifies the viewport/stencil and render target associated with a view instance.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_view_instance_location_public","hiddenSetByFrontmatter":true},{"title":"D3D12_VIEW_INSTANCING_DESC","description":"Specifies parameters used during view instancing configuration.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_view_instancing_desc_public","hiddenSetByFrontmatter":true},{"title":"D3D12_VIEWPORT","description":"Describes the dimensions of a viewport.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_viewport_public","hiddenSetByFrontmatter":true},{"title":"D3D12_WRITEBUFFERIMMEDIATE_PARAMETER","description":"Specifies the immediate value and destination address written using ID3D12CommandList2::WriteBufferImmediate.","hidden":false,"href":"/reference/graphics/d3d12/structs/d3d12_writebufferimmediate_parameter_public","hiddenSetByFrontmatter":true},{"title":"D3d12xbox raytracing acceleration structure postbuild info offline statistics desc public","href":"/reference/graphics/d3d12/structs/d3d12xbox_raytracing_acceleration_structure_postbuild_info_offline_statistics_desc_public"}]}]},{"group":"d3d12_x","icon":"cube","hidden":true,"tag":"NDA","pages":[{"title":"D3d12 x members","href":"/reference/graphics/d3d12_x/d3d12_x_members"},{"group":"Interfaces","icon":"plug","hidden":true,"tag":"NDA","pages":[{"group":"CD3DX12_PIPELINE_STATE_STREAM_SUBOBJECT","hidden":true,"tag":"NDA","pages":[{"title":"Cd3dx12 pipeline state stream subobject","href":"/reference/graphics/d3d12_x/interfaces/cd3dx12_pipeline_state_stream_subobject/cd3dx12_pipeline_state_stream_subobject"}]},{"group":"CD3DX12XBOX_PIPELINE_STATE_STREAM_PARSE_HELPER","hidden":true,"tag":"NDA","pages":[{"title":"Cd3dx12xbox pipeline state stream parse helper","href":"/reference/graphics/d3d12_x/interfaces/cd3dx12xbox_pipeline_state_stream_parse_helper/cd3dx12xbox_pipeline_state_stream_parse_helper"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Cd3dx12xbox pipeline state stream parse helper xboxsetcomputeshaderlimits","href":"/reference/graphics/d3d12_x/interfaces/cd3dx12xbox_pipeline_state_stream_parse_helper/methods/cd3dx12xbox_pipeline_state_stream_parse_helper_xboxsetcomputeshaderlimits"},{"title":"Cd3dx12xbox pipeline state stream parse helper xboxsetdepthstenciloptions","href":"/reference/graphics/d3d12_x/interfaces/cd3dx12xbox_pipeline_state_stream_parse_helper/methods/cd3dx12xbox_pipeline_state_stream_parse_helper_xboxsetdepthstenciloptions"},{"title":"Cd3dx12xbox pipeline state stream parse helper xboxsetgraphicsshaderlimits","href":"/reference/graphics/d3d12_x/interfaces/cd3dx12xbox_pipeline_state_stream_parse_helper/methods/cd3dx12xbox_pipeline_state_stream_parse_helper_xboxsetgraphicsshaderlimits"},{"title":"Cd3dx12xbox pipeline state stream parse helper xboxsetpixelshaderoptions","href":"/reference/graphics/d3d12_x/interfaces/cd3dx12xbox_pipeline_state_stream_parse_helper/methods/cd3dx12xbox_pipeline_state_stream_parse_helper_xboxsetpixelshaderoptions"},{"title":"Cd3dx12xbox pipeline state stream parse helper xboxsettessellationparameters","href":"/reference/graphics/d3d12_x/interfaces/cd3dx12xbox_pipeline_state_stream_parse_helper/methods/cd3dx12xbox_pipeline_state_stream_parse_helper_xboxsettessellationparameters"}]}]},{"group":"ID3D12CommandAllocator","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12commandallocator","href":"/reference/graphics/d3d12_x/interfaces/ID3D12CommandAllocator/id3d12commandallocator"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12commandallocator setallocatorcallbackx","href":"/reference/graphics/d3d12_x/interfaces/ID3D12CommandAllocator/methods/id3d12commandallocator_setallocatorcallbackx"}]}]},{"group":"ID3D12CommandQueue","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12commandqueue","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/id3d12commandqueue"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12commandqueue clearpagemappingsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_clearpagemappingsx"},{"title":"Id3d12commandqueue copypagemappingsbatchx","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_copypagemappingsbatchx"},{"title":"Id3d12commandqueue copypagemappingsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_copypagemappingsx"},{"title":"Id3d12commandqueue executecommandlists","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_executecommandlists"},{"title":"Id3d12commandqueue executecommandlists2x x","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_executecommandlists2x_x"},{"title":"Id3d12commandqueue invalidategraphicstlbx","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_invalidategraphicstlbx"},{"title":"Id3d12commandqueue kickoffx","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_kickoffx"},{"title":"Id3d12commandqueue pixgpubegincapture","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_pixgpubegincapture"},{"title":"Id3d12commandqueue pixgpucapturenextframe","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_pixgpucapturenextframe"},{"title":"Id3d12commandqueue pixgpuendcapture","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_pixgpuendcapture"},{"title":"Id3d12commandqueue presentx","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_presentx"},{"title":"Id3d12commandqueue resumex","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_resumex"},{"title":"Id3d12commandqueue sethdrtonemapperx","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_sethdrtonemapperx"},{"title":"Id3d12commandqueue signalx","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_signalx"},{"title":"Id3d12commandqueue suspendx","href":"/reference/graphics/d3d12_x/interfaces/id3d12commandqueue/methods/id3d12commandqueue_suspendx"}]}]},{"group":"ID3D12Debug","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12debug","href":"/reference/graphics/d3d12_x/interfaces/id3d12debug/id3d12debug"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12debug setprocessdebugflags","href":"/reference/graphics/d3d12_x/interfaces/id3d12debug/methods/id3d12debug_setprocessdebugflags"}]}]},{"group":"ID3D12Device","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12device","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/id3d12device"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12device createcommandlistx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createcommandlistx"},{"title":"Id3d12device createcommandqueuex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createcommandqueuex"},{"title":"Id3d12device createcommittedresourcex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createcommittedresourcex"},{"title":"Id3d12device createcomponentplacedresourcex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createcomponentplacedresourcex"},{"title":"Id3d12device createcomponentplacedresourcex1","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createcomponentplacedresourcex1"},{"title":"Id3d12device createcomputepipelinestatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createcomputepipelinestatex"},{"title":"Id3d12device createcountersetx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createcountersetx"},{"title":"Id3d12device createderivedcomputepipelinestatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createderivedcomputepipelinestatex"},{"title":"Id3d12device createderivedgraphicspipelinestatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createderivedgraphicspipelinestatex"},{"title":"Id3d12device creategraphicspipelinestatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_creategraphicspipelinestatex"},{"title":"Id3d12device createplacedrawshaderresourceviewx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createplacedrawshaderresourceviewx"},{"title":"Id3d12device createplacedrawunorderedaccessviewx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createplacedrawunorderedaccessviewx"},{"title":"Id3d12device createplacedresourcex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createplacedresourcex"},{"title":"Id3d12device createplacedshaderresourceviewx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createplacedshaderresourceviewx"},{"title":"Id3d12device createplacedunorderedaccessviewx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createplacedunorderedaccessviewx"},{"title":"Id3d12device createsamplerx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_createsamplerx"},{"title":"Id3d12device deserializecomputepipelinestatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_deserializecomputepipelinestatex"},{"title":"Id3d12device deserializegraphicspipelinestatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_deserializegraphicspipelinestatex"},{"title":"Id3d12device enablemanualgraphicstlbinvalidationx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_enablemanualgraphicstlbinvalidationx"},{"title":"Id3d12device getdebugflagsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_getdebugflagsx"},{"title":"Id3d12device getdefaultmsaaparametersx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_getdefaultmsaaparametersx"},{"title":"Id3d12device getframestatisticsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_getframestatisticsx"},{"title":"Id3d12device getgpuhardwareconfigurationx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_getgpuhardwareconfigurationx"},{"title":"Id3d12device registercustomfencelocationx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_registercustomfencelocationx"},{"title":"Id3d12device registerpagepoolx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_registerpagepoolx"},{"title":"Id3d12device reportgpuhangx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_reportgpuhangx"},{"title":"Id3d12device scheduleframeeventx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_scheduleframeeventx"},{"title":"Id3d12device serializecomputepipelinestatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_serializecomputepipelinestatex"},{"title":"Id3d12device serializegraphicspipelinestatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_serializegraphicspipelinestatex"},{"title":"Id3d12device setdebugcallbackx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_setdebugcallbackx"},{"title":"Id3d12device setdebugerrorfilterx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_setdebugerrorfilterx"},{"title":"Id3d12device setdebugflagsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_setdebugflagsx"},{"title":"Id3d12device setdriverhintx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_setdriverhintx"},{"title":"Id3d12device setframeintervalx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_setframeintervalx"},{"title":"Id3d12device setgpumemorypriorityx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_setgpumemorypriorityx"},{"title":"Id3d12device sethangcallbacksx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_sethangcallbacksx"},{"title":"Id3d12device unregistercustomfencelocationx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_unregistercustomfencelocationx"},{"title":"Id3d12device unregisterpagepoolx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_unregisterpagepoolx"},{"title":"Id3d12device waitframeeventx","href":"/reference/graphics/d3d12_x/interfaces/id3d12device/methods/id3d12device_waitframeeventx"}]}]},{"group":"ID3D12Device3","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12device3","href":"/reference/graphics/d3d12_x/interfaces/id3d12device3/id3d12device3"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12device3 registerpagepool2x","href":"/reference/graphics/d3d12_x/interfaces/id3d12device3/methods/id3d12device3_registerpagepool2x"}]}]},{"group":"ID3D12GraphicsCommandList","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12graphicscommandlist","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/id3d12graphicscommandlist"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12graphicscommandlist advancepredicationx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_advancepredicationx"},{"title":"Id3d12graphicscommandlist clearrendertargetview","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_clearrendertargetview"},{"title":"Id3d12graphicscommandlist closebundlex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_closebundlex"},{"title":"Id3d12graphicscommandlist copymemorytomemoryx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_copymemorytomemoryx"},{"title":"Id3d12graphicscommandlist copyresourcex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_copyresourcex"},{"title":"Id3d12graphicscommandlist copytextureregionx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_copytextureregionx"},{"title":"Id3d12graphicscommandlist dispatchx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_dispatchx"},{"title":"Id3d12graphicscommandlist drawindexedx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_drawindexedx"},{"title":"Id3d12graphicscommandlist executecommandlistsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_executecommandlistsx"},{"title":"Id3d12graphicscommandlist executeindirectbundlex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_executeindirectbundlex"},{"title":"Id3d12graphicscommandlist fillmemorywith128bitvaluex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_fillmemorywith128bitvaluex"},{"title":"Id3d12graphicscommandlist fillmemorywith32bitvaluex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_fillmemorywith32bitvaluex"},{"title":"Id3d12graphicscommandlist fillmemorywith64bitvaluex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_fillmemorywith64bitvaluex"},{"title":"Id3d12graphicscommandlist flushpipelinex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_flushpipelinex"},{"title":"Id3d12graphicscommandlist getexecutioncommandsizex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_getexecutioncommandsizex"},{"title":"Id3d12graphicscommandlist kickoffx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_kickoffx"},{"title":"Id3d12graphicscommandlist nopx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_nopx"},{"title":"Id3d12graphicscommandlist omsetdepthboundsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_omsetdepthboundsx"},{"title":"Id3d12graphicscommandlist prefetchmemoryx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_prefetchmemoryx"},{"title":"Id3d12graphicscommandlist prefetchpipelinestatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_prefetchpipelinestatex"},{"title":"Id3d12graphicscommandlist readgdsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_readgdsx"},{"title":"Id3d12graphicscommandlist rssetdepthbiasx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_rssetdepthbiasx"},{"title":"Id3d12graphicscommandlist rssetmsaaparametersx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_rssetmsaaparametersx"},{"title":"Id3d12graphicscommandlist samplecountersx","href":"/reference/graphics/d3d12_x/interfaces/ID3D12GraphicsCommandList/methods/id3d12graphicscommandlist_samplecountersx"},{"title":"Id3d12graphicscommandlist setcomputeshaderlimitsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setcomputeshaderlimitsx"},{"title":"Id3d12graphicscommandlist setgraphicsshaderlimitsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setgraphicsshaderlimitsx"},{"title":"Id3d12graphicscommandlist sethistencilcontrolx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_sethistencilcontrolx"},{"title":"Id3d12graphicscommandlist sethistencilstatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_sethistencilstatex"},{"title":"Id3d12graphicscommandlist setocclusionquerycontrolx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setocclusionquerycontrolx"},{"title":"Id3d12graphicscommandlist setperfectocclusionqueriesx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setperfectocclusionqueriesx"},{"title":"Id3d12graphicscommandlist setpixelshaderdepthforcezorderx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setpixelshaderdepthforcezorderx"},{"title":"Id3d12graphicscommandlist setpredicationbufferx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setpredicationbufferx"},{"title":"Id3d12graphicscommandlist setresourcecompressionstatex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setresourcecompressionstatex"},{"title":"Id3d12graphicscommandlist setuporderedappendcounterx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_setuporderedappendcounterx"},{"title":"Id3d12graphicscommandlist startcountersx","href":"/reference/graphics/d3d12_x/interfaces/ID3D12GraphicsCommandList/methods/id3d12graphicscommandlist_startcountersx"},{"title":"Id3d12graphicscommandlist stopcountersx","href":"/reference/graphics/d3d12_x/interfaces/ID3D12GraphicsCommandList/methods/id3d12graphicscommandlist_stopcountersx"},{"title":"Id3d12graphicscommandlist wait32bitvaluex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_wait32bitvaluex"},{"title":"Id3d12graphicscommandlist wait64bitvaluex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_wait64bitvaluex"},{"title":"Id3d12graphicscommandlist write32bitvaluebottomofpipex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_write32bitvaluebottomofpipex"},{"title":"Id3d12graphicscommandlist write32bitvaluebottomofshaderx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_write32bitvaluebottomofshaderx"},{"title":"Id3d12graphicscommandlist write32bitvaluetopofpipex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_write32bitvaluetopofpipex"},{"title":"Id3d12graphicscommandlist write64bitvaluebottomofpipex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_write64bitvaluebottomofpipex"},{"title":"Id3d12graphicscommandlist write64bitvaluetopofpipex","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_write64bitvaluetopofpipex"},{"title":"Id3d12graphicscommandlist writegdsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_writegdsx"}]}]},{"group":"ID3D12GraphicsCommandList2","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12graphicscommandlist2","href":"/reference/graphics/d3d12_x/interfaces/ID3D12GraphicsCommandList2/id3d12graphicscommandlist2"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12graphicscommandlist2 resetx","href":"/reference/graphics/d3d12_x/interfaces/ID3D12GraphicsCommandList2/methods/id3d12graphicscommandlist2_resetx"}]}]},{"group":"ID3D12PipelineState","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12pipelinestate","href":"/reference/graphics/d3d12_x/interfaces/id3d12pipelinestate/id3d12pipelinestate"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12pipelinestate getdescriptorx","href":"/reference/graphics/d3d12_x/interfaces/id3d12pipelinestate/methods/id3d12pipelinestate_getdescriptorx"}]}]},{"group":"ID3D12Resource","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12resource","href":"/reference/graphics/d3d12_x/interfaces/id3d12resource/id3d12resource"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12resource getplacementdescx","href":"/reference/graphics/d3d12_x/interfaces/id3d12resource/methods/id3d12resource_getplacementdescx"}]}]},{"group":"ID3D12XboxCounterSet","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12xboxcounterset","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxcounterset/id3d12xboxcounterset"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12xboxcounterset getcounterdatasizex","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxcounterset/methods/id3d12xboxcounterset_getcounterdatasizex"},{"title":"Id3d12xboxcounterset retrievecounterdatax","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxcounterset/methods/id3d12xboxcounterset_retrievecounterdatax"}]}]},{"group":"ID3D12XboxDmaCommandList","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12xboxdmacommandlist","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/id3d12xboxdmacommandlist"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3d12xboxdmacommandlist beginevent","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_beginevent"},{"title":"Id3d12xboxdmacommandlist beginquery","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_beginquery"},{"title":"Id3d12xboxdmacommandlist close","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_close"},{"title":"Id3d12xboxdmacommandlist copybufferregion","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_copybufferregion"},{"title":"Id3d12xboxdmacommandlist copylasterrorcodetomemoryx","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_copylasterrorcodetomemoryx"},{"title":"Id3d12xboxdmacommandlist copymemorytomemoryx","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_copymemorytomemoryx"},{"title":"Id3d12xboxdmacommandlist copyresource","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_copyresource"},{"title":"Id3d12xboxdmacommandlist copytextureregion","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_copytextureregion"},{"title":"Id3d12xboxdmacommandlist copytiles","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_copytiles"},{"title":"Id3d12xboxdmacommandlist endevent","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_endevent"},{"title":"Id3d12xboxdmacommandlist endquery","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_endquery"},{"title":"Id3d12xboxdmacommandlist enqueuedwordsx","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_enqueuedwordsx"},{"title":"Id3d12xboxdmacommandlist fillmemorywith32bitvaluex","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_fillmemorywith32bitvaluex"},{"title":"Id3d12xboxdmacommandlist jpegdecodememoryx","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_jpegdecodememoryx"},{"title":"Id3d12xboxdmacommandlist kickoffx","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_kickoffx"},{"title":"Id3d12xboxdmacommandlist lzcompressmemoryx","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_lzcompressmemoryx"},{"title":"Id3d12xboxdmacommandlist lzdecompressmemoryx","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_lzdecompressmemoryx"},{"title":"Id3d12xboxdmacommandlist reset","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_reset"},{"title":"Id3d12xboxdmacommandlist resolvequerydata","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_resolvequerydata"},{"title":"Id3d12xboxdmacommandlist resourcebarrier","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_resourcebarrier"},{"title":"Id3d12xboxdmacommandlist setmarker","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_setmarker"},{"title":"Id3d12xboxdmacommandlist wait64bitvaluex","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_wait64bitvaluex"},{"title":"Id3d12xboxdmacommandlist write64bitvaluebottomofpipex","href":"/reference/graphics/d3d12_x/interfaces/id3d12xboxdmacommandlist/methods/id3d12xboxdmacommandlist_write64bitvaluebottomofpipex"}]}]},{"group":"ID3DX12PipelineParserCallbacks","hidden":true,"tag":"NDA","pages":[{"title":"Id3dx12pipelineparsercallbacks","href":"/reference/graphics/d3d12_x/interfaces/id3dx12pipelineparsercallbacks/id3dx12pipelineparsercallbacks"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Id3dx12pipelineparsercallbacks xboxsetcomputeshaderlimits","href":"/reference/graphics/d3d12_x/interfaces/id3dx12pipelineparsercallbacks/methods/id3dx12pipelineparsercallbacks_xboxsetcomputeshaderlimits"},{"title":"Id3dx12pipelineparsercallbacks xboxsetdepthstenciloptions","href":"/reference/graphics/d3d12_x/interfaces/id3dx12pipelineparsercallbacks/methods/id3dx12pipelineparsercallbacks_xboxsetdepthstenciloptions"},{"title":"Id3dx12pipelineparsercallbacks xboxsetgraphicsshaderlimits","href":"/reference/graphics/d3d12_x/interfaces/id3dx12pipelineparsercallbacks/methods/id3dx12pipelineparsercallbacks_xboxsetgraphicsshaderlimits"},{"title":"Id3dx12pipelineparsercallbacks xboxsetpixelshaderoptions","href":"/reference/graphics/d3d12_x/interfaces/id3dx12pipelineparsercallbacks/methods/id3dx12pipelineparsercallbacks_xboxsetpixelshaderoptions"},{"title":"Id3dx12pipelineparsercallbacks xboxsettessellationparameters","href":"/reference/graphics/d3d12_x/interfaces/id3dx12pipelineparsercallbacks/methods/id3dx12pipelineparsercallbacks_xboxsettessellationparameters"}]}]}]},{"group":"Functions","icon":"function","hidden":true,"tag":"NDA","pages":[{"title":"D3d12createdevice","href":"/reference/graphics/d3d12_x/functions/d3d12createdevice"},{"title":"D3d12getflushfromresourcebarrieractionsx","href":"/reference/graphics/d3d12_x/functions/d3d12getflushfromresourcebarrieractionsx"},{"title":"D3d12xboxcreatedevice","href":"/reference/graphics/d3d12_x/functions/d3d12xboxcreatedevice"},{"title":"D3d12xboxenablememoryprofiling","href":"/reference/graphics/d3d12_x/functions/d3d12xboxenablememoryprofiling"},{"title":"D3d12xboxgetcachedreadpointer","href":"/reference/graphics/d3d12_x/functions/d3d12xboxgetcachedreadpointer"},{"title":"D3d12xboxgetprocessdebugflags","href":"/reference/graphics/d3d12_x/functions/d3d12xboxgetprocessdebugflags"},{"title":"D3d12xboxgetwritepointer","href":"/reference/graphics/d3d12_x/functions/d3d12xboxgetwritepointer"},{"title":"D3d12xboxinitializedefaultcomputeshaderlimits","href":"/reference/graphics/d3d12_x/functions/d3d12xboxinitializedefaultcomputeshaderlimits"},{"title":"D3d12xboxinitializedefaultgraphicsshaderlimits","href":"/reference/graphics/d3d12_x/functions/d3d12xboxinitializedefaultgraphicsshaderlimits"},{"title":"D3d12xboxinitializedefaulttessellationparameters","href":"/reference/graphics/d3d12_x/functions/d3d12xboxinitializedefaulttessellationparameters"},{"title":"D3d12xboxsetprocessdebugflags","href":"/reference/graphics/d3d12_x/functions/d3d12xboxsetprocessdebugflags"},{"title":"D3d12xboxunloaddrivermodule","href":"/reference/graphics/d3d12_x/functions/d3d12xboxunloaddrivermodule"},{"title":"D3dconfigurevirtualmemory","href":"/reference/graphics/d3d12_x/functions/d3dconfigurevirtualmemory"}]},{"group":"Structures","icon":"sitemap","hidden":true,"tag":"NDA","pages":[{"title":"Cd3dx12xbox pipeline state stream","href":"/reference/graphics/d3d12_x/structs/cd3dx12xbox_pipeline_state_stream"},{"title":"D3d12 feature data d3d12 options10","href":"/reference/graphics/d3d12_x/structs/d3d12_feature_data_d3d12_options10"},{"title":"D3d12 feature data d3d12 options11","href":"/reference/graphics/d3d12_x/structs/d3d12_feature_data_d3d12_options11"},{"title":"D3d12 feature data d3d12 options7","href":"/reference/graphics/d3d12_x/structs/d3d12_feature_data_d3d12_options7"},{"title":"D3d12 feature data d3d12 options8","href":"/reference/graphics/d3d12_x/structs/d3d12_feature_data_d3d12_options8"},{"title":"D3d12 feature data d3d12 options9","href":"/reference/graphics/d3d12_x/structs/d3d12_feature_data_d3d12_options9"},{"title":"D3d12 feature data displayable","href":"/reference/graphics/d3d12_x/structs/d3d12_feature_data_displayable"},{"title":"D3d12 feature data protected resource session support","href":"/reference/graphics/d3d12_x/structs/d3d12_feature_data_protected_resource_session_support"},{"title":"D3d12 feature data protected resource session type count","href":"/reference/graphics/d3d12_x/structs/d3d12_feature_data_protected_resource_session_type_count"},{"title":"D3d12 feature data protected resource session types","href":"/reference/graphics/d3d12_x/structs/d3d12_feature_data_protected_resource_session_types"},{"title":"D3d12 graphics pipeline state desc","href":"/reference/graphics/d3d12_x/structs/d3d12_graphics_pipeline_state_desc"},{"title":"D3d12 indirect argument desc","href":"/reference/graphics/d3d12_x/structs/d3d12_indirect_argument_desc"},{"title":"D3d12xbox command list desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_command_list_desc"},{"title":"D3d12xbox command queue desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_command_queue_desc"},{"title":"D3d12xbox component placed addresses","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_component_placed_addresses"},{"title":"D3d12xbox compute shader limits desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_compute_shader_limits_desc"},{"title":"D3d12xbox counter data","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_counter_data"},{"title":"D3d12xbox counter set desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_counter_set_desc"},{"title":"D3d12xbox create device parameters","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_create_device_parameters"},{"title":"D3d12xbox dcc options","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_dcc_options"},{"title":"D3d12xbox depth stencil options desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_depth_stencil_options_desc"},{"title":"D3d12xbox derived compute state desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_derived_compute_state_desc"},{"title":"D3d12xbox derived graphics state desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_derived_graphics_state_desc"},{"title":"D3d12xbox descriptor buffer view","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_descriptor_buffer_view"},{"title":"D3d12xbox descriptor pipeline state","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_descriptor_pipeline_state"},{"title":"D3d12xbox descriptor sampler state","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_descriptor_sampler_state"},{"title":"D3d12xbox descriptor texture view","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_descriptor_texture_view"},{"title":"D3d12xbox descriptor unordered access view","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_descriptor_unordered_access_view"},{"title":"D3d12xbox deserialize compute pipeline state","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_deserialize_compute_pipeline_state"},{"title":"D3d12xbox deserialize graphics pipeline state","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_deserialize_graphics_pipeline_state"},{"title":"D3d12xbox deserialize shader","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_deserialize_shader"},{"title":"D3d12xbox dispatch arguments","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_dispatch_arguments"},{"title":"D3d12xbox display statistics","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_display_statistics"},{"title":"D3d12xbox extended compute pipeline state desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_extended_compute_pipeline_state_desc"},{"title":"D3d12xbox extended graphics pipeline state desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_extended_graphics_pipeline_state_desc"},{"title":"D3d12xbox frame event statistics","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_frame_event_statistics"},{"title":"D3d12xbox frame interval statistics","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_frame_interval_statistics"},{"title":"D3d12xbox frame statistics","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_frame_statistics"},{"title":"D3d12xbox gpu hardware configuration","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_gpu_hardware_configuration"},{"title":"D3d12xbox graphics shader limits desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_graphics_shader_limits_desc"},{"title":"D3d12xbox histencil compare state","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_histencil_compare_state"},{"title":"D3d12xbox histencil control","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_histencil_control"},{"title":"D3d12xbox input statistics","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_input_statistics"},{"title":"D3d12xbox msaa centroid priorities","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_msaa_centroid_priorities"},{"title":"D3d12xbox msaa parameters","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_msaa_parameters"},{"title":"D3d12xbox msaa sample locations","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_msaa_sample_locations"},{"title":"D3d12xbox occlusion query control","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_occlusion_query_control"},{"title":"D3d12xbox page mapping batch","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_page_mapping_batch"},{"title":"D3d12xbox page mapping range","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_page_mapping_range"},{"title":"D3d12xbox pixel shader options desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_pixel_shader_options_desc"},{"title":"D3d12xbox predication buffer view","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_predication_buffer_view"},{"title":"D3d12xbox present desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_present_desc"},{"title":"D3d12xbox present desc title performance overlay","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_present_desc_title_performance_overlay"},{"title":"D3d12xbox present parameters","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_present_parameters"},{"title":"D3d12xbox present plane desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_present_plane_desc"},{"title":"D3d12xbox present plane parameters","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_present_plane_parameters"},{"title":"D3d12xbox present statistics","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_present_statistics"},{"title":"D3d12xbox query predication status","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_query_predication_status"},{"title":"D3d12xbox render statistics","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_render_statistics"},{"title":"D3d12xbox resource desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_resource_desc"},{"title":"D3d12xbox sampler desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_sampler_desc"},{"title":"D3d12xbox schedule frame object list","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_schedule_frame_object_list"},{"title":"D3d12xbox serialize compute pipeline state","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_serialize_compute_pipeline_state"},{"title":"D3d12xbox serialize graphics pipeline state","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_serialize_graphics_pipeline_state"},{"title":"D3d12xbox serialize shader","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_serialize_shader"},{"title":"D3d12xbox shader resource view desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_shader_resource_view_desc"},{"title":"D3d12xbox tessellation parameters desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_tessellation_parameters_desc"},{"title":"D3d12xbox unordered access view desc","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_unordered_access_view_desc"},{"title":"D3d12xbox view rect","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_view_rect"},{"title":"D3d12xbox wait frame object list","href":"/reference/graphics/d3d12_x/structs/d3d12xbox_wait_frame_object_list"},{"title":"D3d12xboxputbuffer","href":"/reference/graphics/d3d12_x/structs/d3d12xboxputbuffer"}]},{"group":"Enumerations","icon":"list","hidden":true,"tag":"NDA","pages":[{"title":"D3d12 buffer srv flags","href":"/reference/graphics/d3d12_x/enums/d3d12_buffer_srv_flags"},{"title":"D3d12 buffer uav flags","href":"/reference/graphics/d3d12_x/enums/d3d12_buffer_uav_flags"},{"title":"D3d12 command list type","href":"/reference/graphics/d3d12_x/enums/d3d12_command_list_type"},{"title":"D3d12 command queue flags","href":"/reference/graphics/d3d12_x/enums/d3d12_command_queue_flags"},{"title":"D3d12 descriptor heap flags","href":"/reference/graphics/d3d12_x/enums/d3d12_descriptor_heap_flags"},{"title":"D3d12 heap flags","href":"/reference/graphics/d3d12_x/enums/d3d12_heap_flags"},{"title":"D3d12 index buffer strip cut value","href":"/reference/graphics/d3d12_x/enums/d3d12_index_buffer_strip_cut_value"},{"title":"D3d12 indirect argument type","href":"/reference/graphics/d3d12_x/enums/d3d12_indirect_argument_type"},{"title":"D3d12 mesh shader tier","href":"/reference/graphics/d3d12_x/enums/d3d12_mesh_shader_tier"},{"title":"D3d12 pipeline state flags","href":"/reference/graphics/d3d12_x/enums/d3d12_pipeline_state_flags"},{"title":"D3d12 pipeline state subobject type","href":"/reference/graphics/d3d12_x/enums/d3d12_pipeline_state_subobject_type"},{"title":"D3d12 primitive topology type","href":"/reference/graphics/d3d12_x/enums/d3d12_primitive_topology_type"},{"title":"D3d12 query heap type","href":"/reference/graphics/d3d12_x/enums/d3d12_query_heap_type"},{"title":"D3d12 query type","href":"/reference/graphics/d3d12_x/enums/d3d12_query_type"},{"title":"D3d12 resource barrier flags","href":"/reference/graphics/d3d12_x/enums/d3d12_resource_barrier_flags"},{"title":"D3d12 resource dimension","href":"/reference/graphics/d3d12_x/enums/d3d12_resource_dimension"},{"title":"D3d12 resource flags","href":"/reference/graphics/d3d12_x/enums/d3d12_resource_flags"},{"title":"D3d12 resource states","href":"/reference/graphics/d3d12_x/enums/d3d12_resource_states"},{"title":"D3d12 root signature flags","href":"/reference/graphics/d3d12_x/enums/d3d12_root_signature_flags"},{"title":"D3d12 sampler feedback tier","href":"/reference/graphics/d3d12_x/enums/d3d12_sampler_feedback_tier"},{"title":"D3d12 shared resource compatibility tier","href":"/reference/graphics/d3d12_x/enums/d3d12_shared_resource_compatibility_tier"},{"title":"D3d12 srv dimension","href":"/reference/graphics/d3d12_x/enums/d3d12_srv_dimension"},{"title":"D3d12 stencil op","href":"/reference/graphics/d3d12_x/enums/d3d12_stencil_op"},{"title":"D3d12 texture address mode","href":"/reference/graphics/d3d12_x/enums/d3d12_texture_address_mode"},{"title":"D3d12 texture layout","href":"/reference/graphics/d3d12_x/enums/d3d12_texture_layout"},{"title":"D3d12 wave mma tier","href":"/reference/graphics/d3d12_x/enums/d3d12_wave_mma_tier"},{"title":"D3d12xbox command allocator callback flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_command_allocator_callback_flags"},{"title":"D3d12xbox command list flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_command_list_flags"},{"title":"D3d12xbox command list reset flags x","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_command_list_reset_flags_x"},{"title":"D3d12xbox command queue priority","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_command_queue_priority"},{"title":"D3d12xbox compression state flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_compression_state_flags"},{"title":"D3d12xbox copy flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_copy_flags"},{"title":"D3d12xbox create device flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_create_device_flags"},{"title":"D3d12xbox data format","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_data_format"},{"title":"D3d12xbox dcc color transform","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_dcc_color_transform"},{"title":"D3d12xbox dcc compression level","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_dcc_compression_level"},{"title":"D3d12xbox debug filter flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_debug_filter_flags"},{"title":"D3d12xbox debug flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_debug_flags"},{"title":"D3d12xbox derived compute state type","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_derived_compute_state_type"},{"title":"D3d12xbox derived graphics state type","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_derived_graphics_state_type"},{"title":"D3d12xbox dispatch flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_dispatch_flags"},{"title":"D3d12xbox execute command list flags x","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_execute_command_list_flags_x"},{"title":"D3d12xbox extended compute pipeline state type","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_extended_compute_pipeline_state_type"},{"title":"D3d12xbox extended graphics pipeline state type","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_extended_graphics_pipeline_state_type"},{"title":"D3d12xbox flush","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_flush"},{"title":"D3d12xbox frame event statistics flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_frame_event_statistics_flags"},{"title":"D3d12xbox frame event type","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_frame_event_type"},{"title":"D3d12xbox frame interval flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_frame_interval_flags"},{"title":"D3d12xbox frame pipeline token","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_frame_pipeline_token"},{"title":"D3d12xbox frame statistics type","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_frame_statistics_type"},{"title":"D3d12xbox gds operation","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_gds_operation"},{"title":"D3d12xbox hardware version","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_hardware_version"},{"title":"D3d12xbox histencil compare function","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_histencil_compare_function"},{"title":"D3d12xbox number format","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_number_format"},{"title":"D3d12xbox occlusion query control count flag","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_occlusion_query_control_count_flag"},{"title":"D3d12xbox ordered append shader stage","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_ordered_append_shader_stage"},{"title":"D3d12xbox page mapping flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_page_mapping_flags"},{"title":"D3d12xbox page mapping range type","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_page_mapping_range_type"},{"title":"D3d12xbox pix capture flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_pix_capture_flags"},{"title":"D3d12xbox pixel shader option conservative z export","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_pixel_shader_option_conservative_z_export"},{"title":"D3d12xbox pixel shader option depth before shader","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_pixel_shader_option_depth_before_shader"},{"title":"D3d12xbox pixel shader option exec on hier fail","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_pixel_shader_option_exec_on_hier_fail"},{"title":"D3d12xbox pixel shader option exec on noop","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_pixel_shader_option_exec_on_noop"},{"title":"D3d12xbox pixel shader option out of order rasterization","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_pixel_shader_option_out_of_order_rasterization"},{"title":"D3d12xbox pixel shader option per sample iteration","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_pixel_shader_option_per_sample_iteration"},{"title":"D3d12xbox pixel shader option texkill","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_pixel_shader_option_texkill"},{"title":"D3d12xbox pixel shader option zorder","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_pixel_shader_option_zorder"},{"title":"D3d12xbox prefetch memory flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_prefetch_memory_flags"},{"title":"D3d12xbox prefetch pipeline state flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_prefetch_pipeline_state_flags"},{"title":"D3d12xbox present desc type","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_present_desc_type"},{"title":"D3d12xbox present flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_present_flags"},{"title":"D3d12xbox present plane desc type","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_present_plane_desc_type"},{"title":"D3d12xbox present plane flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_present_plane_flags"},{"title":"D3d12xbox present plane scale filter","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_present_plane_scale_filter"},{"title":"D3d12xbox process debug flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_process_debug_flags"},{"title":"D3d12xbox register page pool flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_register_page_pool_flags"},{"title":"D3d12xbox report gpu hang flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_report_gpu_hang_flags"},{"title":"D3d12xbox resource barrier actions","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_resource_barrier_actions"},{"title":"D3d12xbox sampler flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_sampler_flags"},{"title":"D3d12xbox schedule frame event flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_schedule_frame_event_flags"},{"title":"D3d12xbox serialize flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_serialize_flags"},{"title":"D3d12xbox shader cs simd walk algorithm","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_shader_cs_simd_walk_algorithm"},{"title":"D3d12xbox shader stage","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_shader_stage"},{"title":"D3d12xbox shader unit disable flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_shader_unit_disable_flags"},{"title":"D3d12xbox texture filter mode","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_texture_filter_mode"},{"title":"D3d12xbox texture mip filter","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_texture_mip_filter"},{"title":"D3d12xbox texture xy filter","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_texture_xy_filter"},{"title":"D3d12xbox texture z filter","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_texture_z_filter"},{"title":"D3d12xbox wait flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_wait_flags"},{"title":"D3d12xbox wait frame event flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_wait_frame_event_flags"},{"title":"D3d12xbox write value bop flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_write_value_bop_flags"},{"title":"D3d12xbox write value top flags","href":"/reference/graphics/d3d12_x/enums/d3d12xbox_write_value_top_flags"}]}]},{"group":"d3d12shader_x","icon":"code","hidden":true,"tag":"NDA","pages":[{"title":"D3d12shader x members","href":"/reference/graphics/d3d12shader_x/d3d12shader_x_members"},{"group":"Enumerations","icon":"list","hidden":true,"tag":"NDA","pages":[{"title":"D3d interpolation mode","href":"/reference/graphics/d3d12shader_x/enums/d3d_interpolation_mode"},{"title":"D3d parameter flags","href":"/reference/graphics/d3d12shader_x/enums/d3d_parameter_flags"}]}]},{"group":"d3d12video_x","icon":"video","hidden":true,"tag":"NDA","pages":[{"title":"D3d12video x members","href":"/reference/graphics/d3d12video_x/d3d12video_x_members"},{"group":"Enumerations","icon":"list","hidden":true,"tag":"NDA","pages":[{"title":"D3d12 feature video","href":"/reference/graphics/d3d12video_x/enums/d3d12_feature_video"},{"title":"D3d12 video field type","href":"/reference/graphics/d3d12video_x/enums/d3d12_video_field_type"},{"title":"D3d12 video frame format","href":"/reference/graphics/d3d12video_x/enums/d3d12_video_frame_format"},{"title":"D3d12 video process auto processing flags","href":"/reference/graphics/d3d12video_x/enums/d3d12_video_process_auto_processing_flags"},{"title":"D3d12 video process feature flags","href":"/reference/graphics/d3d12video_x/enums/d3d12_video_process_feature_flags"},{"title":"D3d12 video process filter flags","href":"/reference/graphics/d3d12video_x/enums/d3d12_video_process_filter_flags"},{"title":"D3d12 video process input stream flags","href":"/reference/graphics/d3d12video_x/enums/d3d12_video_process_input_stream_flags"},{"title":"D3d12 video process orientation","href":"/reference/graphics/d3d12video_x/enums/d3d12_video_process_orientation"},{"title":"D3d12 video process support flags","href":"/reference/graphics/d3d12video_x/enums/d3d12_video_process_support_flags"},{"title":"D3d12 video usage","href":"/reference/graphics/d3d12video_x/enums/d3d12_video_usage"}]},{"group":"Structures","icon":"sitemap","hidden":true,"tag":"NDA","pages":[{"title":"D3d12 feature data video decode bitstream encryption schemes","href":"/reference/graphics/d3d12video_x/structs/d3d12_feature_data_video_decode_bitstream_encryption_schemes"},{"title":"D3d12 feature data video process support","href":"/reference/graphics/d3d12video_x/structs/d3d12_feature_data_video_process_support"},{"title":"D3d12 video decode frame argument","href":"/reference/graphics/d3d12video_x/structs/d3d12_video_decode_frame_argument"},{"title":"D3d12 video decode input stream arguments","href":"/reference/graphics/d3d12video_x/structs/d3d12_video_decode_input_stream_arguments"},{"title":"D3d12 video decode reference frames","href":"/reference/graphics/d3d12video_x/structs/d3d12_video_decode_reference_frames"},{"title":"D3d12 video process input stream arguments","href":"/reference/graphics/d3d12video_x/structs/d3d12_video_process_input_stream_arguments"},{"title":"D3d12 video process output stream arguments","href":"/reference/graphics/d3d12video_x/structs/d3d12_video_process_output_stream_arguments"},{"title":"D3d12 video processor desc","href":"/reference/graphics/d3d12video_x/structs/d3d12_video_processor_desc"}]}]},{"group":"d3dx12_x","icon":"cubes","hidden":true,"tag":"NDA","pages":[{"title":"D3dx12 x members","href":"/reference/graphics/d3dx12_x/d3dx12_x_members"},{"group":"Structures","icon":"sitemap","hidden":true,"tag":"NDA","pages":[{"title":"Cd3d12xbox compute shader limits desc","href":"/reference/graphics/d3dx12_x/structs/cd3d12xbox_compute_shader_limits_desc"},{"title":"Cd3d12xbox depth stencil options desc","href":"/reference/graphics/d3dx12_x/structs/cd3d12xbox_depth_stencil_options_desc"},{"title":"Cd3d12xbox graphics shader limits desc","href":"/reference/graphics/d3dx12_x/structs/cd3d12xbox_graphics_shader_limits_desc"},{"title":"Cd3d12xbox pixel shader options desc","href":"/reference/graphics/d3dx12_x/structs/cd3d12xbox_pixel_shader_options_desc"},{"title":"Cd3d12xbox tessellation parameters desc","href":"/reference/graphics/d3dx12_x/structs/cd3d12xbox_tessellation_parameters_desc"},{"title":"Cd3dx12 cpu descriptor handle","href":"/reference/graphics/d3dx12_x/structs/cd3dx12_cpu_descriptor_handle"}]}]},{"group":"d3dx12_xs","icon":"cubes","hidden":true,"tag":"NDA","pages":[{"title":"D3dx12 xs members","href":"/reference/graphics/d3dx12_xs/d3dx12_xs_members"},{"group":"Interfaces","icon":"plug","hidden":true,"tag":"NDA","pages":[{"group":"CD3D12XBOX_RAYTRACING_OPTIONS_SUBOBJECT","hidden":true,"tag":"NDA","pages":[{"title":"Cd3d12xbox raytracing options subobject","href":"/reference/graphics/d3dx12_xs/interfaces/CD3D12XBOX_RAYTRACING_OPTIONS_SUBOBJECT/cd3d12xbox_raytracing_options_subobject"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Cd3d12xbox raytracing options subobject cd3d12xbox raytracing options subobject","href":"/reference/graphics/d3dx12_xs/interfaces/CD3D12XBOX_RAYTRACING_OPTIONS_SUBOBJECT/methods/cd3d12xbox_raytracing_options_subobject_cd3d12xbox_raytracing_options_subobject"},{"title":"Cd3d12xbox raytracing options subobject cd3d12xbox raytracing options subobject 2","href":"/reference/graphics/d3dx12_xs/interfaces/CD3D12XBOX_RAYTRACING_OPTIONS_SUBOBJECT/methods/cd3d12xbox_raytracing_options_subobject_cd3d12xbox_raytracing_options_subobject_2"},{"title":"Cd3d12xbox raytracing options subobject type","href":"/reference/graphics/d3dx12_xs/interfaces/CD3D12XBOX_RAYTRACING_OPTIONS_SUBOBJECT/methods/cd3d12xbox_raytracing_options_subobject_type"}]}]},{"group":"CD3DX12_PIPELINE_STATE_STREAM_SUBOBJECT","hidden":true,"tag":"NDA","pages":[{"title":"Cd3dx12 pipeline state stream subobject xs","href":"/reference/graphics/d3dx12_xs/interfaces/CD3DX12_PIPELINE_STATE_STREAM_SUBOBJECT/cd3dx12_pipeline_state_stream_subobject_xs"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Cd3dx12 pipeline state stream subobject getx","href":"/reference/graphics/d3dx12_xs/interfaces/CD3DX12_PIPELINE_STATE_STREAM_SUBOBJECT/methods/cd3dx12_pipeline_state_stream_subobject_getx"},{"title":"Cd3dx12 pipeline state stream subobject getx 2","href":"/reference/graphics/d3dx12_xs/interfaces/CD3DX12_PIPELINE_STATE_STREAM_SUBOBJECT/methods/cd3dx12_pipeline_state_stream_subobject_getx_2"}]}]}]}]},{"group":"XG reference","icon":"microchip","hidden":true,"tag":"NDA","pages":[{"title":"Xg members","href":"/reference/graphics/xg__NR/xg_members"},{"group":"Interfaces","icon":"plug","hidden":true,"tag":"NDA","pages":[{"group":"XGTextureAddressComputer","hidden":true,"tag":"NDA","pages":[{"title":"Xgtextureaddresscomputer","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/xgtextureaddresscomputer"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xgtextureaddresscomputer addref","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_addref"},{"title":"Xgtextureaddresscomputer copyfromsubresource","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_copyfromsubresource"},{"title":"Xgtextureaddresscomputer copyintosubresource","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_copyintosubresource"},{"title":"Xgtextureaddresscomputer getmipleveloffsetbytes","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_getmipleveloffsetbytes"},{"title":"Xgtextureaddresscomputer getresourcebasealignmentbytes","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_getresourcebasealignmentbytes"},{"title":"Xgtextureaddresscomputer getresourcelayout","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_getresourcelayout"},{"title":"Xgtextureaddresscomputer getresourcesizebytes","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_getresourcesizebytes"},{"title":"Xgtextureaddresscomputer getresourcesizepages","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_getresourcesizepages"},{"title":"Xgtextureaddresscomputer getresourcetiling","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_getresourcetiling"},{"title":"Xgtextureaddresscomputer gettexelcoordinate","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_gettexelcoordinate"},{"title":"Xgtextureaddresscomputer gettexelelementoffsetbytes","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_gettexelelementoffsetbytes"},{"title":"Xgtextureaddresscomputer gettextureviewdescriptor","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_gettextureviewdescriptor"},{"title":"Xgtextureaddresscomputer release","href":"/reference/graphics/xg__NR/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_release"}]}]}]},{"group":"Functions","icon":"function","hidden":true,"tag":"NDA","pages":[{"title":"Xgcomputebankrotationaddress","href":"/reference/graphics/xg__NR/functions/xgcomputebankrotationaddress"},{"title":"Xgcomputebufferlayout","href":"/reference/graphics/xg__NR/functions/xgcomputebufferlayout"},{"title":"Xgcomputeoptimaldepthstenciltilemodes","href":"/reference/graphics/xg__NR/functions/xgcomputeoptimaldepthstenciltilemodes"},{"title":"Xgcomputeoptimaltilemode","href":"/reference/graphics/xg__NR/functions/xgcomputeoptimaltilemode"},{"title":"Xgcomputetexture1dlayout","href":"/reference/graphics/xg__NR/functions/xgcomputetexture1dlayout"},{"title":"Xgcomputetexture2dlayout","href":"/reference/graphics/xg__NR/functions/xgcomputetexture2dlayout"},{"title":"Xgcomputetexture3dlayout","href":"/reference/graphics/xg__NR/functions/xgcomputetexture3dlayout"},{"title":"Xgcomputetileshape","href":"/reference/graphics/xg__NR/functions/xgcomputetileshape"},{"title":"Xgcreatetexture1dcomputer","href":"/reference/graphics/xg__NR/functions/xgcreatetexture1dcomputer"},{"title":"Xgcreatetexture2dcomputer","href":"/reference/graphics/xg__NR/functions/xgcreatetexture2dcomputer"},{"title":"Xgcreatetexture3dcomputer","href":"/reference/graphics/xg__NR/functions/xgcreatetexture3dcomputer"},{"title":"Xgcreatetexturecomputer","href":"/reference/graphics/xg__NR/functions/xgcreatetexturecomputer"},{"title":"Xgcreatetexturecomputerfromdescriptor","href":"/reference/graphics/xg__NR/functions/xgcreatetexturecomputerfromdescriptor"},{"title":"Xgcreatetexturecomputerwithpitch","href":"/reference/graphics/xg__NR/functions/xgcreatetexturecomputerwithpitch"},{"title":"Xgdecodedcc","href":"/reference/graphics/xg__NR/functions/xgdecodedcc"},{"title":"Xgenableexclusivelocking","href":"/reference/graphics/xg__NR/functions/xgenableexclusivelocking"},{"title":"Xgencodedcc","href":"/reference/graphics/xg__NR/functions/xgencodedcc"},{"title":"Xgenterexclusivelock","href":"/reference/graphics/xg__NR/functions/xgenterexclusivelock"},{"title":"Xgleaveexclusivelock","href":"/reference/graphics/xg__NR/functions/xgleaveexclusivelock"},{"title":"Xgsethardwareversion","href":"/reference/graphics/xg__NR/functions/xgsethardwareversion"},{"title":"Xgvalidatedepthstenciltilemode","href":"/reference/graphics/xg__NR/functions/xgvalidatedepthstenciltilemode"},{"title":"Xgvalidatejpegfile","href":"/reference/graphics/xg__NR/functions/xgvalidatejpegfile"}]},{"group":"Structures","icon":"sitemap","hidden":true,"tag":"NDA","pages":[{"title":"Xg buffer desc","href":"/reference/graphics/xg__NR/structs/xg_buffer_desc"},{"title":"Xg dcc options","href":"/reference/graphics/xg__NR/structs/xg_dcc_options"},{"title":"Xg descriptor texture view","href":"/reference/graphics/xg__NR/structs/xg_descriptor_texture_view"},{"title":"Xg miplevel layout","href":"/reference/graphics/xg__NR/structs/xg_miplevel_layout"},{"title":"Xg packed mip desc","href":"/reference/graphics/xg__NR/structs/xg_packed_mip_desc"},{"title":"Xg plane layout","href":"/reference/graphics/xg__NR/structs/xg_plane_layout"},{"title":"Xg resource desc","href":"/reference/graphics/xg__NR/structs/xg_resource_desc"},{"title":"Xg resource layout","href":"/reference/graphics/xg__NR/structs/xg_resource_layout"},{"title":"Xg sample desc","href":"/reference/graphics/xg__NR/structs/xg_sample_desc"},{"title":"Xg subresource tiling","href":"/reference/graphics/xg__NR/structs/xg_subresource_tiling"},{"title":"Xg texture1d desc","href":"/reference/graphics/xg__NR/structs/xg_texture1d_desc"},{"title":"Xg texture2d desc","href":"/reference/graphics/xg__NR/structs/xg_texture2d_desc"},{"title":"Xg texture3d desc","href":"/reference/graphics/xg__NR/structs/xg_texture3d_desc"},{"title":"Xg tile shape","href":"/reference/graphics/xg__NR/structs/xg_tile_shape"},{"title":"Xg tile shape elements","href":"/reference/graphics/xg__NR/structs/xg_tile_shape_elements"},{"title":"Xg validated jpeg desc","href":"/reference/graphics/xg__NR/structs/xg_validated_jpeg_desc"}]},{"group":"Enumerations","icon":"list","hidden":true,"tag":"NDA","pages":[{"title":"Xg bind flag","href":"/reference/graphics/xg__NR/enums/xg_bind_flag"},{"title":"Xg cpu access flag","href":"/reference/graphics/xg__NR/enums/xg_cpu_access_flag"},{"title":"Xg dcc color transform","href":"/reference/graphics/xg__NR/enums/xg_dcc_color_transform"},{"title":"Xg dcc compression level","href":"/reference/graphics/xg__NR/enums/xg_dcc_compression_level"},{"title":"Xg format","href":"/reference/graphics/xg__NR/enums/xg_format"},{"title":"Xg hardware version","href":"/reference/graphics/xg__NR/enums/xg_hardware_version"},{"title":"Xg plane usage","href":"/reference/graphics/xg__NR/enums/xg_plane_usage"},{"title":"Xg resource dimension","href":"/reference/graphics/xg__NR/enums/xg_resource_dimension"},{"title":"Xg resource misc flag","href":"/reference/graphics/xg__NR/enums/xg_resource_misc_flag"},{"title":"Xg texture layout","href":"/reference/graphics/xg__NR/enums/xg_texture_layout"},{"title":"Xg tile mode","href":"/reference/graphics/xg__NR/enums/xg_tile_mode"},{"title":"Xg usage","href":"/reference/graphics/xg__NR/enums/xg_usage"},{"title":"Xg12 resource misc flag","href":"/reference/graphics/xg__NR/enums/xg12_resource_misc_flag"}]}]},{"group":"XGMemory reference","icon":"memory","hidden":true,"tag":"NDA","pages":[{"title":"Xgmemory members","href":"/reference/graphics/xgmemory_NR/xgmemory_members"},{"group":"Interfaces","icon":"plug","hidden":true,"tag":"NDA","pages":[{"group":"XGFreeList","hidden":true,"tag":"NDA","pages":[{"title":"Xgfreelist","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/xgfreelist"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xgfreelist xgfreelist","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/constructors/xgfreelist_xgfreelist"},{"title":"Xgfreelist allocatepage","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_allocatepage"},{"title":"Xgfreelist allocatepages","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_allocatepages"},{"title":"Xgfreelist freepage","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_freepage"},{"title":"Xgfreelist freepages","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_freepages"},{"title":"Xgfreelist getallocatedpagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_getallocatedpagecount"},{"title":"Xgfreelist getfreepagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_getfreepagecount"},{"title":"Xgfreelist gettotalpagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_gettotalpagecount"},{"title":"Xgfreelist initialize","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_initialize"},{"title":"Xgfreelist reset","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_reset"},{"title":"Xgfreelist terminate","href":"/reference/graphics/xgmemory_NR/interfaces/XGFreeList/methods/xgfreelist_terminate"}]}]},{"group":"XGMemoryLayout","hidden":true,"tag":"NDA","pages":[{"title":"Xgmemorylayout","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/xgmemorylayout"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xgmemorylayout copymapping","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_copymapping"},{"title":"Xgmemorylayout createmapping","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_createmapping"},{"title":"Xgmemorylayout ensuremappingsize","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_ensuremappingsize"},{"title":"Xgmemorylayout getbaseaddress","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getbaseaddress"},{"title":"Xgmemorylayout getcurrentaddress","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getcurrentaddress"},{"title":"Xgmemorylayout getcurrentpageoffset","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getcurrentpageoffset"},{"title":"Xgmemorylayout getesrampageranges","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getesrampageranges"},{"title":"Xgmemorylayout getfreeesrampagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getfreeesrampagecount"},{"title":"Xgmemorylayout getfreesystempagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getfreesystempagecount"},{"title":"Xgmemorylayout getgpubaseaddress","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getgpubaseaddress"},{"title":"Xgmemorylayout getgpucurrentaddress","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getgpucurrentaddress"},{"title":"Xgmemorylayout getmaxusedesrampagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getmaxusedesrampagecount"},{"title":"Xgmemorylayout getmaxusedsystempagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getmaxusedsystempagecount"},{"title":"Xgmemorylayout getpagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getpagecount"},{"title":"Xgmemorylayout getpagecountremaining","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getpagecountremaining"},{"title":"Xgmemorylayout getpagesizebytes","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_getpagesizebytes"},{"title":"Xgmemorylayout isvalid","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_isvalid"},{"title":"Xgmemorylayout mapfrompattern","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_mapfrompattern"},{"title":"Xgmemorylayout mappagepriorityarray","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_mappagepriorityarray"},{"title":"Xgmemorylayout maprunlengtharray","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_maprunlengtharray"},{"title":"Xgmemorylayout mapsimple","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_mapsimple"},{"title":"Xgmemorylayout relinquishmapping","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_relinquishmapping"},{"title":"Xgmemorylayout reset","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayout/methods/xgmemorylayout_reset"}]}]},{"group":"XGMemoryLayoutEngine","hidden":true,"tag":"NDA","pages":[{"title":"Xgmemorylayoutengine","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayoutEngine/xgmemorylayoutengine"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xgmemorylayoutengine xgmemorylayoutengine","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayoutEngine/constructors/xgmemorylayoutengine_xgmemorylayoutengine"},{"title":"Xgmemorylayoutengine creatememorylayout","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayoutEngine/methods/xgmemorylayoutengine_creatememorylayout"},{"title":"Xgmemorylayoutengine getesrampagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayoutEngine/methods/xgmemorylayoutengine_getesrampagecount"},{"title":"Xgmemorylayoutengine getesrampagenumber","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayoutEngine/methods/xgmemorylayoutengine_getesrampagenumber"},{"title":"Xgmemorylayoutengine getsystempagecount","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayoutEngine/methods/xgmemorylayoutengine_getsystempagecount"},{"title":"Xgmemorylayoutengine getsystempagenumber","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayoutEngine/methods/xgmemorylayoutengine_getsystempagenumber"},{"title":"Xgmemorylayoutengine initializewithpagearrays","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayoutEngine/methods/xgmemorylayoutengine_initializewithpagearrays"},{"title":"Xgmemorylayoutengine initializewithpagecounts","href":"/reference/graphics/xgmemory_NR/interfaces/XGMemoryLayoutEngine/methods/xgmemorylayoutengine_initializewithpagecounts"}]}]},{"group":"XGRefCount","hidden":true,"tag":"NDA","pages":[{"title":"Xgrefcount","href":"/reference/graphics/xgmemory_NR/interfaces/XGRefCount/xgrefcount"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xgrefcount xgrefcount","href":"/reference/graphics/xgmemory_NR/interfaces/XGRefCount/constructors/xgrefcount_xgrefcount"},{"title":"Xgrefcount addref","href":"/reference/graphics/xgmemory_NR/interfaces/XGRefCount/methods/xgrefcount_addref"},{"title":"Xgrefcount getprivatedata","href":"/reference/graphics/xgmemory_NR/interfaces/XGRefCount/methods/xgrefcount_getprivatedata"},{"title":"Xgrefcount release","href":"/reference/graphics/xgmemory_NR/interfaces/XGRefCount/methods/xgrefcount_release"},{"title":"Xgrefcount setprivatedata","href":"/reference/graphics/xgmemory_NR/interfaces/XGRefCount/methods/xgrefcount_setprivatedata"}]}]}]},{"group":"Structures","icon":"sitemap","hidden":true,"tag":"NDA","pages":[{"title":"Xgmemorylayoutmapping","href":"/reference/graphics/xgmemory_NR/structs/xgmemorylayoutmapping"},{"title":"Xgmemorypagerange","href":"/reference/graphics/xgmemory_NR/structs/xgmemorypagerange"}]},{"group":"Enumerations","icon":"list","hidden":true,"tag":"NDA","pages":[{"title":"Xg copy mapping flags","href":"/reference/graphics/xgmemory_NR/enums/xg_copy_mapping_flags"},{"title":"Xg layout pattern type","href":"/reference/graphics/xgmemory_NR/enums/xg_layout_pattern_type"},{"title":"Xg relinquish mapping flags","href":"/reference/graphics/xgmemory_NR/enums/xg_relinquish_mapping_flags"}]}]},{"group":"XBTC","icon":"layer-group","hidden":true,"tag":"NDA","pages":[{"title":"Xbtc members","href":"/reference/graphics/xbtc/xbtc_members"},{"group":"Interfaces","icon":"plug","hidden":true,"tag":"NDA","pages":[{"group":"XBTCArchive","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcarchive","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/xbtcarchive"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcarchive getbasetexturesize","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_getbasetexturesize"},{"title":"Xbtcarchive getresourcebasestreamindex","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_getresourcebasestreamindex"},{"title":"Xbtcarchive getresourcecompressedsize","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_getresourcecompressedsize"},{"title":"Xbtcarchive getresourcecount","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_getresourcecount"},{"title":"Xbtcarchive getresourcestreamcount","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_getresourcestreamcount"},{"title":"Xbtcarchive getresourcestreamdatastart","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_getresourcestreamdatastart"},{"title":"Xbtcarchive getstreamcount","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_getstreamcount"},{"title":"Xbtcarchive getstreaminfo","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_getstreaminfo"},{"title":"Xbtcarchive gettextureinfo","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_gettextureinfo"},{"title":"Xbtcarchive gettextureoffset","href":"/reference/graphics/xbtc/interfaces/XBTCArchive/methods/xbtcarchive_gettextureoffset"}]}]},{"group":"XBTCArchiveReader","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcarchivereader","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/xbtcarchivereader"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcarchivereader close","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_close"},{"title":"Xbtcarchivereader getbasetexturesize","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getbasetexturesize"},{"title":"Xbtcarchivereader getopenfile","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getopenfile"},{"title":"Xbtcarchivereader getresourcebasestreamindex","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getresourcebasestreamindex"},{"title":"Xbtcarchivereader getresourcecompressedsize","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getresourcecompressedsize"},{"title":"Xbtcarchivereader getresourcecount","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getresourcecount"},{"title":"Xbtcarchivereader getresourceseekoffset","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getresourceseekoffset"},{"title":"Xbtcarchivereader getresourcestreamcount","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getresourcestreamcount"},{"title":"Xbtcarchivereader getresourcestreamdatastart","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getresourcestreamdatastart"},{"title":"Xbtcarchivereader getstreamcount","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getstreamcount"},{"title":"Xbtcarchivereader getstreaminfo","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_getstreaminfo"},{"title":"Xbtcarchivereader gettextureinfo","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_gettextureinfo"},{"title":"Xbtcarchivereader gettextureoffset","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_gettextureoffset"},{"title":"Xbtcarchivereader isvalid","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_isvalid"},{"title":"Xbtcarchivereader isvalidarchive","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_isvalidarchive"},{"title":"Xbtcarchivereader openfromfile","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_openfromfile"},{"title":"Xbtcarchivereader openfrommemory","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_openfrommemory"},{"title":"Xbtcarchivereader xbtcarchivereader","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveReader/methods/xbtcarchivereader_xbtcarchivereader"}]}]},{"group":"XBTCArchiveWriter","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcarchivewriter","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveWriter/xbtcarchivewriter"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcarchivewriter writearchivetofile","href":"/reference/graphics/xbtc/interfaces/XBTCArchiveWriter/methods/xbtcarchivewriter_writearchivetofile"}]}]},{"group":"XBTCRefCountedResource","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcrefcountedresource","href":"/reference/graphics/xbtc/interfaces/XBTCRefCountedResource/xbtcrefcountedresource"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcrefcountedresource ~xbtcrefcountedresource","href":"/reference/graphics/xbtc/interfaces/XBTCRefCountedResource/methods/xbtcrefcountedresource_~xbtcrefcountedresource"},{"title":"Xbtcrefcountedresource addref","href":"/reference/graphics/xbtc/interfaces/XBTCRefCountedResource/methods/xbtcrefcountedresource_addref"},{"title":"Xbtcrefcountedresource release","href":"/reference/graphics/xbtc/interfaces/XBTCRefCountedResource/methods/xbtcrefcountedresource_release"},{"title":"Xbtcrefcountedresource xbtcrefcountedresource","href":"/reference/graphics/xbtc/interfaces/XBTCRefCountedResource/methods/xbtcrefcountedresource_xbtcrefcountedresource"}]}]},{"group":"XBTCStreamingTextureReader","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcstreamingtexturereader","href":"/reference/graphics/xbtc/interfaces/xbtcstreamingtexturereader/xbtcstreamingtexturereader"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcstreamingtexturereader getabsolutestreamindex","href":"/reference/graphics/xbtc/interfaces/xbtcstreamingtexturereader/methods/xbtcstreamingtexturereader_getabsolutestreamindex"},{"title":"Xbtcstreamingtexturereader getabsolutestreamindex 2","href":"/reference/graphics/xbtc/interfaces/xbtcstreamingtexturereader/methods/xbtcstreamingtexturereader_getabsolutestreamindex_2"},{"title":"Xbtcstreamingtexturereader preparetexture","href":"/reference/graphics/xbtc/interfaces/xbtcstreamingtexturereader/methods/xbtcstreamingtexturereader_preparetexture"},{"title":"Xbtcstreamingtexturereader xbtcstreamingtexturereader","href":"/reference/graphics/xbtc/interfaces/xbtcstreamingtexturereader/methods/xbtcstreamingtexturereader_xbtcstreamingtexturereader"}]}]},{"group":"XBTCTextureContainer","hidden":true,"tag":"NDA","pages":[{"title":"Xbtctexturecontainer","href":"/reference/graphics/xbtc/interfaces/XBTCTextureContainer/xbtctexturecontainer"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xbtctexturecontainer getsubresourcememory","href":"/reference/graphics/xbtc/interfaces/XBTCTextureContainer/methods/xbtctexturecontainer_getsubresourcememory"},{"title":"Xbtctexturecontainer getsubresourcepitch","href":"/reference/graphics/xbtc/interfaces/XBTCTextureContainer/methods/xbtctexturecontainer_getsubresourcepitch"},{"title":"Xbtctexturecontainer getsubresourcesize","href":"/reference/graphics/xbtc/interfaces/XBTCTextureContainer/methods/xbtctexturecontainer_getsubresourcesize"},{"title":"Xbtctexturecontainer gettexturememory","href":"/reference/graphics/xbtc/interfaces/XBTCTextureContainer/methods/xbtctexturecontainer_gettexturememory"},{"title":"Xbtctexturecontainer gettexturesize","href":"/reference/graphics/xbtc/interfaces/XBTCTextureContainer/methods/xbtctexturecontainer_gettexturesize"}]}]}]},{"group":"Functions","icon":"function","hidden":true,"tag":"NDA","pages":[{"title":"Xbtcblockcompresstexture","href":"/reference/graphics/xbtc/functions/xbtcblockcompresstexture"},{"title":"Xbtccompressbuffer","href":"/reference/graphics/xbtc/functions/xbtccompressbuffer"},{"title":"Xbtccompressstream","href":"/reference/graphics/xbtc/functions/xbtccompressstream"},{"title":"Xbtccompressstreamalloc","href":"/reference/graphics/xbtc/functions/xbtccompressstreamalloc"},{"title":"Xbtccompresstexture","href":"/reference/graphics/xbtc/functions/xbtccompresstexture"},{"title":"Xbtccreatearchive","href":"/reference/graphics/xbtc/functions/xbtccreatearchive"},{"title":"Xbtccreatebuffer","href":"/reference/graphics/xbtc/functions/xbtccreatebuffer"},{"title":"Xbtccreatelineartexture","href":"/reference/graphics/xbtc/functions/xbtccreatelineartexture"},{"title":"Xbtcdecompressanddetiletexturealloc","href":"/reference/graphics/xbtc/functions/xbtcdecompressanddetiletexturealloc"},{"title":"Xbtcdecompressstream","href":"/reference/graphics/xbtc/functions/xbtcdecompressstream"},{"title":"Xbtcdecompresstexture","href":"/reference/graphics/xbtc/functions/xbtcdecompresstexture"},{"title":"Xbtcdecompresstexturealloc","href":"/reference/graphics/xbtc/functions/xbtcdecompresstexturealloc"},{"title":"Xbtcdetiletexture","href":"/reference/graphics/xbtc/functions/xbtcdetiletexture"},{"title":"Xbtcfreecompressedstream","href":"/reference/graphics/xbtc/functions/xbtcfreecompressedstream"},{"title":"Xbtcfreeresource","href":"/reference/graphics/xbtc/functions/xbtcfreeresource"},{"title":"Xbtcgetrelativestreamindex","href":"/reference/graphics/xbtc/functions/xbtcgetrelativestreamindex"},{"title":"Xbtcgetrelativestreamindex 2","href":"/reference/graphics/xbtc/functions/xbtcgetrelativestreamindex_2"},{"title":"Xbtcgetrelativestreamindex overloads","href":"/reference/graphics/xbtc/functions/xbtcgetrelativestreamindex-overloads"},{"title":"Xbtctileandcompresstexture","href":"/reference/graphics/xbtc/functions/xbtctileandcompresstexture"},{"title":"Xbtctiletexture","href":"/reference/graphics/xbtc/functions/xbtctiletexture"}]},{"group":"Structures","icon":"sitemap","hidden":true,"tag":"NDA","pages":[{"title":"Xbtc archive header","href":"/reference/graphics/xbtc/structs/xbtc_archive_header"},{"title":"Xbtc buffer info","href":"/reference/graphics/xbtc/structs/xbtc_buffer_info"},{"title":"Xbtc compression stats","href":"/reference/graphics/xbtc/structs/xbtc_compression_stats"},{"title":"Xbtc encoding options","href":"/reference/graphics/xbtc/structs/xbtc_encoding_options"},{"title":"Xbtc encoding stats","href":"/reference/graphics/xbtc/structs/xbtc_encoding_stats"},{"title":"Xbtc offset and index","href":"/reference/graphics/xbtc/structs/xbtc_offset_and_index"},{"title":"Xbtc stream info","href":"/reference/graphics/xbtc/structs/xbtc_stream_info"},{"title":"Xbtc texture info","href":"/reference/graphics/xbtc/structs/xbtc_texture_info"}]},{"group":"Enumerations","icon":"list","hidden":true,"tag":"NDA","pages":[{"title":"Xbtc compression flags","href":"/reference/graphics/xbtc/enums/xbtc_compression_flags"},{"title":"Xbtc stream granularity","href":"/reference/graphics/xbtc/enums/xbtc_stream_granularity"},{"title":"Xbtc tex dimension","href":"/reference/graphics/xbtc/enums/xbtc_tex_dimension"},{"title":"Xbtc tiling mode","href":"/reference/graphics/xbtc/enums/xbtc_tiling_mode"}]}]},{"group":"xg_xs","icon":"microchip","hidden":true,"tag":"NDA","pages":[{"title":"Xg xs members","href":"/reference/graphics/xg_xs/xg_xs_members"},{"group":"Enumerations","icon":"list","hidden":true,"tag":"NDA","pages":[{"title":"Xg dcc compression level xs","href":"/reference/graphics/xg_xs/enums/xg_dcc_compression_level_xs"},{"title":"Xg hardware version xs","href":"/reference/graphics/xg_xs/enums/xg_hardware_version_xs"},{"title":"Xg suggest swizzle mode flags","href":"/reference/graphics/xg_xs/enums/xg_suggest_swizzle_mode_flags"},{"title":"Xg swizzle mode","href":"/reference/graphics/xg_xs/enums/xg_swizzle_mode"},{"title":"Xg texture layout xs","href":"/reference/graphics/xg_xs/enums/xg_texture_layout_xs"}]},{"group":"Functions","icon":"function","hidden":true,"tag":"NDA","pages":[{"title":"Xgcomputeoptimaldepthstencilswizzlemode","href":"/reference/graphics/xg_xs/functions/xgcomputeoptimaldepthstencilswizzlemode"},{"title":"Xgcomputeoptimalswizzlemode","href":"/reference/graphics/xg_xs/functions/xgcomputeoptimalswizzlemode"},{"title":"Xgconvertextensiontexturelayouttoswizzlemode","href":"/reference/graphics/xg_xs/functions/xgconvertextensiontexturelayouttoswizzlemode"},{"title":"Xgconvertswizzlemodetoextensiontexturelayout","href":"/reference/graphics/xg_xs/functions/xgconvertswizzlemodetoextensiontexturelayout"},{"title":"Xgcreatebvhcomputer xs","href":"/reference/graphics/xg_xs/functions/xgcreatebvhcomputer_xs"},{"title":"Xgcreatebvhcomputer2 xs","href":"/reference/graphics/xg_xs/functions/xgcreatebvhcomputer2_xs"},{"title":"Xgdecodedcc xs","href":"/reference/graphics/xg_xs/functions/xgdecodedcc_xs"},{"title":"Xgencodedcc xs","href":"/reference/graphics/xg_xs/functions/xgencodedcc_xs"},{"title":"Xginitializelibrary xs","href":"/reference/graphics/xg_xs/functions/xginitializelibrary_xs"},{"title":"Xgsuggestswizzlemode","href":"/reference/graphics/xg_xs/functions/xgsuggestswizzlemode"},{"title":"Xgterminatelibrary xs","href":"/reference/graphics/xg_xs/functions/xgterminatelibrary_xs"},{"title":"Xgvalidatedepthstencilswizzlemode","href":"/reference/graphics/xg_xs/functions/xgvalidatedepthstencilswizzlemode"}]},{"group":"Interfaces","icon":"plug","hidden":true,"tag":"NDA","pages":[{"group":"XGBVHComputer","hidden":true,"tag":"NDA","pages":[{"title":"Xgbvhcomputer xs","href":"/reference/graphics/xg_xs/interfaces/XGBVHComputer/xgbvhcomputer_xs"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xgbvhcomputer decompressbvh batchedgpu xs","href":"/reference/graphics/xg_xs/interfaces/XGBVHComputer/methods/xgbvhcomputer_decompressbvh_batchedgpu_xs"},{"title":"Xgbvhcomputer decompressbvh xs","href":"/reference/graphics/xg_xs/interfaces/XGBVHComputer/methods/xgbvhcomputer_decompressbvh_xs"},{"title":"Xgbvhcomputer deserializebvh xs","href":"/reference/graphics/xg_xs/interfaces/XGBVHComputer/methods/xgbvhcomputer_deserializebvh_xs"},{"title":"Xgbvhcomputer getrequiredgpuscratchsizeinbytes xs","href":"/reference/graphics/xg_xs/interfaces/XGBVHComputer/methods/xgbvhcomputer_getrequiredgpuscratchsizeinbytes_xs"},{"title":"Xgbvhcomputer validatedecompressedbvh xs","href":"/reference/graphics/xg_xs/interfaces/XGBVHComputer/methods/xgbvhcomputer_validatedecompressedbvh_xs"}]}]},{"group":"XGTextureAddressComputer","hidden":true,"tag":"NDA","pages":[{"title":"Xgtextureaddresscomputer xs","href":"/reference/graphics/xg_xs/interfaces/XGTextureAddressComputer/xgtextureaddresscomputer_xs"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Xgtextureaddresscomputer copyfromsubresource xs","href":"/reference/graphics/xg_xs/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_copyfromsubresource_xs"},{"title":"Xgtextureaddresscomputer getswizzlepatterninfo xs","href":"/reference/graphics/xg_xs/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_getswizzlepatterninfo_xs"},{"title":"Xgtextureaddresscomputer gettexelelementoffsetbytes xs","href":"/reference/graphics/xg_xs/interfaces/XGTextureAddressComputer/methods/xgtextureaddresscomputer_gettexelelementoffsetbytes_xs"}]}]}]},{"group":"Structures","icon":"sitemap","hidden":true,"tag":"NDA","pages":[{"title":"Xg buffer desc xs","href":"/reference/graphics/xg_xs/structs/xg_buffer_desc_xs"},{"title":"Xg miplevel layout xs","href":"/reference/graphics/xg_xs/structs/xg_miplevel_layout_xs"},{"title":"Xg plane layout xs","href":"/reference/graphics/xg_xs/structs/xg_plane_layout_xs"},{"title":"Xg swizzle pattern info","href":"/reference/graphics/xg_xs/structs/xg_swizzle_pattern_info"},{"title":"Xg texture1d desc xs","href":"/reference/graphics/xg_xs/structs/xg_texture1d_desc_xs"},{"title":"Xg texture2d desc xs","href":"/reference/graphics/xg_xs/structs/xg_texture2d_desc_xs"},{"title":"Xg texture3d desc xs","href":"/reference/graphics/xg_xs/structs/xg_texture3d_desc_xs"}]}]},{"group":"DXCApi","icon":"code","hidden":true,"tag":"NDA","pages":[{"title":"Dxcapi x members","href":"/reference/graphics/dxcapi_x/dxcapi_x_members"},{"group":"Interfaces","icon":"plug","hidden":true,"tag":"NDA","pages":[{"group":"IDxcXboxBackendDebugInfo","hidden":true,"tag":"NDA","pages":[{"title":"Idxcxboxbackenddebuginfo","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxbackenddebuginfo/idxcxboxbackenddebuginfo"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Idxcxboxbackenddebuginfo getdebuginfoforstage","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxBackendDebugInfo/methods/idxcxboxbackenddebuginfo_getdebuginfoforstage"},{"title":"Idxcxboxbackenddebuginfo getnumstages","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxBackendDebugInfo/methods/idxcxboxbackenddebuginfo_getnumstages"},{"title":"Idxcxboxbackenddebuginfo getstage","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxBackendDebugInfo/methods/idxcxboxbackenddebuginfo_getstage"},{"title":"Idxcxboxbackenddebuginfo load","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxBackendDebugInfo/methods/idxcxboxbackenddebuginfo_load"}]}]},{"group":"IDxcXboxContainer","hidden":true,"tag":"NDA","pages":[{"title":"Idxcxboxcontainer","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxcontainer/idxcxboxcontainer"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Idxcxboxcontainer getnumshaders","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxContainer/methods/idxcxboxcontainer_getnumshaders"},{"title":"Idxcxboxcontainer getshader","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxContainer/methods/idxcxboxcontainer_getshader"},{"title":"Idxcxboxcontainer load","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxContainer/methods/idxcxboxcontainer_load"}]}]},{"group":"IDxcXboxHwShader","hidden":true,"tag":"NDA","pages":[{"title":"Idxcxboxhwshader","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxhwshader/idxcxboxhwshader"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Idxcxboxhwshader getcode","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxHwShader/methods/idxcxboxhwshader_getcode"},{"title":"Idxcxboxhwshader getdebuginfo","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxHwShader/methods/idxcxboxhwshader_getdebuginfo"},{"title":"Idxcxboxhwshader getshaderstats","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxHwShader/methods/idxcxboxhwshader_getshaderstats"},{"title":"Idxcxboxhwshader getstagename","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxHwShader/methods/idxcxboxhwshader_getstagename"}]}]},{"group":"IDxcXboxShaderStats","hidden":true,"tag":"NDA","pages":[{"title":"Idxcxboxshaderstats","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxshaderstats/idxcxboxshaderstats"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Idxcxboxshaderstats getshaderstats","href":"/reference/graphics/dxcapi_x/interfaces/IDxcXboxShaderStats/methods/idxcxboxshaderstats_getshaderstats"}]}]},{"group":"IXdxrPdbRecompiler","hidden":true,"tag":"NDA","pages":[{"title":"Ixdxrpdbrecompiler","href":"/reference/graphics/dxcapi_x/interfaces/IXdxrPdbRecompiler/ixdxrpdbrecompiler"},{"group":"Methods","hidden":true,"tag":"NDA","pages":[{"title":"Ixdxrpdbrecompiler recompile","href":"/reference/graphics/dxcapi_x/interfaces/IXdxrPdbRecompiler/methods/ixdxrpdbrecompiler_recompile"}]}]}]},{"group":"Structures","icon":"sitemap","hidden":true,"tag":"NDA","pages":[{"title":"Dxcxboxshaderstaticsv1","href":"/reference/graphics/dxcapi_x/structs/dxcxboxshaderstaticsv1"},{"title":"Dxcxboxshaderstaticsv2","href":"/reference/graphics/dxcapi_x/structs/dxcxboxshaderstaticsv2"},{"title":"Memoryaccessstat","href":"/reference/graphics/dxcapi_x/structs/memoryaccessstat"},{"title":"Rawinstructionstats","href":"/reference/graphics/dxcapi_x/structs/rawinstructionstats"},{"title":"Rawinstuctionstat","href":"/reference/graphics/dxcapi_x/structs/rawinstuctionstat"}]},{"group":"Enumerations","icon":"list","hidden":true,"tag":"NDA","pages":[{"title":"Dxcxboxshaderstatsclass","href":"/reference/graphics/dxcapi_x/enums/dxcxboxshaderstatsclass"}]}]},{"group":"d3d12_x","pages":[{"group":"Interfaces","pages":[{"group":"ID3D12GraphicsCommandList","pages":[{"group":"Methods","pages":[{"title":"Id3d12graphicscommandlist samplecountersx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_samplecountersx"},{"title":"Id3d12graphicscommandlist startcountersx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_startcountersx"},{"title":"Id3d12graphicscommandlist stopcountersx","href":"/reference/graphics/d3d12_x/interfaces/id3d12graphicscommandlist/methods/id3d12graphicscommandlist_stopcountersx"}]}]}]}]},{"group":"d3d12_xs","pages":[{"title":"D3d12 xs members","href":"/reference/graphics/d3d12_xs/d3d12_xs_members"},{"group":"Enums","pages":[{"title":"D3D_FEATURE_LEVEL (XBOX Series consoles)","description":"Describes the set of features targeted by a Direct3D device.","sidebarTitle":"D3D_FEATURE_LEVEL","hidden":false,"href":"/reference/graphics/d3d12_xs/enums/d3d_feature_level","hiddenSetByFrontmatter":true},{"title":"D3D_NAME (XBOX Series consoles)","description":"Values that identify shader parameters that use system-value semantics.","sidebarTitle":"D3D_NAME","hidden":false,"href":"/reference/graphics/d3d12_xs/enums/d3d_name","hiddenSetByFrontmatter":true},{"title":"D3d primitive topology","href":"/reference/graphics/d3d12_xs/enums/d3d_primitive_topology"},{"title":"D3D_SHADER_INPUT_TYPE (XBOX Series consoles)","description":"Values that identify resource types that can be bound to a shader and that are reflected as part of the resource description for the shader.","sidebarTitle":"D3D_SHADER_INPUT_TYPE","hidden":false,"href":"/reference/graphics/d3d12_xs/enums/d3d_shader_input_type","hiddenSetByFrontmatter":true},{"title":"D3d11 create deferred context flag","href":"/reference/graphics/d3d12_xs/enums/d3d11_create_deferred_context_flag"},{"title":"D3d12 buffer srv flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12_buffer_srv_flags_xs"},{"title":"D3d12 buffer uav flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12_buffer_uav_flags_xs"},{"title":"D3d12 fence flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12_fence_flags_xs"},{"title":"D3d12 indirect argument type xs","href":"/reference/graphics/d3d12_xs/enums/d3d12_indirect_argument_type_xs"},{"title":"D3d12 measurements action","href":"/reference/graphics/d3d12_xs/enums/d3d12_measurements_action"},{"title":"D3D12_MESH_SHADER_TIER (XBOX Series consoles)","description":"Indicates the level of mesh shader support.","sidebarTitle":"D3D12_MESH_SHADER_TIER","hidden":false,"href":"/reference/graphics/d3d12_xs/enums/d3d12_mesh_shader_tier_xs","hiddenSetByFrontmatter":true},{"title":"D3d12 message id","href":"/reference/graphics/d3d12_xs/enums/d3d12_message_id"},{"title":"D3d12 pipeline state flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12_pipeline_state_flags_xs"},{"title":"D3d12 ray flags","href":"/reference/graphics/d3d12_xs/enums/d3d12_ray_flags"},{"title":"D3d12 root signature flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12_root_signature_flags_xs"},{"title":"D3d12 sampler feedback tier xs","href":"/reference/graphics/d3d12_xs/enums/d3d12_sampler_feedback_tier_xs"},{"title":"D3D12_STANDARD_MULTISAMPLE_QUALITY_LEVELS","description":"Specifies a multi-sample pattern type.","sidebarTitle":"D3D12_STANDARD_MULTISAMPLE_QUALITY_LEVELS","hidden":false,"href":"/reference/graphics/d3d12_xs/enums/d3d12_standard_multisample_quality_levels","hiddenSetByFrontmatter":true},{"title":"D3d12 state subobject type xs","href":"/reference/graphics/d3d12_xs/enums/d3d12_state_subobject_type_xs"},{"title":"D3D12_WAVE_MMA_TIER (XBOX Series consoles)","description":"D3D12_WAVE_MMA_TIER (XBOX Series consoles) — Defines constants that specify a level of support for WaveMMA (wave_matrix) operations.","sidebarTitle":"D3D12_WAVE_MMA_TIER","hidden":false,"href":"/reference/graphics/d3d12_xs/enums/d3d12_wave_mma_tier_xs","hiddenSetByFrontmatter":true},{"title":"D3d12xbox bin mapping mode","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_bin_mapping_mode"},{"title":"D3d12xbox bin size","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_bin_size"},{"title":"D3d12xbox binning flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_binning_flags"},{"title":"D3d12xbox binning mode","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_binning_mode"},{"title":"D3d12xbox build raytracing acceleration structure subobject type","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_build_raytracing_acceleration_structure_subobject_type"},{"title":"D3d12xbox cmdlist driver hint","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_cmdlist_driver_hint"},{"title":"D3d12xbox command list flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_command_list_flags_xs"},{"title":"D3d12xbox command list reset flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_command_list_reset_flags"},{"title":"D3d12xbox compute shader launch param flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_compute_shader_launch_param_flags"},{"title":"D3d12xbox copy flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_copy_flags_xs"},{"title":"D3d12xbox create device flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_create_device_flags_xs"},{"title":"D3d12xbox dcc compression level xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_dcc_compression_level_xs"},{"title":"D3d12xbox dispatch flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_dispatch_flags_xs"},{"title":"D3d12xbox driver hint","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_driver_hint"},{"title":"D3d12xbox execute command list flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_execute_command_list_flags"},{"title":"D3d12xbox frame interval flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_frame_interval_flags_xs"},{"title":"D3d12xbox hardware version xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_hardware_version_xs"},{"title":"D3d12xbox image format","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_image_format"},{"title":"D3d12xbox live debugging shader flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_live_debugging_shader_flags"},{"title":"D3d12xbox live debugging shader global flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_live_debugging_shader_global_flags"},{"title":"D3d12xbox live debugging type","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_live_debugging_type"},{"title":"D3d12xbox minmip filter offset","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_minmip_filter_offset"},{"title":"D3d12xbox minmip filter slope","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_minmip_filter_slope"},{"title":"D3d12xbox page mapping flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_page_mapping_flags_xs"},{"title":"D3d12xbox pipeline state information type","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_pipeline_state_information_type"},{"title":"D3d12xbox pipeline state option type","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_pipeline_state_option_type"},{"title":"D3d12xbox pix capture flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_pix_capture_flags_xs"},{"title":"D3d12xbox present desc title performance overlay flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_present_desc_title_performance_overlay_flags"},{"title":"D3d12xbox process debug flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_process_debug_flags_xs"},{"title":"D3d12xbox raytracing canonical acceleration structure node type","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_raytracing_canonical_acceleration_structure_node_type"},{"title":"D3d12xbox raytracing information flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_raytracing_information_flags"},{"title":"D3d12xbox raytracing options traverse type","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_raytracing_options_traverse_type"},{"title":"D3d12xbox register page pool flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_register_page_pool_flags_xs"},{"title":"D3d12xbox report gpu halt flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_report_gpu_halt_flags"},{"title":"D3d12xbox resource barrier shared flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_resource_barrier_shared_flags"},{"title":"D3d12xbox resource barrier supplemental actions","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_resource_barrier_supplemental_actions"},{"title":"D3d12xbox resource validation flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_resource_validation_flags"},{"title":"D3d12xbox sampler flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_sampler_flags_xs"},{"title":"D3d12xbox set shader scratch space flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_set_shader_scratch_space_flags_xs"},{"title":"D3d12xbox shader stage flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_shader_stage_flags"},{"title":"D3d12xbox shader unit disable flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_shader_unit_disable_flags_xs"},{"title":"D3d12xbox shading rate settings htile mode type","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_shading_rate_settings_htile_mode_type"},{"title":"D3d12xbox shading rate settings type","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_shading_rate_settings_type"},{"title":"D3d12xbox sync control flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_sync_control_flags"},{"title":"D3d12xbox sync flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_sync_flags"},{"title":"D3d12xbox virtual memory configuration flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_virtual_memory_configuration_flags"},{"title":"D3d12xbox wait flags xs","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_wait_flags_xs"},{"title":"D3d12xbox zero memory flags","href":"/reference/graphics/d3d12_xs/enums/d3d12xbox_zero_memory_flags"},{"title":"Dxgi color space type","href":"/reference/graphics/d3d12_xs/enums/dxgi_color_space_type"},{"title":"Dxgi format","href":"/reference/graphics/d3d12_xs/enums/dxgi_format"},{"title":"Dxgi mode rotation","href":"/reference/graphics/d3d12_xs/enums/dxgi_mode_rotation"},{"title":"Dxgi mode scanline order","href":"/reference/graphics/d3d12_xs/enums/dxgi_mode_scanline_order"},{"title":"Dxgi scaling","href":"/reference/graphics/d3d12_xs/enums/dxgi_scaling"},{"title":"Dxgi swap chain flag","href":"/reference/graphics/d3d12_xs/enums/dxgi_swap_chain_flag"},{"title":"Dxgi swap effect","href":"/reference/graphics/d3d12_xs/enums/dxgi_swap_effect"},{"title":"Dxgix frame notification","href":"/reference/graphics/d3d12_xs/enums/dxgix_frame_notification"},{"title":"Dxgix vlinecounter","href":"/reference/graphics/d3d12_xs/enums/dxgix_vlinecounter"},{"title":"Dxgixbox mode flags","href":"/reference/graphics/d3d12_xs/enums/dxgixbox_mode_flags"}]},{"group":"Functions","pages":[{"title":"D3D10CreateBlob (XBOX Series consoles)","description":"Creates a buffer.","sidebarTitle":"D3D10CreateBlob","hidden":false,"href":"/reference/graphics/d3d12_xs/functions/d3d10createblob","hiddenSetByFrontmatter":true},{"title":"D3d12configurevirtualmemoryx","href":"/reference/graphics/d3d12_xs/functions/d3d12configurevirtualmemoryx"},{"title":"D3d12xboxinitializedefaultdpbbstate","href":"/reference/graphics/d3d12_xs/functions/d3d12xboxinitializedefaultdpbbstate"},{"title":"D3d12xboxmakedefault d3d12xbox build raytracing acceleration structure params1","href":"/reference/graphics/d3d12_xs/functions/d3d12xboxmakedefault_d3d12xbox_build_raytracing_acceleration_structure_params1"},{"title":"D3d12xboxmakedefault d3d12xbox build raytracing acceleration structure params2","href":"/reference/graphics/d3d12_xs/functions/d3d12xboxmakedefault_d3d12xbox_build_raytracing_acceleration_structure_params2"},{"title":"D3d12xboxmakedefault d3d12xbox build raytracing acceleration structure params3","href":"/reference/graphics/d3d12_xs/functions/d3d12xboxmakedefault_d3d12xbox_build_raytracing_acceleration_structure_params3"},{"title":"D3d12zeromemoryx","href":"/reference/graphics/d3d12_xs/functions/d3d12zeromemoryx"}]},{"group":"Interfaces","pages":[{"group":"ID3D10Blob","pages":[{"title":"Id3d10blob","href":"/reference/graphics/d3d12_xs/interfaces/ID3D10Blob/id3d10blob"},{"group":"Methods","pages":[{"title":"Id3d10blob getbufferpointer","href":"/reference/graphics/d3d12_xs/interfaces/ID3D10Blob/methods/id3d10blob_getbufferpointer"},{"title":"Id3d10blob getbuffersize","href":"/reference/graphics/d3d12_xs/interfaces/ID3D10Blob/methods/id3d10blob_getbuffersize"}]}]},{"group":"ID3D12CommandQueue","pages":[{"title":"Id3d12commandqueue xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12CommandQueue/id3d12commandqueue_xs"},{"group":"Methods","pages":[{"title":"Id3d12commandqueue enablelivedebuggingx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12CommandQueue/methods/id3d12commandqueue_enablelivedebuggingx"},{"title":"Id3d12commandqueue executecommandlists2x","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12CommandQueue/methods/id3d12commandqueue_executecommandlists2x"},{"title":"Id3d12commandqueue signal2x","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12CommandQueue/methods/id3d12commandqueue_signal2x"},{"title":"Id3d12commandqueue waitx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12CommandQueue/methods/id3d12commandqueue_waitx"}]}]},{"group":"ID3D12DescriptorHeap","pages":[{"title":"Id3d12descriptorheap","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12DescriptorHeap/id3d12descriptorheap"},{"group":"Methods","pages":[{"title":"Id3d12descriptorheap getsamplerbordercolortablex","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12DescriptorHeap/methods/id3d12descriptorheap_getsamplerbordercolortablex"}]}]},{"group":"ID3D12Device11","pages":[{"title":"Id3d12device11","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device11/id3d12device11"},{"group":"Methods","pages":[{"title":"Id3d12device11 createcomponentplacedresourcex2","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device11/methods/id3d12device11_createcomponentplacedresourcex2"},{"title":"Id3d12device11 createplacedresourcex1","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device11/methods/id3d12device11_createplacedresourcex1"},{"title":"Id3d12device11 enablelivedebuggingx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device11/methods/id3d12device11_enablelivedebuggingx"},{"title":"Id3d12device11 reportgpuhaltx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device11/methods/id3d12device11_reportgpuhaltx"}]}]},{"group":"ID3D12Device6","pages":[{"title":"Id3d12device6","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device6/id3d12device6"},{"group":"Methods","pages":[{"title":"Id3d12device6 setbackgroundprocessingmode","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device6/methods/id3d12device6_setbackgroundprocessingmode"}]}]},{"group":"ID3D12Device7","pages":[{"title":"Id3d12device7","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device7/id3d12device7"},{"group":"Methods","pages":[{"title":"Id3d12device7 addtostateobject","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device7/methods/id3d12device7_addtostateobject"},{"title":"Id3d12device7 createprotectedresourcesession1","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device7/methods/id3d12device7_createprotectedresourcesession1"}]}]},{"group":"ID3D12Device8","pages":[{"title":"Id3d12device8","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/id3d12device8"},{"group":"Methods","pages":[{"title":"Id3d12device8 addblobtogpuhangdumpx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_addblobtogpuhangdumpx"},{"title":"Id3d12device8 createcommittedresource2","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_createcommittedresource2"},{"title":"Id3d12device8 createminmipshaderresourceviewx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_createminmipshaderresourceviewx"},{"title":"Id3d12device8 createplacedresource1","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_createplacedresource1"},{"title":"Id3d12device8 createsamplerfeedbackunorderedaccessview","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_createsamplerfeedbackunorderedaccessview"},{"title":"Id3d12device8 createsamplerfeedbackunorderedaccessviewx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_createsamplerfeedbackunorderedaccessviewx"},{"title":"Id3d12device8 deserializestateobjectx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_deserializestateobjectx"},{"title":"Id3d12device8 getcopyablefootprints1","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_getcopyablefootprints1"},{"title":"Id3d12device8 getraytracingaccelerationstructureprebuildinfox","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_getraytracingaccelerationstructureprebuildinfox"},{"title":"Id3d12device8 getresourceallocationinfo2","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_getresourceallocationinfo2"},{"title":"Id3d12device8 getshaderresourceviewprtlodindexx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_getshaderresourceviewprtlodindexx"},{"title":"Id3d12device8 serializestateobjectx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_serializestateobjectx"},{"title":"Id3d12device8 setcompiletimeshaderpdbpathx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_setcompiletimeshaderpdbpathx"},{"title":"Id3d12device8 setshaderrecompilecallbackx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_setshaderrecompilecallbackx"},{"title":"Id3d12device8 setshaderresourceviewprtlodindexx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Device8/methods/id3d12device8_setshaderresourceviewprtlodindexx"}]}]},{"group":"ID3D12GraphicsCommandList","pages":[{"title":"Id3d12graphicscommandlist xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList/id3d12graphicscommandlist_xs"},{"group":"Methods","pages":[{"title":"Id3d12graphicscommandlist clearrendertargetview xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList/methods/id3d12graphicscommandlist_clearrendertargetview_xs"},{"title":"Id3d12graphicscommandlist deferredprimitivebreakbatchx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList/methods/id3d12graphicscommandlist_deferredprimitivebreakbatchx"},{"title":"Id3d12graphicscommandlist dispatchmeshx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList/methods/id3d12graphicscommandlist_dispatchmeshx"},{"title":"Id3d12graphicscommandlist driverhintx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList/methods/id3d12graphicscommandlist_driverhintx"},{"title":"Id3d12graphicscommandlist setdeferredprimitivebatchbinningx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList/methods/id3d12graphicscommandlist_setdeferredprimitivebatchbinningx"},{"title":"Id3d12graphicscommandlist setgraphicsshaderlimitsx xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList/methods/id3d12graphicscommandlist_setgraphicsshaderlimitsx_xs"}]}]},{"group":"ID3D12GraphicsCommandList4","pages":[{"title":"Id3d12graphicscommandlist4","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList4/id3d12graphicscommandlist4"},{"group":"Methods","pages":[{"title":"Id3d12graphicscommandlist4 buildraytracingaccelerationstructurefromcanonicalbvh","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList4/methods/id3d12graphicscommandlist4_buildraytracingaccelerationstructurefromcanonicalbvh"},{"title":"Id3d12graphicscommandlist4 cpuvalidateresultx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList4/methods/id3d12graphicscommandlist4_cpuvalidateresultx"}]}]},{"group":"ID3D12GraphicsCommandList5","pages":[{"title":"Id3d12graphicscommandlist5","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList5/id3d12graphicscommandlist5"},{"group":"Methods","pages":[{"title":"Id3d12graphicscommandlist5 rssetshadingratex","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList5/methods/id3d12graphicscommandlist5_rssetshadingratex"}]}]},{"group":"ID3D12GraphicsCommandList6","pages":[{"title":"Id3d12graphicscommandlist6","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/id3d12graphicscommandlist6"},{"group":"Methods","pages":[{"title":"Id3d12graphicscommandlist6 buildraytracingaccelerationstructurebatched2x","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_buildraytracingaccelerationstructurebatched2x"},{"title":"Id3d12graphicscommandlist6 dispatchmesh","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_dispatchmesh"},{"title":"Id3d12graphicscommandlist6 dispatchraysx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_dispatchraysx"},{"title":"Id3d12graphicscommandlist6 enablelivedebuggingx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_enablelivedebuggingx"},{"title":"Id3d12graphicscommandlist6 omsetsamplemaskx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_omsetsamplemaskx"},{"title":"Id3d12graphicscommandlist6 prefetchmemoryx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_prefetchmemoryx"},{"title":"Id3d12graphicscommandlist6 prefetchpipelinestatex","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_prefetchpipelinestatex"},{"title":"Id3d12graphicscommandlist6 resetx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_resetx"},{"title":"Id3d12graphicscommandlist6 resourcebarrierx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_resourcebarrierx"},{"title":"Id3d12graphicscommandlist6 setcomputeshaderlaunchparametersx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_setcomputeshaderlaunchparametersx"},{"title":"Id3d12graphicscommandlist6 setshaderscratchspacex","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_setshaderscratchspacex"},{"title":"Id3d12graphicscommandlist6 syncbottomofpipex","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_syncbottomofpipex"},{"title":"Id3d12graphicscommandlist6 synctopofpipex","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_synctopofpipex"},{"title":"Id3d12graphicscommandlist6 write32bitvaluebottomofpipe2x","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_write32bitvaluebottomofpipe2x"},{"title":"Id3d12graphicscommandlist6 write64bitvaluebottomofpipe2x","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_write64bitvaluebottomofpipe2x"},{"title":"Id3d12graphicscommandlist6 writeprtlodstatisticsx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList6/methods/id3d12graphicscommandlist6_writeprtlodstatisticsx"}]}]},{"group":"ID3D12GraphicsCommandList8","pages":[{"title":"Id3d12graphicscommandlist8","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList8/id3d12graphicscommandlist8"},{"group":"Methods","pages":[{"title":"Id3d12graphicscommandlist8 allocatefromcommandallocatorx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12GraphicsCommandList8/methods/id3d12graphicscommandlist8_allocatefromcommandallocatorx"}]}]},{"group":"ID3D12Heap1","pages":[{"title":"Id3d12heap1","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Heap1/id3d12heap1"},{"group":"Methods","pages":[{"title":"Id3d12heap1 getgpuaddressx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Heap1/methods/id3d12heap1_getgpuaddressx"}]}]},{"group":"ID3D12Object","pages":[{"title":"Id3d12object","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Object/id3d12object"},{"group":"Methods","pages":[{"title":"Id3d12object getnamex","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Object/methods/id3d12object_getnamex"}]}]},{"group":"ID3D12PipelineState","pages":[{"title":"Id3d12pipelinestate xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12PipelineState/id3d12pipelinestate_xs"},{"group":"Methods","pages":[{"title":"Id3d12pipelinestate getdescriptorx xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12PipelineState/methods/id3d12pipelinestate_getdescriptorx_xs"},{"title":"Id3d12pipelinestate getinformationx xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12PipelineState/methods/id3d12pipelinestate_getinformationx_xs"},{"title":"Id3d12pipelinestate iswave32 xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12PipelineState/methods/id3d12pipelinestate_iswave32_xs"},{"title":"Id3d12pipelinestate setoptionx xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12PipelineState/methods/id3d12pipelinestate_setoptionx_xs"},{"title":"Id3d12pipelinestate useshardwaregsorhs 2 xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12PipelineState/methods/id3d12pipelinestate_useshardwaregsorhs_2_xs"},{"title":"Id3d12pipelinestate useshardwaregsorhs xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12PipelineState/methods/id3d12pipelinestate_useshardwaregsorhs_xs"}]}]},{"group":"ID3D12Resource","pages":[{"title":"Id3d12resource xs","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Resource/id3d12resource_xs"},{"group":"Methods","pages":[{"title":"Id3d12resource getvalidationflagsx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Resource/methods/id3d12resource_getvalidationflagsx"},{"title":"Id3d12resource setvalidationflagsx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12Resource/methods/id3d12resource_setvalidationflagsx"}]}]},{"group":"ID3D12RootSignature","pages":[{"title":"Id3d12rootsignature","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12RootSignature/id3d12rootsignature"},{"group":"Methods","pages":[{"title":"Id3d12rootsignature getcomputedescriptorx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12RootSignature/methods/id3d12rootsignature_getcomputedescriptorx"}]}]},{"group":"ID3D12StateObject","pages":[{"title":"Id3d12stateobject","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12StateObject/id3d12stateobject"},{"group":"Methods","pages":[{"title":"Id3d12stateobject getpipelinestatex","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12StateObject/methods/id3d12stateobject_getpipelinestatex"}]}]},{"group":"ID3D12StateObjectProperties","pages":[{"title":"Id3d12stateobjectproperties","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12StateObjectProperties/id3d12stateobjectproperties"},{"group":"Methods","pages":[{"title":"Id3d12stateobjectproperties getinformationx","href":"/reference/graphics/d3d12_xs/interfaces/ID3D12StateObjectProperties/methods/id3d12stateobjectproperties_getinformationx"}]}]},{"group":"ID3DInclude","pages":[{"title":"Id3dinclude","href":"/reference/graphics/d3d12_xs/interfaces/ID3DInclude/id3dinclude"},{"group":"Methods","pages":[{"title":"Id3dinclude close","href":"/reference/graphics/d3d12_xs/interfaces/ID3DInclude/methods/id3dinclude_close"},{"title":"Id3dinclude open","href":"/reference/graphics/d3d12_xs/interfaces/ID3DInclude/methods/id3dinclude_open"}]}]},{"group":"IDXGIAdapter","pages":[{"title":"Idxgiadapter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIAdapter/idxgiadapter"},{"group":"Methods","pages":[{"title":"Idxgiadapter checkinterfacesupport","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIAdapter/methods/idxgiadapter_checkinterfacesupport"},{"title":"Idxgiadapter enumoutputs","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIAdapter/methods/idxgiadapter_enumoutputs"},{"title":"Idxgiadapter getdesc","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIAdapter/methods/idxgiadapter_getdesc"}]}]},{"group":"IDXGIAdapter1","pages":[{"title":"Idxgiadapter1","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIAdapter1/idxgiadapter1"},{"group":"Methods","pages":[{"title":"Idxgiadapter1 getdesc1","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIAdapter1/methods/idxgiadapter1_getdesc1"}]}]},{"group":"IDXGIAdapter2","pages":[{"title":"Idxgiadapter2","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIAdapter2/idxgiadapter2"},{"group":"Methods","pages":[{"title":"Idxgiadapter2 getdesc2","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIAdapter2/methods/idxgiadapter2_getdesc2"}]}]},{"group":"IDXGIDevice","pages":[{"title":"Idxgidevice","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice/idxgidevice"},{"group":"Methods","pages":[{"title":"Idxgidevice createsurface","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice/methods/idxgidevice_createsurface"},{"title":"Idxgidevice getadapter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice/methods/idxgidevice_getadapter"},{"title":"Idxgidevice getgputhreadpriority","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice/methods/idxgidevice_getgputhreadpriority"},{"title":"Idxgidevice queryresourceresidency","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice/methods/idxgidevice_queryresourceresidency"},{"title":"Idxgidevice setgputhreadpriority","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice/methods/idxgidevice_setgputhreadpriority"}]}]},{"group":"IDXGIDevice1","pages":[{"title":"Idxgidevice1","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice1/idxgidevice1"},{"group":"Methods","pages":[{"title":"Idxgidevice1 getmaximumframelatency","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice1/methods/idxgidevice1_getmaximumframelatency"},{"title":"Idxgidevice1 setmaximumframelatency","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice1/methods/idxgidevice1_setmaximumframelatency"}]}]},{"group":"IDXGIDevice2","pages":[{"title":"Idxgidevice2","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice2/idxgidevice2"},{"group":"Methods","pages":[{"title":"Idxgidevice2 enqueuesetevent","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice2/methods/idxgidevice2_enqueuesetevent"},{"title":"Idxgidevice2 offerresources","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice2/methods/idxgidevice2_offerresources"},{"title":"Idxgidevice2 reclaimresources","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDevice2/methods/idxgidevice2_reclaimresources"}]}]},{"group":"IDXGIDeviceSubObject","pages":[{"title":"Idxgidevicesubobject","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDeviceSubObject/idxgidevicesubobject"},{"group":"Methods","pages":[{"title":"Idxgidevicesubobject getdevice","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIDeviceSubObject/methods/idxgidevicesubobject_getdevice"}]}]},{"group":"IDXGIFactory","pages":[{"title":"Idxgifactory","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory/idxgifactory"},{"group":"Methods","pages":[{"title":"Idxgifactory createsoftwareadapter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory/methods/idxgifactory_createsoftwareadapter"},{"title":"Idxgifactory enumadapters","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory/methods/idxgifactory_enumadapters"},{"title":"Idxgifactory getwindowassociation","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory/methods/idxgifactory_getwindowassociation"},{"title":"Idxgifactory makewindowassociation","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory/methods/idxgifactory_makewindowassociation"}]}]},{"group":"IDXGIFactory1","pages":[{"title":"Idxgifactory1","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory1/idxgifactory1"},{"group":"Methods","pages":[{"title":"Idxgifactory1 enumadapters1","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory1/methods/idxgifactory1_enumadapters1"},{"title":"Idxgifactory1 iscurrent","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory1/methods/idxgifactory1_iscurrent"}]}]},{"group":"IDXGIFactory2","pages":[{"title":"Idxgifactory2","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory2/idxgifactory2"},{"group":"Methods","pages":[{"title":"Idxgifactory2 getsharedresourceadapterluid","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory2/methods/idxgifactory2_getsharedresourceadapterluid"},{"title":"Idxgifactory2 iswindowedstereoenabled","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory2/methods/idxgifactory2_iswindowedstereoenabled"},{"title":"Idxgifactory2 registerocclusionstatusevent","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory2/methods/idxgifactory2_registerocclusionstatusevent"},{"title":"Idxgifactory2 registerocclusionstatuswindow","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory2/methods/idxgifactory2_registerocclusionstatuswindow"},{"title":"Idxgifactory2 registerstereostatusevent","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory2/methods/idxgifactory2_registerstereostatusevent"},{"title":"Idxgifactory2 registerstereostatuswindow","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory2/methods/idxgifactory2_registerstereostatuswindow"},{"title":"Idxgifactory2 unregisterocclusionstatus","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory2/methods/idxgifactory2_unregisterocclusionstatus"},{"title":"Idxgifactory2 unregisterstereostatus","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIFactory2/methods/idxgifactory2_unregisterstereostatus"}]}]},{"group":"IDXGIInfoQueue","pages":[{"title":"Idxgiinfoqueue","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/idxgiinfoqueue"},{"group":"Methods","pages":[{"title":"Idxgiinfoqueue addapplicationmessage","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_addapplicationmessage"},{"title":"Idxgiinfoqueue addmessage","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_addmessage"},{"title":"Idxgiinfoqueue addretrievalfilterentries","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_addretrievalfilterentries"},{"title":"Idxgiinfoqueue addstoragefilterentries","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_addstoragefilterentries"},{"title":"Idxgiinfoqueue clearretrievalfilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_clearretrievalfilter"},{"title":"Idxgiinfoqueue clearstoragefilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_clearstoragefilter"},{"title":"Idxgiinfoqueue clearstoredmessages","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_clearstoredmessages"},{"title":"Idxgiinfoqueue getbreakoncategory","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getbreakoncategory"},{"title":"Idxgiinfoqueue getbreakonid","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getbreakonid"},{"title":"Idxgiinfoqueue getbreakonseverity","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getbreakonseverity"},{"title":"Idxgiinfoqueue getmessage","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getmessage"},{"title":"Idxgiinfoqueue getmessagecountlimit","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getmessagecountlimit"},{"title":"Idxgiinfoqueue getmutedebugoutput","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getmutedebugoutput"},{"title":"Idxgiinfoqueue getnummessagesallowedbystoragefilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getnummessagesallowedbystoragefilter"},{"title":"Idxgiinfoqueue getnummessagesdeniedbystoragefilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getnummessagesdeniedbystoragefilter"},{"title":"Idxgiinfoqueue getnummessagesdiscardedbymessagecountlimit","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getnummessagesdiscardedbymessagecountlimit"},{"title":"Idxgiinfoqueue getnumstoredmessages","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getnumstoredmessages"},{"title":"Idxgiinfoqueue getnumstoredmessagesallowedbyretrievalfilters","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getnumstoredmessagesallowedbyretrievalfilters"},{"title":"Idxgiinfoqueue getretrievalfilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getretrievalfilter"},{"title":"Idxgiinfoqueue getretrievalfilterstacksize","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getretrievalfilterstacksize"},{"title":"Idxgiinfoqueue getstoragefilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getstoragefilter"},{"title":"Idxgiinfoqueue getstoragefilterstacksize","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_getstoragefilterstacksize"},{"title":"Idxgiinfoqueue popretrievalfilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_popretrievalfilter"},{"title":"Idxgiinfoqueue popstoragefilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_popstoragefilter"},{"title":"Idxgiinfoqueue pushcopyofretrievalfilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_pushcopyofretrievalfilter"},{"title":"Idxgiinfoqueue pushcopyofstoragefilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_pushcopyofstoragefilter"},{"title":"Idxgiinfoqueue pushdenyallretrievalfilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_pushdenyallretrievalfilter"},{"title":"Idxgiinfoqueue pushdenyallstoragefilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_pushdenyallstoragefilter"},{"title":"Idxgiinfoqueue pushemptyretrievalfilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_pushemptyretrievalfilter"},{"title":"Idxgiinfoqueue pushemptystoragefilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_pushemptystoragefilter"},{"title":"Idxgiinfoqueue pushretrievalfilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_pushretrievalfilter"},{"title":"Idxgiinfoqueue pushstoragefilter","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_pushstoragefilter"},{"title":"Idxgiinfoqueue setbreakoncategory","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_setbreakoncategory"},{"title":"Idxgiinfoqueue setbreakonid","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_setbreakonid"},{"title":"Idxgiinfoqueue setbreakonseverity","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_setbreakonseverity"},{"title":"Idxgiinfoqueue setmessagecountlimit","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_setmessagecountlimit"},{"title":"Idxgiinfoqueue setmutedebugoutput","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIInfoQueue/methods/idxgiinfoqueue_setmutedebugoutput"}]}]},{"group":"IDXGIObject","pages":[{"title":"Idxgiobject","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIObject/idxgiobject"},{"group":"Methods","pages":[{"title":"Idxgiobject getparent","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIObject/methods/idxgiobject_getparent"},{"title":"Idxgiobject getprivatedata","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIObject/methods/idxgiobject_getprivatedata"},{"title":"Idxgiobject setprivatedata","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIObject/methods/idxgiobject_setprivatedata"},{"title":"Idxgiobject setprivatedatainterface","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIObject/methods/idxgiobject_setprivatedatainterface"}]}]},{"group":"IDXGIOutput","pages":[{"title":"Idxgioutput","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/idxgioutput"},{"group":"Methods","pages":[{"title":"Idxgioutput findclosestmatchingmode","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_findclosestmatchingmode"},{"title":"Idxgioutput getaspectratio","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_getaspectratio"},{"title":"Idxgioutput getdesc","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_getdesc"},{"title":"Idxgioutput getdisplaymodelist","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_getdisplaymodelist"},{"title":"Idxgioutput getdisplaymodelistx","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_getdisplaymodelistx"},{"title":"Idxgioutput getdisplaysurfacedata","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_getdisplaysurfacedata"},{"title":"Idxgioutput getframestatistics","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_getframestatistics"},{"title":"Idxgioutput getgammacontrol","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_getgammacontrol"},{"title":"Idxgioutput getgammacontrolcapabilities","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_getgammacontrolcapabilities"},{"title":"Idxgioutput getrefreshrate","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_getrefreshrate"},{"title":"Idxgioutput releaseownership","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_releaseownership"},{"title":"Idxgioutput setdisplaysurface","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_setdisplaysurface"},{"title":"Idxgioutput setgammacontrol","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_setgammacontrol"},{"title":"Idxgioutput takeownership","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_takeownership"},{"title":"Idxgioutput waitforvblank","href":"/reference/graphics/d3d12_xs/interfaces/IDXGIOutput/methods/idxgioutput_waitforvblank"}]}]},{"group":"IDXGISwapChain","pages":[{"title":"Idxgiswapchain","href":"/reference/graphics/d3d12_xs/interfaces/IDXGISwapChain/idxgiswapchain"}]},{"group":"IDXGISwapChain1","pages":[{"title":"Idxgiswapchain1","href":"/reference/graphics/d3d12_xs/interfaces/IDXGISwapChain1/idxgiswapchain1"}]}]},{"group":"Structs","pages":[{"title":"D3d12 dispatch mesh arguments","href":"/reference/graphics/d3d12_xs/structs/d3d12_dispatch_mesh_arguments"},{"title":"D3d12 feature data d3d12 options10 xs","href":"/reference/graphics/d3d12_xs/structs/d3d12_feature_data_d3d12_options10_xs"},{"title":"D3d12 feature data d3d12 options11 xs","href":"/reference/graphics/d3d12_xs/structs/d3d12_feature_data_d3d12_options11_xs"},{"title":"D3d12 feature data d3d12 options7 xs","href":"/reference/graphics/d3d12_xs/structs/d3d12_feature_data_d3d12_options7_xs"},{"title":"D3d12 feature data d3d12 options8 xs","href":"/reference/graphics/d3d12_xs/structs/d3d12_feature_data_d3d12_options8_xs"},{"title":"D3d12 feature data d3d12 options9 xs","href":"/reference/graphics/d3d12_xs/structs/d3d12_feature_data_d3d12_options9_xs"},{"title":"D3d12 feature data displayable xs","href":"/reference/graphics/d3d12_xs/structs/d3d12_feature_data_displayable_xs"},{"title":"D3d12 feature data protected resource session type count xs","href":"/reference/graphics/d3d12_xs/structs/d3d12_feature_data_protected_resource_session_type_count_xs"},{"title":"D3d12 feature data protected resource session types xs","href":"/reference/graphics/d3d12_xs/structs/d3d12_feature_data_protected_resource_session_types_xs"},{"title":"D3d12 mip region","href":"/reference/graphics/d3d12_xs/structs/d3d12_mip_region"},{"title":"D3d12 protected resource session desc1","href":"/reference/graphics/d3d12_xs/structs/d3d12_protected_resource_session_desc1"},{"title":"D3d12 resource desc1","href":"/reference/graphics/d3d12_xs/structs/d3d12_resource_desc1"},{"title":"D3d12xbox build raytracing acceleration structure batched desc","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_build_raytracing_acceleration_structure_batched_desc"},{"title":"D3d12xbox build raytracing acceleration structure batched desc2","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_build_raytracing_acceleration_structure_batched_desc2"},{"title":"D3d12xbox build raytracing acceleration structure params1","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_build_raytracing_acceleration_structure_params1"},{"title":"D3d12xbox build raytracing acceleration structure params2","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_build_raytracing_acceleration_structure_params2"},{"title":"D3d12xbox build raytracing acceleration structure params3","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_build_raytracing_acceleration_structure_params3"},{"title":"D3d12xbox compute shader launch params","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_compute_shader_launch_params"},{"title":"D3d12xbox compute shader limits desc xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_compute_shader_limits_desc_xs"},{"title":"D3d12xbox create device parameters xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_create_device_parameters_xs"},{"title":"D3d12xbox descriptor pipeline state xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_descriptor_pipeline_state_xs"},{"title":"D3d12xbox deserialize graphics pipeline state xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_deserialize_graphics_pipeline_state_xs"},{"title":"D3d12xbox dispatch mesh x arguments","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_dispatch_mesh_x_arguments"},{"title":"D3d12xbox dispatch rays desc","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_dispatch_rays_desc"},{"title":"D3d12xbox dpbb break batch arguments","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_dpbb_break_batch_arguments"},{"title":"D3d12xbox dpbb state","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_dpbb_state"},{"title":"D3d12xbox flushpipelinex arguments","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_flushpipelinex_arguments"},{"title":"D3d12xbox gpu hardware configuration xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_gpu_hardware_configuration_xs"},{"title":"D3d12xbox graphics shader limits desc xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_graphics_shader_limits_desc_xs"},{"title":"D3d12xbox live debugging amplification shader parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_amplification_shader_parameters"},{"title":"D3d12xbox live debugging any shader parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_any_shader_parameters"},{"title":"D3d12xbox live debugging compute shader parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_compute_shader_parameters"},{"title":"D3d12xbox live debugging domain shader parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_domain_shader_parameters"},{"title":"D3d12xbox live debugging geometry shader parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_geometry_shader_parameters"},{"title":"D3d12xbox live debugging global parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_global_parameters"},{"title":"D3d12xbox live debugging hull shader parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_hull_shader_parameters"},{"title":"D3d12xbox live debugging mesh shader parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_mesh_shader_parameters"},{"title":"D3d12xbox live debugging parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_parameters"},{"title":"D3d12xbox live debugging pixel shader parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_pixel_shader_parameters"},{"title":"D3d12xbox live debugging vertex shader parameters","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_live_debugging_vertex_shader_parameters"},{"title":"D3d12xbox msaa parameters xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_msaa_parameters_xs"},{"title":"D3d12xbox prt lod report desc","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_prt_lod_report_desc"},{"title":"D3d12xbox prt lod report gpu header","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_prt_lod_report_gpu_header"},{"title":"D3d12xbox prt lod report gpu sample","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_prt_lod_report_gpu_sample"},{"title":"D3d12xbox raytracing canonical acceleration structure node","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_raytracing_canonical_acceleration_structure_node"},{"title":"D3d12xbox raytracing canonical fp16 aabb data","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_raytracing_canonical_fp16_aabb_data"},{"title":"D3d12xbox raytracing canonical fp32 aabb data","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_raytracing_canonical_fp32_aabb_data"},{"title":"D3d12xbox raytracing canonical triangle node data","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_raytracing_canonical_triangle_node_data"},{"title":"D3d12xbox raytracing fp16 aabb","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_raytracing_fp16_aabb"},{"title":"D3d12xbox raytracing information","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_raytracing_information"},{"title":"D3d12xbox raytracing information export","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_raytracing_information_export"},{"title":"D3d12xbox raytracing information export table","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_raytracing_information_export_table"},{"title":"D3d12xbox raytracing options","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_raytracing_options"},{"title":"D3d12xbox resource barrier summary actions","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_resource_barrier_summary_actions"},{"title":"D3d12xbox sampler desc xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_sampler_desc_xs"},{"title":"D3d12xbox serialize graphics pipeline state xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_serialize_graphics_pipeline_state_xs"},{"title":"D3d12xbox shader resource view desc xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_shader_resource_view_desc_xs"},{"title":"D3d12xbox shader symbol","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_shader_symbol"},{"title":"D3d12xbox shader symbol list","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_shader_symbol_list"},{"title":"D3d12xbox shading rate settings","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_shading_rate_settings"},{"title":"D3d12xbox shading rate settings cmask vrs hint mode","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_shading_rate_settings_cmask_vrs_hint_mode"},{"title":"D3d12xbox shading rate settings combiners","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_shading_rate_settings_combiners"},{"title":"D3d12xbox shading rate settings htile mode","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_shading_rate_settings_htile_mode"},{"title":"D3d12xbox shading rate settings pixel center offsets","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_shading_rate_settings_pixel_center_offsets"},{"title":"D3d12xbox sync params","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_sync_params"},{"title":"D3d12xbox virtual memory configuration","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_virtual_memory_configuration"},{"title":"D3d12xbox xdxr stream desc","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_xdxr_stream_desc"},{"title":"D3d12xbox zero memory buffers","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_zero_memory_buffers"},{"title":"D3d12xbox zero memory range","href":"/reference/graphics/d3d12_xs/structs/d3d12xbox_zero_memory_range"},{"title":"D3d12xboxputbuffer xs","href":"/reference/graphics/d3d12_xs/structs/d3d12xboxputbuffer_xs"},{"title":"DXGI_ADAPTER_DESC2 (XBOX Series consoles)","description":"Describes an adapter (or video card) using DXGI 1.2.","sidebarTitle":"DXGI_ADAPTER_DESC2","hidden":false,"href":"/reference/graphics/d3d12_xs/structs/dxgi_adapter_desc2","hiddenSetByFrontmatter":true},{"title":"Dxgi mode desc","href":"/reference/graphics/d3d12_xs/structs/dxgi_mode_desc"},{"title":"Dxgix frame statistics","href":"/reference/graphics/d3d12_xs/structs/dxgix_frame_statistics"},{"title":"Dxgix presentarray parameters","href":"/reference/graphics/d3d12_xs/structs/dxgix_presentarray_parameters"},{"title":"Dxgixbox mode desc","href":"/reference/graphics/d3d12_xs/structs/dxgixbox_mode_desc"}]}]},{"group":"dxcapi","pages":[{"group":"Interfaces","pages":[{"group":"Idxcxboxbackenddebuginfo","pages":[{"group":"Methods","pages":[{"title":"Idxcxboxbackenddebuginfo getdebuginfoforstage","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxbackenddebuginfo/methods/idxcxboxbackenddebuginfo_getdebuginfoforstage"},{"title":"Idxcxboxbackenddebuginfo getnumstages","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxbackenddebuginfo/methods/idxcxboxbackenddebuginfo_getnumstages"},{"title":"Idxcxboxbackenddebuginfo getstage","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxbackenddebuginfo/methods/idxcxboxbackenddebuginfo_getstage"},{"title":"Idxcxboxbackenddebuginfo load","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxbackenddebuginfo/methods/idxcxboxbackenddebuginfo_load"}]}]},{"group":"Idxcxboxcontainer","pages":[{"group":"Methods","pages":[{"title":"Idxcxboxcontainer getnumshaders","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxcontainer/methods/idxcxboxcontainer_getnumshaders"},{"title":"Idxcxboxcontainer getshader","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxcontainer/methods/idxcxboxcontainer_getshader"},{"title":"Idxcxboxcontainer load","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxcontainer/methods/idxcxboxcontainer_load"}]}]},{"group":"Idxcxboxhwshader","pages":[{"group":"Methods","pages":[{"title":"Idxcxboxhwshader getcode","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxhwshader/methods/idxcxboxhwshader_getcode"},{"title":"Idxcxboxhwshader getdebuginfo","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxhwshader/methods/idxcxboxhwshader_getdebuginfo"},{"title":"Idxcxboxhwshader getshaderstats","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxhwshader/methods/idxcxboxhwshader_getshaderstats"},{"title":"Idxcxboxhwshader getstagename","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxhwshader/methods/idxcxboxhwshader_getstagename"}]}]},{"group":"Idxcxboxshaderstats","pages":[{"group":"Methods","pages":[{"title":"Idxcxboxshaderstats getshaderstats","href":"/reference/graphics/dxcapi_x/interfaces/idxcxboxshaderstats/methods/idxcxboxshaderstats_getshaderstats"}]}]}]}]}]},{"group":"Input API reference","pages":[{"title":"Input API reference","description":"Input API reference for the Microsoft Game Development Kit (GDK), including the GameInput API, XInputOnGameInput compatibility layer, and deprecated members.","sidebarTitle":"Input API reference","href":"/reference/input/gc-reference-input-toc"},{"group":"GameInput","pages":[{"title":"GameInput","description":"GameInput","sidebarTitle":"GameInput","href":"/reference/input/gameinput/gameinput_members"},{"group":"Deprecated","pages":[{"group":"Enums","pages":[{"title":"GameInputBatteryStatus","description":"GameInputBatteryStatus","sidebarTitle":"GameInputBatteryStatus","href":"/reference/input/gameinput/deprecated/enums/gameinputbatterystatus"},{"title":"GameInputDeviceCapabilities","description":"GameInputDeviceCapabilities","sidebarTitle":"GameInputDeviceCapabilities","href":"/reference/input/gameinput/deprecated/enums/gameinputdevicecapabilities"},{"title":"GameInputLocation","description":"GameInputLocation","sidebarTitle":"GameInputLocation","href":"/reference/input/gameinput/deprecated/enums/gameinputlocation"},{"title":"GameInputMotionAccuracy","description":"GameInputMotionAccuracy","sidebarTitle":"GameInputMotionAccuracy","href":"/reference/input/gameinput/deprecated/enums/gameinputmotionaccuracy"},{"title":"GameInputRawDeviceItemCollectionKind","description":"GameInputRawDeviceItemCollectionKind","sidebarTitle":"GameInputRawDeviceItemCollectionKind","href":"/reference/input/gameinput/deprecated/enums/gameinputrawdeviceitemcollectionkind"},{"title":"GameInputRawDevicePhysicalUnitKind","description":"GameInputRawDevicePhysicalUnitKind","sidebarTitle":"GameInputRawDevicePhysicalUnitKind","href":"/reference/input/gameinput/deprecated/enums/gameinputrawdevicephysicalunitkind"},{"title":"GameInputRawDeviceReportItemFlags","description":"GameInputRawDeviceReportItemFlags","sidebarTitle":"GameInputRawDeviceReportItemFlags","href":"/reference/input/gameinput/deprecated/enums/gameinputrawdevicereportitemflags"},{"title":"GameInputTouchShape","description":"GameInputTouchShape","sidebarTitle":"GameInputTouchShape","href":"/reference/input/gameinput/deprecated/enums/gameinputtouchshape"},{"title":"GameInputUiNavigationButtons","description":"GameInputUiNavigationButtons","sidebarTitle":"GameInputUiNavigationButtons","href":"/reference/input/gameinput/deprecated/enums/gameinputuinavigationbuttons"}]},{"group":"Functions","pages":[{"title":"GameInputGuidButtonCallback","description":"GameInputGuidButtonCallback","sidebarTitle":"GameInputGuidButtonCallback","href":"/reference/input/gameinput/deprecated/functions/gameinputguidebuttoncallback"}]},{"group":"Interfaces","pages":[{"group":"Igameinput","pages":[{"group":"Methods","pages":[{"title":"IGameInput::EnableOemDeviceSupport","description":"IGameInput::EnableOemDeviceSupport","sidebarTitle":"IGameInput::EnableOemDeviceSupport","href":"/reference/input/gameinput/deprecated/interfaces/igameinput/methods/igameinput_enableoemdevicesupport"},{"title":"IGameInput::FindDeviceFromObject","description":"IGameInput::FindDeviceFromObject","sidebarTitle":"IGameInput::FindDeviceFromObject","href":"/reference/input/gameinput/deprecated/interfaces/igameinput/methods/igameinput_finddevicefromobject"},{"title":"IGameInput::FindDeviceFromPlatformHandle","description":"IGameInput::FindDeviceFromPlatformHandle","sidebarTitle":"IGameInput::FindDeviceFromPlatformHandle","href":"/reference/input/gameinput/deprecated/interfaces/igameinput/methods/igameinput_finddevicefromplatformhandle"},{"title":"IGameInput::GetTemporalReading","description":"IGameInput::GetTemporalReading","sidebarTitle":"IGameInput::GetTemporalReading","href":"/reference/input/gameinput/deprecated/interfaces/igameinput/methods/igameinput_gettemporalreading"},{"title":"IGameInput::RegisterGuideButtonCallback","description":"IGameInput::RegisterGuideButtonCallback","sidebarTitle":"IGameInput::RegisterGuideButtonCallback","href":"/reference/input/gameinput/deprecated/interfaces/igameinput/methods/igameinput_registerguidebuttoncallback"}]}]},{"group":"Igameinputdevice","pages":[{"group":"Methods","pages":[{"title":"IGameInputDevice::AcquireExclusiveRawDeviceAccess","description":"IGameInputDevice::AcquireExclusiveRawDeviceAccess","sidebarTitle":"IGameInputDevice::AcquireExclusiveRawDeviceAccess","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_acquireexclusiverawdeviceaccess"},{"title":"IGameInputDevice::ExecuteRawDeviceIoControl","description":"IGameInputDevice::ExecuteRawDeviceIoControl","sidebarTitle":"IGameInputDevice::ExecuteRawDeviceIoControl","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_executerawdeviceiocontrol"},{"title":"IGameInputDevice::GetBatteryState","description":"IGameInputDevice::GetBatteryState","sidebarTitle":"IGameInputDevice::GetBatteryState","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_getbatterystate"},{"title":"IGameInputDevice::GetRawDeviceFeature","description":"IGameInputDevice::GetRawDeviceFeature","sidebarTitle":"IGameInputDevice::GetRawDeviceFeature","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_getrawdevicefeature"},{"title":"IGameInputDevice::PowerOff","description":"IGameInputDevice::PowerOff","sidebarTitle":"IGameInputDevice::PowerOff","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_poweroff"},{"title":"IGameInputDevice::ReleaseExclusiveRawDeviceAccess","description":"IGameInputDevice::ReleaseExclusiveRawDeviceAccess","sidebarTitle":"IGameInputDevice::ReleaseExclusiveRawDeviceAccess","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_releaseexclusiverawdeviceaccess"},{"title":"IGameInputDevice::SendInputSynchronizationHint","description":"IGameInputDevice::SendInputSynchronizationHint","sidebarTitle":"IGameInputDevice::SendInputSynchronizationHint","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_sendinputsynchronizationhint"},{"title":"IGameInputDevice::SetHapticMotorState","description":"IGameInputDevice::SetHapticMotorState","sidebarTitle":"IGameInputDevice::SetHapticMotorState","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_sethapticmotorstate"},{"title":"IGameInputDevice::SetInputSynchronizationState","description":"IGameInputDevice::SetInputSynchronizationState","sidebarTitle":"IGameInputDevice::SetInputSynchronizationState","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_setinputsynchronizationstate"},{"title":"IGameInputDevice::SetRawDeviceFeature","description":"IGameInputDevice::SetRawDeviceFeature","sidebarTitle":"IGameInputDevice::SetRawDeviceFeature","href":"/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_setrawdevicefeature"}]}]},{"group":"Igameinputreading","pages":[{"group":"Methods","pages":[{"title":"IGameInputReading::GetMotionState","description":"IGameInputReading::GetMotionState","sidebarTitle":"IGameInputReading::GetMotionState","href":"/reference/input/gameinput/deprecated/interfaces/igameinputreading/methods/igameinputreading_getmotionstate"},{"title":"IGameInputReading::GetTouchCount","description":"IGameInputReading::GetTouchCount","sidebarTitle":"IGameInputReading::GetTouchCount","href":"/reference/input/gameinput/deprecated/interfaces/igameinputreading/methods/igameinputreading_gettouchcount"},{"title":"IGameInputReading::GetTouchState","description":"IGameInputReading::GetTouchState","sidebarTitle":"IGameInputReading::GetTouchState","href":"/reference/input/gameinput/deprecated/interfaces/igameinputreading/methods/igameinputreading_gettouchstate"},{"title":"IGameInputReading::GetUiNavigationState","description":"IGameInputReading::GetUiNavigationState","sidebarTitle":"IGameInputReading::GetUiNavigationState","href":"/reference/input/gameinput/deprecated/interfaces/igameinputreading/methods/igameinputreading_getuinavigationstate"}]}]}]},{"group":"Structs","pages":[{"title":"GameInputBatteryState","description":"GameInputBatteryState","sidebarTitle":"GameInputBatteryState","href":"/reference/input/gameinput/deprecated/structs/gameinputbatterystate"},{"title":"GameInputControllerAxisInfo","description":"GameInputControllerAxisInfo","sidebarTitle":"GameInputControllerAxisInfo","href":"/reference/input/gameinput/deprecated/structs/gameinputcontrolleraxisinfo"},{"title":"GameInputControllerButtonInfo","description":"GameInputControllerButtonInfo","sidebarTitle":"GameInputControllerButtonInfo","href":"/reference/input/gameinput/deprecated/structs/gameinputcontrollerbuttoninfo"},{"title":"GameInputHapticFeedbackMotorInfo","description":"GameInputHapticFeedbackMotorInfo","sidebarTitle":"GameInputHapticFeedbackMotorInfo","href":"/reference/input/gameinput/deprecated/structs/gameinputhapticfeedbackmotorinfo"},{"title":"GameInputHapticFeedbackParams","description":"GameInputHapticFeedbackParams","sidebarTitle":"GameInputHapticFeedbackParams","href":"/reference/input/gameinput/deprecated/structs/gameinputhapticfeedbackparams"},{"title":"GameInputHapticWaveformInfo","description":"GameInputHapticWaveformInfo","sidebarTitle":"GameInputHapticWaveformInfo","href":"/reference/input/gameinput/deprecated/structs/gameinputhapticwaveforminfo"},{"title":"GameInputMotionInfo","description":"GameInputMotionInfo","sidebarTitle":"GameInputMotionInfo","href":"/reference/input/gameinput/deprecated/structs/gameinputmotioninfo"},{"title":"GameInputMotionState","description":"GameInputMotionState","sidebarTitle":"GameInputMotionState","href":"/reference/input/gameinput/deprecated/structs/gameinputmotionstate"},{"title":"GameInputRawDeviceItemCollectionInfo","description":"GameInputRawDeviceItemCollectionInfo","sidebarTitle":"GameInputRawDeviceItemCollectionInfo","href":"/reference/input/gameinput/deprecated/structs/gameinputrawdeviceitemcollectioninfo"},{"title":"GameInputRawDeviceReportItemInfo","description":"GameInputRawDeviceReportItemInfo","sidebarTitle":"GameInputRawDeviceReportItemInfo","href":"/reference/input/gameinput/deprecated/structs/gameinputrawdevicereportiteminfo"},{"title":"GameInputString","description":"GameInputString","sidebarTitle":"GameInputString","href":"/reference/input/gameinput/deprecated/structs/gameinputstring"},{"title":"GameInputTouchSensorInfo","description":"GameInputTouchSensorInfo","sidebarTitle":"GameInputTouchSensorInfo","href":"/reference/input/gameinput/deprecated/structs/gameinputtouchsensorinfo"},{"title":"GameInputTouchState","description":"GameInputTouchState","sidebarTitle":"GameInputTouchState","href":"/reference/input/gameinput/deprecated/structs/gameinputtouchstate"},{"title":"GameInputUiNavigationInfo","description":"GameInputUiNavigationInfo","sidebarTitle":"GameInputUiNavigationInfo","href":"/reference/input/gameinput/deprecated/structs/gameinputuinavigationinfo"},{"title":"GameInputUiNavigationState","description":"GameInputUiNavigationState","sidebarTitle":"GameInputUiNavigationState","href":"/reference/input/gameinput/deprecated/structs/gameinputuinavigationstate"}]}]},{"group":"Enums","pages":[{"title":"GameInputArcadeStickButtons","description":"GameInputArcadeStickButtons","sidebarTitle":"GameInputArcadeStickButtons","href":"/reference/input/gameinput/enums/gameinputarcadestickbuttons"},{"title":"GameInputDeviceFamily","description":"GameInputDeviceFamily","sidebarTitle":"GameInputDeviceFamily","href":"/reference/input/gameinput/enums/gameinputdevicefamily"},{"title":"GameInputDeviceStatus","description":"GameInputDeviceStatus","sidebarTitle":"GameInputDeviceStatus","href":"/reference/input/gameinput/enums/gameinputdevicestatus"},{"title":"GameInputElementKind","description":"GameInputElementKind","sidebarTitle":"GameInputElementKind","href":"/reference/input/gameinput/enums/gameinputelementkind"},{"title":"GameInputEnumerationKind","description":"GameInputEnumerationKind","sidebarTitle":"GameInputEnumerationKind","href":"/reference/input/gameinput/enums/gameinputenumerationkind"},{"title":"GameInputFeedbackAxes","description":"GameInputFeedbackAxes","sidebarTitle":"GameInputFeedbackAxes","href":"/reference/input/gameinput/enums/gameinputfeedbackaxes"},{"title":"GameInputFeedbackEffectState","description":"GameInputFeedbackEffectState","sidebarTitle":"GameInputFeedbackEffectState","href":"/reference/input/gameinput/enums/gameinputfeedbackeffectstate"},{"title":"GameInputFlightStickAxes","description":"GameInputFlightStickAxes","sidebarTitle":"GameInputFlightStickAxes","href":"/reference/input/gameinput/enums/gameinputflightstickaxes"},{"title":"GameInputFlightStickButtons","description":"GameInputFlightStickButtons","sidebarTitle":"GameInputFlightStickButtons","href":"/reference/input/gameinput/enums/gameinputflightstickbuttons"},{"title":"GameInputFocusPolicy","description":"GameInputFocusPolicy","sidebarTitle":"GameInputFocusPolicy","href":"/reference/input/gameinput/enums/gameinputfocuspolicy"},{"title":"GameInputForceFeedbackEffectKind","description":"GameInputForceFeedbackEffectKind","sidebarTitle":"GameInputForceFeedbackEffectKind","href":"/reference/input/gameinput/enums/gameinputforcefeedbackeffectkind"},{"title":"GameInputGamepadAxes","description":"GameInputGamepadAxes","sidebarTitle":"GameInputGamepadAxes","href":"/reference/input/gameinput/enums/gameinputgamepadaxes"},{"title":"GameInputGamepadButtons","description":"GameInputGamepadButtons","sidebarTitle":"GameInputGamepadButtons","href":"/reference/input/gameinput/enums/gameinputgamepadbuttons"},{"title":"GameInputKeyboardKind","description":"GameInputKeyboardKind","sidebarTitle":"GameInputKeyboardKind","href":"/reference/input/gameinput/enums/gameinputkeyboardkind"},{"title":"GameInputKind","description":"GameInputKind","sidebarTitle":"GameInputKind","href":"/reference/input/gameinput/enums/gameinputkind"},{"title":"GameInputLabel","description":"GameInputLabel","sidebarTitle":"GameInputLabel","href":"/reference/input/gameinput/enums/gameinputlabel"},{"title":"GameInputMouseButtons","description":"GameInputMouseButtons","sidebarTitle":"GameInputMouseButtons","href":"/reference/input/gameinput/enums/gameinputmousebuttons"},{"title":"GameInputMousePositions","description":"GameInputMousePositions","sidebarTitle":"GameInputMousePositions","href":"/reference/input/gameinput/enums/gameInputmousepositions"},{"title":"GameInputRacingWheelAxes","description":"GameInputRacingWheelAxes","sidebarTitle":"GameInputRacingWheelAxes","href":"/reference/input/gameinput/enums/gameinputracingwheelaxes"},{"title":"GameInputRacingWheelButtons","description":"GameInputRacingWheelButtons","sidebarTitle":"GameInputRacingWheelButtons","href":"/reference/input/gameinput/enums/gameinputracingwheelbuttons"},{"title":"GameInputRawDeviceReportKind","description":"GameInputRawDeviceReportKind","sidebarTitle":"GameInputRawDeviceReportKind","href":"/reference/input/gameinput/enums/gameinputrawdevicereportkind"},{"title":"GameInputRumbleMotors","description":"GameInputRumbleMotors","sidebarTitle":"GameInputRumbleMotors","href":"/reference/input/gameinput/enums/gameinputrumblemotors"},{"title":"GameInputSensorAccuracy","description":"GameInputSensorAccuracy","sidebarTitle":"GameInputSensorAccuracy","href":"/reference/input/gameinput/enums/gameinputsensoraccuracy"},{"title":"GameInputSensorsKind","description":"GameInputSensorsKind","sidebarTitle":"GameInputSensorsKind","href":"/reference/input/gameinput/enums/gameinputsensorskind"},{"title":"GameInputSwitchKind","description":"GameInputSwitchKind","sidebarTitle":"GameInputSwitchKind","href":"/reference/input/gameinput/enums/gameinputswitchkind"},{"title":"GameInputSwitchPosition","description":"GameInputSwitchPosition","sidebarTitle":"GameInputSwitchPosition","href":"/reference/input/gameinput/enums/gameinputswitchposition"},{"title":"GameInputSystemButtons","description":"GameInputSystemButtons","sidebarTitle":"GameInputSystemButtons","href":"/reference/input/gameinput/enums/gameinputsystembuttons"}]},{"group":"Functions","pages":[{"title":"GameInputCreate","description":"GameInputCreate","sidebarTitle":"GameInputCreate","href":"/reference/input/gameinput/functions/gameinputcreate"},{"title":"GameInputDeviceCallback","description":"GameInputDeviceCallback","sidebarTitle":"GameInputDeviceCallback","href":"/reference/input/gameinput/functions/gameinputdevicecallback"},{"title":"GameInputKeyboardLayoutCallback","description":"GameInputKeyboardLayoutCallback","sidebarTitle":"GameInputKeyboardLayoutCallback","href":"/reference/input/gameinput/functions/gameinputkeyboardlayoutcallback"},{"title":"GameInputReadingCallback","description":"GameInputReadingCallback","sidebarTitle":"GameInputReadingCallback","href":"/reference/input/gameinput/functions/gameinputreadingcallback"},{"title":"GameInputSystemButtonCallback","description":"GameInputSystemButtonCallback","sidebarTitle":"GameInputSystemButtonCallback","href":"/reference/input/gameinput/functions/gameinputsystembuttoncallback"}]},{"group":"Interfaces","pages":[{"group":"Igameinput","pages":[{"title":"IGameInput","description":"IGameInput","sidebarTitle":"IGameInput","href":"/reference/input/gameinput/interfaces/igameinput/igameinput"},{"group":"Methods","pages":[{"title":"IGameInput::CreateAggregateDevice","description":"IGameInput::CreateAggregateDevice","sidebarTitle":"IGameInput::CreateAggregateDevice","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_createaggregatedevice"},{"title":"IGameInput::CreateDispatcher","description":"IGameInput::CreateDispatcher","sidebarTitle":"IGameInput::CreateDispatcher","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_createdispatcher"},{"title":"IGameInput::DisableAggregateDevice","description":"IGameInput::DisableAggregateDevice","sidebarTitle":"IGameInput::DisableAggregateDevice","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_disableaggregatedevice"},{"title":"IGameInput::FindDeviceFromId","description":"IGameInput::FindDeviceFromId","sidebarTitle":"IGameInput::FindDeviceFromId","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_finddevicefromid"},{"title":"IGameInput::FindDeviceFromPlatformString","description":"IGameInput::FindDeviceFromPlatformString","sidebarTitle":"IGameInput::FindDeviceFromPlatformString","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_finddevicefromplatformstring"},{"title":"IGameInput::GetCurrentReading","description":"IGameInput::GetCurrentReading","sidebarTitle":"IGameInput::GetCurrentReading","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_getcurrentreading"},{"title":"IGameInput::GetCurrentTimestamp","description":"IGameInput::GetCurrentTimestamp","sidebarTitle":"IGameInput::GetCurrentTimestamp","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_getcurrenttimestamp"},{"title":"IGameInput::GetNextReading","description":"IGameInput::GetNextReading","sidebarTitle":"IGameInput::GetNextReading","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_getnextreading"},{"title":"IGameInput::GetPreviousReading","description":"IGameInput::GetPreviousReading","sidebarTitle":"IGameInput::GetPreviousReading","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_getpreviousreading"},{"title":"IGameInput::RegisterDeviceCallback","description":"IGameInput::RegisterDeviceCallback","sidebarTitle":"IGameInput::RegisterDeviceCallback","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_registerdevicecallback"},{"title":"IGameInput::RegisterKeyboardLayoutCallback","description":"IGameInput::RegisterKeyboardLayoutCallback","sidebarTitle":"IGameInput::RegisterKeyboardLayoutCallback","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_registerkeyboardlayoutcallback"},{"title":"IGameInput::RegisterReadingCallback","description":"IGameInput::RegisterReadingCallback","sidebarTitle":"IGameInput::RegisterReadingCallback","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_registerreadingcallback"},{"title":"IGameInput::RegisterSystemButtonCallback","description":"IGameInput::RegisterSystemButtonCallback","sidebarTitle":"IGameInput::RegisterSystemButtonCallback","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_registersystembuttoncallback"},{"title":"IGameInput::SetFocusPolicy","description":"IGameInput::SetFocusPolicy","sidebarTitle":"IGameInput::SetFocusPolicy","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_setfocuspolicy"},{"title":"IGameInput::StopCallback","description":"IGameInput::StopCallback","sidebarTitle":"IGameInput::StopCallback","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_stopcallback"},{"title":"IGameInput::UnregisterCallback","description":"IGameInput::UnregisterCallback","sidebarTitle":"IGameInput::UnregisterCallback","href":"/reference/input/gameinput/interfaces/igameinput/methods/igameinput_unregistercallback"}]}]},{"group":"Igameinputdevice","pages":[{"title":"IGameInputDevice","description":"IGameInputDevice","sidebarTitle":"IGameInputDevice","href":"/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice"},{"group":"Methods","pages":[{"title":"CreateForceFeedbackEffect","description":"CreateForceFeedbackEffect","sidebarTitle":"CreateForceFeedbackEffect","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_createforcefeedbackeffect"},{"title":"CreateInputMapper","description":"CreateInputMapper","sidebarTitle":"CreateInputMapper","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_createinputmapper"},{"title":"IGameInputDevice::CreateRawDeviceReport","description":"IGameInputDevice::CreateRawDeviceReport","sidebarTitle":"IGameInputDevice::CreateRawDeviceReport","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_createrawdevicereport"},{"title":"DirectInputEscape","description":"DirectInputEscape","sidebarTitle":"DirectInputEscape","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_directinputescape"},{"title":"GetDeviceInfo","description":"GetDeviceInfo","sidebarTitle":"GetDeviceInfo","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getdeviceinfo"},{"title":"GetDeviceStatus","description":"GetDeviceStatus","sidebarTitle":"GetDeviceStatus","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getdevicestatus"},{"title":"GetExtraAxisCount","description":"GetExtraAxisCount","sidebarTitle":"GetExtraAxisCount","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getextraaxiscount"},{"title":"GetExtraAxisIndexes","description":"GetExtraAxisIndexes","sidebarTitle":"GetExtraAxisIndexes","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getextraaxisindexes"},{"title":"GetExtraButtonCount","description":"GetExtraButtonCount","sidebarTitle":"GetExtraButtonCount","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getextrabuttoncount"},{"title":"GetExtraButtonIndexes","description":"GetExtraButtonIndexes","sidebarTitle":"GetExtraButtonIndexes","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getextrabuttonindexes"},{"title":"GetHapticInfo","description":"GetHapticInfo","sidebarTitle":"GetHapticInfo","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_gethapticinfo"},{"title":"IsForceFeedbackMotorPoweredOn","description":"IsForceFeedbackMotorPoweredOn","sidebarTitle":"IsForceFeedbackMotorPoweredOn","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_isforcefeedbackmotorpoweredon"},{"title":"IGameInputDevice::SendRawDeviceOutput","description":"IGameInputDevice::SendRawDeviceOutput","sidebarTitle":"IGameInputDevice::SendRawDeviceOutput","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_sendrawdeviceoutput"},{"title":"IGameInputDevice::SetForceFeedbackMotorGain","description":"IGameInputDevice::SetForceFeedbackMotorGain","sidebarTitle":"IGameInputDevice::SetForceFeedbackMotorGain","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setforcefeedbackmotorgain"},{"title":"SetRumbleState","description":"SetRumbleState","sidebarTitle":"SetRumbleState","href":"/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_setrumblestate"}]}]},{"group":"IGameInputDispatcher","pages":[{"title":"IGameInputDispatcher","description":"IGameInputDispatcher","sidebarTitle":"IGameInputDispatcher","href":"/reference/input/gameinput/interfaces/IGameInputDispatcher/igameinputdispatcher"},{"group":"Methods","pages":[{"title":"IGameInputDispatcher::Dispatch","description":"IGameInputDispatcher::Dispatch","sidebarTitle":"IGameInputDispatcher::Dispatch","href":"/reference/input/gameinput/interfaces/IGameInputDispatcher/methods/igameinputdispatcher_dispatch"},{"title":"IGameInputDispatcher::OpenWaitHandle","description":"IGameInputDispatcher::OpenWaitHandle","sidebarTitle":"IGameInputDispatcher::OpenWaitHandle","href":"/reference/input/gameinput/interfaces/IGameInputDispatcher/methods/igameinputdispatcher_openwaithandle"}]}]},{"group":"Igameinputforcefeedbackeffect","pages":[{"title":"IGameInputForceFeedbackEffect","description":"IGameInputForceFeedbackEffect","sidebarTitle":"IGameInputForceFeedbackEffect","href":"/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/igameinputforcefeedbackeffect"},{"group":"Methods","pages":[{"title":"IGameInputForceFeedbackEffect::GetDevice","description":"IGameInputForceFeedbackEffect::GetDevice","sidebarTitle":"IGameInputForceFeedbackEffect::GetDevice","href":"/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_getdevice"},{"title":"IGameInputForceFeedbackEffect::GetGain","description":"IGameInputForceFeedbackEffect::GetGain","sidebarTitle":"IGameInputForceFeedbackEffect::GetGain","href":"/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_getgain"},{"title":"IGameInputForceFeedbackEffect::GetMotorIndex","description":"IGameInputForceFeedbackEffect::GetMotorIndex","sidebarTitle":"IGameInputForceFeedbackEffect::GetMotorIndex","href":"/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_getmotorindex"},{"title":"IGameInputForceFeedbackEffect::GetParams","description":"IGameInputForceFeedbackEffect::GetParams","sidebarTitle":"IGameInputForceFeedbackEffect::GetParams","href":"/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_getparams"},{"title":"IGameInputForceFeedbackEffect::GetState","description":"IGameInputForceFeedbackEffect::GetState","sidebarTitle":"IGameInputForceFeedbackEffect::GetState","href":"/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_getstate"},{"title":"IGameInputForceFeedbackEffect::SetGain","description":"IGameInputForceFeedbackEffect::SetGain","sidebarTitle":"IGameInputForceFeedbackEffect::SetGain","href":"/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_setgain"},{"title":"IGameInputForceFeedbackEffect::SetParams","description":"IGameInputForceFeedbackEffect::SetParams","sidebarTitle":"IGameInputForceFeedbackEffect::SetParams","href":"/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_setparams"},{"title":"IGameInputForceFeedbackEffect::SetState","description":"IGameInputForceFeedbackEffect::SetState","sidebarTitle":"IGameInputForceFeedbackEffect::SetState","href":"/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_setstate"}]}]},{"group":"Igameinputmapper","pages":[{"title":"IGameInputMapper","description":"IGameInputMapper","sidebarTitle":"IGameInputMapper","href":"/reference/input/gameinput/interfaces/igameinputmapper/igameinputmapper"},{"group":"Methods","pages":[{"title":"IGameInputMapper::GetArcadeStickButtonMappingInfo","description":"IGameInputMapper::GetArcadeStickButtonMappingInfo","sidebarTitle":"IGameInputMapper::GetArcadeStickButtonMappingInfo","href":"/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getarcadestickbuttonmappinginfo"},{"title":"IGameInputMapper::GetFlightStickAxisMappingInfo","description":"IGameInputMapper::GetFlightStickAxisMappingInfo","sidebarTitle":"IGameInputMapper::GetFlightStickAxisMappingInfo","href":"/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getflightstickaxismappinginfo"},{"title":"IGameInputMapper::GetFlightStickButtonMappingInfo","description":"IGameInputMapper::GetFlightStickButtonMappingInfo","sidebarTitle":"IGameInputMapper::GetFlightStickButtonMappingInfo","href":"/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getflightstickbuttonmappinginfo"},{"title":"IGameInputMapper::GetGamepadAxisMappingInfo","description":"IGameInputMapper::GetGamepadAxisMappingInfo","sidebarTitle":"IGameInputMapper::GetGamepadAxisMappingInfo","href":"/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getgamepadaxismappinginfo"},{"title":"IGameInputMapper::GetGamepadButtonMapping","description":"IGameInputMapper::GetGamepadButtonMapping","sidebarTitle":"IGameInputMapper::GetGamepadButtonMapping","href":"/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getgamepadbuttonmappinginfo"},{"title":"IGameInputMapper::GetRacingWheelAxisMappingInfo","description":"IGameInputMapper::GetRacingWheelAxisMappingInfo","sidebarTitle":"IGameInputMapper::GetRacingWheelAxisMappingInfo","href":"/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getracingwheelaxismappinginfo"},{"title":"IGameInputMapper::GetRacingWheelButtonMappingInfo","description":"IGameInputMapper::GetRacingWheelButtonMappingInfo","sidebarTitle":"IGameInputMapper::GetRacingWheelButtonMappingInfo","href":"/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getracingwheelbuttonmappinginfo"}]}]},{"group":"Igameinputrawdevicereport","pages":[{"title":"IGameInputRawDeviceReport","description":"IGameInputRawDeviceReport","sidebarTitle":"IGameInputRawDeviceReport","href":"/reference/input/gameinput/interfaces/igameinputrawdevicereport/igameinputrawdevicereport"},{"group":"Methods","pages":[{"title":"IGameInputRawDeviceReport::GetDevice","description":"IGameInputRawDeviceReport::GetDevice","sidebarTitle":"IGameInputRawDeviceReport::GetDevice","href":"/reference/input/gameinput/interfaces/igameinputrawdevicereport/methods/igameinputrawdevicereport_getdevice"},{"title":"IGameInputRawDeviceReport::GetRawData","description":"IGameInputRawDeviceReport::GetRawData","sidebarTitle":"IGameInputRawDeviceReport::GetRawData","href":"/reference/input/gameinput/interfaces/igameinputrawdevicereport/methods/igameinputrawdevicereport_getrawdata"},{"title":"IGameInputRawDeviceReport::GetRawDataSize","description":"IGameInputRawDeviceReport::GetRawDataSize","sidebarTitle":"IGameInputRawDeviceReport::GetRawDataSize","href":"/reference/input/gameinput/interfaces/igameinputrawdevicereport/methods/igameinputrawdevicereport_getrawdatasize"},{"title":"IGameInputRawDeviceReport::GetReportInfo","description":"IGameInputRawDeviceReport::GetReportInfo","sidebarTitle":"IGameInputRawDeviceReport::GetReportInfo","href":"/reference/input/gameinput/interfaces/igameinputrawdevicereport/methods/igameinputrawdevicereport_getreportinfo"},{"title":"IGameInputRawDeviceReport::SetRawData","description":"IGameInputRawDeviceReport::SetRawData","sidebarTitle":"IGameInputRawDeviceReport::SetRawData","href":"/reference/input/gameinput/interfaces/igameinputrawdevicereport/methods/igameinputrawdevicereport_setrawdata"}]}]},{"group":"Igameinputreading","pages":[{"title":"IGameInputReading","description":"IGameInputReading","sidebarTitle":"IGameInputReading","href":"/reference/input/gameinput/interfaces/igameinputreading/igameinputreading"},{"group":"Methods","pages":[{"title":"IGameInputReading::GetArcadeStickState","description":"IGameInputReading::GetArcadeStickState","sidebarTitle":"IGameInputReading::GetArcadeStickState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getarcadestickstate"},{"title":"IGameInputReading::GetControllerAxisCount","description":"IGameInputReading::GetControllerAxisCount","sidebarTitle":"IGameInputReading::GetControllerAxisCount","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getcontrolleraxiscount"},{"title":"IGameInputReading::GetControllerAxisState","description":"IGameInputReading::GetControllerAxisState","sidebarTitle":"IGameInputReading::GetControllerAxisState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getcontrolleraxisstate"},{"title":"IGameInputReading::GetControllerButtonCount","description":"IGameInputReading::GetControllerButtonCount","sidebarTitle":"IGameInputReading::GetControllerButtonCount","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getcontrollerbuttoncount"},{"title":"IGameInputReading::GetControllerButtonState","description":"IGameInputReading::GetControllerButtonState","sidebarTitle":"IGameInputReading::GetControllerButtonState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getcontrollerbuttonstate"},{"title":"IGameInputReading::GetControllerSwitchCount","description":"IGameInputReading::GetControllerSwitchCount","sidebarTitle":"IGameInputReading::GetControllerSwitchCount","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getcontrollerswitchcount"},{"title":"IGameInputReading::GetControllerSwitchState","description":"IGameInputReading::GetControllerSwitchState","sidebarTitle":"IGameInputReading::GetControllerSwitchState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getcontrollerswitchstate"},{"title":"IGameInputReading::GetDevice","description":"IGameInputReading::GetDevice","sidebarTitle":"IGameInputReading::GetDevice","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getdevice"},{"title":"IGameInputReading::GetFlightStickState","description":"IGameInputReading::GetFlightStickState","sidebarTitle":"IGameInputReading::GetFlightStickState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getflightstickstate"},{"title":"IGameInputReading::GetGamepadState","description":"IGameInputReading::GetGamepadState","sidebarTitle":"IGameInputReading::GetGamepadState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getgamepadstate"},{"title":"IGameInputReading::GetInputKind","description":"IGameInputReading::GetInputKind","sidebarTitle":"IGameInputReading::GetInputKind","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind"},{"title":"IGameInputReading::GetKeyCount","description":"IGameInputReading::GetKeyCount","sidebarTitle":"IGameInputReading::GetKeyCount","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getkeycount"},{"title":"IGameInputReading::GetKeyState","description":"IGameInputReading::GetKeyState","sidebarTitle":"IGameInputReading::GetKeyState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getkeystate"},{"title":"IGameInputReading::GetMouseState","description":"IGameInputReading::GetMouseState","sidebarTitle":"IGameInputReading::GetMouseState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getmousestate"},{"title":"IGameInputReading::GetRacingWheelState","description":"IGameInputReading::GetRacingWheelState","sidebarTitle":"IGameInputReading::GetRacingWheelState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getracingwheelstate"},{"title":"IGameInputReading::GetRawReport","description":"IGameInputReading::GetRawReport","sidebarTitle":"IGameInputReading::GetRawReport","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getrawreport"},{"title":"IGameInputReading::GetSensorsState","description":"IGameInputReading::GetSensorsState","sidebarTitle":"IGameInputReading::GetSensorsState","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getsensorsstate"},{"title":"IGameInputReading::GetSequenceNumber","description":"IGameInputReading::GetSequenceNumber","sidebarTitle":"IGameInputReading::GetSequenceNumber","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getsequencenumber"},{"title":"IGameInputReading::GetTimestamp","description":"IGameInputReading::GetTimestamp","sidebarTitle":"IGameInputReading::GetTimestamp","href":"/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_gettimestamp"}]}]}]},{"group":"Structs","pages":[{"title":"GameInputArcadeStickInfo","description":"GameInputArcadeStickInfo","sidebarTitle":"GameInputArcadeStickInfo","href":"/reference/input/gameinput/structs/gameinputarcadestickinfo"},{"title":"GameInputArcadeStickState","description":"GameInputArcadeStickState","sidebarTitle":"GameInputArcadeStickState","href":"/reference/input/gameinput/structs/gameinputarcadestickstate"},{"title":"GameInputAxisMapping","description":"GameInputAxisMapping","sidebarTitle":"GameInputAxisMapping","href":"/reference/input/gameinput/structs/gameinputaxismapping"},{"title":"GameInputButtonMapping","description":"GameInputButtonMapping","sidebarTitle":"GameInputButtonMapping","href":"/reference/input/gameinput/structs/gameinputbuttonmapping"},{"title":"GameInputControllerInfo","description":"GameInputControllerInfo","sidebarTitle":"GameInputControllerInfo","href":"/reference/input/gameinput/structs/gameinputcontrollerinfo"},{"title":"GameInputControllerSwitchInfo","description":"GameInputControllerSwitchInfo","sidebarTitle":"GameInputControllerSwitchInfo","href":"/reference/input/gameinput/structs/gameinputcontrollerswitchinfo"},{"title":"GameInputDeviceInfo","description":"GameInputDeviceInfo","sidebarTitle":"GameInputDeviceInfo","href":"/reference/input/gameinput/structs/gameinputdeviceinfo"},{"title":"GameInputFlightStickInfo","description":"GameInputFlightStickInfo","sidebarTitle":"GameInputFlightStickInfo","href":"/reference/input/gameinput/structs/gameinputflightstickinfo"},{"title":"GameInputFlightStickState","description":"GameInputFlightStickState","sidebarTitle":"GameInputFlightStickState","href":"/reference/input/gameinput/structs/gameinputflightstickstate"},{"title":"GameInputForceFeedbackConditionParams","description":"GameInputForceFeedbackConditionParams","sidebarTitle":"GameInputForceFeedbackConditionParams","href":"/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams"},{"title":"GameInputForceFeedbackConstantParams","description":"GameInputForceFeedbackConstantParams","sidebarTitle":"GameInputForceFeedbackConstantParams","href":"/reference/input/gameinput/structs/gameinputforcefeedbackconstantparams"},{"title":"GameInputForceFeedbackEnvelope","description":"GameInputForceFeedbackEnvelope","sidebarTitle":"GameInputForceFeedbackEnvelope","href":"/reference/input/gameinput/structs/gameinputforcefeedbackenvelope"},{"title":"GameInputForceFeedbackMagnitude","description":"GameInputForceFeedbackMagnitude","sidebarTitle":"GameInputForceFeedbackMagnitude","href":"/reference/input/gameinput/structs/gameinputforcefeedbackmagnitude"},{"title":"GameInputForceFeedbackMotorInfo","description":"GameInputForceFeedbackMotorInfo","sidebarTitle":"GameInputForceFeedbackMotorInfo","href":"/reference/input/gameinput/structs/gameinputforcefeedbackmotorinfo"},{"title":"GameInputForceFeedbackParams","description":"GameInputForceFeedbackParams","sidebarTitle":"GameInputForceFeedbackParams","href":"/reference/input/gameinput/structs/gameinputforcefeedbackparams"},{"title":"GameInputForceFeedbackPeriodicParams","description":"GameInputForceFeedbackPeriodicParams","sidebarTitle":"GameInputForceFeedbackPeriodicParams","href":"/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams"},{"title":"GameInputForceFeedbackRampParams","description":"GameInputForceFeedbackRampParams","sidebarTitle":"GameInputForceFeedbackRampParams","href":"/reference/input/gameinput/structs/gameinputforcefeedbackrampparams"},{"title":"GameInputGamepadInfo","description":"Reference for the GameInputGamepadInfo struct: describes gamepad layout, per-button physical labels, extra button count, and extra axis count.","sidebarTitle":"GameInputGamepadInfo","href":"/reference/input/gameinput/structs/gameinputgamepadinfo"},{"title":"GameInputGamepadState","description":"GameInputGamepadState","sidebarTitle":"GameInputGamepadState","href":"/reference/input/gameinput/structs/gameinputgamepadstate"},{"title":"GameInputHapticInfo","description":"GameInputHapticInfo","sidebarTitle":"GameInputHapticInfo","href":"/reference/input/gameinput/structs/gameinputhapticinfo"},{"title":"GameInputKeyboardInfo","description":"GameInputKeyboardInfo","sidebarTitle":"GameInputKeyboardInfo","href":"/reference/input/gameinput/structs/gameinputkeyboardinfo"},{"title":"GameInputKeyState","description":"GameInputKeyState","sidebarTitle":"GameInputKeyState","href":"/reference/input/gameinput/structs/gameinputkeystate"},{"title":"GameInputMouseInfo","description":"GameInputMouseInfo","sidebarTitle":"GameInputMouseInfo","href":"/reference/input/gameinput/structs/gameinputmouseinfo"},{"title":"GameInputMouseState","description":"GameInputMouseState","sidebarTitle":"GameInputMouseState","href":"/reference/input/gameinput/structs/gameinputmousestate"},{"title":"GameInputRacingWheelInfo","description":"GameInputRacingWheelInfo","sidebarTitle":"GameInputRacingWheelInfo","href":"/reference/input/gameinput/structs/gameinputracingwheelinfo"},{"title":"GameInputRacingWheelState","description":"GameInputRacingWheelState","sidebarTitle":"GameInputRacingWheelState","href":"/reference/input/gameinput/structs/gameinputracingwheelstate"},{"title":"GameInputRawDeviceReportInfo","description":"GameInputRawDeviceReportInfo","sidebarTitle":"GameInputRawDeviceReportInfo","href":"/reference/input/gameinput/structs/gameinputrawdevicereportinfo"},{"title":"GameInputRumbleParams","description":"GameInputRumbleParams","sidebarTitle":"GameInputRumbleParams","href":"/reference/input/gameinput/structs/gameinputrumbleparams"},{"title":"GameInputSensorsInfo","description":"GameInputSensorsInfo","sidebarTitle":"GameInputSensorsInfo","href":"/reference/input/gameinput/structs/gameinputsensorsinfo"},{"title":"GameInputSensorsState","description":"Reference for the GameInputSensorsState struct: reports accelerometer, gyrometer, compass heading, and orientation quaternion for GameInput sensors.","sidebarTitle":"GameInputSensorsState","href":"/reference/input/gameinput/structs/gameinputsensorsstate"},{"title":"GameInputUsage","description":"GameInputUsage","sidebarTitle":"GameInputUsage","href":"/reference/input/gameinput/structs/gameinputusage"},{"title":"GameInputVersion","description":"GameInputVersion","sidebarTitle":"GameInputVersion","href":"/reference/input/gameinput/structs/gameinputversion"}]}]},{"group":"Deprecated GameInput API members","pages":[{"title":"Deprecated GameInput API members","description":"Deprecated GameInput API members","sidebarTitle":"Deprecated GameInput API members","href":"/reference/input/gameinput/deprecated/gameinput_deprecated_members"}]},{"group":"XInputOnGameInput","pages":[{"title":"XInputOnGameInput","description":"XInputOnGameInput","sidebarTitle":"XInputOnGameInput","href":"/reference/input/xinputongameinput/xinputongameinput_members"},{"group":"Functions","pages":[{"title":"XInputEnable","description":"XInputEnable","sidebarTitle":"XInputEnable","href":"/reference/input/xinputongameinput/functions/xinputenable"},{"title":"XInputGetAudioDeviceIds","description":"XInputGetAudioDeviceIds","sidebarTitle":"XInputGetAudioDeviceIds","href":"/reference/input/xinputongameinput/functions/xinputgetaudiodeviceids"},{"title":"XInputGetBatteryInformation","description":"XInputGetBatteryInformation","sidebarTitle":"XInputGetBatteryInformation","href":"/reference/input/xinputongameinput/functions/xinputgetbatteryinformation"},{"title":"XInputGetCapabilities","description":"XInputGetCapabilities","sidebarTitle":"XInputGetCapabilities","href":"/reference/input/xinputongameinput/functions/xinputgetcapabilities"},{"title":"XInputGetDeviceId","description":"XInputGetDeviceId","sidebarTitle":"XInputGetDeviceId","href":"/reference/input/xinputongameinput/functions/xinputgetdeviceid"},{"title":"XInputGetKeystroke","description":"XInputGetKeystroke","sidebarTitle":"XInputGetKeystroke","href":"/reference/input/xinputongameinput/functions/xinputgetkeystroke"},{"title":"XInputGetState","description":"XInputGetState","sidebarTitle":"XInputGetState","href":"/reference/input/xinputongameinput/functions/xinputgetstate"},{"title":"XInputGetStateWithToken","description":"XInputGetStateWithToken","sidebarTitle":"XInputGetStateWithToken","href":"/reference/input/xinputongameinput/functions/xinputgetstatewithtoken"},{"title":"XInputOnGameInputInitialize","description":"XInputOnGameInputInitialize","sidebarTitle":"XInputOnGameInputInitialize","href":"/reference/input/xinputongameinput/functions/xinputongameinputinitialize"},{"title":"XInputOnGameInputUninitialize","description":"XInputOnGameInputUninitialize","sidebarTitle":"XInputOnGameInputUninitialize","href":"/reference/input/xinputongameinput/functions/xinputongameinputuninitialize"},{"title":"XInputSetState","description":"XInputSetState","sidebarTitle":"XInputSetState","href":"/reference/input/xinputongameinput/functions/xinputsetstate"},{"title":"XInputSetStateEx","description":"XInputSetStateEx","sidebarTitle":"XInputSetStateEx","href":"/reference/input/xinputongameinput/functions/xinputsetstateex"}]},{"group":"Structs","pages":[{"title":"XINPUT_BATTERY_INFORMATION","description":"XINPUT_BATTERY_INFORMATION","sidebarTitle":"XINPUT_BATTERY_INFORMATION","href":"/reference/input/xinputongameinput/structs/xinput_battery_information"},{"title":"XINPUT_CAPABILITIES","description":"XINPUT_CAPABILITIES","sidebarTitle":"XINPUT_CAPABILITIES","href":"/reference/input/xinputongameinput/structs/xinput_capabilities"},{"title":"XINPUT_GAMEPAD","description":"XINPUT_GAMEPAD","sidebarTitle":"XINPUT_GAMEPAD","href":"/reference/input/xinputongameinput/structs/xinput_gamepad"},{"title":"XINPUT_KEYSTROKE","description":"XINPUT_KEYSTROKE","sidebarTitle":"XINPUT_KEYSTROKE","href":"/reference/input/xinputongameinput/structs/xinput_keystroke"},{"title":"XINPUT_STATE","description":"XINPUT_STATE","sidebarTitle":"XINPUT_STATE","href":"/reference/input/xinputongameinput/structs/xinput_state"},{"title":"XINPUT_VIBRATION","description":"XINPUT_VIBRATION","sidebarTitle":"XINPUT_VIBRATION","href":"/reference/input/xinputongameinput/structs/xinput_vibration"},{"title":"XINPUT_VIBRATION_EX","description":"XINPUT_VIBRATION_EX","sidebarTitle":"XINPUT_VIBRATION_EX","href":"/reference/input/xinputongameinput/structs/xinput_vibration_ex"}]}]}]},{"group":"Lighting API reference","pages":[{"title":"Lighting API reference for LampArray peripherals","description":"GDK Lighting API reference for enumerating LampArray peripherals like keyboards, mice, and headsets and controlling their RGB lighting.","sidebarTitle":"Lighting API Reference","href":"/reference/lighting/gc-reference-lighting-toc"},{"group":"LampArray","pages":[{"title":"LampArray API members reference","description":"Index of the LampArray API members: functions, interfaces, enums, and structs used to enumerate RGB peripherals and control their per-lamp lighting.","sidebarTitle":"LampArray","href":"/reference/lighting/lamparray/lamparray_members"},{"group":"Enums","pages":[{"title":"LampArrayEnumerationKind enum reference","description":"Enum controlling whether initial LampArray enumeration in RegisterLampArrayStatusCallback runs asynchronously or blocks until every device reports.","sidebarTitle":"LampArrayEnumerationKind Enumeration","href":"/reference/lighting/lamparray/enums/lamparrayenumerationkind"},{"title":"LampArrayKind enum reference","description":"Enum identifying the physical device type of a LampArray, including keyboard, mouse, game controller, headset, chassis, wearable, and more.","sidebarTitle":"LampArrayKind Enumeration","href":"/reference/lighting/lamparray/enums/lamparraykind"},{"title":"LampArrayStatus enum reference","description":"Enum of possible LampArray connection and availability states (None, Connected, Available) reported to a LampArrayStatusCallback function.","sidebarTitle":"LampArrayStatus Enumeration","href":"/reference/lighting/lamparray/enums/lamparraystatus"},{"title":"LampPurposes enum reference","description":"Flags enum describing the intended purposes of a single Lamp, such as Control, Accent, Branding, Status, Illumination, and Presentation.","sidebarTitle":"LampPurposes Enumeration","href":"/reference/lighting/lamparray/enums/lamppurposes"}]},{"group":"Functions","pages":[{"title":"LampArrayCallback function reference","description":"Callback signature invoked when a LampArray peripheral is attached or detached; registered through RegisterLampArrayCallback in the GDK Lighting API.","sidebarTitle":"LampArrayCallback","href":"/reference/lighting/lamparray/functions/lamparraycallback"},{"title":"LampArrayStatusCallback function reference","description":"Callback signature invoked when a LampArray peripheral changes status; registered through RegisterLampArrayStatusCallback in the GDK Lighting API.","sidebarTitle":"LampArrayStatusCallback","href":"/reference/lighting/lamparray/functions/lamparraystatuscallback"},{"title":"RegisterLampArrayCallback function reference","description":"Registers a LampArrayCallback that fires when a LampArray peripheral is connected or disconnected, returning a token for later unregistration.","sidebarTitle":"RegisterLampArrayCallback","href":"/reference/lighting/lamparray/functions/registerlamparraycallback"},{"title":"RegisterLampArrayStatusCallback function","description":"Registers a LampArrayStatusCallback that fires on LampArray status changes and controls whether initial device enumeration blocks or runs async.","sidebarTitle":"RegisterLampArrayStatusCallback","href":"/reference/lighting/lamparray/functions/registerlamparraystatuscallback"},{"title":"TrySetLampArrayWorkerThreadAffinityMask reference","description":"Sets the processor affinity mask for the LampArray worker thread that dispatches LampArrayCallback and LampArrayStatusCallback invocations.","sidebarTitle":"TrySetLampArrayWorkerThreadAffinityMask","href":"/reference/lighting/lamparray/functions/trysetlamparrayworkerthreadaffinitymask"},{"title":"UnregisterLampArrayCallback function reference","description":"Unregisters a previously registered LampArrayCallback using its callback token and waits up to a specified timeout for in-flight callbacks to finish.","sidebarTitle":"UnregisterLampArrayCallback","href":"/reference/lighting/lamparray/functions/unregisterlamparraycallback"}]},{"group":"Interfaces","pages":[{"group":"Ilamparray","pages":[{"title":"ILampArray interface reference","description":"COM interface representing an RGB lighting peripheral; exposes device properties like Lamp count, dimensions, IDs, and methods to set color and brightness.","sidebarTitle":"ILampArray","href":"/reference/lighting/lamparray/interfaces/ilamparray/ilamparray"},{"group":"Methods","pages":[{"title":"ILampArray::GetBoundingBox method","description":"Returns the logical 3D bounding box that encompasses every Lamp on a LampArray peripheral, expressed in millimeters from the device origin.","sidebarTitle":"ILampArray::GetBoundingBox","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getboundingbox"},{"title":"ILampArray::GetBrightnessLevel method","description":"Returns the overall brightness scale currently applied to every Lamp on a LampArray, where 0.0 is completely off and 1.0 is maximum brightness.","sidebarTitle":"ILampArray::GetBrightnessLevel","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getbrightnesslevel"},{"title":"ILampArray::GetDeviceId method","description":"Returns the system-generated device identifier string for a connected LampArray peripheral, used to distinguish it from other attached devices.","sidebarTitle":"ILampArray::GetDeviceId","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getdeviceid"},{"title":"ILampArray::GetHardwareVersion method","description":"Returns the hardware revision number reported by a LampArray peripheral, useful for detecting firmware differences across otherwise identical devices.","sidebarTitle":"ILampArray::GetHardwareVersion","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_gethardwareversion"},{"title":"ILampArray::GetIndicesCountForPurposes method","description":"Returns the number of Lamp indices on a LampArray that match a given set of LampPurposes flags, used to size buffers for GetIndicesForPurposes.","sidebarTitle":"ILampArray::GetIndicesCountForPurposes","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getindicescountforpurposes"},{"title":"ILampArray::GetIndicesForPurposes method","description":"Fills a caller-provided buffer with Lamp indices matching the given LampPurposes; size the buffer first with GetIndicesCountForPurposes.","sidebarTitle":"ILampArray::GetIndicesForPurposes","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getindicesforpurposes"},{"title":"ILampArray::GetIsEnabled method","description":"Returns whether the current process is currently permitted to drive lighting on a LampArray peripheral through the GDK Lighting API.","sidebarTitle":"ILampArray::GetIsEnabled","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getisenabled"},{"title":"ILampArray::GetLampArrayKind method","description":"Returns the LampArrayKind value identifying the physical device type of a LampArray, such as keyboard, mouse, game controller, or headset.","sidebarTitle":"ILampArray::GetLampArrayKind","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlamparraykind"},{"title":"ILampArray::GetLampCount method","description":"Returns the total number of individually addressable Lamps on a LampArray peripheral, used to iterate indices when driving RGB lighting.","sidebarTitle":"ILampArray::GetLampCount","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlampcount"},{"title":"ILampArray::GetLampInfo method","description":"Returns an ILampInfo object describing an individual Lamp on a LampArray by index, exposing position, color support, purposes, and scan code.","sidebarTitle":"ILampArray::GetLampInfo","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlampinfo"},{"title":"GetMinUpdateIntervalInMicroseconds method","description":"Returns the minimum interval, in microseconds, at which a LampArray peripheral can accept Lamp state updates, comparable to its refresh rate.","sidebarTitle":"ILampArray::GetMinUpdateIntervalInMicroseconds","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getminupdateintervalinmicroseconds"},{"title":"ILampArray::GetProductId method","description":"Returns the USB product identifier reported by a LampArray peripheral, letting titles detect specific hardware models for custom lighting effects.","sidebarTitle":"ILampArray::GetProductId","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getproductid"},{"title":"ILampArray::GetVendorId method","description":"Returns the USB vendor identifier reported by a LampArray peripheral, letting titles detect the manufacturer to apply device-specific lighting.","sidebarTitle":"ILampArray::GetVendorId","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getvendorid"},{"title":"ILampArray::SetBrightnessLevel method","description":"Sets the overall brightness scale applied to every Lamp on a LampArray, where 0.0 is completely off and 1.0 is maximum brightness.","sidebarTitle":"ILampArray::SetBrightnessLevel","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_setbrightnesslevel"},{"title":"ILampArray::SetColor method","description":"Sets every Lamp on a LampArray to a single specified LampArrayColor, providing the simplest way to apply a uniform RGB color across the device.","sidebarTitle":"ILampArray::SetColor","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_setcolor"},{"title":"ILampArray::SetColorsForIndices method","description":"Sets colors for one or more Lamps on a LampArray by mapping a parallel array of Lamp indices to a parallel array of LampArrayColor values.","sidebarTitle":"ILampArray::SetColorsForIndices","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_setcolorsforindices"},{"title":"ILampArray::SetColorsForScanCodes method","description":"Sets colors for one or more Lamps on a LampArray keyboard by mapping a parallel array of keyboard scan codes to a parallel array of colors.","sidebarTitle":"ILampArray::SetColorsForScanCodes","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_setcolorsforscancodes"},{"title":"ILampArray::SetIsEnabled method","description":"Enables or disables lighting control from the current process for a LampArray peripheral, letting titles pause and resume their RGB effects.","sidebarTitle":"ILampArray::SetIsEnabled","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_setisenabled"},{"title":"ILampArray::SupportsScanCodes method","description":"Returns whether a LampArray supports addressing individual Lamps by keyboard scan code, typically true for peripherals of LampArrayKind Keyboard.","sidebarTitle":"ILampArray::SupportsScanCodes","href":"/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_supportsscancodes"}]}]},{"group":"Ilampinfo","pages":[{"title":"ILampInfo interface reference","description":"COM interface describing a single addressable Lamp on a LampArray, including position, color-channel resolution, purposes, and keyboard scan code.","sidebarTitle":"ILampInfo","href":"/reference/lighting/lamparray/interfaces/ilampinfo/ilampinfo"},{"group":"Methods","pages":[{"title":"ILampInfo::GetBlueLevelCount method","description":"Returns the number of distinct blue channel intensity levels a Lamp on a LampArray can display, useful for picking colors the hardware can render.","sidebarTitle":"ILampInfo::GetBlueLevelCount","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getbluelevelcount"},{"title":"ILampInfo::GetFixedColor method","description":"Returns whether a Lamp on a LampArray has a fixed hardware color, meaning it cannot change color and only responds to brightness changes.","sidebarTitle":"ILampInfo::GetFixedColor","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getfixedcolor"},{"title":"ILampInfo::GetGainLevelCount method","description":"Returns the number of color-independent intensity levels a Lamp on a LampArray can display, used to gauge brightness resolution for the Lamp.","sidebarTitle":"ILampInfo::GetGainLevelCount","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getgainlevelcount"},{"title":"ILampInfo::GetGreenLevelCount method","description":"Returns the number of distinct green channel intensity levels a Lamp on a LampArray can display, useful for picking colors the hardware can render.","sidebarTitle":"ILampInfo::GetGreenLevelCount","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getgreenlevelcount"},{"title":"ILampInfo::GetIndex method","description":"Returns the numeric index of a Lamp within its parent LampArray, letting titles map an ILampInfo back to the index used by ILampArray methods.","sidebarTitle":"ILampInfo::GetIndex","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getindex"},{"title":"ILampInfo::GetNearestSupportedColor method","description":"Returns the closest color a Lamp on a LampArray can physically render for a requested LampArrayColor, accounting for its per-channel level counts.","sidebarTitle":"ILampInfo::GetNearestSupportedColor","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getnearestsupportedcolor"},{"title":"ILampInfo::GetPosition method","description":"Returns the 3D position of a Lamp relative to the origin of its LampArray bounding box, used to arrange Lamps spatially for lighting effects.","sidebarTitle":"ILampInfo::GetPosition","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getposition"},{"title":"ILampInfo::GetPurposes method","description":"Returns the LampPurposes flags describing what a Lamp on a LampArray is intended for, such as Control, Accent, Branding, Status, or Illumination.","sidebarTitle":"ILampInfo::GetPurposes","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getpurposes"},{"title":"ILampInfo::GetRedLevelCount method","description":"Returns the number of distinct red channel intensity levels a Lamp on a LampArray can display, useful for picking colors the hardware can render.","sidebarTitle":"ILampInfo::GetRedLevelCount","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getredlevelcount"},{"title":"ILampInfo::GetScanCode method","description":"Returns the keyboard scan code associated with a Lamp on a LampArray keyboard, letting titles map lighting to specific physical keys on the device.","sidebarTitle":"ILampInfo::GetScanCode","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getscancode"},{"title":"GetUpdateLatencyInMicroseconds method","description":"Returns the time in microseconds between a LampArray receiving a Lamp update and the change becoming visible on the device, useful for syncing effects.","sidebarTitle":"ILampInfo::GetUpdateLatencyInMicroseconds","href":"/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getupdatelatencyinmicroseconds"}]}]}]},{"group":"Structs","pages":[{"title":"LampArrayColor struct reference","description":"Struct describing an RGBA color used when calling ILampArray::SetColor, SetColorsForIndices, and related LampArray lighting methods in the GDK.","sidebarTitle":"LampArrayColor","href":"/reference/lighting/lamparray/structs/lamparraycolor"},{"title":"LampArrayPosition struct reference","description":"Struct describing a 3D position in millimeters from a LampArray origin, used to place individual Lamps within the LampArray bounding box.","sidebarTitle":"LampArrayPosition","href":"/reference/lighting/lamparray/structs/lamparrayposition"}]}]}]},{"group":"Networking API reference","pages":[{"title":"Networking API reference","description":"Networking API reference for the Microsoft Game Development Kit (GDK), including XNetworking multiplayer APIs and links to PlayFab Party low-latency networking.","sidebarTitle":"Networking API reference","href":"/reference/networking/gc-reference-networking-toc"},{"group":"XNetworking","pages":[{"title":"XNetworking","description":"XNetworking","sidebarTitle":"XNetworking","href":"/reference/networking/xnetworking/xnetworking_members"},{"group":"Enums","pages":[{"title":"XNetworkingConfigurationSetting","description":"XNetworkingConfigurationSetting","sidebarTitle":"XNetworkingConfigurationSetting","href":"/reference/networking/xnetworking/enums/xnetworkingconfigurationsetting"},{"title":"XNetworkingConnectivityCostHint","description":"XNetworkingConnectivityCostHint","sidebarTitle":"XNetworkingConnectivityCostHint","href":"/reference/networking/xnetworking/enums/xnetworkingconnectivitycosthint"},{"title":"XNetworkingConnectivityLevelHint","description":"XNetworkingConnectivityLevelHint","sidebarTitle":"XNetworkingConnectivityLevelHint","href":"/reference/networking/xnetworking/enums/xnetworkingconnectivitylevelhint"},{"title":"XNetworkingStatisticsType","description":"XNetworkingStatisticsType","sidebarTitle":"XNetworkingStatisticsType","href":"/reference/networking/xnetworking/enums/xnetworkingstatisticstype"},{"title":"XNetworkingThumbprintType","description":"XNetworkingThumbprintType","sidebarTitle":"XNetworkingThumbprintType","href":"/reference/networking/xnetworking/enums/xnetworkingthumbprinttype"}]},{"group":"Functions","pages":[{"title":"XNetworkingConnectivityHintChangedCallback","description":"XNetworkingConnectivityHintChangedCallback","sidebarTitle":"XNetworkingConnectivityHintChangedCallback","href":"/reference/networking/xnetworking/functions/xnetworkingconnectivityhintchangedcallback"},{"title":"XNetworkingGetConnectivityHint","description":"XNetworkingGetConnectivityHint","sidebarTitle":"XNetworkingGetConnectivityHint","href":"/reference/networking/xnetworking/functions/xnetworkinggetconnectivityhint"},{"title":"XNetworkingPreferredLocalUdpMultiplayerPortChangedCallback","description":"XNetworkingPreferredLocalUdpMultiplayerPortChangedCallback","sidebarTitle":"XNetworkingPreferredLocalUdpMultiplayerPortChangedCallback","href":"/reference/networking/xnetworking/functions/xnetworkingpreferredlocaludpmultiplayerportchangedcallback"},{"title":"XNetworkingQueryConfigurationSetting","description":"XNetworkingQueryConfigurationSetting","sidebarTitle":"XNetworkingQueryConfigurationSetting","href":"/reference/networking/xnetworking/functions/xnetworkingqueryconfigurationsetting"},{"title":"XNetworkingQueryPreferredLocalUdpMultiplayerPort","description":"XNetworkingQueryPreferredLocalUdpMultiplayerPort","sidebarTitle":"XNetworkingQueryPreferredLocalUdpMultiplayerPort","href":"/reference/networking/xnetworking/functions/xnetworkingquerypreferredlocaludpmultiplayerport"},{"title":"XNetworkingQueryPreferredLocalUdpMultiplayerPortAsync","description":"XNetworkingQueryPreferredLocalUdpMultiplayerPortAsync","sidebarTitle":"XNetworkingQueryPreferredLocalUdpMultiplayerPortAsync","href":"/reference/networking/xnetworking/functions/xnetworkingquerypreferredlocaludpmultiplayerportasync"},{"title":"XNetworkingQueryPreferredLocalUdpMultiplayerPortAsyncResult","description":"XNetworkingQueryPreferredLocalUdpMultiplayerPortAsyncResult","sidebarTitle":"XNetworkingQueryPreferredLocalUdpMultiplayerPortAsyncResult","href":"/reference/networking/xnetworking/functions/xnetworkingquerypreferredlocaludpmultiplayerportasyncresult"},{"title":"XNetworkingQuerySecurityInformationForUrlAsync","description":"XNetworkingQuerySecurityInformationForUrlAsync","sidebarTitle":"XNetworkingQuerySecurityInformationForUrlAsync","href":"/reference/networking/xnetworking/functions/xnetworkingquerysecurityinformationforurlasync"},{"title":"XNetworkingQuerySecurityInformationForUrlAsyncResult","description":"XNetworkingQuerySecurityInformationForUrlAsyncResult","sidebarTitle":"XNetworkingQuerySecurityInformationForUrlAsyncResult","href":"/reference/networking/xnetworking/functions/xnetworkingquerysecurityinformationforurlasyncresult"},{"title":"XNetworkingQuerySecurityInformationForUrlAsyncResultSize","description":"XNetworkingQuerySecurityInformationForUrlAsyncResultSize","sidebarTitle":"XNetworkingQuerySecurityInformationForUrlAsyncResultSize","href":"/reference/networking/xnetworking/functions/xnetworkingquerysecurityinformationforurlasyncresultsize"},{"title":"XNetworkingQuerySecurityInformationForUrlUtf16Async","description":"XNetworkingQuerySecurityInformationForUrlUtf16Async","sidebarTitle":"XNetworkingQuerySecurityInformationForUrlUtf16Async","href":"/reference/networking/xnetworking/functions/xnetworkingquerysecurityinformationforurlutf16async"},{"title":"XNetworkingQuerySecurityInformationForUrlUtf16AsyncResult","description":"XNetworkingQuerySecurityInformationForUrlUtf16AsyncResult","sidebarTitle":"XNetworkingQuerySecurityInformationForUrlUtf16AsyncResult","href":"/reference/networking/xnetworking/functions/xnetworkingquerysecurityinformationforurlutf16asyncresult"},{"title":"XNetworkingQuerySecurityInformationForUrlUtf16AsyncResultSize","description":"XNetworkingQuerySecurityInformationForUrlUtf16AsyncResultSize","sidebarTitle":"XNetworkingQuerySecurityInformationForUrlUtf16AsyncResultSize","href":"/reference/networking/xnetworking/functions/xnetworkingquerysecurityinformationforurlutf16asyncresultsize"},{"title":"XNetworkingQueryStatistics","description":"XNetworkingQueryStatistics","sidebarTitle":"XNetworkingQueryStatistics","href":"/reference/networking/xnetworking/functions/xnetworkingquerystatistics"},{"title":"XNetworkingRegisterConnectivityHintChanged","description":"XNetworkingRegisterConnectivityHintChanged","sidebarTitle":"XNetworkingRegisterConnectivityHintChanged","href":"/reference/networking/xnetworking/functions/xnetworkingregisterconnectivityhintchanged"},{"title":"XNetworkingRegisterPreferredLocalUdpMultiplayerPortChanged","description":"XNetworkingRegisterPreferredLocalUdpMultiplayerPortChanged","sidebarTitle":"XNetworkingRegisterPreferredLocalUdpMultiplayerPortChanged","href":"/reference/networking/xnetworking/functions/xnetworkingregisterpreferredlocaludpmultiplayerportchanged"},{"title":"XNetworkingSetConfigurationSetting","description":"XNetworkingSetConfigurationSetting","sidebarTitle":"XNetworkingSetConfigurationSetting","href":"/reference/networking/xnetworking/functions/xnetworkingsetconfigurationsetting"},{"title":"XNetworkingUnregisterConnectivityHintChanged","description":"XNetworkingUnregisterConnectivityHintChanged","sidebarTitle":"XNetworkingUnregisterConnectivityHintChanged","href":"/reference/networking/xnetworking/functions/xnetworkingunregisterconnectivityhintchanged"},{"title":"XNetworkingUnregisterPreferredLocalUdpMultiplayerPortChanged","description":"XNetworkingUnregisterPreferredLocalUdpMultiplayerPortChanged","sidebarTitle":"XNetworkingUnregisterPreferredLocalUdpMultiplayerPortChanged","href":"/reference/networking/xnetworking/functions/xnetworkingunregisterpreferredlocaludpmultiplayerportchanged"},{"title":"XNetworkingVerifyServerCertificate","description":"XNetworkingVerifyServerCertificate","sidebarTitle":"XNetworkingVerifyServerCertificate","href":"/reference/networking/xnetworking/functions/xnetworkingverifyservercertificate"}]},{"group":"Structs","pages":[{"title":"XNetworkingConnectivityHint","description":"XNetworkingConnectivityHint","sidebarTitle":"XNetworkingConnectivityHint","href":"/reference/networking/xnetworking/structs/xnetworkingconnectivityhint"},{"title":"XNetworkingSecurityInformation","description":"XNetworkingSecurityInformation","sidebarTitle":"XNetworkingSecurityInformation","href":"/reference/networking/xnetworking/structs/xnetworkingsecurityinformation"},{"title":"XNetworkingStatisticsBuffer","description":"XNetworkingStatisticsBuffer","sidebarTitle":"XNetworkingStatisticsBuffer","href":"/reference/networking/xnetworking/structs/xnetworkingstatisticsbuffer"},{"title":"XNetworkingTcpQueuedReceivedBufferUsageStatistics","description":"XNetworkingTcpQueuedReceivedBufferUsageStatistics","sidebarTitle":"XNetworkingTcpQueuedReceivedBufferUsageStatistics","href":"/reference/networking/xnetworking/structs/xnetworkingtcpqueuedreceivedbufferusagestatistics"},{"title":"XNetworkingThumbprint","description":"XNetworkingThumbprint","sidebarTitle":"XNetworkingThumbprint","href":"/reference/networking/xnetworking/structs/xnetworkingthumbprint"}]}]},{"group":"XCurl","pages":[{"group":"Functions","pages":[{"title":"xcurl_global_init_mem","description":"xcurl_global_init_mem","sidebarTitle":"xcurl_global_init_mem","href":"/reference/networking/xcurl/functions/xcurl_global_init_mem"},{"title":"xcurl_global_resume","description":"xcurl_global_resume","sidebarTitle":"xcurl_global_resume","href":"/reference/networking/xcurl/functions/xcurl_global_resume"},{"title":"xcurl_global_suspend","description":"xcurl_global_suspend","sidebarTitle":"xcurl_global_suspend","href":"/reference/networking/xcurl/functions/xcurl_global_suspend"}]}]}]},{"group":"XBOX PC remote iteration API reference","pages":[{"title":"XBOX PC Remote Iteration API","description":"XBOX PC Remote Iteration API reference: functions to copy files, launch, resume, and terminate games on remote Windows-based development devices.","sidebarTitle":"XBOX PC Remote Iteration API","href":"/reference/remoting/remoteiteration_members"},{"title":"XBOX PC Remote Iteration release versions","description":"Find the WinGet, API NuGet, and EXE file versions for each XBOX PC Remote Iteration release, plus package links for the client, endpoint, and API packages.","sidebarTitle":"XBOX PC Remote Iteration release versions","href":"/reference/remoting/release-versions"},{"group":"Callbacks","pages":[{"title":"WdCopyFilesStatusCallback","description":"WdCopyFilesStatusCallback","sidebarTitle":"WdCopyFilesStatusCallback","href":"/reference/remoting/callbacks/wdcopyfilesstatuscallback"},{"title":"WdCopyErrorCallback","description":"WdCopyErrorCallback","sidebarTitle":"WdCopyErrorCallback","href":"/reference/remoting/callbacks/wdcopyerrorcallback"},{"title":"WdDeleteProgressCallback","description":"Reference for WdDeleteProgressCallback, a currently unused progress callback declared for WdDeleteRemoteFiles, with its syntax and parameter details.","sidebarTitle":"WdDeleteProgressCallback","href":"/reference/remoting/callbacks/wddeleteprogresscallback"},{"title":"WdDeleteErrorCallback","description":"Reference for WdDeleteErrorCallback, a currently unused error callback declared for WdDeleteRemoteFiles, with its syntax, parameters, and severity type.","sidebarTitle":"WdDeleteErrorCallback","href":"/reference/remoting/callbacks/wddeleteerrorcallback"}]},{"title":"XBOX PC Remote Iteration API error codes","description":"Reference list of HRESULT error codes returned by the XBOX PC Remote Iteration API, with root causes and troubleshooting notes for each code.","sidebarTitle":"XBOX PC Remote Iteration API Error Codes","href":"/reference/remoting/error-codes"},{"group":"Enums","pages":[{"title":"WdCopyDirection","description":"WdCopyDirection","sidebarTitle":"WdCopyDirection","href":"/reference/remoting/enums/wdcopydirection"},{"title":"WdCopyErrorSeverity","description":"WdCopyErrorSeverity","sidebarTitle":"WdCopyErrorSeverity","href":"/reference/remoting/enums/wdcopyerrorseverity"},{"title":"WdLaunchMode","description":"WdLaunchMode","sidebarTitle":"WdLaunchMode","href":"/reference/remoting/enums/wdlaunchmode"}]},{"group":"Functions","pages":[{"title":"WdCancelRemoteCopy","description":"WdCancelRemoteCopy","sidebarTitle":"WdCancelRemoteCopy","href":"/reference/remoting/functions/wdcancelremotecopy"},{"title":"WdCloseCancellationHandle","description":"WdCloseCancellationHandle","sidebarTitle":"WdCloseCancellationHandle","href":"/reference/remoting/functions/wdclosecancellationhandle"},{"title":"WdCreateCancellationHandle","description":"WdCreateCancellationHandle","sidebarTitle":"WdCreateCancellationHandle","href":"/reference/remoting/functions/wdcreatecancellationhandle"},{"title":"WdDuplicateCancellationHandle","description":"WdDuplicateCancellationHandle","sidebarTitle":"WdDuplicateCancellationHandle","href":"/reference/remoting/functions/wdduplicatecancellationhandle"},{"title":"WdLaunchRemoteGame","description":"WdLaunchRemoteGame","sidebarTitle":"WdLaunchRemoteGame","href":"/reference/remoting/functions/wdlaunchremotegame"},{"title":"WdRegisterRemoteXboxGame","description":"WdRegisterRemoteXboxGame","sidebarTitle":"WdRegisterRemoteXboxGame","href":"/reference/remoting/functions/wdregisterremotexboxgame"},{"title":"WdRemoteCopy","description":"WdRemoteCopy","sidebarTitle":"WdRemoteCopy","href":"/reference/remoting/functions/wdremotecopy"},{"title":"WdResumeRemoteGame","description":"WdResumeRemoteGame","sidebarTitle":"WdResumeRemoteGame","href":"/reference/remoting/functions/wdresumeremotegame"},{"title":"WdTerminateRemoteGame","description":"WdTerminateRemoteGame","sidebarTitle":"WdTerminateRemoteGame","href":"/reference/remoting/functions/wdterminateremotegame"},{"title":"WdCancelRemoteDelete","description":"Reference for WdCancelRemoteDelete, which signals cancellation of the client wait for a WdDeleteRemoteFiles call, with syntax and remarks.","sidebarTitle":"WdCancelRemoteDelete","href":"/reference/remoting/functions/wdcancelremotedelete"},{"title":"WdDeleteRemoteFiles","description":"Reference for WdDeleteRemoteFiles, which performs best-effort deletion of files and directories on a remote device, with syntax, parameters, and remarks.","sidebarTitle":"WdDeleteRemoteFiles","href":"/reference/remoting/functions/wddeleteremotefiles"}]},{"group":"Structs","pages":[{"title":"WdCancellationHandle","description":"WdCancellationHandle","sidebarTitle":"WdCancellationHandle","href":"/reference/remoting/structs/wdcancellationhandle"},{"title":"WdCopyFileProgressInfo","description":"WdCopyFileProgressInfo","sidebarTitle":"WdCopyFileProgressInfo","href":"/reference/remoting/structs/wdcopyfileprogressinfo"},{"title":"WdCopyOperationSummary","description":"WdCopyOperationSummary","sidebarTitle":"WdCopyOperationSummary","href":"/reference/remoting/structs/wdcopyoperationsummary"},{"title":"WdCopyOptions","description":"WdCopyOptions","sidebarTitle":"WdCopyOptions","href":"/reference/remoting/structs/wdcopyoptions"},{"title":"WdCopySearchOptions","description":"WdCopySearchOptions","sidebarTitle":"WdCopySearchOptions","href":"/reference/remoting/structs/wdcopysearchoptions"},{"title":"WdCopyStatusCallbacks","description":"WdCopyStatusCallbacks","sidebarTitle":"WdCopyStatusCallbacks","href":"/reference/remoting/structs/wdcopystatuscallbacks"},{"title":"WdLaunchOptions","description":"WdLaunchOptions","sidebarTitle":"WdLaunchOptions","href":"/reference/remoting/structs/wdlaunchoptions"},{"title":"WdDeleteFileProgressInfo","description":"Reference for WdDeleteFileProgressInfo, a currently unused structure declared for WdDeleteRemoteFiles that holds a relative file path and folder path.","sidebarTitle":"WdDeleteFileProgressInfo","href":"/reference/remoting/structs/wddeletefileprogressinfo"},{"title":"WdDeleteOperationSummary","description":"Reference for WdDeleteOperationSummary, a currently unused structure declared for WdDeleteRemoteFiles with deleted file, directory, and total item counts.","sidebarTitle":"WdDeleteOperationSummary","href":"/reference/remoting/structs/wddeleteoperationsummary"},{"title":"WdDeleteOptions","description":"Reference for WdDeleteOptions, which sets the common root alias and whether to delete the root folder during a WdDeleteRemoteFiles operation.","sidebarTitle":"WdDeleteOptions","href":"/reference/remoting/structs/wddeleteoptions"},{"title":"WdDeleteSearchOptions","description":"Reference for WdDeleteSearchOptions, which sets include and exclude patterns and attribute filters that select items to delete with WdDeleteRemoteFiles.","sidebarTitle":"WdDeleteSearchOptions","href":"/reference/remoting/structs/wddeletesearchoptions"},{"title":"WdDeleteStatusCallbacks","description":"Reference for WdDeleteStatusCallbacks, the callback and refresh-rate settings that WdDeleteRemoteFiles currently ignores, so you pass nullptr instead.","sidebarTitle":"WdDeleteStatusCallbacks","href":"/reference/remoting/structs/wddeletestatuscallbacks"}]}]},{"group":"System API reference","pages":[{"title":"System API reference","description":"System API reference for the Microsoft Game Development Kit (GDK), covering DirectStorage, XAccessibility, Touch Adaptation Kit, and other system APIs.","sidebarTitle":"System API reference","href":"/reference/system/gc-reference-system-toc"},{"group":"DStorage","pages":[{"title":"DStorage","description":"DStorage","sidebarTitle":"DStorage","href":"/reference/system/dstorage/dstorage_members"},{"group":"Enums","pages":[{"title":"DSTORAGE_BCPACK_MODE","description":"DSTORAGE_BCPACK_MODE","sidebarTitle":"DSTORAGE_BCPACK_MODE","href":"/reference/system/dstorage/enums/dstorage_bcpack_mode"},{"title":"DSTORAGE_COMMAND_TYPE","description":"DSTORAGE_COMMAND_TYPE","sidebarTitle":"DSTORAGE_COMMAND_TYPE","href":"/reference/system/dstorage/enums/dstorage_command_type"},{"title":"DSTORAGE_DEBUG","description":"DSTORAGE_DEBUG","sidebarTitle":"DSTORAGE_DEBUG","href":"/reference/system/dstorage/enums/dstorage_debug"},{"title":"DSTORAGE_PRIORITY","description":"DSTORAGE_PRIORITY","sidebarTitle":"DSTORAGE_PRIORITY","href":"/reference/system/dstorage/enums/dstorage_priority"},{"title":"DSTORAGE_REQUEST_SOURCE_TYPE","description":"DSTORAGE_REQUEST_SOURCE_TYPE","sidebarTitle":"DSTORAGE_REQUEST_SOURCE_TYPE","href":"/reference/system/dstorage/enums/dstorage_request_source_type"},{"title":"DSTORAGE_STAGING_BUFFER_SIZE","description":"DSTORAGE_STAGING_BUFFER_SIZE","sidebarTitle":"DSTORAGE_STAGING_BUFFER_SIZE","href":"/reference/system/dstorage/enums/dstorage_staging_buffer_size"},{"title":"DSTORAGE_SWIZZLE_MODE","description":"DSTORAGE_SWIZZLE_MODE","sidebarTitle":"DSTORAGE_SWIZZLE_MODE","href":"/reference/system/dstorage/enums/dstorage_swizzle_mode"}]},{"group":"Functions","pages":[{"title":"DStorageGetFactory","description":"DStorageGetFactory","sidebarTitle":"DStorageGetFactory","href":"/reference/system/dstorage/functions/dstoragegetfactory"}]},{"group":"Interfaces","pages":[{"group":"IDStorageFactoryX","pages":[{"title":"IDStorageFactoryX","description":"IDStorageFactoryX","sidebarTitle":"IDStorageFactoryX","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX/idstoragefactoryx"},{"group":"Methods","pages":[{"title":"IDStorageFactoryX::CreateQueue","description":"IDStorageFactoryX::CreateQueue","sidebarTitle":"IDStorageFactoryX::CreateQueue","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX/methods/idstoragefactoryx_createqueue"},{"title":"IDStorageFactoryX::CreateStatusArray","description":"IDStorageFactoryX::CreateStatusArray","sidebarTitle":"IDStorageFactoryX::CreateStatusArray","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX/methods/idstoragefactoryx_createstatusarray"},{"title":"IDStorageFactoryX::OpenFile","description":"IDStorageFactoryX::OpenFile","sidebarTitle":"IDStorageFactoryX::OpenFile","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX/methods/idstoragefactoryx_openfile"},{"title":"IDStorageFactoryX::SetCpuAffinity","description":"IDStorageFactoryX::SetCpuAffinity","sidebarTitle":"IDStorageFactoryX::SetCpuAffinity","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX/methods/idstoragefactoryx_setcpuaffinity"},{"title":"IDStorageFactoryX::SetDebugFlags","description":"IDStorageFactoryX::SetDebugFlags","sidebarTitle":"IDStorageFactoryX::SetDebugFlags","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX/methods/idstoragefactoryx_setdebugflags"},{"title":"IDStorageFactoryX::SetStagingBufferSize","description":"IDStorageFactoryX::SetStagingBufferSize","sidebarTitle":"IDStorageFactoryX::SetStagingBufferSize","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX/methods/idstoragefactoryx_setstagingbuffersize"}]}]},{"group":"IDStorageFactoryX1","pages":[{"title":"IDStorageFactoryX1","description":"IDStorageFactoryX1","sidebarTitle":"IDStorageFactoryX1","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX1/idstoragefactoryx1"},{"group":"Methods","pages":[{"title":"IDStorageFactoryX1::GetStats","description":"IDStorageFactoryX1::GetStats","sidebarTitle":"IDStorageFactoryX1::GetStats","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX1/methods/idstoragefactoryx1_getstats"}]}]},{"group":"IDStorageFactoryX2","pages":[{"title":"IDStorageFactoryX2","description":"IDStorageFactoryX2","sidebarTitle":"IDStorageFactoryX2","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX2/idstoragefactoryx2"},{"group":"Methods","pages":[{"title":"IDStorageFactoryX2::CreateQueue1","description":"IDStorageFactoryX2::CreateQueue1","sidebarTitle":"IDStorageFactoryX2::CreateQueue1","href":"/reference/system/dstorage/interfaces/IDStorageFactoryX2/methods/idstoragefactoryx_createqueue1"}]}]},{"group":"IDStorageFileX","pages":[{"title":"IDStorageFileX","description":"IDStorageFileX","sidebarTitle":"IDStorageFileX","href":"/reference/system/dstorage/interfaces/IDStorageFileX/idstoragefilex"},{"group":"Methods","pages":[{"title":"IDStorageFileX::Close","description":"IDStorageFileX::Close","sidebarTitle":"IDStorageFileX::Close","href":"/reference/system/dstorage/interfaces/IDStorageFileX/methods/idstoragefilex_close"},{"title":"IDStorageFileX::GetHandle","description":"IDStorageFileX::GetHandle","sidebarTitle":"IDStorageFileX::GetHandle","href":"/reference/system/dstorage/interfaces/IDStorageFileX/methods/idstoragefilex_gethandle"}]}]},{"group":"IDStorageQueueX","pages":[{"title":"IDStorageQueueX","description":"IDStorageQueueX","sidebarTitle":"IDStorageQueueX","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/idstoragequeuex"},{"group":"Methods","pages":[{"title":"IDStorageQueueX::CancelRequestsWithTag","description":"IDStorageQueueX::CancelRequestsWithTag","sidebarTitle":"IDStorageQueueX::CancelRequestsWithTag","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/methods/idstoragequeuex_cancelrequestswithtag"},{"title":"IDStorageQueueX::Close","description":"IDStorageQueueX::Close","sidebarTitle":"IDStorageQueueX::Close","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/methods/idstoragequeuex_close"},{"title":"IDStorageQueueX::EnqueueRequest","description":"IDStorageQueueX::EnqueueRequest","sidebarTitle":"IDStorageQueueX::EnqueueRequest","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/methods/idstoragequeuex_enqueuerequest"},{"title":"IDStorageQueueX::EnqueueSignal","description":"IDStorageQueueX::EnqueueSignal","sidebarTitle":"IDStorageQueueX::EnqueueSignal","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/methods/idstoragequeuex_enqueuesignal"},{"title":"IDStorageQueueX::EnqueueStatus","description":"IDStorageQueueX::EnqueueStatus","sidebarTitle":"IDStorageQueueX::EnqueueStatus","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/methods/idstoragequeuex_enqueuestatus"},{"title":"IDStorageQueueX::GetErrorEvent","description":"IDStorageQueueX::GetErrorEvent","sidebarTitle":"IDStorageQueueX::GetErrorEvent","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/methods/idstoragequeuex_geterrorevent"},{"title":"IDStorageQueueX::Query","description":"IDStorageQueueX::Query","sidebarTitle":"IDStorageQueueX::Query","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/methods/idstoragequeuex_query"},{"title":"IDStorageQueueX::RetrieveErrorRecord","description":"IDStorageQueueX::RetrieveErrorRecord","sidebarTitle":"IDStorageQueueX::RetrieveErrorRecord","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/methods/idstoragequeuex_retrieveerrorrecord"},{"title":"IDStorageQueueX::Submit","description":"IDStorageQueueX::Submit","sidebarTitle":"IDStorageQueueX::Submit","href":"/reference/system/dstorage/interfaces/IDStorageQueueX/methods/idstoragequeuex_submit"}]}]},{"group":"IDStorageQueueX1","pages":[{"title":"IDStorageQueueX1","description":"IDStorageQueueX1","sidebarTitle":"IDStorageQueueX1","href":"/reference/system/dstorage/interfaces/IDStorageQueueX1/idstoragequeuex1"},{"group":"Methods","pages":[{"title":"IDStorageQueueX1::EnqueueSetEvent","description":"IDStorageQueueX1::EnqueueSetEvent","sidebarTitle":"IDStorageQueueX1::EnqueueSetEvent","href":"/reference/system/dstorage/interfaces/IDStorageQueueX1/methods/idstoragequeuex_enqueuesetevent"}]}]},{"group":"IDStorageQueueX2","pages":[{"title":"IDStorageQueueX2","description":"IDStorageQueueX2","sidebarTitle":"IDStorageQueueX2","href":"/reference/system/dstorage/interfaces/IDStorageQueueX2/idstoragequeuex2"},{"group":"Methods","pages":[{"title":"IDStorageQueueX2::Query1","description":"IDStorageQueueX2::Query1","sidebarTitle":"IDStorageQueueX2::Query1","href":"/reference/system/dstorage/interfaces/IDStorageQueueX2/methods/idstoragequeuex_query1"}]}]},{"group":"IDStorageStatusArrayX","pages":[{"title":"IDStorageStatusArrayX","description":"IDStorageStatusArrayX","sidebarTitle":"IDStorageStatusArrayX","href":"/reference/system/dstorage/interfaces/IDStorageStatusArrayX/idstoragestatusarrayx"},{"group":"Methods","pages":[{"title":"IDStorageStatusArrayX::GetHResult","description":"IDStorageStatusArrayX::GetHResult","sidebarTitle":"IDStorageStatusArrayX::GetHResult","href":"/reference/system/dstorage/interfaces/IDStorageStatusArrayX/methods/idstoragestatusarrayx_gethresult"},{"title":"IDStorageStatusArrayX::IsComplete","description":"IDStorageStatusArrayX::IsComplete","sidebarTitle":"IDStorageStatusArrayX::IsComplete","href":"/reference/system/dstorage/interfaces/IDStorageStatusArrayX/methods/idstoragestatusarrayx_iscomplete"}]}]}]},{"group":"Structs","pages":[{"title":"DSTORAGE_ERROR_RECORD","description":"DSTORAGE_ERROR_RECORD","sidebarTitle":"DSTORAGE_ERROR_RECORD","href":"/reference/system/dstorage/structs/dstorage_error_record"},{"title":"DSTORAGE_PRIORITY_STATS","description":"DSTORAGE_PRIORITY_STATS","sidebarTitle":"DSTORAGE_PRIORITY_STATS","href":"/reference/system/dstorage/structs/dstorage_priority_stats"},{"title":"DSTORAGE_QUEUE_DESC","description":"DSTORAGE_QUEUE_DESC","sidebarTitle":"DSTORAGE_QUEUE_DESC","href":"/reference/system/dstorage/structs/dstorage_queue_desc"},{"title":"DSTORAGE_QUEUE_DESC1","description":"DSTORAGE_QUEUE_DESC1","sidebarTitle":"DSTORAGE_QUEUE_DESC1","href":"/reference/system/dstorage/structs/dstorage_queue_desc1"},{"title":"DSTORAGE_QUEUE_INFO","description":"DSTORAGE_QUEUE_INFO","sidebarTitle":"DSTORAGE_QUEUE_INFO","href":"/reference/system/dstorage/structs/dstorage_queue_info"},{"title":"DSTORAGE_QUEUE_INFO1","description":"DSTORAGE_QUEUE_INFO1","sidebarTitle":"DSTORAGE_QUEUE_INFO1","href":"/reference/system/dstorage/structs/dstorage_queue_info1"},{"title":"DSTORAGE_QUEUE_OPTIONS","description":"DSTORAGE_QUEUE_OPTIONS","sidebarTitle":"DSTORAGE_QUEUE_OPTIONS","href":"/reference/system/dstorage/structs/dstorage_queue_options"},{"title":"DSTORAGE_REQUEST","description":"DSTORAGE_REQUEST","sidebarTitle":"DSTORAGE_REQUEST","href":"/reference/system/dstorage/structs/dstorage_request"},{"title":"DSTORAGE_REQUEST_OPTIONS","description":"DSTORAGE_REQUEST_OPTIONS","sidebarTitle":"DSTORAGE_REQUEST_OPTIONS","href":"/reference/system/dstorage/structs/dstorage_request_options"},{"title":"DSTORAGE_STATS","description":"DSTORAGE_STATS","sidebarTitle":"DSTORAGE_STATS","href":"/reference/system/dstorage/structs/dstorage_stats"}]}]},{"group":"Touch Adaptation Kit","pages":[{"title":"Touch Adaptation Kit","description":"Touch Adaptation Kit","sidebarTitle":"Touch Adaptation Kit","href":"/reference/system/touchadaptationkit/touchadaptationkit-reference"}]},{"group":"XAccessibility","pages":[{"title":"XAccessibility","description":"XAccessibility","sidebarTitle":"XAccessibility","href":"/reference/system/xaccessibility/xaccessibility_members"},{"group":"Enums","pages":[{"title":"XClosedCaptionFontEdgeAttribute","description":"XClosedCaptionFontEdgeAttribute","sidebarTitle":"XClosedCaptionFontEdgeAttribute","href":"/reference/system/xaccessibility/enums/xclosedcaptionfontedgeattribute"},{"title":"XClosedCaptionFontStyle","description":"XClosedCaptionFontStyle","sidebarTitle":"XClosedCaptionFontStyle","href":"/reference/system/xaccessibility/enums/xclosedcaptionfontstyle"},{"title":"XHighContrastMode","description":"XHighContrastMode","sidebarTitle":"XHighContrastMode","href":"/reference/system/xaccessibility/enums/xhighcontrastmode"},{"title":"XSpeechToTextPositionHint","description":"XSpeechToTextPositionHint","sidebarTitle":"XSpeechToTextPositionHint","href":"/reference/system/xaccessibility/enums/xspeechtotextpositionhint"},{"title":"XSpeechToTextType","description":"XSpeechToTextType","sidebarTitle":"XSpeechToTextType","href":"/reference/system/xaccessibility/enums/xspeechtotexttype"}]},{"group":"Functions","pages":[{"title":"XClosedCaptionGetProperties","description":"XClosedCaptionGetProperties","sidebarTitle":"XClosedCaptionGetProperties","href":"/reference/system/xaccessibility/functions/xclosedcaptiongetproperties"},{"title":"XClosedCaptionSetEnabled","description":"XClosedCaptionSetEnabled","sidebarTitle":"XClosedCaptionSetEnabled","href":"/reference/system/xaccessibility/functions/xclosedcaptionsetenabled"},{"title":"XHighContrastGetMode","description":"XHighContrastGetMode","sidebarTitle":"XHighContrastGetMode","href":"/reference/system/xaccessibility/functions/xhighcontrastgetmode"},{"title":"XSpeechToTextBeginHypothesisString","description":"XSpeechToTextBeginHypothesisString","sidebarTitle":"XSpeechToTextBeginHypothesisString","href":"/reference/system/xaccessibility/functions/xspeechtotextbeginhypothesisstring"},{"title":"XSpeechToTextCancelHypothesisString","description":"XSpeechToTextCancelHypothesisString","sidebarTitle":"XSpeechToTextCancelHypothesisString","href":"/reference/system/xaccessibility/functions/xspeechtotextcancelhypothesisstring"},{"title":"XSpeechToTextFinalizeHypothesisString","description":"XSpeechToTextFinalizeHypothesisString","sidebarTitle":"XSpeechToTextFinalizeHypothesisString","href":"/reference/system/xaccessibility/functions/xspeechtotextfinalizehypothesisstring"},{"title":"XSpeechToTextSendString","description":"XSpeechToTextSendString","sidebarTitle":"XSpeechToTextSendString","href":"/reference/system/xaccessibility/functions/xspeechtotextsendstring"},{"title":"XSpeechToTextSetPositionHint","description":"XSpeechToTextSetPositionHint","sidebarTitle":"XSpeechToTextSetPositionHint","href":"/reference/system/xaccessibility/functions/xspeechtotextsetpositionhint"},{"title":"XSpeechToTextUpdateHypothesisString","description":"XSpeechToTextUpdateHypothesisString","sidebarTitle":"XSpeechToTextUpdateHypothesisString","href":"/reference/system/xaccessibility/functions/xspeechtotextupdatehypothesisstring"}]},{"group":"Structs","pages":[{"title":"XClosedCaptionProperties","description":"XClosedCaptionProperties","sidebarTitle":"XClosedCaptionProperties","href":"/reference/system/xaccessibility/structs/xclosedcaptionproperties"}]}]},{"group":"XAppCapture","pages":[{"title":"XAppCapture","description":"XAppCapture","sidebarTitle":"XAppCapture","href":"/reference/system/xappcapture/xappcapture_members"},{"title":"XAppCapture Error Codes","description":"XAppCapture Error Codes","sidebarTitle":"XAppCapture Error Codes","href":"/reference/system/xappcapture/xappcapture_errors"},{"group":"Enums","pages":[{"title":"XAppCaptureMetadataPriority","description":"XAppCaptureMetadataPriority","sidebarTitle":"XAppCaptureMetadataPriority","href":"/reference/system/xappcapture/enums/xappcapturemetadatapriority"},{"title":"XAppCaptureScreenshotFormatFlag","description":"XAppCaptureScreenshotFormatFlag","sidebarTitle":"XAppCaptureScreenshotFormatFlag","href":"/reference/system/xappcapture/enums/xappcapturescreenshotformatflag"},{"title":"XAppCaptureVideoColorFormat","description":"XAppCaptureVideoColorFormat","sidebarTitle":"XAppCaptureVideoColorFormat","href":"/reference/system/xappcapture/enums/xappcapturevideocolorformat"},{"title":"XAppCaptureVideoEncoding","description":"XAppCaptureVideoEncoding","sidebarTitle":"XAppCaptureVideoEncoding","href":"/reference/system/xappcapture/enums/xappcapturevideoencoding"}]},{"group":"Functions","pages":[{"title":"XAppBroadcastGetStatus","description":"XAppBroadcastGetStatus","sidebarTitle":"XAppBroadcastGetStatus","href":"/reference/system/xappcapture/functions/xappbroadcastgetstatus"},{"title":"XAppBroadcastIsAppBroadcasting","description":"XAppBroadcastIsAppBroadcasting","sidebarTitle":"XAppBroadcastIsAppBroadcasting","href":"/reference/system/xappcapture/functions/xappbroadcastisappbroadcasting"},{"title":"XAppBroadcastMonitorCallback","description":"XAppBroadcastMonitorCallback","sidebarTitle":"XAppBroadcastMonitorCallback","href":"/reference/system/xappcapture/functions/xappbroadcastmonitorcallback"},{"title":"XAppBroadcastRegisterIsAppBroadcastingChanged","description":"XAppBroadcastRegisterIsAppBroadcastingChanged","sidebarTitle":"XAppBroadcastRegisterIsAppBroadcastingChanged","href":"/reference/system/xappcapture/functions/xappbroadcastregisterisappbroadcastingchanged"},{"title":"XAppBroadcastShowUI","description":"XAppBroadcastShowUI","sidebarTitle":"XAppBroadcastShowUI","href":"/reference/system/xappcapture/functions/xappbroadcastshowui"},{"title":"XAppBroadcastUnregisterIsAppBroadcastingChanged","description":"XAppBroadcastUnregisterIsAppBroadcastingChanged","sidebarTitle":"XAppBroadcastUnregisterIsAppBroadcastingChanged","href":"/reference/system/xappcapture/functions/xappbroadcastunregisterisappbroadcastingchanged"},{"title":"XAppCaptureCancelUserRecord","description":"XAppCaptureCancelUserRecord","sidebarTitle":"XAppCaptureCancelUserRecord","href":"/reference/system/xappcapture/functions/xappcapturecanceluserrecord"},{"title":"XAppCaptureCloseLocalStream","description":"XAppCaptureCloseLocalStream","sidebarTitle":"XAppCaptureCloseLocalStream","href":"/reference/system/xappcapture/functions/xappcapturecloselocalstream"},{"title":"XAppCaptureCloseScreenshotStream","description":"XAppCaptureCloseScreenshotStream","sidebarTitle":"XAppCaptureCloseScreenshotStream","href":"/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream"},{"title":"XAppCaptureDisableRecord","description":"XAppCaptureDisableRecord","sidebarTitle":"XAppCaptureDisableRecord","href":"/reference/system/xappcapture/functions/xappcapturedisablerecord"},{"title":"XAppCaptureEnableRecord","description":"XAppCaptureEnableRecord","sidebarTitle":"XAppCaptureEnableRecord","href":"/reference/system/xappcapture/functions/xappcaptureenablerecord"},{"title":"XAppCaptureGetVideoCaptureSettings","description":"XAppCaptureGetVideoCaptureSettings","sidebarTitle":"XAppCaptureGetVideoCaptureSettings","href":"/reference/system/xappcapture/functions/xappcapturegetvideocapturesettings"},{"title":"XAppCaptureMetadataAddDoubleEvent","description":"XAppCaptureMetadataAddDoubleEvent","sidebarTitle":"XAppCaptureMetadataAddDoubleEvent","href":"/reference/system/xappcapture/functions/xappcapturemetadataadddoubleevent"},{"title":"XAppCaptureMetadataAddInt32Event","description":"XAppCaptureMetadataAddInt32Event","sidebarTitle":"XAppCaptureMetadataAddInt32Event","href":"/reference/system/xappcapture/functions/xappcapturemetadataaddint32event"},{"title":"XAppCaptureMetadataAddStringEvent","description":"XAppCaptureMetadataAddStringEvent","sidebarTitle":"XAppCaptureMetadataAddStringEvent","href":"/reference/system/xappcapture/functions/xappcapturemetadataaddstringevent"},{"title":"XAppCaptureMetadataPurgedCallback","description":"XAppCaptureMetadataPurgedCallback","sidebarTitle":"XAppCaptureMetadataPurgedCallback","href":"/reference/system/xappcapture/functions/xappcapturemetadatapurgedcallback"},{"title":"XAppCaptureMetadataRemainingStorageBytesAvailable","description":"XAppCaptureMetadataRemainingStorageBytesAvailable","sidebarTitle":"XAppCaptureMetadataRemainingStorageBytesAvailable","href":"/reference/system/xappcapture/functions/xappcapturemetadataremainingstoragebytesavailable"},{"title":"XAppCaptureMetadataStartDoubleState","description":"XAppCaptureMetadataStartDoubleState","sidebarTitle":"XAppCaptureMetadataStartDoubleState","href":"/reference/system/xappcapture/functions/xappcapturemetadatastartdoublestate"},{"title":"XAppCaptureMetadataStartInt32State","description":"XAppCaptureMetadataStartInt32State","sidebarTitle":"XAppCaptureMetadataStartInt32State","href":"/reference/system/xappcapture/functions/xappcapturemetadatastartint32state"},{"title":"AppCaptureMetadataStartStringState","description":"AppCaptureMetadataStartStringState","sidebarTitle":"AppCaptureMetadataStartStringState","href":"/reference/system/xappcapture/functions/xappcapturemetadatastartstringstate"},{"title":"XAppCaptureMetadataStopAllStates","description":"XAppCaptureMetadataStopAllStates","sidebarTitle":"XAppCaptureMetadataStopAllStates","href":"/reference/system/xappcapture/functions/xappcapturemetadatastopallstates"},{"title":"XAppCaptureMetadataStopState","description":"XAppCaptureMetadataStopState","sidebarTitle":"XAppCaptureMetadataStopState","href":"/reference/system/xappcapture/functions/xappcapturemetadatastopstate"},{"title":"XAppCaptureOpenScreenshotStream","description":"XAppCaptureOpenScreenshotStream","sidebarTitle":"XAppCaptureOpenScreenshotStream","href":"/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream"},{"title":"XAppCaptureReadLocalStream","description":"XAppCaptureReadLocalStream","sidebarTitle":"XAppCaptureReadLocalStream","href":"/reference/system/xappcapture/functions/xappcapturereadlocalstream"},{"title":"XAppCaptureReadScreenshotStream","description":"XAppCaptureReadScreenshotStream","sidebarTitle":"XAppCaptureReadScreenshotStream","href":"/reference/system/xappcapture/functions/xappcapturereadscreenshotstream"},{"title":"XAppCaptureRecordDiagnosticClip","description":"XAppCaptureRecordDiagnosticClip","sidebarTitle":"XAppCaptureRecordDiagnosticClip","href":"/reference/system/xappcapture/functions/xappcapturerecorddiagnosticclip"},{"title":"XAppCaptureRecordTimespan","description":"XAppCaptureRecordTimespan","sidebarTitle":"XAppCaptureRecordTimespan","href":"/reference/system/xappcapture/functions/xappcapturerecordtimespan"},{"title":"AppCaptureRegisterMetadataPurged","description":"AppCaptureRegisterMetadataPurged","sidebarTitle":"AppCaptureRegisterMetadataPurged","href":"/reference/system/xappcapture/functions/xappcaptureregistermetadatapurged"},{"title":"XAppCaptureStartUserRecord","description":"XAppCaptureStartUserRecord","sidebarTitle":"XAppCaptureStartUserRecord","href":"/reference/system/xappcapture/functions/xappcapturestartuserrecord"},{"title":"XAppCaptureStopUserRecord","description":"XAppCaptureStopUserRecord","sidebarTitle":"XAppCaptureStopUserRecord","href":"/reference/system/xappcapture/functions/xappcapturestopuserrecord"},{"title":"XAppCaptureTakeDiagnosticScreenshot","description":"XAppCaptureTakeDiagnosticScreenshot","sidebarTitle":"XAppCaptureTakeDiagnosticScreenshot","href":"/reference/system/xappcapture/functions/xappcapturetakediagnosticscreenshot"},{"title":"XAppCaptureTakeScreenshot","description":"XAppCaptureTakeScreenshot","sidebarTitle":"XAppCaptureTakeScreenshot","href":"/reference/system/xappcapture/functions/xappcapturetakescreenshot"},{"title":"XAppCaptureUnRegisterMetadataPurged","description":"XAppCaptureUnRegisterMetadataPurged","sidebarTitle":"XAppCaptureUnRegisterMetadataPurged","href":"/reference/system/xappcapture/functions/xappcaptureunregistermetadatapurged"}]},{"group":"Structs","pages":[{"title":"XAppBroadcastStatus","description":"XAppBroadcastStatus","sidebarTitle":"XAppBroadcastStatus","href":"/reference/system/xappcapture/structs/xappbroadcaststatus"},{"title":"XAppCaptureDiagnosticScreenshotResult","description":"XAppCaptureDiagnosticScreenshotResult","sidebarTitle":"XAppCaptureDiagnosticScreenshotResult","href":"/reference/system/xappcapture/structs/xappcapturediagnosticscreenshotresult"},{"title":"XAppCaptureLocalResult","description":"XAppCaptureLocalResult","sidebarTitle":"XAppCaptureLocalResult","href":"/reference/system/xappcapture/structs/xappcapturelocalresult"},{"title":"XAppCaptureRecordClipResult","description":"XAppCaptureRecordClipResult","sidebarTitle":"XAppCaptureRecordClipResult","href":"/reference/system/xappcapture/structs/xappcapturerecordclipresult"},{"title":"XAppCaptureScreenshotFile","description":"XAppCaptureScreenshotFile","sidebarTitle":"XAppCaptureScreenshotFile","href":"/reference/system/xappcapture/structs/xappcapturescreenshotfile"},{"title":"XAppCaptureScreenshotStream","description":"XAppCaptureScreenshotStream","sidebarTitle":"XAppCaptureScreenshotStream","href":"/reference/system/xappcapture/structs/xappcapturescreenshotstream"},{"title":"XAppCaptureTakeScreenshotResult","description":"XAppCaptureTakeScreenshotResult","sidebarTitle":"XAppCaptureTakeScreenshotResult","href":"/reference/system/xappcapture/structs/xappcapturetakescreenshotresult"},{"title":"XAppCaptureUserRecordingResult","description":"XAppCaptureUserRecordingResult","sidebarTitle":"XAppCaptureUserRecordingResult","href":"/reference/system/xappcapture/structs/xappcaptureuserrecordingresult"},{"title":"XAppCaptureVideoCaptureSettings","description":"XAppCaptureVideoCaptureSettings","sidebarTitle":"XAppCaptureVideoCaptureSettings","href":"/reference/system/xappcapture/structs/xappcapturevideocapturesettings"}]}]},{"group":"XAsync","pages":[{"title":"XAsync","description":"XAsync","sidebarTitle":"XAsync","href":"/reference/system/xasync/xasync_members"},{"group":"Functions","pages":[{"title":"XAsyncCancel","description":"XAsyncCancel","sidebarTitle":"XAsyncCancel","href":"/reference/system/xasync/functions/xasynccancel"},{"title":"XAsyncCompletionRoutine","description":"XAsyncCompletionRoutine","sidebarTitle":"XAsyncCompletionRoutine","href":"/reference/system/xasync/functions/xasynccompletionroutine"},{"title":"XAsyncGetResultSize","description":"XAsyncGetResultSize","sidebarTitle":"XAsyncGetResultSize","href":"/reference/system/xasync/functions/xasyncgetresultsize"},{"title":"XAsyncGetStatus","description":"XAsyncGetStatus","sidebarTitle":"XAsyncGetStatus","href":"/reference/system/xasync/functions/xasyncgetstatus"},{"title":"XAsyncRun","description":"XAsyncRun","sidebarTitle":"XAsyncRun","href":"/reference/system/xasync/functions/xasyncrun"},{"title":"XAsyncWork","description":"XAsyncWork","sidebarTitle":"XAsyncWork","href":"/reference/system/xasync/functions/xasyncwork"}]},{"group":"Structs","pages":[{"title":"XAsyncBlock","description":"XAsyncBlock","sidebarTitle":"XAsyncBlock","href":"/reference/system/xasync/structs/xasyncblock"}]}]},{"group":"XAsyncProvider","pages":[{"title":"XAsyncProvider","description":"XAsyncProvider","sidebarTitle":"XAsyncProvider","href":"/reference/system/xasyncprovider/xasyncprovider_members"},{"group":"Enums","pages":[{"title":"XAsyncOp","description":"XAsyncOp","sidebarTitle":"XAsyncOp","href":"/reference/system/xasyncprovider/enums/xasyncop"}]},{"group":"Functions","pages":[{"title":"XAsyncBegin","description":"XAsyncBegin","sidebarTitle":"XAsyncBegin","href":"/reference/system/xasyncprovider/functions/xasyncbegin"},{"title":"XAsyncComplete","description":"XAsyncComplete","sidebarTitle":"XAsyncComplete","href":"/reference/system/xasyncprovider/functions/xasynccomplete"},{"title":"XAsyncGetResult","description":"XAsyncGetResult","sidebarTitle":"XAsyncGetResult","href":"/reference/system/xasyncprovider/functions/xasyncgetresult"},{"title":"XAsyncProvider function","description":"XAsyncProvider function","sidebarTitle":"XAsyncProvider function","href":"/reference/system/xasyncprovider/functions/xasyncprovider"},{"title":"XAsyncSchedule","description":"XAsyncSchedule","sidebarTitle":"XAsyncSchedule","href":"/reference/system/xasyncprovider/functions/xasyncschedule"}]},{"group":"Structs","pages":[{"title":"AsyncProviderData","description":"AsyncProviderData","sidebarTitle":"AsyncProviderData","href":"/reference/system/xasyncprovider/structs/xasyncproviderdata"}]}]},{"group":"XDisplay","pages":[{"title":"XDisplay","description":"XDisplay","sidebarTitle":"XDisplay","href":"/reference/system/xdisplay/xdisplay_members"},{"group":"Enums","pages":[{"title":"XDisplayHdrModePreference","description":"XDisplayHdrModePreference","sidebarTitle":"XDisplayHdrModePreference","href":"/reference/system/xdisplay/enums/xdisplayhdrmodepreference"},{"title":"XDisplayHdrModeResult","description":"XDisplayHdrModeResult","sidebarTitle":"XDisplayHdrModeResult","href":"/reference/system/xdisplay/enums/xdisplayhdrmoderesult"}]},{"group":"Functions","pages":[{"title":"XDisplayAcquireTimeoutDeferral","description":"XDisplayAcquireTimeoutDeferral","sidebarTitle":"XDisplayAcquireTimeoutDeferral","href":"/reference/system/xdisplay/functions/xdisplayacquiretimeoutdeferral"},{"title":"XDisplayCloseTimeoutDeferralHandle","description":"XDisplayCloseTimeoutDeferralHandle","sidebarTitle":"XDisplayCloseTimeoutDeferralHandle","href":"/reference/system/xdisplay/functions/xdisplayclosetimeoutdeferralhandle"},{"title":"XDisplayTryEnableHdrMode","description":"XDisplayTryEnableHdrMode","sidebarTitle":"XDisplayTryEnableHdrMode","href":"/reference/system/xdisplay/functions/xdisplaytryenablehdrmode"}]},{"group":"Structs","pages":[{"title":"XDisplayHdrModeInfo","description":"XDisplayHdrModeInfo","sidebarTitle":"XDisplayHdrModeInfo","href":"/reference/system/xdisplay/structs/xdisplayhdrmodeinfo"}]}]},{"group":"XError","pages":[{"title":"XError members","description":"XError members","sidebarTitle":"XError members","href":"/reference/system/xerror/xerror_members"},{"group":"Enums","pages":[{"title":"XErrorOptions","description":"XErrorOptions","sidebarTitle":"XErrorOptions","href":"/reference/system/xerror/enums/xerroroptions"}]},{"group":"Functions","pages":[{"title":"XErrorCallback","description":"XErrorCallback","sidebarTitle":"XErrorCallback","href":"/reference/system/xerror/functions/xerrorcallback"},{"title":"XErrorSetCallback","description":"XErrorSetCallback","sidebarTitle":"XErrorSetCallback","href":"/reference/system/xerror/functions/xerrorsetcallback"},{"title":"XErrorSetOptions","description":"XErrorSetOptions","sidebarTitle":"XErrorSetOptions","href":"/reference/system/xerror/functions/xerrorsetoptions"}]}]},{"group":"XGame","pages":[{"title":"XGame","description":"XGame","sidebarTitle":"XGame","href":"/reference/system/xgame/xgame_members"},{"group":"Functions","pages":[{"title":"XGameGetXboxTitleId","description":"XGameGetXboxTitleId","sidebarTitle":"XGameGetXboxTitleId","href":"/reference/system/xgame/functions/xgamegetxboxtitleid"},{"title":"XLaunchNewGame","description":"XLaunchNewGame","sidebarTitle":"XLaunchNewGame","href":"/reference/system/xgame/functions/xlaunchnewgame"},{"title":"XLaunchRestartOnCrash","description":"XLaunchRestartOnCrash","sidebarTitle":"XLaunchRestartOnCrash","href":"/reference/system/xgame/functions/xlaunchrestartoncrash"}]}]},{"group":"XGameActivation","pages":[{"title":"XGameActivation","description":"XGameActivation","sidebarTitle":"XGameActivation","href":"/reference/system/xgameactivation/xgameactivation_members"},{"group":"Enums","pages":[{"title":"XGameActivationType","description":"XGameActivationType","sidebarTitle":"XGameActivationType","href":"/reference/system/xgameactivation/enums/xgameactivationtype"}]},{"group":"Functions","pages":[{"title":"XGameActivationAcceptPendingInvite","description":"XGameActivationAcceptPendingInvite","sidebarTitle":"XGameActivationAcceptPendingInvite","href":"/reference/system/xgameactivation/functions/xgameactivationacceptpendinginvite"},{"title":"XGameActivationCallback","description":"XGameActivationCallback","sidebarTitle":"XGameActivationCallback","href":"/reference/system/xgameactivation/functions/xgameactivationcallback"},{"title":"XGameActivationRegisterForEvent","description":"XGameActivationRegisterForEvent","sidebarTitle":"XGameActivationRegisterForEvent","href":"/reference/system/xgameactivation/functions/xgameactivationregisterforevent"},{"title":"XGameActivationUnregisterForEvent","description":"XGameActivationUnregisterForEvent","sidebarTitle":"XGameActivationUnregisterForEvent","href":"/reference/system/xgameactivation/functions/xgameactivationunregisterforevent"}]},{"group":"Structs","pages":[{"title":"XGameActivationInfo","description":"XGameActivationInfo","sidebarTitle":"XGameActivationInfo","href":"/reference/system/xgameactivation/structs/xgameactivationinfo"}]}]},{"group":"XGameEvent","pages":[{"title":"XGameEvent","description":"XGameEvent","sidebarTitle":"XGameEvent","href":"/reference/system/xgameevent/xgameevent_members"},{"group":"Functions","pages":[{"title":"XGameEventWrite","description":"XGameEventWrite","sidebarTitle":"XGameEventWrite","href":"/reference/system/xgameevent/functions/xgameeventwrite"}]}]},{"group":"XGameInvite (deprecated)","pages":[{"title":"XGameInvite (deprecated)","description":"XGameInvite (deprecated)","sidebarTitle":"XGameInvite (deprecated)","href":"/reference/system/xgameinvite/xgameinvite_members"},{"group":"Functions","pages":[{"title":"XGameInviteEventCallback (deprecated)","description":"XGameInviteEventCallback (deprecated)","sidebarTitle":"XGameInviteEventCallback (deprecated)","href":"/reference/system/xgameinvite/functions/xgameinviteeventcallback"},{"title":"XGameInviteRegisterForEvent (deprecated)","description":"XGameInviteRegisterForEvent (deprecated)","sidebarTitle":"XGameInviteRegisterForEvent (deprecated)","href":"/reference/system/xgameinvite/functions/xgameinviteregisterforevent"},{"title":"XGameInviteUnregisterForEvent (deprecated)","description":"XGameInviteUnregisterForEvent (deprecated)","sidebarTitle":"XGameInviteUnregisterForEvent (deprecated)","href":"/reference/system/xgameinvite/functions/xgameinviteunregisterforevent"}]}]},{"group":"XGameProtocol (deprecated)","pages":[{"title":"XGameProtocol (deprecated)","description":"XGameProtocol (deprecated)","sidebarTitle":"XGameProtocol (deprecated)","href":"/reference/system/xgameprotocol/xgameprotocol_members"},{"group":"Functions","pages":[{"title":"XGameProtocolActivationCallbackXGameProtocol (deprecated)","description":"XGameProtocolActivationCallbackXGameProtocol (deprecated)","sidebarTitle":"XGameProtocolActivationCallbackXGameProtocol (deprecated)","href":"/reference/system/xgameprotocol/functions/xgameprotocolactivationcallback"},{"title":"XGameProtocolRegisterForActivation (deprecated)","description":"XGameProtocolRegisterForActivation (deprecated)","sidebarTitle":"XGameProtocolRegisterForActivation (deprecated)","href":"/reference/system/xgameprotocol/functions/xgameprotocolregisterforactivation"},{"title":"XGameProtocolUnregisterForActivation (deprecated)","description":"XGameProtocolUnregisterForActivation (deprecated)","sidebarTitle":"XGameProtocolUnregisterForActivation (deprecated)","href":"/reference/system/xgameprotocol/functions/xgameprotocolunregisterforactivation"}]}]},{"group":"XGameRuntimeFeature","pages":[{"title":"XGameRuntimeFeature (API contents)","description":"XGameRuntimeFeature (API contents)","sidebarTitle":"XGameRuntimeFeature (API contents)","href":"/reference/system/xgameruntimefeature/xgameruntimefeature_members"},{"group":"Enums","pages":[{"title":"XGameRuntimeFeature","description":"XGameRuntimeFeature","sidebarTitle":"XGameRuntimeFeature","href":"/reference/system/xgameruntimefeature/enums/xgameruntimefeature"}]},{"group":"Functions","pages":[{"title":"XGameRuntimeIsFeatureAvailable","description":"XGameRuntimeIsFeatureAvailable","sidebarTitle":"XGameRuntimeIsFeatureAvailable","href":"/reference/system/xgameruntimefeature/functions/xgameruntimeisfeatureavailable"}]}]},{"group":"XGameRuntimeInit","pages":[{"title":"XGameRuntimeInit","description":"XGameRuntimeInit","sidebarTitle":"XGameRuntimeInit","href":"/reference/system/xgameruntimeinit/xgameruntimeinit_members"},{"group":"Enumerations","pages":[{"title":"XGameRuntimeGameConfigSource","description":"XGameRuntimeGameConfigSource","sidebarTitle":"XGameRuntimeGameConfigSource","href":"/reference/system/xgameruntimeinit/Enumerations/xgameruntimegameconfigsource"}]},{"group":"Functions","pages":[{"title":"XGameRuntimeInitialize","description":"XGameRuntimeInitialize","sidebarTitle":"XGameRuntimeInitialize","href":"/reference/system/xgameruntimeinit/functions/xgameruntimeinitialize"},{"title":"XGameRuntimeInitializeWithOptions","description":"XGameRuntimeInitializeWithOptions","sidebarTitle":"XGameRuntimeInitializeWithOptions","href":"/reference/system/xgameruntimeinit/functions/xgameruntimeinitializewithoptions"},{"title":"XGameRuntimeUninitialize","description":"XGameRuntimeUninitialize","sidebarTitle":"XGameRuntimeUninitialize","href":"/reference/system/xgameruntimeinit/functions/xgameruntimeuninitialize"}]},{"group":"Structures","pages":[{"title":"XGameRuntimeOptions","description":"XGameRuntimeOptions","sidebarTitle":"XGameRuntimeOptions","href":"/reference/system/xgameruntimeinit/Structures/xgameruntimeoptions"}]}]},{"group":"XGameRuntimeTypes","pages":[{"title":"XGameRuntimeTypes","description":"XGameRuntimeTypes","sidebarTitle":"XGameRuntimeTypes","href":"/reference/system/xgameruntimetypes/xgameruntimetypes_members"},{"group":"Structs","pages":[{"title":"XColor","description":"XColor","sidebarTitle":"XColor","href":"/reference/system/xgameruntimetypes/structs/xcolor"},{"title":"XVersion","description":"XVersion","sidebarTitle":"XVersion","href":"/reference/system/xgameruntimetypes/structs/xversion"}]}]},{"group":"XGameSave Wrapper","pages":[{"title":"XGameSave Wrapper reference index and member list","description":"Index of the XGameSave wrapper reference: the Provider class, its methods, BlobInfo struct, and BlobData, BlobInfoSet, BlobNames, and ContainerNames types.","sidebarTitle":"XGameSave Wrapper Reference","href":"/reference/system/Wrappers/xgamesave_wrapper_members"},{"group":"Structs","pages":[{"title":"XGameSave Wrapper BlobInfo struct reference","description":"Reference for the Microsoft.Xbox.Wrappers.XGameSave.BlobInfo struct, which holds the name and byte size of a save-container blob (file) used by XGameSave.","sidebarTitle":"BlobInfo","href":"/reference/system/Wrappers/structs/blobinfo"}]},{"group":"Classes","pages":[{"group":"Provider","pages":[{"group":"Methods","pages":[{"title":"XGameSave Provider Initialize method reference","description":"Reference for the XGameSave wrapper Provider.Initialize method, which prepares the save-game provider and syncs all containers for the specified user.","sidebarTitle":"Initialize","href":"/reference/system/Wrappers/classes/provider/methods/xgamesave_wrapper_provider_initialize"},{"title":"XGameSave Provider Delete(std::string\u0026) method","description":"Reference for the XGameSave wrapper Provider.Delete(std::string\u0026) method, which removes a save container along with every blob (file) it stores.","sidebarTitle":"Delete(std::string\u0026)","href":"/reference/system/Wrappers/classes/provider/methods/xgamesave_wrapper_provider_delete_string"},{"title":"XGameSave Provider Delete with BlobNames overload","description":"Reference for the XGameSave Provider.Delete(std::string\u0026, BlobNames\u0026) overload that removes one or more named blobs (files) from a specified save container.","sidebarTitle":"Delete(std::string\u0026, BlobNames\u0026)","href":"/reference/system/Wrappers/classes/provider/methods/xgamesave_wrapper_provider_delete_string_blobnames"},{"title":"XGameSave Provider Delete single-blob string overload","description":"Reference for the XGameSave Provider.Delete(std::string\u0026, std::string\u0026) overload that removes a single named blob (file) from a specified save container.","sidebarTitle":"Delete(std::string\u0026, std::string\u0026)","href":"/reference/system/Wrappers/classes/provider/methods/xgamesave_wrapper_provider_delete_string_string"},{"title":"XGameSave Provider GetQuota method reference","description":"Reference for the XGameSave wrapper Provider.GetQuota method, which returns the amount of save-data storage still available to the current user.","sidebarTitle":"GetQuota","href":"/reference/system/Wrappers/classes/provider/methods/xgamesave_wrapper_provider_getquota"},{"title":"XGameSave Provider Load method reference","description":"Reference for the XGameSave wrapper Provider.Load method, which reads the bytes of a named blob (file) from a save container into game memory.","sidebarTitle":"Load","href":"/reference/system/Wrappers/classes/provider/methods/xgamesave_wrapper_provider_load"},{"title":"XGameSave Provider QueryContainerBlobs method","description":"Reference for the XGameSave Provider.QueryContainerBlobs method, which returns a vector of BlobInfo entries describing every blob (file) in a save container.","sidebarTitle":"QueryContainerBlobs","href":"/reference/system/Wrappers/classes/provider/methods/xgamesave_wrapper_provider_querycontainerblobs"},{"title":"XGameSave Provider QueryContainers method","description":"Reference for the XGameSave wrapper Provider.QueryContainers method, which returns the names of save containers whose names match a supplied prefix.","sidebarTitle":"QueryContainers","href":"/reference/system/Wrappers/classes/provider/methods/xgamesave_wrapper_provider_querycontainers"},{"title":"XGameSave Provider Save method reference","description":"Reference for the XGameSave wrapper Provider.Save method, which writes game-state bytes to a named blob (file) inside a specified save container.","sidebarTitle":"Save","href":"/reference/system/Wrappers/classes/provider/methods/xgamesave_wrapper_provider_save"}]}]}]}]},{"group":"XGameSave","pages":[{"title":"XGameSave","description":"XGameSave","sidebarTitle":"XGameSave","href":"/reference/system/xgamesave/xgamesave_members"},{"group":"Functions","pages":[{"title":"XGameSaveBlobInfoCallback","description":"XGameSaveBlobInfoCallback","sidebarTitle":"XGameSaveBlobInfoCallback","href":"/reference/system/xgamesave/functions/xgamesaveblobinfocallback"},{"title":"XGameSaveCloseContainer","description":"XGameSaveCloseContainer","sidebarTitle":"XGameSaveCloseContainer","href":"/reference/system/xgamesave/functions/xgamesaveclosecontainer"},{"title":"XGameSaveCloseProvider","description":"XGameSaveCloseProvider","sidebarTitle":"XGameSaveCloseProvider","href":"/reference/system/xgamesave/functions/xgamesavecloseprovider"},{"title":"XGameSaveCloseUpdate","description":"XGameSaveCloseUpdate","sidebarTitle":"XGameSaveCloseUpdate","href":"/reference/system/xgamesave/functions/xgamesavecloseupdate"},{"title":"XGameSaveContainerInfoCallback","description":"XGameSaveContainerInfoCallback","sidebarTitle":"XGameSaveContainerInfoCallback","href":"/reference/system/xgamesave/functions/xgamesavecontainerinfocallback"},{"title":"XGameSaveCreateContainer","description":"XGameSaveCreateContainer","sidebarTitle":"XGameSaveCreateContainer","href":"/reference/system/xgamesave/functions/xgamesavecreatecontainer"},{"title":"XGameSaveCreateUpdate","description":"XGameSaveCreateUpdate","sidebarTitle":"XGameSaveCreateUpdate","href":"/reference/system/xgamesave/functions/xgamesavecreateupdate"},{"title":"XGameSaveDeleteContainer","description":"XGameSaveDeleteContainer","sidebarTitle":"XGameSaveDeleteContainer","href":"/reference/system/xgamesave/functions/xgamesavedeletecontainer"},{"title":"XGameSaveDeleteContainerAsync","description":"XGameSaveDeleteContainerAsync","sidebarTitle":"XGameSaveDeleteContainerAsync","href":"/reference/system/xgamesave/functions/xgamesavedeletecontainerasync"},{"title":"XGameSaveDeleteContainerResult","description":"XGameSaveDeleteContainerResult","sidebarTitle":"XGameSaveDeleteContainerResult","href":"/reference/system/xgamesave/functions/xgamesavedeletecontainerresult"},{"title":"XGameSaveEnumerateBlobInfo","description":"XGameSaveEnumerateBlobInfo","sidebarTitle":"XGameSaveEnumerateBlobInfo","href":"/reference/system/xgamesave/functions/xgamesaveenumerateblobinfo"},{"title":"XGameSaveEnumerateBlobInfoByName","description":"XGameSaveEnumerateBlobInfoByName","sidebarTitle":"XGameSaveEnumerateBlobInfoByName","href":"/reference/system/xgamesave/functions/xgamesaveenumerateblobinfobyname"},{"title":"XGameSaveEnumerateContainerInfo","description":"XGameSaveEnumerateContainerInfo","sidebarTitle":"XGameSaveEnumerateContainerInfo","href":"/reference/system/xgamesave/functions/xgamesaveenumeratecontainerinfo"},{"title":"XGameSaveEnumerateContainerInfoByName","description":"XGameSaveEnumerateContainerInfoByName","sidebarTitle":"XGameSaveEnumerateContainerInfoByName","href":"/reference/system/xgamesave/functions/xgamesaveenumeratecontainerinfobyname"},{"title":"XGameSaveGetContainerInfo","description":"XGameSaveGetContainerInfo","sidebarTitle":"XGameSaveGetContainerInfo","href":"/reference/system/xgamesave/functions/xgamesavegetcontainerinfo"},{"title":"XGameSaveGetRemainingQuota","description":"XGameSaveGetRemainingQuota","sidebarTitle":"XGameSaveGetRemainingQuota","href":"/reference/system/xgamesave/functions/xgamesavegetremainingquota"},{"title":"XGameSaveGetRemainingQuotaAsync","description":"XGameSaveGetRemainingQuotaAsync","sidebarTitle":"XGameSaveGetRemainingQuotaAsync","href":"/reference/system/xgamesave/functions/xgamesavegetremainingquotaasync"},{"title":"XGameSaveGetRemainingQuotaResult","description":"XGameSaveGetRemainingQuotaResult","sidebarTitle":"XGameSaveGetRemainingQuotaResult","href":"/reference/system/xgamesave/functions/xgamesavegetremainingquotaresult"},{"title":"XGameSaveInitializeProvider","description":"XGameSaveInitializeProvider","sidebarTitle":"XGameSaveInitializeProvider","href":"/reference/system/xgamesave/functions/xgamesaveinitializeprovider"},{"title":"XGameSaveInitializeProviderAsync","description":"XGameSaveInitializeProviderAsync","sidebarTitle":"XGameSaveInitializeProviderAsync","href":"/reference/system/xgamesave/functions/xgamesaveinitializeproviderasync"},{"title":"XGameSaveInitializeProviderResult","description":"XGameSaveInitializeProviderResult","sidebarTitle":"XGameSaveInitializeProviderResult","href":"/reference/system/xgamesave/functions/xgamesaveinitializeproviderresult"},{"title":"XGameSaveReadBlobData","description":"XGameSaveReadBlobData","sidebarTitle":"XGameSaveReadBlobData","href":"/reference/system/xgamesave/functions/xgamesavereadblobdata"},{"title":"XGameSaveReadBlobDataAsync","description":"XGameSaveReadBlobDataAsync","sidebarTitle":"XGameSaveReadBlobDataAsync","href":"/reference/system/xgamesave/functions/xgamesavereadblobdataasync"},{"title":"XGameSaveReadBlobDataResult","description":"XGameSaveReadBlobDataResult","sidebarTitle":"XGameSaveReadBlobDataResult","href":"/reference/system/xgamesave/functions/xgamesavereadblobdataresult"},{"title":"XGameSaveSubmitBlobDelete","description":"XGameSaveSubmitBlobDelete","sidebarTitle":"XGameSaveSubmitBlobDelete","href":"/reference/system/xgamesave/functions/xgamesavesubmitblobdelete"},{"title":"XGameSaveSubmitBlobWrite","description":"XGameSaveSubmitBlobWrite","sidebarTitle":"XGameSaveSubmitBlobWrite","href":"/reference/system/xgamesave/functions/xgamesavesubmitblobwrite"},{"title":"XGameSaveSubmitUpdate","description":"XGameSaveSubmitUpdate","sidebarTitle":"XGameSaveSubmitUpdate","href":"/reference/system/xgamesave/functions/xgamesavesubmitupdate"},{"title":"XGameSaveSubmitUpdateAsync","description":"XGameSaveSubmitUpdateAsync","sidebarTitle":"XGameSaveSubmitUpdateAsync","href":"/reference/system/xgamesave/functions/xgamesavesubmitupdateasync"},{"title":"XGameSaveSubmitUpdateResult","description":"XGameSaveSubmitUpdateResult","sidebarTitle":"XGameSaveSubmitUpdateResult","href":"/reference/system/xgamesave/functions/xgamesavesubmitupdateresult"}]},{"group":"Structs","pages":[{"title":"XGameSaveBlob","description":"XGameSaveBlob","sidebarTitle":"XGameSaveBlob","href":"/reference/system/xgamesave/structs/xgamesaveblob"},{"title":"XGameSaveBlobInfo","description":"XGameSaveBlobInfo","sidebarTitle":"XGameSaveBlobInfo","href":"/reference/system/xgamesave/structs/xgamesaveblobinfo"},{"title":"XGameSaveContainerInfo","description":"XGameSaveContainerInfo","sidebarTitle":"XGameSaveContainerInfo","href":"/reference/system/xgamesave/structs/xgamesavecontainerinfo"}]}]},{"group":"XGameSaveFiles","pages":[{"title":"XGameSaveFiles","description":"XGameSaveFiles","sidebarTitle":"XGameSaveFiles","href":"/reference/system/xgamesavefiles/xgamesavefiles_members"},{"group":"Functions","pages":[{"title":"XGameSaveFilesGetFolderWithUiAsync","description":"XGameSaveFilesGetFolderWithUiAsync","sidebarTitle":"XGameSaveFilesGetFolderWithUiAsync","href":"/reference/system/xgamesavefiles/functions/xgamesavefilesgetfolderwithuiasync"},{"title":"XGameSaveFilesGetFolderWithUiResult","description":"XGameSaveFilesGetFolderWithUiResult","sidebarTitle":"XGameSaveFilesGetFolderWithUiResult","href":"/reference/system/xgamesavefiles/functions/xgamesavefilesgetfolderwithuiresult"},{"title":"XGameSaveFilesGetRemainingQuota","description":"XGameSaveFilesGetRemainingQuota","sidebarTitle":"XGameSaveFilesGetRemainingQuota","href":"/reference/system/xgamesavefiles/functions/xgamesavefilesgetremainingquota"}]}]},{"group":"XGameStreaming","pages":[{"title":"XGameStreaming","description":"XGameStreaming","sidebarTitle":"XGameStreaming","href":"/reference/system/xgamestreaming/xgamestreaming_members"},{"group":"Enums","pages":[{"title":"XGameStreamingClientProperty","description":"XGameStreamingClientProperty","sidebarTitle":"XGameStreamingClientProperty","href":"/reference/system/xgamestreaming/enums/xgamestreamingclientproperty"},{"title":"XGameStreamingConnectionState","description":"XGameStreamingConnectionState","sidebarTitle":"XGameStreamingConnectionState","href":"/reference/system/xgamestreaming/enums/xgamestreamingconnectionstate"},{"title":"XGameStreamingGamepadPhysicality","description":"XGameStreamingGamepadPhysicality","sidebarTitle":"XGameStreamingGamepadPhysicality","href":"/reference/system/xgamestreaming/enums/xgamestreaminggamepadphysicality"},{"title":"XGameStreamingTouchControlsStateOperationKind","description":"XGameStreamingTouchControlsStateOperationKind","sidebarTitle":"XGameStreamingTouchControlsStateOperationKind","href":"/reference/system/xgamestreaming/enums/xgamestreamingtouchcontrolsstateoperationkind"},{"title":"XGameStreamingTouchControlsStateValueKind","description":"XGameStreamingTouchControlsStateValueKind","sidebarTitle":"XGameStreamingTouchControlsStateValueKind","href":"/reference/system/xgamestreaming/enums/xgamestreamingtouchcontrolsstatevaluekind"},{"title":"XGameStreamingVideoFlags","description":"XGameStreamingVideoFlags","sidebarTitle":"XGameStreamingVideoFlags","href":"/reference/system/xgamestreaming/enums/xgamestreamingvideoflags"}]},{"group":"Functions","pages":[{"title":"XGameStreamingClientPropertiesChangedCallback","description":"XGameStreamingClientPropertiesChangedCallback","sidebarTitle":"XGameStreamingClientPropertiesChangedCallback","href":"/reference/system/xgamestreaming/functions/xgamestreamingclientpropertieschangedcallback"},{"title":"XGameStreamingConnectionStateChangedCallback","description":"XGameStreamingConnectionStateChangedCallback","sidebarTitle":"XGameStreamingConnectionStateChangedCallback","href":"/reference/system/xgamestreaming/functions/xgamestreamingconnectionstatechangedcallback"},{"title":"XGameStreamingGetAssociatedFrame","description":"XGameStreamingGetAssociatedFrame","sidebarTitle":"XGameStreamingGetAssociatedFrame","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetassociatedframe"},{"title":"XGameStreamingGetClientCount","description":"XGameStreamingGetClientCount","sidebarTitle":"XGameStreamingGetClientCount","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetclientcount"},{"title":"XGameStreamingGetClientIPAddress","description":"XGameStreamingGetClientIPAddress","sidebarTitle":"XGameStreamingGetClientIPAddress","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetclientipaddress"},{"title":"XGameStreamingGetClients","description":"XGameStreamingGetClients","sidebarTitle":"XGameStreamingGetClients","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetclients"},{"title":"XGameStreamingGetConnectionState","description":"XGameStreamingGetConnectionState","sidebarTitle":"XGameStreamingGetConnectionState","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetconnectionstate"},{"title":"XGameStreamingGetDisplayDetails","description":"XGameStreamingGetDisplayDetails","sidebarTitle":"XGameStreamingGetDisplayDetails","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetdisplaydetails"},{"title":"XGameStreamingGetGamepadPhysicality","description":"XGameStreamingGetGamepadPhysicality","sidebarTitle":"XGameStreamingGetGamepadPhysicality","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetgamepadphysicality"},{"title":"XGameStreamingGetLastFrameDisplayed","description":"XGameStreamingGetLastFrameDisplayed","sidebarTitle":"XGameStreamingGetLastFrameDisplayed","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetlastframedisplayed"},{"title":"XGameStreamingGetServerLocationName","description":"XGameStreamingGetServerLocationName","sidebarTitle":"XGameStreamingGetServerLocationName","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetserverlocationname"},{"title":"XGameStreamingGetServerLocationNameSize","description":"XGameStreamingGetServerLocationNameSize","sidebarTitle":"XGameStreamingGetServerLocationNameSize","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetserverlocationnamesize"},{"title":"XGameStreamingGetSessionId","description":"XGameStreamingGetSessionId","sidebarTitle":"XGameStreamingGetSessionId","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetsessionid"},{"title":"XGameStreamingGetStreamAddedLatency","description":"XGameStreamingGetStreamAddedLatency","sidebarTitle":"XGameStreamingGetStreamAddedLatency","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetstreamaddedlatency"},{"title":"XGameStreamingGetStreamPhysicalDimensions","description":"XGameStreamingGetStreamPhysicalDimensions","sidebarTitle":"XGameStreamingGetStreamPhysicalDimensions","href":"/reference/system/xgamestreaming/functions/xgamestreaminggetstreamphysicaldimensions"},{"title":"XGameStreamingGetTouchBundleVersion","description":"XGameStreamingGetTouchBundleVersion","sidebarTitle":"XGameStreamingGetTouchBundleVersion","href":"/reference/system/xgamestreaming/functions/xgamestreaminggettouchbundleversion"},{"title":"XGameStreamingGetTouchBundleVersionNameSize","description":"XGameStreamingGetTouchBundleVersionNameSize","sidebarTitle":"XGameStreamingGetTouchBundleVersionNameSize","href":"/reference/system/xgamestreaming/functions/xgamestreaminggettouchbundleversionnamesize"},{"title":"XGameStreamingHideTouchControls","description":"XGameStreamingHideTouchControls","sidebarTitle":"XGameStreamingHideTouchControls","href":"/reference/system/xgamestreaming/functions/xgamestreaminghidetouchcontrols"},{"title":"XGameStreamingHideTouchControlsOnClient","description":"XGameStreamingHideTouchControlsOnClient","sidebarTitle":"XGameStreamingHideTouchControlsOnClient","href":"/reference/system/xgamestreaming/functions/xgamestreaminghidetouchcontrolsonclient"},{"title":"XGameStreamingInitialize","description":"XGameStreamingInitialize","sidebarTitle":"XGameStreamingInitialize","href":"/reference/system/xgamestreaming/functions/xgamestreaminginitialize"},{"title":"XGameStreamingIsStreaming","description":"XGameStreamingIsStreaming","sidebarTitle":"XGameStreamingIsStreaming","href":"/reference/system/xgamestreaming/functions/xgamestreamingisstreaming"},{"title":"XGameStreamingIsTouchInputEnabled","description":"XGameStreamingIsTouchInputEnabled","sidebarTitle":"XGameStreamingIsTouchInputEnabled","href":"/reference/system/xgamestreaming/functions/xgamestreamingistouchinputenabled"},{"title":"XGameStreamingRegisterClientPropertiesChanged","description":"XGameStreamingRegisterClientPropertiesChanged","sidebarTitle":"XGameStreamingRegisterClientPropertiesChanged","href":"/reference/system/xgamestreaming/functions/xgamestreamingregisterclientpropertieschanged"},{"title":"XGameStreamingRegisterConnectionStateChanged","description":"XGameStreamingRegisterConnectionStateChanged","sidebarTitle":"XGameStreamingRegisterConnectionStateChanged","href":"/reference/system/xgamestreaming/functions/xgamestreamingregisterconnectionstatechanged"},{"title":"XGameStreamingSetResolution","description":"XGameStreamingSetResolution","sidebarTitle":"XGameStreamingSetResolution","href":"/reference/system/xgamestreaming/functions/xgamestreamingsetresolution"},{"title":"XGameStreamingShowTouchControlLayout","description":"XGameStreamingShowTouchControlLayout","sidebarTitle":"XGameStreamingShowTouchControlLayout","href":"/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrollayout"},{"title":"XGameStreamingShowTouchControlLayoutOnClient","description":"XGameStreamingShowTouchControlLayoutOnClient","sidebarTitle":"XGameStreamingShowTouchControlLayoutOnClient","href":"/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrollayoutonclient"},{"title":"XGameStreamingShowTouchControlsWithStateUpdate","description":"XGameStreamingShowTouchControlsWithStateUpdate","sidebarTitle":"XGameStreamingShowTouchControlsWithStateUpdate","href":"/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrolswithstateupdate"},{"title":"XGameStreamingShowTouchControlsWithStateUpdateOnClient","description":"XGameStreamingShowTouchControlsWithStateUpdateOnClient","sidebarTitle":"XGameStreamingShowTouchControlsWithStateUpdateOnClient","href":"/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrolswithstateupdateonclient"},{"title":"XGameStreamingUninitialize","description":"XGameStreamingUninitialize","sidebarTitle":"XGameStreamingUninitialize","href":"/reference/system/xgamestreaming/functions/xgamestreaminguninitialize"},{"title":"XGameStreamingUnregisterClientPropertiesChanged","description":"XGameStreamingUnregisterClientPropertiesChanged","sidebarTitle":"XGameStreamingUnregisterClientPropertiesChanged","href":"/reference/system/xgamestreaming/functions/xgamestreamingunregisterclientpropertieschanged"},{"title":"XGameStreamingUnregisterConnectionStateChanged","description":"XGameStreamingUnregisterConnectionStateChanged","sidebarTitle":"XGameStreamingUnregisterConnectionStateChanged","href":"/reference/system/xgamestreaming/functions/xgamestreamingunregisterconnectionstatechanged"},{"title":"XGameStreamingUpdateTouchControlsState","description":"XGameStreamingUpdateTouchControlsState","sidebarTitle":"XGameStreamingUpdateTouchControlsState","href":"/reference/system/xgamestreaming/functions/xgamestreamingupdatetouchcontrolsstate"},{"title":"XGameStreamingUpdateTouchControlsStateOnClient","description":"XGameStreamingUpdateTouchControlsStateOnClient","sidebarTitle":"XGameStreamingUpdateTouchControlsStateOnClient","href":"/reference/system/xgamestreaming/functions/xgamestreamingupdatetouchcontrolsstateonclient"}]},{"group":"Structs","pages":[{"title":"XGameStreamingDisplayDetails","description":"XGameStreamingDisplayDetails","sidebarTitle":"XGameStreamingDisplayDetails","href":"/reference/system/xgamestreaming/structs/xgamestreamingdisplaydetails"},{"title":"XGameStreamingTouchControlsStateOperation","description":"XGameStreamingTouchControlsStateOperation","sidebarTitle":"XGameStreamingTouchControlsStateOperation","href":"/reference/system/xgamestreaming/structs/xgamestreamingtouchcontrolsstateoperation"},{"title":"XGameStreamingTouchControlsStateValue","description":"XGameStreamingTouchControlsStateValue","sidebarTitle":"XGameStreamingTouchControlsStateValue","href":"/reference/system/xgamestreaming/structs/xgamestreamingtouchcontrolsstatevalue"}]}]},{"group":"XGameUI","pages":[{"title":"XGameUI","description":"XGameUI","sidebarTitle":"XGameUI","href":"/reference/system/xgameui/xgameui_members"},{"group":"Enums","pages":[{"title":"XGameUiMessageDialogButton","description":"XGameUiMessageDialogButton","sidebarTitle":"XGameUiMessageDialogButton","href":"/reference/system/xgameui/enums/xgameuimessagedialogbutton"},{"title":"XGameUiNotificationPositionHint","description":"XGameUiNotificationPositionHint","sidebarTitle":"XGameUiNotificationPositionHint","href":"/reference/system/xgameui/enums/xgameuinotificationpositionhint"},{"title":"XGameUiTextEntryChangeTypeFlags","description":"XGameUiTextEntryChangeTypeFlags","sidebarTitle":"XGameUiTextEntryChangeTypeFlags","href":"/reference/system/xgameui/enums/xgameuitextentrychangetypeflags"},{"title":"XGameUiTextEntryInputScope","description":"XGameUiTextEntryInputScope","sidebarTitle":"XGameUiTextEntryInputScope","href":"/reference/system/xgameui/enums/xgameuitextentryinputscope"},{"title":"XGameUiTextEntryPositionHint","description":"XGameUiTextEntryPositionHint","sidebarTitle":"XGameUiTextEntryPositionHint","href":"/reference/system/xgameui/enums/xgameuitextentrypositionhint"},{"title":"XGameUiTextEntryVisibilityFlags","description":"XGameUiTextEntryVisibilityFlags","sidebarTitle":"XGameUiTextEntryVisibilityFlags","href":"/reference/system/xgameui/enums/xgameuitextentryvisibilityflags"},{"title":"XGameUiWebAuthenticationOptions","description":"XGameUiWebAuthenticationOptions","sidebarTitle":"XGameUiWebAuthenticationOptions","href":"/reference/system/xgameui/enums/xgameuiwebauthenticationoptions"}]},{"group":"Functions","pages":[{"title":"XGameUiSetAchievementsUiResponse","description":"XGameUiSetAchievementsUiResponse","sidebarTitle":"XGameUiSetAchievementsUiResponse","href":"/reference/system/xgameui/functions/xgameuisetachievementsuiresponse"},{"title":"XGameUiSetErrorDialogUiResponse","description":"XGameUiSetErrorDialogUiResponse","sidebarTitle":"XGameUiSetErrorDialogUiResponse","href":"/reference/system/xgameui/functions/xgameuiseterrordialoguiresponse"},{"title":"XGameUiSetMessageDialogUiResponse","description":"XGameUiSetMessageDialogUiResponse","sidebarTitle":"XGameUiSetMessageDialogUiResponse","href":"/reference/system/xgameui/functions/xgameuisetmessagedialoguiresponse"},{"title":"XGameUiSetMultiplayerActivityGameInviteUiResponse","description":"XGameUiSetMultiplayerActivityGameInviteUiResponse","sidebarTitle":"XGameUiSetMultiplayerActivityGameInviteUiResponse","href":"/reference/system/xgameui/functions/xgameuisetmultiplayeractivitygameinviteuiresponse"},{"title":"XGameUiSetNotificationPositionHint","description":"XGameUiSetNotificationPositionHint","sidebarTitle":"XGameUiSetNotificationPositionHint","href":"/reference/system/xgameui/functions/xgameuisetnotificationpositionhint"},{"title":"XGameUiSetPlayerPickerUiResponse","description":"XGameUiSetPlayerPickerUiResponse","sidebarTitle":"XGameUiSetPlayerPickerUiResponse","href":"/reference/system/xgameui/functions/xgameuisetplayerpickeruiresponse"},{"title":"XGameUiSetPlayerProfileCardUiResponse","description":"XGameUiSetPlayerProfileCardUiResponse","sidebarTitle":"XGameUiSetPlayerProfileCardUiResponse","href":"/reference/system/xgameui/functions/xgameuisetplayerprofilecarduiresponse"},{"title":"XGameUiSetSendGameInviteUiResponse","description":"XGameUiSetSendGameInviteUiResponse","sidebarTitle":"XGameUiSetSendGameInviteUiResponse","href":"/reference/system/xgameui/functions/xgameuisetsendgameinviteuiresponse"},{"title":"XGameUiSetTextEntryUiResponse","description":"XGameUiSetTextEntryUiResponse","sidebarTitle":"XGameUiSetTextEntryUiResponse","href":"/reference/system/xgameui/functions/xgameuisettextentryuiresponse"},{"title":"XGameUiSetUiCallbacks","description":"XGameUiSetUiCallbacks","sidebarTitle":"XGameUiSetUiCallbacks","href":"/reference/system/xgameui/functions/xgameuisetuicallbacks"},{"title":"XGameUiShowAchievementsAsync","description":"XGameUiShowAchievementsAsync","sidebarTitle":"XGameUiShowAchievementsAsync","href":"/reference/system/xgameui/functions/xgameuishowachievementsasync"},{"title":"XGameUiShowAchievementsResult","description":"XGameUiShowAchievementsResult","sidebarTitle":"XGameUiShowAchievementsResult","href":"/reference/system/xgameui/functions/xgameuishowachievementsresult"},{"title":"XGameUiShowAchievementsUiCallback","description":"XGameUiShowAchievementsUiCallback","sidebarTitle":"XGameUiShowAchievementsUiCallback","href":"/reference/system/xgameui/functions/xgameuishowachievementsuicallback"},{"title":"XGameUiShowErrorDialogAsync","description":"XGameUiShowErrorDialogAsync","sidebarTitle":"XGameUiShowErrorDialogAsync","href":"/reference/system/xgameui/functions/xgameuishowerrordialogasync"},{"title":"XGameUiShowErrorDialogResult","description":"XGameUiShowErrorDialogResult","sidebarTitle":"XGameUiShowErrorDialogResult","href":"/reference/system/xgameui/functions/xgameuishowerrordialogresult"},{"title":"XGameUiShowErrorDialogUiCallback","description":"XGameUiShowErrorDialogUiCallback","sidebarTitle":"XGameUiShowErrorDialogUiCallback","href":"/reference/system/xgameui/functions/xgameuishowerrordialoguicallback"},{"title":"XGameUiShowMessageDialogAsync","description":"XGameUiShowMessageDialogAsync","sidebarTitle":"XGameUiShowMessageDialogAsync","href":"/reference/system/xgameui/functions/xgameuishowmessagedialogasync"},{"title":"XGameUiShowMessageDialogResult","description":"XGameUiShowMessageDialogResult","sidebarTitle":"XGameUiShowMessageDialogResult","href":"/reference/system/xgameui/functions/xgameuishowmessagedialogresult"},{"title":"XGameUiShowMessageDialogUiCallback","description":"XGameUiShowMessageDialogUiCallback","sidebarTitle":"XGameUiShowMessageDialogUiCallback","href":"/reference/system/xgameui/functions/xgameuishowmessagedialoguicallback"},{"title":"XGameUiShowMultiplayerActivityGameInviteAsync","description":"XGameUiShowMultiplayerActivityGameInviteAsync","sidebarTitle":"XGameUiShowMultiplayerActivityGameInviteAsync","href":"/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteasync"},{"title":"XGameUiShowMultiplayerActivityGameInviteResult","description":"XGameUiShowMultiplayerActivityGameInviteResult","sidebarTitle":"XGameUiShowMultiplayerActivityGameInviteResult","href":"/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteresult"},{"title":"XGameUiShowMultiplayerActivityGameInviteUiCallback","description":"XGameUiShowMultiplayerActivityGameInviteUiCallback","sidebarTitle":"XGameUiShowMultiplayerActivityGameInviteUiCallback","href":"/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteuicallback"},{"title":"XGameUiShowPlayerPickerAsync","description":"XGameUiShowPlayerPickerAsync","sidebarTitle":"XGameUiShowPlayerPickerAsync","href":"/reference/system/xgameui/functions/xgameuishowplayerpickerasync"},{"title":"XGameUiShowPlayerPickerResult","description":"XGameUiShowPlayerPickerResult","sidebarTitle":"XGameUiShowPlayerPickerResult","href":"/reference/system/xgameui/functions/xgameuishowplayerpickerresult"},{"title":"XGameUiShowPlayerPickerResultCount","description":"XGameUiShowPlayerPickerResultCount","sidebarTitle":"XGameUiShowPlayerPickerResultCount","href":"/reference/system/xgameui/functions/xgameuishowplayerpickerresultcount"},{"title":"XGameUiShowPlayerPickerUiCallback","description":"XGameUiShowPlayerPickerUiCallback","sidebarTitle":"XGameUiShowPlayerPickerUiCallback","href":"/reference/system/xgameui/functions/xgameuishowplayerpickeruicallback"},{"title":"XGameUiShowPlayerProfileCardAsync","description":"XGameUiShowPlayerProfileCardAsync","sidebarTitle":"XGameUiShowPlayerProfileCardAsync","href":"/reference/system/xgameui/functions/xgameuishowplayerprofilecardasync"},{"title":"XGameUiShowPlayerProfileCardResult","description":"XGameUiShowPlayerProfileCardResult","sidebarTitle":"XGameUiShowPlayerProfileCardResult","href":"/reference/system/xgameui/functions/xgameuishowplayerprofilecardresult"},{"title":"XGameUiShowPlayerProfileCardUiCallback","description":"XGameUiShowPlayerProfileCardUiCallback","sidebarTitle":"XGameUiShowPlayerProfileCardUiCallback","href":"/reference/system/xgameui/functions/xgameuishowplayerprofilecarduicallback"},{"title":"XGameUiShowSendGameInviteAsync","description":"XGameUiShowSendGameInviteAsync","sidebarTitle":"XGameUiShowSendGameInviteAsync","href":"/reference/system/xgameui/functions/xgameuishowsendgameinviteasync"},{"title":"XGameUiShowSendGameInviteResult","description":"XGameUiShowSendGameInviteResult","sidebarTitle":"XGameUiShowSendGameInviteResult","href":"/reference/system/xgameui/functions/xgameuishowsendgameinviteresult"},{"title":"XGameUiShowSendGameInviteUiCallback","description":"XGameUiShowSendGameInviteUiCallback","sidebarTitle":"XGameUiShowSendGameInviteUiCallback","href":"/reference/system/xgameui/functions/xgameuishowsendgameinviteuicallback"},{"title":"XGameUiShowStateShareAsync","description":"XGameUiShowStateShareAsync","sidebarTitle":"XGameUiShowStateShareAsync","href":"/reference/system/xgameui/functions/xgameuishowstateshareasync"},{"title":"XGameUiShowStateShareResult","description":"XGameUiShowStateShareResult","sidebarTitle":"XGameUiShowStateShareResult","href":"/reference/system/xgameui/functions/xgameuishowstateshareresult"},{"title":"XGameUiShowTextEntryAsync","description":"XGameUiShowTextEntryAsync","sidebarTitle":"XGameUiShowTextEntryAsync","href":"/reference/system/xgameui/functions/xgameuishowtextentryasync"},{"title":"XGameUiShowTextEntryResult","description":"XGameUiShowTextEntryResult","sidebarTitle":"XGameUiShowTextEntryResult","href":"/reference/system/xgameui/functions/xgameuishowtextentryresult"},{"title":"XGameUiShowTextEntryResultSize","description":"XGameUiShowTextEntryResultSize","sidebarTitle":"XGameUiShowTextEntryResultSize","href":"/reference/system/xgameui/functions/xgameuishowtextentryresultsize"},{"title":"XGameUiShowTextEntryUiCallback","description":"XGameUiShowTextEntryUiCallback","sidebarTitle":"XGameUiShowTextEntryUiCallback","href":"/reference/system/xgameui/functions/xgameuishowtextentryuicallback"},{"title":"XGameUiShowWebAuthenticationAsync","description":"XGameUiShowWebAuthenticationAsync","sidebarTitle":"XGameUiShowWebAuthenticationAsync","href":"/reference/system/xgameui/functions/xgameuishowwebauthenticationasync"},{"title":"XGameUiShowWebAuthenticationResult","description":"XGameUiShowWebAuthenticationResult","sidebarTitle":"XGameUiShowWebAuthenticationResult","href":"/reference/system/xgameui/functions/xgameuishowwebauthenticationresult"},{"title":"XGameUiShowWebAuthenticationResultSize","description":"XGameUiShowWebAuthenticationResultSize","sidebarTitle":"XGameUiShowWebAuthenticationResultSize","href":"/reference/system/xgameui/functions/xgameuishowwebauthenticationresultsize"},{"title":"XGameUiShowWebAuthenticationWithOptionsAsync","description":"XGameUiShowWebAuthenticationWithOptionsAsync","sidebarTitle":"XGameUiShowWebAuthenticationWithOptionsAsync","href":"/reference/system/xgameui/functions/xgameuishowwebauthenticationwithoptionsasync"},{"title":"XGameUiTextEntryClose","description":"XGameUiTextEntryClose","sidebarTitle":"XGameUiTextEntryClose","href":"/reference/system/xgameui/functions/xgameuitextentryclose"},{"title":"XGameUiTextEntryGetExtents","description":"XGameUiTextEntryGetExtents","sidebarTitle":"XGameUiTextEntryGetExtents","href":"/reference/system/xgameui/functions/xgameuitextentrygetextents"},{"title":"XGameUiTextEntryGetState","description":"XGameUiTextEntryGetState","sidebarTitle":"XGameUiTextEntryGetState","href":"/reference/system/xgameui/functions/xgameuitextentrygetstate"},{"title":"XGameUiTextEntryOpen","description":"XGameUiTextEntryOpen","sidebarTitle":"XGameUiTextEntryOpen","href":"/reference/system/xgameui/functions/xgameuitextentryopen"},{"title":"XGameUiTextEntryUpdatePositionHint","description":"XGameUiTextEntryUpdatePositionHint","sidebarTitle":"XGameUiTextEntryUpdatePositionHint","href":"/reference/system/xgameui/functions/xgameuitextentryupdatepositionhint"},{"title":"XGameUiTextEntryUpdateVisibility","description":"XGameUiTextEntryUpdateVisibility","sidebarTitle":"XGameUiTextEntryUpdateVisibility","href":"/reference/system/xgameui/functions/xgameuitextentryupdatevisibility"}]},{"group":"Structs","pages":[{"title":"XGameUiCallbackHandle","description":"XGameUiCallbackHandle","sidebarTitle":"XGameUiCallbackHandle","href":"/reference/system/xgameui/structs/xgameuicallbackhandle"},{"title":"XGameUiPlayerPickerInfo","description":"XGameUiPlayerPickerInfo","sidebarTitle":"XGameUiPlayerPickerInfo","href":"/reference/system/xgameui/structs/xgameuiplayerpickerinfo"},{"title":"XGameUiTextEntryExtents","description":"XGameUiTextEntryExtents","sidebarTitle":"XGameUiTextEntryExtents","href":"/reference/system/xgameui/structs/xgameuitextentryextents"},{"title":"XGameUiTextEntryOptions","description":"XGameUiTextEntryOptions","sidebarTitle":"XGameUiTextEntryOptions","href":"/reference/system/xgameui/structs/xgameuitextentryoptions"},{"title":"XGameUiUiCallbacks","description":"XGameUiUiCallbacks","sidebarTitle":"XGameUiUiCallbacks","href":"/reference/system/xgameui/structs/xgameuiuicallbacks"},{"title":"XGameUiWebAuthenticationResultData","description":"XGameUiWebAuthenticationResultData","sidebarTitle":"XGameUiWebAuthenticationResultData","href":"/reference/system/xgameui/structs/xgameuiwebauthenticationresultdata"}]}]},{"group":"XLauncher","pages":[{"title":"XLauncher","description":"XLauncher","sidebarTitle":"XLauncher","href":"/reference/system/xlauncher/xlauncher_members"},{"group":"Functions","pages":[{"title":"XLaunchUri","description":"XLaunchUri","sidebarTitle":"XLaunchUri","href":"/reference/system/xlauncher/functions/xlaunchuri"}]}]},{"group":"XMem","pages":[{"title":"Xmem members","href":"/reference/system/xmem/xmem_members"},{"group":"Enums","pages":[{"title":"XALLOC_ALLOCATOR_IDS","description":"XALLOC_ALLOCATOR_IDS","sidebarTitle":"XALLOC_ALLOCATOR_IDS","href":"/reference/system/xmem/enums/xalloc_allocator_ids"},{"title":"XMEM_OPTIONS","description":"XMEM_OPTIONS","sidebarTitle":"XMEM_OPTIONS","href":"/reference/system/xmem/enums/xmem_options"},{"title":"Xmem transfer type","href":"/reference/system/xmem/enums/xmem_transfer_type"}]},{"group":"Functions","pages":[{"title":"PHEAP_TRACK_ALLOC_ROUTINE callback","description":"PHEAP_TRACK_ALLOC_ROUTINE callback","sidebarTitle":"PHEAP_TRACK_ALLOC_ROUTINE callback","href":"/reference/system/xmem/functions/pheap_track_alloc_routine"},{"title":"PHEAP_TRACK_FREE_ROUTINE callback","description":"PHEAP_TRACK_FREE_ROUTINE callback","sidebarTitle":"PHEAP_TRACK_FREE_ROUTINE callback","href":"/reference/system/xmem/functions/pheap_track_free_routine"},{"title":"PHEAP_TRACK_REALLOC_ROUTINE callback","description":"PHEAP_TRACK_REALLOC_ROUTINE callback","sidebarTitle":"PHEAP_TRACK_REALLOC_ROUTINE callback","href":"/reference/system/xmem/functions/pheap_track_realloc_routine"},{"title":"Xmemalloc","href":"/reference/system/xmem/functions/xmemalloc"},{"title":"XMEMALLOC_ROUTINE callback","description":"XMEMALLOC_ROUTINE callback","sidebarTitle":"XMEMALLOC_ROUTINE callback","href":"/reference/system/xmem/functions/xmemalloc_routine"},{"title":"Xmemallocatephysicalpages","href":"/reference/system/xmem/functions/xmemallocatephysicalpages"},{"title":"Xmemallocdefault","href":"/reference/system/xmem/functions/xmemallocdefault"},{"title":"XMemCreateWin32Heap","description":"XMemCreateWin32Heap","sidebarTitle":"XMemCreateWin32Heap","href":"/reference/system/xmem/functions/xmemcreatewin32heap"},{"title":"Xmemfree","href":"/reference/system/xmem/functions/xmemfree"},{"title":"XMEMFREE_ROUTINE callback","description":"XMEMFREE_ROUTINE callback","sidebarTitle":"XMEMFREE_ROUTINE callback","href":"/reference/system/xmem/functions/xmemfree_routine"},{"title":"XMemFreeDefault","description":"XMemFreeDefault","sidebarTitle":"XMemFreeDefault","href":"/reference/system/xmem/functions/xmemfreedefault"},{"title":"XMemFreePhysicalPages","description":"XMemFreePhysicalPages","sidebarTitle":"XMemFreePhysicalPages","href":"/reference/system/xmem/functions/xmemfreephysicalpages"},{"title":"Xmemgetallocationhysteresis","href":"/reference/system/xmem/functions/xmemgetallocationhysteresis"},{"title":"Xmemgetallocationstatistics","href":"/reference/system/xmem/functions/xmemgetallocationstatistics"},{"title":"Xmemgetphysicalmemorylayout","href":"/reference/system/xmem/functions/xmemgetphysicalmemorylayout"},{"title":"XMemGetTitleHeap","description":"XMemGetTitleHeap","sidebarTitle":"XMemGetTitleHeap","href":"/reference/system/xmem/functions/xmemgettitleheap"},{"title":"XMemGetWin32HeapName","description":"XMemGetWin32HeapName","sidebarTitle":"XMemGetWin32HeapName","href":"/reference/system/xmem/functions/xmemgetwin32heapname"},{"title":"XMemGetWin32HeapStatistics","description":"XMemGetWin32HeapStatistics","sidebarTitle":"XMemGetWin32HeapStatistics","href":"/reference/system/xmem/functions/xmemgetwin32heapstatistics"},{"title":"XMemGetWorkingSetStatistics","description":"XMemGetWorkingSetStatistics","sidebarTitle":"XMemGetWorkingSetStatistics","href":"/reference/system/xmem/functions/xmemgetworkingsetstatistics"},{"title":"Xmemgetwritewatch","href":"/reference/system/xmem/functions/xmemgetwritewatch"},{"title":"XMemIsToolsMemAvailable","description":"XMemIsToolsMemAvailable","sidebarTitle":"XMemIsToolsMemAvailable","href":"/reference/system/xmem/functions/xmemistoolsmemavailable"},{"title":"XMemMakeTag","description":"XMemMakeTag","sidebarTitle":"XMemMakeTag","href":"/reference/system/xmem/functions/xmemmaketag"},{"title":"XMemMapPhysicalPages","description":"XMemMapPhysicalPages","sidebarTitle":"XMemMapPhysicalPages","href":"/reference/system/xmem/functions/xmemmapphysicalpages"},{"title":"XMemMapPhysicalPagesScatter","description":"XMemMapPhysicalPagesScatter","sidebarTitle":"XMemMapPhysicalPagesScatter","href":"/reference/system/xmem/functions/xmemmapphysicalpagesscatter"},{"title":"XMemPreallocateFreeSpace","description":"XMemPreallocateFreeSpace","sidebarTitle":"XMemPreallocateFreeSpace","href":"/reference/system/xmem/functions/xmempreallocatefreespace"},{"title":"Xmemresetwritewatch","href":"/reference/system/xmem/functions/xmemresetwritewatch"},{"title":"Xmemresumewritewatch","href":"/reference/system/xmem/functions/xmemresumewritewatch"},{"title":"XMemSetAllocationHooks","description":"XMemSetAllocationHooks","sidebarTitle":"XMemSetAllocationHooks","href":"/reference/system/xmem/functions/xmemsetallocationhooks"},{"title":"Xmemsetallocationhysteresis","href":"/reference/system/xmem/functions/xmemsetallocationhysteresis"},{"title":"XMemSetOption","description":"XMemSetOption","sidebarTitle":"XMemSetOption","href":"/reference/system/xmem/functions/xmemsetoption"},{"title":"XMemSetWin32HeapName","description":"XMemSetWin32HeapName","sidebarTitle":"XMemSetWin32HeapName","href":"/reference/system/xmem/functions/xmemsetwin32heapname"},{"title":"XMemSetWin32HeapTrackingHooks","description":"XMemSetWin32HeapTrackingHooks","sidebarTitle":"XMemSetWin32HeapTrackingHooks","href":"/reference/system/xmem/functions/xmemsetwin32heaptrackinghooks"},{"title":"Xmemtransfermemory","href":"/reference/system/xmem/functions/xmemtransfermemory"},{"title":"Xmemvirtualalloc","href":"/reference/system/xmem/functions/xmemvirtualalloc"},{"title":"XMemVirtualQuery","description":"XMemVirtualQuery","sidebarTitle":"XMemVirtualQuery","href":"/reference/system/xmem/functions/xmemvirtualquery"}]},{"group":"Structs","pages":[{"title":"WIN32_HEAP_STATISTICS","description":"WIN32_HEAP_STATISTICS","sidebarTitle":"WIN32_HEAP_STATISTICS","href":"/reference/system/xmem/structs/win32_heap_statistics"},{"title":"Xalloc attributes","href":"/reference/system/xmem/structs/xalloc_attributes"},{"title":"XMEM_ALLOCATION_HOOKS","description":"XMEM_ALLOCATION_HOOKS","sidebarTitle":"XMEM_ALLOCATION_HOOKS","href":"/reference/system/xmem/structs/xmem_allocation_hooks"},{"title":"Xmem basic information","href":"/reference/system/xmem/structs/xmem_basic_information"},{"title":"Xmem heap statistics","href":"/reference/system/xmem/structs/xmem_heap_statistics"},{"title":"XMEM_OPTION","description":"XMEM_OPTION","sidebarTitle":"XMEM_OPTION","href":"/reference/system/xmem/structs/xmem_option"},{"title":"Xmem physical memory layout","href":"/reference/system/xmem/structs/xmem_physical_memory_layout"},{"title":"Xmem working set statistics","href":"/reference/system/xmem/structs/xmem_working_set_statistics"}]}]},{"group":"XPackage","pages":[{"title":"XPackage","description":"XPackage","sidebarTitle":"XPackage","href":"/reference/system/xpackage/xpackage_members"},{"group":"Enums","pages":[{"title":"XPackageChunkAvailability","description":"XPackageChunkAvailability","sidebarTitle":"XPackageChunkAvailability","href":"/reference/system/xpackage/enums/xpackagechunkavailability"},{"title":"XPackageChunkSelectorType","description":"XPackageChunkSelectorType","sidebarTitle":"XPackageChunkSelectorType","href":"/reference/system/xpackage/enums/xpackagechunkselectortype"},{"title":"XPackageEnumerationScope","description":"XPackageEnumerationScope","sidebarTitle":"XPackageEnumerationScope","href":"/reference/system/xpackage/enums/xpackageenumerationscope"},{"title":"XPackageKind","description":"XPackageKind","sidebarTitle":"XPackageKind","href":"/reference/system/xpackage/enums/xpackagekind"}]},{"group":"Functions","pages":[{"title":"XPackageChangeChunkInstallOrder","description":"XPackageChangeChunkInstallOrder","sidebarTitle":"XPackageChangeChunkInstallOrder","href":"/reference/system/xpackage/functions/xpackagechangechunkinstallorder"},{"title":"XPackageChunkAvailabilityCallback","description":"XPackageChunkAvailabilityCallback","sidebarTitle":"XPackageChunkAvailabilityCallback","href":"/reference/system/xpackage/functions/xpackagechunkavailabilitycallback"},{"title":"XPackageCloseInstallationMonitorHandle","description":"XPackageCloseInstallationMonitorHandle","sidebarTitle":"XPackageCloseInstallationMonitorHandle","href":"/reference/system/xpackage/functions/xpackagecloseinstallationmonitorhandle"},{"title":"XPackageCloseMountHandle","description":"XPackageCloseMountHandle","sidebarTitle":"XPackageCloseMountHandle","href":"/reference/system/xpackage/functions/xpackageclosemounthandle"},{"title":"XPackageCreateInstallationMonitor","description":"XPackageCreateInstallationMonitor","sidebarTitle":"XPackageCreateInstallationMonitor","href":"/reference/system/xpackage/functions/xpackagecreateinstallationmonitor"},{"title":"XPackageEnumerateChunkAvailability","description":"XPackageEnumerateChunkAvailability","sidebarTitle":"XPackageEnumerateChunkAvailability","href":"/reference/system/xpackage/functions/xpackageenumeratechunkavailability"},{"title":"XPackageEnumerateFeatures","description":"XPackageEnumerateFeatures","sidebarTitle":"XPackageEnumerateFeatures","href":"/reference/system/xpackage/functions/xpackageenumeratefeatures"},{"title":"XPackageEnumeratePackages","description":"XPackageEnumeratePackages","sidebarTitle":"XPackageEnumeratePackages","href":"/reference/system/xpackage/functions/xpackageenumeratepackages"},{"title":"XPackageEnumerationCallback","description":"XPackageEnumerationCallback","sidebarTitle":"XPackageEnumerationCallback","href":"/reference/system/xpackage/functions/xpackageenumerationcallback"},{"title":"XPackageEstimateDownloadSize","description":"XPackageEstimateDownloadSize","sidebarTitle":"XPackageEstimateDownloadSize","href":"/reference/system/xpackage/functions/xpackageestimatedownloadsize"},{"title":"XPackageFeatureEnumerationCallback","description":"XPackageFeatureEnumerationCallback","sidebarTitle":"XPackageFeatureEnumerationCallback","href":"/reference/system/xpackage/functions/xpackagefeatureenumerationcallback"},{"title":"XPackageFindChunkAvailability","description":"XPackageFindChunkAvailability","sidebarTitle":"XPackageFindChunkAvailability","href":"/reference/system/xpackage/functions/xpackagefindchunkavailability"},{"title":"XPackageGetCurrentProcessPackageIdentifier","description":"XPackageGetCurrentProcessPackageIdentifier","sidebarTitle":"XPackageGetCurrentProcessPackageIdentifier","href":"/reference/system/xpackage/functions/xpackagegetcurrentprocesspackageidentifier"},{"title":"XPackageGetInstallationProgress","description":"XPackageGetInstallationProgress","sidebarTitle":"XPackageGetInstallationProgress","href":"/reference/system/xpackage/functions/xpackagegetinstallationprogress"},{"title":"XPackageGetMountPath","description":"XPackageGetMountPath","sidebarTitle":"XPackageGetMountPath","href":"/reference/system/xpackage/functions/xpackagegetmountpath"},{"title":"XPackageGetPackageKind","description":"XPackageGetPackageKind","sidebarTitle":"XPackageGetPackageKind","href":"/reference/system/xpackage/functions/xpackagegetpackagekind"},{"title":"XPackageGetMountPathSize","description":"XPackageGetMountPathSize","sidebarTitle":"XPackageGetMountPathSize","href":"/reference/system/xpackage/functions/xpackagegetmountpathsize"},{"title":"XPackageGetUserLocale","description":"XPackageGetUserLocale","sidebarTitle":"XPackageGetUserLocale","href":"/reference/system/xpackage/functions/xpackagegetuserlocale"},{"title":"XPackageGetWriteStats","description":"XPackageGetWriteStats","sidebarTitle":"XPackageGetWriteStats","href":"/reference/system/xpackage/functions/xpackagegetwritestats"},{"title":"XPackageInstallationProgressCallback","description":"XPackageInstallationProgressCallback","sidebarTitle":"XPackageInstallationProgressCallback","href":"/reference/system/xpackage/functions/xpackageinstallationprogresscallback"},{"title":"XPackageInstallChunks","description":"XPackageInstallChunks","sidebarTitle":"XPackageInstallChunks","href":"/reference/system/xpackage/functions/xpackageinstallchunks"},{"title":"XPackageInstallChunksAsync","description":"XPackageInstallChunksAsync","sidebarTitle":"XPackageInstallChunksAsync","href":"/reference/system/xpackage/functions/xpackageinstallchunksasync"},{"title":"XPackageInstallChunksResult","description":"XPackageInstallChunksResult","sidebarTitle":"XPackageInstallChunksResult","href":"/reference/system/xpackage/functions/xpackageinstallchunksresult"},{"title":"XPackageInstalledCallback","description":"XPackageInstalledCallback","sidebarTitle":"XPackageInstalledCallback","href":"/reference/system/xpackage/functions/xpackageinstalledcallback"},{"title":"XPackageIsPackagedProcess","description":"XPackageIsPackagedProcess","sidebarTitle":"XPackageIsPackagedProcess","href":"/reference/system/xpackage/functions/xpackageispackagedprocess"},{"title":"[DEPRECATED] XPackageMount","description":"[DEPRECATED] XPackageMount","sidebarTitle":"[DEPRECATED] XPackageMount","href":"/reference/system/xpackage/functions/xpackagemount"},{"title":"XPackageMountWithUiAsync","description":"XPackageMountWithUiAsync","sidebarTitle":"XPackageMountWithUiAsync","href":"/reference/system/xpackage/functions/xpackagemountwithuiasync"},{"title":"XPackageMountWithUiResult","description":"XPackageMountWithUiResult","sidebarTitle":"XPackageMountWithUiResult","href":"/reference/system/xpackage/functions/xpackagemountwithuiresult"},{"title":"XPackageRegisterInstallationProgressChanged","description":"XPackageRegisterInstallationProgressChanged","sidebarTitle":"XPackageRegisterInstallationProgressChanged","href":"/reference/system/xpackage/functions/xpackageregisterinstallationprogresschanged"},{"title":"XPackageRegisterPackageInstalled","description":"XPackageRegisterPackageInstalled","sidebarTitle":"XPackageRegisterPackageInstalled","href":"/reference/system/xpackage/functions/xpackageregisterpackageinstalled"},{"title":"XPackageUninstallChunks","description":"XPackageUninstallChunks","sidebarTitle":"XPackageUninstallChunks","href":"/reference/system/xpackage/functions/xpackageuninstallchunks"},{"title":"XPackageUninstallPackage","description":"XPackageUninstallPackage","sidebarTitle":"XPackageUninstallPackage","href":"/reference/system/xpackage/functions/xpackageuninstallpackage"},{"title":"XPackageUninstallUWPInstance","description":"XPackageUninstallUWPInstance","sidebarTitle":"XPackageUninstallUWPInstance","href":"/reference/system/xpackage/functions/xpackageuninstalluwpinstance"},{"title":"XPackageUnregisterInstallationProgressChanged","description":"XPackageUnregisterInstallationProgressChanged","sidebarTitle":"XPackageUnregisterInstallationProgressChanged","href":"/reference/system/xpackage/functions/xpackageunregisterinstallationprogresschanged"},{"title":"XPackageUnregisterPackageInstalled","description":"XPackageUnregisterPackageInstalled","sidebarTitle":"XPackageUnregisterPackageInstalled","href":"/reference/system/xpackage/functions/xpackageunregisterpackageinstalled"},{"title":"XPackageUpdateInstallationMonitor","description":"XPackageUpdateInstallationMonitor","sidebarTitle":"XPackageUpdateInstallationMonitor","href":"/reference/system/xpackage/functions/xpackageupdateinstallationmonitor"}]},{"group":"Structs","pages":[{"title":"XPackageChunkSelector","description":"XPackageChunkSelector","sidebarTitle":"XPackageChunkSelector","href":"/reference/system/xpackage/structs/xpackagechunkselector"},{"title":"XPackageDetails","description":"XPackageDetails","sidebarTitle":"XPackageDetails","href":"/reference/system/xpackage/structs/xpackagedetails"},{"title":"XPackageFeature","description":"XPackageFeature","sidebarTitle":"XPackageFeature","href":"/reference/system/xpackage/structs/xpackagefeature"},{"title":"XPackageInstallationProgress","description":"XPackageInstallationProgress","sidebarTitle":"XPackageInstallationProgress","href":"/reference/system/xpackage/structs/xpackageinstallationprogress"},{"title":"XPackageWriteStats","description":"XPackageWriteStats","sidebarTitle":"XPackageWriteStats","href":"/reference/system/xpackage/structs/xpackagewritestats"}]}]},{"group":"XPersistentLocalStorage","pages":[{"title":"XPersistentLocalStorage","description":"XPersistentLocalStorage","sidebarTitle":"XPersistentLocalStorage","href":"/reference/system/xpersistentlocalstorage/xpersistentlocalstorage_members"},{"group":"Functions","pages":[{"title":"XPersistentLocalStorageGetPath","description":"XPersistentLocalStorageGetPath","sidebarTitle":"XPersistentLocalStorageGetPath","href":"/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragegetpath"},{"title":"XPersistentLocalStorageGetPathSize","description":"XPersistentLocalStorageGetPathSize","sidebarTitle":"XPersistentLocalStorageGetPathSize","href":"/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragegetpathsize"},{"title":"XPersistentLocalStorageGetSpaceInfo","description":"XPersistentLocalStorageGetSpaceInfo","sidebarTitle":"XPersistentLocalStorageGetSpaceInfo","href":"/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragegetspaceinfo"},{"title":"XPersistentLocalStorageMountForPackage","description":"XPersistentLocalStorageMountForPackage","sidebarTitle":"XPersistentLocalStorageMountForPackage","href":"/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragemountforpackage"},{"title":"XPersistentLocalStoragePromptUserForSpaceAsync","description":"XPersistentLocalStoragePromptUserForSpaceAsync","sidebarTitle":"XPersistentLocalStoragePromptUserForSpaceAsync","href":"/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragepromptuserforspaceasync"},{"title":"XPersistentLocalStoragePromptUserForSpaceResult","description":"XPersistentLocalStoragePromptUserForSpaceResult","sidebarTitle":"XPersistentLocalStoragePromptUserForSpaceResult","href":"/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragepromptuserforspaceresult"}]},{"group":"Structs","pages":[{"title":"XPersistentLocalStorageSpaceInfo","description":"XPersistentLocalStorageSpaceInfo","sidebarTitle":"XPersistentLocalStorageSpaceInfo","href":"/reference/system/xpersistentlocalstorage/structs/xpersistentlocalstoragespaceinfo"}]}]},{"group":"XSpeechSynthesizer","pages":[{"title":"XSpeechSynthesizer","description":"XSpeechSynthesizer","sidebarTitle":"XSpeechSynthesizer","href":"/reference/system/xspeechsynthesizer/xspeechsynthesizer_members"},{"group":"Enums","pages":[{"title":"XSpeechSynthesizerVoiceGender","description":"XSpeechSynthesizerVoiceGender","sidebarTitle":"XSpeechSynthesizerVoiceGender","href":"/reference/system/xspeechsynthesizer/enums/xspeechsynthesizervoicegender"}]},{"group":"Structs","pages":[{"title":"XSpeechSynthesizerVoiceInformation","description":"XSpeechSynthesizerVoiceInformation","sidebarTitle":"XSpeechSynthesizerVoiceInformation","href":"/reference/system/xspeechsynthesizer/structs/xspeechsynthesizervoiceinformation"}]},{"group":"Functions","pages":[{"title":"XSpeechSynthesizerCloseHandle","description":"XSpeechSynthesizerCloseHandle","sidebarTitle":"XSpeechSynthesizerCloseHandle","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizerclosehandle"},{"title":"XSpeechSynthesizerCloseStreamHandle","description":"XSpeechSynthesizerCloseStreamHandle","sidebarTitle":"XSpeechSynthesizerCloseStreamHandle","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizerclosestreamhandle"},{"title":"XSpeechSynthesizerCreate","description":"XSpeechSynthesizerCreate","sidebarTitle":"XSpeechSynthesizerCreate","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizercreate"},{"title":"XSpeechSynthesizerCreateStreamFromSsml","description":"XSpeechSynthesizerCreateStreamFromSsml","sidebarTitle":"XSpeechSynthesizerCreateStreamFromSsml","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizercreatestreamfromssml"},{"title":"XSpeechSynthesizerCreateStreamFromText","description":"XSpeechSynthesizerCreateStreamFromText","sidebarTitle":"XSpeechSynthesizerCreateStreamFromText","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizercreatestreamfromtext"},{"title":"XSpeechSynthesizerEnumerateInstalledVoices","description":"XSpeechSynthesizerEnumerateInstalledVoices","sidebarTitle":"XSpeechSynthesizerEnumerateInstalledVoices","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizerenumerateinstalledvoices"},{"title":"XSpeechSynthesizerGetStreamData","description":"XSpeechSynthesizerGetStreamData","sidebarTitle":"XSpeechSynthesizerGetStreamData","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizergetstreamdata"},{"title":"XSpeechSynthesizerGetStreamDataSize","description":"XSpeechSynthesizerGetStreamDataSize","sidebarTitle":"XSpeechSynthesizerGetStreamDataSize","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizergetstreamdatasize"},{"title":"XSpeechSynthesizerInstalledVoicesCallback","description":"XSpeechSynthesizerInstalledVoicesCallback","sidebarTitle":"XSpeechSynthesizerInstalledVoicesCallback","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizerinstalledvoicescallback"},{"title":"XSpeechSynthesizerSetCustomVoice","description":"XSpeechSynthesizerSetCustomVoice","sidebarTitle":"XSpeechSynthesizerSetCustomVoice","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizersetcustomvoice"},{"title":"XSpeechSynthesizerSetDefaultVoice","description":"XSpeechSynthesizerSetDefaultVoice","sidebarTitle":"XSpeechSynthesizerSetDefaultVoice","href":"/reference/system/xspeechsynthesizer/functions/xspeechsynthesizersetdefaultvoice"}]}]},{"group":"XStore","pages":[{"title":"XStore","description":"XStore","sidebarTitle":"XStore","href":"/reference/system/xstore/xstore_members"},{"group":"Enums","pages":[{"title":"XStoreCanLicenseStatus","description":"XStoreCanLicenseStatus","sidebarTitle":"XStoreCanLicenseStatus","href":"/reference/system/xstore/enums/xstorecanlicensestatus"},{"title":"XStoreDurationUnit","description":"XStoreDurationUnit","sidebarTitle":"XStoreDurationUnit","href":"/reference/system/xstore/enums/xstoredurationunit"},{"title":"XStoreProductKind","description":"XStoreProductKind","sidebarTitle":"XStoreProductKind","href":"/reference/system/xstore/enums/xstoreproductkind"}]},{"group":"Functions","pages":[{"title":"XStoreAcquireLicenseForDurablesAsync","description":"XStoreAcquireLicenseForDurablesAsync","sidebarTitle":"XStoreAcquireLicenseForDurablesAsync","href":"/reference/system/xstore/functions/xstoreacquirelicensefordurablesasync"},{"title":"XStoreAcquireLicenseForDurablesResult","description":"XStoreAcquireLicenseForDurablesResult","sidebarTitle":"XStoreAcquireLicenseForDurablesResult","href":"/reference/system/xstore/functions/xstoreacquirelicensefordurablesresult"},{"title":"XStoreAcquireLicenseForPackageAsync","description":"XStoreAcquireLicenseForPackageAsync","sidebarTitle":"XStoreAcquireLicenseForPackageAsync","href":"/reference/system/xstore/functions/xstoreacquirelicenseforpackageasync"},{"title":"XStoreAcquireLicenseForPackageResult","description":"XStoreAcquireLicenseForPackageResult","sidebarTitle":"XStoreAcquireLicenseForPackageResult","href":"/reference/system/xstore/functions/xstoreacquirelicenseforpackageresult"},{"title":"XStoreCanAcquireLicenseForPackageAsync","description":"XStoreCanAcquireLicenseForPackageAsync","sidebarTitle":"XStoreCanAcquireLicenseForPackageAsync","href":"/reference/system/xstore/functions/xstorecanacquirelicenseforpackageasync"},{"title":"XStoreCanAcquireLicenseForPackageResult","description":"XStoreCanAcquireLicenseForPackageResult","sidebarTitle":"XStoreCanAcquireLicenseForPackageResult","href":"/reference/system/xstore/functions/xstorecanacquirelicenseforpackageresult"},{"title":"XStoreCanAcquireLicenseForStoreIdAsync","description":"XStoreCanAcquireLicenseForStoreIdAsync","sidebarTitle":"XStoreCanAcquireLicenseForStoreIdAsync","href":"/reference/system/xstore/functions/xstorecanacquirelicenseforstoreidasync"},{"title":"XStoreCanAcquireLicenseForStoreIdResult","description":"XStoreCanAcquireLicenseForStoreIdResult","sidebarTitle":"XStoreCanAcquireLicenseForStoreIdResult","href":"/reference/system/xstore/functions/xstorecanacquirelicenseforstoreidresult"},{"title":"XStoreCloseContextHandle","description":"XStoreCloseContextHandle","sidebarTitle":"XStoreCloseContextHandle","href":"/reference/system/xstore/functions/xstoreclosecontexthandle"},{"title":"XStoreCloseLicenseHandle","description":"XStoreCloseLicenseHandle","sidebarTitle":"XStoreCloseLicenseHandle","href":"/reference/system/xstore/functions/xstorecloselicensehandle"},{"title":"XStoreCloseProductsQueryHandle","description":"XStoreCloseProductsQueryHandle","sidebarTitle":"XStoreCloseProductsQueryHandle","href":"/reference/system/xstore/functions/xstorecloseproductsqueryhandle"},{"title":"XStoreCreateContext","description":"XStoreCreateContext","sidebarTitle":"XStoreCreateContext","href":"/reference/system/xstore/functions/xstorecreatecontext"},{"title":"XStoreDownloadAndInstallPackagesAsync","description":"XStoreDownloadAndInstallPackagesAsync","sidebarTitle":"XStoreDownloadAndInstallPackagesAsync","href":"/reference/system/xstore/functions/xstoredownloadandinstallpackagesasync"},{"title":"XStoreDownloadAndInstallPackagesResult","description":"XStoreDownloadAndInstallPackagesResult","sidebarTitle":"XStoreDownloadAndInstallPackagesResult","href":"/reference/system/xstore/functions/xstoredownloadandinstallpackagesresult"},{"title":"XStoreDownloadAndInstallPackagesResultCount","description":"XStoreDownloadAndInstallPackagesResultCount","sidebarTitle":"XStoreDownloadAndInstallPackagesResultCount","href":"/reference/system/xstore/functions/xstoredownloadandinstallpackagesresultcount"},{"title":"XStoreDownloadAndInstallPackageUpdatesAsync","description":"XStoreDownloadAndInstallPackageUpdatesAsync","sidebarTitle":"XStoreDownloadAndInstallPackageUpdatesAsync","href":"/reference/system/xstore/functions/xstoredownloadandinstallpackageupdatesasync"},{"title":"XStoreDownloadAndInstallPackageUpdatesResult","description":"XStoreDownloadAndInstallPackageUpdatesResult","sidebarTitle":"XStoreDownloadAndInstallPackageUpdatesResult","href":"/reference/system/xstore/functions/xstoredownloadandinstallpackageupdatesresult"},{"title":"XStoreDownloadPackageUpdatesAsync","description":"XStoreDownloadPackageUpdatesAsync","sidebarTitle":"XStoreDownloadPackageUpdatesAsync","href":"/reference/system/xstore/functions/xstoredownloadpackageupdatesasync"},{"title":"XStoreDownloadPackageUpdatesResult","description":"XStoreDownloadPackageUpdatesResult","sidebarTitle":"XStoreDownloadPackageUpdatesResult","href":"/reference/system/xstore/functions/xstoredownloadpackageupdatesresult"},{"title":"XStoreEnumerateProductsQuery","description":"XStoreEnumerateProductsQuery","sidebarTitle":"XStoreEnumerateProductsQuery","href":"/reference/system/xstore/functions/xstoreenumerateproductsquery"},{"title":"XStoreGameLicenseChangedCallback","description":"XStoreGameLicenseChangedCallback","sidebarTitle":"XStoreGameLicenseChangedCallback","href":"/reference/system/xstore/functions/xstoregamelicensechangedcallback"},{"title":"XStoreGetUserCollectionsIdAsync","description":"XStoreGetUserCollectionsIdAsync","sidebarTitle":"XStoreGetUserCollectionsIdAsync","href":"/reference/system/xstore/functions/xstoregetusercollectionsidasync"},{"title":"XStoreGetUserCollectionsIdResult","description":"XStoreGetUserCollectionsIdResult","sidebarTitle":"XStoreGetUserCollectionsIdResult","href":"/reference/system/xstore/functions/xstoregetusercollectionsidresult"},{"title":"XStoreGetUserCollectionsIdResultSize","description":"XStoreGetUserCollectionsIdResultSize","sidebarTitle":"XStoreGetUserCollectionsIdResultSize","href":"/reference/system/xstore/functions/xstoregetusercollectionsidresultsize"},{"title":"XStoreGetUserPurchaseIdAsync","description":"XStoreGetUserPurchaseIdAsync","sidebarTitle":"XStoreGetUserPurchaseIdAsync","href":"/reference/system/xstore/functions/xstoregetuserpurchaseidasync"},{"title":"XStoreGetUserPurchaseIdResult","description":"XStoreGetUserPurchaseIdResult","sidebarTitle":"XStoreGetUserPurchaseIdResult","href":"/reference/system/xstore/functions/xstoregetuserpurchaseidresult"},{"title":"XStoreGetUserPurchaseIdResultSize","description":"XStoreGetUserPurchaseIdResultSize","sidebarTitle":"XStoreGetUserPurchaseIdResultSize","href":"/reference/system/xstore/functions/xstoregetuserpurchaseidresultsize"},{"title":"XStoreIsLicenseValid","description":"XStoreIsLicenseValid","sidebarTitle":"XStoreIsLicenseValid","href":"/reference/system/xstore/functions/xstoreislicensevalid"},{"title":"XStorePackageLicenseLostCallback","description":"XStorePackageLicenseLostCallback","sidebarTitle":"XStorePackageLicenseLostCallback","href":"/reference/system/xstore/functions/xstorepackagelicenselostcallback"},{"title":"XStoreProductQueryCallback","description":"XStoreProductQueryCallback","sidebarTitle":"XStoreProductQueryCallback","href":"/reference/system/xstore/functions/xstoreproductquerycallback"},{"title":"XStoreProductsQueryHasMorePages","description":"XStoreProductsQueryHasMorePages","sidebarTitle":"XStoreProductsQueryHasMorePages","href":"/reference/system/xstore/functions/xstoreproductsqueryhasmorepages"},{"title":"XStoreProductsQueryNextPageAsync","description":"XStoreProductsQueryNextPageAsync","sidebarTitle":"XStoreProductsQueryNextPageAsync","href":"/reference/system/xstore/functions/xstoreproductsquerynextpageasync"},{"title":"XStoreProductsQueryNextPageResult","description":"XStoreProductsQueryNextPageResult","sidebarTitle":"XStoreProductsQueryNextPageResult","href":"/reference/system/xstore/functions/xstoreproductsquerynextpageresult"},{"title":"XStoreQueryAddOnLicensesAsync","description":"XStoreQueryAddOnLicensesAsync","sidebarTitle":"XStoreQueryAddOnLicensesAsync","href":"/reference/system/xstore/functions/xstorequeryaddonlicensesasync"},{"title":"XStoreQueryAddOnLicensesResult","description":"XStoreQueryAddOnLicensesResult","sidebarTitle":"XStoreQueryAddOnLicensesResult","href":"/reference/system/xstore/functions/xstorequeryaddonlicensesresult"},{"title":"XStoreQueryAddOnLicensesResultCount","description":"XStoreQueryAddOnLicensesResultCount","sidebarTitle":"XStoreQueryAddOnLicensesResultCount","href":"/reference/system/xstore/functions/xstorequeryaddonlicensesresultcount"},{"title":"XStoreQueryAssociatedProductsAsync","description":"XStoreQueryAssociatedProductsAsync","sidebarTitle":"XStoreQueryAssociatedProductsAsync","href":"/reference/system/xstore/functions/xstorequeryassociatedproductsasync"},{"title":"XStoreQueryAssociatedProductsForStoreIdAsync","description":"XStoreQueryAssociatedProductsForStoreIdAsync","sidebarTitle":"XStoreQueryAssociatedProductsForStoreIdAsync","href":"/reference/system/xstore/functions/xstorequeryassociatedproductsforstoreidasync"},{"title":"XStoreQueryAssociatedProductsForStoreIdResult","description":"XStoreQueryAssociatedProductsForStoreIdResult","sidebarTitle":"XStoreQueryAssociatedProductsForStoreIdResult","href":"/reference/system/xstore/functions/xstorequeryassociatedproductsforstoreidresult"},{"title":"XStoreQueryAssociatedProductsResult","description":"XStoreQueryAssociatedProductsResult","sidebarTitle":"XStoreQueryAssociatedProductsResult","href":"/reference/system/xstore/functions/xstorequeryassociatedproductsresult"},{"title":"XStoreQueryConsumableBalanceRemainingAsync","description":"XStoreQueryConsumableBalanceRemainingAsync","sidebarTitle":"XStoreQueryConsumableBalanceRemainingAsync","href":"/reference/system/xstore/functions/xstorequeryconsumablebalanceremainingasync"},{"title":"XStoreQueryConsumableBalanceRemainingResult","description":"XStoreQueryConsumableBalanceRemainingResult","sidebarTitle":"XStoreQueryConsumableBalanceRemainingResult","href":"/reference/system/xstore/functions/xstorequeryconsumablebalanceremainingresult"},{"title":"XStoreQueryEntitledProductsAsync","description":"XStoreQueryEntitledProductsAsync","sidebarTitle":"XStoreQueryEntitledProductsAsync","href":"/reference/system/xstore/functions/xstorequeryentitledproductsasync"},{"title":"XStoreQueryEntitledProductsResult","description":"XStoreQueryEntitledProductsResult","sidebarTitle":"XStoreQueryEntitledProductsResult","href":"/reference/system/xstore/functions/xstorequeryentitledproductsresult"},{"title":"XStoreQueryGameAndDlcPackageUpdatesAsync","description":"XStoreQueryGameAndDlcPackageUpdatesAsync","sidebarTitle":"XStoreQueryGameAndDlcPackageUpdatesAsync","href":"/reference/system/xstore/functions/xstorequerygameanddlcpackageupdatesasync"},{"title":"XStoreQueryGameAndDlcPackageUpdatesResult","description":"XStoreQueryGameAndDlcPackageUpdatesResult","sidebarTitle":"XStoreQueryGameAndDlcPackageUpdatesResult","href":"/reference/system/xstore/functions/xstorequerygameanddlcpackageupdatesresult"},{"title":"XStoreQueryGameAndDlcPackageUpdatesResultCount","description":"XStoreQueryGameAndDlcPackageUpdatesResultCount","sidebarTitle":"XStoreQueryGameAndDlcPackageUpdatesResultCount","href":"/reference/system/xstore/functions/xstorequerygameanddlcpackageupdatesresultcount"},{"title":"XStoreQueryGameLicenseAsync","description":"XStoreQueryGameLicenseAsync","sidebarTitle":"XStoreQueryGameLicenseAsync","href":"/reference/system/xstore/functions/xstorequerygamelicenseasync"},{"title":"XStoreQueryGameLicenseResult","description":"XStoreQueryGameLicenseResult","sidebarTitle":"XStoreQueryGameLicenseResult","href":"/reference/system/xstore/functions/xstorequerygamelicenseresult"},{"title":"XStoreQueryLicenseTokenAsync","description":"Reference for XStoreQueryLicenseTokenAsync, a GDK XStore licensing function that retrieves a JSON Web Token for entitlement validation and B2B calls.","sidebarTitle":"XStoreQueryLicenseTokenAsync","href":"/reference/system/xstore/functions/xstorequerylicensetokenasync"},{"title":"XStoreQueryLicenseTokenResult","description":"XStoreQueryLicenseTokenResult","sidebarTitle":"XStoreQueryLicenseTokenResult","href":"/reference/system/xstore/functions/xstorequerylicensetokenresult"},{"title":"XStoreQueryLicenseTokenResultSize","description":"XStoreQueryLicenseTokenResultSize","sidebarTitle":"XStoreQueryLicenseTokenResultSize","href":"/reference/system/xstore/functions/xstorequerylicensetokenresultsize"},{"title":"XStoreQueryPackageIdentifier","description":"XStoreQueryPackageIdentifier","sidebarTitle":"XStoreQueryPackageIdentifier","href":"/reference/system/xstore/functions/xstorequerypackageidentifier"},{"title":"XStoreQueryPackageUpdatesAsync","description":"XStoreQueryPackageUpdatesAsync","sidebarTitle":"XStoreQueryPackageUpdatesAsync","href":"/reference/system/xstore/functions/xstorequerypackageupdatesasync"},{"title":"XStoreQueryPackageUpdatesResult","description":"XStoreQueryPackageUpdatesResult","sidebarTitle":"XStoreQueryPackageUpdatesResult","href":"/reference/system/xstore/functions/xstorequerypackageupdatesresult"},{"title":"XStoreQueryPackageUpdatesResultCount","description":"XStoreQueryPackageUpdatesResultCount","sidebarTitle":"XStoreQueryPackageUpdatesResultCount","href":"/reference/system/xstore/functions/xstorequerypackageupdatesresultcount"},{"title":"XStoreQueryProductForCurrentGameAsync","description":"XStoreQueryProductForCurrentGameAsync","sidebarTitle":"XStoreQueryProductForCurrentGameAsync","href":"/reference/system/xstore/functions/xstorequeryproductforcurrentgameasync"},{"title":"XStoreQueryProductForCurrentGameResult","description":"XStoreQueryProductForCurrentGameResult","sidebarTitle":"XStoreQueryProductForCurrentGameResult","href":"/reference/system/xstore/functions/xstorequeryproductforcurrentgameresult"},{"title":"XStoreQueryProductForPackageAsync","description":"XStoreQueryProductForPackageAsync","sidebarTitle":"XStoreQueryProductForPackageAsync","href":"/reference/system/xstore/functions/xstorequeryproductforpackageasync"},{"title":"XStoreQueryProductForPackageResult","description":"XStoreQueryProductForPackageResult","sidebarTitle":"XStoreQueryProductForPackageResult","href":"/reference/system/xstore/functions/xstorequeryproductforpackageresult"},{"title":"XStoreQueryProductsAsync","description":"XStoreQueryProductsAsync","sidebarTitle":"XStoreQueryProductsAsync","href":"/reference/system/xstore/functions/xstorequeryproductsasync"},{"title":"XStoreQueryProductsResult","description":"XStoreQueryProductsResult","sidebarTitle":"XStoreQueryProductsResult","href":"/reference/system/xstore/functions/xstorequeryproductsresult"},{"title":"XStoreRegisterGameLicenseChanged","description":"XStoreRegisterGameLicenseChanged","sidebarTitle":"XStoreRegisterGameLicenseChanged","href":"/reference/system/xstore/functions/xstoreregistergamelicensechanged"},{"title":"XStoreRegisterPackageLicenseLost","description":"XStoreRegisterPackageLicenseLost","sidebarTitle":"XStoreRegisterPackageLicenseLost","href":"/reference/system/xstore/functions/xstoreregisterpackagelicenselost"},{"title":"XStoreReportConsumableFulfillmentAsync","description":"XStoreReportConsumableFulfillmentAsync","sidebarTitle":"XStoreReportConsumableFulfillmentAsync","href":"/reference/system/xstore/functions/xstorereportconsumablefulfillmentasync"},{"title":"XStoreReportConsumableFulfillmentResult","description":"XStoreReportConsumableFulfillmentResult","sidebarTitle":"XStoreReportConsumableFulfillmentResult","href":"/reference/system/xstore/functions/xstorereportconsumablefulfillmentresult"},{"title":"XStoreShowAssociatedProductsUIAsync","description":"XStoreShowAssociatedProductsUIAsync","sidebarTitle":"XStoreShowAssociatedProductsUIAsync","href":"/reference/system/xstore/functions/xstoreshowassociatedproductsuiasync"},{"title":"XStoreShowAssociatedProductsUIResult","description":"XStoreShowAssociatedProductsUIResult","sidebarTitle":"XStoreShowAssociatedProductsUIResult","href":"/reference/system/xstore/functions/xstoreshowassociatedproductsuiresult"},{"title":"XStoreShowGiftingUIAsync","description":"XStoreShowGiftingUIAsync","sidebarTitle":"XStoreShowGiftingUIAsync","href":"/reference/system/xstore/functions/xstoreshowgiftinguiasync"},{"title":"XStoreShowGiftingUIResult","description":"XStoreShowGiftingUIResult","sidebarTitle":"XStoreShowGiftingUIResult","href":"/reference/system/xstore/functions/xstoreshowgiftinguiresult"},{"title":"XStoreShowProductPageUIAsync","description":"XStoreShowProductPageUIAsync","sidebarTitle":"XStoreShowProductPageUIAsync","href":"/reference/system/xstore/functions/xstoreshowproductpageuiasync"},{"title":"XStoreShowProductPageUIResult","description":"XStoreShowProductPageUIResult","sidebarTitle":"XStoreShowProductPageUIResult","href":"/reference/system/xstore/functions/xstoreshowproductpageuiresult"},{"title":"XStoreShowPurchaseUIAsync","description":"XStoreShowPurchaseUIAsync","sidebarTitle":"XStoreShowPurchaseUIAsync","href":"/reference/system/xstore/functions/xstoreshowpurchaseuiasync"},{"title":"XStoreShowPurchaseUIResult","description":"XStoreShowPurchaseUIResult","sidebarTitle":"XStoreShowPurchaseUIResult","href":"/reference/system/xstore/functions/xstoreshowpurchaseuiresult"},{"title":"XStoreShowRateAndReviewUIAsync","description":"XStoreShowRateAndReviewUIAsync","sidebarTitle":"XStoreShowRateAndReviewUIAsync","href":"/reference/system/xstore/functions/xstoreshowrateandreviewuiasync"},{"title":"XStoreShowRateAndReviewUIResult","description":"XStoreShowRateAndReviewUIResult","sidebarTitle":"XStoreShowRateAndReviewUIResult","href":"/reference/system/xstore/functions/xstoreshowrateandreviewuiresult"},{"title":"XStoreShowRedeemTokenUIAsync","description":"XStoreShowRedeemTokenUIAsync","sidebarTitle":"XStoreShowRedeemTokenUIAsync","href":"/reference/system/xstore/functions/xstoreshowredeemtokenuiasync"},{"title":"XStoreShowRedeemTokenUIResult","description":"XStoreShowRedeemTokenUIResult","sidebarTitle":"XStoreShowRedeemTokenUIResult","href":"/reference/system/xstore/functions/xstoreshowredeemtokenuiresult"},{"title":"XStoreUnregisterGameLicenseChanged","description":"XStoreUnregisterGameLicenseChanged","sidebarTitle":"XStoreUnregisterGameLicenseChanged","href":"/reference/system/xstore/functions/xstoreunregistergamelicensechanged"},{"title":"XStoreUnregisterPackageLicenseLost","description":"XStoreUnregisterPackageLicenseLost","sidebarTitle":"XStoreUnregisterPackageLicenseLost","href":"/reference/system/xstore/functions/xstoreunregisterpackagelicenselost"}]},{"group":"Structs","pages":[{"title":"XStoreAddonLicense","description":"XStoreAddonLicense","sidebarTitle":"XStoreAddonLicense","href":"/reference/system/xstore/structs/xstoreaddonlicense"},{"title":"XStoreAvailability","description":"XStoreAvailability","sidebarTitle":"XStoreAvailability","href":"/reference/system/xstore/structs/xstoreavailability"},{"title":"XStoreCanAcquireLicenseResult","description":"XStoreCanAcquireLicenseResult","sidebarTitle":"XStoreCanAcquireLicenseResult","href":"/reference/system/xstore/structs/xstorecanacquirelicenseresult"},{"title":"XStoreCollectionData","description":"XStoreCollectionData","sidebarTitle":"XStoreCollectionData","href":"/reference/system/xstore/structs/xstorecollectiondata"},{"title":"XStoreConsumableResult","description":"XStoreConsumableResult","sidebarTitle":"XStoreConsumableResult","href":"/reference/system/xstore/structs/xstoreconsumableresult"},{"title":"XStoreGameLicense","description":"XStoreGameLicense","sidebarTitle":"XStoreGameLicense","href":"/reference/system/xstore/structs/xstoregamelicense"},{"title":"XStoreImage","description":"XStoreImage","sidebarTitle":"XStoreImage","href":"/reference/system/xstore/structs/xstoreimage"},{"title":"XStorePackageUpdate","description":"XStorePackageUpdate","sidebarTitle":"XStorePackageUpdate","href":"/reference/system/xstore/structs/xstorepackageupdate"},{"title":"XStorePrice","description":"XStorePrice","sidebarTitle":"XStorePrice","href":"/reference/system/xstore/structs/xstoreprice"},{"title":"XStoreProduct","description":"XStoreProduct","sidebarTitle":"XStoreProduct","href":"/reference/system/xstore/structs/xstoreproduct"},{"title":"XStoreRateAndReviewResult","description":"XStoreRateAndReviewResult","sidebarTitle":"XStoreRateAndReviewResult","href":"/reference/system/xstore/structs/xstorerateandreviewresult"},{"title":"XStoreSku","description":"XStoreSku","sidebarTitle":"XStoreSku","href":"/reference/system/xstore/structs/xstoresku"},{"title":"XStoreSubscriptionInfo","description":"XStoreSubscriptionInfo","sidebarTitle":"XStoreSubscriptionInfo","href":"/reference/system/xstore/structs/xstoresubscriptioninfo"},{"title":"XStoreVideo","description":"XStoreVideo","sidebarTitle":"XStoreVideo","href":"/reference/system/xstore/structs/xstorevideo"}]}]},{"group":"XSystem","pages":[{"title":"XSystem","description":"XSystem","sidebarTitle":"XSystem","href":"/reference/system/xsystem/xsystem_members"},{"group":"Enums","pages":[{"title":"XSystemDeviceType","description":"XSystemDeviceType","sidebarTitle":"XSystemDeviceType","href":"/reference/system/xsystem/enums/xsystemdevicetype"},{"title":"XSystemHandleCallbackReason","description":"XSystemHandleCallbackReason","sidebarTitle":"XSystemHandleCallbackReason","href":"/reference/system/xsystem/enums/xsystemhandlecallbackreason"},{"title":"XSystemHandleType","description":"XSystemHandleType","sidebarTitle":"XSystemHandleType","href":"/reference/system/xsystem/enums/xsystemhandletype"}]},{"group":"Functions","pages":[{"title":"XSystemAllowFullDownloadBandwidth","description":"XSystemAllowFullDownloadBandwidth","sidebarTitle":"XSystemAllowFullDownloadBandwidth","href":"/reference/system/xsystem/functions/xsystemallowfulldownloadbandwidth"},{"title":"XSystemGetAnalyticsInfo","description":"XSystemGetAnalyticsInfo","sidebarTitle":"XSystemGetAnalyticsInfo","href":"/reference/system/xsystem/functions/xsystemgetanalyticsinfo"},{"title":"XSystemGetAppSpecificDeviceId","description":"XSystemGetAppSpecificDeviceId","sidebarTitle":"XSystemGetAppSpecificDeviceId","href":"/reference/system/xsystem/functions/xsystemgetappspecificdeviceid"},{"title":"XSystemGetConsoleId","description":"XSystemGetConsoleId","sidebarTitle":"XSystemGetConsoleId","href":"/reference/system/xsystem/functions/xsystemgetconsoleid"},{"title":"XSystemGetDeviceType","description":"XSystemGetDeviceType","sidebarTitle":"XSystemGetDeviceType","href":"/reference/system/xsystem/functions/xsystemgetdevicetype"},{"title":"XSystemGetRuntimeInfo","description":"XSystemGetRuntimeInfo","sidebarTitle":"XSystemGetRuntimeInfo","href":"/reference/system/xsystem/functions/xsystemgetruntimeinfo"},{"title":"XSystemGetXboxLiveSandboxId","description":"XSystemGetXboxLiveSandboxId","sidebarTitle":"XSystemGetXboxLiveSandboxId","href":"/reference/system/xsystem/functions/xsystemgetxboxlivesandboxid"},{"title":"XSystemHandleCallback","description":"XSystemHandleCallback","sidebarTitle":"XSystemHandleCallback","href":"/reference/system/xsystem/functions/xsystemhandlecallback"},{"title":"XSystemHandleTrack","description":"XSystemHandleTrack","sidebarTitle":"XSystemHandleTrack","href":"/reference/system/xsystem/functions/xsystemhandletrack"},{"title":"XSystemIsHandleValid","description":"XSystemIsHandleValid","sidebarTitle":"XSystemIsHandleValid","href":"/reference/system/xsystem/functions/xsystemishandlevalid"}]},{"group":"Structs","pages":[{"title":"XSystemAnalyticsInfo","description":"XSystemAnalyticsInfo","sidebarTitle":"XSystemAnalyticsInfo","href":"/reference/system/xsystem/structs/xsystemanalyticsinfo"},{"title":"XSystemRuntimeInfo","description":"XSystemRuntimeInfo","sidebarTitle":"XSystemRuntimeInfo","href":"/reference/system/xsystem/structs/xsystemruntimeinfo"}]}]},{"group":"XTaskQueue","pages":[{"title":"XTaskQueue","description":"XTaskQueue","sidebarTitle":"XTaskQueue","href":"/reference/system/xtaskqueue/xtaskqueue_members"},{"group":"Enums","pages":[{"title":"XTaskQueueDispatchMode","description":"XTaskQueueDispatchMode","sidebarTitle":"XTaskQueueDispatchMode","href":"/reference/system/xtaskqueue/enums/xtaskqueuedispatchmode"},{"title":"XTaskQueuePort","description":"XTaskQueuePort","sidebarTitle":"XTaskQueuePort","href":"/reference/system/xtaskqueue/enums/xtaskqueueport"}]},{"group":"Functions","pages":[{"title":"XTaskQueueCallback","description":"XTaskQueueCallback","sidebarTitle":"XTaskQueueCallback","href":"/reference/system/xtaskqueue/functions/xtaskqueuecallback"},{"title":"XTaskQueueCloseHandle","description":"XTaskQueueCloseHandle","sidebarTitle":"XTaskQueueCloseHandle","href":"/reference/system/xtaskqueue/functions/xtaskqueueclosehandle"},{"title":"XTaskQueueCreate","description":"XTaskQueueCreate","sidebarTitle":"XTaskQueueCreate","href":"/reference/system/xtaskqueue/functions/xtaskqueuecreate"},{"title":"XTaskQueueCreateComposite","description":"XTaskQueueCreateComposite","sidebarTitle":"XTaskQueueCreateComposite","href":"/reference/system/xtaskqueue/functions/xtaskqueuecreatecomposite"},{"title":"XTaskQueueDispatch","description":"XTaskQueueDispatch","sidebarTitle":"XTaskQueueDispatch","href":"/reference/system/xtaskqueue/functions/xtaskqueuedispatch"},{"title":"XTaskQueueDuplicateHandle","description":"XTaskQueueDuplicateHandle","sidebarTitle":"XTaskQueueDuplicateHandle","href":"/reference/system/xtaskqueue/functions/xtaskqueueduplicatehandle"},{"title":"XTaskQueueGetCurrentProcessTaskQueue","description":"XTaskQueueGetCurrentProcessTaskQueue","sidebarTitle":"XTaskQueueGetCurrentProcessTaskQueue","href":"/reference/system/xtaskqueue/functions/xtaskqueuegetcurrentprocesstaskqueue"},{"title":"XTaskQueueGetPort","description":"XTaskQueueGetPort","sidebarTitle":"XTaskQueueGetPort","href":"/reference/system/xtaskqueue/functions/xtaskqueuegetport"},{"title":"XTaskQueueMonitorCallback","description":"XTaskQueueMonitorCallback","sidebarTitle":"XTaskQueueMonitorCallback","href":"/reference/system/xtaskqueue/functions/xtaskqueuemonitorcallback"},{"title":"XTaskQueueRegisterMonitor","description":"XTaskQueueRegisterMonitor","sidebarTitle":"XTaskQueueRegisterMonitor","href":"/reference/system/xtaskqueue/functions/xtaskqueueregistermonitor"},{"title":"XTaskQueueRegisterWaiter","description":"XTaskQueueRegisterWaiter","sidebarTitle":"XTaskQueueRegisterWaiter","href":"/reference/system/xtaskqueue/functions/xtaskqueueregisterwaiter"},{"title":"XTaskQueueSetCurrentProcessTaskQueue","description":"XTaskQueueSetCurrentProcessTaskQueue","sidebarTitle":"XTaskQueueSetCurrentProcessTaskQueue","href":"/reference/system/xtaskqueue/functions/xtaskqueuesetcurrentprocesstaskqueue"},{"title":"XTaskQueueSubmitCallback","description":"XTaskQueueSubmitCallback","sidebarTitle":"XTaskQueueSubmitCallback","href":"/reference/system/xtaskqueue/functions/xtaskqueuesubmitcallback"},{"title":"XTaskQueueSubmitDelayedCallback","description":"XTaskQueueSubmitDelayedCallback","sidebarTitle":"XTaskQueueSubmitDelayedCallback","href":"/reference/system/xtaskqueue/functions/xtaskqueuesubmitdelayedcallback"},{"title":"XTaskQueueTerminate","description":"XTaskQueueTerminate","sidebarTitle":"XTaskQueueTerminate","href":"/reference/system/xtaskqueue/functions/xtaskqueueterminate"},{"title":"XTaskQueueTerminatedCallback","description":"XTaskQueueTerminatedCallback","sidebarTitle":"XTaskQueueTerminatedCallback","href":"/reference/system/xtaskqueue/functions/xtaskqueueterminatedcallback"},{"title":"XTaskQueueUnregisterMonitor","description":"XTaskQueueUnregisterMonitor","sidebarTitle":"XTaskQueueUnregisterMonitor","href":"/reference/system/xtaskqueue/functions/xtaskqueueunregistermonitor"},{"title":"XTaskQueueUnregisterWaiter","description":"XTaskQueueUnregisterWaiter","sidebarTitle":"XTaskQueueUnregisterWaiter","href":"/reference/system/xtaskqueue/functions/xtaskqueueunregisterwaiter"}]},{"group":"Structs","pages":[{"title":"XTaskQueueRegistrationToken","description":"XTaskQueueRegistrationToken","sidebarTitle":"XTaskQueueRegistrationToken","href":"/reference/system/xtaskqueue/structs/xtaskqueueregistrationtoken"}]}]},{"group":"XThread","pages":[{"title":"XThread","description":"XThread","sidebarTitle":"XThread","href":"/reference/system/xthread/xthread_members"},{"group":"Functions","pages":[{"title":"XThreadAssertNotTimeSensitive","description":"XThreadAssertNotTimeSensitive","sidebarTitle":"XThreadAssertNotTimeSensitive","href":"/reference/system/xthread/functions/xthreadassertnottimesensitive"},{"title":"XThreadIsTimeSensitive","description":"XThreadIsTimeSensitive","sidebarTitle":"XThreadIsTimeSensitive","href":"/reference/system/xthread/functions/xthreadistimesensitive"},{"title":"XThreadSetTimeSensitive","description":"XThreadSetTimeSensitive","sidebarTitle":"XThreadSetTimeSensitive","href":"/reference/system/xthread/functions/xthreadsettimesensitive"}]}]},{"group":"XUser","pages":[{"title":"XUser","description":"XUser","sidebarTitle":"XUser","href":"/reference/system/xuser/xuser_members"},{"group":"Enums","pages":[{"title":"XUserAddOptions","description":"XUserAddOptions","sidebarTitle":"XUserAddOptions","href":"/reference/system/xuser/enums/xuseraddoptions"},{"title":"XUserAgeGroup","description":"XUserAgeGroup","sidebarTitle":"XUserAgeGroup","href":"/reference/system/xuser/enums/xuseragegroup"},{"title":"XUserChangeEvent","description":"XUserChangeEvent","sidebarTitle":"XUserChangeEvent","href":"/reference/system/xuser/enums/xuserchangeevent"},{"title":"XUserDefaultAudioEndpointKind","description":"XUserDefaultAudioEndpointKind","sidebarTitle":"XUserDefaultAudioEndpointKind","href":"/reference/system/xuser/enums/xuserdefaultaudioendpointkind"},{"title":"XUserGamerPictureSize","description":"XUserGamerPictureSize","sidebarTitle":"XUserGamerPictureSize","href":"/reference/system/xuser/enums/xusergamerpicturesize"},{"title":"XUserGamertagComponent","description":"XUserGamertagComponent","sidebarTitle":"XUserGamertagComponent","href":"/reference/system/xuser/enums/xusergamertagcomponent"},{"title":"XUserGetMsaTokenSilentlyOptions","description":"XUserGetMsaTokenSilentlyOptions","sidebarTitle":"XUserGetMsaTokenSilentlyOptions","href":"/reference/system/xuser/enums/xusergetmsatokensilentlyoptions"},{"title":"XUserGetTokenAndSignatureOptions","description":"XUserGetTokenAndSignatureOptions","sidebarTitle":"XUserGetTokenAndSignatureOptions","href":"/reference/system/xuser/enums/xusergettokenandsignatureoptions"},{"title":"XUserPlatformOperationResult","description":"XUserPlatformOperationResult","sidebarTitle":"XUserPlatformOperationResult","href":"/reference/system/xuser/enums/XUserPlatformOperationResult"},{"title":"XUserPlatformSpopOperationResult","description":"XUserPlatformSpopOperationResult","sidebarTitle":"XUserPlatformSpopOperationResult","href":"/reference/system/xuser/enums/xuserplatformspopoperationresult"},{"title":"XUserPrivilege","description":"XUserPrivilege","sidebarTitle":"XUserPrivilege","href":"/reference/system/xuser/enums/xuserprivilege"},{"title":"XUserPrivilegeDenyReason","description":"XUserPrivilegeDenyReason","sidebarTitle":"XUserPrivilegeDenyReason","href":"/reference/system/xuser/enums/xuserprivilegedenyreason"},{"title":"XUserPrivilegeOptions","description":"XUserPrivilegeOptions","sidebarTitle":"XUserPrivilegeOptions","href":"/reference/system/xuser/enums/xuserprivilegeoptions"},{"title":"XUserState","description":"XUserState","sidebarTitle":"XUserState","href":"/reference/system/xuser/enums/xuserstate"}]},{"group":"Functions","pages":[{"title":"XUserAddAsync","description":"XUserAddAsync","sidebarTitle":"XUserAddAsync","href":"/reference/system/xuser/functions/xuseraddasync"},{"title":"XUserAddByIdWithUiAsync","description":"XUserAddByIdWithUiAsync","sidebarTitle":"XUserAddByIdWithUiAsync","href":"/reference/system/xuser/functions/xuseraddbyidwithuiasync"},{"title":"XUserAddByIdWithUiResult","description":"XUserAddByIdWithUiResult","sidebarTitle":"XUserAddByIdWithUiResult","href":"/reference/system/xuser/functions/xuseraddbyidwithuiresult"},{"title":"XUserAddResult","description":"XUserAddResult","sidebarTitle":"XUserAddResult","href":"/reference/system/xuser/functions/xuseraddresult"},{"title":"XUserChangeEventCallback","description":"XUserChangeEventCallback","sidebarTitle":"XUserChangeEventCallback","href":"/reference/system/xuser/functions/xuserchangeeventcallback"},{"title":"XUserCheckPrivilege","description":"XUserCheckPrivilege","sidebarTitle":"XUserCheckPrivilege","href":"/reference/system/xuser/functions/xusercheckprivilege"},{"title":"XUserCloseHandle","description":"XUserCloseHandle","sidebarTitle":"XUserCloseHandle","href":"/reference/system/xuser/functions/xuserclosehandle"},{"title":"XUserCloseSignOutDeferralHandle","description":"XUserCloseSignOutDeferralHandle","sidebarTitle":"XUserCloseSignOutDeferralHandle","href":"/reference/system/xuser/functions/xuserclosesignoutdeferralhandle"},{"title":"XUserCompare","description":"XUserCompare","sidebarTitle":"XUserCompare","href":"/reference/system/xuser/functions/xusercompare"},{"title":"XUserDefaultAudioEndpointUtf16ChangedCallback","description":"XUserDefaultAudioEndpointUtf16ChangedCallback","sidebarTitle":"XUserDefaultAudioEndpointUtf16ChangedCallback","href":"/reference/system/xuser/functions/xuserdefaultaudioendpointutf16changedcallback"},{"title":"XUserDeviceAssociationChangedCallback","description":"XUserDeviceAssociationChangedCallback","sidebarTitle":"XUserDeviceAssociationChangedCallback","href":"/reference/system/xuser/functions/xuserdeviceassociationchangedcallback"},{"title":"XUserDuplicateHandle","description":"XUserDuplicateHandle","sidebarTitle":"XUserDuplicateHandle","href":"/reference/system/xuser/functions/xuserduplicatehandle"},{"title":"XUserFindControllerForUserWithUiAsync","description":"XUserFindControllerForUserWithUiAsync","sidebarTitle":"XUserFindControllerForUserWithUiAsync","href":"/reference/system/xuser/functions/xuserfindcontrollerforuserwithuiasync"},{"title":"XUserFindControllerForUserWithUiResult","description":"XUserFindControllerForUserWithUiResult","sidebarTitle":"XUserFindControllerForUserWithUiResult","href":"/reference/system/xuser/functions/xuserfindcontrollerforuserwithuiresult"},{"title":"XUserFindForDevice","description":"XUserFindForDevice","sidebarTitle":"XUserFindForDevice","href":"/reference/system/xuser/functions/xuserfindfordevice"},{"title":"XUserFindUserById","description":"XUserFindUserById","sidebarTitle":"XUserFindUserById","href":"/reference/system/xuser/functions/xuserfinduserbyid"},{"title":"XUserFindUserByLocalId","description":"XUserFindUserByLocalId","sidebarTitle":"XUserFindUserByLocalId","href":"/reference/system/xuser/functions/xuserfinduserbylocalid"},{"title":"XUserGetAgeGroup","description":"XUserGetAgeGroup","sidebarTitle":"XUserGetAgeGroup","href":"/reference/system/xuser/functions/xusergetagegroup"},{"title":"XUserGetDefaultAudioEndpointUtf16","description":"XUserGetDefaultAudioEndpointUtf16","sidebarTitle":"XUserGetDefaultAudioEndpointUtf16","href":"/reference/system/xuser/functions/xusergetdefaultaudioendpointutf16"},{"title":"XUserGetGamerPictureAsync","description":"XUserGetGamerPictureAsync","sidebarTitle":"XUserGetGamerPictureAsync","href":"/reference/system/xuser/functions/xusergetgamerpictureasync"},{"title":"XUserGetGamerPictureResult","description":"XUserGetGamerPictureResult","sidebarTitle":"XUserGetGamerPictureResult","href":"/reference/system/xuser/functions/xusergetgamerpictureresult"},{"title":"XUserGetGamerPictureResultSize","description":"XUserGetGamerPictureResultSize","sidebarTitle":"XUserGetGamerPictureResultSize","href":"/reference/system/xuser/functions/xusergetgamerpictureresultsize"},{"title":"XUserGetGamertag","description":"XUserGetGamertag","sidebarTitle":"XUserGetGamertag","href":"/reference/system/xuser/functions/xusergetgamertag"},{"title":"XUserGetId","description":"XUserGetId","sidebarTitle":"XUserGetId","href":"/reference/system/xuser/functions/xusergetid"},{"title":"XUserGetIsGuest","description":"XUserGetIsGuest","sidebarTitle":"XUserGetIsGuest","href":"/reference/system/xuser/functions/xusergetisguest"},{"title":"XUserGetLocalId","description":"XUserGetLocalId","sidebarTitle":"XUserGetLocalId","href":"/reference/system/xuser/functions/xusergetlocalid"},{"title":"XUserGetMaxUsers","description":"XUserGetMaxUsers","sidebarTitle":"XUserGetMaxUsers","href":"/reference/system/xuser/functions/xusergetmaxusers"},{"title":"[DEPRECATED] XUserGetMsaTokenSilentlyAsync","description":"[DEPRECATED] XUserGetMsaTokenSilentlyAsync","sidebarTitle":"[DEPRECATED] XUserGetMsaTokenSilentlyAsync","href":"/reference/system/xuser/functions/xusergetmsatokensilentlyasync"},{"title":"[DEPRECATED] XUserGetMsaTokenSilentlyResult","description":"[DEPRECATED] XUserGetMsaTokenSilentlyResult","sidebarTitle":"[DEPRECATED] XUserGetMsaTokenSilentlyResult","href":"/reference/system/xuser/functions/xusergetmsatokensilentlyresult"},{"title":"[DEPRECATED] XUserGetMsaTokenSilentlyResultSize","description":"[DEPRECATED] XUserGetMsaTokenSilentlyResultSize","sidebarTitle":"[DEPRECATED] XUserGetMsaTokenSilentlyResultSize","href":"/reference/system/xuser/functions/xusergetmsatokensilentlyresultsize"},{"title":"XUserGetSignOutDeferral","description":"XUserGetSignOutDeferral","sidebarTitle":"XUserGetSignOutDeferral","href":"/reference/system/xuser/functions/xusergetsignoutdeferral"},{"title":"XUserGetState","description":"XUserGetState","sidebarTitle":"XUserGetState","href":"/reference/system/xuser/functions/xusergetstate"},{"title":"XUserGetTokenAndSignatureAsync","description":"XUserGetTokenAndSignatureAsync","sidebarTitle":"XUserGetTokenAndSignatureAsync","href":"/reference/system/xuser/functions/xusergettokenandsignatureasync"},{"title":"XUserGetTokenAndSignatureResult","description":"XUserGetTokenAndSignatureResult","sidebarTitle":"XUserGetTokenAndSignatureResult","href":"/reference/system/xuser/functions/xusergettokenandsignatureresult"},{"title":"XUserGetTokenAndSignatureResultSize","description":"XUserGetTokenAndSignatureResultSize","sidebarTitle":"XUserGetTokenAndSignatureResultSize","href":"/reference/system/xuser/functions/xusergettokenandsignatureresultsize"},{"title":"XUserGetTokenAndSignatureUtf16Async","description":"XUserGetTokenAndSignatureUtf16Async","sidebarTitle":"XUserGetTokenAndSignatureUtf16Async","href":"/reference/system/xuser/functions/xusergettokenandsignatureutf16async"},{"title":"XUserGetTokenAndSignatureUtf16Result","description":"XUserGetTokenAndSignatureUtf16Result","sidebarTitle":"XUserGetTokenAndSignatureUtf16Result","href":"/reference/system/xuser/functions/xusergettokenandsignatureutf16result"},{"title":"XUserGetTokenAndSignatureUtf16ResultSize","description":"XUserGetTokenAndSignatureUtf16ResultSize","sidebarTitle":"XUserGetTokenAndSignatureUtf16ResultSize","href":"/reference/system/xuser/functions/xusergettokenandsignatureutf16resultsize"},{"title":"XUserIsStoreUser","description":"Reference for XUserIsStoreUser, a GDK XUser API function that checks whether the XUser MSA matches the account signed in to the Microsoft Store on PC.","sidebarTitle":"XUserIsStoreUser","href":"/reference/system/xuser/functions/xuserisstoreuser"},{"title":"XUserPlatformRemoteConnectCancelPrompt","description":"XUserPlatformRemoteConnectCancelPrompt","sidebarTitle":"XUserPlatformRemoteConnectCancelPrompt","href":"/reference/system/xuser/functions/xuserplatformremoteconnectcancelprompt"},{"title":"XUserPlatformRemoteConnectClosePromptEventHandler","description":"XUserPlatformRemoteConnectClosePromptEventHandler","sidebarTitle":"XUserPlatformRemoteConnectClosePromptEventHandler","href":"/reference/system/xuser/functions/xuserplatformremoteconnectcloseprompteventhandler"},{"title":"XUserPlatformRemoteConnectSetEventHandlers","description":"XUserPlatformRemoteConnectSetEventHandlers","sidebarTitle":"XUserPlatformRemoteConnectSetEventHandlers","href":"/reference/system/xuser/functions/xuserplatformremoteconnectseteventhandlers"},{"title":"XUserPlatformRemoteConnectShowPromptEventHandler","description":"XUserPlatformRemoteConnectShowPromptEventHandler","sidebarTitle":"XUserPlatformRemoteConnectShowPromptEventHandler","href":"/reference/system/xuser/functions/xuserplatformremoteconnectshowprompteventhandler"},{"title":"XUserPlatformSpopPromptClearEventHandler","description":"XUserPlatformSpopPromptClearEventHandler","sidebarTitle":"XUserPlatformSpopPromptClearEventHandler","href":"/reference/system/xuser/functions/xuserplatformspoppromptcleareventhandler"},{"title":"XUserPlatformSpopPromptComplete","description":"XUserPlatformSpopPromptComplete","sidebarTitle":"XUserPlatformSpopPromptComplete","href":"/reference/system/xuser/functions/xuserplatformspoppromptcomplete"},{"title":"XUserPlatformSpopPromptEventHandler","description":"XUserPlatformSpopPromptEventHandler","sidebarTitle":"XUserPlatformSpopPromptEventHandler","href":"/reference/system/xuser/functions/xuserplatformspopprompteventhandler"},{"title":"XUserPlatformSpopPromptSetEventHandlers","description":"XUserPlatformSpopPromptSetEventHandlers","sidebarTitle":"XUserPlatformSpopPromptSetEventHandlers","href":"/reference/system/xuser/functions/xuserplatformspoppromptseteventhandlers"},{"title":"XUserRegisterForChangeEvent","description":"XUserRegisterForChangeEvent","sidebarTitle":"XUserRegisterForChangeEvent","href":"/reference/system/xuser/functions/xuserregisterforchangeevent"},{"title":"XUserRegisterForDefaultAudioEndpointUtf16Changed","description":"XUserRegisterForDefaultAudioEndpointUtf16Changed","sidebarTitle":"XUserRegisterForDefaultAudioEndpointUtf16Changed","href":"/reference/system/xuser/functions/xuserregisterfordefaultaudioendpointutf16changed"},{"title":"XUserRegisterForDeviceAssociationChanged","description":"XUserRegisterForDeviceAssociationChanged","sidebarTitle":"XUserRegisterForDeviceAssociationChanged","href":"/reference/system/xuser/functions/xuserregisterfordeviceassociationchanged"},{"title":"XUserResolveIssueWithUiAsync","description":"XUserResolveIssueWithUiAsync","sidebarTitle":"XUserResolveIssueWithUiAsync","href":"/reference/system/xuser/functions/xuserresolveissuewithuiasync"},{"title":"XUserResolveIssueWithUiResult","description":"XUserResolveIssueWithUiResult","sidebarTitle":"XUserResolveIssueWithUiResult","href":"/reference/system/xuser/functions/xuserresolveissuewithuiresult"},{"title":"XUserResolveIssueWithUiUtf16Async","description":"XUserResolveIssueWithUiUtf16Async","sidebarTitle":"XUserResolveIssueWithUiUtf16Async","href":"/reference/system/xuser/functions/xuserresolveissuewithuiutf16async"},{"title":"XUserResolveIssueWithUiUtf16Result","description":"XUserResolveIssueWithUiUtf16Result","sidebarTitle":"XUserResolveIssueWithUiUtf16Result","href":"/reference/system/xuser/functions/xuserresolveissuewithuiutf16result"},{"title":"XUserResolvePrivilegeWithUiAsync","description":"XUserResolvePrivilegeWithUiAsync","sidebarTitle":"XUserResolvePrivilegeWithUiAsync","href":"/reference/system/xuser/functions/xuserresolveprivilegewithuiasync"},{"title":"XUserResolvePrivilegeWithUiResult","description":"XUserResolvePrivilegeWithUiResult","sidebarTitle":"XUserResolvePrivilegeWithUiResult","href":"/reference/system/xuser/functions/xuserresolveprivilegewithuiresult"},{"title":"XUserUnregisterForChangeEvent","description":"XUserUnregisterForChangeEvent","sidebarTitle":"XUserUnregisterForChangeEvent","href":"/reference/system/xuser/functions/xuserunregisterforchangeevent"},{"title":"XUserUnregisterForDefaultAudioEndpointUtf16Changed","description":"XUserUnregisterForDefaultAudioEndpointUtf16Changed","sidebarTitle":"XUserUnregisterForDefaultAudioEndpointUtf16Changed","href":"/reference/system/xuser/functions/xuserunregisterfordefaultaudioendpointutf16changed"},{"title":"XUserUnregisterForDeviceAssociationChanged","description":"XUserUnregisterForDeviceAssociationChanged","sidebarTitle":"XUserUnregisterForDeviceAssociationChanged","href":"/reference/system/xuser/functions/xuserunregisterfordeviceassociationchanged"}]},{"group":"Structs","pages":[{"title":"APP_LOCAL_DEVICE_ID","description":"APP_LOCAL_DEVICE_ID","sidebarTitle":"APP_LOCAL_DEVICE_ID","href":"/reference/system/xuser/structs/app_local_device_id"},{"title":"XUserDeviceAssociationChange","description":"XUserDeviceAssociationChange","sidebarTitle":"XUserDeviceAssociationChange","href":"/reference/system/xuser/structs/xuserdeviceassociationchange"},{"title":"XUserGetTokenAndSignatureData","description":"XUserGetTokenAndSignatureData","sidebarTitle":"XUserGetTokenAndSignatureData","href":"/reference/system/xuser/structs/xusergettokenandsignaturedata"},{"title":"XUserGetTokenAndSignatureHttpHeader","description":"XUserGetTokenAndSignatureHttpHeader","sidebarTitle":"XUserGetTokenAndSignatureHttpHeader","href":"/reference/system/xuser/structs/xusergettokenandsignaturehttpheader"},{"title":"XUserGetTokenAndSignatureUtf16Data","description":"XUserGetTokenAndSignatureUtf16Data","sidebarTitle":"XUserGetTokenAndSignatureUtf16Data","href":"/reference/system/xuser/structs/xusergettokenandsignatureutf16data"},{"title":"XUserGetTokenAndSignatureUtf16HttpHeader","description":"XUserGetTokenAndSignatureUtf16HttpHeader","sidebarTitle":"XUserGetTokenAndSignatureUtf16HttpHeader","href":"/reference/system/xuser/structs/xusergettokenandsignatureutf16httpheader"},{"title":"XUserLocalId","description":"XUserLocalId","sidebarTitle":"XUserLocalId","href":"/reference/system/xuser/structs/xuserlocalid"},{"title":"XUserPlatformRemoteConnectEventHandlers","description":"XUserPlatformRemoteConnectEventHandlers","sidebarTitle":"XUserPlatformRemoteConnectEventHandlers","href":"/reference/system/xuser/structs/xuserplatformremoteconnecteventhandlers"}]}]}]},{"group":"Tools API reference","pages":[{"title":"Tools API reference","description":"Tools API reference for the Microsoft Game Development Kit (GDK), including PIX3 profiling APIs and XBOX Tools Framework (XTF) for dev-kit communication.","sidebarTitle":"Tools API reference","href":"/reference/tools/gc-reference-tools-toc"},{"group":"PIX3","pages":[{"title":"PIX3","description":"PIX3","sidebarTitle":"PIX3","href":"/reference/tools/pix3/pix3_members"},{"title":"Pix3 gpu captures","href":"/reference/tools/pix3/pix3_gpu_captures"},{"group":"Functions","pages":[{"title":"ConfigureL2IPMCs","description":"ConfigureL2IPMCs","sidebarTitle":"ConfigureL2IPMCs","href":"/reference/tools/pix3/functions/configurel2ipmcs"},{"title":"ConfigureNBPMCs","description":"ConfigureNBPMCs","sidebarTitle":"ConfigureNBPMCs","href":"/reference/tools/pix3/functions/configurenbpmcs"},{"title":"ConfigurePMCs","description":"ConfigurePMCs","sidebarTitle":"ConfigurePMCs","href":"/reference/tools/pix3/functions/configurepmcs"},{"title":"GetPMCValue","description":"GetPMCValue","sidebarTitle":"GetPMCValue","href":"/reference/tools/pix3/functions/getpmcvalue"},{"title":"PIX_COLOR","description":"PIX_COLOR","sidebarTitle":"PIX_COLOR","href":"/reference/tools/pix3/functions/pix_color"},{"title":"PIX_COLOR_INDEX","description":"PIX_COLOR_INDEX","sidebarTitle":"PIX_COLOR_INDEX","href":"/reference/tools/pix3/functions/pix_color_index"},{"title":"PIXBeginCapture","description":"PIXBeginCapture","sidebarTitle":"PIXBeginCapture","href":"/reference/tools/pix3/functions/pixbegincapture"},{"title":"PIXBeginEvent function","description":"PIXBeginEvent function","sidebarTitle":"PIXBeginEvent function","href":"/reference/tools/pix3/functions/pixbeginevent"},{"title":"PIXBeginEvent function reference","description":"PIXBeginEvent function reference","sidebarTitle":"PIXBeginEvent function reference","href":"/reference/tools/pix3/functions/pixbeginevent_2"},{"title":"PIXBeginEvent reference","description":"PIXBeginEvent reference","sidebarTitle":"PIXBeginEvent reference","href":"/reference/tools/pix3/functions/pixbeginevent_3"},{"title":"PIXBeginEvent overview","description":"PIXBeginEvent overview","sidebarTitle":"PIXBeginEvent overview","href":"/reference/tools/pix3/functions/pixbeginevent_4"},{"title":"PIXBeginEvent Function","description":"PIXBeginEvent Function","sidebarTitle":"PIXBeginEvent Function","href":"/reference/tools/pix3/functions/pixbeginevent-overloads"},{"title":"PIXBeginRetailEvent function","description":"PIXBeginRetailEvent function","sidebarTitle":"PIXBeginRetailEvent function","href":"/reference/tools/pix3/functions/pixbeginretailevent"},{"title":"PIXBeginRetailEvent","description":"PIXBeginRetailEvent","sidebarTitle":"PIXBeginRetailEvent","href":"/reference/tools/pix3/functions/pixbeginretailevent_2"},{"title":"PIXEndCapture","description":"PIXEndCapture","sidebarTitle":"PIXEndCapture","href":"/reference/tools/pix3/functions/pixendcapture"},{"title":"PIXEndEvent reference","description":"PIXEndEvent reference","sidebarTitle":"PIXEndEvent reference","href":"/reference/tools/pix3/functions/pixendevent"},{"title":"PIXEndEvent","description":"PIXEndEvent","sidebarTitle":"PIXEndEvent","href":"/reference/tools/pix3/functions/pixendevent_2"},{"title":"PIXEndEvent function","description":"PIXEndEvent function","sidebarTitle":"PIXEndEvent function","href":"/reference/tools/pix3/functions/pixendevent-overloads"},{"title":"PIXEndRetailEvent","description":"PIXEndRetailEvent","sidebarTitle":"PIXEndRetailEvent","href":"/reference/tools/pix3/functions/pixendretailevent"},{"title":"PIXGetCaptureState","description":"PIXGetCaptureState","sidebarTitle":"PIXGetCaptureState","href":"/reference/tools/pix3/functions/pixgetcapturestate"},{"title":"Pixgetpowermetrics","href":"/reference/tools/pix3/functions/pixgetpowermetrics"},{"title":"PIXRecordMemoryAllocationEvent","description":"PIXRecordMemoryAllocationEvent","sidebarTitle":"PIXRecordMemoryAllocationEvent","href":"/reference/tools/pix3/functions/pixrecordmemoryallocationevent"},{"title":"PIXRecordMemoryFreeEvent","description":"PIXRecordMemoryFreeEvent","sidebarTitle":"PIXRecordMemoryFreeEvent","href":"/reference/tools/pix3/functions/pixrecordmemoryfreeevent"},{"title":"PIXReportCounter","description":"PIXReportCounter","sidebarTitle":"PIXReportCounter","href":"/reference/tools/pix3/functions/pixreportcounter"},{"title":"PIXScopedEvent function","description":"PIXScopedEvent function","sidebarTitle":"PIXScopedEvent function","href":"/reference/tools/pix3/functions/pixscopedevent"},{"title":"PIXScopedEvent reference","description":"PIXScopedEvent reference","sidebarTitle":"PIXScopedEvent reference","href":"/reference/tools/pix3/functions/pixscopedevent_2"},{"title":"PIXScopedEvent function reference","description":"PIXScopedEvent function reference","sidebarTitle":"PIXScopedEvent function reference","href":"/reference/tools/pix3/functions/pixscopedevent_3"},{"title":"PIXScopedEvent overview","description":"PIXScopedEvent overview","sidebarTitle":"PIXScopedEvent overview","href":"/reference/tools/pix3/functions/pixscopedevent_4"},{"title":"PIXScopedEvent","description":"PIXScopedEvent","sidebarTitle":"PIXScopedEvent","href":"/reference/tools/pix3/functions/pixscopedevent-overloads"},{"title":"PIXSetMarker function","description":"PIXSetMarker function","sidebarTitle":"PIXSetMarker function","href":"/reference/tools/pix3/functions/pixsetmarker"},{"title":"PIXSetMarker reference","description":"PIXSetMarker reference","sidebarTitle":"PIXSetMarker reference","href":"/reference/tools/pix3/functions/pixsetmarker_2"},{"title":"PIXSetMarker function reference","description":"PIXSetMarker function reference","sidebarTitle":"PIXSetMarker function reference","href":"/reference/tools/pix3/functions/pixsetmarker_3"},{"title":"PIXSetMarker overview","description":"PIXSetMarker overview","sidebarTitle":"PIXSetMarker overview","href":"/reference/tools/pix3/functions/pixsetmarker_4"},{"title":"PIXSetMarker","description":"PIXSetMarker","sidebarTitle":"PIXSetMarker","href":"/reference/tools/pix3/functions/pixsetmarker-overloads"},{"title":"PIXSetRetailMarker function","description":"PIXSetRetailMarker function","sidebarTitle":"PIXSetRetailMarker function","href":"/reference/tools/pix3/functions/pixsetretailmarker"},{"title":"PIXSetRetailMarker","description":"PIXSetRetailMarker","sidebarTitle":"PIXSetRetailMarker","href":"/reference/tools/pix3/functions/pixsetretailmarker_2"}]},{"group":"Structs","pages":[{"title":"PIXCaptureParameters","description":"PIXCaptureParameters","sidebarTitle":"PIXCaptureParameters","href":"/reference/tools/pix3/structs/pixcaptureparameters"},{"title":"Pixpowermetrics","href":"/reference/tools/pix3/structs/pixpowermetrics"}]}]},{"group":"XBOX Tools Framework","pages":[{"title":"XBOX Tools Framework","description":"XBOX Tools Framework","sidebarTitle":"XBOX Tools Framework","href":"/reference/tools/xtf/atoc-xbox-tools-framework"},{"group":"XtfApi","pages":[{"group":"Enums","pages":[{"title":"XtfConsoleCertType Enumeration","description":"XtfConsoleCertType Enumeration","sidebarTitle":"XtfConsoleCertType Enumeration","href":"/reference/tools/xtf/xtfapi/enums/xtfconsolecerttype-xbox-windows-t"},{"title":"XtfConsoleFieldId Enumeration","description":"XtfConsoleFieldId Enumeration","sidebarTitle":"XtfConsoleFieldId Enumeration","href":"/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t"},{"title":"XtfConsoleFieldType Enumeration","description":"XtfConsoleFieldType Enumeration","sidebarTitle":"XtfConsoleFieldType Enumeration","href":"/reference/tools/xtf/xtfapi/enums/xtfconsolefieldtype-xbox-windows-t"}]},{"group":"Functions","pages":[{"title":"XtfAddCredential","description":"XtfAddCredential","sidebarTitle":"XtfAddCredential","href":"/reference/tools/xtf/xtfapi/functions/xtfaddcredential-xtfapi-xbox-windows-m"},{"title":"XtfCacheTitleOS","description":"XtfCacheTitleOS","sidebarTitle":"XtfCacheTitleOS","href":"/reference/tools/xtf/xtfapi/functions/xtfcachetitleos-xtfapi-xbox-windows-m"},{"title":"XtfCaptureRecordedGameClip","description":"XtfCaptureRecordedGameClip","sidebarTitle":"XtfCaptureRecordedGameClip","href":"/reference/tools/xtf/xtfapi/functions/xtfcapturegameclip-xbox-microsoft-m"},{"title":"XtfCaptureOutputBegin","description":"XtfCaptureOutputBegin","sidebarTitle":"XtfCaptureOutputBegin","href":"/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m"},{"title":"XtfCaptureOutputEnd","description":"XtfCaptureOutputEnd","sidebarTitle":"XtfCaptureOutputEnd","href":"/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputend-xtfapi-xbox-windows-m"},{"title":"XtfClearAllOverlayFolders","description":"XtfClearAllOverlayFolders","sidebarTitle":"XtfClearAllOverlayFolders","href":"/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m"},{"title":"XtfCloseConsoleInfoList","description":"XtfCloseConsoleInfoList","sidebarTitle":"XtfCloseConsoleInfoList","href":"/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m"},{"title":"XtfCloseCredentialInfoList","description":"XtfCloseCredentialInfoList","sidebarTitle":"XtfCloseCredentialInfoList","href":"/reference/tools/xtf/xtfapi/functions/xtfclosecredentialinfo-xtfapi-xbox-windows-m"},{"title":"XtfClosePackageInfo","description":"XtfClosePackageInfo","sidebarTitle":"XtfClosePackageInfo","href":"/reference/tools/xtf/xtfapi/functions/xtfclosepackageinfo-xtfapi-xbox-windows-m"},{"title":"XtfDebugStringCallback","description":"XtfDebugStringCallback","sidebarTitle":"XtfDebugStringCallback","href":"/reference/tools/xtf/xtfapi/functions/xtfdebugstringcallback-xtfapi-xbox-windows-m"},{"title":"XtfDebugStringErrorCallback","description":"XtfDebugStringErrorCallback","sidebarTitle":"XtfDebugStringErrorCallback","href":"/reference/tools/xtf/xtfapi/functions/xtfdebugstringerrorcallback-xtfapi-xbox-windows-m"},{"title":"XtfGetAumid","description":"XtfGetAumid","sidebarTitle":"XtfGetAumid","href":"/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m"},{"title":"XtfGetCachedTitleOSVersions","description":"XtfGetCachedTitleOSVersions","sidebarTitle":"XtfGetCachedTitleOSVersions","href":"/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m"},{"title":"XtfGetCachedTitleOSVersionsCallback","description":"XtfGetCachedTitleOSVersionsCallback","sidebarTitle":"XtfGetCachedTitleOSVersionsCallback","href":"/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m"},{"title":"XtfGetConsoleFieldValue","description":"XtfGetConsoleFieldValue","sidebarTitle":"XtfGetConsoleFieldValue","href":"/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m"},{"title":"XtfGetCountofAppUserModelIds","description":"XtfGetCountofAppUserModelIds","sidebarTitle":"XtfGetCountofAppUserModelIds","href":"/reference/tools/xtf/xtfapi/functions/xtfgetcountofappusermodelids-xtfapi-xbox-windows-m"},{"title":"XtfGetCredentialInfoCount","description":"XtfGetCredentialInfoCount","sidebarTitle":"XtfGetCredentialInfoCount","href":"/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m"},{"title":"XtfGetCredentialInfoList","description":"XtfGetCredentialInfoList","sidebarTitle":"XtfGetCredentialInfoList","href":"/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m"},{"title":"XtfGetCredentialServerName","description":"XtfGetCredentialServerName","sidebarTitle":"XtfGetCredentialServerName","href":"/reference/tools/xtf/xtfapi/functions/xtfgetcredentialtargetname-xtfapi-xbox-windows-m"},{"title":"XtfGetCredentialUserName","description":"XtfGetCredentialUserName","sidebarTitle":"XtfGetCredentialUserName","href":"/reference/tools/xtf/xtfapi/functions/xtfgetcredentialusername-xtfapi-xbox-windows-m"},{"title":"XtfGetOverlayFolder","description":"XtfGetOverlayFolder","sidebarTitle":"XtfGetOverlayFolder","href":"/reference/tools/xtf/xtfapi/functions/xtfgetoverlayfolder-xtfapi-xbox-windows-m"},{"title":"XtfGetPackageFullName","description":"XtfGetPackageFullName","sidebarTitle":"XtfGetPackageFullName","href":"/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m"},{"title":"XtfGetSavedConsoleAddress","description":"XtfGetSavedConsoleAddress","sidebarTitle":"XtfGetSavedConsoleAddress","href":"/reference/tools/xtf/xtfapi/functions/xtfgetsavedconsoleaddress-xtfapi-xbox-windows-m"},{"title":"XtfGetSystemUpTime","description":"XtfGetSystemUpTime","sidebarTitle":"XtfGetSystemUpTime","href":"/reference/tools/xtf/xtfapi/functions/xtfgetsystemuptime-xtfapi-xbox-windows-m"},{"title":"XtfGetTitleOSFourPartVersion","description":"XtfGetTitleOSFourPartVersion","sidebarTitle":"XtfGetTitleOSFourPartVersion","href":"/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m"},{"title":"XtfGetTitleOSState","description":"XtfGetTitleOSState","sidebarTitle":"XtfGetTitleOSState","href":"/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m"},{"title":"XtfGetTitleProcessMemoryReports","description":"XtfGetTitleProcessMemoryReports","sidebarTitle":"XtfGetTitleProcessMemoryReports","href":"/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m"},{"title":"XtfPullAuditionApp","description":"XtfPullAuditionApp","sidebarTitle":"XtfPullAuditionApp","href":"/reference/tools/xtf/xtfapi/functions/xtfpullauditionapp-xtfapi-xbox-windows-m"},{"title":"XtfPullRegisterApp","description":"XtfPullRegisterApp","sidebarTitle":"XtfPullRegisterApp","href":"/reference/tools/xtf/xtfapi/functions/xtfpullregisterapp-xtfapi-xbox-windows-m"},{"title":"XtfPullSupplyMock","description":"XtfPullSupplyMock","sidebarTitle":"XtfPullSupplyMock","href":"/reference/tools/xtf/xtfapi/functions/xtfpullsupplymock-xtfapi-xbox-windows-m"},{"title":"XtfPullUnregisterApp","description":"XtfPullUnregisterApp","sidebarTitle":"XtfPullUnregisterApp","href":"/reference/tools/xtf/xtfapi/functions/xtfpullunregisterapp-xtfapi-xbox-windows-m"},{"title":"XtfRegisterAllPackagesOnDrive","description":"XtfRegisterAllPackagesOnDrive","sidebarTitle":"XtfRegisterAllPackagesOnDrive","href":"/reference/tools/xtf/xtfapi/functions/xtfregisterallpackagesondrive-xtfapi-xbox-windows-m"},{"title":"XtfRegisterNetworkSharePackage","description":"XtfRegisterNetworkSharePackage","sidebarTitle":"XtfRegisterNetworkSharePackage","href":"/reference/tools/xtf/xtfapi/functions/xtfregisternetworksharepackage-xtfapi-xbox-windows-m"},{"title":"XtfRegisterPackage","description":"XtfRegisterPackage","sidebarTitle":"XtfRegisterPackage","href":"/reference/tools/xtf/xtfapi/functions/xtfregisterpackage-xtfapi-xbox-windows-m"},{"title":"XtfRegisterPackageOnDrive","description":"XtfRegisterPackageOnDrive","sidebarTitle":"XtfRegisterPackageOnDrive","href":"/reference/tools/xtf/xtfapi/functions/xtfregisterpackageondrive-xtfapi-xbox-windows-m"},{"title":"XtfRemoveCredential","description":"XtfRemoveCredential","sidebarTitle":"XtfRemoveCredential","href":"/reference/tools/xtf/xtfapi/functions/xtfremovecredential-xtfapi-xbox-windows-m"},{"title":"XtfRemoveTitleOSFromCache","description":"XtfRemoveTitleOSFromCache","sidebarTitle":"XtfRemoveTitleOSFromCache","href":"/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcache-xtfapi-xbox-windows-m"},{"title":"XtfRemoveTitleOSFromCacheByVersion","description":"XtfRemoveTitleOSFromCacheByVersion","sidebarTitle":"XtfRemoveTitleOSFromCacheByVersion","href":"/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcachebyversion-xtfapi-xbox-windows-m"},{"title":"XtfSetOverlayFolder","description":"XtfSetOverlayFolder","sidebarTitle":"XtfSetOverlayFolder","href":"/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m"},{"title":"XtfShutdownTitleOS","description":"XtfShutdownTitleOS","sidebarTitle":"XtfShutdownTitleOS","href":"/reference/tools/xtf/xtfapi/functions/xtfshutdowntitleos-xtfapi-xbox-windows-m"},{"title":"XtfStartTitleOS","description":"XtfStartTitleOS","sidebarTitle":"XtfStartTitleOS","href":"/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m"},{"title":"XtfStartTitleOSByGameConfig","description":"XtfStartTitleOSByGameConfig","sidebarTitle":"XtfStartTitleOSByGameConfig","href":"/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbygameconfig-xtfapi-xbox-windows-m"},{"title":"XtfStartTitleOSByVersion","description":"XtfStartTitleOSByVersion","sidebarTitle":"XtfStartTitleOSByVersion","href":"/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbyversion-xtfapi-xbox-windows-m"},{"title":"XtfUnregisterPackage","description":"XtfUnregisterPackage","sidebarTitle":"XtfUnregisterPackage","href":"/reference/tools/xtf/xtfapi/functions/xtfunregisterpackage-xtfapi-xbox-windows-m"},{"title":"Xtfwaitforconsoleosready xtfapi xbox windows m","href":"/reference/tools/xtf/xtfapi/functions/xtfwaitforconsoleosready-xtfapi-xbox-windows-m"},{"title":"XtfWaitForConsoleState","description":"XtfWaitForConsoleState","sidebarTitle":"XtfWaitForConsoleState","href":"/reference/tools/xtf/xtfapi/functions/xtfwaitforconsolestate"}]},{"group":"Structs","pages":[{"title":"FourPartVersion","description":"FourPartVersion","sidebarTitle":"FourPartVersion","href":"/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s"}]}]},{"group":"XtfApplication","pages":[{"group":"Classes","pages":[{"group":"IXtfApplicationClient","pages":[{"group":"Methods","pages":[{"title":"IXtfApplicationClient::Constrain","description":"IXtfApplicationClient::Constrain","sidebarTitle":"IXtfApplicationClient::Constrain","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/constrain-ixtfapplicationclient-xtfapplication-xbox-windows-m"},{"title":"IXtfApplicationClient::DebugEnable","description":"IXtfApplicationClient::DebugEnable","sidebarTitle":"IXtfApplicationClient::DebugEnable","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/debugenable-ixtfapplicationclient-xtfapplication-xbox-microsoft-m"},{"title":"IXtfApplicationClient::Deploy","description":"IXtfApplicationClient::Deploy","sidebarTitle":"IXtfApplicationClient::Deploy","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/deploy-ixtfapplicationclient-xtfapplication-xbox-microsoft-m"},{"title":"IXtfApplicationClient::EnableGlobalOption","description":"IXtfApplicationClient::EnableGlobalOption","sidebarTitle":"IXtfApplicationClient::EnableGlobalOption","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/enableglobaloption-ixtfapplicationclient-xtfapplication-xb"},{"title":"IXtfApplicationClient::GetDlc","description":"IXtfApplicationClient::GetDlc","sidebarTitle":"IXtfApplicationClient::GetDlc","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/getdlc-ixtfapplicationclient-xtfapplication-xbox-microsoft-m"},{"title":"IXtfApplicationClient::GetInstalled","description":"IXtfApplicationClient::GetInstalled","sidebarTitle":"IXtfApplicationClient::GetInstalled","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/getinstalled-ixtfapplicationclient-xtfapplication-xbox-microsoft-m"},{"title":"IXtfApplicationClient::DebugQuery","description":"IXtfApplicationClient::DebugQuery","sidebarTitle":"IXtfApplicationClient::DebugQuery","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/ixtfapplicationclient-debugquery"},{"title":"IXtfApplicationClient::DeployEx","description":"IXtfApplicationClient::DeployEx","sidebarTitle":"IXtfApplicationClient::DeployEx","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/ixtfapplicationclient-deployex"},{"title":"IXtfApplicationClient::DeployToTitleScratch","description":"IXtfApplicationClient::DeployToTitleScratch","sidebarTitle":"IXtfApplicationClient::DeployToTitleScratch","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/ixtfapplicationclient-deploytotitlescratch"},{"title":"IXtfApplicationClient::Launch","description":"IXtfApplicationClient::Launch","sidebarTitle":"IXtfApplicationClient::Launch","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/launch-ixtfapplicationclient-xtfapplication-xbox-microsoft-m"},{"title":"IXtfApplicationClient::MarkAppAsProvisioned method","description":"IXtfApplicationClient::MarkAppAsProvisioned method","sidebarTitle":"IXtfApplicationClient::MarkAppAsProvisioned method","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/markappasprovisioned-ixtfapplicationclient-xtfapplication"},{"title":"IXtfApplicationClient::QueryExecutionState","description":"IXtfApplicationClient::QueryExecutionState","sidebarTitle":"IXtfApplicationClient::QueryExecutionState","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/queryexecutionstate-ixtfapplicationclient-xtfapplication-xbox-microsoft-m"},{"title":"IXtfApplicationClient::Resume","description":"IXtfApplicationClient::Resume","sidebarTitle":"IXtfApplicationClient::Resume","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/resume-ixtfapplicationclient-xtfapplication-xbox-microsoft-m"},{"title":"IXtfApplicationClient::SetDefaultApp","description":"IXtfApplicationClient::SetDefaultApp","sidebarTitle":"IXtfApplicationClient::SetDefaultApp","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/setdefaultapp-ixtfapplicationclient-xtfapplication-xbox-wi"},{"title":"IXtfApplicationClient::Snap","description":"IXtfApplicationClient::Snap","sidebarTitle":"IXtfApplicationClient::Snap","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/snap-ixtfapplicationclient-xtfapplication-xbox-windows-m"},{"title":"IXtfApplicationClient::Suspend","description":"IXtfApplicationClient::Suspend","sidebarTitle":"IXtfApplicationClient::Suspend","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/suspend-ixtfapplicationclient-xtfapplication-xbox-windows"},{"title":"IXtfApplicationClient::Terminate","description":"IXtfApplicationClient::Terminate","sidebarTitle":"IXtfApplicationClient::Terminate","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/terminate-ixtfapplicationclient-xtfapplication-xbox-microsoft-m"},{"title":"IXtfApplicationClient::Unconstrain","description":"IXtfApplicationClient::Unconstrain","sidebarTitle":"IXtfApplicationClient::Unconstrain","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/unconstrain-ixtfapplicationclient-xtfapplication-xbox-windows-m"},{"title":"IXtfApplicationClient::Uninstall","description":"IXtfApplicationClient::Uninstall","sidebarTitle":"IXtfApplicationClient::Uninstall","href":"/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/uninstall-ixtfapplicationclient-xtfapplication-xbox-microsoft-m"}]}]},{"group":"IXtfDeployCallback","pages":[{"group":"Methods","pages":[{"title":"IXtfDeployCallback::OnDeployChangeEvaluation","description":"IXtfDeployCallback::OnDeployChangeEvaluation","sidebarTitle":"IXtfDeployCallback::OnDeployChangeEvaluation","href":"/reference/tools/xtf/xtfapplication/classes/IXtfDeployCallback/methods/ondeploychangeevaluation-ixtfdeploycallback-xtfapplication-xb"},{"title":"IXtfDeployCallback::OnDeployError","description":"IXtfDeployCallback::OnDeployError","sidebarTitle":"IXtfDeployCallback::OnDeployError","href":"/reference/tools/xtf/xtfapplication/classes/IXtfDeployCallback/methods/ondeployerror-ixtfdeploycallback-xtfapplication-xbox-windows"},{"title":"IXtfDeployCallback::OnDeployExtraFileDetected","description":"IXtfDeployCallback::OnDeployExtraFileDetected","sidebarTitle":"IXtfDeployCallback::OnDeployExtraFileDetected","href":"/reference/tools/xtf/xtfapplication/classes/IXtfDeployCallback/methods/ondeployextrafiledetected-ixtfdeploycallback-xtfapplication-x"},{"title":"IXtfDeployCallback::OnDeployExtraFileRemoved","description":"IXtfDeployCallback::OnDeployExtraFileRemoved","sidebarTitle":"IXtfDeployCallback::OnDeployExtraFileRemoved","href":"/reference/tools/xtf/xtfapplication/classes/IXtfDeployCallback/methods/ondeployextrafileremoved-ixtfdeploycallback-xtfapplication-xb"},{"title":"IXtfDeployCallback::OnDeployFileProgress","description":"IXtfDeployCallback::OnDeployFileProgress","sidebarTitle":"IXtfDeployCallback::OnDeployFileProgress","href":"/reference/tools/xtf/xtfapplication/classes/IXtfDeployCallback/methods/ondeployfileprogress-ixtfdeploycallback-xtfapplication-xbox-w"},{"title":"IXtfDeployCallback::OnDeployInitialized Method","description":"IXtfDeployCallback::OnDeployInitialized Method","sidebarTitle":"IXtfDeployCallback::OnDeployInitialized Method","href":"/reference/tools/xtf/xtfapplication/classes/IXtfDeployCallback/methods/ondeployinitialized-ixtfdeploycallback-xtfapplication-xbox-wi"},{"title":"IXtfDeployCallback::OnDeployMetrics method","description":"IXtfDeployCallback::OnDeployMetrics method","sidebarTitle":"IXtfDeployCallback::OnDeployMetrics method","href":"/reference/tools/xtf/xtfapplication/classes/IXtfDeployCallback/methods/ondeploymetrics-ixtfdeploycallback-xtfapplication-xbox-window"}]}]}]},{"group":"Methods","pages":[{"title":"XtfCreateApplicationClient","description":"XtfCreateApplicationClient","sidebarTitle":"XtfCreateApplicationClient","href":"/reference/tools/xtf/xtfapplication/methods/xtfcreateapplicationclient-xtfapplication-xbox-microsoft-m"}]}]},{"group":"XtfConsoleControl","pages":[{"group":"Functions","pages":[{"title":"XtfCaptureScreenshot","description":"XtfCaptureScreenshot","sidebarTitle":"XtfCaptureScreenshot","href":"/reference/tools/xtf/xtfconsolecontrol/functions/xtfcapturescreenshot"},{"title":"XtfCreateConsoleControlClient","description":"XtfCreateConsoleControlClient","sidebarTitle":"XtfCreateConsoleControlClient","href":"/reference/tools/xtf/xtfconsolecontrol/functions/xtfcreateconsolecontrolclient-xtfconsolecontrol-xbox-microsoft-m"},{"title":"XtfGetAvailableSpaceForAppInstallation","description":"XtfGetAvailableSpaceForAppInstallation","sidebarTitle":"XtfGetAvailableSpaceForAppInstallation","href":"/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetavailablespaceforappinstallation-xtfconsolecontrol-xbox-microsoft-m"},{"title":"XtfGetConsoleInfoList","description":"XtfGetConsoleInfoList","sidebarTitle":"XtfGetConsoleInfoList","href":"/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetconsoleinfolist-xtfconsolecontrol-xbox-microsoft-m"},{"title":"XtfGetErrorText","description":"XtfGetErrorText","sidebarTitle":"XtfGetErrorText","href":"/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortext-xtfconsolecontrol-xbox-microsoft-m"},{"title":"XtfGetErrorTextA","description":"XtfGetErrorTextA","sidebarTitle":"XtfGetErrorTextA","href":"/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortexta"}]},{"group":"Interfaces","pages":[{"group":"IXtfConfigSettingsCallback","pages":[{"title":"IXtfConfigSettingsCallback","description":"IXtfConfigSettingsCallback","sidebarTitle":"IXtfConfigSettingsCallback","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConfigSettingsCallback/ixtfconfigsettingscallback"},{"group":"Methods","pages":[{"title":"IXtfConfigSettingsCallback::OnFoundSetting","description":"IXtfConfigSettingsCallback::OnFoundSetting","sidebarTitle":"IXtfConfigSettingsCallback::OnFoundSetting","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConfigSettingsCallback/methods/ixtfconfigsettingscallback_onfoundsetting"}]}]},{"group":"IXtfConsoleControlClient","pages":[{"title":"IXtfConsoleControlClient","description":"IXtfConsoleControlClient","sidebarTitle":"IXtfConsoleControlClient","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/ixtfconsolecontrolclient"},{"group":"Methods","pages":[{"title":"IXtfConsoleControlClient::GenerateStackDump","description":"IXtfConsoleControlClient::GenerateStackDump","sidebarTitle":"IXtfConsoleControlClient::GenerateStackDump","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_generatestackdump"},{"title":"IXtfConsoleControlClient::GetAllSettings","description":"IXtfConsoleControlClient::GetAllSettings","sidebarTitle":"IXtfConsoleControlClient::GetAllSettings","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_getallsettings"},{"title":"IXtfConsoleControlClient::GetConfigSettings","description":"IXtfConsoleControlClient::GetConfigSettings","sidebarTitle":"IXtfConsoleControlClient::GetConfigSettings","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_getconfigsettings"},{"title":"IXtfConsoleControlClient::GetConfigValue","description":"IXtfConsoleControlClient::GetConfigValue","sidebarTitle":"IXtfConsoleControlClient::GetConfigValue","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_getconfigvalue"},{"title":"IXtfConsoleControlClient::GetRunningProcesses","description":"IXtfConsoleControlClient::GetRunningProcesses","sidebarTitle":"IXtfConsoleControlClient::GetRunningProcesses","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_getrunningprocesses"},{"title":"IXtfConsoleControlClient::GetSystemTime","description":"IXtfConsoleControlClient::GetSystemTime","sidebarTitle":"IXtfConsoleControlClient::GetSystemTime","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_getsystemtime"},{"title":"IXtfConsoleControlClient::QueryConnectedStandby","description":"IXtfConsoleControlClient::QueryConnectedStandby","sidebarTitle":"IXtfConsoleControlClient::QueryConnectedStandby","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_queryconnectedstandby"},{"title":"IXtfConsoleControlClient::QueryConnectedStandbyEx","description":"IXtfConsoleControlClient::QueryConnectedStandbyEx","sidebarTitle":"IXtfConsoleControlClient::QueryConnectedStandbyEx","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_queryconnectedstandbyex"},{"title":"IXtfConsoleControlClient::SendMessageToUpdateSvc","description":"IXtfConsoleControlClient::SendMessageToUpdateSvc","sidebarTitle":"IXtfConsoleControlClient::SendMessageToUpdateSvc","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_sendmessagetoupdatesvc"},{"title":"IXtfConsoleControlClient::SetConfigValue","description":"IXtfConsoleControlClient::SetConfigValue","sidebarTitle":"IXtfConsoleControlClient::SetConfigValue","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_setconfigvalue"},{"title":"IXtfConsoleControlClient::ShutdownConsole","description":"IXtfConsoleControlClient::ShutdownConsole","sidebarTitle":"IXtfConsoleControlClient::ShutdownConsole","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_shutdownconsole"},{"title":"IXtfConsoleControlClient::UpdatesPending","description":"IXtfConsoleControlClient::UpdatesPending","sidebarTitle":"IXtfConsoleControlClient::UpdatesPending","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_updatespending"}]}]},{"group":"IXtfRunningProcessCallback","pages":[{"title":"IXtfRunningProcessCallback","description":"IXtfRunningProcessCallback","sidebarTitle":"IXtfRunningProcessCallback","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfRunningProcessCallback/ixtfrunningprocesscallback"},{"group":"Methods","pages":[{"title":"IXtfRunningProcessCallback::OnFoundProcess","description":"IXtfRunningProcessCallback::OnFoundProcess","sidebarTitle":"IXtfRunningProcessCallback::OnFoundProcess","href":"/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfRunningProcessCallback/methods/ixtfrunningprocesscallback_onfoundprocess"}]}]}]},{"group":"Structs","pages":[{"title":"XTFCONFIGSETTING","description":"XTFCONFIGSETTING","sidebarTitle":"XTFCONFIGSETTING","href":"/reference/tools/xtf/xtfconsolecontrol/structs/xtfconfigsetting"},{"title":"XTFPROCESSINFO","description":"XTFPROCESSINFO","sidebarTitle":"XTFPROCESSINFO","href":"/reference/tools/xtf/xtfconsolecontrol/structs/xtfprocessinfo"},{"title":"XTFSYSTEMTIME","description":"XTFSYSTEMTIME","sidebarTitle":"XTFSYSTEMTIME","href":"/reference/tools/xtf/xtfconsolecontrol/structs/xtfsystemtime"}]}]},{"group":"XtfConsoleManager","pages":[{"group":"Classes","pages":[{"group":"IXtfConsoleManager","pages":[{"group":"Methods","pages":[{"title":"IXtfConsoleManager::AddConsole method","description":"IXtfConsoleManager::AddConsole method","sidebarTitle":"IXtfConsoleManager::AddConsole method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfConsoleManager/methods/addconsole-ixtfconsolemanager-xtfconsolemanager-xbox-microsoft-m"},{"title":"IXtfConsoleManager::EnumerateConsoles method","description":"IXtfConsoleManager::EnumerateConsoles method","sidebarTitle":"IXtfConsoleManager::EnumerateConsoles method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfConsoleManager/methods/enumerateconsoles-ixtfconsolemanager-xtfconsolemanager-xbox-microsoft-m"},{"title":"IXtfConsoleManager::GetConsole Method","description":"IXtfConsoleManager::GetConsole Method","sidebarTitle":"IXtfConsoleManager::GetConsole Method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfConsoleManager/methods/getconsole-ixtfconsolemanager-xtfconsolemanager-xbox-microsoft-m"},{"title":"IXtfConsoleManager::GetDefaultConsole Method","description":"IXtfConsoleManager::GetDefaultConsole Method","sidebarTitle":"IXtfConsoleManager::GetDefaultConsole Method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfConsoleManager/methods/getdefaultconsole-ixtfconsolemanager-xtfconsolemanager-xbox-microsoft-m"},{"title":"IXtfConsoleManager::RemoveConsole Method","description":"IXtfConsoleManager::RemoveConsole Method","sidebarTitle":"IXtfConsoleManager::RemoveConsole Method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfConsoleManager/methods/removeconsole-ixtfconsolemanager-xtfconsolemanager-xbox-microsoft-m"},{"title":"IXtfConsoleManager::SetDefaultConsole Method","description":"IXtfConsoleManager::SetDefaultConsole Method","sidebarTitle":"IXtfConsoleManager::SetDefaultConsole Method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfConsoleManager/methods/setdefaultconsole-ixtfconsolemanager-xtfconsolemanager-xbox-microsoft-m"}]}]},{"group":"IXtfConsoleManagerCallback","pages":[{"group":"Methods","pages":[{"title":"IXtfConsoleManagerCallback::OnAddConsole Method","description":"IXtfConsoleManagerCallback::OnAddConsole Method","sidebarTitle":"IXtfConsoleManagerCallback::OnAddConsole Method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfConsoleManagerCallback/methods/onaddconsole-ixtfconsolemanagercallback-xtfconsolemanager-xbox-microsoft"},{"title":"IXtfConsoleManagerCallback::OnChangedDefaultConsole Method","description":"IXtfConsoleManagerCallback::OnChangedDefaultConsole Method","sidebarTitle":"IXtfConsoleManagerCallback::OnChangedDefaultConsole Method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfConsoleManagerCallback/methods/onchangeddefaultconsole-ixtfconsolemanagercallback-xtfconsolemanager-xbox"},{"title":"IXtfConsoleManagerCallback::OnRemoveConsole Method","description":"IXtfConsoleManagerCallback::OnRemoveConsole Method","sidebarTitle":"IXtfConsoleManagerCallback::OnRemoveConsole Method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfConsoleManagerCallback/methods/onremoveconsole-ixtfconsolemanagercallback-xtfconsolemanager-xbox-microso"}]}]},{"group":"IXtfEnumerateConsolesCallback","pages":[{"group":"Methods","pages":[{"title":"IXtfEnumerateConsolesCallback::OnConsoleFound Method","description":"IXtfEnumerateConsolesCallback::OnConsoleFound Method","sidebarTitle":"IXtfEnumerateConsolesCallback::OnConsoleFound Method","href":"/reference/tools/xtf/xtfconsolemanager/classes/IXtfEnumerateConsolesCallback/methods/onconsolefound-ixtfenumerateconsolescallback-xtfconsolemanager-xbox-mi"}]}]}]},{"group":"Methods","pages":[{"title":"XtfCreateConsoleManager","description":"XtfCreateConsoleManager","sidebarTitle":"XtfCreateConsoleManager","href":"/reference/tools/xtf/xtfconsolemanager/methods/xtfcreateconsolemanager-xtfconsolemanager-xbox-microsoft-m"},{"title":"XtfGetDefaultAddress","description":"XtfGetDefaultAddress","sidebarTitle":"XtfGetDefaultAddress","href":"/reference/tools/xtf/xtfconsolemanager/methods/xtfgetdefaultaddress-xtfconsolemanager-xbox-windows-m"}]},{"group":"Structures","pages":[{"title":"XTFCONSOLEDATA Structure","description":"XTFCONSOLEDATA Structure","sidebarTitle":"XTFCONSOLEDATA Structure","href":"/reference/tools/xtf/xtfconsolemanager/structures/xtfconsoledata-xtfconsolemanager-xbox-microsoft-t"}]}]},{"group":"XtfDebugMonitor","pages":[{"group":"Classes","pages":[{"group":"IXtfDebugMonitorCallback","pages":[{"group":"Methods","pages":[{"title":"IXtfDebugMonitorCallback::OnOutputDebugString Method","description":"IXtfDebugMonitorCallback::OnOutputDebugString Method","sidebarTitle":"IXtfDebugMonitorCallback::OnOutputDebugString Method","href":"/reference/tools/xtf/xtfdebugmonitor/classes/IXtfDebugMonitorCallback/methods/onoutputdebugstring-ixtfdebugmonitorcallback-xtfdebugmonitor-xbox-microsoft-m"}]}]},{"group":"IXtfDebugMonitorClient","pages":[{"group":"Methods","pages":[{"title":"IXtfDebugMonitorClient::Start Method","description":"IXtfDebugMonitorClient::Start Method","sidebarTitle":"IXtfDebugMonitorClient::Start Method","href":"/reference/tools/xtf/xtfdebugmonitor/classes/IXtfDebugMonitorClient/methods/start-ixtfdebugmonitorclient-xtfdebugmonitor-xbox-microsoft-m"},{"title":"IXtfDebugMonitorClient::Stop Method","description":"IXtfDebugMonitorClient::Stop Method","sidebarTitle":"IXtfDebugMonitorClient::Stop Method","href":"/reference/tools/xtf/xtfdebugmonitor/classes/IXtfDebugMonitorClient/methods/stop-ixtfdebugmonitorclient-xtfdebugmonitor-xbox-microsoft-m"}]}]}]},{"group":"Methods","pages":[{"title":"XtfCreateDebugMonitorClient","description":"XtfCreateDebugMonitorClient","sidebarTitle":"XtfCreateDebugMonitorClient","href":"/reference/tools/xtf/xtfdebugmonitor/methods/xtfcreatedebugmonitorclient-xtfdebugmonitor-xbox-microsoft-m"}]},{"group":"Structures","pages":[{"title":"XTF_OUTPUT_DEBUG_STRING_DATA structure","description":"XTF_OUTPUT_DEBUG_STRING_DATA structure","sidebarTitle":"XTF_OUTPUT_DEBUG_STRING_DATA structure","href":"/reference/tools/xtf/xtfdebugmonitor/structures/XTF_OUTPUT_DEBUG_STRING_DATA-xtfdebugmonitor-xbox-microsoft-t"}]}]},{"group":"XtfFileIO","pages":[{"group":"Classes","pages":[{"group":"IXtfBatchFileIOClient","pages":[{"group":"Methods","pages":[{"title":"IXtfBatchFileIOClient::CopyFiles Method","description":"IXtfBatchFileIOClient::CopyFiles Method","sidebarTitle":"IXtfBatchFileIOClient::CopyFiles Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfBatchFileIOClient/methods/copyfiles-ixtfbatchfileioclient-xtffileio-xbox-microsoft-m"}]}]},{"group":"IXtfCopyFileCallback","pages":[{"group":"Methods","pages":[{"title":"IXtfCopyFileCallback::OnEndFileCopy Method","description":"IXtfCopyFileCallback::OnEndFileCopy Method","sidebarTitle":"IXtfCopyFileCallback::OnEndFileCopy Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfCopyFileCallback/methods/onendfilecopy-ixtfcopyfilecallback-xtffileio-xbox-microsoft-m"},{"title":"IXtfCopyFileCallback::OnFileCopyProgress Method","description":"IXtfCopyFileCallback::OnFileCopyProgress Method","sidebarTitle":"IXtfCopyFileCallback::OnFileCopyProgress Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfCopyFileCallback/methods/onfilecopyprogress-ixtfcopyfilecallback-xtffileio-xbox-microsoft-m"},{"title":"IXtfCopyFileCallback::OnStartFileCopy Method","description":"IXtfCopyFileCallback::OnStartFileCopy Method","sidebarTitle":"IXtfCopyFileCallback::OnStartFileCopy Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfCopyFileCallback/methods/onstartfilecopy-ixtfcopyfilecallback-xtffileio-xbox-microsoft-m"}]}]},{"group":"IXtfFileIOClient","pages":[{"group":"Methods","pages":[{"title":"IXtfFileIOClient::CopyFiles Method","description":"IXtfFileIOClient::CopyFiles Method","sidebarTitle":"IXtfFileIOClient::CopyFiles Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/copyfiles-ixtffileioclient-xtffileio-xbox-microsoft-m"},{"title":"IXtfFileIOClient::CreateDirectory Method","description":"IXtfFileIOClient::CreateDirectory Method","sidebarTitle":"IXtfFileIOClient::CreateDirectory Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/createdirectory-ixtffileioclient-xtffileio-xbox-microsoft-m"},{"title":"IXtfFileIOClient::DeleteFiles Method","description":"IXtfFileIOClient::DeleteFiles Method","sidebarTitle":"IXtfFileIOClient::DeleteFiles Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/deletefiles-ixtffileioclient-xtffileio-xbox-microsoft-m"},{"title":"IXtfFileIOClient::FindFiles Method","description":"IXtfFileIOClient::FindFiles Method","sidebarTitle":"IXtfFileIOClient::FindFiles Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/findfiles-ixtffileioclient-xtffileio-xbox-microsoft-m"},{"title":"IXtfFileIOClient::GetFileAttributes Method","description":"IXtfFileIOClient::GetFileAttributes Method","sidebarTitle":"IXtfFileIOClient::GetFileAttributes Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/getfileattributes-ixtffileioclient-xtffileio-xbox-microsoft-m"},{"title":"IXtfFileIOClient::GetFileInfo Method","description":"IXtfFileIOClient::GetFileInfo Method","sidebarTitle":"IXtfFileIOClient::GetFileInfo Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/getfileinfo-ixtffileioclient-xtffileio-xbox-microsoft-m"},{"title":"IXtfFileIOClient::GetFileSize Method","description":"IXtfFileIOClient::GetFileSize Method","sidebarTitle":"IXtfFileIOClient::GetFileSize Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/getfilesize-ixtffileioclient-xtffileio-xbox-microsoft-m"},{"title":"IXtfFileIOClient::RemoveDirectory Method","description":"IXtfFileIOClient::RemoveDirectory Method","sidebarTitle":"IXtfFileIOClient::RemoveDirectory Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/removedirectory-ixtffileioclient-xtffileio-xbox-microsoft-m"},{"title":"IXtfFileIOClient::SetFileAttributes Method","description":"IXtfFileIOClient::SetFileAttributes Method","sidebarTitle":"IXtfFileIOClient::SetFileAttributes Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/setfileattributes-ixtffileioclient-xtffileio-xbox-microsoft-m"}]}]},{"group":"IXtfFindFileCallback","pages":[{"group":"Methods","pages":[{"title":"IXtfFindFileCallback::OnFoundFile Method","description":"IXtfFindFileCallback::OnFoundFile Method","sidebarTitle":"IXtfFindFileCallback::OnFoundFile Method","href":"/reference/tools/xtf/xtffileio/classes/IXtfFindFileCallback/methods/onfoundfile-ixtffindfilecallback-xtffileio-xbox-microsoft-m"}]}]}]},{"group":"Methods","pages":[{"title":"XtfCreateFileIOClient","description":"XtfCreateFileIOClient","sidebarTitle":"XtfCreateFileIOClient","href":"/reference/tools/xtf/xtffileio/methods/xtfcreatefileioclient-xtffileio-xbox-microsoft-m"}]},{"group":"Structures","pages":[{"title":"XTFFILEINFO","description":"XTFFILEINFO","sidebarTitle":"XTFFILEINFO","href":"/reference/tools/xtf/xtffileio/structures/xtffileinfo-xtffileio-xbox-microsoft-t"},{"title":"XTFFILEIORESERVED","description":"XTFFILEIORESERVED","sidebarTitle":"XTFFILEIORESERVED","href":"/reference/tools/xtf/xtffileio/structures/xtffileioreserved-xtffileio-xbox-microsoft-t"}]}]},{"group":"XtfInput","pages":[{"group":"Classes","pages":[{"group":"IXtfInputClient","pages":[{"group":"Methods","pages":[{"title":"IXtfInputClient::ConnectGamepad Method","description":"IXtfInputClient::ConnectGamepad Method","sidebarTitle":"IXtfInputClient::ConnectGamepad Method","href":"/reference/tools/xtf/xtfinput/classes/IXtfInputClient/methods/connectgamepad-ixtfinputclient-xtfinput-xbox-windows-m"},{"title":"IXtfInputClient::DisconnectAllGamepads Method","description":"IXtfInputClient::DisconnectAllGamepads Method","sidebarTitle":"IXtfInputClient::DisconnectAllGamepads Method","href":"/reference/tools/xtf/xtfinput/classes/IXtfInputClient/methods/disconnectallgamepads-ixtfinputclient-xtfinput-xbox-windows-m"},{"title":"IXtfInputClient::DisconnectGamepad Method","description":"IXtfInputClient::DisconnectGamepad Method","sidebarTitle":"IXtfInputClient::DisconnectGamepad Method","href":"/reference/tools/xtf/xtfinput/classes/IXtfInputClient/methods/disconnectgamepad-ixtfinputclient-xtfinput-xbox-windows-m"},{"title":"IXtfInputClient::SendGamepadReportEx","description":"IXtfInputClient::SendGamepadReportEx","sidebarTitle":"IXtfInputClient::SendGamepadReportEx","href":"/reference/tools/xtf/xtfinput/classes/IXtfInputClient/methods/ixtfinputclient_sendgamepadreportex"},{"title":"IXtfInputClient::SendGamepadReportWithAudio","description":"IXtfInputClient::SendGamepadReportWithAudio","sidebarTitle":"IXtfInputClient::SendGamepadReportWithAudio","href":"/reference/tools/xtf/xtfinput/classes/IXtfInputClient/methods/ixtfinputclient_sendgamepadreportwithaudio"},{"title":"IXtfInputClient::SendGamepadReport Method","description":"IXtfInputClient::SendGamepadReport Method","sidebarTitle":"IXtfInputClient::SendGamepadReport Method","href":"/reference/tools/xtf/xtfinput/classes/IXtfInputClient/methods/sendgamepadreport-ixtfinputclient-xtfinput-xbox-windows-m"}]}]}]},{"group":"Enumerations","pages":[{"title":"GAMEPAD_BUTTONS Enumeration","description":"GAMEPAD_BUTTONS Enumeration","sidebarTitle":"GAMEPAD_BUTTONS Enumeration","href":"/reference/tools/xtf/xtfinput/enumerations/GAMEPAD_BUTTONS-typedef-xtfinput-xbox-windows-t"},{"title":"GAMEPAD_MORE_BUTTONS","description":"GAMEPAD_MORE_BUTTONS","sidebarTitle":"GAMEPAD_MORE_BUTTONS","href":"/reference/tools/xtf/xtfinput/enumerations/gamepad_more_buttons"}]},{"group":"Methods","pages":[{"title":"XtfCreateInputClient","description":"XtfCreateInputClient","sidebarTitle":"XtfCreateInputClient","href":"/reference/tools/xtf/xtfinput/methods/xtfcreateinputclient-xtfinput-xbox-windows-m"}]},{"group":"Structures","pages":[{"title":"GAMEPAD_REPORT_EX","description":"GAMEPAD_REPORT_EX","sidebarTitle":"GAMEPAD_REPORT_EX","href":"/reference/tools/xtf/xtfinput/structures/gamepad_report_ex"},{"title":"GAMEPAD_REPORT structure","description":"GAMEPAD_REPORT structure","sidebarTitle":"GAMEPAD_REPORT structure","href":"/reference/tools/xtf/xtfinput/structures/GAMEPAD_REPORT-xtfinput-xbox-windows-t"},{"title":"GAMEPAD_VIBRATION","description":"GAMEPAD_VIBRATION","sidebarTitle":"GAMEPAD_VIBRATION","href":"/reference/tools/xtf/xtfinput/structures/gamepad_vibration"}]}]},{"group":"XtfRemoteRun","pages":[{"group":"Classes","pages":[{"group":"IXtfRemoteRunCallback","pages":[{"group":"Interfaces","pages":[{"title":"IXtfRemoteRunCallback Interface","description":"IXtfRemoteRunCallback Interface","sidebarTitle":"IXtfRemoteRunCallback Interface","href":"/reference/tools/xtf/xtfremoterun/classes/IXtfRemoteRunCallback/interfaces/ixtfremoteruncallback"}]},{"group":"Methods","pages":[{"title":"IXtfRemoteRunCallback::Input Method","description":"IXtfRemoteRunCallback::Input Method","sidebarTitle":"IXtfRemoteRunCallback::Input Method","href":"/reference/tools/xtf/xtfremoterun/classes/IXtfRemoteRunCallback/methods/ixtfremoteruncallback_input"},{"title":"IXtfRemoteRunCallback::Output Method","description":"IXtfRemoteRunCallback::Output Method","sidebarTitle":"IXtfRemoteRunCallback::Output Method","href":"/reference/tools/xtf/xtfremoterun/classes/IXtfRemoteRunCallback/methods/ixtfremoteruncallback_output"}]}]},{"group":"IXtfRemoteRunClient","pages":[{"group":"Interfaces","pages":[{"title":"IXtfRemoteRunClient Interface","description":"IXtfRemoteRunClient Interface","sidebarTitle":"IXtfRemoteRunClient Interface","href":"/reference/tools/xtf/xtfremoterun/classes/IXtfRemoteRunClient/interfaces/ixtfremoterunclient"}]},{"group":"Methods","pages":[{"title":"IXtfRemoteRunClient::Run Method","description":"IXtfRemoteRunClient::Run Method","sidebarTitle":"IXtfRemoteRunClient::Run Method","href":"/reference/tools/xtf/xtfremoterun/classes/IXtfRemoteRunClient/methods/ixtfremoterunclient_run"}]}]}]},{"group":"Methods","pages":[{"title":"XtfCreateRemoteRunClient Method","description":"XtfCreateRemoteRunClient Method","sidebarTitle":"XtfCreateRemoteRunClient Method","href":"/reference/tools/xtf/xtfremoterun/methods/xtfremoterun_xtfcreateremoterunclient"}]}]},{"group":"XtfUser","pages":[{"group":"Classes","pages":[{"group":"IXtfUserClient","pages":[{"group":"Methods","pages":[{"title":"IXtfUserClient::AddSponsoredUser","description":"IXtfUserClient::AddSponsoredUser","sidebarTitle":"IXtfUserClient::AddSponsoredUser","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/addsponsoreduser-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::AddUser Method","description":"IXtfUserClient::AddUser Method","sidebarTitle":"IXtfUserClient::AddUser Method","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/adduser-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::DeleteAllUsers","description":"IXtfUserClient::DeleteAllUsers","sidebarTitle":"IXtfUserClient::DeleteAllUsers","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/deleteallusers-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::DeleteUser","description":"IXtfUserClient::DeleteUser","sidebarTitle":"IXtfUserClient::DeleteUser","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/deleteuser-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::DeleteUserId","description":"IXtfUserClient::DeleteUserId","sidebarTitle":"IXtfUserClient::DeleteUserId","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/deleteuserid-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::ListUsersEx","description":"IXtfUserClient::ListUsersEx","sidebarTitle":"IXtfUserClient::ListUsersEx","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/ixtfuserclient_listusersex"},{"title":"IXtfUserClient::ListUsers","description":"IXtfUserClient::ListUsers","sidebarTitle":"IXtfUserClient::ListUsers","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/listusers-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::PairControllerWithUser Method","description":"IXtfUserClient::PairControllerWithUser Method","sidebarTitle":"IXtfUserClient::PairControllerWithUser Method","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/paircontrollerwithuser-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::PairControllerWithUserId Method","description":"IXtfUserClient::PairControllerWithUserId Method","sidebarTitle":"IXtfUserClient::PairControllerWithUserId Method","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/paircontrollerwithuserid-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::SigninUser","description":"IXtfUserClient::SigninUser","sidebarTitle":"IXtfUserClient::SigninUser","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/signinuser-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::SigninUserId","description":"IXtfUserClient::SigninUserId","sidebarTitle":"IXtfUserClient::SigninUserId","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/signinuserid-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::SignoutUser","description":"IXtfUserClient::SignoutUser","sidebarTitle":"IXtfUserClient::SignoutUser","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/signoutuser-ixtfuserclient-xtfuser-xbox-windows-m"},{"title":"IXtfUserClient::SignoutUserId","description":"IXtfUserClient::SignoutUserId","sidebarTitle":"IXtfUserClient::SignoutUserId","href":"/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/signoutuserid-ixtfuserclient-xtfuser-xbox-windows-m"}]}]}]},{"group":"Enumerations","pages":[{"title":"XTF_USER_AGE_GROUP","description":"XTF_USER_AGE_GROUP","sidebarTitle":"XTF_USER_AGE_GROUP","href":"/reference/tools/xtf/xtfuser/enumerations/xtf_user_age_group"}]},{"group":"Methods","pages":[{"title":"XtfCreateUserClient","description":"XtfCreateUserClient","sidebarTitle":"XtfCreateUserClient","href":"/reference/tools/xtf/xtfuser/methods/xtfcreateuserclient-xtfuser-xbox-windows-m"}]},{"group":"Structures","pages":[{"title":"XTF_USER_DATA_V2","description":"XTF_USER_DATA_V2","sidebarTitle":"XTF_USER_DATA_V2","href":"/reference/tools/xtf/xtfuser/structures/xtf_user_data_v2"},{"title":"XTF_USER_DATA","description":"XTF_USER_DATA","sidebarTitle":"XTF_USER_DATA","href":"/reference/tools/xtf/xtfuser/structures/XTF_USER_DATA-xtfuser-xbox-windows-t"}]}]}]},{"group":"PackagingServices","pages":[{"title":"PackagingServices","description":"PackagingServices","sidebarTitle":"PackagingServices","href":"/reference/tools/packagingservices/packagingservices_members"},{"group":"Functions","pages":[{"title":"GetIsGameCorePartition","description":"GetIsGameCorePartition","sidebarTitle":"GetIsGameCorePartition","href":"/reference/tools/packagingservices/functions/getisgamecorepartition"},{"title":"GetIsTitlePartition","description":"GetIsTitlePartition","sidebarTitle":"GetIsTitlePartition","href":"/reference/tools/packagingservices/functions/getistitlepartition"},{"title":"GetPackageFamilyNameFromManifest","description":"GetPackageFamilyNameFromManifest","sidebarTitle":"GetPackageFamilyNameFromManifest","href":"/reference/tools/packagingservices/functions/getpackagefamilynamefrommanifest"},{"title":"GetPackageFullNameFromInfo","description":"GetPackageFullNameFromInfo","sidebarTitle":"GetPackageFullNameFromInfo","href":"/reference/tools/packagingservices/functions/getpackagefullnamefrominfo"},{"title":"GetPackageFullNameFromManifest","description":"GetPackageFullNameFromManifest","sidebarTitle":"GetPackageFullNameFromManifest","href":"/reference/tools/packagingservices/functions/getpackagefullnamefrommanifest"},{"title":"GetPackageInfoFromGameConfig","description":"GetPackageInfoFromGameConfig","sidebarTitle":"GetPackageInfoFromGameConfig","href":"/reference/tools/packagingservices/functions/getpackageinfofromgameconfig"},{"title":"GetPackageVersionFromManifest","description":"GetPackageVersionFromManifest","sidebarTitle":"GetPackageVersionFromManifest","href":"/reference/tools/packagingservices/functions/getpackageversionfrommanifest"},{"title":"PackagingValidateGameConfig","description":"PackagingValidateGameConfig","sidebarTitle":"PackagingValidateGameConfig","href":"/reference/tools/packagingservices/functions/packagingvalidategameconfig"},{"title":"ValidateSchemaForManifest","description":"ValidateSchemaForManifest","sidebarTitle":"ValidateSchemaForManifest","href":"/reference/tools/packagingservices/functions/validateschemaformanifest"}]}]}]},{"group":"Windows device portal REST API reference","pages":[{"title":"Windows Device Portal REST API reference","description":"REST API reference for Windows Device Portal (WDP) on XBOX, letting GDK developers programmatically access data and control XBOX development kits.","sidebarTitle":"Windows Device Portal REST API Reference","href":"/reference/deviceportal/atoc-deviceportal-reference"},{"group":"Front Panel URIs","pages":[{"title":"Front Panel URIs","description":"Front Panel URIs","sidebarTitle":"Front Panel URIs","href":"/reference/deviceportal/frontpanel/atoc-rest-frontpanel"}]},{"group":"Remote Recovery URIs","pages":[{"title":"Remote Recovery URIs","description":"Remote Recovery URIs","sidebarTitle":"Remote Recovery URIs","href":"/reference/deviceportal/remote/atoc-rest-remote"}]},{"group":"Unattended Setup URIs","pages":[{"title":"Unattended Setup URIs","description":"Unattended Setup URIs","sidebarTitle":"Unattended Setup URIs","href":"/reference/deviceportal/unattendedsetup/atoc-rest-unattendedsetup"}]}]},{"group":"XBOX services API reference","pages":[{"title":"XBOX services API reference","description":"XBOX services API reference for the Microsoft Game Development Kit (GDK), covering XSAPI, httpClient, and XBOX Live HRESULT error codes for GDK titles.","sidebarTitle":"XBOX services API reference","href":"/reference/live/gc-reference-live-toc"},{"group":"HttpClient","pages":[{"title":"HttpClient API reference","description":"HttpClient API reference","sidebarTitle":"HttpClient API reference","href":"/reference/live/httpclient/atoc-httpclient"},{"group":"httpClient","pages":[{"group":"Enums","pages":[{"title":"HCCompressionLevel","description":"HCCompressionLevel","sidebarTitle":"HCCompressionLevel","href":"/reference/live/httpclient/httpclient/enums/hccompressionlevel"},{"title":"HCConfigSetting","description":"HCConfigSetting","sidebarTitle":"HCConfigSetting","href":"/reference/live/httpclient/httpclient/enums/hcconfigsetting"}]},{"group":"Functions","pages":[{"title":"HCAddCallRoutedHandler","description":"HCAddCallRoutedHandler","sidebarTitle":"HCAddCallRoutedHandler","href":"/reference/live/httpclient/httpclient/functions/hcaddcallroutedhandler"},{"title":"HCAddWebSocketRoutedHandler","description":"HCAddWebSocketRoutedHandler","sidebarTitle":"HCAddWebSocketRoutedHandler","href":"/reference/live/httpclient/httpclient/functions/hcaddwebsocketroutedhandler"},{"title":"HCCleanup","description":"HCCleanup","sidebarTitle":"HCCleanup","href":"/reference/live/httpclient/httpclient/functions/hccleanup"},{"title":"HCCleanupAsync","description":"HCCleanupAsync","sidebarTitle":"HCCleanupAsync","href":"/reference/live/httpclient/httpclient/functions/hccleanupasync"},{"title":"HCGetLibVersion","description":"HCGetLibVersion","sidebarTitle":"HCGetLibVersion","href":"/reference/live/httpclient/httpclient/functions/hcgetlibversion"},{"title":"HCGetWebSocketConnectResult","description":"HCGetWebSocketConnectResult","sidebarTitle":"HCGetWebSocketConnectResult","href":"/reference/live/httpclient/httpclient/functions/hcgetwebsocketconnectresult"},{"title":"HCGetWebSocketSendMessageResult","description":"HCGetWebSocketSendMessageResult","sidebarTitle":"HCGetWebSocketSendMessageResult","href":"/reference/live/httpclient/httpclient/functions/hcgetwebsocketsendmessageresult"},{"title":"HCHttpCallCloseHandle","description":"HCHttpCallCloseHandle","sidebarTitle":"HCHttpCallCloseHandle","href":"/reference/live/httpclient/httpclient/functions/hchttpcallclosehandle"},{"title":"HCHttpCallCreate","description":"HCHttpCallCreate","sidebarTitle":"HCHttpCallCreate","href":"/reference/live/httpclient/httpclient/functions/hchttpcallcreate"},{"title":"HCHttpCallDuplicateHandle","description":"HCHttpCallDuplicateHandle","sidebarTitle":"HCHttpCallDuplicateHandle","href":"/reference/live/httpclient/httpclient/functions/hchttpcallduplicatehandle"},{"title":"HCHttpCallGetId","description":"HCHttpCallGetId","sidebarTitle":"HCHttpCallGetId","href":"/reference/live/httpclient/httpclient/functions/hchttpcallgetid"},{"title":"HCHttpCallGetRequestUrl","description":"HCHttpCallGetRequestUrl","sidebarTitle":"HCHttpCallGetRequestUrl","href":"/reference/live/httpclient/httpclient/functions/hchttpcallgetrequesturl"},{"title":"HCHttpCallPerformAsync","description":"HCHttpCallPerformAsync","sidebarTitle":"HCHttpCallPerformAsync","href":"/reference/live/httpclient/httpclient/functions/hchttpcallperformasync"},{"title":"HCHttpCallRequestEnableGzipCompression","description":"HCHttpCallRequestEnableGzipCompression","sidebarTitle":"HCHttpCallRequestEnableGzipCompression","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestenablegzipcompression"},{"title":"HCHttpCallRequestSetHeader","description":"HCHttpCallRequestSetHeader","sidebarTitle":"HCHttpCallRequestSetHeader","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsetheader"},{"title":"HCHttpCallRequestSetRequestBodyBytes","description":"HCHttpCallRequestSetRequestBodyBytes","sidebarTitle":"HCHttpCallRequestSetRequestBodyBytes","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsetrequestbodybytes"},{"title":"HCHttpCallRequestSetRequestBodyReadFunction","description":"HCHttpCallRequestSetRequestBodyReadFunction","sidebarTitle":"HCHttpCallRequestSetRequestBodyReadFunction","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsetrequestbodyreadfunction"},{"title":"HCHttpCallRequestSetRequestBodyString","description":"HCHttpCallRequestSetRequestBodyString","sidebarTitle":"HCHttpCallRequestSetRequestBodyString","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsetrequestbodystring"},{"title":"HCHttpCallRequestSetRetryAllowed","description":"HCHttpCallRequestSetRetryAllowed","sidebarTitle":"HCHttpCallRequestSetRetryAllowed","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsetretryallowed"},{"title":"HCHttpCallRequestSetRetryCacheId","description":"HCHttpCallRequestSetRetryCacheId","sidebarTitle":"HCHttpCallRequestSetRetryCacheId","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsetretrycacheid"},{"title":"HCHttpCallRequestSetRetryDelay","description":"HCHttpCallRequestSetRetryDelay","sidebarTitle":"HCHttpCallRequestSetRetryDelay","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsetretrydelay"},{"title":"HCHttpCallRequestSetSSLValidation","description":"HCHttpCallRequestSetSSLValidation","sidebarTitle":"HCHttpCallRequestSetSSLValidation","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsetsslvalidation"},{"title":"HCHttpCallRequestSetTimeout","description":"HCHttpCallRequestSetTimeout","sidebarTitle":"HCHttpCallRequestSetTimeout","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsettimeout"},{"title":"HCHttpCallRequestSetTimeoutWindow","description":"HCHttpCallRequestSetTimeoutWindow","sidebarTitle":"HCHttpCallRequestSetTimeoutWindow","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestsettimeoutwindow"},{"title":"HCHttpCallRequestSetUrl","description":"HCHttpCallRequestSetUrl","sidebarTitle":"HCHttpCallRequestSetUrl","href":"/reference/live/httpclient/httpclient/functions/hchttpcallrequestseturl"},{"title":"HCHttpCallResponseGetHeader","description":"HCHttpCallResponseGetHeader","sidebarTitle":"HCHttpCallResponseGetHeader","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsegetheader"},{"title":"HCHttpCallResponseGetHeaderAtIndex","description":"HCHttpCallResponseGetHeaderAtIndex","sidebarTitle":"HCHttpCallResponseGetHeaderAtIndex","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsegetheaderatindex"},{"title":"HCHttpCallResponseGetNetworkErrorCode","description":"HCHttpCallResponseGetNetworkErrorCode","sidebarTitle":"HCHttpCallResponseGetNetworkErrorCode","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsegetnetworkerrorcode"},{"title":"HCHttpCallResponseGetNumHeaders","description":"HCHttpCallResponseGetNumHeaders","sidebarTitle":"HCHttpCallResponseGetNumHeaders","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsegetnumheaders"},{"title":"HCHttpCallResponseGetPlatformNetworkErrorMessage","description":"HCHttpCallResponseGetPlatformNetworkErrorMessage","sidebarTitle":"HCHttpCallResponseGetPlatformNetworkErrorMessage","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsegetplatformnetworkerrormessage"},{"title":"HCHttpCallResponseGetResponseBodyBytes","description":"HCHttpCallResponseGetResponseBodyBytes","sidebarTitle":"HCHttpCallResponseGetResponseBodyBytes","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsegetresponsebodybytes"},{"title":"HCHttpCallResponseGetResponseBodyBytesSize","description":"HCHttpCallResponseGetResponseBodyBytesSize","sidebarTitle":"HCHttpCallResponseGetResponseBodyBytesSize","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsegetresponsebodybytessize"},{"title":"HCHttpCallResponseGetResponseString","description":"HCHttpCallResponseGetResponseString","sidebarTitle":"HCHttpCallResponseGetResponseString","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsegetresponsestring"},{"title":"HCHttpCallResponseGetStatusCode","description":"HCHttpCallResponseGetStatusCode","sidebarTitle":"HCHttpCallResponseGetStatusCode","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsegetstatuscode"},{"title":"HCHttpCallResponseSetGzipCompressed","description":"HCHttpCallResponseSetGzipCompressed","sidebarTitle":"HCHttpCallResponseSetGzipCompressed","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsesetgzipcompressed"},{"title":"HCHttpCallResponseSetResponseBodyWriteFunction","description":"HCHttpCallResponseSetResponseBodyWriteFunction","sidebarTitle":"HCHttpCallResponseSetResponseBodyWriteFunction","href":"/reference/live/httpclient/httpclient/functions/hchttpcallresponsesetresponsebodywritefunction"},{"title":"HCHttpCallSetTracing","description":"HCHttpCallSetTracing","sidebarTitle":"HCHttpCallSetTracing","href":"/reference/live/httpclient/httpclient/functions/hchttpcallsettracing"},{"title":"HCHttpDisableAssertsForSSLValidationInDevSandboxes","description":"HCHttpDisableAssertsForSSLValidationInDevSandboxes","sidebarTitle":"HCHttpDisableAssertsForSSLValidationInDevSandboxes","href":"/reference/live/httpclient/httpclient/functions/hchttpdisableassertsforsslvalidationindevsandboxes"},{"title":"HCInitialize","description":"HCInitialize","sidebarTitle":"HCInitialize","href":"/reference/live/httpclient/httpclient/functions/hcinitialize"},{"title":"HCIsInitialized","description":"HCIsInitialized","sidebarTitle":"HCIsInitialized","href":"/reference/live/httpclient/httpclient/functions/hcisinitialized"},{"title":"HCMemGetFunctions","description":"HCMemGetFunctions","sidebarTitle":"HCMemGetFunctions","href":"/reference/live/httpclient/httpclient/functions/hcmemgetfunctions"},{"title":"HCMemSetFunctions","description":"HCMemSetFunctions","sidebarTitle":"HCMemSetFunctions","href":"/reference/live/httpclient/httpclient/functions/hcmemsetfunctions"},{"title":"HCRemoveCallRoutedHandler","description":"HCRemoveCallRoutedHandler","sidebarTitle":"HCRemoveCallRoutedHandler","href":"/reference/live/httpclient/httpclient/functions/hcremovecallroutedhandler"},{"title":"HCRemoveWebSocketRoutedHandler","description":"HCRemoveWebSocketRoutedHandler","sidebarTitle":"HCRemoveWebSocketRoutedHandler","href":"/reference/live/httpclient/httpclient/functions/hcremovewebsocketroutedhandler"},{"title":"HCSetGlobalProxy","description":"HCSetGlobalProxy","sidebarTitle":"HCSetGlobalProxy","href":"/reference/live/httpclient/httpclient/functions/hcsetglobalproxy"},{"title":"HCWebSocketCloseHandle","description":"HCWebSocketCloseHandle","sidebarTitle":"HCWebSocketCloseHandle","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketclosehandle"},{"title":"HCWebSocketConnectAsync","description":"HCWebSocketConnectAsync","sidebarTitle":"HCWebSocketConnectAsync","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketconnectasync"},{"title":"HCWebSocketCreate","description":"HCWebSocketCreate","sidebarTitle":"HCWebSocketCreate","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketcreate"},{"title":"HCWebSocketDisconnect","description":"HCWebSocketDisconnect","sidebarTitle":"HCWebSocketDisconnect","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketdisconnect"},{"title":"HCWebSocketDuplicateHandle","description":"HCWebSocketDuplicateHandle","sidebarTitle":"HCWebSocketDuplicateHandle","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketduplicatehandle"},{"title":"HCWebSocketGetBinaryMessageFragmentEventFunction","description":"HCWebSocketGetBinaryMessageFragmentEventFunction","sidebarTitle":"HCWebSocketGetBinaryMessageFragmentEventFunction","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketgetbinarymessagefragmenteventfunction"},{"title":"HCWebSocketGetEventFunctions","description":"HCWebSocketGetEventFunctions","sidebarTitle":"HCWebSocketGetEventFunctions","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketgeteventfunctions"},{"title":"HCWebSocketSendBinaryMessageAsync","description":"HCWebSocketSendBinaryMessageAsync","sidebarTitle":"HCWebSocketSendBinaryMessageAsync","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketsendbinarymessageasync"},{"title":"HCWebSocketSendMessageAsync","description":"HCWebSocketSendMessageAsync","sidebarTitle":"HCWebSocketSendMessageAsync","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketsendmessageasync"},{"title":"HCWebSocketSetBinaryMessageFragmentEventFunction","description":"HCWebSocketSetBinaryMessageFragmentEventFunction","sidebarTitle":"HCWebSocketSetBinaryMessageFragmentEventFunction","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketsetbinarymessagefragmenteventfunction"},{"title":"HCWebSocketSetHeader","description":"HCWebSocketSetHeader","sidebarTitle":"HCWebSocketSetHeader","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketsetheader"},{"title":"HCWebSocketSetMaxReceiveBufferSize","description":"HCWebSocketSetMaxReceiveBufferSize","sidebarTitle":"HCWebSocketSetMaxReceiveBufferSize","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketsetmaxreceivebuffersize"},{"title":"HCWebSocketSetProxyDecryptsHttps","description":"HCWebSocketSetProxyDecryptsHttps","sidebarTitle":"HCWebSocketSetProxyDecryptsHttps","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketsetproxydecryptshttps"},{"title":"HCWebSocketSetProxyUri","description":"HCWebSocketSetProxyUri","sidebarTitle":"HCWebSocketSetProxyUri","href":"/reference/live/httpclient/httpclient/functions/hcwebsocketsetproxyuri"}]},{"group":"Structs","pages":[{"title":"HCInitArgs data structure","description":"HCInitArgs data structure","sidebarTitle":"HCInitArgs data structure","href":"/reference/live/httpclient/httpclient/structs/hcinitargs"},{"title":"HCInitArgs","description":"HCInitArgs","sidebarTitle":"HCInitArgs","href":"/reference/live/httpclient/httpclient/structs/hcinitargs_2"},{"title":"WebSocketCompletionResult","description":"WebSocketCompletionResult","sidebarTitle":"WebSocketCompletionResult","href":"/reference/live/httpclient/httpclient/structs/websocketcompletionresult"}]}]},{"group":"httpProvider","pages":[{"group":"Functions","pages":[{"title":"HCGetHttpCallPerformFunction","description":"HCGetHttpCallPerformFunction","sidebarTitle":"HCGetHttpCallPerformFunction","href":"/reference/live/httpclient/httpprovider/functions/hcgethttpcallperformfunction"},{"title":"HCGetWebSocketFunctions","description":"HCGetWebSocketFunctions","sidebarTitle":"HCGetWebSocketFunctions","href":"/reference/live/httpclient/httpprovider/functions/hcgetwebsocketfunctions"},{"title":"HCHttpCallGetContext","description":"HCHttpCallGetContext","sidebarTitle":"HCHttpCallGetContext","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallgetcontext"},{"title":"HCHttpCallRequestGetHeader","description":"HCHttpCallRequestGetHeader","sidebarTitle":"HCHttpCallRequestGetHeader","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgetheader"},{"title":"HCHttpCallRequestGetHeaderAtIndex","description":"HCHttpCallRequestGetHeaderAtIndex","sidebarTitle":"HCHttpCallRequestGetHeaderAtIndex","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgetheaderatindex"},{"title":"HCHttpCallRequestGetNumHeaders","description":"HCHttpCallRequestGetNumHeaders","sidebarTitle":"HCHttpCallRequestGetNumHeaders","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgetnumheaders"},{"title":"HCHttpCallRequestGetRequestBodyBytes","description":"HCHttpCallRequestGetRequestBodyBytes","sidebarTitle":"HCHttpCallRequestGetRequestBodyBytes","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgetrequestbodybytes"},{"title":"HCHttpCallRequestGetRequestBodyReadFunction","description":"HCHttpCallRequestGetRequestBodyReadFunction","sidebarTitle":"HCHttpCallRequestGetRequestBodyReadFunction","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgetrequestbodyreadfunction"},{"title":"HCHttpCallRequestGetRequestBodyString","description":"HCHttpCallRequestGetRequestBodyString","sidebarTitle":"HCHttpCallRequestGetRequestBodyString","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgetrequestbodystring"},{"title":"HCHttpCallRequestGetRetryAllowed","description":"HCHttpCallRequestGetRetryAllowed","sidebarTitle":"HCHttpCallRequestGetRetryAllowed","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgetretryallowed"},{"title":"HCHttpCallRequestGetRetryCacheId","description":"HCHttpCallRequestGetRetryCacheId","sidebarTitle":"HCHttpCallRequestGetRetryCacheId","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgetretrycacheid"},{"title":"HCHttpCallRequestGetRetryDelay","description":"HCHttpCallRequestGetRetryDelay","sidebarTitle":"HCHttpCallRequestGetRetryDelay","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgetretrydelay"},{"title":"HCHttpCallRequestGetTimeout","description":"HCHttpCallRequestGetTimeout","sidebarTitle":"HCHttpCallRequestGetTimeout","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgettimeout"},{"title":"HCHttpCallRequestGetTimeoutWindow","description":"HCHttpCallRequestGetTimeoutWindow","sidebarTitle":"HCHttpCallRequestGetTimeoutWindow","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgettimeoutwindow"},{"title":"HCHttpCallRequestGetUrl","description":"HCHttpCallRequestGetUrl","sidebarTitle":"HCHttpCallRequestGetUrl","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallrequestgeturl"},{"title":"HCHttpCallResponseAppendResponseBodyBytes","description":"HCHttpCallResponseAppendResponseBodyBytes","sidebarTitle":"HCHttpCallResponseAppendResponseBodyBytes","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallresponseappendresponsebodybytes"},{"title":"HCHttpCallResponseGetResponseBodyWriteFunction","description":"HCHttpCallResponseGetResponseBodyWriteFunction","sidebarTitle":"HCHttpCallResponseGetResponseBodyWriteFunction","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallresponsegetresponsebodywritefunction"},{"title":"HCHttpCallResponseSetHeader","description":"HCHttpCallResponseSetHeader","sidebarTitle":"HCHttpCallResponseSetHeader","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallresponsesetheader"},{"title":"HCHttpCallResponseSetHeaderWithLength","description":"HCHttpCallResponseSetHeaderWithLength","sidebarTitle":"HCHttpCallResponseSetHeaderWithLength","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallresponsesetheaderwithlength"},{"title":"HCHttpCallResponseSetNetworkErrorCode","description":"HCHttpCallResponseSetNetworkErrorCode","sidebarTitle":"HCHttpCallResponseSetNetworkErrorCode","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallresponsesetnetworkerrorcode"},{"title":"HCHttpCallResponseSetPlatformNetworkErrorMessage","description":"HCHttpCallResponseSetPlatformNetworkErrorMessage","sidebarTitle":"HCHttpCallResponseSetPlatformNetworkErrorMessage","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallresponsesetplatformnetworkerrormessage"},{"title":"HCHttpCallResponseSetResponseBodyBytes","description":"HCHttpCallResponseSetResponseBodyBytes","sidebarTitle":"HCHttpCallResponseSetResponseBodyBytes","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallresponsesetresponsebodybytes"},{"title":"HCHttpCallResponseSetStatusCode","description":"HCHttpCallResponseSetStatusCode","sidebarTitle":"HCHttpCallResponseSetStatusCode","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallresponsesetstatuscode"},{"title":"HCHttpCallSetContext","description":"HCHttpCallSetContext","sidebarTitle":"HCHttpCallSetContext","href":"/reference/live/httpclient/httpprovider/functions/hchttpcallsetcontext"},{"title":"HCSetHttpCallPerformFunction","description":"HCSetHttpCallPerformFunction","sidebarTitle":"HCSetHttpCallPerformFunction","href":"/reference/live/httpclient/httpprovider/functions/hcsethttpcallperformfunction"},{"title":"HCSetWebSocketFunctions","description":"HCSetWebSocketFunctions","sidebarTitle":"HCSetWebSocketFunctions","href":"/reference/live/httpclient/httpprovider/functions/hcsetwebsocketfunctions"},{"title":"HCWebSocketGetHeader","description":"HCWebSocketGetHeader","sidebarTitle":"HCWebSocketGetHeader","href":"/reference/live/httpclient/httpprovider/functions/hcwebsocketgetheader"},{"title":"HCWebSocketGetHeaderAtIndex","description":"HCWebSocketGetHeaderAtIndex","sidebarTitle":"HCWebSocketGetHeaderAtIndex","href":"/reference/live/httpclient/httpprovider/functions/hcwebsocketgetheaderatindex"},{"title":"HCWebSocketGetNumHeaders","description":"HCWebSocketGetNumHeaders","sidebarTitle":"HCWebSocketGetNumHeaders","href":"/reference/live/httpclient/httpprovider/functions/hcwebsocketgetnumheaders"},{"title":"HCWebSocketGetProxyUri","description":"HCWebSocketGetProxyUri","sidebarTitle":"HCWebSocketGetProxyUri","href":"/reference/live/httpclient/httpprovider/functions/hcwebsocketgetproxyuri"}]}]},{"group":"mock","pages":[{"group":"Functions","pages":[{"title":"HCMockAddMock","description":"HCMockAddMock","sidebarTitle":"HCMockAddMock","href":"/reference/live/httpclient/mock/functions/hcmockaddmock"},{"title":"HCMockCallCloseHandle","description":"HCMockCallCloseHandle","sidebarTitle":"HCMockCallCloseHandle","href":"/reference/live/httpclient/mock/functions/hcmockcallclosehandle"},{"title":"HCMockCallCreate","description":"HCMockCallCreate","sidebarTitle":"HCMockCallCreate","href":"/reference/live/httpclient/mock/functions/hcmockcallcreate"},{"title":"HCMockCallDuplicateHandle","description":"HCMockCallDuplicateHandle","sidebarTitle":"HCMockCallDuplicateHandle","href":"/reference/live/httpclient/mock/functions/hcmockcallduplicatehandle"},{"title":"HCMockClearMocks","description":"HCMockClearMocks","sidebarTitle":"HCMockClearMocks","href":"/reference/live/httpclient/mock/functions/hcmockclearmocks"},{"title":"HCMockRemoveMock","description":"HCMockRemoveMock","sidebarTitle":"HCMockRemoveMock","href":"/reference/live/httpclient/mock/functions/hcmockremovemock"},{"title":"HCMockResponseSetHeader","description":"HCMockResponseSetHeader","sidebarTitle":"HCMockResponseSetHeader","href":"/reference/live/httpclient/mock/functions/hcmockresponsesetheader"},{"title":"HCMockResponseSetNetworkErrorCode","description":"HCMockResponseSetNetworkErrorCode","sidebarTitle":"HCMockResponseSetNetworkErrorCode","href":"/reference/live/httpclient/mock/functions/hcmockresponsesetnetworkerrorcode"},{"title":"HCMockResponseSetResponseBodyBytes","description":"HCMockResponseSetResponseBodyBytes","sidebarTitle":"HCMockResponseSetResponseBodyBytes","href":"/reference/live/httpclient/mock/functions/hcmockresponsesetresponsebodybytes"},{"title":"HCMockResponseSetStatusCode","description":"HCMockResponseSetStatusCode","sidebarTitle":"HCMockResponseSetStatusCode","href":"/reference/live/httpclient/mock/functions/hcmockresponsesetstatuscode"},{"title":"HCMockSetMockMatchedCallback","description":"HCMockSetMockMatchedCallback","sidebarTitle":"HCMockSetMockMatchedCallback","href":"/reference/live/httpclient/mock/functions/hcmocksetmockmatchedcallback"}]}]},{"group":"trace","pages":[{"group":"Enums","pages":[{"title":"HCTraceLevel","description":"HCTraceLevel","sidebarTitle":"HCTraceLevel","href":"/reference/live/httpclient/trace/enums/hctracelevel"}]},{"group":"Functions","pages":[{"title":"HCSettingsGetTraceLevel","description":"HCSettingsGetTraceLevel","sidebarTitle":"HCSettingsGetTraceLevel","href":"/reference/live/httpclient/trace/functions/hcsettingsgettracelevel"},{"title":"HCSettingsSetTraceLevel","description":"HCSettingsSetTraceLevel","sidebarTitle":"HCSettingsSetTraceLevel","href":"/reference/live/httpclient/trace/functions/hcsettingssettracelevel"},{"title":"HCTraceCleanup","description":"HCTraceCleanup","sidebarTitle":"HCTraceCleanup","href":"/reference/live/httpclient/trace/functions/hctracecleanup"},{"title":"HCTraceImplGetAreaVerbosity","description":"HCTraceImplGetAreaVerbosity","sidebarTitle":"HCTraceImplGetAreaVerbosity","href":"/reference/live/httpclient/trace/functions/hctraceimplgetareaverbosity"},{"title":"HCTraceImplMessage","description":"HCTraceImplMessage","sidebarTitle":"HCTraceImplMessage","href":"/reference/live/httpclient/trace/functions/hctraceimplmessage"},{"title":"HCTraceImplSetAreaVerbosity","description":"HCTraceImplSetAreaVerbosity","sidebarTitle":"HCTraceImplSetAreaVerbosity","href":"/reference/live/httpclient/trace/functions/hctraceimplsetareaverbosity"},{"title":"HCTraceInit","description":"HCTraceInit","sidebarTitle":"HCTraceInit","href":"/reference/live/httpclient/trace/functions/hctraceinit"},{"title":"HCTraceSetClientCallback","description":"HCTraceSetClientCallback","sidebarTitle":"HCTraceSetClientCallback","href":"/reference/live/httpclient/trace/functions/hctracesetclientcallback"},{"title":"HCTraceSetEtwEnabled","description":"HCTraceSetEtwEnabled","sidebarTitle":"HCTraceSetEtwEnabled","href":"/reference/live/httpclient/trace/functions/hctracesetetwenabled"},{"title":"HCTraceSetPlatformCallbacks","description":"HCTraceSetPlatformCallbacks","sidebarTitle":"HCTraceSetPlatformCallbacks","href":"/reference/live/httpclient/trace/functions/hctracesetplatformcallbacks"},{"title":"HCTraceSetTraceToDebugger","description":"HCTraceSetTraceToDebugger","sidebarTitle":"HCTraceSetTraceToDebugger","href":"/reference/live/httpclient/trace/functions/hctracesettracetodebugger"}]}]}]},{"group":"XSAPI","pages":[{"title":"XSAPI reference","description":"XSAPI reference","sidebarTitle":"XSAPI reference","href":"/reference/live/xsapi-c/atoc-xsapi-c"},{"group":"achievements_c","pages":[{"group":"Enums","pages":[{"title":"XblAchievementMediaAssetType","description":"XblAchievementMediaAssetType","sidebarTitle":"XblAchievementMediaAssetType","href":"/reference/live/xsapi-c/achievements_c/enums/xblachievementmediaassettype"},{"title":"XblAchievementOrderBy","description":"XblAchievementOrderBy","sidebarTitle":"XblAchievementOrderBy","href":"/reference/live/xsapi-c/achievements_c/enums/xblachievementorderby"},{"title":"XblAchievementParticipationType","description":"XblAchievementParticipationType","sidebarTitle":"XblAchievementParticipationType","href":"/reference/live/xsapi-c/achievements_c/enums/xblachievementparticipationtype"},{"title":"XblAchievementProgressState","description":"XblAchievementProgressState","sidebarTitle":"XblAchievementProgressState","href":"/reference/live/xsapi-c/achievements_c/enums/xblachievementprogressstate"},{"title":"XblAchievementRarityCategory","description":"XblAchievementRarityCategory","sidebarTitle":"XblAchievementRarityCategory","href":"/reference/live/xsapi-c/achievements_c/enums/xblachievementraritycategory"},{"title":"XblAchievementRewardType","description":"XblAchievementRewardType","sidebarTitle":"XblAchievementRewardType","href":"/reference/live/xsapi-c/achievements_c/enums/xblachievementrewardtype"},{"title":"XblAchievementType","description":"XblAchievementType","sidebarTitle":"XblAchievementType","href":"/reference/live/xsapi-c/achievements_c/enums/xblachievementtype"}]},{"group":"Functions","pages":[{"title":"XblAchievementsAddAchievementProgressChangeHandler","description":"XblAchievementsAddAchievementProgressChangeHandler","sidebarTitle":"XblAchievementsAddAchievementProgressChangeHandler","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsaddachievementprogresschangehandler"},{"title":"XblAchievementsGetAchievementAsync","description":"XblAchievementsGetAchievementAsync","sidebarTitle":"XblAchievementsGetAchievementAsync","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsgetachievementasync"},{"title":"XblAchievementsGetAchievementResult","description":"XblAchievementsGetAchievementResult","sidebarTitle":"XblAchievementsGetAchievementResult","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsgetachievementresult"},{"title":"XblAchievementsGetAchievementsForTitleIdAsync","description":"XblAchievementsGetAchievementsForTitleIdAsync","sidebarTitle":"XblAchievementsGetAchievementsForTitleIdAsync","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsgetachievementsfortitleidasync"},{"title":"XblAchievementsGetAchievementsForTitleIdResult","description":"XblAchievementsGetAchievementsForTitleIdResult","sidebarTitle":"XblAchievementsGetAchievementsForTitleIdResult","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsgetachievementsfortitleidresult"},{"title":"XblAchievementsProgressChangeHandler","description":"XblAchievementsProgressChangeHandler","sidebarTitle":"XblAchievementsProgressChangeHandler","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsprogresschangehandler"},{"title":"XblAchievementsRemoveAchievementProgressChangeHandler","description":"XblAchievementsRemoveAchievementProgressChangeHandler","sidebarTitle":"XblAchievementsRemoveAchievementProgressChangeHandler","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsremoveachievementprogresschangehandler"},{"title":"XblAchievementsResultCloseHandle","description":"XblAchievementsResultCloseHandle","sidebarTitle":"XblAchievementsResultCloseHandle","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsresultclosehandle"},{"title":"XblAchievementsResultDuplicateHandle","description":"XblAchievementsResultDuplicateHandle","sidebarTitle":"XblAchievementsResultDuplicateHandle","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsresultduplicatehandle"},{"title":"XblAchievementsResultGetAchievements","description":"XblAchievementsResultGetAchievements","sidebarTitle":"XblAchievementsResultGetAchievements","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsresultgetachievements"},{"title":"XblAchievementsResultGetNextAsync","description":"XblAchievementsResultGetNextAsync","sidebarTitle":"XblAchievementsResultGetNextAsync","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsresultgetnextasync"},{"title":"XblAchievementsResultGetNextResult","description":"XblAchievementsResultGetNextResult","sidebarTitle":"XblAchievementsResultGetNextResult","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsresultgetnextresult"},{"title":"XblAchievementsResultHasNext","description":"XblAchievementsResultHasNext","sidebarTitle":"XblAchievementsResultHasNext","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsresulthasnext"},{"title":"XblAchievementsUpdateAchievementAsync","description":"XblAchievementsUpdateAchievementAsync","sidebarTitle":"XblAchievementsUpdateAchievementAsync","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsupdateachievementasync"},{"title":"XblAchievementsUpdateAchievementForTitleIdAsync","description":"XblAchievementsUpdateAchievementForTitleIdAsync","sidebarTitle":"XblAchievementsUpdateAchievementForTitleIdAsync","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementsupdateachievementfortitleidasync"},{"title":"XblAchievementUnlockAddNotificationHandler","description":"XblAchievementUnlockAddNotificationHandler","sidebarTitle":"XblAchievementUnlockAddNotificationHandler","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementunlockaddnotificationhandler"},{"title":"XblAchievementUnlockHandler","description":"XblAchievementUnlockHandler","sidebarTitle":"XblAchievementUnlockHandler","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementunlockhandler"},{"title":"XblAchievementUnlockRemoveNotificationHandler","description":"XblAchievementUnlockRemoveNotificationHandler","sidebarTitle":"XblAchievementUnlockRemoveNotificationHandler","href":"/reference/live/xsapi-c/achievements_c/functions/xblachievementunlockremovenotificationhandler"}]},{"group":"Structs","pages":[{"title":"XblAchievement","description":"XblAchievement","sidebarTitle":"XblAchievement","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievement"},{"title":"XblAchievementMediaAsset","description":"XblAchievementMediaAsset","sidebarTitle":"XblAchievementMediaAsset","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievementmediaasset"},{"title":"XblAchievementProgressChangeEntry","description":"XblAchievementProgressChangeEntry","sidebarTitle":"XblAchievementProgressChangeEntry","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievementprogresschangeentry"},{"title":"XblAchievementProgressChangeEventArgs","description":"XblAchievementProgressChangeEventArgs","sidebarTitle":"XblAchievementProgressChangeEventArgs","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievementprogresschangeeventargs"},{"title":"XblAchievementProgression","description":"XblAchievementProgression","sidebarTitle":"XblAchievementProgression","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievementprogression"},{"title":"XblAchievementRequirement","description":"XblAchievementRequirement","sidebarTitle":"XblAchievementRequirement","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievementrequirement"},{"title":"XblAchievementReward","description":"XblAchievementReward","sidebarTitle":"XblAchievementReward","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievementreward"},{"title":"XblAchievementTimeWindow","description":"XblAchievementTimeWindow","sidebarTitle":"XblAchievementTimeWindow","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievementtimewindow"},{"title":"XblAchievementTitleAssociation","description":"XblAchievementTitleAssociation","sidebarTitle":"XblAchievementTitleAssociation","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievementtitleassociation"},{"title":"XblAchievementUnlockEvent","description":"XblAchievementUnlockEvent","sidebarTitle":"XblAchievementUnlockEvent","href":"/reference/live/xsapi-c/achievements_c/structs/xblachievementunlockevent"}]}]},{"group":"achievements_manager_c","pages":[{"group":"Enums","pages":[{"title":"XblAchievementsManagerEventType","description":"XblAchievementsManagerEventType","sidebarTitle":"XblAchievementsManagerEventType","href":"/reference/live/xsapi-c/achievements_manager_c/enums/xblachievementsmanagereventtype"},{"title":"XblAchievementsManagerSortOrder","description":"XblAchievementsManagerSortOrder","sidebarTitle":"XblAchievementsManagerSortOrder","href":"/reference/live/xsapi-c/achievements_manager_c/enums/xblachievementsmanagersortorder"}]},{"group":"Functions","pages":[{"title":"XblAchievementsManagerAddLocalUser","description":"XblAchievementsManagerAddLocalUser","sidebarTitle":"XblAchievementsManagerAddLocalUser","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanageraddlocaluser"},{"title":"XblAchievementsManagerDoWork","description":"XblAchievementsManagerDoWork","sidebarTitle":"XblAchievementsManagerDoWork","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagerdowork"},{"title":"XblAchievementsManagerGetAchievement","description":"XblAchievementsManagerGetAchievement","sidebarTitle":"XblAchievementsManagerGetAchievement","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagergetachievement"},{"title":"XblAchievementsManagerGetAchievements","description":"XblAchievementsManagerGetAchievements","sidebarTitle":"XblAchievementsManagerGetAchievements","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagergetachievements"},{"title":"XblAchievementsManagerGetAchievementsByState","description":"XblAchievementsManagerGetAchievementsByState","sidebarTitle":"XblAchievementsManagerGetAchievementsByState","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagergetachievementsbystate"},{"title":"XblAchievementsManagerIsUserInitialized","description":"XblAchievementsManagerIsUserInitialized","sidebarTitle":"XblAchievementsManagerIsUserInitialized","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagerisuserinitialized"},{"title":"XblAchievementsManagerRemoveLocalUser","description":"XblAchievementsManagerRemoveLocalUser","sidebarTitle":"XblAchievementsManagerRemoveLocalUser","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagerremovelocaluser"},{"title":"XblAchievementsManagerResultCloseHandle","description":"XblAchievementsManagerResultCloseHandle","sidebarTitle":"XblAchievementsManagerResultCloseHandle","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagerresultclosehandle"},{"title":"XblAchievementsManagerResultDuplicateHandle","description":"XblAchievementsManagerResultDuplicateHandle","sidebarTitle":"XblAchievementsManagerResultDuplicateHandle","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagerresultduplicatehandle"},{"title":"XblAchievementsManagerResultGetAchievements","description":"XblAchievementsManagerResultGetAchievements","sidebarTitle":"XblAchievementsManagerResultGetAchievements","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagerresultgetachievements"},{"title":"XblAchievementsManagerUpdateAchievement","description":"XblAchievementsManagerUpdateAchievement","sidebarTitle":"XblAchievementsManagerUpdateAchievement","href":"/reference/live/xsapi-c/achievements_manager_c/functions/xblachievementsmanagerupdateachievement"}]},{"group":"Structs","pages":[{"title":"XblAchievementsManagerEvent","description":"XblAchievementsManagerEvent","sidebarTitle":"XblAchievementsManagerEvent","href":"/reference/live/xsapi-c/achievements_manager_c/structs/xblachievementsmanagerevent"}]}]},{"group":"errors_c","pages":[{"group":"Enums","pages":[{"title":"XblErrorCondition","description":"XblErrorCondition","sidebarTitle":"XblErrorCondition","href":"/reference/live/xsapi-c/errors_c/enums/xblerrorcondition"}]},{"group":"Functions","pages":[{"title":"XblGetErrorCondition","description":"XblGetErrorCondition","sidebarTitle":"XblGetErrorCondition","href":"/reference/live/xsapi-c/errors_c/functions/xblgeterrorcondition"}]}]},{"group":"events_c","pages":[{"group":"Functions","pages":[{"title":"XblEventsSetMaxFileSize","description":"XblEventsSetMaxFileSize","sidebarTitle":"XblEventsSetMaxFileSize","href":"/reference/live/xsapi-c/events_c/functions/xbleventssetmaxfilesize"},{"title":"XblEventsSetStorageAllotment","description":"XblEventsSetStorageAllotment","sidebarTitle":"XblEventsSetStorageAllotment","href":"/reference/live/xsapi-c/events_c/functions/xbleventssetstorageallotment"},{"title":"XblEventsWriteInGameEvent","description":"XblEventsWriteInGameEvent","sidebarTitle":"XblEventsWriteInGameEvent","href":"/reference/live/xsapi-c/events_c/functions/xbleventswriteingameevent"}]}]},{"group":"http_call_c","pages":[{"group":"Enums","pages":[{"title":"XblHttpCallResponseBodyType","description":"XblHttpCallResponseBodyType","sidebarTitle":"XblHttpCallResponseBodyType","href":"/reference/live/xsapi-c/http_call_c/enums/xblhttpcallresponsebodytype"}]},{"group":"Functions","pages":[{"title":"XblHttpCallCloseHandle","description":"XblHttpCallCloseHandle","sidebarTitle":"XblHttpCallCloseHandle","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallclosehandle"},{"title":"XblHttpCallCreate","description":"XblHttpCallCreate","sidebarTitle":"XblHttpCallCreate","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallcreate"},{"title":"XblHttpCallDuplicateHandle","description":"XblHttpCallDuplicateHandle","sidebarTitle":"XblHttpCallDuplicateHandle","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallduplicatehandle"},{"title":"XblHttpCallGetHeader","description":"XblHttpCallGetHeader","sidebarTitle":"XblHttpCallGetHeader","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetheader"},{"title":"XblHttpCallGetHeaderAtIndex","description":"XblHttpCallGetHeaderAtIndex","sidebarTitle":"XblHttpCallGetHeaderAtIndex","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetheaderatindex"},{"title":"XblHttpCallGetNetworkErrorCode","description":"XblHttpCallGetNetworkErrorCode","sidebarTitle":"XblHttpCallGetNetworkErrorCode","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetnetworkerrorcode"},{"title":"XblHttpCallGetNumHeaders","description":"XblHttpCallGetNumHeaders","sidebarTitle":"XblHttpCallGetNumHeaders","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetnumheaders"},{"title":"XblHttpCallGetPlatformNetworkErrorMessage","description":"XblHttpCallGetPlatformNetworkErrorMessage","sidebarTitle":"XblHttpCallGetPlatformNetworkErrorMessage","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetplatformnetworkerrormessage"},{"title":"XblHttpCallGetRequestUrl","description":"XblHttpCallGetRequestUrl","sidebarTitle":"XblHttpCallGetRequestUrl","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetrequesturl"},{"title":"XblHttpCallGetResponseBodyBytes","description":"XblHttpCallGetResponseBodyBytes","sidebarTitle":"XblHttpCallGetResponseBodyBytes","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetresponsebodybytes"},{"title":"XblHttpCallGetResponseBodyBytesSize","description":"XblHttpCallGetResponseBodyBytesSize","sidebarTitle":"XblHttpCallGetResponseBodyBytesSize","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetresponsebodybytessize"},{"title":"XblHttpCallGetResponseString","description":"XblHttpCallGetResponseString","sidebarTitle":"XblHttpCallGetResponseString","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetresponsestring"},{"title":"XblHttpCallGetStatusCode","description":"XblHttpCallGetStatusCode","sidebarTitle":"XblHttpCallGetStatusCode","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallgetstatuscode"},{"title":"XblHttpCallPerformAsync","description":"XblHttpCallPerformAsync","sidebarTitle":"XblHttpCallPerformAsync","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallperformasync"},{"title":"XblHttpCallRequestSetHeader","description":"XblHttpCallRequestSetHeader","sidebarTitle":"XblHttpCallRequestSetHeader","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallrequestsetheader"},{"title":"XblHttpCallRequestSetLongHttpCall","description":"XblHttpCallRequestSetLongHttpCall","sidebarTitle":"XblHttpCallRequestSetLongHttpCall","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallrequestsetlonghttpcall"},{"title":"XblHttpCallRequestSetRequestBodyBytes","description":"XblHttpCallRequestSetRequestBodyBytes","sidebarTitle":"XblHttpCallRequestSetRequestBodyBytes","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallrequestsetrequestbodybytes"},{"title":"XblHttpCallRequestSetRequestBodyString","description":"XblHttpCallRequestSetRequestBodyString","sidebarTitle":"XblHttpCallRequestSetRequestBodyString","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallrequestsetrequestbodystring"},{"title":"XblHttpCallRequestSetRetryAllowed","description":"XblHttpCallRequestSetRetryAllowed","sidebarTitle":"XblHttpCallRequestSetRetryAllowed","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallrequestsetretryallowed"},{"title":"XblHttpCallRequestSetRetryCacheId","description":"XblHttpCallRequestSetRetryCacheId","sidebarTitle":"XblHttpCallRequestSetRetryCacheId","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallrequestsetretrycacheid"},{"title":"XblHttpCallSetTracing","description":"XblHttpCallSetTracing","sidebarTitle":"XblHttpCallSetTracing","href":"/reference/live/xsapi-c/http_call_c/functions/xblhttpcallsettracing"}]}]},{"group":"leaderboard_c","pages":[{"group":"Enums","pages":[{"title":"XblLeaderboardQueryType","description":"XblLeaderboardQueryType","sidebarTitle":"XblLeaderboardQueryType","href":"/reference/live/xsapi-c/leaderboard_c/enums/xblleaderboardquerytype"},{"title":"XblLeaderboardSortOrder","description":"XblLeaderboardSortOrder","sidebarTitle":"XblLeaderboardSortOrder","href":"/reference/live/xsapi-c/leaderboard_c/enums/xblleaderboardsortorder"},{"title":"XblLeaderboardStatType","description":"XblLeaderboardStatType","sidebarTitle":"XblLeaderboardStatType","href":"/reference/live/xsapi-c/leaderboard_c/enums/xblleaderboardstattype"},{"title":"XblSocialGroupType","description":"XblSocialGroupType","sidebarTitle":"XblSocialGroupType","href":"/reference/live/xsapi-c/leaderboard_c/enums/xblsocialgrouptype"}]},{"group":"Functions","pages":[{"title":"XblLeaderboardGetLeaderboardAsync","description":"XblLeaderboardGetLeaderboardAsync","sidebarTitle":"XblLeaderboardGetLeaderboardAsync","href":"/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardgetleaderboardasync"},{"title":"XblLeaderboardGetLeaderboardResult","description":"XblLeaderboardGetLeaderboardResult","sidebarTitle":"XblLeaderboardGetLeaderboardResult","href":"/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardgetleaderboardresult"},{"title":"XblLeaderboardGetLeaderboardResultSize","description":"XblLeaderboardGetLeaderboardResultSize","sidebarTitle":"XblLeaderboardGetLeaderboardResultSize","href":"/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardgetleaderboardresultsize"},{"title":"XblLeaderboardResultGetNextAsync","description":"XblLeaderboardResultGetNextAsync","sidebarTitle":"XblLeaderboardResultGetNextAsync","href":"/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardresultgetnextasync"},{"title":"XblLeaderboardResultGetNextResult","description":"XblLeaderboardResultGetNextResult","sidebarTitle":"XblLeaderboardResultGetNextResult","href":"/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardresultgetnextresult"},{"title":"XblLeaderboardResultGetNextResultSize","description":"XblLeaderboardResultGetNextResultSize","sidebarTitle":"XblLeaderboardResultGetNextResultSize","href":"/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardresultgetnextresultsize"}]},{"group":"Structs","pages":[{"title":"XblLeaderboardColumn","description":"XblLeaderboardColumn","sidebarTitle":"XblLeaderboardColumn","href":"/reference/live/xsapi-c/leaderboard_c/structs/xblleaderboardcolumn"},{"title":"XblLeaderboardQuery","description":"XblLeaderboardQuery","sidebarTitle":"XblLeaderboardQuery","href":"/reference/live/xsapi-c/leaderboard_c/structs/xblleaderboardquery"},{"title":"XblLeaderboardResult","description":"XblLeaderboardResult","sidebarTitle":"XblLeaderboardResult","href":"/reference/live/xsapi-c/leaderboard_c/structs/xblleaderboardresult"},{"title":"XblLeaderboardRow","description":"XblLeaderboardRow","sidebarTitle":"XblLeaderboardRow","href":"/reference/live/xsapi-c/leaderboard_c/structs/xblleaderboardrow"}]}]},{"group":"matchmaking_c","pages":[{"group":"Enums","pages":[{"title":"XblPreserveSessionMode","description":"XblPreserveSessionMode","sidebarTitle":"XblPreserveSessionMode","href":"/reference/live/xsapi-c/matchmaking_c/enums/xblpreservesessionmode"},{"title":"XblTicketStatus","description":"XblTicketStatus","sidebarTitle":"XblTicketStatus","href":"/reference/live/xsapi-c/matchmaking_c/enums/xblticketstatus"}]},{"group":"Functions","pages":[{"title":"XblMatchmakingCreateMatchTicketAsync","description":"XblMatchmakingCreateMatchTicketAsync","sidebarTitle":"XblMatchmakingCreateMatchTicketAsync","href":"/reference/live/xsapi-c/matchmaking_c/functions/xblmatchmakingcreatematchticketasync"},{"title":"XblMatchmakingCreateMatchTicketResult","description":"XblMatchmakingCreateMatchTicketResult","sidebarTitle":"XblMatchmakingCreateMatchTicketResult","href":"/reference/live/xsapi-c/matchmaking_c/functions/xblmatchmakingcreatematchticketresult"},{"title":"XblMatchmakingDeleteMatchTicketAsync","description":"XblMatchmakingDeleteMatchTicketAsync","sidebarTitle":"XblMatchmakingDeleteMatchTicketAsync","href":"/reference/live/xsapi-c/matchmaking_c/functions/xblmatchmakingdeletematchticketasync"},{"title":"XblMatchmakingGetHopperStatisticsAsync","description":"XblMatchmakingGetHopperStatisticsAsync","sidebarTitle":"XblMatchmakingGetHopperStatisticsAsync","href":"/reference/live/xsapi-c/matchmaking_c/functions/xblmatchmakinggethopperstatisticsasync"},{"title":"XblMatchmakingGetHopperStatisticsResult","description":"XblMatchmakingGetHopperStatisticsResult","sidebarTitle":"XblMatchmakingGetHopperStatisticsResult","href":"/reference/live/xsapi-c/matchmaking_c/functions/xblmatchmakinggethopperstatisticsresult"},{"title":"XblMatchmakingGetHopperStatisticsResultSize","description":"XblMatchmakingGetHopperStatisticsResultSize","sidebarTitle":"XblMatchmakingGetHopperStatisticsResultSize","href":"/reference/live/xsapi-c/matchmaking_c/functions/xblmatchmakinggethopperstatisticsresultsize"},{"title":"XblMatchmakingGetMatchTicketDetailsAsync","description":"XblMatchmakingGetMatchTicketDetailsAsync","sidebarTitle":"XblMatchmakingGetMatchTicketDetailsAsync","href":"/reference/live/xsapi-c/matchmaking_c/functions/xblmatchmakinggetmatchticketdetailsasync"},{"title":"XblMatchmakingGetMatchTicketDetailsResult","description":"XblMatchmakingGetMatchTicketDetailsResult","sidebarTitle":"XblMatchmakingGetMatchTicketDetailsResult","href":"/reference/live/xsapi-c/matchmaking_c/functions/xblmatchmakinggetmatchticketdetailsresult"},{"title":"XblMatchmakingGetMatchTicketDetailsResultSize","description":"XblMatchmakingGetMatchTicketDetailsResultSize","sidebarTitle":"XblMatchmakingGetMatchTicketDetailsResultSize","href":"/reference/live/xsapi-c/matchmaking_c/functions/xblmatchmakinggetmatchticketdetailsresultsize"}]},{"group":"Structs","pages":[{"title":"XblCreateMatchTicketResponse","description":"XblCreateMatchTicketResponse","sidebarTitle":"XblCreateMatchTicketResponse","href":"/reference/live/xsapi-c/matchmaking_c/structs/xblcreatematchticketresponse"},{"title":"XblHopperStatisticsResponse","description":"XblHopperStatisticsResponse","sidebarTitle":"XblHopperStatisticsResponse","href":"/reference/live/xsapi-c/matchmaking_c/structs/xblhopperstatisticsresponse"},{"title":"XblMatchTicketDetailsResponse","description":"XblMatchTicketDetailsResponse","sidebarTitle":"XblMatchTicketDetailsResponse","href":"/reference/live/xsapi-c/matchmaking_c/structs/xblmatchticketdetailsresponse"}]}]},{"group":"multiplayer_activity_c","pages":[{"group":"Enums","pages":[{"title":"XblMultiplayerActivityEncounterType","description":"XblMultiplayerActivityEncounterType","sidebarTitle":"XblMultiplayerActivityEncounterType","href":"/reference/live/xsapi-c/multiplayer_activity_c/enums/xblmultiplayeractivityencountertype"},{"title":"XblMultiplayerActivityJoinRestriction","description":"XblMultiplayerActivityJoinRestriction","sidebarTitle":"XblMultiplayerActivityJoinRestriction","href":"/reference/live/xsapi-c/multiplayer_activity_c/enums/xblmultiplayeractivityjoinrestriction"},{"title":"XblMultiplayerActivityPlatform","description":"XblMultiplayerActivityPlatform","sidebarTitle":"XblMultiplayerActivityPlatform","href":"/reference/live/xsapi-c/multiplayer_activity_c/enums/xblmultiplayeractivityplatform"}]},{"group":"Functions","pages":[{"title":"XblMultiplayerActivityAddInviteHandler","description":"XblMultiplayerActivityAddInviteHandler","sidebarTitle":"XblMultiplayerActivityAddInviteHandler","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivityaddinvitehandler"},{"title":"XblMultiplayerActivityDeleteActivityAsync","description":"XblMultiplayerActivityDeleteActivityAsync","sidebarTitle":"XblMultiplayerActivityDeleteActivityAsync","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivitydeleteactivityasync"},{"title":"XblMultiplayerActivityFlushRecentPlayersAsync","description":"XblMultiplayerActivityFlushRecentPlayersAsync","sidebarTitle":"XblMultiplayerActivityFlushRecentPlayersAsync","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivityflushrecentplayersasync"},{"title":"XblMultiplayerActivityGetActivityAsync","description":"XblMultiplayerActivityGetActivityAsync","sidebarTitle":"XblMultiplayerActivityGetActivityAsync","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivitygetactivityasync"},{"title":"XblMultiplayerActivityGetActivityResult","description":"XblMultiplayerActivityGetActivityResult","sidebarTitle":"XblMultiplayerActivityGetActivityResult","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivitygetactivityresult"},{"title":"XblMultiplayerActivityGetActivityResultSize","description":"XblMultiplayerActivityGetActivityResultSize","sidebarTitle":"XblMultiplayerActivityGetActivityResultSize","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivitygetactivityresultsize"},{"title":"XblMultiplayerActivityInviteHandler","description":"XblMultiplayerActivityInviteHandler","sidebarTitle":"XblMultiplayerActivityInviteHandler","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivityinvitehandler"},{"title":"XblMultiplayerActivityRemoveInviteHandler","description":"XblMultiplayerActivityRemoveInviteHandler","sidebarTitle":"XblMultiplayerActivityRemoveInviteHandler","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivityremoveinvitehandler"},{"title":"XblMultiplayerActivitySendInvitesAsync","description":"XblMultiplayerActivitySendInvitesAsync","sidebarTitle":"XblMultiplayerActivitySendInvitesAsync","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivitysendinvitesasync"},{"title":"XblMultiplayerActivitySetActivityAsync","description":"XblMultiplayerActivitySetActivityAsync","sidebarTitle":"XblMultiplayerActivitySetActivityAsync","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivitysetactivityasync"},{"title":"XblMultiplayerActivityUpdateRecentPlayers","description":"XblMultiplayerActivityUpdateRecentPlayers","sidebarTitle":"XblMultiplayerActivityUpdateRecentPlayers","href":"/reference/live/xsapi-c/multiplayer_activity_c/functions/xblmultiplayeractivityupdaterecentplayers"}]},{"group":"Structs","pages":[{"title":"XblMultiplayerActivityInfo","description":"XblMultiplayerActivityInfo","sidebarTitle":"XblMultiplayerActivityInfo","href":"/reference/live/xsapi-c/multiplayer_activity_c/structs/xblmultiplayeractivityinfo"},{"title":"XblMultiplayerActivityInviteData","description":"XblMultiplayerActivityInviteData","sidebarTitle":"XblMultiplayerActivityInviteData","href":"/reference/live/xsapi-c/multiplayer_activity_c/structs/xblmultiplayeractivityinvitedata"},{"title":"XblMultiplayerActivityRecentPlayerUpdate","description":"XblMultiplayerActivityRecentPlayerUpdate","sidebarTitle":"XblMultiplayerActivityRecentPlayerUpdate","href":"/reference/live/xsapi-c/multiplayer_activity_c/structs/xblmultiplayeractivityrecentplayerupdate"}]}]},{"group":"multiplayer_c","pages":[{"group":"Enums","pages":[{"title":"XblMatchmakingStatus","description":"XblMatchmakingStatus","sidebarTitle":"XblMatchmakingStatus","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmatchmakingstatus"},{"title":"XblMultiplayerInitializationStage","description":"XblMultiplayerInitializationStage","sidebarTitle":"XblMultiplayerInitializationStage","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayerinitializationstage"},{"title":"XblMultiplayerMeasurementFailure","description":"XblMultiplayerMeasurementFailure","sidebarTitle":"XblMultiplayerMeasurementFailure","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayermeasurementfailure"},{"title":"XblMultiplayerMetrics","description":"XblMultiplayerMetrics","sidebarTitle":"XblMultiplayerMetrics","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayermetrics"},{"title":"XblMultiplayerSessionChangeTypes","description":"XblMultiplayerSessionChangeTypes","sidebarTitle":"XblMultiplayerSessionChangeTypes","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayersessionchangetypes"},{"title":"XblMultiplayerSessionMemberStatus","description":"XblMultiplayerSessionMemberStatus","sidebarTitle":"XblMultiplayerSessionMemberStatus","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayersessionmemberstatus"},{"title":"XblMultiplayerSessionRestriction","description":"XblMultiplayerSessionRestriction","sidebarTitle":"XblMultiplayerSessionRestriction","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayersessionrestriction"},{"title":"XblMultiplayerSessionStatus","description":"XblMultiplayerSessionStatus","sidebarTitle":"XblMultiplayerSessionStatus","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayersessionstatus"},{"title":"XblMultiplayerSessionVisibility","description":"XblMultiplayerSessionVisibility","sidebarTitle":"XblMultiplayerSessionVisibility","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayersessionvisibility"},{"title":"XblMultiplayerSessionWriteMode","description":"XblMultiplayerSessionWriteMode","sidebarTitle":"XblMultiplayerSessionWriteMode","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayersessionwritemode"},{"title":"XblMutableRoleSettings","description":"XblMutableRoleSettings","sidebarTitle":"XblMutableRoleSettings","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblmutablerolesettings"},{"title":"XblNetworkAddressTranslationSetting","description":"XblNetworkAddressTranslationSetting","sidebarTitle":"XblNetworkAddressTranslationSetting","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblnetworkaddresstranslationsetting"},{"title":"XblTournamentArbitrationState","description":"XblTournamentArbitrationState","sidebarTitle":"XblTournamentArbitrationState","href":"/reference/live/xsapi-c/multiplayer_c/enums/xbltournamentarbitrationstate"},{"title":"XblTournamentArbitrationStatus","description":"XblTournamentArbitrationStatus","sidebarTitle":"XblTournamentArbitrationStatus","href":"/reference/live/xsapi-c/multiplayer_c/enums/xbltournamentarbitrationstatus"},{"title":"XblTournamentGameResult","description":"XblTournamentGameResult","sidebarTitle":"XblTournamentGameResult","href":"/reference/live/xsapi-c/multiplayer_c/enums/xbltournamentgameresult"},{"title":"XblTournamentGameResultSource","description":"XblTournamentGameResultSource","sidebarTitle":"XblTournamentGameResultSource","href":"/reference/live/xsapi-c/multiplayer_c/enums/xbltournamentgameresultsource"},{"title":"XblTournamentRegistrationReason","description":"XblTournamentRegistrationReason","sidebarTitle":"XblTournamentRegistrationReason","href":"/reference/live/xsapi-c/multiplayer_c/enums/xbltournamentregistrationreason"},{"title":"XblTournamentRegistrationState","description":"XblTournamentRegistrationState","sidebarTitle":"XblTournamentRegistrationState","href":"/reference/live/xsapi-c/multiplayer_c/enums/xbltournamentregistrationstate"},{"title":"XblWriteSessionStatus","description":"XblWriteSessionStatus","sidebarTitle":"XblWriteSessionStatus","href":"/reference/live/xsapi-c/multiplayer_c/enums/xblwritesessionstatus"}]},{"group":"Functions","pages":[{"title":"XblFormatSecureDeviceAddress","description":"XblFormatSecureDeviceAddress","sidebarTitle":"XblFormatSecureDeviceAddress","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblformatsecuredeviceaddress"},{"title":"XblMultiplayerAddConnectionIdChangedHandler","description":"XblMultiplayerAddConnectionIdChangedHandler","sidebarTitle":"XblMultiplayerAddConnectionIdChangedHandler","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayeraddconnectionidchangedhandler"},{"title":"XblMultiplayerAddSessionChangedHandler","description":"XblMultiplayerAddSessionChangedHandler","sidebarTitle":"XblMultiplayerAddSessionChangedHandler","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayeraddsessionchangedhandler"},{"title":"XblMultiplayerAddSubscriptionLostHandler","description":"XblMultiplayerAddSubscriptionLostHandler","sidebarTitle":"XblMultiplayerAddSubscriptionLostHandler","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayeraddsubscriptionlosthandler"},{"title":"XblMultiplayerClearActivityAsync","description":"XblMultiplayerClearActivityAsync","sidebarTitle":"XblMultiplayerClearActivityAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerclearactivityasync"},{"title":"XblMultiplayerConnectionIdChangedHandler","description":"XblMultiplayerConnectionIdChangedHandler","sidebarTitle":"XblMultiplayerConnectionIdChangedHandler","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerconnectionidchangedhandler"},{"title":"XblMultiplayerCreateSearchHandleAsync","description":"XblMultiplayerCreateSearchHandleAsync","sidebarTitle":"XblMultiplayerCreateSearchHandleAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayercreatesearchhandleasync"},{"title":"XblMultiplayerCreateSearchHandleResult","description":"XblMultiplayerCreateSearchHandleResult","sidebarTitle":"XblMultiplayerCreateSearchHandleResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayercreatesearchhandleresult"},{"title":"XblMultiplayerDeleteSearchHandleAsync","description":"XblMultiplayerDeleteSearchHandleAsync","sidebarTitle":"XblMultiplayerDeleteSearchHandleAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerdeletesearchhandleasync"},{"title":"XblMultiplayerGetActivitiesForSocialGroupAsync","description":"XblMultiplayerGetActivitiesForSocialGroupAsync","sidebarTitle":"XblMultiplayerGetActivitiesForSocialGroupAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitiesforsocialgroupasync"},{"title":"XblMultiplayerGetActivitiesForSocialGroupResult","description":"XblMultiplayerGetActivitiesForSocialGroupResult","sidebarTitle":"XblMultiplayerGetActivitiesForSocialGroupResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitiesforsocialgroupresult"},{"title":"XblMultiplayerGetActivitiesForSocialGroupResultCount","description":"XblMultiplayerGetActivitiesForSocialGroupResultCount","sidebarTitle":"XblMultiplayerGetActivitiesForSocialGroupResultCount","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitiesforsocialgroupresultcount"},{"title":"XblMultiplayerGetActivitiesForUsersAsync","description":"XblMultiplayerGetActivitiesForUsersAsync","sidebarTitle":"XblMultiplayerGetActivitiesForUsersAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitiesforusersasync"},{"title":"XblMultiplayerGetActivitiesForUsersResult","description":"XblMultiplayerGetActivitiesForUsersResult","sidebarTitle":"XblMultiplayerGetActivitiesForUsersResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitiesforusersresult"},{"title":"XblMultiplayerGetActivitiesForUsersResultCount","description":"XblMultiplayerGetActivitiesForUsersResultCount","sidebarTitle":"XblMultiplayerGetActivitiesForUsersResultCount","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitiesforusersresultcount"},{"title":"XblMultiplayerGetActivitiesWithPropertiesForSocialGroupAsync","description":"XblMultiplayerGetActivitiesWithPropertiesForSocialGroupAsync","sidebarTitle":"XblMultiplayerGetActivitiesWithPropertiesForSocialGroupAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitieswithpropertiesforsocialgroupasync"},{"title":"XblMultiplayerGetActivitiesWithPropertiesForSocialGroupResult","description":"XblMultiplayerGetActivitiesWithPropertiesForSocialGroupResult","sidebarTitle":"XblMultiplayerGetActivitiesWithPropertiesForSocialGroupResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitieswithpropertiesforsocialgroupresult"},{"title":"XblMultiplayerGetActivitiesWithPropertiesForSocialGroupResultSize","description":"XblMultiplayerGetActivitiesWithPropertiesForSocialGroupResultSize","sidebarTitle":"XblMultiplayerGetActivitiesWithPropertiesForSocialGroupResultSize","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitieswithpropertiesforsocialgroupresultsize"},{"title":"XblMultiplayerGetActivitiesWithPropertiesForUsersAsync","description":"XblMultiplayerGetActivitiesWithPropertiesForUsersAsync","sidebarTitle":"XblMultiplayerGetActivitiesWithPropertiesForUsersAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitieswithpropertiesforusersasync"},{"title":"XblMultiplayerGetActivitiesWithPropertiesForUsersResult","description":"XblMultiplayerGetActivitiesWithPropertiesForUsersResult","sidebarTitle":"XblMultiplayerGetActivitiesWithPropertiesForUsersResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitieswithpropertiesforusersresult"},{"title":"XblMultiplayerGetActivitiesWithPropertiesForUsersResultSize","description":"XblMultiplayerGetActivitiesWithPropertiesForUsersResultSize","sidebarTitle":"XblMultiplayerGetActivitiesWithPropertiesForUsersResultSize","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetactivitieswithpropertiesforusersresultsize"},{"title":"XblMultiplayerGetSearchHandlesAsync","description":"XblMultiplayerGetSearchHandlesAsync","sidebarTitle":"XblMultiplayerGetSearchHandlesAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsearchhandlesasync"},{"title":"XblMultiplayerGetSearchHandlesResult","description":"XblMultiplayerGetSearchHandlesResult","sidebarTitle":"XblMultiplayerGetSearchHandlesResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsearchhandlesresult"},{"title":"XblMultiplayerGetSearchHandlesResultCount","description":"XblMultiplayerGetSearchHandlesResultCount","sidebarTitle":"XblMultiplayerGetSearchHandlesResultCount","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsearchhandlesresultcount"},{"title":"XblMultiplayerGetSessionAsync","description":"XblMultiplayerGetSessionAsync","sidebarTitle":"XblMultiplayerGetSessionAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsessionasync"},{"title":"XblMultiplayerGetSessionByHandleAsync","description":"XblMultiplayerGetSessionByHandleAsync","sidebarTitle":"XblMultiplayerGetSessionByHandleAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsessionbyhandleasync"},{"title":"XblMultiplayerGetSessionByHandleResult","description":"XblMultiplayerGetSessionByHandleResult","sidebarTitle":"XblMultiplayerGetSessionByHandleResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsessionbyhandleresult"},{"title":"XblMultiplayerGetSessionResult","description":"XblMultiplayerGetSessionResult","sidebarTitle":"XblMultiplayerGetSessionResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsessionresult"},{"title":"XblMultiplayerQuerySessionsAsync","description":"XblMultiplayerQuerySessionsAsync","sidebarTitle":"XblMultiplayerQuerySessionsAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerquerysessionsasync"},{"title":"XblMultiplayerQuerySessionsResult","description":"XblMultiplayerQuerySessionsResult","sidebarTitle":"XblMultiplayerQuerySessionsResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerquerysessionsresult"},{"title":"XblMultiplayerQuerySessionsResultCount","description":"XblMultiplayerQuerySessionsResultCount","sidebarTitle":"XblMultiplayerQuerySessionsResultCount","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerquerysessionsresultcount"},{"title":"XblMultiplayerRemoveConnectionIdChangedHandler","description":"XblMultiplayerRemoveConnectionIdChangedHandler","sidebarTitle":"XblMultiplayerRemoveConnectionIdChangedHandler","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerremoveconnectionidchangedhandler"},{"title":"XblMultiplayerRemoveSessionChangedHandler","description":"XblMultiplayerRemoveSessionChangedHandler","sidebarTitle":"XblMultiplayerRemoveSessionChangedHandler","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerremovesessionchangedhandler"},{"title":"XblMultiplayerRemoveSubscriptionLostHandler","description":"XblMultiplayerRemoveSubscriptionLostHandler","sidebarTitle":"XblMultiplayerRemoveSubscriptionLostHandler","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerremovesubscriptionlosthandler"},{"title":"XblMultiplayerSearchHandleCloseHandle","description":"XblMultiplayerSearchHandleCloseHandle","sidebarTitle":"XblMultiplayerSearchHandleCloseHandle","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandleclosehandle"},{"title":"XblMultiplayerSearchHandleDuplicateHandle","description":"XblMultiplayerSearchHandleDuplicateHandle","sidebarTitle":"XblMultiplayerSearchHandleDuplicateHandle","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandleduplicatehandle"},{"title":"XblMultiplayerSearchHandleGetCreationTime","description":"XblMultiplayerSearchHandleGetCreationTime","sidebarTitle":"XblMultiplayerSearchHandleGetCreationTime","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetcreationtime"},{"title":"XblMultiplayerSearchHandleGetCustomSessionPropertiesJson","description":"XblMultiplayerSearchHandleGetCustomSessionPropertiesJson","sidebarTitle":"XblMultiplayerSearchHandleGetCustomSessionPropertiesJson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetcustomsessionpropertiesjson"},{"title":"XblMultiplayerSearchHandleGetId","description":"XblMultiplayerSearchHandleGetId","sidebarTitle":"XblMultiplayerSearchHandleGetId","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetid"},{"title":"XblMultiplayerSearchHandleGetJoinRestriction","description":"XblMultiplayerSearchHandleGetJoinRestriction","sidebarTitle":"XblMultiplayerSearchHandleGetJoinRestriction","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetjoinrestriction"},{"title":"XblMultiplayerSearchHandleGetMemberCounts","description":"XblMultiplayerSearchHandleGetMemberCounts","sidebarTitle":"XblMultiplayerSearchHandleGetMemberCounts","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetmembercounts"},{"title":"XblMultiplayerSearchHandleGetNumberAttributes","description":"XblMultiplayerSearchHandleGetNumberAttributes","sidebarTitle":"XblMultiplayerSearchHandleGetNumberAttributes","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetnumberattributes"},{"title":"XblMultiplayerSearchHandleGetSessionClosed","description":"XblMultiplayerSearchHandleGetSessionClosed","sidebarTitle":"XblMultiplayerSearchHandleGetSessionClosed","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetsessionclosed"},{"title":"XblMultiplayerSearchHandleGetSessionOwnerXuids","description":"XblMultiplayerSearchHandleGetSessionOwnerXuids","sidebarTitle":"XblMultiplayerSearchHandleGetSessionOwnerXuids","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetsessionownerxuids"},{"title":"XblMultiplayerSearchHandleGetSessionReference","description":"XblMultiplayerSearchHandleGetSessionReference","sidebarTitle":"XblMultiplayerSearchHandleGetSessionReference","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetsessionreference"},{"title":"XblMultiplayerSearchHandleGetStringAttributes","description":"XblMultiplayerSearchHandleGetStringAttributes","sidebarTitle":"XblMultiplayerSearchHandleGetStringAttributes","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetstringattributes"},{"title":"XblMultiplayerSearchHandleGetTags","description":"XblMultiplayerSearchHandleGetTags","sidebarTitle":"XblMultiplayerSearchHandleGetTags","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegettags"},{"title":"XblMultiplayerSearchHandleGetVisibility","description":"XblMultiplayerSearchHandleGetVisibility","sidebarTitle":"XblMultiplayerSearchHandleGetVisibility","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersearchhandlegetvisibility"},{"title":"XblMultiplayerSendInvitesAsync","description":"XblMultiplayerSendInvitesAsync","sidebarTitle":"XblMultiplayerSendInvitesAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersendinvitesasync"},{"title":"XblMultiplayerSendInvitesResult","description":"XblMultiplayerSendInvitesResult","sidebarTitle":"XblMultiplayerSendInvitesResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersendinvitesresult"},{"title":"XblMultiplayerSessionAddMemberReservation","description":"XblMultiplayerSessionAddMemberReservation","sidebarTitle":"XblMultiplayerSessionAddMemberReservation","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionaddmemberreservation"},{"title":"XblMultiplayerSessionChangedHandler","description":"XblMultiplayerSessionChangedHandler","sidebarTitle":"XblMultiplayerSessionChangedHandler","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionchangedhandler"},{"title":"XblMultiplayerSessionCloseHandle","description":"XblMultiplayerSessionCloseHandle","sidebarTitle":"XblMultiplayerSessionCloseHandle","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionclosehandle"},{"title":"XblMultiplayerSessionCompare","description":"XblMultiplayerSessionCompare","sidebarTitle":"XblMultiplayerSessionCompare","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncompare"},{"title":"XblMultiplayerSessionConstantsSetCapabilities","description":"XblMultiplayerSessionConstantsSetCapabilities","sidebarTitle":"XblMultiplayerSessionConstantsSetCapabilities","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssetcapabilities"},{"title":"Xblmultiplayersessionconstantssetcloudcomputepackagejson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssetcloudcomputepackagejson"},{"title":"XblMultiplayerSessionConstantsSetMaxMembersInSession","description":"XblMultiplayerSessionConstantsSetMaxMembersInSession","sidebarTitle":"XblMultiplayerSessionConstantsSetMaxMembersInSession","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssetmaxmembersinsession"},{"title":"Xblmultiplayersessionconstantssetmeasurementserveraddressesjson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssetmeasurementserveraddressesjson"},{"title":"XblMultiplayerSessionConstantsSetMemberInitialization","description":"XblMultiplayerSessionConstantsSetMemberInitialization","sidebarTitle":"XblMultiplayerSessionConstantsSetMemberInitialization","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssetmemberinitialization"},{"title":"XblMultiplayerSessionConstantsSetPeerToHostRequirements","description":"XblMultiplayerSessionConstantsSetPeerToHostRequirements","sidebarTitle":"XblMultiplayerSessionConstantsSetPeerToHostRequirements","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssetpeertohostrequirements"},{"title":"XblMultiplayerSessionConstantsSetPeerToPeerRequirements","description":"XblMultiplayerSessionConstantsSetPeerToPeerRequirements","sidebarTitle":"XblMultiplayerSessionConstantsSetPeerToPeerRequirements","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssetpeertopeerrequirements"},{"title":"XblMultiplayerSessionConstantsSetQosConnectivityMetrics","description":"XblMultiplayerSessionConstantsSetQosConnectivityMetrics","sidebarTitle":"XblMultiplayerSessionConstantsSetQosConnectivityMetrics","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssetqosconnectivitymetrics"},{"title":"XblMultiplayerSessionConstantsSetTimeouts","description":"XblMultiplayerSessionConstantsSetTimeouts","sidebarTitle":"XblMultiplayerSessionConstantsSetTimeouts","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssettimeouts"},{"title":"XblMultiplayerSessionConstantsSetVisibility","description":"XblMultiplayerSessionConstantsSetVisibility","sidebarTitle":"XblMultiplayerSessionConstantsSetVisibility","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionconstantssetvisibility"},{"title":"XblMultiplayerSessionCreateHandle","description":"XblMultiplayerSessionCreateHandle","sidebarTitle":"XblMultiplayerSessionCreateHandle","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncreatehandle"},{"title":"XblMultiplayerSessionCurrentUser","description":"XblMultiplayerSessionCurrentUser","sidebarTitle":"XblMultiplayerSessionCurrentUser","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentuser"},{"title":"XblMultiplayerSessionCurrentUserDeleteCustomPropertyJson","description":"XblMultiplayerSessionCurrentUserDeleteCustomPropertyJson","sidebarTitle":"XblMultiplayerSessionCurrentUserDeleteCustomPropertyJson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentuserdeletecustompropertyjson"},{"title":"XblMultiplayerSessionCurrentUserSetCustomPropertyJson","description":"XblMultiplayerSessionCurrentUserSetCustomPropertyJson","sidebarTitle":"XblMultiplayerSessionCurrentUserSetCustomPropertyJson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetcustompropertyjson"},{"title":"XblMultiplayerSessionCurrentUserSetEncounters","description":"XblMultiplayerSessionCurrentUserSetEncounters","sidebarTitle":"XblMultiplayerSessionCurrentUserSetEncounters","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetencounters"},{"title":"XblMultiplayerSessionCurrentUserSetGroups","description":"XblMultiplayerSessionCurrentUserSetGroups","sidebarTitle":"XblMultiplayerSessionCurrentUserSetGroups","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetgroups"},{"title":"XblMultiplayerSessionCurrentUserSetMembersInGroup","description":"XblMultiplayerSessionCurrentUserSetMembersInGroup","sidebarTitle":"XblMultiplayerSessionCurrentUserSetMembersInGroup","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetmembersingroup"},{"title":"Xblmultiplayersessioncurrentusersetqosmeasurements","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetqosmeasurements"},{"title":"XblMultiplayerSessionCurrentUserSetRoles","description":"XblMultiplayerSessionCurrentUserSetRoles","sidebarTitle":"XblMultiplayerSessionCurrentUserSetRoles","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetroles"},{"title":"XblMultiplayerSessionCurrentUserSetSecureDeviceAddressBase64","description":"XblMultiplayerSessionCurrentUserSetSecureDeviceAddressBase64","sidebarTitle":"XblMultiplayerSessionCurrentUserSetSecureDeviceAddressBase64","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetsecuredeviceaddressbase64"},{"title":"Xblmultiplayersessioncurrentusersetserverqosmeasurements","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetserverqosmeasurements"},{"title":"XblMultiplayerSessionCurrentUserSetStatus","description":"XblMultiplayerSessionCurrentUserSetStatus","sidebarTitle":"XblMultiplayerSessionCurrentUserSetStatus","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetstatus"},{"title":"XblMultiplayerSessionDeleteCustomPropertyJson","description":"XblMultiplayerSessionDeleteCustomPropertyJson","sidebarTitle":"XblMultiplayerSessionDeleteCustomPropertyJson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessiondeletecustompropertyjson"},{"title":"XblMultiplayerSessionDuplicateHandle","description":"XblMultiplayerSessionDuplicateHandle","sidebarTitle":"XblMultiplayerSessionDuplicateHandle","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionduplicatehandle"},{"title":"XblMultiplayerSessionEtag","description":"XblMultiplayerSessionEtag","sidebarTitle":"XblMultiplayerSessionEtag","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionetag"},{"title":"XblMultiplayerSessionGetInfo","description":"XblMultiplayerSessionGetInfo","sidebarTitle":"XblMultiplayerSessionGetInfo","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessiongetinfo"},{"title":"XblMultiplayerSessionGetInitializationInfo","description":"XblMultiplayerSessionGetInitializationInfo","sidebarTitle":"XblMultiplayerSessionGetInitializationInfo","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessiongetinitializationinfo"},{"title":"XblMultiplayerSessionGetMember","description":"XblMultiplayerSessionGetMember","sidebarTitle":"XblMultiplayerSessionGetMember","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessiongetmember"},{"title":"XblMultiplayerSessionGetRoleByName","description":"XblMultiplayerSessionGetRoleByName","sidebarTitle":"XblMultiplayerSessionGetRoleByName","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessiongetrolebyname"},{"title":"XblMultiplayerSessionHostCandidates","description":"XblMultiplayerSessionHostCandidates","sidebarTitle":"XblMultiplayerSessionHostCandidates","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionhostcandidates"},{"title":"XblMultiplayerSessionJoin","description":"XblMultiplayerSessionJoin","sidebarTitle":"XblMultiplayerSessionJoin","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionjoin"},{"title":"XblMultiplayerSessionLeave","description":"XblMultiplayerSessionLeave","sidebarTitle":"XblMultiplayerSessionLeave","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionleave"},{"title":"XblMultiplayerSessionMatchmakingServer","description":"XblMultiplayerSessionMatchmakingServer","sidebarTitle":"XblMultiplayerSessionMatchmakingServer","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionmatchmakingserver"},{"title":"XblMultiplayerSessionMembers","description":"XblMultiplayerSessionMembers","sidebarTitle":"XblMultiplayerSessionMembers","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionmembers"},{"title":"XblMultiplayerSessionMembersAccepted","description":"XblMultiplayerSessionMembersAccepted","sidebarTitle":"XblMultiplayerSessionMembersAccepted","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionmembersaccepted"},{"title":"XblMultiplayerSessionPropertiesSetJoinRestriction","description":"XblMultiplayerSessionPropertiesSetJoinRestriction","sidebarTitle":"XblMultiplayerSessionPropertiesSetJoinRestriction","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionpropertiessetjoinrestriction"},{"title":"XblMultiplayerSessionPropertiesSetKeywords","description":"XblMultiplayerSessionPropertiesSetKeywords","sidebarTitle":"XblMultiplayerSessionPropertiesSetKeywords","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionpropertiessetkeywords"},{"title":"XblMultiplayerSessionPropertiesSetReadRestriction","description":"XblMultiplayerSessionPropertiesSetReadRestriction","sidebarTitle":"XblMultiplayerSessionPropertiesSetReadRestriction","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionpropertiessetreadrestriction"},{"title":"XblMultiplayerSessionPropertiesSetTurnCollection","description":"XblMultiplayerSessionPropertiesSetTurnCollection","sidebarTitle":"XblMultiplayerSessionPropertiesSetTurnCollection","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionpropertiessetturncollection"},{"title":"XblMultiplayerSessionRawServersJson","description":"XblMultiplayerSessionRawServersJson","sidebarTitle":"XblMultiplayerSessionRawServersJson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionrawserversjson"},{"title":"XblMultiplayerSessionReferenceCreate","description":"XblMultiplayerSessionReferenceCreate","sidebarTitle":"XblMultiplayerSessionReferenceCreate","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionreferencecreate"},{"title":"XblMultiplayerSessionReferenceIsValid","description":"XblMultiplayerSessionReferenceIsValid","sidebarTitle":"XblMultiplayerSessionReferenceIsValid","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionreferenceisvalid"},{"title":"XblMultiplayerSessionReferenceParseFromUriPath","description":"XblMultiplayerSessionReferenceParseFromUriPath","sidebarTitle":"XblMultiplayerSessionReferenceParseFromUriPath","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionreferenceparsefromuripath"},{"title":"XblMultiplayerSessionReferenceToUriPath","description":"XblMultiplayerSessionReferenceToUriPath","sidebarTitle":"XblMultiplayerSessionReferenceToUriPath","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionreferencetouripath"},{"title":"XblMultiplayerSessionRoleTypes","description":"XblMultiplayerSessionRoleTypes","sidebarTitle":"XblMultiplayerSessionRoleTypes","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionroletypes"},{"title":"XblMultiplayerSessionSessionConstants","description":"XblMultiplayerSessionSessionConstants","sidebarTitle":"XblMultiplayerSessionSessionConstants","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsessionconstants"},{"title":"XblMultiplayerSessionSessionProperties","description":"XblMultiplayerSessionSessionProperties","sidebarTitle":"XblMultiplayerSessionSessionProperties","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsessionproperties"},{"title":"XblMultiplayerSessionSessionReference","description":"XblMultiplayerSessionSessionReference","sidebarTitle":"XblMultiplayerSessionSessionReference","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsessionreference"},{"title":"XblMultiplayerSessionSetAllocateCloudCompute","description":"XblMultiplayerSessionSetAllocateCloudCompute","sidebarTitle":"XblMultiplayerSessionSetAllocateCloudCompute","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetallocatecloudcompute"},{"title":"XblMultiplayerSessionSetClosed","description":"XblMultiplayerSessionSetClosed","sidebarTitle":"XblMultiplayerSessionSetClosed","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetclosed"},{"title":"Xblmultiplayersessionsetcustompropertyjson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetcustompropertyjson"},{"title":"XblMultiplayerSessionSetHostDeviceToken","description":"XblMultiplayerSessionSetHostDeviceToken","sidebarTitle":"XblMultiplayerSessionSetHostDeviceToken","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsethostdevicetoken"},{"title":"XblMultiplayerSessionSetInitializationSucceeded","description":"XblMultiplayerSessionSetInitializationSucceeded","sidebarTitle":"XblMultiplayerSessionSetInitializationSucceeded","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetinitializationsucceeded"},{"title":"XblMultiplayerSessionSetLocked","description":"XblMultiplayerSessionSetLocked","sidebarTitle":"XblMultiplayerSessionSetLocked","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetlocked"},{"title":"XblMultiplayerSessionSetMatchmakingResubmit","description":"XblMultiplayerSessionSetMatchmakingResubmit","sidebarTitle":"XblMultiplayerSessionSetMatchmakingResubmit","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetmatchmakingresubmit"},{"title":"XblMultiplayerSessionSetMatchmakingServerConnectionPath","description":"XblMultiplayerSessionSetMatchmakingServerConnectionPath","sidebarTitle":"XblMultiplayerSessionSetMatchmakingServerConnectionPath","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetmatchmakingserverconnectionpath"},{"title":"XblMultiplayerSessionSetMatchmakingTargetSessionConstantsJson","description":"XblMultiplayerSessionSetMatchmakingTargetSessionConstantsJson","sidebarTitle":"XblMultiplayerSessionSetMatchmakingTargetSessionConstantsJson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetmatchmakingtargetsessionconstantsjson"},{"title":"XblMultiplayerSessionSetMutableRoleSettings","description":"XblMultiplayerSessionSetMutableRoleSettings","sidebarTitle":"XblMultiplayerSessionSetMutableRoleSettings","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetmutablerolesettings"},{"title":"XblMultiplayerSessionSetRawServersJson","description":"XblMultiplayerSessionSetRawServersJson","sidebarTitle":"XblMultiplayerSessionSetRawServersJson","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetrawserversjson"},{"title":"XblMultiplayerSessionSetServerConnectionStringCandidates","description":"XblMultiplayerSessionSetServerConnectionStringCandidates","sidebarTitle":"XblMultiplayerSessionSetServerConnectionStringCandidates","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetserverconnectionstringcandidates"},{"title":"XblMultiplayerSessionSetSessionChangeSubscription","description":"XblMultiplayerSessionSetSessionChangeSubscription","sidebarTitle":"XblMultiplayerSessionSetSessionChangeSubscription","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetsessionchangesubscription"},{"title":"XblMultiplayerSessionSubscribedChangeTypes","description":"XblMultiplayerSessionSubscribedChangeTypes","sidebarTitle":"XblMultiplayerSessionSubscribedChangeTypes","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsubscribedchangetypes"},{"title":"XblMultiplayerSessionSubscriptionLostHandler","description":"XblMultiplayerSessionSubscriptionLostHandler","sidebarTitle":"XblMultiplayerSessionSubscriptionLostHandler","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsubscriptionlosthandler"},{"title":"XblMultiplayerSessionTimeOfSession","description":"XblMultiplayerSessionTimeOfSession","sidebarTitle":"XblMultiplayerSessionTimeOfSession","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessiontimeofsession"},{"title":"XblMultiplayerSessionWriteStatus","description":"XblMultiplayerSessionWriteStatus","sidebarTitle":"XblMultiplayerSessionWriteStatus","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionwritestatus"},{"title":"XblMultiplayerSetActivityAsync","description":"XblMultiplayerSetActivityAsync","sidebarTitle":"XblMultiplayerSetActivityAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersetactivityasync"},{"title":"XblMultiplayerSetSubscriptionsEnabled","description":"XblMultiplayerSetSubscriptionsEnabled","sidebarTitle":"XblMultiplayerSetSubscriptionsEnabled","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersetsubscriptionsenabled"},{"title":"XblMultiplayerSetTransferHandleAsync","description":"XblMultiplayerSetTransferHandleAsync","sidebarTitle":"XblMultiplayerSetTransferHandleAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersettransferhandleasync"},{"title":"XblMultiplayerSetTransferHandleResult","description":"XblMultiplayerSetTransferHandleResult","sidebarTitle":"XblMultiplayerSetTransferHandleResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersettransferhandleresult"},{"title":"XblMultiplayerSubscriptionsEnabled","description":"XblMultiplayerSubscriptionsEnabled","sidebarTitle":"XblMultiplayerSubscriptionsEnabled","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersubscriptionsenabled"},{"title":"XblMultiplayerWriteSessionAsync","description":"XblMultiplayerWriteSessionAsync","sidebarTitle":"XblMultiplayerWriteSessionAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerwritesessionasync"},{"title":"XblMultiplayerWriteSessionByHandleAsync","description":"XblMultiplayerWriteSessionByHandleAsync","sidebarTitle":"XblMultiplayerWriteSessionByHandleAsync","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerwritesessionbyhandleasync"},{"title":"XblMultiplayerWriteSessionByHandleResult","description":"XblMultiplayerWriteSessionByHandleResult","sidebarTitle":"XblMultiplayerWriteSessionByHandleResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerwritesessionbyhandleresult"},{"title":"XblMultiplayerWriteSessionResult","description":"XblMultiplayerWriteSessionResult","sidebarTitle":"XblMultiplayerWriteSessionResult","href":"/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerwritesessionresult"}]},{"group":"Structs","pages":[{"title":"XblDeviceToken","description":"XblDeviceToken","sidebarTitle":"XblDeviceToken","href":"/reference/live/xsapi-c/multiplayer_c/structs/xbldevicetoken"},{"title":"XblFormattedSecureDeviceAddress","description":"XblFormattedSecureDeviceAddress","sidebarTitle":"XblFormattedSecureDeviceAddress","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblformattedsecuredeviceaddress"},{"title":"XblMultiplayerActivityDetails","description":"XblMultiplayerActivityDetails","sidebarTitle":"XblMultiplayerActivityDetails","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayeractivitydetails"},{"title":"XblMultiplayerArbitrationServer","description":"XblMultiplayerArbitrationServer","sidebarTitle":"XblMultiplayerArbitrationServer","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayerarbitrationserver"},{"title":"XblMultiplayerInviteHandle","description":"XblMultiplayerInviteHandle","sidebarTitle":"XblMultiplayerInviteHandle","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayerinvitehandle"},{"title":"XblMultiplayerMatchmakingServer","description":"XblMultiplayerMatchmakingServer","sidebarTitle":"XblMultiplayerMatchmakingServer","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayermatchmakingserver"},{"title":"XblMultiplayerMemberInitialization","description":"XblMultiplayerMemberInitialization","sidebarTitle":"XblMultiplayerMemberInitialization","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayermemberinitialization"},{"title":"XblMultiplayerPeerToHostRequirements","description":"XblMultiplayerPeerToHostRequirements","sidebarTitle":"XblMultiplayerPeerToHostRequirements","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayerpeertohostrequirements"},{"title":"XblMultiplayerPeerToPeerRequirements","description":"XblMultiplayerPeerToPeerRequirements","sidebarTitle":"XblMultiplayerPeerToPeerRequirements","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayerpeertopeerrequirements"},{"title":"XblMultiplayerRole","description":"XblMultiplayerRole","sidebarTitle":"XblMultiplayerRole","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayerrole"},{"title":"XblMultiplayerRoleType","description":"XblMultiplayerRoleType","sidebarTitle":"XblMultiplayerRoleType","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayerroletype"},{"title":"XblMultiplayerSessionCapabilities","description":"XblMultiplayerSessionCapabilities","sidebarTitle":"XblMultiplayerSessionCapabilities","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessioncapabilities"},{"title":"XblMultiplayerSessionChangeEventArgs","description":"XblMultiplayerSessionChangeEventArgs","sidebarTitle":"XblMultiplayerSessionChangeEventArgs","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionchangeeventargs"},{"title":"XblMultiplayerSessionConstants","description":"XblMultiplayerSessionConstants","sidebarTitle":"XblMultiplayerSessionConstants","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionconstants"},{"title":"XblMultiplayerSessionHandleId","description":"XblMultiplayerSessionHandleId","sidebarTitle":"XblMultiplayerSessionHandleId","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionhandleid"},{"title":"XblMultiplayerSessionInfo","description":"XblMultiplayerSessionInfo","sidebarTitle":"XblMultiplayerSessionInfo","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessioninfo"},{"title":"XblMultiplayerSessionInitArgs","description":"XblMultiplayerSessionInitArgs","sidebarTitle":"XblMultiplayerSessionInitArgs","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessioninitargs"},{"title":"XblMultiplayerSessionInitializationInfo","description":"XblMultiplayerSessionInitializationInfo","sidebarTitle":"XblMultiplayerSessionInitializationInfo","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessioninitializationinfo"},{"title":"XblMultiplayerSessionMember","description":"XblMultiplayerSessionMember","sidebarTitle":"XblMultiplayerSessionMember","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionmember"},{"title":"XblMultiplayerSessionMemberRole","description":"XblMultiplayerSessionMemberRole","sidebarTitle":"XblMultiplayerSessionMemberRole","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionmemberrole"},{"title":"XblMultiplayerSessionNumberAttribute","description":"XblMultiplayerSessionNumberAttribute","sidebarTitle":"XblMultiplayerSessionNumberAttribute","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionnumberattribute"},{"title":"XblMultiplayerSessionProperties","description":"XblMultiplayerSessionProperties","sidebarTitle":"XblMultiplayerSessionProperties","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionproperties"},{"title":"XblMultiplayerSessionQuery","description":"XblMultiplayerSessionQuery","sidebarTitle":"XblMultiplayerSessionQuery","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionquery"},{"title":"XblMultiplayerSessionQueryResult","description":"XblMultiplayerSessionQueryResult","sidebarTitle":"XblMultiplayerSessionQueryResult","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionqueryresult"},{"title":"XblMultiplayerSessionReference","description":"XblMultiplayerSessionReference","sidebarTitle":"XblMultiplayerSessionReference","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionreference"},{"title":"XblMultiplayerSessionReferenceUri","description":"XblMultiplayerSessionReferenceUri","sidebarTitle":"XblMultiplayerSessionReferenceUri","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionreferenceuri"},{"title":"XblMultiplayerSessionStringAttribute","description":"XblMultiplayerSessionStringAttribute","sidebarTitle":"XblMultiplayerSessionStringAttribute","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionstringattribute"},{"title":"XblMultiplayerSessionTag","description":"XblMultiplayerSessionTag","sidebarTitle":"XblMultiplayerSessionTag","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessiontag"},{"title":"XblMultiplayerTournamentsServer","description":"XblMultiplayerTournamentsServer","sidebarTitle":"XblMultiplayerTournamentsServer","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayertournamentsserver"},{"title":"XblMultiplayerTournamentTeam","description":"XblMultiplayerTournamentTeam","sidebarTitle":"XblMultiplayerTournamentTeam","href":"/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayertournamentteam"},{"title":"XblTournamentGameResultWithRank","description":"XblTournamentGameResultWithRank","sidebarTitle":"XblTournamentGameResultWithRank","href":"/reference/live/xsapi-c/multiplayer_c/structs/xbltournamentgameresultwithrank"},{"title":"XblTournamentReference","description":"XblTournamentReference","sidebarTitle":"XblTournamentReference","href":"/reference/live/xsapi-c/multiplayer_c/structs/xbltournamentreference"},{"title":"XblTournamentTeamResult","description":"XblTournamentTeamResult","sidebarTitle":"XblTournamentTeamResult","href":"/reference/live/xsapi-c/multiplayer_c/structs/xbltournamentteamresult"}]}]},{"group":"multiplayer_manager_c","pages":[{"group":"Enums","pages":[{"title":"XblMultiplayerEventType","description":"XblMultiplayerEventType","sidebarTitle":"XblMultiplayerEventType","href":"/reference/live/xsapi-c/multiplayer_manager_c/enums/xblmultiplayereventtype"},{"title":"XblMultiplayerJoinability","description":"XblMultiplayerJoinability","sidebarTitle":"XblMultiplayerJoinability","href":"/reference/live/xsapi-c/multiplayer_manager_c/enums/xblmultiplayerjoinability"},{"title":"XblMultiplayerMatchStatus","description":"XblMultiplayerMatchStatus","sidebarTitle":"XblMultiplayerMatchStatus","href":"/reference/live/xsapi-c/multiplayer_manager_c/enums/xblmultiplayermatchstatus"},{"title":"XblMultiplayerSessionType","description":"XblMultiplayerSessionType","sidebarTitle":"XblMultiplayerSessionType","href":"/reference/live/xsapi-c/multiplayer_manager_c/enums/xblmultiplayersessiontype"}]},{"group":"Functions","pages":[{"title":"XblMultiplayerEventArgsFindMatchCompleted","description":"XblMultiplayerEventArgsFindMatchCompleted","sidebarTitle":"XblMultiplayerEventArgsFindMatchCompleted","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayereventargsfindmatchcompleted"},{"title":"XblMultiplayerEventArgsMember","description":"XblMultiplayerEventArgsMember","sidebarTitle":"XblMultiplayerEventArgsMember","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayereventargsmember"},{"title":"XblMultiplayerEventArgsMembers","description":"XblMultiplayerEventArgsMembers","sidebarTitle":"XblMultiplayerEventArgsMembers","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayereventargsmembers"},{"title":"XblMultiplayerEventArgsMembersCount","description":"XblMultiplayerEventArgsMembersCount","sidebarTitle":"XblMultiplayerEventArgsMembersCount","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayereventargsmemberscount"},{"title":"XblMultiplayerEventArgsPerformQoSMeasurements","description":"XblMultiplayerEventArgsPerformQoSMeasurements","sidebarTitle":"XblMultiplayerEventArgsPerformQoSMeasurements","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayereventargsperformqosmeasurements"},{"title":"XblMultiplayerEventArgsPropertiesJson","description":"XblMultiplayerEventArgsPropertiesJson","sidebarTitle":"XblMultiplayerEventArgsPropertiesJson","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayereventargspropertiesjson"},{"title":"XblMultiplayerEventArgsXuid","description":"XblMultiplayerEventArgsXuid","sidebarTitle":"XblMultiplayerEventArgsXuid","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayereventargsxuid"},{"title":"XblMultiplayerManagerAutoFillMembersDuringMatchmaking","description":"XblMultiplayerManagerAutoFillMembersDuringMatchmaking","sidebarTitle":"XblMultiplayerManagerAutoFillMembersDuringMatchmaking","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerautofillmembersduringmatchmaking"},{"title":"XblMultiplayerManagerCancelMatch","description":"XblMultiplayerManagerCancelMatch","sidebarTitle":"XblMultiplayerManagerCancelMatch","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagercancelmatch"},{"title":"XblMultiplayerManagerDoWork","description":"XblMultiplayerManagerDoWork","sidebarTitle":"XblMultiplayerManagerDoWork","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerdowork"},{"title":"XblMultiplayerManagerEstimatedMatchWaitTime","description":"XblMultiplayerManagerEstimatedMatchWaitTime","sidebarTitle":"XblMultiplayerManagerEstimatedMatchWaitTime","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerestimatedmatchwaittime"},{"title":"XblMultiplayerManagerFindMatch","description":"XblMultiplayerManagerFindMatch","sidebarTitle":"XblMultiplayerManagerFindMatch","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerfindmatch"},{"title":"XblMultiplayerManagerGameSessionActive","description":"XblMultiplayerManagerGameSessionActive","sidebarTitle":"XblMultiplayerManagerGameSessionActive","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionactive"},{"title":"XblMultiplayerManagerGameSessionConstants","description":"XblMultiplayerManagerGameSessionConstants","sidebarTitle":"XblMultiplayerManagerGameSessionConstants","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionconstants"},{"title":"XblMultiplayerManagerGameSessionCorrelationId","description":"XblMultiplayerManagerGameSessionCorrelationId","sidebarTitle":"XblMultiplayerManagerGameSessionCorrelationId","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessioncorrelationid"},{"title":"XblMultiplayerManagerGameSessionHost","description":"XblMultiplayerManagerGameSessionHost","sidebarTitle":"XblMultiplayerManagerGameSessionHost","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionhost"},{"title":"XblMultiplayerManagerGameSessionIsHost","description":"XblMultiplayerManagerGameSessionIsHost","sidebarTitle":"XblMultiplayerManagerGameSessionIsHost","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionishost"},{"title":"XblMultiplayerManagerGameSessionMembers","description":"XblMultiplayerManagerGameSessionMembers","sidebarTitle":"XblMultiplayerManagerGameSessionMembers","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionmembers"},{"title":"XblMultiplayerManagerGameSessionMembersCount","description":"XblMultiplayerManagerGameSessionMembersCount","sidebarTitle":"XblMultiplayerManagerGameSessionMembersCount","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionmemberscount"},{"title":"XblMultiplayerManagerGameSessionPropertiesJson","description":"XblMultiplayerManagerGameSessionPropertiesJson","sidebarTitle":"XblMultiplayerManagerGameSessionPropertiesJson","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionpropertiesjson"},{"title":"XblMultiplayerManagerGameSessionSessionReference","description":"XblMultiplayerManagerGameSessionSessionReference","sidebarTitle":"XblMultiplayerManagerGameSessionSessionReference","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionsessionreference"},{"title":"XblMultiplayerManagerGameSessionSetProperties","description":"XblMultiplayerManagerGameSessionSetProperties","sidebarTitle":"XblMultiplayerManagerGameSessionSetProperties","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionsetproperties"},{"title":"XblMultiplayerManagerGameSessionSetSynchronizedHost","description":"XblMultiplayerManagerGameSessionSetSynchronizedHost","sidebarTitle":"XblMultiplayerManagerGameSessionSetSynchronizedHost","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionsetsynchronizedhost"},{"title":"XblMultiplayerManagerGameSessionSetSynchronizedProperties","description":"XblMultiplayerManagerGameSessionSetSynchronizedProperties","sidebarTitle":"XblMultiplayerManagerGameSessionSetSynchronizedProperties","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagergamesessionsetsynchronizedproperties"},{"title":"XblMultiplayerManagerInitialize","description":"XblMultiplayerManagerInitialize","sidebarTitle":"XblMultiplayerManagerInitialize","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerinitialize"},{"title":"XblMultiplayerManagerJoinability","description":"XblMultiplayerManagerJoinability","sidebarTitle":"XblMultiplayerManagerJoinability","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerjoinability"},{"title":"XblMultiplayerManagerJoinGame","description":"XblMultiplayerManagerJoinGame","sidebarTitle":"XblMultiplayerManagerJoinGame","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerjoingame"},{"title":"XblMultiplayerManagerJoinGameFromLobby","description":"XblMultiplayerManagerJoinGameFromLobby","sidebarTitle":"XblMultiplayerManagerJoinGameFromLobby","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerjoingamefromlobby"},{"title":"XblMultiplayerManagerJoinLobby","description":"XblMultiplayerManagerJoinLobby","sidebarTitle":"XblMultiplayerManagerJoinLobby","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerjoinlobby"},{"title":"XblMultiplayerManagerLeaveGame","description":"XblMultiplayerManagerLeaveGame","sidebarTitle":"XblMultiplayerManagerLeaveGame","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerleavegame"},{"title":"XblMultiplayerManagerLobbySessionAddLocalUser","description":"XblMultiplayerManagerLobbySessionAddLocalUser","sidebarTitle":"XblMultiplayerManagerLobbySessionAddLocalUser","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionaddlocaluser"},{"title":"XblMultiplayerManagerLobbySessionConstants","description":"XblMultiplayerManagerLobbySessionConstants","sidebarTitle":"XblMultiplayerManagerLobbySessionConstants","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionconstants"},{"title":"XblMultiplayerManagerLobbySessionCorrelationId","description":"XblMultiplayerManagerLobbySessionCorrelationId","sidebarTitle":"XblMultiplayerManagerLobbySessionCorrelationId","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessioncorrelationid"},{"title":"XblMultiplayerManagerLobbySessionDeleteLocalMemberProperties","description":"XblMultiplayerManagerLobbySessionDeleteLocalMemberProperties","sidebarTitle":"XblMultiplayerManagerLobbySessionDeleteLocalMemberProperties","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessiondeletelocalmemberproperties"},{"title":"XblMultiplayerManagerLobbySessionHost","description":"XblMultiplayerManagerLobbySessionHost","sidebarTitle":"XblMultiplayerManagerLobbySessionHost","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionhost"},{"title":"XblMultiplayerManagerLobbySessionInviteFriends","description":"XblMultiplayerManagerLobbySessionInviteFriends","sidebarTitle":"XblMultiplayerManagerLobbySessionInviteFriends","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessioninvitefriends"},{"title":"XblMultiplayerManagerLobbySessionInviteUsers","description":"XblMultiplayerManagerLobbySessionInviteUsers","sidebarTitle":"XblMultiplayerManagerLobbySessionInviteUsers","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessioninviteusers"},{"title":"XblMultiplayerManagerLobbySessionIsHost","description":"XblMultiplayerManagerLobbySessionIsHost","sidebarTitle":"XblMultiplayerManagerLobbySessionIsHost","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionishost"},{"title":"XblMultiplayerManagerLobbySessionLocalMembers","description":"XblMultiplayerManagerLobbySessionLocalMembers","sidebarTitle":"XblMultiplayerManagerLobbySessionLocalMembers","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionlocalmembers"},{"title":"XblMultiplayerManagerLobbySessionLocalMembersCount","description":"XblMultiplayerManagerLobbySessionLocalMembersCount","sidebarTitle":"XblMultiplayerManagerLobbySessionLocalMembersCount","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionlocalmemberscount"},{"title":"XblMultiplayerManagerLobbySessionMembers","description":"XblMultiplayerManagerLobbySessionMembers","sidebarTitle":"XblMultiplayerManagerLobbySessionMembers","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionmembers"},{"title":"XblMultiplayerManagerLobbySessionMembersCount","description":"XblMultiplayerManagerLobbySessionMembersCount","sidebarTitle":"XblMultiplayerManagerLobbySessionMembersCount","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionmemberscount"},{"title":"XblMultiplayerManagerLobbySessionPropertiesJson","description":"XblMultiplayerManagerLobbySessionPropertiesJson","sidebarTitle":"XblMultiplayerManagerLobbySessionPropertiesJson","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionpropertiesjson"},{"title":"XblMultiplayerManagerLobbySessionRemoveLocalUser","description":"XblMultiplayerManagerLobbySessionRemoveLocalUser","sidebarTitle":"XblMultiplayerManagerLobbySessionRemoveLocalUser","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionremovelocaluser"},{"title":"XblMultiplayerManagerLobbySessionSessionReference","description":"XblMultiplayerManagerLobbySessionSessionReference","sidebarTitle":"XblMultiplayerManagerLobbySessionSessionReference","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionsessionreference"},{"title":"XblMultiplayerManagerLobbySessionSetLocalMemberConnectionAddress","description":"XblMultiplayerManagerLobbySessionSetLocalMemberConnectionAddress","sidebarTitle":"XblMultiplayerManagerLobbySessionSetLocalMemberConnectionAddress","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionsetlocalmemberconnectionaddress"},{"title":"XblMultiplayerManagerLobbySessionSetLocalMemberProperties","description":"XblMultiplayerManagerLobbySessionSetLocalMemberProperties","sidebarTitle":"XblMultiplayerManagerLobbySessionSetLocalMemberProperties","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionsetlocalmemberproperties"},{"title":"XblMultiplayerManagerLobbySessionSetProperties","description":"XblMultiplayerManagerLobbySessionSetProperties","sidebarTitle":"XblMultiplayerManagerLobbySessionSetProperties","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionsetproperties"},{"title":"XblMultiplayerManagerLobbySessionSetSynchronizedHost","description":"XblMultiplayerManagerLobbySessionSetSynchronizedHost","sidebarTitle":"XblMultiplayerManagerLobbySessionSetSynchronizedHost","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionsetsynchronizedhost"},{"title":"XblMultiplayerManagerLobbySessionSetSynchronizedProperties","description":"XblMultiplayerManagerLobbySessionSetSynchronizedProperties","sidebarTitle":"XblMultiplayerManagerLobbySessionSetSynchronizedProperties","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagerlobbysessionsetsynchronizedproperties"},{"title":"XblMultiplayerManagerMatchStatus","description":"XblMultiplayerManagerMatchStatus","sidebarTitle":"XblMultiplayerManagerMatchStatus","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagermatchstatus"},{"title":"XblMultiplayerManagerMemberAreMembersOnSameDevice","description":"XblMultiplayerManagerMemberAreMembersOnSameDevice","sidebarTitle":"XblMultiplayerManagerMemberAreMembersOnSameDevice","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagermemberaremembersonsamedevice"},{"title":"XblMultiplayerManagerSetAutoFillMembersDuringMatchmaking","description":"XblMultiplayerManagerSetAutoFillMembersDuringMatchmaking","sidebarTitle":"XblMultiplayerManagerSetAutoFillMembersDuringMatchmaking","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagersetautofillmembersduringmatchmaking"},{"title":"XblMultiplayerManagerSetJoinability","description":"XblMultiplayerManagerSetJoinability","sidebarTitle":"XblMultiplayerManagerSetJoinability","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagersetjoinability"},{"title":"Xblmultiplayermanagersetqosmeasurements","href":"/reference/live/xsapi-c/multiplayer_manager_c/functions/xblmultiplayermanagersetqosmeasurements"}]},{"group":"Structs","pages":[{"title":"XblMultiplayerConnectionAddressDeviceTokenPair","description":"XblMultiplayerConnectionAddressDeviceTokenPair","sidebarTitle":"XblMultiplayerConnectionAddressDeviceTokenPair","href":"/reference/live/xsapi-c/multiplayer_manager_c/structs/xblmultiplayerconnectionaddressdevicetokenpair"},{"title":"XblMultiplayerEvent","description":"XblMultiplayerEvent","sidebarTitle":"XblMultiplayerEvent","href":"/reference/live/xsapi-c/multiplayer_manager_c/structs/xblmultiplayerevent"},{"title":"XblMultiplayerManagerMember","description":"XblMultiplayerManagerMember","sidebarTitle":"XblMultiplayerManagerMember","href":"/reference/live/xsapi-c/multiplayer_manager_c/structs/xblmultiplayermanagermember"},{"title":"XblMultiplayerPerformQoSMeasurementsArgs","description":"XblMultiplayerPerformQoSMeasurementsArgs","sidebarTitle":"XblMultiplayerPerformQoSMeasurementsArgs","href":"/reference/live/xsapi-c/multiplayer_manager_c/structs/xblmultiplayerperformqosmeasurementsargs"}]}]},{"group":"platform_c","pages":[{"group":"Enums","pages":[{"title":"XblClientOperationResult","description":"XblClientOperationResult","sidebarTitle":"XblClientOperationResult","href":"/reference/live/xsapi-c/platform_c/enums/xblclientoperationresult"},{"title":"XblLocalStorageWriteMode","description":"XblLocalStorageWriteMode","sidebarTitle":"XblLocalStorageWriteMode","href":"/reference/live/xsapi-c/platform_c/enums/xbllocalstoragewritemode"}]},{"group":"Functions","pages":[{"title":"XblLocalStorageClearComplete","description":"XblLocalStorageClearComplete","sidebarTitle":"XblLocalStorageClearComplete","href":"/reference/live/xsapi-c/platform_c/functions/xbllocalstorageclearcomplete"},{"title":"XblLocalStorageClearHandler","description":"XblLocalStorageClearHandler","sidebarTitle":"XblLocalStorageClearHandler","href":"/reference/live/xsapi-c/platform_c/functions/xbllocalstorageclearhandler"},{"title":"XblLocalStorageReadComplete","description":"XblLocalStorageReadComplete","sidebarTitle":"XblLocalStorageReadComplete","href":"/reference/live/xsapi-c/platform_c/functions/xbllocalstoragereadcomplete"},{"title":"XblLocalStorageReadHandler","description":"XblLocalStorageReadHandler","sidebarTitle":"XblLocalStorageReadHandler","href":"/reference/live/xsapi-c/platform_c/functions/xbllocalstoragereadhandler"},{"title":"XblLocalStorageSetHandlers","description":"XblLocalStorageSetHandlers","sidebarTitle":"XblLocalStorageSetHandlers","href":"/reference/live/xsapi-c/platform_c/functions/xbllocalstoragesethandlers"},{"title":"XblLocalStorageWriteComplete","description":"XblLocalStorageWriteComplete","sidebarTitle":"XblLocalStorageWriteComplete","href":"/reference/live/xsapi-c/platform_c/functions/xbllocalstoragewritecomplete"},{"title":"XblLocalStorageWriteHandler","description":"XblLocalStorageWriteHandler","sidebarTitle":"XblLocalStorageWriteHandler","href":"/reference/live/xsapi-c/platform_c/functions/xbllocalstoragewritehandler"}]}]},{"group":"presence_c","pages":[{"group":"Enums","pages":[{"title":"XblPresenceBroadcastProvider","description":"XblPresenceBroadcastProvider","sidebarTitle":"XblPresenceBroadcastProvider","href":"/reference/live/xsapi-c/presence_c/enums/xblpresencebroadcastprovider"},{"title":"XblPresenceDetailLevel","description":"XblPresenceDetailLevel","sidebarTitle":"XblPresenceDetailLevel","href":"/reference/live/xsapi-c/presence_c/enums/xblpresencedetaillevel"},{"title":"XblPresenceDeviceType","description":"XblPresenceDeviceType","sidebarTitle":"XblPresenceDeviceType","href":"/reference/live/xsapi-c/presence_c/enums/xblpresencedevicetype"},{"title":"XblPresenceMediaIdType","description":"XblPresenceMediaIdType","sidebarTitle":"XblPresenceMediaIdType","href":"/reference/live/xsapi-c/presence_c/enums/xblpresencemediaidtype"},{"title":"XblPresenceTitleState","description":"XblPresenceTitleState","sidebarTitle":"XblPresenceTitleState","href":"/reference/live/xsapi-c/presence_c/enums/xblpresencetitlestate"},{"title":"XblPresenceTitleViewState","description":"XblPresenceTitleViewState","sidebarTitle":"XblPresenceTitleViewState","href":"/reference/live/xsapi-c/presence_c/enums/xblpresencetitleviewstate"},{"title":"XblPresenceUserState","description":"XblPresenceUserState","sidebarTitle":"XblPresenceUserState","href":"/reference/live/xsapi-c/presence_c/enums/xblpresenceuserstate"}]},{"group":"Functions","pages":[{"title":"XblPresenceAddDevicePresenceChangedHandler","description":"XblPresenceAddDevicePresenceChangedHandler","sidebarTitle":"XblPresenceAddDevicePresenceChangedHandler","href":"/reference/live/xsapi-c/presence_c/functions/xblpresenceadddevicepresencechangedhandler"},{"title":"XblPresenceAddTitlePresenceChangedHandler","description":"XblPresenceAddTitlePresenceChangedHandler","sidebarTitle":"XblPresenceAddTitlePresenceChangedHandler","href":"/reference/live/xsapi-c/presence_c/functions/xblpresenceaddtitlepresencechangedhandler"},{"title":"XblPresenceDevicePresenceChangedHandler","description":"XblPresenceDevicePresenceChangedHandler","sidebarTitle":"XblPresenceDevicePresenceChangedHandler","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencedevicepresencechangedhandler"},{"title":"XblPresenceGetPresenceAsync","description":"XblPresenceGetPresenceAsync","sidebarTitle":"XblPresenceGetPresenceAsync","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencegetpresenceasync"},{"title":"XblPresenceGetPresenceForMultipleUsersAsync","description":"XblPresenceGetPresenceForMultipleUsersAsync","sidebarTitle":"XblPresenceGetPresenceForMultipleUsersAsync","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencegetpresenceformultipleusersasync"},{"title":"XblPresenceGetPresenceForMultipleUsersResult","description":"XblPresenceGetPresenceForMultipleUsersResult","sidebarTitle":"XblPresenceGetPresenceForMultipleUsersResult","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencegetpresenceformultipleusersresult"},{"title":"XblPresenceGetPresenceForMultipleUsersResultCount","description":"XblPresenceGetPresenceForMultipleUsersResultCount","sidebarTitle":"XblPresenceGetPresenceForMultipleUsersResultCount","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencegetpresenceformultipleusersresultcount"},{"title":"XblPresenceGetPresenceForSocialGroupAsync","description":"XblPresenceGetPresenceForSocialGroupAsync","sidebarTitle":"XblPresenceGetPresenceForSocialGroupAsync","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencegetpresenceforsocialgroupasync"},{"title":"XblPresenceGetPresenceForSocialGroupResult","description":"XblPresenceGetPresenceForSocialGroupResult","sidebarTitle":"XblPresenceGetPresenceForSocialGroupResult","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencegetpresenceforsocialgroupresult"},{"title":"XblPresenceGetPresenceForSocialGroupResultCount","description":"XblPresenceGetPresenceForSocialGroupResultCount","sidebarTitle":"XblPresenceGetPresenceForSocialGroupResultCount","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencegetpresenceforsocialgroupresultcount"},{"title":"XblPresenceGetPresenceResult","description":"XblPresenceGetPresenceResult","sidebarTitle":"XblPresenceGetPresenceResult","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencegetpresenceresult"},{"title":"XblPresenceRecordCloseHandle","description":"XblPresenceRecordCloseHandle","sidebarTitle":"XblPresenceRecordCloseHandle","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencerecordclosehandle"},{"title":"XblPresenceRecordDuplicateHandle","description":"XblPresenceRecordDuplicateHandle","sidebarTitle":"XblPresenceRecordDuplicateHandle","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencerecordduplicatehandle"},{"title":"XblPresenceRecordGetDeviceRecords","description":"XblPresenceRecordGetDeviceRecords","sidebarTitle":"XblPresenceRecordGetDeviceRecords","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencerecordgetdevicerecords"},{"title":"XblPresenceRecordGetUserState","description":"XblPresenceRecordGetUserState","sidebarTitle":"XblPresenceRecordGetUserState","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencerecordgetuserstate"},{"title":"XblPresenceRecordGetXuid","description":"XblPresenceRecordGetXuid","sidebarTitle":"XblPresenceRecordGetXuid","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencerecordgetxuid"},{"title":"XblPresenceRemoveDevicePresenceChangedHandler","description":"XblPresenceRemoveDevicePresenceChangedHandler","sidebarTitle":"XblPresenceRemoveDevicePresenceChangedHandler","href":"/reference/live/xsapi-c/presence_c/functions/xblpresenceremovedevicepresencechangedhandler"},{"title":"XblPresenceRemoveTitlePresenceChangedHandler","description":"XblPresenceRemoveTitlePresenceChangedHandler","sidebarTitle":"XblPresenceRemoveTitlePresenceChangedHandler","href":"/reference/live/xsapi-c/presence_c/functions/xblpresenceremovetitlepresencechangedhandler"},{"title":"XblPresenceSetPresenceAsync","description":"XblPresenceSetPresenceAsync","sidebarTitle":"XblPresenceSetPresenceAsync","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencesetpresenceasync"},{"title":"XblPresenceStopTrackingAdditionalTitles","description":"XblPresenceStopTrackingAdditionalTitles","sidebarTitle":"XblPresenceStopTrackingAdditionalTitles","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencestoptrackingadditionaltitles"},{"title":"XblPresenceStopTrackingUsers","description":"XblPresenceStopTrackingUsers","sidebarTitle":"XblPresenceStopTrackingUsers","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencestoptrackingusers"},{"title":"XblPresenceTitlePresenceChangedHandler","description":"XblPresenceTitlePresenceChangedHandler","sidebarTitle":"XblPresenceTitlePresenceChangedHandler","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencetitlepresencechangedhandler"},{"title":"XblPresenceTrackAdditionalTitles","description":"XblPresenceTrackAdditionalTitles","sidebarTitle":"XblPresenceTrackAdditionalTitles","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencetrackadditionaltitles"},{"title":"XblPresenceTrackUsers","description":"XblPresenceTrackUsers","sidebarTitle":"XblPresenceTrackUsers","href":"/reference/live/xsapi-c/presence_c/functions/xblpresencetrackusers"}]},{"group":"Structs","pages":[{"title":"XblPresenceBroadcastRecord","description":"XblPresenceBroadcastRecord","sidebarTitle":"XblPresenceBroadcastRecord","href":"/reference/live/xsapi-c/presence_c/structs/xblpresencebroadcastrecord"},{"title":"XblPresenceDeviceRecord","description":"XblPresenceDeviceRecord","sidebarTitle":"XblPresenceDeviceRecord","href":"/reference/live/xsapi-c/presence_c/structs/xblpresencedevicerecord"},{"title":"XblPresenceQueryFilters","description":"XblPresenceQueryFilters","sidebarTitle":"XblPresenceQueryFilters","href":"/reference/live/xsapi-c/presence_c/structs/xblpresencequeryfilters"},{"title":"XblPresenceRichPresenceIds","description":"XblPresenceRichPresenceIds","sidebarTitle":"XblPresenceRichPresenceIds","href":"/reference/live/xsapi-c/presence_c/structs/xblpresencerichpresenceids"},{"title":"XblPresenceTitleRecord","description":"XblPresenceTitleRecord","sidebarTitle":"XblPresenceTitleRecord","href":"/reference/live/xsapi-c/presence_c/structs/xblpresencetitlerecord"}]}]},{"group":"privacy_c","pages":[{"group":"Enums","pages":[{"title":"XblAnonymousUserType","description":"XblAnonymousUserType","sidebarTitle":"XblAnonymousUserType","href":"/reference/live/xsapi-c/privacy_c/enums/xblanonymoususertype"},{"title":"XblPermission","description":"XblPermission","sidebarTitle":"XblPermission","href":"/reference/live/xsapi-c/privacy_c/enums/xblpermission"},{"title":"XblPermissionDenyReason","description":"XblPermissionDenyReason","sidebarTitle":"XblPermissionDenyReason","href":"/reference/live/xsapi-c/privacy_c/enums/xblpermissiondenyreason"},{"title":"XblPrivacyListChangeType","description":"XblPrivacyListChangeType","sidebarTitle":"XblPrivacyListChangeType","href":"/reference/live/xsapi-c/privacy_c/enums/xblprivacylistchangetype"},{"title":"XblPrivacySetting","description":"XblPrivacySetting","sidebarTitle":"XblPrivacySetting","href":"/reference/live/xsapi-c/privacy_c/enums/xblprivacysetting"},{"title":"XblPrivilege","description":"XblPrivilege","sidebarTitle":"XblPrivilege","href":"/reference/live/xsapi-c/privacy_c/enums/xblprivilege"}]},{"group":"Functions","pages":[{"title":"XblPrivacyAddBlockListChangedHandler","description":"XblPrivacyAddBlockListChangedHandler","sidebarTitle":"XblPrivacyAddBlockListChangedHandler","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacyaddblocklistchangedhandler"},{"title":"XblPrivacyAddMuteListChangedHandler","description":"XblPrivacyAddMuteListChangedHandler","sidebarTitle":"XblPrivacyAddMuteListChangedHandler","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacyaddmutelistchangedhandler"},{"title":"XblPrivacyBatchCheckPermissionAsync","description":"XblPrivacyBatchCheckPermissionAsync","sidebarTitle":"XblPrivacyBatchCheckPermissionAsync","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacybatchcheckpermissionasync"},{"title":"XblPrivacyBatchCheckPermissionResult","description":"XblPrivacyBatchCheckPermissionResult","sidebarTitle":"XblPrivacyBatchCheckPermissionResult","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacybatchcheckpermissionresult"},{"title":"XblPrivacyBatchCheckPermissionResultSize","description":"XblPrivacyBatchCheckPermissionResultSize","sidebarTitle":"XblPrivacyBatchCheckPermissionResultSize","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacybatchcheckpermissionresultsize"},{"title":"XblPrivacyCheckPermissionAsync","description":"XblPrivacyCheckPermissionAsync","sidebarTitle":"XblPrivacyCheckPermissionAsync","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacycheckpermissionasync"},{"title":"XblPrivacyCheckPermissionForAnonymousUserAsync","description":"XblPrivacyCheckPermissionForAnonymousUserAsync","sidebarTitle":"XblPrivacyCheckPermissionForAnonymousUserAsync","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacycheckpermissionforanonymoususerasync"},{"title":"XblPrivacyCheckPermissionForAnonymousUserResult","description":"XblPrivacyCheckPermissionForAnonymousUserResult","sidebarTitle":"XblPrivacyCheckPermissionForAnonymousUserResult","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacycheckpermissionforanonymoususerresult"},{"title":"XblPrivacyCheckPermissionForAnonymousUserResultSize","description":"XblPrivacyCheckPermissionForAnonymousUserResultSize","sidebarTitle":"XblPrivacyCheckPermissionForAnonymousUserResultSize","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacycheckpermissionforanonymoususerresultsize"},{"title":"XblPrivacyCheckPermissionResult","description":"XblPrivacyCheckPermissionResult","sidebarTitle":"XblPrivacyCheckPermissionResult","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacycheckpermissionresult"},{"title":"XblPrivacyCheckPermissionResultSize","description":"XblPrivacyCheckPermissionResultSize","sidebarTitle":"XblPrivacyCheckPermissionResultSize","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacycheckpermissionresultsize"},{"title":"XblPrivacyGetAvoidListAsync","description":"XblPrivacyGetAvoidListAsync","sidebarTitle":"XblPrivacyGetAvoidListAsync","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacygetavoidlistasync"},{"title":"XblPrivacyGetAvoidListResult","description":"XblPrivacyGetAvoidListResult","sidebarTitle":"XblPrivacyGetAvoidListResult","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacygetavoidlistresult"},{"title":"XblPrivacyGetAvoidListResultCount","description":"XblPrivacyGetAvoidListResultCount","sidebarTitle":"XblPrivacyGetAvoidListResultCount","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacygetavoidlistresultcount"},{"title":"XblPrivacyGetMuteListAsync","description":"XblPrivacyGetMuteListAsync","sidebarTitle":"XblPrivacyGetMuteListAsync","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacygetmutelistasync"},{"title":"XblPrivacyGetMuteListResult","description":"XblPrivacyGetMuteListResult","sidebarTitle":"XblPrivacyGetMuteListResult","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacygetmutelistresult"},{"title":"XblPrivacyGetMuteListResultCount","description":"XblPrivacyGetMuteListResultCount","sidebarTitle":"XblPrivacyGetMuteListResultCount","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacygetmutelistresultcount"},{"title":"XblPrivacyRemoveBlockListChangedHandler","description":"XblPrivacyRemoveBlockListChangedHandler","sidebarTitle":"XblPrivacyRemoveBlockListChangedHandler","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacyremoveblocklistchangedhandler"},{"title":"XblPrivacyRemoveMuteListChangedHandler","description":"XblPrivacyRemoveMuteListChangedHandler","sidebarTitle":"XblPrivacyRemoveMuteListChangedHandler","href":"/reference/live/xsapi-c/privacy_c/functions/xblprivacyremovemutelistchangedhandler"}]},{"group":"Structs","pages":[{"title":"XblPermissionCheckResult","description":"XblPermissionCheckResult","sidebarTitle":"XblPermissionCheckResult","href":"/reference/live/xsapi-c/privacy_c/structs/xblpermissioncheckresult"},{"title":"XblPermissionDenyReasonDetails","description":"XblPermissionDenyReasonDetails","sidebarTitle":"XblPermissionDenyReasonDetails","href":"/reference/live/xsapi-c/privacy_c/structs/xblpermissiondenyreasondetails"},{"title":"XblPrivacyBlockListChangeEventArgs","description":"XblPrivacyBlockListChangeEventArgs","sidebarTitle":"XblPrivacyBlockListChangeEventArgs","href":"/reference/live/xsapi-c/privacy_c/structs/xblprivacyblocklistchangeeventargs"},{"title":"XblPrivacyMuteListChangeEventArgs","description":"XblPrivacyMuteListChangeEventArgs","sidebarTitle":"XblPrivacyMuteListChangeEventArgs","href":"/reference/live/xsapi-c/privacy_c/structs/xblprivacymutelistchangeeventargs"}]}]},{"group":"profile_c","pages":[{"group":"Functions","pages":[{"title":"XblProfileGetUserProfileAsync","description":"XblProfileGetUserProfileAsync","sidebarTitle":"XblProfileGetUserProfileAsync","href":"/reference/live/xsapi-c/profile_c/functions/xblprofilegetuserprofileasync"},{"title":"XblProfileGetUserProfileResult","description":"XblProfileGetUserProfileResult","sidebarTitle":"XblProfileGetUserProfileResult","href":"/reference/live/xsapi-c/profile_c/functions/xblprofilegetuserprofileresult"},{"title":"XblProfileGetUserProfilesAsync","description":"XblProfileGetUserProfilesAsync","sidebarTitle":"XblProfileGetUserProfilesAsync","href":"/reference/live/xsapi-c/profile_c/functions/xblprofilegetuserprofilesasync"},{"title":"XblProfileGetUserProfilesForSocialGroupAsync","description":"XblProfileGetUserProfilesForSocialGroupAsync","sidebarTitle":"XblProfileGetUserProfilesForSocialGroupAsync","href":"/reference/live/xsapi-c/profile_c/functions/xblprofilegetuserprofilesforsocialgroupasync"},{"title":"XblProfileGetUserProfilesForSocialGroupResult","description":"XblProfileGetUserProfilesForSocialGroupResult","sidebarTitle":"XblProfileGetUserProfilesForSocialGroupResult","href":"/reference/live/xsapi-c/profile_c/functions/xblprofilegetuserprofilesforsocialgroupresult"},{"title":"XblProfileGetUserProfilesForSocialGroupResultCount","description":"XblProfileGetUserProfilesForSocialGroupResultCount","sidebarTitle":"XblProfileGetUserProfilesForSocialGroupResultCount","href":"/reference/live/xsapi-c/profile_c/functions/xblprofilegetuserprofilesforsocialgroupresultcount"},{"title":"XblProfileGetUserProfilesResult","description":"XblProfileGetUserProfilesResult","sidebarTitle":"XblProfileGetUserProfilesResult","href":"/reference/live/xsapi-c/profile_c/functions/xblprofilegetuserprofilesresult"},{"title":"XblProfileGetUserProfilesResultCount","description":"XblProfileGetUserProfilesResultCount","sidebarTitle":"XblProfileGetUserProfilesResultCount","href":"/reference/live/xsapi-c/profile_c/functions/xblprofilegetuserprofilesresultcount"}]},{"group":"Structs","pages":[{"title":"XblUserProfile","description":"XblUserProfile","sidebarTitle":"XblUserProfile","href":"/reference/live/xsapi-c/profile_c/structs/xbluserprofile"}]}]},{"group":"real_time_activity_c","pages":[{"group":"Enums","pages":[{"title":"XblRealTimeActivityConnectionState","description":"XblRealTimeActivityConnectionState","sidebarTitle":"XblRealTimeActivityConnectionState","href":"/reference/live/xsapi-c/real_time_activity_c/enums/xblrealtimeactivityconnectionstate"},{"title":"XblRealTimeActivitySubscriptionState","description":"XblRealTimeActivitySubscriptionState","sidebarTitle":"XblRealTimeActivitySubscriptionState","href":"/reference/live/xsapi-c/real_time_activity_c/enums/xblrealtimeactivitysubscriptionstate"}]},{"group":"Functions","pages":[{"title":"XblRealTimeActivityAddConnectionStateChangeHandler","description":"XblRealTimeActivityAddConnectionStateChangeHandler","sidebarTitle":"XblRealTimeActivityAddConnectionStateChangeHandler","href":"/reference/live/xsapi-c/real_time_activity_c/functions/xblrealtimeactivityaddconnectionstatechangehandler"},{"title":"XblRealTimeActivityAddResyncHandler","description":"XblRealTimeActivityAddResyncHandler","sidebarTitle":"XblRealTimeActivityAddResyncHandler","href":"/reference/live/xsapi-c/real_time_activity_c/functions/xblrealtimeactivityaddresynchandler"},{"title":"XblRealTimeActivityConnectionStateChangeHandler","description":"XblRealTimeActivityConnectionStateChangeHandler","sidebarTitle":"XblRealTimeActivityConnectionStateChangeHandler","href":"/reference/live/xsapi-c/real_time_activity_c/functions/xblrealtimeactivityconnectionstatechangehandler"},{"title":"XblRealTimeActivityRemoveConnectionStateChangeHandler","description":"XblRealTimeActivityRemoveConnectionStateChangeHandler","sidebarTitle":"XblRealTimeActivityRemoveConnectionStateChangeHandler","href":"/reference/live/xsapi-c/real_time_activity_c/functions/xblrealtimeactivityremoveconnectionstatechangehandler"},{"title":"XblRealTimeActivityRemoveResyncHandler","description":"XblRealTimeActivityRemoveResyncHandler","sidebarTitle":"XblRealTimeActivityRemoveResyncHandler","href":"/reference/live/xsapi-c/real_time_activity_c/functions/xblrealtimeactivityremoveresynchandler"},{"title":"XblRealTimeActivityResyncHandler","description":"XblRealTimeActivityResyncHandler","sidebarTitle":"XblRealTimeActivityResyncHandler","href":"/reference/live/xsapi-c/real_time_activity_c/functions/xblrealtimeactivityresynchandler"},{"title":"XblRealTimeActivitySubscriptionErrorHandler","description":"XblRealTimeActivitySubscriptionErrorHandler","sidebarTitle":"XblRealTimeActivitySubscriptionErrorHandler","href":"/reference/live/xsapi-c/real_time_activity_c/functions/xblrealtimeactivitysubscriptionerrorhandler"}]}]},{"group":"social_c","pages":[{"group":"Enums","pages":[{"title":"XblReputationFeedbackType","description":"XblReputationFeedbackType","sidebarTitle":"XblReputationFeedbackType","href":"/reference/live/xsapi-c/social_c/enums/xblreputationfeedbacktype"},{"title":"XblSocialNotificationType","description":"XblSocialNotificationType","sidebarTitle":"XblSocialNotificationType","href":"/reference/live/xsapi-c/social_c/enums/xblsocialnotificationtype"},{"title":"XblSocialRelationshipFilter","description":"XblSocialRelationshipFilter","sidebarTitle":"XblSocialRelationshipFilter","href":"/reference/live/xsapi-c/social_c/enums/xblsocialrelationshipfilter"}]},{"group":"Functions","pages":[{"title":"XblSocialAddSocialRelationshipChangedHandler","description":"XblSocialAddSocialRelationshipChangedHandler","sidebarTitle":"XblSocialAddSocialRelationshipChangedHandler","href":"/reference/live/xsapi-c/social_c/functions/xblsocialaddsocialrelationshipchangedhandler"},{"title":"XblSocialGetSocialRelationshipsAsync","description":"XblSocialGetSocialRelationshipsAsync","sidebarTitle":"XblSocialGetSocialRelationshipsAsync","href":"/reference/live/xsapi-c/social_c/functions/xblsocialgetsocialrelationshipsasync"},{"title":"XblSocialGetSocialRelationshipsResult","description":"XblSocialGetSocialRelationshipsResult","sidebarTitle":"XblSocialGetSocialRelationshipsResult","href":"/reference/live/xsapi-c/social_c/functions/xblsocialgetsocialrelationshipsresult"},{"title":"XblSocialRelationshipResultCloseHandle","description":"XblSocialRelationshipResultCloseHandle","sidebarTitle":"XblSocialRelationshipResultCloseHandle","href":"/reference/live/xsapi-c/social_c/functions/xblsocialrelationshipresultclosehandle"},{"title":"XblSocialRelationshipResultDuplicateHandle","description":"XblSocialRelationshipResultDuplicateHandle","sidebarTitle":"XblSocialRelationshipResultDuplicateHandle","href":"/reference/live/xsapi-c/social_c/functions/xblsocialrelationshipresultduplicatehandle"},{"title":"XblSocialRelationshipResultGetNextAsync","description":"XblSocialRelationshipResultGetNextAsync","sidebarTitle":"XblSocialRelationshipResultGetNextAsync","href":"/reference/live/xsapi-c/social_c/functions/xblsocialrelationshipresultgetnextasync"},{"title":"XblSocialRelationshipResultGetNextResult","description":"XblSocialRelationshipResultGetNextResult","sidebarTitle":"XblSocialRelationshipResultGetNextResult","href":"/reference/live/xsapi-c/social_c/functions/xblsocialrelationshipresultgetnextresult"},{"title":"XblSocialRelationshipResultGetRelationships","description":"XblSocialRelationshipResultGetRelationships","sidebarTitle":"XblSocialRelationshipResultGetRelationships","href":"/reference/live/xsapi-c/social_c/functions/xblsocialrelationshipresultgetrelationships"},{"title":"XblSocialRelationshipResultGetTotalCount","description":"XblSocialRelationshipResultGetTotalCount","sidebarTitle":"XblSocialRelationshipResultGetTotalCount","href":"/reference/live/xsapi-c/social_c/functions/xblsocialrelationshipresultgettotalcount"},{"title":"XblSocialRelationshipResultHasNext","description":"XblSocialRelationshipResultHasNext","sidebarTitle":"XblSocialRelationshipResultHasNext","href":"/reference/live/xsapi-c/social_c/functions/xblsocialrelationshipresulthasnext"},{"title":"XblSocialRemoveSocialRelationshipChangedHandler","description":"XblSocialRemoveSocialRelationshipChangedHandler","sidebarTitle":"XblSocialRemoveSocialRelationshipChangedHandler","href":"/reference/live/xsapi-c/social_c/functions/xblsocialremovesocialrelationshipchangedhandler"},{"title":"XblSocialSubmitBatchReputationFeedbackAsync","description":"XblSocialSubmitBatchReputationFeedbackAsync","sidebarTitle":"XblSocialSubmitBatchReputationFeedbackAsync","href":"/reference/live/xsapi-c/social_c/functions/xblsocialsubmitbatchreputationfeedbackasync"},{"title":"XblSocialSubmitReputationFeedbackAsync","description":"XblSocialSubmitReputationFeedbackAsync","sidebarTitle":"XblSocialSubmitReputationFeedbackAsync","href":"/reference/live/xsapi-c/social_c/functions/xblsocialsubmitreputationfeedbackasync"}]},{"group":"Structs","pages":[{"title":"XblReputationFeedbackItem","description":"XblReputationFeedbackItem","sidebarTitle":"XblReputationFeedbackItem","href":"/reference/live/xsapi-c/social_c/structs/xblreputationfeedbackitem"},{"title":"XblSocialRelationship","description":"XblSocialRelationship","sidebarTitle":"XblSocialRelationship","href":"/reference/live/xsapi-c/social_c/structs/xblsocialrelationship"},{"title":"XblSocialRelationshipChangeEventArgs","description":"XblSocialRelationshipChangeEventArgs","sidebarTitle":"XblSocialRelationshipChangeEventArgs","href":"/reference/live/xsapi-c/social_c/structs/xblsocialrelationshipchangeeventargs"}]}]},{"group":"social_manager_c","pages":[{"group":"Enums","pages":[{"title":"XblPresenceFilter","description":"XblPresenceFilter","sidebarTitle":"XblPresenceFilter","href":"/reference/live/xsapi-c/social_manager_c/enums/xblpresencefilter"},{"title":"XblRelationshipFilter","description":"XblRelationshipFilter","sidebarTitle":"XblRelationshipFilter","href":"/reference/live/xsapi-c/social_manager_c/enums/xblrelationshipfilter"},{"title":"XblSocialManagerEventType","description":"XblSocialManagerEventType","sidebarTitle":"XblSocialManagerEventType","href":"/reference/live/xsapi-c/social_manager_c/enums/xblsocialmanagereventtype"},{"title":"XblSocialManagerExtraDetailLevel","description":"XblSocialManagerExtraDetailLevel","sidebarTitle":"XblSocialManagerExtraDetailLevel","href":"/reference/live/xsapi-c/social_manager_c/enums/xblsocialmanagerextradetaillevel"},{"title":"XblSocialUserGroupType","description":"XblSocialUserGroupType","sidebarTitle":"XblSocialUserGroupType","href":"/reference/live/xsapi-c/social_manager_c/enums/xblsocialusergrouptype"}]},{"group":"Functions","pages":[{"title":"XblSocialManagerAddLocalUser","description":"XblSocialManagerAddLocalUser","sidebarTitle":"XblSocialManagerAddLocalUser","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanageraddlocaluser"},{"title":"XblSocialManagerCreateSocialUserGroupFromFilters","description":"XblSocialManagerCreateSocialUserGroupFromFilters","sidebarTitle":"XblSocialManagerCreateSocialUserGroupFromFilters","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagercreatesocialusergroupfromfilters"},{"title":"XblSocialManagerCreateSocialUserGroupFromList","description":"XblSocialManagerCreateSocialUserGroupFromList","sidebarTitle":"XblSocialManagerCreateSocialUserGroupFromList","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagercreatesocialusergroupfromlist"},{"title":"XblSocialManagerDestroySocialUserGroup","description":"XblSocialManagerDestroySocialUserGroup","sidebarTitle":"XblSocialManagerDestroySocialUserGroup","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerdestroysocialusergroup"},{"title":"XblSocialManagerDoWork","description":"XblSocialManagerDoWork","sidebarTitle":"XblSocialManagerDoWork","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerdowork"},{"title":"XblSocialManagerGetLocalUserCount","description":"XblSocialManagerGetLocalUserCount","sidebarTitle":"XblSocialManagerGetLocalUserCount","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagergetlocalusercount"},{"title":"XblSocialManagerGetLocalUsers","description":"XblSocialManagerGetLocalUsers","sidebarTitle":"XblSocialManagerGetLocalUsers","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagergetlocalusers"},{"title":"XblSocialManagerPresenceRecordIsUserPlayingTitle","description":"XblSocialManagerPresenceRecordIsUserPlayingTitle","sidebarTitle":"XblSocialManagerPresenceRecordIsUserPlayingTitle","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerpresencerecordisuserplayingtitle"},{"title":"XblSocialManagerRemoveLocalUser","description":"XblSocialManagerRemoveLocalUser","sidebarTitle":"XblSocialManagerRemoveLocalUser","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerremovelocaluser"},{"title":"XblSocialManagerSetRichPresencePollingStatus","description":"XblSocialManagerSetRichPresencePollingStatus","sidebarTitle":"XblSocialManagerSetRichPresencePollingStatus","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagersetrichpresencepollingstatus"},{"title":"XblSocialManagerUpdateSocialUserGroup","description":"XblSocialManagerUpdateSocialUserGroup","sidebarTitle":"XblSocialManagerUpdateSocialUserGroup","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerupdatesocialusergroup"},{"title":"XblSocialManagerUserGroupGetFilters","description":"XblSocialManagerUserGroupGetFilters","sidebarTitle":"XblSocialManagerUserGroupGetFilters","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerusergroupgetfilters"},{"title":"XblSocialManagerUserGroupGetLocalUser","description":"XblSocialManagerUserGroupGetLocalUser","sidebarTitle":"XblSocialManagerUserGroupGetLocalUser","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerusergroupgetlocaluser"},{"title":"XblSocialManagerUserGroupGetType","description":"XblSocialManagerUserGroupGetType","sidebarTitle":"XblSocialManagerUserGroupGetType","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerusergroupgettype"},{"title":"XblSocialManagerUserGroupGetUsers","description":"XblSocialManagerUserGroupGetUsers","sidebarTitle":"XblSocialManagerUserGroupGetUsers","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerusergroupgetusers"},{"title":"XblSocialManagerUserGroupGetUsersTrackedByGroup","description":"XblSocialManagerUserGroupGetUsersTrackedByGroup","sidebarTitle":"XblSocialManagerUserGroupGetUsersTrackedByGroup","href":"/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerusergroupgetuserstrackedbygroup"}]},{"group":"Structs","pages":[{"title":"XblPreferredColor","description":"XblPreferredColor","sidebarTitle":"XblPreferredColor","href":"/reference/live/xsapi-c/social_manager_c/structs/xblpreferredcolor"},{"title":"XblSocialManagerEvent","description":"XblSocialManagerEvent","sidebarTitle":"XblSocialManagerEvent","href":"/reference/live/xsapi-c/social_manager_c/structs/xblsocialmanagerevent"},{"title":"XblSocialManagerPresenceRecord","description":"XblSocialManagerPresenceRecord","sidebarTitle":"XblSocialManagerPresenceRecord","href":"/reference/live/xsapi-c/social_manager_c/structs/xblsocialmanagerpresencerecord"},{"title":"XblSocialManagerPresenceTitleRecord","description":"XblSocialManagerPresenceTitleRecord","sidebarTitle":"XblSocialManagerPresenceTitleRecord","href":"/reference/live/xsapi-c/social_manager_c/structs/xblsocialmanagerpresencetitlerecord"},{"title":"XblSocialManagerUser","description":"XblSocialManagerUser","sidebarTitle":"XblSocialManagerUser","href":"/reference/live/xsapi-c/social_manager_c/structs/xblsocialmanageruser"},{"title":"XblTitleHistory","description":"XblTitleHistory","sidebarTitle":"XblTitleHistory","href":"/reference/live/xsapi-c/social_manager_c/structs/xbltitlehistory"}]}]},{"group":"string_verify_c","pages":[{"group":"Enums","pages":[{"title":"XblVerifyStringResultCode","description":"XblVerifyStringResultCode","sidebarTitle":"XblVerifyStringResultCode","href":"/reference/live/xsapi-c/string_verify_c/enums/xblverifystringresultcode"}]},{"group":"Functions","pages":[{"title":"XblStringVerifyStringAsync","description":"XblStringVerifyStringAsync","sidebarTitle":"XblStringVerifyStringAsync","href":"/reference/live/xsapi-c/string_verify_c/functions/xblstringverifystringasync"},{"title":"XblStringVerifyStringResult","description":"XblStringVerifyStringResult","sidebarTitle":"XblStringVerifyStringResult","href":"/reference/live/xsapi-c/string_verify_c/functions/xblstringverifystringresult"},{"title":"XblStringVerifyStringResultSize","description":"XblStringVerifyStringResultSize","sidebarTitle":"XblStringVerifyStringResultSize","href":"/reference/live/xsapi-c/string_verify_c/functions/xblstringverifystringresultsize"},{"title":"XblStringVerifyStringsAsync","description":"XblStringVerifyStringsAsync","sidebarTitle":"XblStringVerifyStringsAsync","href":"/reference/live/xsapi-c/string_verify_c/functions/xblstringverifystringsasync"},{"title":"XblStringVerifyStringsResult","description":"XblStringVerifyStringsResult","sidebarTitle":"XblStringVerifyStringsResult","href":"/reference/live/xsapi-c/string_verify_c/functions/xblstringverifystringsresult"},{"title":"XblStringVerifyStringsResultSize","description":"XblStringVerifyStringsResultSize","sidebarTitle":"XblStringVerifyStringsResultSize","href":"/reference/live/xsapi-c/string_verify_c/functions/xblstringverifystringsresultsize"}]},{"group":"Structs","pages":[{"title":"XblVerifyStringResult","description":"XblVerifyStringResult","sidebarTitle":"XblVerifyStringResult","href":"/reference/live/xsapi-c/string_verify_c/structs/xblverifystringresult"}]}]},{"group":"title_managed_statistics_c","pages":[{"group":"Enums","pages":[{"title":"XblTitleManagedStatType","description":"XblTitleManagedStatType","sidebarTitle":"XblTitleManagedStatType","href":"/reference/live/xsapi-c/title_managed_statistics_c/enums/xbltitlemanagedstattype"}]},{"group":"Functions","pages":[{"title":"XblTitleManagedStatsDeleteStatsAsync","description":"XblTitleManagedStatsDeleteStatsAsync","sidebarTitle":"XblTitleManagedStatsDeleteStatsAsync","href":"/reference/live/xsapi-c/title_managed_statistics_c/functions/xbltitlemanagedstatsdeletestatsasync"},{"title":"XblTitleManagedStatsUpdateStatsAsync","description":"XblTitleManagedStatsUpdateStatsAsync","sidebarTitle":"XblTitleManagedStatsUpdateStatsAsync","href":"/reference/live/xsapi-c/title_managed_statistics_c/functions/xbltitlemanagedstatsupdatestatsasync"},{"title":"XblTitleManagedStatsWriteAsync","description":"XblTitleManagedStatsWriteAsync","sidebarTitle":"XblTitleManagedStatsWriteAsync","href":"/reference/live/xsapi-c/title_managed_statistics_c/functions/xbltitlemanagedstatswriteasync"}]},{"group":"Structs","pages":[{"title":"XblTitleManagedStatistic","description":"XblTitleManagedStatistic","sidebarTitle":"XblTitleManagedStatistic","href":"/reference/live/xsapi-c/title_managed_statistics_c/structs/xbltitlemanagedstatistic"}]}]},{"group":"title_storage_c","pages":[{"group":"Enums","pages":[{"title":"XblTitleStorageBlobType","description":"XblTitleStorageBlobType","sidebarTitle":"XblTitleStorageBlobType","href":"/reference/live/xsapi-c/title_storage_c/enums/xbltitlestorageblobtype"},{"title":"XblTitleStorageETagMatchCondition","description":"XblTitleStorageETagMatchCondition","sidebarTitle":"XblTitleStorageETagMatchCondition","href":"/reference/live/xsapi-c/title_storage_c/enums/xbltitlestorageetagmatchcondition"},{"title":"XblTitleStorageType","description":"XblTitleStorageType","sidebarTitle":"XblTitleStorageType","href":"/reference/live/xsapi-c/title_storage_c/enums/xbltitlestoragetype"}]},{"group":"Functions","pages":[{"title":"XblTitleStorageBlobMetadataResultCloseHandle","description":"XblTitleStorageBlobMetadataResultCloseHandle","sidebarTitle":"XblTitleStorageBlobMetadataResultCloseHandle","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestorageblobmetadataresultclosehandle"},{"title":"XblTitleStorageBlobMetadataResultDuplicateHandle","description":"XblTitleStorageBlobMetadataResultDuplicateHandle","sidebarTitle":"XblTitleStorageBlobMetadataResultDuplicateHandle","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestorageblobmetadataresultduplicatehandle"},{"title":"XblTitleStorageBlobMetadataResultGetItems","description":"XblTitleStorageBlobMetadataResultGetItems","sidebarTitle":"XblTitleStorageBlobMetadataResultGetItems","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestorageblobmetadataresultgetitems"},{"title":"XblTitleStorageBlobMetadataResultGetNextAsync","description":"XblTitleStorageBlobMetadataResultGetNextAsync","sidebarTitle":"XblTitleStorageBlobMetadataResultGetNextAsync","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestorageblobmetadataresultgetnextasync"},{"title":"XblTitleStorageBlobMetadataResultGetNextResult","description":"XblTitleStorageBlobMetadataResultGetNextResult","sidebarTitle":"XblTitleStorageBlobMetadataResultGetNextResult","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestorageblobmetadataresultgetnextresult"},{"title":"XblTitleStorageBlobMetadataResultHasNext","description":"XblTitleStorageBlobMetadataResultHasNext","sidebarTitle":"XblTitleStorageBlobMetadataResultHasNext","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestorageblobmetadataresulthasnext"},{"title":"XblTitleStorageDeleteBlobAsync","description":"XblTitleStorageDeleteBlobAsync","sidebarTitle":"XblTitleStorageDeleteBlobAsync","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestoragedeleteblobasync"},{"title":"XblTitleStorageDownloadBlobAsync","description":"XblTitleStorageDownloadBlobAsync","sidebarTitle":"XblTitleStorageDownloadBlobAsync","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestoragedownloadblobasync"},{"title":"XblTitleStorageDownloadBlobResult","description":"XblTitleStorageDownloadBlobResult","sidebarTitle":"XblTitleStorageDownloadBlobResult","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestoragedownloadblobresult"},{"title":"XblTitleStorageGetBlobMetadataAsync","description":"XblTitleStorageGetBlobMetadataAsync","sidebarTitle":"XblTitleStorageGetBlobMetadataAsync","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestoragegetblobmetadataasync"},{"title":"XblTitleStorageGetBlobMetadataResult","description":"XblTitleStorageGetBlobMetadataResult","sidebarTitle":"XblTitleStorageGetBlobMetadataResult","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestoragegetblobmetadataresult"},{"title":"XblTitleStorageGetQuotaAsync","description":"XblTitleStorageGetQuotaAsync","sidebarTitle":"XblTitleStorageGetQuotaAsync","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestoragegetquotaasync"},{"title":"XblTitleStorageGetQuotaResult","description":"XblTitleStorageGetQuotaResult","sidebarTitle":"XblTitleStorageGetQuotaResult","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestoragegetquotaresult"},{"title":"XblTitleStorageUploadBlobAsync","description":"XblTitleStorageUploadBlobAsync","sidebarTitle":"XblTitleStorageUploadBlobAsync","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestorageuploadblobasync"},{"title":"XblTitleStorageUploadBlobResult","description":"XblTitleStorageUploadBlobResult","sidebarTitle":"XblTitleStorageUploadBlobResult","href":"/reference/live/xsapi-c/title_storage_c/functions/xbltitlestorageuploadblobresult"}]},{"group":"Structs","pages":[{"title":"XblTitleStorageBlobMetadata","description":"XblTitleStorageBlobMetadata","sidebarTitle":"XblTitleStorageBlobMetadata","href":"/reference/live/xsapi-c/title_storage_c/structs/xbltitlestorageblobmetadata"}]}]},{"group":"types_c","pages":[{"group":"Structs","pages":[{"title":"XblGuid","description":"XblGuid","sidebarTitle":"XblGuid","href":"/reference/live/xsapi-c/types_c/structs/xblguid"}]}]},{"group":"user_statistics_c","pages":[{"group":"Functions","pages":[{"title":"XblStatisticChangedHandler","description":"XblStatisticChangedHandler","sidebarTitle":"XblStatisticChangedHandler","href":"/reference/live/xsapi-c/user_statistics_c/functions/xblstatisticchangedhandler"},{"title":"XblUserStatisticsAddStatisticChangedHandler","description":"XblUserStatisticsAddStatisticChangedHandler","sidebarTitle":"XblUserStatisticsAddStatisticChangedHandler","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsaddstatisticchangedhandler"},{"title":"XblUserStatisticsGetMultipleUserStatisticsAsync","description":"XblUserStatisticsGetMultipleUserStatisticsAsync","sidebarTitle":"XblUserStatisticsGetMultipleUserStatisticsAsync","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetmultipleuserstatisticsasync"},{"title":"XblUserStatisticsGetMultipleUserStatisticsForMultipleServiceConfigurationsAsync","description":"XblUserStatisticsGetMultipleUserStatisticsForMultipleServiceConfigurationsAsync","sidebarTitle":"XblUserStatisticsGetMultipleUserStatisticsForMultipleServiceConfigurationsAsync","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetmultipleuserstatisticsformultipleserviceconfigurationsasync"},{"title":"XblUserStatisticsGetMultipleUserStatisticsForMultipleServiceConfigurationsResult","description":"XblUserStatisticsGetMultipleUserStatisticsForMultipleServiceConfigurationsResult","sidebarTitle":"XblUserStatisticsGetMultipleUserStatisticsForMultipleServiceConfigurationsResult","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetmultipleuserstatisticsformultipleserviceconfigurationsresult"},{"title":"XblUserStatisticsGetMultipleUserStatisticsForMultipleServiceConfigurationsResultSize","description":"XblUserStatisticsGetMultipleUserStatisticsForMultipleServiceConfigurationsResultSize","sidebarTitle":"XblUserStatisticsGetMultipleUserStatisticsForMultipleServiceConfigurationsResultSize","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetmultipleuserstatisticsformultipleserviceconfigurationsresultsize"},{"title":"XblUserStatisticsGetMultipleUserStatisticsResult","description":"XblUserStatisticsGetMultipleUserStatisticsResult","sidebarTitle":"XblUserStatisticsGetMultipleUserStatisticsResult","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetmultipleuserstatisticsresult"},{"title":"XblUserStatisticsGetMultipleUserStatisticsResultSize","description":"XblUserStatisticsGetMultipleUserStatisticsResultSize","sidebarTitle":"XblUserStatisticsGetMultipleUserStatisticsResultSize","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetmultipleuserstatisticsresultsize"},{"title":"XblUserStatisticsGetSingleUserStatisticAsync","description":"XblUserStatisticsGetSingleUserStatisticAsync","sidebarTitle":"XblUserStatisticsGetSingleUserStatisticAsync","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticasync"},{"title":"XblUserStatisticsGetSingleUserStatisticResult","description":"XblUserStatisticsGetSingleUserStatisticResult","sidebarTitle":"XblUserStatisticsGetSingleUserStatisticResult","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticresult"},{"title":"XblUserStatisticsGetSingleUserStatisticResultSize","description":"XblUserStatisticsGetSingleUserStatisticResultSize","sidebarTitle":"XblUserStatisticsGetSingleUserStatisticResultSize","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticresultsize"},{"title":"XblUserStatisticsGetSingleUserStatisticsAsync","description":"XblUserStatisticsGetSingleUserStatisticsAsync","sidebarTitle":"XblUserStatisticsGetSingleUserStatisticsAsync","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticsasync"},{"title":"XblUserStatisticsGetSingleUserStatisticsResult","description":"XblUserStatisticsGetSingleUserStatisticsResult","sidebarTitle":"XblUserStatisticsGetSingleUserStatisticsResult","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticsresult"},{"title":"XblUserStatisticsGetSingleUserStatisticsResultSize","description":"XblUserStatisticsGetSingleUserStatisticsResultSize","sidebarTitle":"XblUserStatisticsGetSingleUserStatisticsResultSize","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticsresultsize"},{"title":"XblUserStatisticsRemoveStatisticChangedHandler","description":"XblUserStatisticsRemoveStatisticChangedHandler","sidebarTitle":"XblUserStatisticsRemoveStatisticChangedHandler","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsremovestatisticchangedhandler"},{"title":"XblUserStatisticsStopTrackingStatistics","description":"XblUserStatisticsStopTrackingStatistics","sidebarTitle":"XblUserStatisticsStopTrackingStatistics","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsstoptrackingstatistics"},{"title":"XblUserStatisticsStopTrackingUsers","description":"XblUserStatisticsStopTrackingUsers","sidebarTitle":"XblUserStatisticsStopTrackingUsers","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsstoptrackingusers"},{"title":"XblUserStatisticsTrackStatistics","description":"XblUserStatisticsTrackStatistics","sidebarTitle":"XblUserStatisticsTrackStatistics","href":"/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticstrackstatistics"}]},{"group":"Structs","pages":[{"title":"XblRequestedStatistics","description":"XblRequestedStatistics","sidebarTitle":"XblRequestedStatistics","href":"/reference/live/xsapi-c/user_statistics_c/structs/xblrequestedstatistics"},{"title":"XblServiceConfigurationStatistic","description":"XblServiceConfigurationStatistic","sidebarTitle":"XblServiceConfigurationStatistic","href":"/reference/live/xsapi-c/user_statistics_c/structs/xblserviceconfigurationstatistic"},{"title":"XblStatistic","description":"XblStatistic","sidebarTitle":"XblStatistic","href":"/reference/live/xsapi-c/user_statistics_c/structs/xblstatistic"},{"title":"XblStatisticChangeEventArgs","description":"XblStatisticChangeEventArgs","sidebarTitle":"XblStatisticChangeEventArgs","href":"/reference/live/xsapi-c/user_statistics_c/structs/xblstatisticchangeeventargs"},{"title":"XblUserStatisticsResult","description":"XblUserStatisticsResult","sidebarTitle":"XblUserStatisticsResult","href":"/reference/live/xsapi-c/user_statistics_c/structs/xbluserstatisticsresult"}]}]},{"group":"xbox_live_context_c","pages":[{"group":"Functions","pages":[{"title":"XblContextCloseHandle","description":"XblContextCloseHandle","sidebarTitle":"XblContextCloseHandle","href":"/reference/live/xsapi-c/xbox_live_context_c/functions/xblcontextclosehandle"},{"title":"XblContextCreateHandle","description":"XblContextCreateHandle","sidebarTitle":"XblContextCreateHandle","href":"/reference/live/xsapi-c/xbox_live_context_c/functions/xblcontextcreatehandle"},{"title":"XblContextDuplicateHandle","description":"XblContextDuplicateHandle","sidebarTitle":"XblContextDuplicateHandle","href":"/reference/live/xsapi-c/xbox_live_context_c/functions/xblcontextduplicatehandle"},{"title":"XblContextGetUser","description":"XblContextGetUser","sidebarTitle":"XblContextGetUser","href":"/reference/live/xsapi-c/xbox_live_context_c/functions/xblcontextgetuser"},{"title":"XblContextGetXboxUserId","description":"XblContextGetXboxUserId","sidebarTitle":"XblContextGetXboxUserId","href":"/reference/live/xsapi-c/xbox_live_context_c/functions/xblcontextgetxboxuserid"}]}]},{"group":"xbox_live_context_settings_c","pages":[{"group":"Functions","pages":[{"title":"XblContextSettingsGetHttpRetryDelay","description":"XblContextSettingsGetHttpRetryDelay","sidebarTitle":"XblContextSettingsGetHttpRetryDelay","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingsgethttpretrydelay"},{"title":"XblContextSettingsGetHttpTimeoutWindow","description":"XblContextSettingsGetHttpTimeoutWindow","sidebarTitle":"XblContextSettingsGetHttpTimeoutWindow","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingsgethttptimeoutwindow"},{"title":"XblContextSettingsGetLongHttpTimeout","description":"XblContextSettingsGetLongHttpTimeout","sidebarTitle":"XblContextSettingsGetLongHttpTimeout","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingsgetlonghttptimeout"},{"title":"XblContextSettingsGetUseCrossPlatformQosServers","description":"XblContextSettingsGetUseCrossPlatformQosServers","sidebarTitle":"XblContextSettingsGetUseCrossPlatformQosServers","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingsgetusecrossplatformqosservers"},{"title":"XblContextSettingsGetWebsocketTimeoutWindow","description":"XblContextSettingsGetWebsocketTimeoutWindow","sidebarTitle":"XblContextSettingsGetWebsocketTimeoutWindow","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingsgetwebsockettimeoutwindow"},{"title":"XblContextSettingsSetHttpRetryDelay","description":"XblContextSettingsSetHttpRetryDelay","sidebarTitle":"XblContextSettingsSetHttpRetryDelay","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingssethttpretrydelay"},{"title":"XblContextSettingsSetHttpTimeoutWindow","description":"XblContextSettingsSetHttpTimeoutWindow","sidebarTitle":"XblContextSettingsSetHttpTimeoutWindow","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingssethttptimeoutwindow"},{"title":"XblContextSettingsSetLongHttpTimeout","description":"XblContextSettingsSetLongHttpTimeout","sidebarTitle":"XblContextSettingsSetLongHttpTimeout","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingssetlonghttptimeout"},{"title":"XblContextSettingsSetUseCrossPlatformQosServers","description":"XblContextSettingsSetUseCrossPlatformQosServers","sidebarTitle":"XblContextSettingsSetUseCrossPlatformQosServers","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingssetusecrossplatformqosservers"},{"title":"XblContextSettingsSetWebsocketTimeoutWindow","description":"XblContextSettingsSetWebsocketTimeoutWindow","sidebarTitle":"XblContextSettingsSetWebsocketTimeoutWindow","href":"/reference/live/xsapi-c/xbox_live_context_settings_c/functions/xblcontextsettingssetwebsockettimeoutwindow"}]}]},{"group":"xbox_live_global_c","pages":[{"group":"Enums","pages":[{"title":"XblApiType","description":"XblApiType","sidebarTitle":"XblApiType","href":"/reference/live/xsapi-c/xbox_live_global_c/enums/xblapitype"},{"title":"XblConfigSetting","description":"XblConfigSetting","sidebarTitle":"XblConfigSetting","href":"/reference/live/xsapi-c/xbox_live_global_c/enums/xblconfigsetting"}]},{"group":"Functions","pages":[{"title":"XblAddServiceCallRoutedHandler","description":"XblAddServiceCallRoutedHandler","sidebarTitle":"XblAddServiceCallRoutedHandler","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xbladdservicecallroutedhandler"},{"title":"XblCleanupAsync","description":"XblCleanupAsync","sidebarTitle":"XblCleanupAsync","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblcleanupasync"},{"title":"XblDisableAssertsForXboxLiveThrottlingInDevSandboxes","description":"XblDisableAssertsForXboxLiveThrottlingInDevSandboxes","sidebarTitle":"XblDisableAssertsForXboxLiveThrottlingInDevSandboxes","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xbldisableassertsforxboxlivethrottlingindevsandboxes"},{"title":"XblGetAsyncQueue","description":"XblGetAsyncQueue","sidebarTitle":"XblGetAsyncQueue","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblgetasyncqueue"},{"title":"XblGetScid","description":"XblGetScid","sidebarTitle":"XblGetScid","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblgetscid"},{"title":"XblInitialize","description":"XblInitialize","sidebarTitle":"XblInitialize","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblinitialize"},{"title":"XblMemGetFunctions","description":"XblMemGetFunctions","sidebarTitle":"XblMemGetFunctions","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblmemgetfunctions"},{"title":"XblMemSetFunctions","description":"XblMemSetFunctions","sidebarTitle":"XblMemSetFunctions","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblmemsetfunctions"},{"title":"XblRemoveServiceCallRoutedHandler","description":"XblRemoveServiceCallRoutedHandler","sidebarTitle":"XblRemoveServiceCallRoutedHandler","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblremoveservicecallroutedhandler"},{"title":"XblSetApiType","description":"XblSetApiType","sidebarTitle":"XblSetApiType","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblsetapitype"},{"title":"XblSetOverrideConfiguration","description":"XblSetOverrideConfiguration","sidebarTitle":"XblSetOverrideConfiguration","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblsetoverrideconfiguration"},{"title":"XblSetOverrideLocale","description":"XblSetOverrideLocale","sidebarTitle":"XblSetOverrideLocale","href":"/reference/live/xsapi-c/xbox_live_global_c/functions/xblsetoverridelocale"}]},{"group":"Structs","pages":[{"title":"XblInitArgs","description":"XblInitArgs","sidebarTitle":"XblInitArgs","href":"/reference/live/xsapi-c/xbox_live_global_c/structs/xblinitargs"},{"title":"XblServiceCallRoutedArgs","description":"XblServiceCallRoutedArgs","sidebarTitle":"XblServiceCallRoutedArgs","href":"/reference/live/xsapi-c/xbox_live_global_c/structs/xblservicecallroutedargs"}]}]}]},{"title":"XBOX Live HRESULT error codes","description":"Complete list of HRESULT error codes returned by XBOX Live and XBOX services APIs, with names, hex, and decimal values for troubleshooting XSAPI titles.","sidebarTitle":"XBOX Live HRESULT Error Codes","href":"/reference/live/xbl-hresult-error-codes"},{"group":"REST","pages":[{"title":"XBOX services RESTful reference","description":"XBOX services RESTful reference","sidebarTitle":"XBOX services RESTful reference","href":"/reference/live/rest/atoc-xboxlivews-reference"},{"group":"Enums","pages":[{"title":"Enumerations Used In JavaScript Object Notation (JSON) Objects","description":"Enumerations Used In JavaScript Object Notation (JSON) Objects","sidebarTitle":"Enumerations Used In JavaScript Object Notation (JSON) Objects","href":"/reference/live/rest/enums/atoc-xboxlivews-reference-enums"},{"title":"GameClipSource Enumeration","description":"GameClipSource Enumeration","sidebarTitle":"GameClipSource Enumeration","href":"/reference/live/rest/enums/gvr-enum-gameclipsource"},{"title":"GameClipState Enumeration","description":"GameClipState Enumeration","sidebarTitle":"GameClipState Enumeration","href":"/reference/live/rest/enums/gvr-enum-gameclipstate"},{"title":"GameClipType Enumeration","description":"GameClipType Enumeration","sidebarTitle":"GameClipType Enumeration","href":"/reference/live/rest/enums/gvr-enum-gamecliptypes"},{"title":"GameClipUriType Enumeration","description":"GameClipUriType Enumeration","sidebarTitle":"GameClipUriType Enumeration","href":"/reference/live/rest/enums/gvr-enum-gameclipuritype"},{"title":"GameClipVisibility Enumeration","description":"GameClipVisibility Enumeration","sidebarTitle":"GameClipVisibility Enumeration","href":"/reference/live/rest/enums/gvr-enum-gameclipvisibility"},{"title":"ThumbnailSource Enumeration","description":"ThumbnailSource Enumeration","sidebarTitle":"ThumbnailSource Enumeration","href":"/reference/live/rest/enums/gvr-enum-thumbnailsource"},{"title":"ThumbnailType Enumeration","description":"ThumbnailType Enumeration","sidebarTitle":"ThumbnailType Enumeration","href":"/reference/live/rest/enums/gvr-enum-thumbnailtype"},{"title":"PermissionId Enumeration","description":"PermissionId Enumeration","sidebarTitle":"PermissionId Enumeration","href":"/reference/live/rest/enums/privacy-enum-permissionid"}]}]}]},{"group":"MicrosoftGame.config reference","pages":[{"title":"MicrosoftGame.config reference","description":"MicrosoftGame.config reference","sidebarTitle":"MicrosoftGame.config reference","href":"/reference/system/microsoftgameconfig/elements/gc-microsoftgameconfig-toc"},{"title":"MicrosoftGame.config additional reference","description":"MicrosoftGame.config additional reference","sidebarTitle":"MicrosoftGame.config additional reference","href":"/reference/system/microsoftgameconfig/microsoftgameconfig-schema"},{"title":"MicrosoftGame.config Element - AdvancedUserModel","description":"MicrosoftGame.config Element - AdvancedUserModel","sidebarTitle":"MicrosoftGame.config Element - AdvancedUserModel","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-advancedusermodel"},{"title":"MicrosoftGame.config Element - AllowedProducts","description":"MicrosoftGame.config Element - AllowedProducts","sidebarTitle":"MicrosoftGame.config Element - AllowedProducts","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-allowedproducts"},{"title":"MicrosoftGame.config Element - AllowedProduct","description":"MicrosoftGame.config Element - AllowedProduct","sidebarTitle":"MicrosoftGame.config Element - AllowedProduct","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-allowedproduct"},{"title":"MicrosoftGame.config Element - AssociatedFranchiseGameHubId","description":"MicrosoftGame.config Element - AssociatedFranchiseGameHubId","sidebarTitle":"MicrosoftGame.config Element - AssociatedFranchiseGameHubId","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-associatedfranchisegamehubid"},{"title":"MicrosoftGame.config Element - BlockBroadcast","description":"MicrosoftGame.config Element - BlockBroadcast","sidebarTitle":"MicrosoftGame.config Element - BlockBroadcast","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-blockbroadcast"},{"title":"MicrosoftGame.config Element - BlockGameDVR","description":"MicrosoftGame.config Element - BlockGameDVR","sidebarTitle":"MicrosoftGame.config Element - BlockGameDVR","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-blockgamedvr"},{"title":"MicrosoftGame.config Element - ContentIdOverride","description":"MicrosoftGame.config Element - ContentIdOverride","sidebarTitle":"MicrosoftGame.config Element - ContentIdOverride","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-contentidoverride"},{"title":"MicrosoftGame.config Element - CustomInstallActions","description":"MicrosoftGame.config Element - CustomInstallActions","sidebarTitle":"MicrosoftGame.config Element - CustomInstallActions","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-custominstallactions"},{"title":"MicrosoftGame.config Element - DebugNetworkPort","description":"MicrosoftGame.config Element - DebugNetworkPort","sidebarTitle":"MicrosoftGame.config Element - DebugNetworkPort","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-debugnetworkport"},{"title":"MicrosoftGame.config Element - DebugNetworkPortList","description":"MicrosoftGame.config Element - DebugNetworkPortList","sidebarTitle":"MicrosoftGame.config Element - DebugNetworkPortList","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-debugnetworkportlist"},{"title":"MicrosoftGame.config Element - Dependency","description":"MicrosoftGame.config Element - Dependency","sidebarTitle":"MicrosoftGame.config Element - Dependency","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-dependency"},{"title":"MicrosoftGame.config Element - DependencyList","description":"MicrosoftGame.config Element - DependencyList","sidebarTitle":"MicrosoftGame.config Element - DependencyList","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-dependencylist"},{"title":"MicrosoftGame.config Element - DesktopRegistration","description":"MicrosoftGame.config Element - DesktopRegistration","sidebarTitle":"MicrosoftGame.config Element - DesktopRegistration","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-desktopregistration"},{"title":"MicrosoftGame.config Element - DevelopmentOnly","description":"MicrosoftGame.config Element - DevelopmentOnly","sidebarTitle":"MicrosoftGame.config Element - DevelopmentOnly","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-developmentonly"},{"title":"MicrosoftGame.config Element - DisableFilesystemWriteVirtualization (DEPRECATED)","description":"MicrosoftGame.config Element - DisableFilesystemWriteVirtualization (DEPRECATED)","sidebarTitle":"MicrosoftGame.config Element - DisableFilesystemWriteVirtualization (DEPRECATED)","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-disablefilesystemwritevirtualization"},{"title":"MicrosoftGame.config Element - DisableRegistryWriteVirtualization (DEPRECATED)","description":"MicrosoftGame.config Element - DisableRegistryWriteVirtualization (DEPRECATED)","sidebarTitle":"MicrosoftGame.config Element - DisableRegistryWriteVirtualization (DEPRECATED)","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-disableregistrywritevirtualization"},{"title":"MicrosoftGame.config Element - DisplayName","description":"MicrosoftGame.config Element - DisplayName","sidebarTitle":"MicrosoftGame.config Element - DisplayName","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-displayname"},{"title":"MicrosoftGame.config Element - DlcCompatibility","description":"MicrosoftGame.config Element - DlcCompatibility","sidebarTitle":"MicrosoftGame.config Element - DlcCompatibility","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-dlccompatibility"},{"title":"MicrosoftGame.config Element - EditFlags","description":"MicrosoftGame.config Element - EditFlags","sidebarTitle":"MicrosoftGame.config Element - EditFlags","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-editflags"},{"title":"MicrosoftGame.config Element - EKBIDOverride","description":"MicrosoftGame.config Element - EKBIDOverride","sidebarTitle":"MicrosoftGame.config Element - EKBIDOverride","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-ekbidoverride"},{"title":"MicrosoftGame.config Element - EnableWritesToPackageRoot (DEPRECATED)","description":"MicrosoftGame.config Element - EnableWritesToPackageRoot (DEPRECATED)","sidebarTitle":"MicrosoftGame.config Element - EnableWritesToPackageRoot (DEPRECATED)","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-enablewritestopackageroot"},{"title":"MicrosoftGame.config Element - Executable","description":"MicrosoftGame.config Element - Executable","sidebarTitle":"MicrosoftGame.config Element - Executable","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-executable"},{"title":"MicrosoftGame.config Element - ExecutableList","description":"MicrosoftGame.config Element - ExecutableList","sidebarTitle":"MicrosoftGame.config Element - ExecutableList","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-executablelist"},{"title":"MicrosoftGame.config Element - ExtendedAttribute","description":"MicrosoftGame.config Element - ExtendedAttribute","sidebarTitle":"MicrosoftGame.config Element - ExtendedAttribute","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-extendedattribute"},{"title":"MicrosoftGame.config Element - ExtendedAttributeList","description":"MicrosoftGame.config Element - ExtendedAttributeList","sidebarTitle":"MicrosoftGame.config Element - ExtendedAttributeList","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-extendedattributelist"},{"title":"MicrosoftGame.config Element - FileTypeAssociation","description":"MicrosoftGame.config Element - FileTypeAssociation","sidebarTitle":"MicrosoftGame.config Element - FileTypeAssociation","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-filetypeassociation"},{"title":"MicrosoftGame.config Element - FileType","description":"MicrosoftGame.config Element - FileType","sidebarTitle":"MicrosoftGame.config Element - FileType","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-filetype"},{"title":"MicrosoftGame.config Element - Folder","description":"MicrosoftGame.config Element - Folder","sidebarTitle":"MicrosoftGame.config Element - Folder","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-folder"},{"title":"MicrosoftGame.config Element - FranchiseGameHubId","description":"MicrosoftGame.config Element - FranchiseGameHubId","sidebarTitle":"MicrosoftGame.config Element - FranchiseGameHubId","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-franchisegamehubid"},{"title":"MicrosoftGame.config Element - Game","description":"MicrosoftGame.config Element - Game","sidebarTitle":"MicrosoftGame.config Element - Game","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-game"},{"title":"MicrosoftGame.config Element - GameDVRSystemComponent","description":"MicrosoftGame.config Element - GameDVRSystemComponent","sidebarTitle":"MicrosoftGame.config Element - GameDVRSystemComponent","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-gamedvrsystemcomponent"},{"title":"MicrosoftGame.config Element - GameOsVersion","description":"MicrosoftGame.config Element - GameOsVersion","sidebarTitle":"MicrosoftGame.config Element - GameOsVersion","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-gameosversion"},{"title":"MicrosoftGame.config Element - GrowableToMB","description":"MicrosoftGame.config Element - GrowableToMB","sidebarTitle":"MicrosoftGame.config Element - GrowableToMB","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-growabletomb"},{"title":"MicrosoftGame.config Element - Identity","description":"MicrosoftGame.config Element - Identity","sidebarTitle":"MicrosoftGame.config Element - Identity","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-identity"},{"title":"MicrosoftGame.config Element - InfoTip","description":"MicrosoftGame.config Element - InfoTip","sidebarTitle":"MicrosoftGame.config Element - InfoTip","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-infotip"},{"title":"MicrosoftGame.config Element - InstallAction","description":"MicrosoftGame.config Element - InstallAction","sidebarTitle":"MicrosoftGame.config Element - InstallAction","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-installaction"},{"title":"MicrosoftGame.config Element - InstallActionList","description":"MicrosoftGame.config Element - InstallActionList","sidebarTitle":"MicrosoftGame.config Element - InstallActionList","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-installactionlist"},{"title":"MicrosoftGame.config Element - KnownDependency","description":"MicrosoftGame.config Element - KnownDependency","sidebarTitle":"MicrosoftGame.config Element - KnownDependency","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-knowndependency"},{"title":"MicrosoftGame.config Element - Logo","description":"MicrosoftGame.config Element - Logo","sidebarTitle":"MicrosoftGame.config Element - Logo","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-logo"},{"title":"MicrosoftGame.config Element - MainPackageDependency","description":"MicrosoftGame.config Element - MainPackageDependency","sidebarTitle":"MicrosoftGame.config Element - MainPackageDependency","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-mainpackagedependency"},{"title":"MicrosoftGame.config Element - ManifestUrl","description":"MicrosoftGame.config Element - ManifestUrl","sidebarTitle":"MicrosoftGame.config Element - ManifestUrl","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-manifesturl"},{"title":"MicrosoftGame.config Element - MaxUserQuota","description":"MicrosoftGame.config Element - MaxUserQuota","sidebarTitle":"MicrosoftGame.config Element - MaxUserQuota","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-maxuserquota"},{"title":"MicrosoftGame.config Element - MediaCapture","description":"MicrosoftGame.config Element - MediaCapture","sidebarTitle":"MicrosoftGame.config Element - MediaCapture","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-mediacapture"},{"title":"MicrosoftGame.config Element - ModFolder (DEPRECATED)","description":"MicrosoftGame.config Element - ModFolder (DEPRECATED)","sidebarTitle":"MicrosoftGame.config Element - ModFolder (DEPRECATED)","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-modfolder"},{"title":"MicrosoftGame.config Element - MSAAppId","description":"MicrosoftGame.config Element - MSAAppId","sidebarTitle":"MicrosoftGame.config Element - MSAAppId","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-msaappid"},{"title":"MicrosoftGame.config Element - MSAFullTrust","description":"MicrosoftGame.config Element - MSAFullTrust","sidebarTitle":"MicrosoftGame.config Element - MSAFullTrust","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-msafulltrust"},{"title":"MicrosoftGame.config Element - MultiplayerProtocol","description":"MicrosoftGame.config Element - MultiplayerProtocol","sidebarTitle":"MicrosoftGame.config Element - MultiplayerProtocol","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-multiplayerprotocol"},{"title":"MicrosoftGame.config Element - NoCodePCRoot","description":"MicrosoftGame.config Element - NoCodePCRoot","sidebarTitle":"MicrosoftGame.config Element - NoCodePCRoot","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-nocodepcroot"},{"title":"MicrosoftGame.config Element - PersistentLocalStorage","description":"MicrosoftGame.config Element - PersistentLocalStorage","sidebarTitle":"MicrosoftGame.config Element - PersistentLocalStorage","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-persistentlocalstorage"},{"title":"MicrosoftGame.config Element - ProcessorArchitecture","description":"MicrosoftGame.config Element - ProcessorArchitecture","sidebarTitle":"MicrosoftGame.config Element - ProcessorArchitecture","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-processorarchitecture"},{"title":"MicrosoftGame.config Element - Protocol","description":"MicrosoftGame.config Element - Protocol","sidebarTitle":"MicrosoftGame.config Element - Protocol","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-protocol"},{"title":"MicrosoftGame.config Element - ProtocolList","description":"MicrosoftGame.config Element - ProtocolList","sidebarTitle":"MicrosoftGame.config Element - ProtocolList","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-protocollist"},{"title":"MicrosoftGame.config Element - PublisherContent","description":"MicrosoftGame.config Element - PublisherContent","sidebarTitle":"MicrosoftGame.config Element - PublisherContent","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-publishercontent"},{"title":"MicrosoftGame.config Element - PublisherContentBaseProduct","description":"MicrosoftGame.config Element - PublisherContentBaseProduct","sidebarTitle":"MicrosoftGame.config Element - PublisherContentBaseProduct","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-publishercontentbaseproduct"},{"title":"MicrosoftGame.config Element - RelatedProduct","description":"MicrosoftGame.config Element - RelatedProduct","sidebarTitle":"MicrosoftGame.config Element - RelatedProduct","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-relatedproduct"},{"title":"MicrosoftGame.config Element - RelatedProducts","description":"MicrosoftGame.config Element - RelatedProducts","sidebarTitle":"MicrosoftGame.config Element - RelatedProducts","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-relatedproducts"},{"title":"MicrosoftGame.config Element - RepairAction","description":"MicrosoftGame.config Element - RepairAction","sidebarTitle":"MicrosoftGame.config Element - RepairAction","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-repairaction"},{"title":"MicrosoftGame.config Element - RepairActionList","description":"MicrosoftGame.config Element - RepairActionList","sidebarTitle":"MicrosoftGame.config Element - RepairActionList","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-repairactionlist"},{"title":"MicrosoftGame.config Element - RequiresEraShim","description":"MicrosoftGame.config Element - RequiresEraShim","sidebarTitle":"MicrosoftGame.config Element - RequiresEraShim","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-requireserashim"},{"title":"MicrosoftGame.config Element - RequiresXboxLive","description":"MicrosoftGame.config Element - RequiresXboxLive","sidebarTitle":"MicrosoftGame.config Element - RequiresXboxLive","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-requiresxboxlive"},{"title":"MicrosoftGame.config Element - Resource","description":"MicrosoftGame.config Element - Resource","sidebarTitle":"MicrosoftGame.config Element - Resource","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-resource"},{"title":"MicrosoftGame.config Element - Resources","description":"MicrosoftGame.config Element - Resources","sidebarTitle":"MicrosoftGame.config Element - Resources","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-resources"},{"title":"MicrosoftGame.config Element - SaveGameStorage","description":"MicrosoftGame.config Element - SaveGameStorage","sidebarTitle":"MicrosoftGame.config Element - SaveGameStorage","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-savegamestorage"},{"title":"MicrosoftGame.config Element - SCID","description":"MicrosoftGame.config Element - SCID","sidebarTitle":"MicrosoftGame.config Element - SCID","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-scid"},{"title":"MicrosoftGame.config Element - Shareable","description":"MicrosoftGame.config Element - Shareable","sidebarTitle":"MicrosoftGame.config Element - Shareable","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-shareable"},{"title":"MicrosoftGame.config Element - ShellVisuals","description":"MicrosoftGame.config Element - ShellVisuals","sidebarTitle":"MicrosoftGame.config Element - ShellVisuals","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-shellvisuals"},{"title":"MicrosoftGame.config Element - SizeMB","description":"MicrosoftGame.config Element - SizeMB","sidebarTitle":"MicrosoftGame.config Element - SizeMB","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-sizemb"},{"title":"MicrosoftGame.config Element - SMTEnabled","description":"MicrosoftGame.config Element - SMTEnabled","sidebarTitle":"MicrosoftGame.config Element - SMTEnabled","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-smtenabled"},{"title":"MicrosoftGame.config Element - StoreId","description":"MicrosoftGame.config Element - StoreId","sidebarTitle":"MicrosoftGame.config Element - StoreId","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-storeid"},{"title":"MicrosoftGame.config Element - SupportedFileTypes","description":"MicrosoftGame.config Element - SupportedFileTypes","sidebarTitle":"MicrosoftGame.config Element - SupportedFileTypes","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-supportedfiletypes"},{"title":"MicrosoftGame.config Element - TargetDeviceFamilyForDLC","description":"MicrosoftGame.config Element - TargetDeviceFamilyForDLC","sidebarTitle":"MicrosoftGame.config Element - TargetDeviceFamilyForDLC","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-targetdevicefamilyfordlc"},{"title":"MicrosoftGame.config Element - TitleId","description":"MicrosoftGame.config Element - TitleId","sidebarTitle":"MicrosoftGame.config Element - TitleId","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-titleid"},{"title":"MicrosoftGame.config Element - UninstallAction","description":"MicrosoftGame.config Element - UninstallAction","sidebarTitle":"MicrosoftGame.config Element - UninstallAction","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-uninstallaction"},{"title":"MicrosoftGame.config Element - UninstallActionList","description":"MicrosoftGame.config Element - UninstallActionList","sidebarTitle":"MicrosoftGame.config Element - UninstallActionList","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-uninstallactionlist"},{"title":"MicrosoftGame.config Element - VirtualMachine","description":"MicrosoftGame.config Element - VirtualMachine","sidebarTitle":"MicrosoftGame.config Element - VirtualMachine","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-virtualmachine"},{"title":"MicrosoftGame.config Element - XboxLockhartTitleMemory","description":"MicrosoftGame.config Element - XboxLockhartTitleMemory","sidebarTitle":"MicrosoftGame.config Element - XboxLockhartTitleMemory","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-xboxlockharttitlememory"},{"title":"MicrosoftGame.config Element - XboxAnacondaTitleMemory","description":"MicrosoftGame.config Element - XboxAnacondaTitleMemory","sidebarTitle":"MicrosoftGame.config Element - XboxAnacondaTitleMemory","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-xboxanacondatitlememory"},{"title":"MicrosoftGame.config Element - XboxCompatibility","description":"MicrosoftGame.config Element - XboxCompatibility","sidebarTitle":"MicrosoftGame.config Element - XboxCompatibility","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-xboxcompatibility"},{"title":"MicrosoftGame.config Element - XboxOneXTitleMemory","description":"MicrosoftGame.config Element - XboxOneXTitleMemory","sidebarTitle":"MicrosoftGame.config Element - XboxOneXTitleMemory","href":"/reference/system/microsoftgameconfig/elements/microsoftgameconfig-element-xboxonextitlememory"}]}]},{"tab":"PlayFab APIs","groups":[{"group":"PlayFab API","icon":"server","pages":[{"title":"PlayFab REST API reference overview","description":"Overview of the PlayFab REST API reference, including endpoints, request and response formats, authentication, and how each API section is structured.","sidebarTitle":"Overview","href":"/services/playfab/api-references"},{"title":"API Access Policy","description":"Describes how to use the API access policies in PlayFab.","sidebarTitle":"API access policy","href":"/services/playfab/api-references/api-access-policy"},{"title":"Global API Method Error Codes","description":"Lists the global error codes that apply to every PlayFab API method.","sidebarTitle":"Global API method error codes","href":"/services/playfab/api-references/global-api-method-error-codes"},{"title":"HTTP response status codes","description":"HTTP response status codes.","href":"/services/playfab/api-references/http-response-status-codes"},{"group":"C","pages":[{"title":"PlayFab Services C API reference","description":"Reference documentation for the PlayFab Services C API, organized by API group, with links to installation and SDK programming guidance for the GDK.","href":"/services/playfab/api-references/c/index"},{"group":"PFAccountManagement","pages":[{"title":"Services C API overview - PFAccountManagement.h","description":"Services C API overview - PFAccountManagement.h","sidebarTitle":"PFAccountManagement","href":"/services/playfab/api-references/c/pfaccountmanagement/pfaccountmanagement_members"},{"group":"Functions","pages":[{"title":"PFAccountManagementClientAddOrUpdateContactEmailAsync","description":"Adds or updates a contact email to the player's profile.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientaddorupdatecontactemailasync"},{"title":"PFAccountManagementClientAddUsernamePasswordAsync","description":"Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientaddusernamepasswordasync"},{"title":"PFAccountManagementClientAddUsernamePasswordGetResult","description":"Gets the result of a successful PFAccountManagementClientAddUsernamePasswordAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientaddusernamepasswordgetresult"},{"title":"PFAccountManagementClientAddUsernamePasswordGetResultSize","description":"Get the size in bytes needed to store the result of a ClientAddUsernamePassword call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientaddusernamepasswordgetresultsize"},{"title":"PFAccountManagementClientGetAccountInfoAsync","description":"Retrieves the user's PlayFab account details","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetaccountinfoasync"},{"title":"PFAccountManagementClientGetAccountInfoGetResult","description":"Gets the result of a successful PFAccountManagementClientGetAccountInfoAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetaccountinfogetresult"},{"title":"PFAccountManagementClientGetAccountInfoGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetAccountInfo call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetaccountinfogetresultsize"},{"title":"PFAccountManagementClientGetPlayerCombinedInfoAsync","description":"Retrieves all of the user's different kinds of info.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayercombinedinfoasync"},{"title":"PFAccountManagementClientGetPlayerCombinedInfoGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayerCombinedInfoAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayercombinedinfogetresult"},{"title":"PFAccountManagementClientGetPlayerCombinedInfoGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayerCombinedInfo call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayercombinedinfogetresultsize"},{"title":"PFAccountManagementClientGetPlayerProfileAsync","description":"Client API to retrieve a PlayFab player's profile, including display name, avatar URL, statistics, and linked account details from the authenticated player.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayerprofileasync"},{"title":"PFAccountManagementClientGetPlayerProfileGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayerProfileAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayerprofilegetresult"},{"title":"PFAccountManagementClientGetPlayerProfileGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayerProfile call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayerprofilegetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromBattleNetAccountIdsAsync","description":"Client API that looks up PlayFab IDs for a set of Battle.net account identifiers, authenticated with an entity handle. Available on all platforms.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfrombattlenetaccountidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromBattleNetAccountIdsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromBattleNetAccountIdsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfrombattlenetaccountidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromBattleNetAccountIdsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromBattleNetAccountIds call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfrombattlenetaccountidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromFacebookIDsAsync","description":"Client API to look up PlayFab IDs for a set of Facebook user IDs, letting titles map Facebook social identifiers to PlayFab player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromfacebookidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromFacebookIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromFacebookIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromfacebookidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromFacebookIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromFacebookIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromfacebookidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromFacebookInstantGamesIdsAsync","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromfacebookinstantgamesidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromFacebookInstantGamesIdsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromFacebookInstantGamesIdsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromfacebookinstantgamesidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromFacebookInstantGamesIdsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromFacebookInstantGamesIds call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromfacebookinstantgamesidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromGameCenterIDsAsync","description":"Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromgamecenteridsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromGameCenterIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromGameCenterIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromgamecenteridsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromGameCenterIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromGameCenterIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromgamecenteridsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromGoogleIDsAsync","description":"Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as 'id'.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromgoogleidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromGoogleIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromGoogleIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromgoogleidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromGoogleIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromGoogleIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromgoogleidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromGooglePlayGamesPlayerIDsAsync","description":"Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games identifiers are the IDs for the user.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromgoogleplaygamesplayeridsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromGooglePlayGamesPlayerIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromGooglePlayGamesPlayerIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromgoogleplaygamesplayeridsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromGooglePlayGamesPlayerIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromGooglePlayGamesPlayerIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromgoogleplaygamesplayeridsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromKongregateIDsAsync","description":"Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromkongregateidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromKongregateIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromKongregateIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromkongregateidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromKongregateIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromKongregateIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromkongregateidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromNintendoServiceAccountIdsAsync","description":"Client API to look up PlayFab IDs for a set of Nintendo Service Account identifiers, mapping Nintendo Switch account IDs to PlayFab player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromnintendoserviceaccountidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromNintendoServiceAccountIdsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromNintendoServiceAccountIdsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromnintendoserviceaccountidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromNintendoServiceAccountIdsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromNintendoServiceAccountIds call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromnintendoserviceaccountidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromNintendoSwitchDeviceIdsAsync","description":"Client API to look up PlayFab IDs for a set of Nintendo Switch device identifiers, letting titles resolve Switch device IDs to PlayFab player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromnintendoswitchdeviceidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromNintendoSwitchDeviceIdsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromNintendoSwitchDeviceIdsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromnintendoswitchdeviceidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromNintendoSwitchDeviceIdsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromNintendoSwitchDeviceIds call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromnintendoswitchdeviceidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromPSNAccountIDsAsync","description":"Client API to look up PlayFab IDs for a set of PlayStation Network account IDs, letting titles resolve PSN identifiers to PlayFab player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfrompsnaccountidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromPSNAccountIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromPSNAccountIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfrompsnaccountidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromPSNAccountIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromPSNAccountIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfrompsnaccountidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromPSNOnlineIDsAsync","description":"Client API that looks up PlayFab IDs for a set of PlayStation Network online IDs, authenticated with an entity handle. Available on all platforms.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfrompsnonlineidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromPSNOnlineIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromPSNOnlineIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfrompsnonlineidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromPSNOnlineIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromPSNOnlineIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfrompsnonlineidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromSteamIDsAsync","description":"Client API to look up PlayFab IDs for a set of Steam profile IDs (SteamId), letting titles resolve Steamworks identifiers to PlayFab player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromsteamidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromSteamIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromSteamIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromsteamidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromSteamIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromSteamIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromsteamidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromSteamNamesAsync","description":"Client API that looks up PlayFab IDs for a set of Steam persona names, authenticated with an entity handle. Available on all platforms.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromsteamnamesasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromSteamNamesGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromSteamNamesAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromsteamnamesgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromSteamNamesGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromSteamNames call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromsteamnamesgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromTwitchIDsAsync","description":"Client API to look up PlayFab IDs for a set of Twitch user IDs, letting titles map Twitch account identifiers to PlayFab player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromtwitchidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromTwitchIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromTwitchIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromtwitchidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromTwitchIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromTwitchIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromtwitchidsgetresultsize"},{"title":"PFAccountManagementClientGetPlayFabIDsFromXboxLiveIDsAsync","description":"Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromxboxliveidsasync"},{"title":"PFAccountManagementClientGetPlayFabIDsFromXboxLiveIDsGetResult","description":"Gets the result of a successful PFAccountManagementClientGetPlayFabIDsFromXboxLiveIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromxboxliveidsgetresult"},{"title":"PFAccountManagementClientGetPlayFabIDsFromXboxLiveIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayFabIDsFromXboxLiveIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientgetplayfabidsfromxboxliveidsgetresultsize"},{"title":"PFAccountManagementClientLinkAndroidDeviceIDAsync","description":"Links the Android device identifier to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkandroiddeviceidasync"},{"title":"PFAccountManagementClientLinkAppleAsync","description":"Links the Apple account associated with the token to the user's PlayFab account.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkappleasync"},{"title":"PFAccountManagementClientLinkBattleNetAccountAsync","description":"Client API that links the Battle.net account tied to a token to the user's PlayFab account on Windows. See also ClientLoginWithBattleNetAsync.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkbattlenetaccountasync"},{"title":"PFAccountManagementClientLinkCustomIDAsync","description":"Links the custom identifier, generated by the title, to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkcustomidasync"},{"title":"PFAccountManagementClientLinkFacebookAccountAsync","description":"Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkfacebookaccountasync"},{"title":"PFAccountManagementClientLinkFacebookInstantGamesIdAsync","description":"Links the Facebook Instant Games Id to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkfacebookinstantgamesidasync"},{"title":"PFAccountManagementClientLinkGameCenterAccountAsync","description":"Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkgamecenteraccountasync"},{"title":"PFAccountManagementClientLinkGoogleAccountAsync","description":"Links the currently signed-in user account to their Google account, using their Google account credentials","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkgoogleaccountasync"},{"title":"PFAccountManagementClientLinkGooglePlayGamesServicesAccountAsync","description":"Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account credentials","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkgoogleplaygamesservicesaccountasync"},{"title":"PFAccountManagementClientLinkIOSDeviceIDAsync","description":"Links the vendor-specific iOS device identifier to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkiosdeviceidasync"},{"title":"PFAccountManagementClientLinkKongregateAsync","description":"Links the Kongregate identifier to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkkongregateasync"},{"title":"PFAccountManagementClientLinkNintendoServiceAccountAsync","description":"Links the Nintendo account associated with the token to the user's PlayFab account.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinknintendoserviceaccountasync"},{"title":"PFAccountManagementClientLinkNintendoSwitchDeviceIdAsync","description":"Links the NintendoSwitchDeviceId to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinknintendoswitchdeviceidasync"},{"title":"PFAccountManagementClientLinkOpenIdConnectAsync","description":"Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an Open ID Connect provider and the OpenId Connect JWT from that provider.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkopenidconnectasync"},{"title":"PFAccountManagementClientLinkPSNAccountAsync","description":"Client API that links a PlayStation Network account to the user's PlayFab account using an access code. Available on PlayStation, Linux, and macOS.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkpsnaccountasync"},{"title":"PFAccountManagementClientLinkSteamAccountAsync","description":"Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinksteamaccountasync"},{"title":"PFAccountManagementClientLinkTwitchAsync","description":"Links the Twitch account associated with the token to the user's PlayFab account.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinktwitchasync"},{"title":"PFAccountManagementClientLinkXboxAccountAsync","description":"Links the XBOX Live account associated with the provided access code to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientlinkxboxaccountasync"},{"title":"PFAccountManagementClientRemoveContactEmailAsync","description":"Removes a contact email from the player's profile.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientremovecontactemailasync"},{"title":"PFAccountManagementClientReportPlayerAsync","description":"Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientreportplayerasync"},{"title":"PFAccountManagementClientReportPlayerGetResult","description":"Gets the result of a successful PFAccountManagementClientReportPlayerAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientreportplayergetresult"},{"title":"PFAccountManagementClientSendAccountRecoveryEmailAsync","description":"Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientsendaccountrecoveryemailasync"},{"title":"PFAccountManagementClientUnlinkAndroidDeviceIDAsync","description":"Unlinks the related Android device identifier from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkandroiddeviceidasync"},{"title":"PFAccountManagementClientUnlinkAppleAsync","description":"Unlinks the related Apple account from the user's PlayFab account.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkappleasync"},{"title":"PFAccountManagementClientUnlinkBattleNetAccountAsync","description":"Client API that unlinks the related Battle.net account from the user's PlayFab account on Windows. Possible errors include E_PF_ACCOUNT_NOT_LINKED.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkbattlenetaccountasync"},{"title":"PFAccountManagementClientUnlinkCustomIDAsync","description":"Unlinks the related custom identifier from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkcustomidasync"},{"title":"PFAccountManagementClientUnlinkFacebookAccountAsync","description":"Unlinks the related Facebook account from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkfacebookaccountasync"},{"title":"PFAccountManagementClientUnlinkFacebookInstantGamesIdAsync","description":"Unlinks the related Facebook Instant Game Ids from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkfacebookinstantgamesidasync"},{"title":"PFAccountManagementClientUnlinkGameCenterAccountAsync","description":"Unlinks the related Game Center account from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkgamecenteraccountasync"},{"title":"PFAccountManagementClientUnlinkGoogleAccountAsync","description":"Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkgoogleaccountasync"},{"title":"PFAccountManagementClientUnlinkGooglePlayGamesServicesAccountAsync","description":"Unlinks the related Google Play Games account from the user's PlayFab account.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkgoogleplaygamesservicesaccountasync"},{"title":"PFAccountManagementClientUnlinkIOSDeviceIDAsync","description":"Unlinks the related iOS device identifier from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkiosdeviceidasync"},{"title":"PFAccountManagementClientUnlinkKongregateAsync","description":"Unlinks the related Kongregate identifier from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkkongregateasync"},{"title":"PFAccountManagementClientUnlinkNintendoServiceAccountAsync","description":"Unlinks the related Nintendo account from the user's PlayFab account.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinknintendoserviceaccountasync"},{"title":"PFAccountManagementClientUnlinkNintendoSwitchDeviceIdAsync","description":"Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinknintendoswitchdeviceidasync"},{"title":"PFAccountManagementClientUnlinkOpenIdConnectAsync","description":"Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship between a title and an Open ID.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkopenidconnectasync"},{"title":"PFAccountManagementClientUnlinkPSNAccountAsync","description":"Unlinks the related PlayStation :tm: Network account from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkpsnaccountasync"},{"title":"PFAccountManagementClientUnlinkSteamAccountAsync","description":"Unlinks the related Steam account from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinksteamaccountasync"},{"title":"PFAccountManagementClientUnlinkTwitchAsync","description":"Unlinks the related Twitch account from the user's PlayFab account.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinktwitchasync"},{"title":"PFAccountManagementClientUnlinkXboxAccountAsync","description":"Unlinks the related XBOX Live account from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientunlinkxboxaccountasync"},{"title":"PFAccountManagementClientUpdateAvatarUrlAsync","description":"Update the avatar URL of the player","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientupdateavatarurlasync"},{"title":"PFAccountManagementClientUpdateUserTitleDisplayNameAsync","description":"Updates the title specific display name for the user","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientupdateusertitledisplaynameasync"},{"title":"PFAccountManagementClientUpdateUserTitleDisplayNameGetResult","description":"Gets the result of a successful PFAccountManagementClientUpdateUserTitleDisplayNameAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientupdateusertitledisplaynamegetresult"},{"title":"PFAccountManagementClientUpdateUserTitleDisplayNameGetResultSize","description":"Get the size in bytes needed to store the result of a ClientUpdateUserTitleDisplayName call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientupdateusertitledisplaynamegetresultsize"},{"title":"PFAccountManagementGetTitlePlayersFromXboxLiveIDsAsync","description":"Retrieves the title player accounts associated with the given XUIDs.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementgettitleplayersfromxboxliveidsasync"},{"title":"PFAccountManagementGetTitlePlayersFromXboxLiveIDsGetResult","description":"Gets the result of a successful PFAccountManagementGetTitlePlayersFromXboxLiveIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementgettitleplayersfromxboxliveidsgetresult"},{"title":"PFAccountManagementGetTitlePlayersFromXboxLiveIDsGetResultSize","description":"Get the size in bytes needed to store the result of a GetTitlePlayersFromXboxLiveIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementgettitleplayersfromxboxliveidsgetresultsize"},{"title":"PFAccountManagementServerBanUsersAsync","description":"Bans users by PlayFab ID with optional IP address for the provided game.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverbanusersasync"},{"title":"PFAccountManagementServerBanUsersGetResult","description":"Gets the result of a successful PFAccountManagementServerBanUsersAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverbanusersgetresult"},{"title":"PFAccountManagementServerBanUsersGetResultSize","description":"Get the size in bytes needed to store the result of a ServerBanUsers call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverbanusersgetresultsize"},{"title":"PFAccountManagementServerDeletePlayerAsync","description":"Removes a user's player account from a title and deletes all associated data","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverdeleteplayerasync"},{"title":"PFAccountManagementServerGetPlayerCombinedInfoAsync","description":"Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayercombinedinfoasync"},{"title":"PFAccountManagementServerGetPlayerCombinedInfoGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayerCombinedInfoAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayercombinedinfogetresult"},{"title":"PFAccountManagementServerGetPlayerCombinedInfoGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayerCombinedInfo call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayercombinedinfogetresultsize"},{"title":"PFAccountManagementServerGetPlayerProfileAsync","description":"Server API to retrieve any PlayFab player's profile by PlayFab ID, including display name, avatar URL, statistics, and linked account information.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayerprofileasync"},{"title":"PFAccountManagementServerGetPlayerProfileGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayerProfileAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayerprofilegetresult"},{"title":"PFAccountManagementServerGetPlayerProfileGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayerProfile call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayerprofilegetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromBattleNetAccountIdsAsync","description":"Server API for Windows that looks up PlayFab IDs for a set of Battle.net account identifiers, authenticated with a title entity handle.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfrombattlenetaccountidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromBattleNetAccountIdsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromBattleNetAccountIdsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfrombattlenetaccountidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromBattleNetAccountIdsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromBattleNetAccountIds call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfrombattlenetaccountidsgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromFacebookIDsAsync","description":"Server API to look up PlayFab IDs for a set of Facebook user IDs, letting game servers map Facebook social identifiers to PlayFab player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromfacebookidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromFacebookIDsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromFacebookIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromfacebookidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromFacebookIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromFacebookIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromfacebookidsgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromFacebookInstantGamesIdsAsync","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromfacebookinstantgamesidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromFacebookInstantGamesIdsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromFacebookInstantGamesIdsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromfacebookinstantgamesidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromFacebookInstantGamesIdsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromFacebookInstantGamesIds call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromfacebookinstantgamesidsgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromNintendoServiceAccountIdsAsync","description":"Server API to look up PlayFab IDs for a set of Nintendo Service Account identifiers, mapping Nintendo Switch account IDs to PlayFab player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromnintendoserviceaccountidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromNintendoServiceAccountIdsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromNintendoServiceAccountIdsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromnintendoserviceaccountidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromNintendoServiceAccountIdsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromNintendoServiceAccountIds call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromnintendoserviceaccountidsgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromNintendoSwitchDeviceIdsAsync","description":"Server API to look up PlayFab IDs for a set of Nintendo Switch device identifiers, letting game servers resolve Switch device IDs to PlayFab accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromnintendoswitchdeviceidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromNintendoSwitchDeviceIdsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromNintendoSwitchDeviceIdsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromnintendoswitchdeviceidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromNintendoSwitchDeviceIdsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromNintendoSwitchDeviceIds call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromnintendoswitchdeviceidsgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromPSNAccountIDsAsync","description":"Server API to look up PlayFab IDs for a set of PlayStation Network account IDs, letting game servers resolve PSN identifiers to PlayFab accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfrompsnaccountidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromPSNAccountIDsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromPSNAccountIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfrompsnaccountidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromPSNAccountIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromPSNAccountIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfrompsnaccountidsgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromPSNOnlineIDsAsync","description":"Server API for Windows that looks up PlayFab IDs for a set of PlayStation Network online IDs, authenticated with a title entity handle.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfrompsnonlineidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromPSNOnlineIDsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromPSNOnlineIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfrompsnonlineidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromPSNOnlineIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromPSNOnlineIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfrompsnonlineidsgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromSteamIDsAsync","description":"Server API to look up PlayFab IDs for a set of Steam profile IDs (SteamId), letting game servers resolve Steamworks identifiers to PlayFab accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromsteamidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromSteamIDsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromSteamIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromsteamidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromSteamIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromSteamIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromsteamidsgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromSteamNamesAsync","description":"Server API for Windows that looks up PlayFab IDs for a set of Steam persona names, authenticated with a title entity handle from a secret key.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromsteamnamesasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromSteamNamesGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromSteamNamesAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromsteamnamesgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromSteamNamesGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromSteamNames call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromsteamnamesgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromTwitchIDsAsync","description":"Server API to look up PlayFab IDs for a set of Twitch user IDs, letting game servers map Twitch account identifiers to PlayFab player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromtwitchidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromTwitchIDsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromTwitchIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromtwitchidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromTwitchIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromTwitchIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromtwitchidsgetresultsize"},{"title":"PFAccountManagementServerGetPlayFabIDsFromXboxLiveIDsAsync","description":"Server API to look up PlayFab IDs for a set of XBOX Live identifiers, letting game servers map XBOX Live XUIDs to PlayFab accounts.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromxboxliveidsasync"},{"title":"PFAccountManagementServerGetPlayFabIDsFromXboxLiveIDsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetPlayFabIDsFromXboxLiveIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromxboxliveidsgetresult"},{"title":"PFAccountManagementServerGetPlayFabIDsFromXboxLiveIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayFabIDsFromXboxLiveIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetplayfabidsfromxboxliveidsgetresultsize"},{"title":"PFAccountManagementServerGetServerCustomIDsFromPlayFabIDsAsync","description":"Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetservercustomidsfromplayfabidsasync"},{"title":"PFAccountManagementServerGetServerCustomIDsFromPlayFabIDsGetResult","description":"Gets the result of a successful PFAccountManagementServerGetServerCustomIDsFromPlayFabIDsAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetservercustomidsfromplayfabidsgetresult"},{"title":"PFAccountManagementServerGetServerCustomIDsFromPlayFabIDsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetServerCustomIDsFromPlayFabIDs call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetservercustomidsfromplayfabidsgetresultsize"},{"title":"PFAccountManagementServerGetUserAccountInfoAsync","description":"Retrieves the relevant details for a specified user","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetuseraccountinfoasync"},{"title":"PFAccountManagementServerGetUserAccountInfoGetResult","description":"Gets the result of a successful PFAccountManagementServerGetUserAccountInfoAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetuseraccountinfogetresult"},{"title":"PFAccountManagementServerGetUserAccountInfoGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetUserAccountInfo call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetuseraccountinfogetresultsize"},{"title":"PFAccountManagementServerGetUserBansAsync","description":"Gets all bans for a user.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetuserbansasync"},{"title":"PFAccountManagementServerGetUserBansGetResult","description":"Gets the result of a successful PFAccountManagementServerGetUserBansAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetuserbansgetresult"},{"title":"PFAccountManagementServerGetUserBansGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetUserBans call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementservergetuserbansgetresultsize"},{"title":"PFAccountManagementServerLinkBattleNetAccountAsync","description":"Server API for Windows that links a Battle.net account to a user's PlayFab account, authenticated with a title entity handle obtained from a secret key.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverlinkbattlenetaccountasync"},{"title":"PFAccountManagementServerLinkNintendoServiceAccountAsync","description":"Links the Nintendo account associated with the token to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverlinknintendoserviceaccountasync"},{"title":"PFAccountManagementServerLinkNintendoServiceAccountSubjectAsync","description":"Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverlinknintendoserviceaccountsubjectasync"},{"title":"PFAccountManagementServerLinkNintendoSwitchDeviceIdAsync","description":"Server API to link a Nintendo Switch device identifier to a specified PlayFab player account so the device can sign in on future sessions.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverlinknintendoswitchdeviceidasync"},{"title":"PFAccountManagementServerLinkPSNAccountAsync","description":"Server API that links a PlayStation Network account to a user's PlayFab account via an access code and title entity handle on Windows, Linux, and macOS.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverlinkpsnaccountasync"},{"title":"PFAccountManagementServerLinkPSNIdAsync","description":"Links the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverlinkpsnidasync"},{"title":"PFAccountManagementServerLinkServerCustomIdAsync","description":"Links the custom server identifier, generated by the title, to the user's PlayFab account.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverlinkservercustomidasync"},{"title":"PFAccountManagementServerLinkSteamIdAsync","description":"Links the Steam account associated with the provided Steam ID to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverlinksteamidasync"},{"title":"PFAccountManagementServerLinkXboxAccountAsync","description":"Server API to link the XBOX Live account for a provided access token to a specified PlayFab player account for cross-session sign-in.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverlinkxboxaccountasync"},{"title":"PFAccountManagementServerRevokeAllBansForUserAsync","description":"Revoke all active bans for a user.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverrevokeallbansforuserasync"},{"title":"PFAccountManagementServerRevokeAllBansForUserGetResult","description":"Gets the result of a successful PFAccountManagementServerRevokeAllBansForUserAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverrevokeallbansforusergetresult"},{"title":"PFAccountManagementServerRevokeAllBansForUserGetResultSize","description":"Get the size in bytes needed to store the result of a ServerRevokeAllBansForUser call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverrevokeallbansforusergetresultsize"},{"title":"PFAccountManagementServerRevokeBansAsync","description":"Revoke all active bans specified with BanId.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverrevokebansasync"},{"title":"PFAccountManagementServerRevokeBansGetResult","description":"Gets the result of a successful PFAccountManagementServerRevokeBansAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverrevokebansgetresult"},{"title":"PFAccountManagementServerRevokeBansGetResultSize","description":"Get the size in bytes needed to store the result of a ServerRevokeBans call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverrevokebansgetresultsize"},{"title":"PFAccountManagementServerSendCustomAccountRecoveryEmailAsync","description":"Forces an email to be sent to the registered contact email address for the user's account based on an account recovery email template","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserversendcustomaccountrecoveryemailasync"},{"title":"PFAccountManagementServerSendEmailFromTemplateAsync","description":"Sends an email based on an email template to a player's contact email","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserversendemailfromtemplateasync"},{"title":"PFAccountManagementServerUnlinkBattleNetAccountAsync","description":"Server API that unlinks a Battle.net account from a user's PlayFab account, authenticated with a title entity handle. Available on Windows only.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverunlinkbattlenetaccountasync"},{"title":"PFAccountManagementServerUnlinkNintendoServiceAccountAsync","description":"Unlinks the related Nintendo account from the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverunlinknintendoserviceaccountasync"},{"title":"PFAccountManagementServerUnlinkNintendoSwitchDeviceIdAsync","description":"Server API to unlink a Nintendo Switch device identifier from a specified PlayFab player account so the device can no longer sign in as that player.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverunlinknintendoswitchdeviceidasync"},{"title":"PFAccountManagementServerUnlinkPSNAccountAsync","description":"Server API to unlink the PlayStation Network account from a specified PlayFab player account, removing PSN as a sign-in option for that player.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverunlinkpsnaccountasync"},{"title":"PFAccountManagementServerUnlinkServerCustomIdAsync","description":"Unlinks the custom server identifier from the user's PlayFab account.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverunlinkservercustomidasync"},{"title":"PFAccountManagementServerUnlinkSteamIdAsync","description":"Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverunlinksteamidasync"},{"title":"PFAccountManagementServerUnlinkXboxAccountAsync","description":"Server API to unlink the XBOX Live account from a specified PlayFab player account, removing XBOX Live as a sign-in option for that player.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverunlinkxboxaccountasync"},{"title":"PFAccountManagementServerUpdateAvatarUrlAsync","description":"Update the avatar URL of the specified player","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverupdateavatarurlasync"},{"title":"PFAccountManagementServerUpdateBansAsync","description":"Updates information of a list of existing bans specified with Ban Ids.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverupdatebansasync"},{"title":"PFAccountManagementServerUpdateBansGetResult","description":"Gets the result of a successful PFAccountManagementServerUpdateBansAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverupdatebansgetresult"},{"title":"PFAccountManagementServerUpdateBansGetResultSize","description":"Get the size in bytes needed to store the result of a ServerUpdateBans call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementserverupdatebansgetresultsize"},{"title":"PFAccountManagementSetDisplayNameAsync","description":"Update the display name of the entity","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementsetdisplaynameasync"},{"title":"PFAccountManagementSetDisplayNameGetResult","description":"Gets the result of a successful PFAccountManagementSetDisplayNameAsync call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementsetdisplaynamegetresult"},{"title":"PFAccountManagementSetDisplayNameGetResultSize","description":"Get the size in bytes needed to store the result of a SetDisplayName call.","href":"/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementsetdisplaynamegetresultsize"}]}]},{"group":"PFAccountManagementTypes","pages":[{"title":"Services C API overview - PFAccountManagementTypes.h","description":"Services C API overview - PFAccountManagementTypes.h","sidebarTitle":"PFAccountManagementTypes","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/pfaccountmanagementtypes_members"},{"group":"Enums","pages":[{"title":"PFAccountManagementUserFamilyType","description":"UserFamilyType enum.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/enums/pfaccountmanagementuserfamilytype"}]},{"group":"Structs","pages":[{"title":"PFAccountManagementAddOrUpdateContactEmailRequest","description":"PFAccountManagementAddOrUpdateContactEmailRequest data model. This API adds a contact email to the player's profile. If the player's profile already contains.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementaddorupdatecontactemailrequest"},{"title":"PFAccountManagementAddUsernamePasswordRequest","description":"PFAccountManagementAddUsernamePasswordRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementaddusernamepasswordrequest"},{"title":"PFAccountManagementAddUsernamePasswordResult","description":"PFAccountManagementAddUsernamePasswordResult data model. Each account must have a unique username and email address in the PlayFab service.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementaddusernamepasswordresult"},{"title":"PFAccountManagementBanInfo","description":"PFAccountManagementBanInfo data model. Contains information for a ban.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementbaninfo"},{"title":"PFAccountManagementBanRequest","description":"PFAccountManagementBanRequest data model. Represents a single ban request.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementbanrequest"},{"title":"PFAccountManagementBanUsersRequest","description":"PFAccountManagementBanUsersRequest data model. The existence of each user will not be verified. When banning by IP, multiple players may be affected, so use.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementbanusersrequest"},{"title":"PFAccountManagementBanUsersResult","description":"PFAccountManagementBanUsersResult data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementbanusersresult"},{"title":"PFAccountManagementBattleNetAccountPlayFabIdPair","description":"PFAccountManagementBattleNetAccountPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementbattlenetaccountplayfabidpair"},{"title":"PFAccountManagementClientLinkBattleNetAccountRequest","description":"PFAccountManagementClientLinkBattleNetAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientlinkbattlenetaccountrequest"},{"title":"PFAccountManagementClientLinkNintendoServiceAccountRequest","description":"PFAccountManagementClientLinkNintendoServiceAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientlinknintendoserviceaccountrequest"},{"title":"PFAccountManagementClientLinkNintendoSwitchDeviceIdRequest","description":"PFAccountManagementClientLinkNintendoSwitchDeviceIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientlinknintendoswitchdeviceidrequest"},{"title":"PFAccountManagementClientLinkPSNAccountRequest","description":"PFAccountManagementClientLinkPSNAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientlinkpsnaccountrequest"},{"title":"PFAccountManagementClientLinkTwitchAccountRequest","description":"PFAccountManagementClientLinkTwitchAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientlinktwitchaccountrequest"},{"title":"PFAccountManagementClientLinkXboxAccountRequest","description":"PFAccountManagementClientLinkXboxAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientlinkxboxaccountrequest"},{"title":"PFAccountManagementClientUnlinkAppleRequest","description":"PFAccountManagementClientUnlinkAppleRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinkapplerequest"},{"title":"PFAccountManagementClientUnlinkBattleNetAccountRequest","description":"PFAccountManagementClientUnlinkBattleNetAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinkbattlenetaccountrequest"},{"title":"PFAccountManagementClientUnlinkFacebookAccountRequest","description":"PFAccountManagementClientUnlinkFacebookAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinkfacebookaccountrequest"},{"title":"PFAccountManagementClientUnlinkFacebookInstantGamesIdRequest","description":"PFAccountManagementClientUnlinkFacebookInstantGamesIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinkfacebookinstantgamesidrequest"},{"title":"PFAccountManagementClientUnlinkGameCenterAccountRequest","description":"PFAccountManagementClientUnlinkGameCenterAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinkgamecenteraccountrequest"},{"title":"PFAccountManagementClientUnlinkNintendoServiceAccountRequest","description":"PFAccountManagementClientUnlinkNintendoServiceAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinknintendoserviceaccountrequest"},{"title":"PFAccountManagementClientUnlinkNintendoSwitchDeviceIdRequest","description":"PFAccountManagementClientUnlinkNintendoSwitchDeviceIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinknintendoswitchdeviceidrequest"},{"title":"PFAccountManagementClientUnlinkPSNAccountRequest","description":"PFAccountManagementClientUnlinkPSNAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinkpsnaccountrequest"},{"title":"PFAccountManagementClientUnlinkTwitchAccountRequest","description":"PFAccountManagementClientUnlinkTwitchAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinktwitchaccountrequest"},{"title":"PFAccountManagementClientUnlinkXboxAccountRequest","description":"PFAccountManagementClientUnlinkXboxAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientunlinkxboxaccountrequest"},{"title":"PFAccountManagementClientUpdateAvatarUrlRequest","description":"PFAccountManagementClientUpdateAvatarUrlRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementclientupdateavatarurlrequest"},{"title":"PFAccountManagementDeletePlayerRequest","description":"PFAccountManagementDeletePlayerRequest data model. Deletes all data associated with the player, including statistics, custom data, inventory, purchases.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementdeleteplayerrequest"},{"title":"PFAccountManagementFacebookInstantGamesPlayFabIdPair","description":"PFAccountManagementFacebookInstantGamesPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementfacebookinstantgamesplayfabidpair"},{"title":"PFAccountManagementFacebookPlayFabIdPair","description":"PFAccountManagementFacebookPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementfacebookplayfabidpair"},{"title":"PFAccountManagementGameCenterPlayFabIdPair","description":"PFAccountManagementGameCenterPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgamecenterplayfabidpair"},{"title":"PFAccountManagementGetAccountInfoRequest","description":"PFAccountManagementGetAccountInfoRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetaccountinforequest"},{"title":"PFAccountManagementGetAccountInfoResult","description":"PFAccountManagementGetAccountInfoResult data model. This API retrieves details regarding the player in the PlayFab service. Note that when this call is used.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetaccountinforesult"},{"title":"PFAccountManagementGetPlayerCombinedInfoRequest","description":"PFAccountManagementGetPlayerCombinedInfoRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayercombinedinforequest"},{"title":"PFAccountManagementGetPlayerCombinedInfoResult","description":"PFAccountManagementGetPlayerCombinedInfoResult data model. Returns whatever info is requested in the response for the user. If no user is explicitly.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayercombinedinforesult"},{"title":"PFAccountManagementGetPlayerProfileRequest","description":"PFAccountManagementGetPlayerProfileRequest data model. This API allows for access to details regarding a user in the PlayFab service, usually for purposes of customer support. Note that data returned may be Personally Identifying Information (PII), such as email address, and so care should be taken in how this data is stored and managed. Since this call will always return the relevant information for users who have accessed the title, the recommendation is to not store this data locally.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayerprofilerequest"},{"title":"PFAccountManagementGetPlayerProfileResult","description":"PFAccountManagementGetPlayerProfileResult data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayerprofileresult"},{"title":"PFAccountManagementGetPlayFabIDsFromBattleNetAccountIdsRequest","description":"PFAccountManagementGetPlayFabIDsFromBattleNetAccountIdsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfrombattlenetaccountidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromBattleNetAccountIdsResult","description":"PFAccountManagementGetPlayFabIDsFromBattleNetAccountIdsResult data model. For Battle.net account identifiers which have not been linked to PlayFab accounts, null will be returned.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfrombattlenetaccountidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromFacebookIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromFacebookIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromfacebookidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromFacebookIDsResult","description":"PFAccountManagementGetPlayFabIDsFromFacebookIDsResult data model. For Facebook identifiers which have not been linked to PlayFab accounts, null will be.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromfacebookidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromFacebookInstantGamesIdsRequest","description":"PFAccountManagementGetPlayFabIDsFromFacebookInstantGamesIdsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromfacebookinstantgamesidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromFacebookInstantGamesIdsResult","description":"PFAccountManagementGetPlayFabIDsFromFacebookInstantGamesIdsResult data model. For Facebook Instant Game identifiers which have not been linked to PlayFab.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromfacebookinstantgamesidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromGameCenterIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromGameCenterIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromgamecenteridsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromGameCenterIDsResult","description":"PFAccountManagementGetPlayFabIDsFromGameCenterIDsResult data model. For Game Center identifiers which have not been linked to PlayFab accounts, null will be.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromgamecenteridsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromGoogleIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromGoogleIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromgoogleidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromGoogleIDsResult","description":"PFAccountManagementGetPlayFabIDsFromGoogleIDsResult data model. For Google identifiers which have not been linked to PlayFab accounts, null will be returned.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromgoogleidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromgoogleplaygamesplayeridsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromGooglePlayGamesPlayerIDsResult","description":"PFAccountManagementGetPlayFabIDsFromGooglePlayGamesPlayerIDsResult data model. For Google Play Games identifiers which have not been linked to PlayFab.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromgoogleplaygamesplayeridsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromKongregateIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromKongregateIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromkongregateidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromKongregateIDsResult","description":"PFAccountManagementGetPlayFabIDsFromKongregateIDsResult data model. For Kongregate identifiers which have not been linked to PlayFab accounts, null will be.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromkongregateidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromNintendoServiceAccountIdsRequest","description":"PFAccountManagementGetPlayFabIDsFromNintendoServiceAccountIdsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromnintendoserviceaccountidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromNintendoServiceAccountIdsResult","description":"PFAccountManagementGetPlayFabIDsFromNintendoServiceAccountIdsResult data model. For Nintendo Service Account identifiers which have not been linked to.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromnintendoserviceaccountidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromNintendoSwitchDeviceIdsRequest","description":"PFAccountManagementGetPlayFabIDsFromNintendoSwitchDeviceIdsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromnintendoswitchdeviceidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromNintendoSwitchDeviceIdsResult","description":"PFAccountManagementGetPlayFabIDsFromNintendoSwitchDeviceIdsResult data model. For Nintendo Switch identifiers which have not been linked to PlayFab accounts.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromnintendoswitchdeviceidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromOpenIdsRequest","description":"PFAccountManagementGetPlayFabIDsFromOpenIdsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromopenidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromOpenIdsResult","description":"PFAccountManagementGetPlayFabIDsFromOpenIdsResult data model. For OpenId identifiers which have not been linked to PlayFab accounts, null will be returned.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromopenidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromPSNAccountIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromPSNAccountIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfrompsnaccountidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromPSNAccountIDsResult","description":"PFAccountManagementGetPlayFabIDsFromPSNAccountIDsResult data model. For PlayStation :tm: Network identifiers which have not been linked to PlayFab accounts.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfrompsnaccountidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromPSNOnlineIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromPSNOnlineIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfrompsnonlineidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromPSNOnlineIDsResult","description":"PFAccountManagementGetPlayFabIDsFromPSNOnlineIDsResult data model. For PlayStation :tm: Network identifiers which have not been linked to PlayFab accounts, null will be returned.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfrompsnonlineidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromSteamIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromSteamIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromsteamidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromSteamIDsResult","description":"PFAccountManagementGetPlayFabIDsFromSteamIDsResult data model. For Steam identifiers which have not been linked to PlayFab accounts, null will be returned.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromsteamidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromSteamNamesRequest","description":"PFAccountManagementGetPlayFabIDsFromSteamNamesRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromsteamnamesrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromSteamNamesResult","description":"PFAccountManagementGetPlayFabIDsFromSteamNamesResult data model. For Steam identifiers which have not been linked to PlayFab accounts, or if the user has not logged in recently, null will be returned.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromsteamnamesresult"},{"title":"PFAccountManagementGetPlayFabIDsFromTwitchIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromTwitchIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromtwitchidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromTwitchIDsResult","description":"PFAccountManagementGetPlayFabIDsFromTwitchIDsResult data model. For Twitch identifiers which have not been linked to PlayFab accounts, null will be returned.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromtwitchidsresult"},{"title":"PFAccountManagementGetPlayFabIDsFromXboxLiveIDsRequest","description":"PFAccountManagementGetPlayFabIDsFromXboxLiveIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromxboxliveidsrequest"},{"title":"PFAccountManagementGetPlayFabIDsFromXboxLiveIDsResult","description":"PFAccountManagementGetPlayFabIDsFromXboxLiveIDsResult data model. For XboxLive identifiers which have not been linked to PlayFab accounts, null will be.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetplayfabidsfromxboxliveidsresult"},{"title":"PFAccountManagementGetServerCustomIDsFromPlayFabIDsRequest","description":"PFAccountManagementGetServerCustomIDsFromPlayFabIDsRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetservercustomidsfromplayfabidsrequest"},{"title":"PFAccountManagementGetServerCustomIDsFromPlayFabIDsResult","description":"PFAccountManagementGetServerCustomIDsFromPlayFabIDsResult data model. For a PlayFab account that isn't associated with a server custom identity.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetservercustomidsfromplayfabidsresult"},{"title":"PFAccountManagementGetTitlePlayersFromProviderIDsResponse","description":"PFAccountManagementGetTitlePlayersFromProviderIDsResponse data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgettitleplayersfromprovideridsresponse"},{"title":"PFAccountManagementGetTitlePlayersFromXboxLiveIDsRequest","description":"PFAccountManagementGetTitlePlayersFromXboxLiveIDsRequest data model. Given a collection of XBOX IDs (XUIDs), returns all title player accounts.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgettitleplayersfromxboxliveidsrequest"},{"title":"PFAccountManagementGetUserAccountInfoRequest","description":"PFAccountManagementGetUserAccountInfoRequest data model. This API allows for access to details regarding a user in the PlayFab service, usually for purposes.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetuseraccountinforequest"},{"title":"PFAccountManagementGetUserAccountInfoResult","description":"PFAccountManagementGetUserAccountInfoResult data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetuseraccountinforesult"},{"title":"PFAccountManagementGetUserBansRequest","description":"PFAccountManagementGetUserBansRequest data model. Get all bans for a user, including inactive and expired bans. .","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetuserbansrequest"},{"title":"PFAccountManagementGetUserBansResult","description":"PFAccountManagementGetUserBansResult data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgetuserbansresult"},{"title":"PFAccountManagementGooglePlayFabIdPair","description":"PFAccountManagementGooglePlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgoogleplayfabidpair"},{"title":"PFAccountManagementGooglePlayGamesPlayFabIdPair","description":"PFAccountManagementGooglePlayGamesPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementgoogleplaygamesplayfabidpair"},{"title":"PFAccountManagementKongregatePlayFabIdPair","description":"PFAccountManagementKongregatePlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementkongregateplayfabidpair"},{"title":"PFAccountManagementLinkAndroidDeviceIDRequest","description":"PFAccountManagementLinkAndroidDeviceIDRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkandroiddeviceidrequest"},{"title":"PFAccountManagementLinkAppleRequest","description":"PFAccountManagementLinkAppleRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkapplerequest"},{"title":"PFAccountManagementLinkCustomIDRequest","description":"PFAccountManagementLinkCustomIDRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkcustomidrequest"},{"title":"PFAccountManagementLinkFacebookAccountRequest","description":"PFAccountManagementLinkFacebookAccountRequest data model. Facebook sign-in is accomplished using the Facebook User Access Token. More information on the Token can be found in the Facebook developer documentation (https://developers.facebook.com/docs/facebook-login/access-tokens/). In Unity, for example, the Token is available as AccessToken in the Facebook SDK ScriptableObject FB. Note that titles should never re-use the same Facebook applications between PlayFab Title IDs, as Facebook provides unique user IDs per application and doing so can result in issues with the Facebook ID for the user in their PlayFab account information. If you must re-use an application in a new PlayFab Title ID, please be sure to first unlink all accounts from Facebook, or delete all users in the first Title ID.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkfacebookaccountrequest"},{"title":"PFAccountManagementLinkFacebookInstantGamesIdRequest","description":"PFAccountManagementLinkFacebookInstantGamesIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkfacebookinstantgamesidrequest"},{"title":"PFAccountManagementLinkGameCenterAccountRequest","description":"PFAccountManagementLinkGameCenterAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkgamecenteraccountrequest"},{"title":"PFAccountManagementLinkGoogleAccountRequest","description":"PFAccountManagementLinkGoogleAccountRequest data model. Google sign-in is accomplished by obtaining a Google OAuth 2.0 credential using the Google sign-in.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkgoogleaccountrequest"},{"title":"PFAccountManagementLinkGooglePlayGamesServicesAccountRequest","description":"PFAccountManagementLinkGooglePlayGamesServicesAccountRequest data model. Google Play Games sign-in is accomplished by obtaining a Google OAuth 2.0 credential.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkgoogleplaygamesservicesaccountrequest"},{"title":"PFAccountManagementLinkIOSDeviceIDRequest","description":"PFAccountManagementLinkIOSDeviceIDRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkiosdeviceidrequest"},{"title":"PFAccountManagementLinkKongregateAccountRequest","description":"PFAccountManagementLinkKongregateAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkkongregateaccountrequest"},{"title":"PFAccountManagementLinkNintendoServiceAccountSubjectRequest","description":"PFAccountManagementLinkNintendoServiceAccountSubjectRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinknintendoserviceaccountsubjectrequest"},{"title":"PFAccountManagementLinkOpenIdConnectRequest","description":"PFAccountManagementLinkOpenIdConnectRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkopenidconnectrequest"},{"title":"PFAccountManagementLinkPSNIdRequest","description":"PFAccountManagementLinkPSNIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkpsnidrequest"},{"title":"PFAccountManagementLinkServerCustomIdRequest","description":"PFAccountManagementLinkServerCustomIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinkservercustomidrequest"},{"title":"PFAccountManagementLinkSteamAccountRequest","description":"PFAccountManagementLinkSteamAccountRequest data model. Steam authentication is accomplished with the Steam Session Ticket. More information on the Ticket can.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinksteamaccountrequest"},{"title":"PFAccountManagementLinkSteamIdRequest","description":"PFAccountManagementLinkSteamIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinksteamidrequest"},{"title":"PFAccountManagementLinkTwitchAccountRequest","description":"PFAccountManagementLinkTwitchAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementlinktwitchaccountrequest"},{"title":"PFAccountManagementNintendoServiceAccountPlayFabIdPair","description":"PFAccountManagementNintendoServiceAccountPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementnintendoserviceaccountplayfabidpair"},{"title":"PFAccountManagementNintendoSwitchPlayFabIdPair","description":"PFAccountManagementNintendoSwitchPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementnintendoswitchplayfabidpair"},{"title":"PFAccountManagementOpenIdSubjectIdentifier","description":"PFAccountManagementOpenIdSubjectIdentifier data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementopenidsubjectidentifier"},{"title":"PFAccountManagementOpenIdSubjectIdentifierPlayFabIdPair","description":"PFAccountManagementOpenIdSubjectIdentifierPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementopenidsubjectidentifierplayfabidpair"},{"title":"PFAccountManagementPSNAccountPlayFabIdPair","description":"PFAccountManagementPSNAccountPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementpsnaccountplayfabidpair"},{"title":"PFAccountManagementPSNOnlinePlayFabIdPair","description":"PFAccountManagementPSNOnlinePlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementpsnonlineplayfabidpair"},{"title":"PFAccountManagementRemoveContactEmailRequest","description":"PFAccountManagementRemoveContactEmailRequest data model. This API removes an existing contact email from the player's profile.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementremovecontactemailrequest"},{"title":"PFAccountManagementReportPlayerClientRequest","description":"PFAccountManagementReportPlayerClientRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementreportplayerclientrequest"},{"title":"PFAccountManagementReportPlayerClientResult","description":"PFAccountManagementReportPlayerClientResult data model. Players are currently limited to five reports per day. Attempts by a single user account to submit.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementreportplayerclientresult"},{"title":"PFAccountManagementRevokeAllBansForUserRequest","description":"PFAccountManagementRevokeAllBansForUserRequest data model. Setting the active state of all non-expired bans for a user to Inactive.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementrevokeallbansforuserrequest"},{"title":"PFAccountManagementRevokeAllBansForUserResult","description":"PFAccountManagementRevokeAllBansForUserResult data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementrevokeallbansforuserresult"},{"title":"PFAccountManagementRevokeBansRequest","description":"PFAccountManagementRevokeBansRequest data model. Setting the active state of all bans requested to Inactive regardless of whether that ban has already expired.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementrevokebansrequest"},{"title":"PFAccountManagementRevokeBansResult","description":"PFAccountManagementRevokeBansResult data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementrevokebansresult"},{"title":"PFAccountManagementSendAccountRecoveryEmailRequest","description":"PFAccountManagementSendAccountRecoveryEmailRequest data model for sending an account recovery email to PlayFab accounts that have a valid email address.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsendaccountrecoveryemailrequest"},{"title":"PFAccountManagementSendCustomAccountRecoveryEmailRequest","description":"PFAccountManagementSendCustomAccountRecoveryEmailRequest data model. PlayFab accounts which have valid email address or username will be able to receive a.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsendcustomaccountrecoveryemailrequest"},{"title":"PFAccountManagementSendEmailFromTemplateRequest","description":"PFAccountManagementSendEmailFromTemplateRequest data model. Sends an email for only players that have contact emails associated with them.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsendemailfromtemplaterequest"},{"title":"PFAccountManagementServerCustomIDPlayFabIDPair","description":"PFAccountManagementServerCustomIDPlayFabIDPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementservercustomidplayfabidpair"},{"title":"PFAccountManagementServerLinkBattleNetAccountRequest","description":"PFAccountManagementServerLinkBattleNetAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverlinkbattlenetaccountrequest"},{"title":"PFAccountManagementServerLinkNintendoServiceAccountRequest","description":"PFAccountManagementServerLinkNintendoServiceAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverlinknintendoserviceaccountrequest"},{"title":"PFAccountManagementServerLinkNintendoSwitchDeviceIdRequest","description":"PFAccountManagementServerLinkNintendoSwitchDeviceIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverlinknintendoswitchdeviceidrequest"},{"title":"PFAccountManagementServerLinkPSNAccountRequest","description":"PFAccountManagementServerLinkPSNAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverlinkpsnaccountrequest"},{"title":"PFAccountManagementServerLinkXboxAccountRequest","description":"PFAccountManagementServerLinkXboxAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverlinkxboxaccountrequest"},{"title":"PFAccountManagementServerUnlinkBattleNetAccountRequest","description":"PFAccountManagementServerUnlinkBattleNetAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverunlinkbattlenetaccountrequest"},{"title":"PFAccountManagementServerUnlinkNintendoServiceAccountRequest","description":"PFAccountManagementServerUnlinkNintendoServiceAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverunlinknintendoserviceaccountrequest"},{"title":"PFAccountManagementServerUnlinkNintendoSwitchDeviceIdRequest","description":"PFAccountManagementServerUnlinkNintendoSwitchDeviceIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverunlinknintendoswitchdeviceidrequest"},{"title":"PFAccountManagementServerUnlinkPSNAccountRequest","description":"PFAccountManagementServerUnlinkPSNAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverunlinkpsnaccountrequest"},{"title":"PFAccountManagementServerUnlinkXboxAccountRequest","description":"PFAccountManagementServerUnlinkXboxAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverunlinkxboxaccountrequest"},{"title":"PFAccountManagementServerUpdateAvatarUrlRequest","description":"PFAccountManagementServerUpdateAvatarUrlRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementserverupdateavatarurlrequest"},{"title":"PFAccountManagementSetDisplayNameRequest","description":"PFAccountManagementSetDisplayNameRequest data model. Given an entity profile, will update its display name to the one passed in if the profile's version is equal to the specified value.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsetdisplaynamerequest"},{"title":"PFAccountManagementSetDisplayNameResponse","description":"PFAccountManagementSetDisplayNameResponse data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsetdisplaynameresponse"},{"title":"PFAccountManagementSteamNamePlayFabIdPair","description":"PFAccountManagementSteamNamePlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsteamnameplayfabidpair"},{"title":"PFAccountManagementSteamPlayFabIdPair","description":"PFAccountManagementSteamPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsteamplayfabidpair"},{"title":"PFAccountManagementTwitchPlayFabIdPair","description":"PFAccountManagementTwitchPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementtwitchplayfabidpair"},{"title":"PFAccountManagementUnlinkAndroidDeviceIDRequest","description":"PFAccountManagementUnlinkAndroidDeviceIDRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkandroiddeviceidrequest"},{"title":"PFAccountManagementUnlinkAppleRequest","description":"PFAccountManagementUnlinkAppleRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkapplerequest"},{"title":"PFAccountManagementUnlinkCustomIDRequest","description":"PFAccountManagementUnlinkCustomIDRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkcustomidrequest"},{"title":"PFAccountManagementUnlinkFacebookAccountRequest","description":"PFAccountManagementUnlinkFacebookAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkfacebookaccountrequest"},{"title":"PFAccountManagementUnlinkFacebookInstantGamesIdRequest","description":"PFAccountManagementUnlinkFacebookInstantGamesIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkfacebookinstantgamesidrequest"},{"title":"PFAccountManagementUnlinkGameCenterAccountRequest","description":"PFAccountManagementUnlinkGameCenterAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkgamecenteraccountrequest"},{"title":"PFAccountManagementUnlinkGoogleAccountRequest","description":"PFAccountManagementUnlinkGoogleAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkgoogleaccountrequest"},{"title":"PFAccountManagementUnlinkGooglePlayGamesServicesAccountRequest","description":"PFAccountManagementUnlinkGooglePlayGamesServicesAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkgoogleplaygamesservicesaccountrequest"},{"title":"PFAccountManagementUnlinkIOSDeviceIDRequest","description":"PFAccountManagementUnlinkIOSDeviceIDRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkiosdeviceidrequest"},{"title":"PFAccountManagementUnlinkKongregateAccountRequest","description":"PFAccountManagementUnlinkKongregateAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkkongregateaccountrequest"},{"title":"PFAccountManagementUnlinkOpenIdConnectRequest","description":"PFAccountManagementUnlinkOpenIdConnectRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkopenidconnectrequest"},{"title":"PFAccountManagementUnlinkServerCustomIdRequest","description":"PFAccountManagementUnlinkServerCustomIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinkservercustomidrequest"},{"title":"PFAccountManagementUnlinkSteamAccountRequest","description":"PFAccountManagementUnlinkSteamAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinksteamaccountrequest"},{"title":"PFAccountManagementUnlinkSteamIdRequest","description":"PFAccountManagementUnlinkSteamIdRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinksteamidrequest"},{"title":"PFAccountManagementUnlinkTwitchAccountRequest","description":"PFAccountManagementUnlinkTwitchAccountRequest data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementunlinktwitchaccountrequest"},{"title":"PFAccountManagementUpdateBanRequest","description":"PFAccountManagementUpdateBanRequest data model. Represents a single update ban request.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementupdatebanrequest"},{"title":"PFAccountManagementUpdateBansRequest","description":"PFAccountManagementUpdateBansRequest data model. For each ban, only updates the values that are set. Leave any value to null for no change. If a ban could.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementupdatebansrequest"},{"title":"PFAccountManagementUpdateBansResult","description":"PFAccountManagementUpdateBansResult data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementupdatebansresult"},{"title":"PFAccountManagementUpdateUserTitleDisplayNameRequest","description":"PFAccountManagementUpdateUserTitleDisplayNameRequest data model. In addition to the PlayFab username, titles can make use of a DisplayName which is also a.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementupdateusertitledisplaynamerequest"},{"title":"PFAccountManagementUpdateUserTitleDisplayNameResult","description":"PFAccountManagementUpdateUserTitleDisplayNameResult data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementupdateusertitledisplaynameresult"},{"title":"PFAccountManagementXboxLiveAccountPlayFabIdPair","description":"PFAccountManagementXboxLiveAccountPlayFabIdPair data model.","href":"/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementxboxliveaccountplayfabidpair"}]}]},{"group":"PFAuthentication","pages":[{"title":"Services C API overview - PFAuthentication.h","description":"Services C API overview - PFAuthentication.h","sidebarTitle":"PFAuthentication","href":"/services/playfab/api-references/c/pfauthentication/pfauthentication_members"},{"group":"Functions","pages":[{"title":"PFAuthenticationAuthenticateGameServerWithCustomIdAsync","description":"Create a game_server entity token and return a new or existing game_server entity.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationauthenticategameserverwithcustomidasync"},{"title":"PFAuthenticationAuthenticateGameServerWithCustomIdGetResult","description":"Get the result from a PFAuthenticationAuthenticateGameServerWithCustomIdAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationauthenticategameserverwithcustomidgetresult"},{"title":"PFAuthenticationDeleteAsync","description":"Delete a game_server entity.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationdeleteasync"},{"title":"PFAuthenticationGetEntityAsync","description":"Exchange a legacy AuthenticationTicket or title SecretKey for an Entity Token, or refresh a still valid one, using a PFEntityHandle for authentication.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentityasync"},{"title":"PFAuthenticationGetEntityGetResult","description":"Gets the result of a successful PFAuthenticationGetEntityAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentitygetresult"},{"title":"PFAuthenticationGetEntityWithSecretKeyAsync","description":"Get an Entity Token by passing a PFServiceConfigHandle and a title Secret Key. On success, it issues a new entity token and emits a PlayStream event.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentitywithsecretkeyasync"},{"title":"PFAuthenticationGetEntityWithSecretKeyGetResult","description":"Gets the result of a successful PFAuthenticationGetEntityWithSecretKeyAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentitywithsecretkeygetresult"},{"title":"PFAuthenticationLoginWithAppleAsync","description":"Signs in the user with a Sign in with Apple identity token.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithappleasync"},{"title":"PFAuthenticationLoginWithAppleGetResult","description":"Get the result from a PFAuthenticationLoginWithAppleAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithapplegetresult"},{"title":"PFAuthenticationLoginWithAppleGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithAppleAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithapplegetresultsize"},{"title":"PFAuthenticationLoginWithBattleNetAsync","description":"Client API that signs in the user with a Battle.net identity token on Windows. Call PFAuthenticationLoginWithBattleNetGetResult when the task completes.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithbattlenetasync"},{"title":"PFAuthenticationLoginWithBattleNetGetResult","description":"Get the result from a PFAuthenticationLoginWithBattleNetAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithbattlenetgetresult"},{"title":"PFAuthenticationLoginWithBattleNetGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithBattleNetAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithbattlenetgetresultsize"},{"title":"PFAuthenticationLoginWithCustomIDAsync","description":"Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithcustomidasync"},{"title":"PFAuthenticationLoginWithCustomIDGetResult","description":"Get the result from a PFAuthenticationLoginWithCustomIDAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithcustomidgetresult"},{"title":"PFAuthenticationLoginWithCustomIDGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithCustomIDAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithcustomidgetresultsize"},{"title":"PFAuthenticationLoginWithFacebookAsync","description":"Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithfacebookasync"},{"title":"PFAuthenticationLoginWithFacebookGetResult","description":"Get the result from a PFAuthenticationLoginWithFacebookAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithfacebookgetresult"},{"title":"PFAuthenticationLoginWithFacebookGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithFacebookAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithfacebookgetresultsize"},{"title":"PFAuthenticationLoginWithGameCenterAsync","description":"Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithgamecenterasync"},{"title":"PFAuthenticationLoginWithGameCenterGetResult","description":"Get the result from a PFAuthenticationLoginWithGameCenterAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithgamecentergetresult"},{"title":"PFAuthenticationLoginWithGameCenterGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithGameCenterAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithgamecentergetresultsize"},{"title":"PFAuthenticationLoginWithGoogleAccountAsync","description":"Signs the user in using their Google account credentials","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithgoogleaccountasync"},{"title":"PFAuthenticationLoginWithGoogleAccountGetResult","description":"Get the result from a PFAuthenticationLoginWithGoogleAccountAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithgoogleaccountgetresult"},{"title":"PFAuthenticationLoginWithGoogleAccountGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithGoogleAccountAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithgoogleaccountgetresultsize"},{"title":"PFAuthenticationLoginWithGooglePlayGamesServicesAsync","description":"Signs the user in using their Google Play Games account credentials","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithgoogleplaygamesservicesasync"},{"title":"PFAuthenticationLoginWithGooglePlayGamesServicesGetResult","description":"Get the result from a PFAuthenticationLoginWithGooglePlayGamesServicesAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithgoogleplaygamesservicesgetresult"},{"title":"PFAuthenticationLoginWithGooglePlayGamesServicesGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithGooglePlayGamesServicesAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithgoogleplaygamesservicesgetresultsize"},{"title":"PFAuthenticationLoginWithNintendoServiceAccountAsync","description":"Signs in the user with a Nintendo service account token.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithnintendoserviceaccountasync"},{"title":"PFAuthenticationLoginWithNintendoServiceAccountGetResult","description":"Get the result from a PFAuthenticationLoginWithNintendoServiceAccountAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithnintendoserviceaccountgetresult"},{"title":"PFAuthenticationLoginWithNintendoServiceAccountGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithNintendoServiceAccountAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithnintendoserviceaccountgetresultsize"},{"title":"PFAuthenticationLoginWithOpenIdConnectAsync","description":"Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect provider.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithopenidconnectasync"},{"title":"PFAuthenticationLoginWithOpenIdConnectGetResult","description":"Get the result from a PFAuthenticationLoginWithOpenIdConnectAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithopenidconnectgetresult"},{"title":"PFAuthenticationLoginWithOpenIdConnectGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithOpenIdConnectAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithopenidconnectgetresultsize"},{"title":"PFAuthenticationLoginWithPSNAsync","description":"Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can subsequently be used for API calls which.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithpsnasync"},{"title":"PFAuthenticationLoginWithPSNGetResult","description":"Get the result from a PFAuthenticationLoginWithPSNAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithpsngetresult"},{"title":"PFAuthenticationLoginWithPSNGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithPSNAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithpsngetresultsize"},{"title":"PFAuthenticationLoginWithSteamAsync","description":"Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithsteamasync"},{"title":"PFAuthenticationLoginWithSteamGetResult","description":"Get the result from a PFAuthenticationLoginWithSteamAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithsteamgetresult"},{"title":"PFAuthenticationLoginWithSteamGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithSteamAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithsteamgetresultsize"},{"title":"PFAuthenticationLoginWithXboxAsync","description":"Signs the user in using a XBOX Live Token, returning a session identifier that can subsequently be used for API calls which require an authenticated user. If possible, PFAuthenticationLoginWithXUserAsync should be preferred, as it will more seamlessly handle automatic token refresh.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithxboxasync"},{"title":"PFAuthenticationLoginWithXboxGetResult","description":"Get the result from a PFAuthenticationLoginWithXboxAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithxboxgetresult"},{"title":"PFAuthenticationLoginWithXboxGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithXboxAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithxboxgetresultsize"},{"title":"PFAuthenticationLoginWithXUserAsync","description":"Signs the user in using an XUserHandle, returning a session identifier that can subsequently be used for API calls which require an authenticated user","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithxuserasync"},{"title":"PFAuthenticationLoginWithXUserGetResult","description":"Get the result from a PFAuthenticationLoginWithXUserAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithxusergetresult"},{"title":"PFAuthenticationLoginWithXUserGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationLoginWithXUserAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationloginwithxusergetresultsize"},{"title":"PFAuthenticationReLoginWithAppleAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with Sign in with Apple when an EntityToken has expired and the SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithappleasync"},{"title":"PFAuthenticationReLoginWithBattleNetAsync","description":"Reauthenticates an existing PFEntityHandle. Used to address situations where the EntityToken expired and the PlayFab SDK is unable to refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithbattlenetasync"},{"title":"PFAuthenticationReLoginWithCustomIDAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with a custom identifier when an EntityToken has expired and the SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithcustomidasync"},{"title":"PFAuthenticationReLoginWithFacebookAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with a Facebook access token when an EntityToken has expired and the SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithfacebookasync"},{"title":"PFAuthenticationReLoginWithGameCenterAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with Apple Game Center when an EntityToken has expired and the SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithgamecenterasync"},{"title":"PFAuthenticationReLoginWithGoogleAccountAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with a Google account when an EntityToken has expired and the SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithgoogleaccountasync"},{"title":"PFAuthenticationReLoginWithGooglePlayGamesServicesAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with Google Play Games Services when an EntityToken has expired and the SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithgoogleplaygamesservicesasync"},{"title":"PFAuthenticationReLoginWithNintendoServiceAccountAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with a Nintendo Service Account when an EntityToken has expired and the SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithnintendoserviceaccountasync"},{"title":"PFAuthenticationReLoginWithOpenIdConnectAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with an OpenID Connect provider when an EntityToken has expired and the SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithopenidconnectasync"},{"title":"PFAuthenticationReLoginWithPSNAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with PlayStation Network when an EntityToken has expired and the SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithpsnasync"},{"title":"PFAuthenticationReLoginWithSteamAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with Steam when an EntityToken has expired and the PlayFab SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithsteamasync"},{"title":"PFAuthenticationReLoginWithXboxAsync","description":"Reauthenticates an existing PFEntityHandle by signing in with XBOX Live when an EntityToken has expired and the PlayFab SDK cannot refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithxboxasync"},{"title":"PFAuthenticationReLoginWithXUserAsync","description":"Reauthenticates an existing PFEntityHandle using an XUserHandle. Used to address situations where the EntityToken expired and the PlayFab SDK is unable to refresh it.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationreloginwithxuserasync"},{"title":"PFAuthenticationServerLoginWithAndroidDeviceIDAsync","description":"Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithandroiddeviceidasync"},{"title":"PFAuthenticationServerLoginWithAndroidDeviceIDGetResult","description":"Get the result from a PFAuthenticationServerLoginWithAndroidDeviceIDAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithandroiddeviceidgetresult"},{"title":"PFAuthenticationServerLoginWithAndroidDeviceIDGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationServerLoginWithAndroidDeviceIDAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithandroiddeviceidgetresultsize"},{"title":"PFAuthenticationServerLoginWithBattleNetAsync","description":"Server API that signs in a user with a Battle.net identity token, authenticating the service request with a title Secret Key. Available on Windows.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithbattlenetasync"},{"title":"PFAuthenticationServerLoginWithBattleNetGetResult","description":"Get the result from a PFAuthenticationServerLoginWithBattleNetAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithbattlenetgetresult"},{"title":"PFAuthenticationServerLoginWithBattleNetGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationServerLoginWithBattleNetAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithbattlenetgetresultsize"},{"title":"PFAuthenticationServerLoginWithCustomIDAsync","description":"Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithcustomidasync"},{"title":"PFAuthenticationServerLoginWithCustomIDGetResult","description":"Get the result from a PFAuthenticationServerLoginWithCustomIDAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithcustomidgetresult"},{"title":"PFAuthenticationServerLoginWithCustomIDGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationServerLoginWithCustomIDAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithcustomidgetresultsize"},{"title":"PFAuthenticationServerLoginWithIOSDeviceIDAsync","description":"Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithiosdeviceidasync"},{"title":"PFAuthenticationServerLoginWithIOSDeviceIDGetResult","description":"Get the result from a PFAuthenticationServerLoginWithIOSDeviceIDAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithiosdeviceidgetresult"},{"title":"PFAuthenticationServerLoginWithIOSDeviceIDGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationServerLoginWithIOSDeviceIDAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithiosdeviceidgetresultsize"},{"title":"PFAuthenticationServerLoginWithPSNAsync","description":"Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can subsequently be used for API calls which require an authenticated user","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithpsnasync"},{"title":"PFAuthenticationServerLoginWithPSNGetResult","description":"Get the result from a PFAuthenticationServerLoginWithPSNAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithpsngetresult"},{"title":"PFAuthenticationServerLoginWithPSNGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationServerLoginWithPSNAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithpsngetresultsize"},{"title":"PFAuthenticationServerLoginWithServerCustomIdAsync","description":"Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID and Client Custom ID are mutually.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithservercustomidasync"},{"title":"PFAuthenticationServerLoginWithServerCustomIdGetResult","description":"Get the result from a PFAuthenticationServerLoginWithServerCustomIdAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithservercustomidgetresult"},{"title":"PFAuthenticationServerLoginWithServerCustomIdGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationServerLoginWithServerCustomIdAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithservercustomidgetresultsize"},{"title":"PFAuthenticationServerLoginWithSteamIdAsync","description":"Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithsteamidasync"},{"title":"PFAuthenticationServerLoginWithSteamIdGetResult","description":"Get the result from a PFAuthenticationServerLoginWithSteamIdAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithsteamidgetresult"},{"title":"PFAuthenticationServerLoginWithSteamIdGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationServerLoginWithSteamIdAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithsteamidgetresultsize"},{"title":"PFAuthenticationServerLoginWithXboxAsync","description":"Signs the user in using an XBOX Live Token from an external server backend, returning a session identifier that can subsequently be used for API calls which.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithxboxasync"},{"title":"PFAuthenticationServerLoginWithXboxGetResult","description":"Get the result from a PFAuthenticationServerLoginWithXboxAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithxboxgetresult"},{"title":"PFAuthenticationServerLoginWithXboxGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationServerLoginWithXboxAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithxboxgetresultsize"},{"title":"PFAuthenticationServerLoginWithXboxIdAsync","description":"Signs the user in using an XBOX ID and Sandbox ID, returning a session identifier that can subsequently be used for API calls which require an authenticated.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithxboxidasync"},{"title":"PFAuthenticationServerLoginWithXboxIdGetResult","description":"Get the result from a PFAuthenticationServerLoginWithXboxIdAsync call. The PFEntityHandle will always be returned, but the additional info in the PFAuthenticationLoginResult is only returned if a buffer is provided.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithxboxidgetresult"},{"title":"PFAuthenticationServerLoginWithXboxIdGetResultSize","description":"Get the size in bytes needed to store the result of a PFAuthenticationServerLoginWithXboxIdAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationserverloginwithxboxidgetresultsize"},{"title":"PFAuthenticationValidateEntityTokenAsync","description":"Method for a server to validate a client provided EntityToken. Only callable by the title entity.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationvalidateentitytokenasync"},{"title":"PFAuthenticationValidateEntityTokenGetResult","description":"Gets the result of a successful PFAuthenticationValidateEntityTokenAsync call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationvalidateentitytokengetresult"},{"title":"PFAuthenticationValidateEntityTokenGetResultSize","description":"Get the size in bytes needed to store the result of a ValidateEntityToken call.","href":"/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationvalidateentitytokengetresultsize"}]}]},{"group":"PFAuthenticationTypes","pages":[{"title":"Services C API overview - PFAuthenticationTypes.h","description":"Services C API overview - PFAuthenticationTypes.h","sidebarTitle":"PFAuthenticationTypes","href":"/services/playfab/api-references/c/pfauthenticationtypes/pfauthenticationtypes_members"},{"group":"Enums","pages":[{"title":"PFAuthenticationIdentifiedDeviceType","description":"IdentifiedDeviceType enum.","href":"/services/playfab/api-references/c/pfauthenticationtypes/enums/pfauthenticationidentifieddevicetype"}]},{"group":"Structs","pages":[{"title":"PFAuthenticationAuthenticateCustomIdRequest","description":"PFAuthenticationAuthenticateCustomIdRequest data model. Create or return a game_server entity token. Caller must be a title entity.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationauthenticatecustomidrequest"},{"title":"PFAuthenticationAuthenticateCustomIdResult","description":"PFAuthenticationAuthenticateCustomIdResult data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationauthenticatecustomidresult"},{"title":"PFAuthenticationDeleteRequest","description":"PFAuthenticationDeleteRequest data model. Delete a game_server entity. The caller can be the game_server entity attempting to delete itself.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationdeleterequest"},{"title":"PFAuthenticationEntityTokenResponse","description":"PFAuthenticationEntityTokenResponse data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationentitytokenresponse"},{"title":"PFAuthenticationGetEntityRequest","description":"PFAuthenticationGetEntityRequest data model. This API must be called with X-SecretKey, X-Authentication or X-EntityToken headers. The header must still be valid and cannot be expired or revoked.If successful, it will issue a new entity token and emit the \"entity_logged_in\" PlayStream event.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationgetentityrequest"},{"title":"PFAuthenticationLoginResult","description":"PFAuthenticationLoginResult data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginresult"},{"title":"PFAuthenticationLoginWithAppleRequest","description":"PFAuthenticationLoginWithAppleRequest data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithapplerequest"},{"title":"PFAuthenticationLoginWithBattleNetRequest","description":"PFAuthenticationLoginWithBattleNetRequest data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithbattlenetrequest"},{"title":"PFAuthenticationLoginWithCustomIDRequest","description":"PFAuthenticationLoginWithCustomIDRequest data model. It is highly recommended that developers ensure that it is extremely unlikely that a customer could generate an ID which is already in use by another customer. If this is the first time a user has signed in with the Custom ID and CreateAccount is set to true, a new PlayFab account will be created and linked to the Custom ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Custom ID, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithcustomidrequest"},{"title":"PFAuthenticationLoginWithFacebookRequest","description":"Request data for signing in with a Facebook User Access Token. Set CreateAccount to true to create and link a new PlayFab account on the first sign-in.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithfacebookrequest"},{"title":"PFAuthenticationLoginWithGameCenterRequest","description":"Request data for signing in with a Game Center player identifier, plus signature, salt, and timestamp fields. Never expose the identifier to end users.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithgamecenterrequest"},{"title":"PFAuthenticationLoginWithGoogleAccountRequest","description":"Request data for Google account sign-in on Android. Pass the auth code from GoogleSignInAccount.getServerAuthCode() as the ServerAuthCode parameter.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithgoogleaccountrequest"},{"title":"PFAuthenticationLoginWithGooglePlayGamesServicesRequest","description":"Request data for Google Play Games sign-in on Android. Pass the auth code from GamesSignInClient.requestServerSideAccess() as the ServerAuthCode parameter.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithgoogleplaygamesservicesrequest"},{"title":"PFAuthenticationLoginWithNintendoServiceAccountRequest","description":"PFAuthenticationLoginWithNintendoServiceAccountRequest data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithnintendoserviceaccountrequest"},{"title":"PFAuthenticationLoginWithOpenIdConnectRequest","description":"PFAuthenticationLoginWithOpenIdConnectRequest data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithopenidconnectrequest"},{"title":"PFAuthenticationLoginWithPSNRequest","description":"PFAuthenticationLoginWithPSNRequest data model. If this is the first time a user has signed in with the PlayStation :tm: Network account and CreateAccount is set to true, a new PlayFab account will be created and linked to the PlayStation :tm: Network account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the PlayStation :tm: Network account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithpsnrequest"},{"title":"PFAuthenticationLoginWithServerCustomIdRequest","description":"PFAuthenticationLoginWithServerCustomIdRequest data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithservercustomidrequest"},{"title":"PFAuthenticationLoginWithSteamIdRequest","description":"PFAuthenticationLoginWithSteamIdRequest data model. If this is the first time a user has signed in with the Steam ID and CreateAccount is set to true, a new.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithsteamidrequest"},{"title":"PFAuthenticationLoginWithSteamRequest","description":"PFAuthenticationLoginWithSteamRequest data model. Steam sign-in is accomplished with the Steam Session Ticket. More information on the Ticket can be found in the Steamworks SDK, here: https://partner.steamgames.com/documentation/auth. NOTE: For Steam authentication to work, the title must be configured with the Steam Application ID and Web API Key in the PlayFab Game Manager (under Steam in the Add-ons Marketplace). You can obtain a Web API Key from the Permissions page of any Group associated with your App ID in the Steamworks site. If this is the first time a user has signed in with the Steam account and CreateAccount is set to true, a new PlayFab account will be created and linked to the provided account's Steam ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Steam account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithsteamrequest"},{"title":"PFAuthenticationLoginWithXboxIdRequest","description":"PFAuthenticationLoginWithXboxIdRequest data model. If this is the first time a user has signed in with the XBOX ID and CreateAccount is set to true, a new.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithxboxidrequest"},{"title":"PFAuthenticationLoginWithXboxRequest","description":"PFAuthenticationLoginWithXboxRequest data model. If this is the first time a user has signed in with the XBOX Live account and CreateAccount is set to true, a new PlayFab account will be created and linked to the XBOX Live account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the XBOX Live account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithxboxrequest"},{"title":"PFAuthenticationLoginWithXUserRequest","description":"PFAuthenticationLoginWithXUserRequest data model. If this is the first time a user has signed in with the XBOX Live account and CreateAccount is set to true, a new PlayFab account will be created and linked to the XBOX Live account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the XBOX Live account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. Request object for PFAuthenticationLoginWithXUserAsync.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationloginwithxuserrequest"},{"title":"PFAuthenticationServerLoginWithAndroidDeviceIDRequest","description":"Server request data for signing in with an Android device ID such as Settings.Secure.ANDROID_ID. CreateAccount creates and links a new PlayFab account.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationserverloginwithandroiddeviceidrequest"},{"title":"PFAuthenticationServerLoginWithBattleNetRequest","description":"PFAuthenticationServerLoginWithBattleNetRequest data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationserverloginwithbattlenetrequest"},{"title":"PFAuthenticationServerLoginWithCustomIDRequest","description":"PFAuthenticationServerLoginWithCustomIDRequest data model. It is highly recommended that developers ensure that it is extremely unlikely that a customer could generate an ID which is already in use by another customer. If this is the first time a user has signed in with the Custom ID and CreateAccount is set to true, a new PlayFab account will be created and linked to the Custom ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Custom ID, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationserverloginwithcustomidrequest"},{"title":"PFAuthenticationServerLoginWithIOSDeviceIDRequest","description":"PFAuthenticationServerLoginWithIOSDeviceIDRequest data model. On iOS devices, the identifierForVendor (https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIDevice_Class/index.html# // apple_ref/occ/instp/UIDevice/identifierForVendor) must be used as the DeviceId, as the UIDevice uniqueIdentifier has been deprecated as of iOS 5, and use of the advertisingIdentifier for this purpose will result in failure of Apple's certification process. If this is the first time a user has signed in with the iOS device and CreateAccount is set to true, a new PlayFab account will be created and linked to the vendor-specific iOS device ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the iOS device, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationserverloginwithiosdeviceidrequest"},{"title":"PFAuthenticationServerLoginWithPSNRequest","description":"PFAuthenticationServerLoginWithPSNRequest data model. If this is the first time a user has signed in with the PlayStation :tm: Network account and CreateAccount is set to true, a new PlayFab account will be created and linked to the PlayStation :tm: Network account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the PlayStation :tm: Network account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationserverloginwithpsnrequest"},{"title":"PFAuthenticationServerLoginWithXboxRequest","description":"PFAuthenticationServerLoginWithXboxRequest data model. If this is the first time a user has signed in with the XBOX Live account and CreateAccount is set to.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationserverloginwithxboxrequest"},{"title":"PFAuthenticationUserSettings","description":"PFAuthenticationUserSettings data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationusersettings"},{"title":"PFAuthenticationValidateEntityTokenRequest","description":"PFAuthenticationValidateEntityTokenRequest data model. Given an entity token, validates that it hasn't expired or been revoked and will return details of the.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationvalidateentitytokenrequest"},{"title":"PFAuthenticationValidateEntityTokenResponse","description":"PFAuthenticationValidateEntityTokenResponse data model.","href":"/services/playfab/api-references/c/pfauthenticationtypes/structs/pfauthenticationvalidateentitytokenresponse"}]}]},{"group":"PFCatalog","pages":[{"title":"Services C API overview - PFCatalog.h","description":"Services C API overview - PFCatalog.h","sidebarTitle":"PFCatalog","href":"/services/playfab/api-references/c/pfcatalog/pfcatalog_members"},{"group":"Functions","pages":[{"title":"PFCatalogCreateDraftItemAsync","description":"Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogcreatedraftitemasync"},{"title":"PFCatalogCreateDraftItemGetResult","description":"Gets the result of a successful PFCatalogCreateDraftItemAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogcreatedraftitemgetresult"},{"title":"PFCatalogCreateDraftItemGetResultSize","description":"Get the size in bytes needed to store the result of a CreateDraftItem call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogcreatedraftitemgetresultsize"},{"title":"PFCatalogCreateUploadUrlsAsync","description":"Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info around uploading content can be found here: https://learn.microsoft.com/gaming/playfab/features/pricing/meters/catalog-meters","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogcreateuploadurlsasync"},{"title":"PFCatalogCreateUploadUrlsGetResult","description":"Gets the result of a successful PFCatalogCreateUploadUrlsAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogcreateuploadurlsgetresult"},{"title":"PFCatalogCreateUploadUrlsGetResultSize","description":"Get the size in bytes needed to store the result of a CreateUploadUrls call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogcreateuploadurlsgetresultsize"},{"title":"PFCatalogDeleteEntityItemReviewsAsync","description":"Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogdeleteentityitemreviewsasync"},{"title":"PFCatalogDeleteItemAsync","description":"Removes an item from working catalog and all published versions from the public catalog.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogdeleteitemasync"},{"title":"PFCatalogGetCatalogConfigAsync","description":"Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/settings","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetcatalogconfigasync"},{"title":"PFCatalogGetCatalogConfigGetResult","description":"Gets the result of a successful PFCatalogGetCatalogConfigAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetcatalogconfiggetresult"},{"title":"PFCatalogGetCatalogConfigGetResultSize","description":"Get the size in bytes needed to store the result of a GetCatalogConfig call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetcatalogconfiggetresultsize"},{"title":"PFCatalogGetDraftItemAsync","description":"Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are valid for 1 hour.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetdraftitemasync"},{"title":"PFCatalogGetDraftItemGetResult","description":"Gets the result of a successful PFCatalogGetDraftItemAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetdraftitemgetresult"},{"title":"PFCatalogGetDraftItemGetResultSize","description":"Get the size in bytes needed to store the result of a GetDraftItem call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetdraftitemgetresultsize"},{"title":"PFCatalogGetDraftItemsAsync","description":"Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request. GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note: SAS tokens provided are valid for 1 hour.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetdraftitemsasync"},{"title":"PFCatalogGetDraftItemsGetResult","description":"Gets the result of a successful PFCatalogGetDraftItemsAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetdraftitemsgetresult"},{"title":"PFCatalogGetDraftItemsGetResultSize","description":"Get the size in bytes needed to store the result of a GetDraftItems call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetdraftitemsgetresultsize"},{"title":"PFCatalogGetEntityDraftItemsAsync","description":"Retrieves a paginated list of the items from the draft catalog created by the Entity. Up to 50 items can be returned at once. You can use continuation tokens.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetentitydraftitemsasync"},{"title":"PFCatalogGetEntityDraftItemsGetResult","description":"Gets the result of a successful PFCatalogGetEntityDraftItemsAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetentitydraftitemsgetresult"},{"title":"PFCatalogGetEntityDraftItemsGetResultSize","description":"Get the size in bytes needed to store the result of a GetEntityDraftItems call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetentitydraftitemsgetresultsize"},{"title":"PFCatalogGetEntityItemReviewAsync","description":"Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update in near real time with delays within.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetentityitemreviewasync"},{"title":"PFCatalogGetEntityItemReviewGetResult","description":"Gets the result of a successful PFCatalogGetEntityItemReviewAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetentityitemreviewgetresult"},{"title":"PFCatalogGetEntityItemReviewGetResultSize","description":"Get the size in bytes needed to store the result of a GetEntityItemReview call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetentityitemreviewgetresultsize"},{"title":"PFCatalogGetItemAsync","description":"Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when trying to get recent item updates.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemasync"},{"title":"PFCatalogGetItemContainersAsync","description":"Search for a given item and return a set of bundles and stores containing the item. Up to 50 items can be returned at once. You can use continuation tokens.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemcontainersasync"},{"title":"PFCatalogGetItemContainersGetResult","description":"Gets the result of a successful PFCatalogGetItemContainersAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemcontainersgetresult"},{"title":"PFCatalogGetItemContainersGetResultSize","description":"Get the size in bytes needed to store the result of a GetItemContainers call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemcontainersgetresultsize"},{"title":"PFCatalogGetItemGetResult","description":"Gets the result of a successful PFCatalogGetItemAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemgetresult"},{"title":"PFCatalogGetItemGetResultSize","description":"Get the size in bytes needed to store the result of a GetItem call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemgetresultsize"},{"title":"PFCatalogGetItemModerationStateAsync","description":"Gets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/ugc/moderation","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemmoderationstateasync"},{"title":"PFCatalogGetItemModerationStateGetResult","description":"Gets the result of a successful PFCatalogGetItemModerationStateAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemmoderationstategetresult"},{"title":"PFCatalogGetItemModerationStateGetResultSize","description":"Get the size in bytes needed to store the result of a GetItemModerationState call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemmoderationstategetresultsize"},{"title":"PFCatalogGetItemPublishStatusAsync","description":"Gets the status of a publish of an item.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitempublishstatusasync"},{"title":"PFCatalogGetItemPublishStatusGetResult","description":"Gets the result of a successful PFCatalogGetItemPublishStatusAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitempublishstatusgetresult"},{"title":"PFCatalogGetItemPublishStatusGetResultSize","description":"Get the size in bytes needed to store the result of a GetItemPublishStatus call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitempublishstatusgetresultsize"},{"title":"PFCatalogGetItemReviewsAsync","description":"Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near real time with delays within a few.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemreviewsasync"},{"title":"PFCatalogGetItemReviewsGetResult","description":"Gets the result of a successful PFCatalogGetItemReviewsAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemreviewsgetresult"},{"title":"PFCatalogGetItemReviewsGetResultSize","description":"Get the size in bytes needed to store the result of a GetItemReviews call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemreviewsgetresultsize"},{"title":"PFCatalogGetItemReviewSummaryAsync","description":"Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update data coming within 15 minutes.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemreviewsummaryasync"},{"title":"PFCatalogGetItemReviewSummaryGetResult","description":"Gets the result of a successful PFCatalogGetItemReviewSummaryAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemreviewsummarygetresult"},{"title":"PFCatalogGetItemReviewSummaryGetResultSize","description":"Get the size in bytes needed to store the result of a GetItemReviewSummary call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemreviewsummarygetresultsize"},{"title":"PFCatalogGetItemsAsync","description":"Retrieves items from the public catalog. Up to 50 items can be returned at once. GetItems does not work off a cache of the Catalog and should be used when.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemsasync"},{"title":"PFCatalogGetItemsGetResult","description":"Gets the result of a successful PFCatalogGetItemsAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemsgetresult"},{"title":"PFCatalogGetItemsGetResultSize","description":"Get the size in bytes needed to store the result of a GetItems call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetitemsgetresultsize"},{"title":"PFCatalogPublishDraftItemAsync","description":"Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API to track the state of the item publish.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogpublishdraftitemasync"},{"title":"PFCatalogReportItemAsync","description":"Submit a report for an item, indicating in what way the item is inappropriate.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogreportitemasync"},{"title":"PFCatalogReportItemReviewAsync","description":"Submit a report for a review","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogreportitemreviewasync"},{"title":"PFCatalogReviewItemAsync","description":"Creates or updates a review for the specified item. More information around the caching surrounding item ratings and reviews can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/catalog/ratings#ratings-design-and-caching","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogreviewitemasync"},{"title":"PFCatalogSearchItemsAsync","description":"Executes a search against the public catalog using the provided search parameters and returns a set of paginated results. SearchItems uses a cache of the catalog with item updates taking up to a few minutes to propagate. You should use the GetItem API for when trying to immediately get recent item updates. More information about the Search API can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/catalog/search","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogsearchitemsasync"},{"title":"PFCatalogSearchItemsGetResult","description":"Gets the result of a successful PFCatalogSearchItemsAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogsearchitemsgetresult"},{"title":"PFCatalogSearchItemsGetResultSize","description":"Get the size in bytes needed to store the result of a SearchItems call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogsearchitemsgetresultsize"},{"title":"PFCatalogSetItemModerationStateAsync","description":"Sets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/ugc/moderation","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogsetitemmoderationstateasync"},{"title":"PFCatalogSubmitItemReviewVoteAsync","description":"Submit a vote for a review, indicating whether the review was helpful or unhelpful.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogsubmititemreviewvoteasync"},{"title":"PFCatalogTakedownItemReviewsAsync","description":"Submit a request to takedown one or more reviews.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogtakedownitemreviewsasync"},{"title":"PFCatalogUpdateCatalogConfigAsync","description":"Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/settings","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogupdatecatalogconfigasync"},{"title":"PFCatalogUpdateDraftItemAsync","description":"Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogupdatedraftitemasync"},{"title":"PFCatalogUpdateDraftItemGetResult","description":"Gets the result of a successful PFCatalogUpdateDraftItemAsync call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogupdatedraftitemgetresult"},{"title":"PFCatalogUpdateDraftItemGetResultSize","description":"Get the size in bytes needed to store the result of a UpdateDraftItem call.","href":"/services/playfab/api-references/c/pfcatalog/functions/pfcatalogupdatedraftitemgetresultsize"}]}]},{"group":"PFCatalogTypes","pages":[{"title":"Services C API overview - PFCatalogTypes.h","description":"Services C API overview - PFCatalogTypes.h","sidebarTitle":"PFCatalogTypes","href":"/services/playfab/api-references/c/pfcatalogtypes/pfcatalogtypes_members"},{"group":"Enums","pages":[{"title":"PFCatalogConcernCategory","description":"ConcernCategory enum.","href":"/services/playfab/api-references/c/pfcatalogtypes/enums/pfcatalogconcerncategory"},{"title":"PFCatalogDisplayPropertyType","description":"DisplayPropertyType enum.","href":"/services/playfab/api-references/c/pfcatalogtypes/enums/pfcatalogdisplaypropertytype"},{"title":"PFCatalogHelpfulnessVote","description":"HelpfulnessVote enum.","href":"/services/playfab/api-references/c/pfcatalogtypes/enums/pfcataloghelpfulnessvote"},{"title":"PFCatalogModerationStatus","description":"ModerationStatus enum.","href":"/services/playfab/api-references/c/pfcatalogtypes/enums/pfcatalogmoderationstatus"},{"title":"PFCatalogPublishResult","description":"PublishResult enum.","href":"/services/playfab/api-references/c/pfcatalogtypes/enums/pfcatalogpublishresult"}]},{"group":"Structs","pages":[{"title":"PFCatalogCatalogAlternateId","description":"PFCatalogCatalogAlternateId data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogalternateid"},{"title":"PFCatalogCatalogConfig","description":"PFCatalogCatalogConfig data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogconfig"},{"title":"PFCatalogCatalogItem","description":"PFCatalogCatalogItem data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogitem"},{"title":"PFCatalogCatalogItemReference","description":"PFCatalogCatalogItemReference data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogitemreference"},{"title":"PFCatalogCatalogPrice","description":"PFCatalogCatalogPrice data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogprice"},{"title":"PFCatalogCatalogPriceAmount","description":"PFCatalogCatalogPriceAmount data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogpriceamount"},{"title":"PFCatalogCatalogPriceAmountOverride","description":"PFCatalogCatalogPriceAmountOverride data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogpriceamountoverride"},{"title":"PFCatalogCatalogPriceOptions","description":"PFCatalogCatalogPriceOptions data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogpriceoptions"},{"title":"PFCatalogCatalogPriceOptionsOverride","description":"PFCatalogCatalogPriceOptionsOverride data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogpriceoptionsoverride"},{"title":"PFCatalogCatalogPriceOverride","description":"PFCatalogCatalogPriceOverride data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogpriceoverride"},{"title":"PFCatalogCatalogSpecificConfig","description":"PFCatalogCatalogSpecificConfig data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcatalogspecificconfig"},{"title":"PFCatalogCategoryRatingConfig","description":"PFCatalogCategoryRatingConfig data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcategoryratingconfig"},{"title":"PFCatalogContent","description":"PFCatalogContent data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcontent"},{"title":"PFCatalogCreateDraftItemRequest","description":"PFCatalogCreateDraftItemRequest data model. The item will not be published to the public catalog until the PublishItem API is called for the item.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcreatedraftitemrequest"},{"title":"PFCatalogCreateDraftItemResponse","description":"PFCatalogCreateDraftItemResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcreatedraftitemresponse"},{"title":"PFCatalogCreateUploadUrlsRequest","description":"PFCatalogCreateUploadUrlsRequest data model. Upload URLs point to Azure Blobs; clients must follow the Microsoft Azure Storage Blob Service REST API pattern.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcreateuploadurlsrequest"},{"title":"PFCatalogCreateUploadUrlsResponse","description":"PFCatalogCreateUploadUrlsResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogcreateuploadurlsresponse"},{"title":"PFCatalogDeepLink","description":"PFCatalogDeepLink data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogdeeplink"},{"title":"PFCatalogDeepLinkFormat","description":"PFCatalogDeepLinkFormat data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogdeeplinkformat"},{"title":"PFCatalogDeleteEntityItemReviewsRequest","description":"PFCatalogDeleteEntityItemReviewsRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogdeleteentityitemreviewsrequest"},{"title":"PFCatalogDeleteItemRequest","description":"PFCatalogDeleteItemRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogdeleteitemrequest"},{"title":"PFCatalogDisplayPropertyIndexInfo","description":"PFCatalogDisplayPropertyIndexInfo data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogdisplaypropertyindexinfo"},{"title":"PFCatalogFileConfig","description":"PFCatalogFileConfig data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogfileconfig"},{"title":"PFCatalogFilterOptions","description":"PFCatalogFilterOptions data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogfilteroptions"},{"title":"PFCatalogGetCatalogConfigRequest","description":"PFCatalogGetCatalogConfigRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetcatalogconfigrequest"},{"title":"PFCatalogGetCatalogConfigResponse","description":"PFCatalogGetCatalogConfigResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetcatalogconfigresponse"},{"title":"PFCatalogGetDraftItemRequest","description":"PFCatalogGetDraftItemRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetdraftitemrequest"},{"title":"PFCatalogGetDraftItemResponse","description":"PFCatalogGetDraftItemResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetdraftitemresponse"},{"title":"PFCatalogGetDraftItemsRequest","description":"PFCatalogGetDraftItemsRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetdraftitemsrequest"},{"title":"PFCatalogGetDraftItemsResponse","description":"PFCatalogGetDraftItemsResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetdraftitemsresponse"},{"title":"PFCatalogGetEntityDraftItemsRequest","description":"PFCatalogGetEntityDraftItemsRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetentitydraftitemsrequest"},{"title":"PFCatalogGetEntityDraftItemsResponse","description":"PFCatalogGetEntityDraftItemsResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetentitydraftitemsresponse"},{"title":"PFCatalogGetEntityItemReviewRequest","description":"PFCatalogGetEntityItemReviewRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetentityitemreviewrequest"},{"title":"PFCatalogGetEntityItemReviewResponse","description":"PFCatalogGetEntityItemReviewResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetentityitemreviewresponse"},{"title":"PFCatalogGetItemContainersRequest","description":"PFCatalogGetItemContainersRequest data model. Given an item, return a set of bundles and stores containing the item.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemcontainersrequest"},{"title":"PFCatalogGetItemContainersResponse","description":"PFCatalogGetItemContainersResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemcontainersresponse"},{"title":"PFCatalogGetItemModerationStateRequest","description":"PFCatalogGetItemModerationStateRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemmoderationstaterequest"},{"title":"PFCatalogGetItemModerationStateResponse","description":"PFCatalogGetItemModerationStateResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemmoderationstateresponse"},{"title":"PFCatalogGetItemPublishStatusRequest","description":"PFCatalogGetItemPublishStatusRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitempublishstatusrequest"},{"title":"PFCatalogGetItemPublishStatusResponse","description":"PFCatalogGetItemPublishStatusResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitempublishstatusresponse"},{"title":"PFCatalogGetItemRequest","description":"PFCatalogGetItemRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemrequest"},{"title":"PFCatalogGetItemResponse","description":"PFCatalogGetItemResponse data model. Get item result.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemresponse"},{"title":"PFCatalogGetItemReviewsRequest","description":"PFCatalogGetItemReviewsRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemreviewsrequest"},{"title":"PFCatalogGetItemReviewsResponse","description":"PFCatalogGetItemReviewsResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemreviewsresponse"},{"title":"PFCatalogGetItemReviewSummaryRequest","description":"PFCatalogGetItemReviewSummaryRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemreviewsummaryrequest"},{"title":"PFCatalogGetItemReviewSummaryResponse","description":"PFCatalogGetItemReviewSummaryResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemreviewsummaryresponse"},{"title":"PFCatalogGetItemsRequest","description":"PFCatalogGetItemsRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemsrequest"},{"title":"PFCatalogGetItemsResponse","description":"PFCatalogGetItemsResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetitemsresponse"},{"title":"PFCatalogImage","description":"PFCatalogImage data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogimage"},{"title":"PFCatalogImageConfig","description":"PFCatalogImageConfig data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogimageconfig"},{"title":"PFCatalogKeywordSet","description":"PFCatalogKeywordSet data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogkeywordset"},{"title":"PFCatalogKeywordSetDictionaryEntry","description":"Dictionary entry for an associative array with PFCatalogKeywordSet values.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogkeywordsetdictionaryentry"},{"title":"PFCatalogModerationState","description":"PFCatalogModerationState data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogmoderationstate"},{"title":"PFCatalogPermissions","description":"PFCatalogPermissions data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogpermissions"},{"title":"PFCatalogPublishDraftItemRequest","description":"PFCatalogPublishDraftItemRequest data model. The call kicks off a workflow to publish the item to the public catalog. The Publish Status API should be used.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogpublishdraftitemrequest"},{"title":"PFCatalogRating","description":"PFCatalogRating data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalograting"},{"title":"PFCatalogRealMoneyPriceDetails","description":"PFCatalogRealMoneyPriceDetails data model. The multi-currency unit price, in real money, of the item that was redeemed within an individual marketplace. Each property is a dictionary where the key is the three-letter currency code as defined in ISO 4217, and the value is the currency amount in the smallest unit (e.g. cents, pence, etc.) in accordance with ISO 4217. Example: If the product price in USD is $1.39, the dictionary entry would be: [\"USD\"] = 139. Currently, only United States Dollar (USD) is supported.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogrealmoneypricedetails"},{"title":"PFCatalogReportItemRequest","description":"PFCatalogReportItemRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogreportitemrequest"},{"title":"PFCatalogReportItemReviewRequest","description":"PFCatalogReportItemReviewRequest data model. Submit a report for an inappropriate review, allowing the submitting user to specify their concern.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogreportitemreviewrequest"},{"title":"PFCatalogReview","description":"PFCatalogReview data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogreview"},{"title":"PFCatalogReviewConfig","description":"PFCatalogReviewConfig data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogreviewconfig"},{"title":"PFCatalogReviewItemRequest","description":"PFCatalogReviewItemRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogreviewitemrequest"},{"title":"PFCatalogReviewTakedown","description":"PFCatalogReviewTakedown data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogreviewtakedown"},{"title":"PFCatalogSearchItemsRequest","description":"PFCatalogSearchItemsRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogsearchitemsrequest"},{"title":"PFCatalogSearchItemsResponse","description":"PFCatalogSearchItemsResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogsearchitemsresponse"},{"title":"PFCatalogSetItemModerationStateRequest","description":"PFCatalogSetItemModerationStateRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogsetitemmoderationstaterequest"},{"title":"PFCatalogStoreDetails","description":"PFCatalogStoreDetails data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogstoredetails"},{"title":"PFCatalogStoreReference","description":"PFCatalogStoreReference data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogstorereference"},{"title":"PFCatalogSubmitItemReviewVoteRequest","description":"PFCatalogSubmitItemReviewVoteRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogsubmititemreviewvoterequest"},{"title":"PFCatalogTakedownItemReviewsRequest","description":"PFCatalogTakedownItemReviewsRequest data model. Submit a request to takedown one or more reviews, removing them from public view. Authors will still be able to see their reviews after being taken down.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogtakedownitemreviewsrequest"},{"title":"PFCatalogUpdateCatalogConfigRequest","description":"PFCatalogUpdateCatalogConfigRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogupdatecatalogconfigrequest"},{"title":"PFCatalogUpdateDraftItemRequest","description":"PFCatalogUpdateDraftItemRequest data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogupdatedraftitemrequest"},{"title":"PFCatalogUpdateDraftItemResponse","description":"PFCatalogUpdateDraftItemResponse data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogupdatedraftitemresponse"},{"title":"PFCatalogUploadInfo","description":"PFCatalogUploadInfo data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloguploadinfo"},{"title":"PFCatalogUploadUrlMetadata","description":"PFCatalogUploadUrlMetadata data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloguploadurlmetadata"},{"title":"PFCatalogUserGeneratedContentSpecificConfig","description":"PFCatalogUserGeneratedContentSpecificConfig data model.","href":"/services/playfab/api-references/c/pfcatalogtypes/structs/pfcatalogusergeneratedcontentspecificconfig"}]}]},{"group":"PFCloudScript","pages":[{"title":"Services C API overview - PFCloudScript.h","description":"Services C API overview - PFCloudScript.h","sidebarTitle":"PFCloudScript","href":"/services/playfab/api-references/c/pfcloudscript/pfcloudscript_members"},{"group":"Functions","pages":[{"title":"PFCloudScriptClientExecuteCloudScriptAsync","description":"Client API that executes a PlayFab CloudScript function server-side, with currentPlayerId set to the authenticated player's PlayFab (master account) ID.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptclientexecutecloudscriptasync"},{"title":"PFCloudScriptClientExecuteCloudScriptGetResult","description":"Gets the result of a successful PFCloudScriptClientExecuteCloudScriptAsync call.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptclientexecutecloudscriptgetresult"},{"title":"PFCloudScriptClientExecuteCloudScriptGetResultSize","description":"Get the size in bytes needed to store the result of a ClientExecuteCloudScript call.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptclientexecutecloudscriptgetresultsize"},{"title":"PFCloudScriptExecuteEntityCloudScriptAsync","description":"Executes a PlayFab CloudScript (JavaScript) function server-side in the context of a specified entity, returning custom server logic results to the caller.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptexecuteentitycloudscriptasync"},{"title":"PFCloudScriptExecuteEntityCloudScriptGetResult","description":"Gets the result of a successful PFCloudScriptExecuteEntityCloudScriptAsync call.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptexecuteentitycloudscriptgetresult"},{"title":"PFCloudScriptExecuteEntityCloudScriptGetResultSize","description":"Get the size in bytes needed to store the result of a ExecuteEntityCloudScript call.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptexecuteentitycloudscriptgetresultsize"},{"title":"PFCloudScriptExecuteFunctionAsync","description":"Executes a PlayFab CloudScript using Azure Functions server-side handler in the context of a specified entity, returning custom logic results to the caller.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptexecutefunctionasync"},{"title":"PFCloudScriptExecuteFunctionGetResult","description":"Gets the result of a successful PFCloudScriptExecuteFunctionAsync call.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptexecutefunctiongetresult"},{"title":"PFCloudScriptExecuteFunctionGetResultSize","description":"Get the size in bytes needed to store the result of a ExecuteFunction call.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptexecutefunctiongetresultsize"},{"title":"PFCloudScriptServerExecuteCloudScriptAsync","description":"Server API that executes a PlayFab CloudScript function server-side with a specified PlayFab ID as currentPlayerId, for use from trusted game servers.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptserverexecutecloudscriptasync"},{"title":"PFCloudScriptServerExecuteCloudScriptGetResult","description":"Gets the result of a successful PFCloudScriptServerExecuteCloudScriptAsync call.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptserverexecutecloudscriptgetresult"},{"title":"PFCloudScriptServerExecuteCloudScriptGetResultSize","description":"Get the size in bytes needed to store the result of a ServerExecuteCloudScript call.","href":"/services/playfab/api-references/c/pfcloudscript/functions/pfcloudscriptserverexecutecloudscriptgetresultsize"}]}]},{"group":"PFCloudScriptTypes","pages":[{"title":"Services C API overview - PFCloudScriptTypes.h","description":"Services C API overview - PFCloudScriptTypes.h","sidebarTitle":"PFCloudScriptTypes","href":"/services/playfab/api-references/c/pfcloudscripttypes/pfcloudscripttypes_members"},{"group":"Enums","pages":[{"title":"PFCloudScriptCloudScriptRevisionOption","description":"CloudScriptRevisionOption enum.","href":"/services/playfab/api-references/c/pfcloudscripttypes/enums/pfcloudscriptcloudscriptrevisionoption"}]},{"group":"Structs","pages":[{"title":"PFCloudScriptEventHubFunctionModel","description":"PFCloudScriptEventHubFunctionModel data model.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscripteventhubfunctionmodel"},{"title":"PFCloudScriptExecuteCloudScriptRequest","description":"PFCloudScriptExecuteCloudScriptRequest data model.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptexecutecloudscriptrequest"},{"title":"PFCloudScriptExecuteCloudScriptResult","description":"PFCloudScriptExecuteCloudScriptResult data model.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptexecutecloudscriptresult"},{"title":"PFCloudScriptExecuteCloudScriptServerRequest","description":"PFCloudScriptExecuteCloudScriptServerRequest data model.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptexecutecloudscriptserverrequest"},{"title":"PFCloudScriptExecuteEntityCloudScriptRequest","description":"PFCloudScriptExecuteEntityCloudScriptRequest data model. Executes CloudScript with the entity profile that is defined in the request.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptexecuteentitycloudscriptrequest"},{"title":"PFCloudScriptExecuteFunctionRequest","description":"PFCloudScriptExecuteFunctionRequest data model. Executes an Azure Function with the profile of the entity that is defined in the request.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptexecutefunctionrequest"},{"title":"PFCloudScriptExecuteFunctionResult","description":"PFCloudScriptExecuteFunctionResult data model.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptexecutefunctionresult"},{"title":"PFCloudScriptFunctionExecutionError","description":"PFCloudScriptFunctionExecutionError data model.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptfunctionexecutionerror"},{"title":"PFCloudScriptListFunctionsRequest","description":"PFCloudScriptListFunctionsRequest data model. A title can have many functions, ListHttpFunctions will return a list of all the currently registered HTTP.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptlistfunctionsrequest"},{"title":"PFCloudScriptLogStatement","description":"PFCloudScriptLogStatement data model.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptlogstatement"},{"title":"PFCloudScriptScriptExecutionError","description":"PFCloudScriptScriptExecutionError data model.","href":"/services/playfab/api-references/c/pfcloudscripttypes/structs/pfcloudscriptscriptexecutionerror"}]}]},{"group":"PFCore","pages":[{"title":"Services C API overview - PFCore.h","description":"Services C API overview - PFCore.h","sidebarTitle":"PFCore","href":"/services/playfab/api-references/c/pfcore/pfcore_members"},{"group":"Functions","pages":[{"title":"PFInitialize","description":"Initializes PlayFabCore global state on non-Android platforms so PlayFab client APIs can be used. Custom platform hooks must be configured beforehand.","href":"/services/playfab/api-references/c/pfcore/functions/pfinitialize"},{"title":"PFInitialize (Android overload)","description":"Android overload of PFInitialize that also takes a JavaVM pointer and application Context to initialize PlayFabCore global state for Android titles.","href":"/services/playfab/api-references/c/pfcore/functions/pfinitialize_2"},{"title":"PFUninitializeAsync","description":"Cleanup PlayFab global state.","href":"/services/playfab/api-references/c/pfcore/functions/pfuninitializeasync"}]}]},{"group":"PFData","pages":[{"title":"Services C API overview - PFData.h","description":"Services C API overview - PFData.h","sidebarTitle":"PFData","href":"/services/playfab/api-references/c/pfdata/pfdata_members"},{"group":"Functions","pages":[{"title":"PFDataAbortFileUploadsAsync","description":"Abort pending file uploads to an entity's profile.","href":"/services/playfab/api-references/c/pfdata/functions/pfdataabortfileuploadsasync"},{"title":"PFDataAbortFileUploadsGetResult","description":"Gets the result of a successful PFDataAbortFileUploadsAsync call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdataabortfileuploadsgetresult"},{"title":"PFDataAbortFileUploadsGetResultSize","description":"Get the size in bytes needed to store the result of an AbortFileUploads call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdataabortfileuploadsgetresultsize"},{"title":"PFDataDeleteFilesAsync","description":"Delete files on an entity's profile.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatadeletefilesasync"},{"title":"PFDataDeleteFilesGetResult","description":"Gets the result of a successful PFDataDeleteFilesAsync call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatadeletefilesgetresult"},{"title":"PFDataDeleteFilesGetResultSize","description":"Get the size in bytes needed to store the result of a DeleteFiles call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatadeletefilesgetresultsize"},{"title":"PFDataFinalizeFileUploadsAsync","description":"Finalize file uploads to an entity's profile.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatafinalizefileuploadsasync"},{"title":"PFDataFinalizeFileUploadsGetResult","description":"Gets the result of a successful PFDataFinalizeFileUploadsAsync call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatafinalizefileuploadsgetresult"},{"title":"PFDataFinalizeFileUploadsGetResultSize","description":"Get the size in bytes needed to store the result of a FinalizeFileUploads call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatafinalizefileuploadsgetresultsize"},{"title":"PFDataGetFilesAsync","description":"Retrieves file metadata from an entity's profile.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatagetfilesasync"},{"title":"PFDataGetFilesGetResult","description":"Gets the result of a successful PFDataGetFilesAsync call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatagetfilesgetresult"},{"title":"PFDataGetFilesGetResultSize","description":"Get the size in bytes needed to store the result of a GetFiles call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatagetfilesgetresultsize"},{"title":"PFDataGetObjectsAsync","description":"Retrieves objects from an entity's profile.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatagetobjectsasync"},{"title":"PFDataGetObjectsGetResult","description":"Gets the result of a successful PFDataGetObjectsAsync call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatagetobjectsgetresult"},{"title":"PFDataGetObjectsGetResultSize","description":"Get the size in bytes needed to store the result of a GetObjects call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatagetobjectsgetresultsize"},{"title":"PFDataInitiateFileUploadsAsync","description":"Initiates file uploads to an entity's profile.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatainitiatefileuploadsasync"},{"title":"PFDataInitiateFileUploadsGetResult","description":"Gets the result of a successful PFDataInitiateFileUploadsAsync call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatainitiatefileuploadsgetresult"},{"title":"PFDataInitiateFileUploadsGetResultSize","description":"Get the size in bytes needed to store the result of a InitiateFileUploads call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatainitiatefileuploadsgetresultsize"},{"title":"PFDataSetObjectsAsync","description":"Sets objects on an entity's profile.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatasetobjectsasync"},{"title":"PFDataSetObjectsGetResult","description":"Gets the result of a successful PFDataSetObjectsAsync call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatasetobjectsgetresult"},{"title":"PFDataSetObjectsGetResultSize","description":"Get the size in bytes needed to store the result of a SetObjects call.","href":"/services/playfab/api-references/c/pfdata/functions/pfdatasetobjectsgetresultsize"}]}]},{"group":"PFDataTypes","pages":[{"title":"Services C API overview - PFDataTypes.h","description":"Services C API overview - PFDataTypes.h","sidebarTitle":"PFDataTypes","href":"/services/playfab/api-references/c/pfdatatypes/pfdatatypes_members"},{"group":"Structs","pages":[{"title":"PFDataAbortFileUploadsRequest","description":"PFDataAbortFileUploadsRequest data model. Aborts the pending upload of the requested files.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdataabortfileuploadsrequest"},{"title":"PFDataAbortFileUploadsResponse","description":"PFDataAbortFileUploadsResponse data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdataabortfileuploadsresponse"},{"title":"PFDataDeleteFilesRequest","description":"PFDataDeleteFilesRequest data model. Deletes the requested files from the entity's profile.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatadeletefilesrequest"},{"title":"PFDataDeleteFilesResponse","description":"PFDataDeleteFilesResponse data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatadeletefilesresponse"},{"title":"PFDataFinalizeFileUploadsRequest","description":"PFDataFinalizeFileUploadsRequest data model. Finalizes the upload of the requested files. Verifies that the files have been successfully uploaded and moves the file pointers from pending to live.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatafinalizefileuploadsrequest"},{"title":"PFDataFinalizeFileUploadsResponse","description":"PFDataFinalizeFileUploadsResponse data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatafinalizefileuploadsresponse"},{"title":"PFDataGetFileMetadata","description":"PFDataGetFileMetadata data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatagetfilemetadata"},{"title":"PFDataGetFileMetadataDictionaryEntry","description":"Dictionary entry for an associative array with PFDataGetFileMetadata values.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatagetfilemetadatadictionaryentry"},{"title":"PFDataGetFilesRequest","description":"PFDataGetFilesRequest data model. Returns URLs that may be used to download the files for a profile for a limited length of time. Only returns files that.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatagetfilesrequest"},{"title":"PFDataGetFilesResponse","description":"PFDataGetFilesResponse data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatagetfilesresponse"},{"title":"PFDataGetObjectsRequest","description":"PFDataGetObjectsRequest data model. Gets JSON objects from an entity profile and returns it. .","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatagetobjectsrequest"},{"title":"PFDataGetObjectsResponse","description":"PFDataGetObjectsResponse data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatagetobjectsresponse"},{"title":"PFDataInitiateFileUploadMetadata","description":"PFDataInitiateFileUploadMetadata data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatainitiatefileuploadmetadata"},{"title":"PFDataInitiateFileUploadsRequest","description":"PFDataInitiateFileUploadsRequest data model. Returns URLs that may be used to upload the files for a profile 5 minutes. After using the upload calls FinalizeFileUploads must be called to move the file status from pending to live.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatainitiatefileuploadsrequest"},{"title":"PFDataInitiateFileUploadsResponse","description":"PFDataInitiateFileUploadsResponse data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatainitiatefileuploadsresponse"},{"title":"PFDataObjectResult","description":"PFDataObjectResult data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdataobjectresult"},{"title":"PFDataObjectResultDictionaryEntry","description":"Dictionary entry for an associative array with PFDataObjectResult values.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdataobjectresultdictionaryentry"},{"title":"PFDataSetObject","description":"PFDataSetObject data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatasetobject"},{"title":"PFDataSetObjectInfo","description":"PFDataSetObjectInfo data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatasetobjectinfo"},{"title":"PFDataSetObjectsRequest","description":"PFDataSetObjectsRequest data model. Sets JSON objects on the requested entity profile. May include a version number to be used to perform optimistic concurrency operations during update. If the current version differs from the version in the request the request will be ignored. If no version is set on the request then the value will always be updated if the values differ. Using the version value does not guarantee a write though, ConcurrentEditError may still occur if multiple clients are attempting to update the same profile. .","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatasetobjectsrequest"},{"title":"PFDataSetObjectsResponse","description":"PFDataSetObjectsResponse data model.","href":"/services/playfab/api-references/c/pfdatatypes/structs/pfdatasetobjectsresponse"}]}]},{"group":"PFEntity","pages":[{"title":"Services C API overview - PFEntity.h","description":"Services C API overview - PFEntity.h","sidebarTitle":"PFEntity","href":"/services/playfab/api-references/c/pfentity/pfentity_members"},{"group":"Functions","pages":[{"title":"PFEntityCloseHandle","description":"Closes a PFEntityHandle.","href":"/services/playfab/api-references/c/pfentity/functions/pfentityclosehandle"},{"title":"PFEntityDuplicateHandle","description":"Duplicates a PFEntityHandle.","href":"/services/playfab/api-references/c/pfentity/functions/pfentityduplicatehandle"},{"title":"PFEntityGetAPIEndpoint","description":"Gets the API endpoint for the PFServiceConfig associated with an entity handle.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygetapiendpoint"},{"title":"PFEntityGetAPIEndpointSize","description":"Gets the size of the buffer needed to hold the API endpoint string from an entity handle.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygetapiendpointsize"},{"title":"PFEntityGetEntityKey","description":"Get the PFEntityKey for an entity.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygetentitykey"},{"title":"PFEntityGetEntityKeySize","description":"Get the size in bytes needed to store the PFEntityKey for an Entity.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygetentitykeysize"},{"title":"PFEntityGetEntityTokenAsync","description":"Get the cached PFEntityToken for an Entity.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygetentitytokenasync"},{"title":"PFEntityGetEntityTokenResult","description":"Gets the result of a successful PFEntityGetEntityTokenAsync call.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygetentitytokenresult"},{"title":"PFEntityGetEntityTokenResultSize","description":"Get the size in bytes needed to store the result of a PFEntityGetEntityTokenAsync call.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygetentitytokenresultsize"},{"title":"PFEntityGetSecretKey","description":"Gets the PlayFab secretKey associated with a title Entity. Will fail with E_PF_NOSECRETKEY if there is no Secret Key associated with the provided Entity.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygetsecretkey"},{"title":"PFEntityGetSecretKeySize","description":"Gets the size of the buffer needed to hold the PlayFab secretKey. Will fail with E_PF_NOSECRETKEY if there is no Secret Key associated with the provided Entity.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygetsecretkeysize"},{"title":"PFEntityGetTitleId","description":"Gets the titleId for the PFServiceConfig associated with an entity handle.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygettitleid"},{"title":"PFEntityGetTitleIdSize","description":"Gets the size of the buffer needed to hold the titleId string from an entity handle.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitygettitleidsize"},{"title":"PFEntityIsTitlePlayer","description":"Convenience method to check if an Entity is a Title Player. This is equivalent to calling PFEntityGetEntityKey and comparing entityKey.type to.","href":"/services/playfab/api-references/c/pfentity/functions/pfentityistitleplayer"},{"title":"PFEntityRegisterTokenExpiredEventHandler","description":"Register a handler for EntityToken expired events.","href":"/services/playfab/api-references/c/pfentity/functions/pfentityregistertokenexpiredeventhandler"},{"title":"PFEntityRegisterTokenRefreshedEventHandler","description":"Register a handler for EntityToken refreshed events.","href":"/services/playfab/api-references/c/pfentity/functions/pfentityregistertokenrefreshedeventhandler"},{"title":"PFEntityTokenExpiredEventHandler","description":"EntityToken expired event handler. Needed to reauthenticate players in scenarios where the SDK is unable to automatically refresh the cached EntityToken.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitytokenexpiredeventhandler"},{"title":"PFEntityTokenRefreshedEventHandler","description":"A handler invoked every time an Entity is automatically re-authenticated, thus obtaining a new EntityToken. An entity will be automatically re-authenticated.","href":"/services/playfab/api-references/c/pfentity/functions/pfentitytokenrefreshedeventhandler"},{"title":"PFEntityUnregisterTokenExpiredEventHandler","description":"Unregisters a previously registered callback.","href":"/services/playfab/api-references/c/pfentity/functions/pfentityunregistertokenexpiredeventhandler"},{"title":"PFEntityUnregisterTokenRefreshedEventHandler","description":"Unregisters a previously registered PFEntityTokenRefreshedCallback.","href":"/services/playfab/api-references/c/pfentity/functions/pfentityunregistertokenrefreshedeventhandler"}]},{"group":"Structs","pages":[{"title":"PFEntityToken","description":"PlayFab EntityToken and its expiration time. Used to authenticate PlayFab service calls.","href":"/services/playfab/api-references/c/pfentity/structs/pfentitytoken"}]}]},{"group":"PFEventPipeline","pages":[{"title":"Services C API overview - PFEventPipeline.h","description":"Services C API overview - PFEventPipeline.h","sidebarTitle":"PFEventPipeline","href":"/services/playfab/api-references/c/pfeventpipeline/pfeventpipeline_members"},{"group":"Functions","pages":[{"title":"PFEventPipelineAddUploadingEntity","description":"Adds an entity to an existing pipeline. All events emitted will be linked to this entity.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelineadduploadingentity"},{"title":"PFEventPipelineBatchUploadFailedEventHandler","description":"A handler invoked when the SDK has attempted but failed to upload a batch of event pipeline events. It is up to the client to resubmit failed events as.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelinebatchuploadfailedeventhandler"},{"title":"PFEventPipelineBatchUploadSucceededEventHandler","description":"A handler invoked when the SDK successfully uploads a batch of events.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelinebatchuploadsucceededeventhandler"},{"title":"PFEventPipelineCloseHandle","description":"Closes a PFEventPipelineHandle.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelineclosehandle"},{"title":"PFEventPipelineCreatePlayStreamPipelineHandle","description":"Creates an event pipeline to upload PlayStream events using an Entity.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelinecreateplaystreampipelinehandle"},{"title":"PFEventPipelineCreateTelemetryPipelineHandleWithEntity","description":"Creates an event pipeline to upload Telemetry events using an Entity.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelinecreatetelemetrypipelinehandlewithentity"},{"title":"PFEventPipelineCreateTelemetryPipelineHandleWithKey","description":"Creates an event pipeline to upload Telemetry events using a Telemetry Key.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelinecreatetelemetrypipelinehandlewithkey"},{"title":"PFEventPipelineDuplicateHandle","description":"Duplicates a PFEventPipelineHandle.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelineduplicatehandle"},{"title":"PFEventPipelineEmitEvent","description":"Adds a event to a pipelines buffer to be uploaded. The API will return synchronously and the event will be uploaded in the background based on the pipeline.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelineemitevent"},{"title":"PFEventPipelineRemoveUploadingEntity","description":"Remove an entity from an existing pipeline. If a valid Telemetry Key Configuration was added at pipeline creation it will switch to it.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelineremoveuploadingentity"},{"title":"PFEventPipelineUpdateConfiguration","description":"Update an existing pipeline configuration.","href":"/services/playfab/api-references/c/pfeventpipeline/functions/pfeventpipelineupdateconfiguration"}]},{"group":"Structs","pages":[{"title":"PFEvent","description":"Event to be uploaded to PlayFab.","href":"/services/playfab/api-references/c/pfeventpipeline/structs/pfevent"},{"title":"PFEventPipelineConfig","description":"Defines the Event Pipeline configuration.","href":"/services/playfab/api-references/c/pfeventpipeline/structs/pfeventpipelineconfig"},{"title":"PFEventPipelineTelemetryKeyConfig","description":"Configuration struct that defines the properties required for using Telemetry Key.","href":"/services/playfab/api-references/c/pfeventpipeline/structs/pfeventpipelinetelemetrykeyconfig"},{"title":"PFUploadedEvent","description":"Event that has been uploaded to PlayFab. Associates the service assigned ID with the clientId provided when the event was emitted.","href":"/services/playfab/api-references/c/pfeventpipeline/structs/pfuploadedevent"}]}]},{"group":"PFEvents","pages":[{"title":"Services C API overview - PFEvents.h","description":"Services C API overview - PFEvents.h","sidebarTitle":"PFEvents","href":"/services/playfab/api-references/c/pfevents/pfevents_members"},{"group":"Functions","pages":[{"title":"PFEventsWriteEventsAsync","description":"Write batches of entity based events to PlayStream. The namespace of the Event must be 'custom' or start with 'custom.'.","href":"/services/playfab/api-references/c/pfevents/functions/pfeventswriteeventsasync"},{"title":"PFEventsWriteEventsGetResult","description":"Gets the result of a successful PFEventsWriteEventsAsync call.","href":"/services/playfab/api-references/c/pfevents/functions/pfeventswriteeventsgetresult"},{"title":"PFEventsWriteEventsGetResultSize","description":"Get the size in bytes needed to store the result of a WriteEvents call.","href":"/services/playfab/api-references/c/pfevents/functions/pfeventswriteeventsgetresultsize"},{"title":"PFEventsWriteTelemetryEventsAsync","description":"Write batches of entity based events to as Telemetry events (bypass PlayStream). The namespace must be 'custom' or start with 'custom.'","href":"/services/playfab/api-references/c/pfevents/functions/pfeventswritetelemetryeventsasync"},{"title":"PFEventsWriteTelemetryEventsGetResult","description":"Gets the result of a successful PFEventsWriteTelemetryEventsAsync call.","href":"/services/playfab/api-references/c/pfevents/functions/pfeventswritetelemetryeventsgetresult"},{"title":"PFEventsWriteTelemetryEventsGetResultSize","description":"Get the size in bytes needed to store the result of a WriteTelemetryEvents call.","href":"/services/playfab/api-references/c/pfevents/functions/pfeventswritetelemetryeventsgetresultsize"}]}]},{"group":"PFEventsTypes","pages":[{"title":"Services C API overview - PFEventsTypes.h","description":"Services C API overview - PFEventsTypes.h","sidebarTitle":"PFEventsTypes","href":"/services/playfab/api-references/c/pfeventstypes/pfeventstypes_members"},{"group":"Structs","pages":[{"title":"PFEventsDataConnectionAzureBlobSettings","description":"PFEventsDataConnectionAzureBlobSettings data model.","href":"/services/playfab/api-references/c/pfeventstypes/structs/pfeventsdataconnectionazureblobsettings"},{"title":"PFEventsDataConnectionAzureDataExplorerSettings","description":"PFEventsDataConnectionAzureDataExplorerSettings data model.","href":"/services/playfab/api-references/c/pfeventstypes/structs/pfeventsdataconnectionazuredataexplorersettings"},{"title":"PFEventsDataConnectionDetails","description":"PFEventsDataConnectionDetails data model.","href":"/services/playfab/api-references/c/pfeventstypes/structs/pfeventsdataconnectiondetails"},{"title":"PFEventsDataConnectionFabricKQLSettings","description":"PFEventsDataConnectionFabricKQLSettings data model.","href":"/services/playfab/api-references/c/pfeventstypes/structs/pfeventsdataconnectionfabrickqlsettings"},{"title":"PFEventsDataConnectionSettings","description":"PFEventsDataConnectionSettings data model.","href":"/services/playfab/api-references/c/pfeventstypes/structs/pfeventsdataconnectionsettings"},{"title":"PFEventsDataConnectionStatusDetails","description":"PFEventsDataConnectionStatusDetails data model.","href":"/services/playfab/api-references/c/pfeventstypes/structs/pfeventsdataconnectionstatusdetails"},{"title":"PFEventsEventContents","description":"PFEventsEventContents data model.","href":"/services/playfab/api-references/c/pfeventstypes/structs/pfeventseventcontents"},{"title":"PFEventsWriteEventsRequest","description":"PFEventsWriteEventsRequest data model.","href":"/services/playfab/api-references/c/pfeventstypes/structs/pfeventswriteeventsrequest"},{"title":"PFEventsWriteEventsResponse","description":"PFEventsWriteEventsResponse data model.","href":"/services/playfab/api-references/c/pfeventstypes/structs/pfeventswriteeventsresponse"}]},{"group":"Enums","pages":[{"title":"PFEventsDataConnectionErrorState","description":"DataConnectionErrorState enum.","href":"/services/playfab/api-references/c/pfeventstypes/enums/pfeventsdataconnectionerrorstate"},{"title":"PFEventsDataConnectionType","description":"DataConnectionType enum.","href":"/services/playfab/api-references/c/pfeventstypes/enums/pfeventsdataconnectiontype"}]}]},{"group":"PFExperimentation","pages":[{"title":"Services C API overview - PFExperimentation.h","description":"Services C API overview - PFExperimentation.h","sidebarTitle":"PFExperimentation","href":"/services/playfab/api-references/c/pfexperimentation/pfexperimentation_members"},{"group":"Functions","pages":[{"title":"PFExperimentationGetTreatmentAssignmentAsync","description":"Gets the treatment assignments for a player for every running experiment in the title.","href":"/services/playfab/api-references/c/pfexperimentation/functions/pfexperimentationgettreatmentassignmentasync"},{"title":"PFExperimentationGetTreatmentAssignmentGetResult","description":"Gets the result of a successful PFExperimentationGetTreatmentAssignmentAsync call.","href":"/services/playfab/api-references/c/pfexperimentation/functions/pfexperimentationgettreatmentassignmentgetresult"},{"title":"PFExperimentationGetTreatmentAssignmentGetResultSize","description":"Get the size in bytes needed to store the result of a GetTreatmentAssignment call.","href":"/services/playfab/api-references/c/pfexperimentation/functions/pfexperimentationgettreatmentassignmentgetresultsize"}]}]},{"group":"PFExperimentationTypes","pages":[{"title":"Services C API overview - PFExperimentationTypes.h","description":"Services C API overview - PFExperimentationTypes.h","sidebarTitle":"PFExperimentationTypes","href":"/services/playfab/api-references/c/pfexperimentationtypes/pfexperimentationtypes_members"},{"group":"Structs","pages":[{"title":"PFExperimentationGetTreatmentAssignmentRequest","description":"PFExperimentationGetTreatmentAssignmentRequest data model. Given a title player or a title entity token, returns the treatment variants and variables.","href":"/services/playfab/api-references/c/pfexperimentationtypes/structs/pfexperimentationgettreatmentassignmentrequest"},{"title":"PFExperimentationGetTreatmentAssignmentResult","description":"PFExperimentationGetTreatmentAssignmentResult data model.","href":"/services/playfab/api-references/c/pfexperimentationtypes/structs/pfexperimentationgettreatmentassignmentresult"}]}]},{"group":"PFFriends","pages":[{"title":"Services C API overview - PFFriends.h","description":"Services C API overview - PFFriends.h","sidebarTitle":"PFFriends","href":"/services/playfab/api-references/c/pffriends/pffriends_members"},{"group":"Functions","pages":[{"title":"PFFriendsClientAddFriendAsync","description":"Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of.","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsclientaddfriendasync"},{"title":"PFFriendsClientAddFriendGetResult","description":"Gets the result of a successful PFFriendsClientAddFriendAsync call.","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsclientaddfriendgetresult"},{"title":"PFFriendsClientGetFriendsListAsync","description":"Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also.","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsclientgetfriendslistasync"},{"title":"PFFriendsClientGetFriendsListGetResult","description":"Gets the result of a successful PFFriendsClientGetFriendsListAsync call.","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsclientgetfriendslistgetresult"},{"title":"PFFriendsClientGetFriendsListGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetFriendsList call.","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsclientgetfriendslistgetresultsize"},{"title":"PFFriendsClientRemoveFriendAsync","description":"Removes a specified user from the friend list of the local user","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsclientremovefriendasync"},{"title":"PFFriendsClientSetFriendTagsAsync","description":"Updates the tag list for a specified user in the friend list of the local user","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsclientsetfriendtagsasync"},{"title":"PFFriendsServerAddFriendAsync","description":"Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName.","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsserveraddfriendasync"},{"title":"PFFriendsServerGetFriendsListAsync","description":"Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are.","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsservergetfriendslistasync"},{"title":"PFFriendsServerGetFriendsListGetResult","description":"Gets the result of a successful PFFriendsServerGetFriendsListAsync call.","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsservergetfriendslistgetresult"},{"title":"PFFriendsServerGetFriendsListGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetFriendsList call.","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsservergetfriendslistgetresultsize"},{"title":"PFFriendsServerRemoveFriendAsync","description":"Removes the specified friend from the user's friend list","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsserverremovefriendasync"},{"title":"PFFriendsServerSetFriendTagsAsync","description":"Updates the tag list for a specified user in the friend list of another user","href":"/services/playfab/api-references/c/pffriends/functions/pffriendsserversetfriendtagsasync"}]}]},{"group":"PFFriendsTypes","pages":[{"title":"Services C API overview - PFFriendsTypes.h","description":"Services C API overview - PFFriendsTypes.h","sidebarTitle":"PFFriendsTypes","href":"/services/playfab/api-references/c/pffriendstypes/pffriendstypes_members"},{"group":"Enums","pages":[{"title":"PFFriendsExternalFriendSources","description":"ExternalFriendSources enum.","href":"/services/playfab/api-references/c/pffriendstypes/enums/pffriendsexternalfriendsources"}]},{"group":"Structs","pages":[{"title":"PFFriendsAddFriendResult","description":"PFFriendsAddFriendResult data model.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsaddfriendresult"},{"title":"PFFriendsClientAddFriendRequest","description":"PFFriendsClientAddFriendRequest data model.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsclientaddfriendrequest"},{"title":"PFFriendsClientGetFriendsListRequest","description":"PFFriendsClientGetFriendsListRequest data model.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsclientgetfriendslistrequest"},{"title":"PFFriendsClientRemoveFriendRequest","description":"PFFriendsClientRemoveFriendRequest data model.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsclientremovefriendrequest"},{"title":"PFFriendsClientSetFriendTagsRequest","description":"PFFriendsClientSetFriendTagsRequest data model. This operation is not additive. It will completely replace the tag list for the specified user.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsclientsetfriendtagsrequest"},{"title":"PFFriendsFriendInfo","description":"PFFriendsFriendInfo data model.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsfriendinfo"},{"title":"PFFriendsGetFriendsListResult","description":"PFFriendsGetFriendsListResult data model. If any additional services are queried for the user's friends, those friends who also have a PlayFab account registered for the title will be returned in the results. For Facebook, user has to have logged into the title's Facebook app recently, and only friends who also plays this game will be included. Note: If the user authenticated with AuthenticationToken when calling LoginWithFacebook, instead of AccessToken, an empty list will be returned. For XBOX Live, user has to have logged into the XBOX Live recently, and only friends who also play this game will be included. XBOX Live friends include all users the caller is following, regardless of whether those users follow the caller back. This differs from FindFriendLobbies, which only considers mutual XBOX Live friends.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsgetfriendslistresult"},{"title":"PFFriendsServerAddFriendRequest","description":"PFFriendsServerAddFriendRequest data model.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsserveraddfriendrequest"},{"title":"PFFriendsServerGetFriendsListRequest","description":"PFFriendsServerGetFriendsListRequest data model.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsservergetfriendslistrequest"},{"title":"PFFriendsServerRemoveFriendRequest","description":"PFFriendsServerRemoveFriendRequest data model.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsserverremovefriendrequest"},{"title":"PFFriendsServerSetFriendTagsRequest","description":"PFFriendsServerSetFriendTagsRequest data model. This operation is not additive. It will completely replace the tag list for the specified user.","href":"/services/playfab/api-references/c/pffriendstypes/structs/pffriendsserversetfriendtagsrequest"}]}]},{"group":"PFGameSaveFiles","pages":[{"title":"Services C API overview - PFGameSaveFiles.h","description":"Services C API overview - PFGameSaveFiles.h","sidebarTitle":"PFGameSaveFiles","href":"/services/playfab/api-references/c/pfgamesavefiles/pfgamesavefiles_members"},{"group":"Functions","pages":[{"title":"PFGameSaveFilesActiveDeviceChangedCallback","description":"Callback for when the active device changes. When this callback is triggered, it means the user moved to another device so this title should return to main menu","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesactivedevicechangedcallback"},{"title":"PFGameSaveFilesAddUserWithUiAsync","description":"Adds a user to the game save system. This downloads save state from the cloud as needed, and might trigger these UI callbacks: PFGameSaveFilesUiProgressCallback, PFGameSaveFilesUiSyncFailedCallback, PFGameSaveFilesUiActiveDeviceContentionCallback, PFGameSaveFilesUiConflictCallback, PFGameSaveFilesUiOutOfStorageCallback See PFGameSaveFilesSetUiCallbacks for more detail. PFGameSaveFilesInitialize must be called prior. On XBOX and Windows platforms, stock UI is provided by the system.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesadduserwithuiasync"},{"title":"PFGameSaveFilesAddUserWithUiResult","description":"Retrieves the result of a call to PFGameSaveFilesAddUserWithUiAsync.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesadduserwithuiresult"},{"title":"PFGameSaveFilesGetFolder","description":"Returns the root folder of the game save files and folders for this user. All its files and subfolders will be synchronized with the cloud. The user must be added first using PFGameSaveFilesAddUserWithUiAsync.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesgetfolder"},{"title":"PFGameSaveFilesGetFolderSize","description":"Returns the size in bytes of the root folder of the game save files and folders for this user. The user must be added first using PFGameSaveFilesAddUserWithUiAsync.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesgetfoldersize"},{"title":"PFGameSaveFilesGetRemainingQuota","description":"Returns the amount of data available to store save data in bytes using the PFGameSaveFiles API. Going over quota will return a negative number and cause the service to block the upload.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesgetremainingquota"},{"title":"PFGameSaveFilesInitialize","description":"Initializes the PlayFab Game Save library instance.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesinitialize"},{"title":"PFGameSaveFilesIsConnectedToCloud","description":"Returns if the user is connected to cloud. The user can be disconnected from cloud when calling PFGameSaveFilesAddUserWithUiAsync() without network access and the user chooses PFGameSaveFilesUiSyncFailedUserAction::UseOffline in the PFGameSaveFilesUiSyncFailedCallback. The user can also be disconnected from cloud at anytime if another device becomes the active device. When disconnected from cloud, PFGameSaveFilesAddUserWithUiAsync() can be called again if you want to try connect to the cloud. It will show the failure UI again if the network is still offline. No need to re-init gamesave but you can if desired. While disconnected from cloud, PFGameSaveFilesUploadWithUiAsync() will not do anything but return E_PF_GAMESAVE_DISCONNECTED_FROM_CLOUD in the async completion even if there's network access.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesisconnectedtocloud"},{"title":"PFGameSaveFilesResetCloudAsync","description":"This resets the cloud game save state for this user. Normally this does not need to be called but might be useful during development or testing. This does not delete or alter the local game save.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesresetcloudasync"},{"title":"PFGameSaveFilesResetCloudResult","description":"Retrieves the result of a call to PFGameSaveFilesResetCloudAsync.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesresetcloudresult"},{"title":"PFGameSaveFilesSetActiveDeviceChangedCallback","description":"Sets the active device changed callback. When this callback is triggered, it means the user moved to another device so this title should return to main menu","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilessetactivedevicechangedcallback"},{"title":"PFGameSaveFilesSetSaveDescriptionAsync","description":"Set a short save description of the pending game save. This can be seen in the conflict or active device contention UI","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilessetsavedescriptionasync"},{"title":"PFGameSaveFilesSetSaveDescriptionResult","description":"Retrieves the result of a call to PFGameSaveFilesSetSaveDescriptionAsync.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilessetsavedescriptionresult"},{"title":"PFGameSaveFilesUninitializeAsync","description":"Cleanup PlayFab Game Save library instance.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesuninitializeasync"},{"title":"PFGameSaveFilesUninitializeResult","description":"Retrieves the result of a call to PFGameSaveFilesUninitializeAsync.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesuninitializeresult"},{"title":"PFGameSaveFilesUploadWithUiAsync","description":"Uploads all the files and folders in the folder returned by PFGameSaveFilesGetFolder(). The user must be added first. On non-Windows platforms, the upload happens in the same process as the game and might trigger these UI callbacks: PFGameSaveFilesUiProgressCallback, PFGameSaveFilesUiSyncFailedCallback On XBOX and Windows platforms, the upload is done out of process and stock UI is provided by the system. Calling this API is optional on XBOX and Windows platforms as the upload will automatically happen when the game isn't running.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesuploadwithuiasync"},{"title":"PFGameSaveFilesUploadWithUiResult","description":"Retrieves the result of a call to PFGameSaveFilesUploadWithUiAsync.","href":"/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesuploadwithuiresult"}]}]},{"group":"PFGameSaveFilesTypes","pages":[{"title":"Services C API overview - PFGameSaveFilesTypes.h","description":"Services C API overview - PFGameSaveFilesTypes.h","sidebarTitle":"PFGameSaveFilesTypes","href":"/services/playfab/api-references/c/pfgamesavefilestypes/pfgamesavefilestypes_members"},{"group":"Structs","pages":[{"title":"PFGameSaveDescriptor","description":"Struct describing a game save, including time, total and uploaded bytes, device type, ID, and friendly name, thumbnail URI, and a short save description.","href":"/services/playfab/api-references/c/pfgamesavefilestypes/structs/pfgamesavedescriptor"},{"title":"PFGameSaveInitArgs","description":"Init args for PFGameSave: a background XTaskQueue, PFGameSaveInitOptions flags, and the root saveFolder whose files and subfolders sync with the cloud.","href":"/services/playfab/api-references/c/pfgamesavefilestypes/structs/pfgamesaveinitargs"}]},{"group":"Enums","pages":[{"title":"PFGameSaveFilesAddUserOptions","description":"Options to use when adding a user to the game save system.","href":"/services/playfab/api-references/c/pfgamesavefilestypes/enums/pfgamesavefilesadduseroptions"},{"title":"PFGameSaveFilesSyncState","description":"Sync state of the game save system","href":"/services/playfab/api-references/c/pfgamesavefilestypes/enums/pfgamesavefilessyncstate"},{"title":"PFGameSaveFilesUploadOption","description":"Options to use when uploading game save files","href":"/services/playfab/api-references/c/pfgamesavefilestypes/enums/pfgamesavefilesuploadoption"},{"title":"PFGameSaveInitOptions","description":"Options to use when initializing the game save system.","href":"/services/playfab/api-references/c/pfgamesavefilestypes/enums/pfgamesaveinitoptions"}]}]},{"group":"PFGameSaveFilesUi","pages":[{"title":"Services C API overview - PFGameSaveFilesUi.h","description":"Services C API overview - PFGameSaveFilesUi.h","sidebarTitle":"PFGameSaveFilesUi","href":"/services/playfab/api-references/c/pfgamesavefilesui/pfgamesavefilesui_members"},{"group":"Functions","pages":[{"title":"PFGameSaveFilesSetUiActiveDeviceContentionResponse","description":"Sets the user response for the PFGameSaveFilesUiActiveDeviceContentionCallback. This can be called inside or outside of the callback. The state machine won't progress until the user chooses a response, or the async API is canceled.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilessetuiactivedevicecontentionresponse"},{"title":"PFGameSaveFilesSetUiCallbacks","description":"Sets the UI callbacks. These UI callbacks will trigger during PFGameSaveFilesAddUserWithUiAsync() or PFGameSaveFilesUploadWithUiAsync(). PFGameSaveFilesAddUserWithUiAsync() may trigger any UI callback while PFGameSaveFilesUploadWithUiAsync() will only trigger PFGameSaveFilesUiProgressCallback and/or PFGameSaveFilesUiSyncFailedCallback. On non-Windows platforms, setting these callbacks is required to trigger game rendered UI dialogs. On XBOX and Windows platforms, file sync is done in out of process and stock UI is provided by the platform however the title can set these callbacks to render custom UI dialogs as desired.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilessetuicallbacks"},{"title":"PFGameSaveFilesSetUiConflictResponse","description":"Sets the user response for the PFGameSaveFilesUiConflictCallback. This can be called inside or outside of the callback. The state machine won't progress until the user chooses a response, or the async API is canceled.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilessetuiconflictresponse"},{"title":"PFGameSaveFilesSetUiOutOfStorageResponse","description":"Sets the user response for the PFGameSaveFilesUiOutOfStorageCallback. This can be called inside or outside of the callback. The state machine won't progress until the user chooses a response, or the async API is canceled.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilessetuioutofstorageresponse"},{"title":"PFGameSaveFilesSetUiProgressResponse","description":"Sets the user response for the PFGameSaveFilesUiProgressCallback. This can be called inside or outside of the callback. The state machine won't progress until the user chooses a response, or the async API is canceled.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilessetuiprogressresponse"},{"title":"PFGameSaveFilesSetUiSyncFailedResponse","description":"Sets the user response for the PFGameSaveFilesUiSyncFailedCallback. This can be called inside or outside of the callback. The state machine won't progress until the user chooses a response, or the async API is canceled.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilessetuisyncfailedresponse"},{"title":"PFGameSaveFilesUiActiveDeviceContentionCallback","description":"Active device contention callback.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilesuiactivedevicecontentioncallback"},{"title":"PFGameSaveFilesUiConflictCallback","description":"Conflict callback.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilesuiconflictcallback"},{"title":"PFGameSaveFilesUiOutOfStorageCallback","description":"Callback triggered when the local device is out of storage space.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilesuioutofstoragecallback"},{"title":"PFGameSaveFilesUiProgressCallback","description":"Notification callback fired when the sync operation transitions to a new state. This callback fires once per state transition (e.g., once for PreparingForUpload, once for Uploading) -- it is NOT fired repeatedly as progress advances within a state. To get granular progress within a state, call PFGameSaveFilesUiProgressGetProgress to poll the current and total byte counts. Titles should treat this as a state-change notification (e.g., show or update a progress dialog) rather than expecting it to fire at a high frequency.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilesuiprogresscallback"},{"title":"PFGameSaveFilesUiProgressGetProgress","description":"Gets the current progress of the sync operation. Call this from within PFGameSaveFilesUiProgressCallback or poll it periodically while a sync is in progress to get up-to-date byte-level progress. During PreparingForUpload, current/total reflect uncompressed bytes processed/expected. During Uploading, current/total reflect uncompressed bytes transferred/expected. During Downloading, current/total reflect bytes downloaded/expected. If total is 0, the total size is not yet known -- titles should treat this as indeterminate progress (e.g., show a spinner) rather than dividing by zero or displaying 0%.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilesuiprogressgetprogress"},{"title":"PFGameSaveFilesUiSyncFailedCallback","description":"Sync failed callback.","href":"/services/playfab/api-references/c/pfgamesavefilesui/functions/pfgamesavefilesuisyncfailedcallback"}]},{"group":"Structs","pages":[{"title":"PFGameSaveUICallbacks","description":"UI callbacks for game save operations.","href":"/services/playfab/api-references/c/pfgamesavefilesui/structs/pfgamesaveuicallbacks"}]},{"group":"Enums","pages":[{"title":"PFGameSaveFilesUiActiveDeviceContentionUserAction","description":"The user action of the PFGameSaveFilesUiActiveDeviceContentionCallback.","href":"/services/playfab/api-references/c/pfgamesavefilesui/enums/pfgamesavefilesuiactivedevicecontentionuseraction"},{"title":"PFGameSaveFilesUiConflictUserAction","description":"The user action of the PFGameSaveFilesUiConflictCallback.","href":"/services/playfab/api-references/c/pfgamesavefilesui/enums/pfgamesavefilesuiconflictuseraction"},{"title":"PFGameSaveFilesUiOutOfStorageUserAction","description":"The user action of the PFGameSaveFilesUiOutOfStorageCallback.","href":"/services/playfab/api-references/c/pfgamesavefilesui/enums/pfgamesavefilesuioutofstorageuseraction"},{"title":"PFGameSaveFilesUiProgressUserAction","description":"The user action of the PFGameSaveFilesUiProgressCallback.","href":"/services/playfab/api-references/c/pfgamesavefilesui/enums/pfgamesavefilesuiprogressuseraction"},{"title":"PFGameSaveFilesUiSyncFailedUserAction","description":"The user action of the PFGameSaveFilesUiSyncFailedCallback.","href":"/services/playfab/api-references/c/pfgamesavefilesui/enums/pfgamesavefilesuisyncfaileduseraction"}]}]},{"group":"PFGroups","pages":[{"title":"Services C API overview - PFGroups.h","description":"Services C API overview - PFGroups.h","sidebarTitle":"PFGroups","href":"/services/playfab/api-references/c/pfgroups/pfgroups_members"},{"group":"Functions","pages":[{"title":"PFGroupsAcceptGroupApplicationAsync","description":"Accepts an outstanding invitation to join a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsacceptgroupapplicationasync"},{"title":"PFGroupsAcceptGroupInvitationAsync","description":"Accepts an invitation to join a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsacceptgroupinvitationasync"},{"title":"PFGroupsAddMembersAsync","description":"Adds members to a group or role.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsaddmembersasync"},{"title":"PFGroupsApplyToGroupAsync","description":"Applies to join a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsapplytogroupasync"},{"title":"PFGroupsApplyToGroupGetResult","description":"Gets the result of a successful PFGroupsApplyToGroupAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsapplytogroupgetresult"},{"title":"PFGroupsApplyToGroupGetResultSize","description":"Get the size in bytes needed to store the result of a ApplyToGroup call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsapplytogroupgetresultsize"},{"title":"PFGroupsBlockEntityAsync","description":"Blocks a list of entities from joining a group.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsblockentityasync"},{"title":"PFGroupsChangeMemberRoleAsync","description":"Changes the role membership of a list of entities from one role to another.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupschangememberroleasync"},{"title":"PFGroupsCreateGroupAsync","description":"Creates a new group.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupscreategroupasync"},{"title":"PFGroupsCreateGroupGetResult","description":"Gets the result of a successful PFGroupsCreateGroupAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupscreategroupgetresult"},{"title":"PFGroupsCreateGroupGetResultSize","description":"Get the size in bytes needed to store the result of a CreateGroup call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupscreategroupgetresultsize"},{"title":"PFGroupsCreateRoleAsync","description":"Creates a new group role.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupscreateroleasync"},{"title":"PFGroupsCreateRoleGetResult","description":"Gets the result of a successful PFGroupsCreateRoleAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupscreaterolegetresult"},{"title":"PFGroupsCreateRoleGetResultSize","description":"Get the size in bytes needed to store the result of a CreateRole call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupscreaterolegetresultsize"},{"title":"PFGroupsDeleteGroupAsync","description":"Deletes a group and all roles, invitations, join requests, and blocks associated with it.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsdeletegroupasync"},{"title":"PFGroupsDeleteRoleAsync","description":"Deletes an existing role in a group.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsdeleteroleasync"},{"title":"PFGroupsGetGroupAsync","description":"Gets information about a group and its roles","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsgetgroupasync"},{"title":"PFGroupsGetGroupGetResult","description":"Gets the result of a successful PFGroupsGetGroupAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsgetgroupgetresult"},{"title":"PFGroupsGetGroupGetResultSize","description":"Get the size in bytes needed to store the result of a GetGroup call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsgetgroupgetresultsize"},{"title":"PFGroupsInviteToGroupAsync","description":"Invites a player to join a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsinvitetogroupasync"},{"title":"PFGroupsInviteToGroupGetResult","description":"Gets the result of a successful PFGroupsInviteToGroupAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsinvitetogroupgetresult"},{"title":"PFGroupsInviteToGroupGetResultSize","description":"Get the size in bytes needed to store the result of a InviteToGroup call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsinvitetogroupgetresultsize"},{"title":"PFGroupsIsMemberAsync","description":"Checks to see if an entity is a member of a group or role within the group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsismemberasync"},{"title":"PFGroupsIsMemberGetResult","description":"Gets the result of a successful PFGroupsIsMemberAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsismembergetresult"},{"title":"PFGroupsListGroupApplicationsAsync","description":"Lists all outstanding requests to join a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupapplicationsasync"},{"title":"PFGroupsListGroupApplicationsGetResult","description":"Gets the result of a successful PFGroupsListGroupApplicationsAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupapplicationsgetresult"},{"title":"PFGroupsListGroupApplicationsGetResultSize","description":"Get the size in bytes needed to store the result of a ListGroupApplications call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupapplicationsgetresultsize"},{"title":"PFGroupsListGroupBlocksAsync","description":"Lists all entities blocked from joining a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupblocksasync"},{"title":"PFGroupsListGroupBlocksGetResult","description":"Gets the result of a successful PFGroupsListGroupBlocksAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupblocksgetresult"},{"title":"PFGroupsListGroupBlocksGetResultSize","description":"Get the size in bytes needed to store the result of a ListGroupBlocks call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupblocksgetresultsize"},{"title":"PFGroupsListGroupInvitationsAsync","description":"Lists all outstanding invitations for a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupinvitationsasync"},{"title":"PFGroupsListGroupInvitationsGetResult","description":"Gets the result of a successful PFGroupsListGroupInvitationsAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupinvitationsgetresult"},{"title":"PFGroupsListGroupInvitationsGetResultSize","description":"Get the size in bytes needed to store the result of a ListGroupInvitations call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupinvitationsgetresultsize"},{"title":"PFGroupsListGroupMembersAsync","description":"Lists all members for a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupmembersasync"},{"title":"PFGroupsListGroupMembersGetResult","description":"Gets the result of a successful PFGroupsListGroupMembersAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupmembersgetresult"},{"title":"PFGroupsListGroupMembersGetResultSize","description":"Get the size in bytes needed to store the result of a ListGroupMembers call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistgroupmembersgetresultsize"},{"title":"PFGroupsListMembershipAsync","description":"Lists all groups and roles for an entity","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistmembershipasync"},{"title":"PFGroupsListMembershipGetResult","description":"Gets the result of a successful PFGroupsListMembershipAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistmembershipgetresult"},{"title":"PFGroupsListMembershipGetResultSize","description":"Get the size in bytes needed to store the result of a ListMembership call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistmembershipgetresultsize"},{"title":"PFGroupsListMembershipOpportunitiesAsync","description":"Lists all outstanding invitations and group applications for an entity","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistmembershipopportunitiesasync"},{"title":"PFGroupsListMembershipOpportunitiesGetResult","description":"Gets the result of a successful PFGroupsListMembershipOpportunitiesAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistmembershipopportunitiesgetresult"},{"title":"PFGroupsListMembershipOpportunitiesGetResultSize","description":"Get the size in bytes needed to store the result of a ListMembershipOpportunities call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupslistmembershipopportunitiesgetresultsize"},{"title":"PFGroupsRemoveGroupApplicationAsync","description":"Removes an application to join a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsremovegroupapplicationasync"},{"title":"PFGroupsRemoveGroupInvitationAsync","description":"Removes an invitation join a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsremovegroupinvitationasync"},{"title":"PFGroupsRemoveMembersAsync","description":"Removes members from a group.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsremovemembersasync"},{"title":"PFGroupsUnblockEntityAsync","description":"Unblocks a list of entities from joining a group","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsunblockentityasync"},{"title":"PFGroupsUpdateGroupAsync","description":"Updates non-membership data about a group.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsupdategroupasync"},{"title":"PFGroupsUpdateGroupGetResult","description":"Gets the result of a successful PFGroupsUpdateGroupAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsupdategroupgetresult"},{"title":"PFGroupsUpdateGroupGetResultSize","description":"Get the size in bytes needed to store the result of a UpdateGroup call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsupdategroupgetresultsize"},{"title":"PFGroupsUpdateRoleAsync","description":"Updates metadata about a role.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsupdateroleasync"},{"title":"PFGroupsUpdateRoleGetResult","description":"Gets the result of a successful PFGroupsUpdateRoleAsync call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsupdaterolegetresult"},{"title":"PFGroupsUpdateRoleGetResultSize","description":"Get the size in bytes needed to store the result of a UpdateRole call.","href":"/services/playfab/api-references/c/pfgroups/functions/pfgroupsupdaterolegetresultsize"}]}]},{"group":"PFGroupsTypes","pages":[{"title":"Services C API overview - PFGroupsTypes.h","description":"Services C API overview - PFGroupsTypes.h","sidebarTitle":"PFGroupsTypes","href":"/services/playfab/api-references/c/pfgroupstypes/pfgroupstypes_members"},{"group":"Structs","pages":[{"title":"PFGroupsAcceptGroupApplicationRequest","description":"PFGroupsAcceptGroupApplicationRequest data model. Accepts an outstanding invitation to join a group if the invited entity is not blocked by the group.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsacceptgroupapplicationrequest"},{"title":"PFGroupsAcceptGroupInvitationRequest","description":"PFGroupsAcceptGroupInvitationRequest data model. Accepts an outstanding invitation to join the group if the invited entity is not blocked by the group.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsacceptgroupinvitationrequest"},{"title":"PFGroupsAddMembersRequest","description":"PFGroupsAddMembersRequest data model. Adds members to a group or role. Existing members of the group will added to roles within the group, but if the user is.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsaddmembersrequest"},{"title":"PFGroupsApplyToGroupRequest","description":"PFGroupsApplyToGroupRequest data model. Creates an application to join a group. Calling this while a group application already exists will return the same.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsapplytogrouprequest"},{"title":"PFGroupsApplyToGroupResponse","description":"PFGroupsApplyToGroupResponse data model. Describes an application to join a group.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsapplytogroupresponse"},{"title":"PFGroupsBlockEntityRequest","description":"PFGroupsBlockEntityRequest data model. Blocks a list of entities from joining a group. Blocked entities may not create new applications to join, be invited.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsblockentityrequest"},{"title":"PFGroupsChangeMemberRoleRequest","description":"PFGroupsChangeMemberRoleRequest data model. Changes the role membership of a list of entities from one role to another in a single operation.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupschangememberrolerequest"},{"title":"PFGroupsCreateGroupRequest","description":"PFGroupsCreateGroupRequest data model. Creates a new group, as well as administration and member roles, based off of a title's group template.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupscreategrouprequest"},{"title":"PFGroupsCreateGroupResponse","description":"PFGroupsCreateGroupResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupscreategroupresponse"},{"title":"PFGroupsCreateGroupRoleRequest","description":"PFGroupsCreateGroupRoleRequest data model. Creates a new role within an existing group, with no members. Both the role ID and role name must be unique within.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupscreategrouprolerequest"},{"title":"PFGroupsCreateGroupRoleResponse","description":"PFGroupsCreateGroupRoleResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupscreategrouproleresponse"},{"title":"PFGroupsDeleteGroupRequest","description":"PFGroupsDeleteGroupRequest data model. Deletes a group and all roles, invitations, join requests, and blocks associated with it. Permission to delete is only.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsdeletegrouprequest"},{"title":"PFGroupsDeleteRoleRequest","description":"PFGroupsDeleteRoleRequest data model. Returns information about the role.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsdeleterolerequest"},{"title":"PFGroupsEntityMemberRole","description":"PFGroupsEntityMemberRole data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsentitymemberrole"},{"title":"PFGroupsEntityWithLineage","description":"PFGroupsEntityWithLineage data model. Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsentitywithlineage"},{"title":"PFGroupsGetGroupRequest","description":"PFGroupsGetGroupRequest data model. Returns the ID, name, role list and other non-membership related information about a group.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgetgrouprequest"},{"title":"PFGroupsGetGroupResponse","description":"PFGroupsGetGroupResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgetgroupresponse"},{"title":"PFGroupsGroupApplication","description":"PFGroupsGroupApplication data model. Describes an application to join a group.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupapplication"},{"title":"PFGroupsGroupBlock","description":"PFGroupsGroupBlock data model. Describes an entity that is blocked from joining a group.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupblock"},{"title":"PFGroupsGroupInvitation","description":"PFGroupsGroupInvitation data model. Describes an invitation to a group.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupinvitation"},{"title":"PFGroupsGroupRole","description":"PFGroupsGroupRole data model. Describes a group role.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgrouprole"},{"title":"PFGroupsGroupWithRoles","description":"PFGroupsGroupWithRoles data model. Describes a group and the roles that it contains.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupwithroles"},{"title":"PFGroupsInviteToGroupRequest","description":"PFGroupsInviteToGroupRequest data model. Invites a player to join a group, if they are not blocked by the group. An optional role can be provided to.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsinvitetogrouprequest"},{"title":"PFGroupsInviteToGroupResponse","description":"PFGroupsInviteToGroupResponse data model. Describes an invitation to a group.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsinvitetogroupresponse"},{"title":"PFGroupsIsMemberRequest","description":"PFGroupsIsMemberRequest data model. Checks to see if an entity is a member of a group or role within the group. A result indicating if the entity is a member.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsismemberrequest"},{"title":"PFGroupsIsMemberResponse","description":"PFGroupsIsMemberResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsismemberresponse"},{"title":"PFGroupsListGroupApplicationsRequest","description":"PFGroupsListGroupApplicationsRequest data model. Lists all outstanding requests to join a group. Returns a list of all requests to join, as well as when the.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupapplicationsrequest"},{"title":"PFGroupsListGroupApplicationsResponse","description":"PFGroupsListGroupApplicationsResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupapplicationsresponse"},{"title":"PFGroupsListGroupBlocksRequest","description":"PFGroupsListGroupBlocksRequest data model. Lists all entities blocked from joining a group. A list of blocked entities is returned.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupblocksrequest"},{"title":"PFGroupsListGroupBlocksResponse","description":"PFGroupsListGroupBlocksResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupblocksresponse"},{"title":"PFGroupsListGroupInvitationsRequest","description":"PFGroupsListGroupInvitationsRequest data model. Lists all outstanding invitations for a group. Returns a list of entities that have been invited, as well as.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupinvitationsrequest"},{"title":"PFGroupsListGroupInvitationsResponse","description":"PFGroupsListGroupInvitationsResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupinvitationsresponse"},{"title":"PFGroupsListGroupMembersRequest","description":"PFGroupsListGroupMembersRequest data model. Gets a list of members and the roles they belong to within the group. If the caller does not have permission to.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupmembersrequest"},{"title":"PFGroupsListGroupMembersResponse","description":"PFGroupsListGroupMembersResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupmembersresponse"},{"title":"PFGroupsListMembershipOpportunitiesRequest","description":"PFGroupsListMembershipOpportunitiesRequest data model. Lists all outstanding group applications and invitations for an entity. Anyone may call this for any.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistmembershipopportunitiesrequest"},{"title":"PFGroupsListMembershipOpportunitiesResponse","description":"PFGroupsListMembershipOpportunitiesResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistmembershipopportunitiesresponse"},{"title":"PFGroupsListMembershipRequest","description":"PFGroupsListMembershipRequest data model. Lists the groups and roles that an entity is a part of, checking to see if group and role metadata and memberships.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistmembershiprequest"},{"title":"PFGroupsListMembershipResponse","description":"PFGroupsListMembershipResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistmembershipresponse"},{"title":"PFGroupsRemoveGroupApplicationRequest","description":"PFGroupsRemoveGroupApplicationRequest data model. Removes an existing application to join the group. This is used for both rejection of an application as.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsremovegroupapplicationrequest"},{"title":"PFGroupsRemoveGroupInvitationRequest","description":"PFGroupsRemoveGroupInvitationRequest data model. Removes an existing invitation to join the group. This is used for both rejection of an invitation as well.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsremovegroupinvitationrequest"},{"title":"PFGroupsRemoveMembersRequest","description":"PFGroupsRemoveMembersRequest data model. Removes members from a group. A member can always remove themselves from a group, regardless of permissions.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsremovemembersrequest"},{"title":"PFGroupsUnblockEntityRequest","description":"PFGroupsUnblockEntityRequest data model. Unblocks a list of entities from joining a group. No data is returned in the case of success.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsunblockentityrequest"},{"title":"PFGroupsUpdateGroupRequest","description":"PFGroupsUpdateGroupRequest data model. Updates data about a group, such as the name or default member role. Returns information about whether the update was successful. Only title claimants may modify the administration role for a group.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsupdategrouprequest"},{"title":"PFGroupsUpdateGroupResponse","description":"PFGroupsUpdateGroupResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsupdategroupresponse"},{"title":"PFGroupsUpdateGroupRoleRequest","description":"PFGroupsUpdateGroupRoleRequest data model. Updates the role name. Returns information about whether the update was successful.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsupdategrouprolerequest"},{"title":"PFGroupsUpdateGroupRoleResponse","description":"PFGroupsUpdateGroupRoleResponse data model.","href":"/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsupdategrouproleresponse"}]}]},{"group":"PFHttpConfig","pages":[{"title":"Services C API overview - PFHttpConfig.h","description":"Services C API overview - PFHttpConfig.h","sidebarTitle":"PFHttpConfig","href":"/services/playfab/api-references/c/pfhttpconfig/pfhttpconfig_members"},{"group":"Functions","pages":[{"title":"PFGetHttpRetrySettings","description":"Gets the current HTTP retry settings for the SDK.","href":"/services/playfab/api-references/c/pfhttpconfig/functions/pfgethttpretrysettings"},{"title":"PFGetHttpSettings","description":"Gets the current generic HTTP settings for the SDK.","href":"/services/playfab/api-references/c/pfhttpconfig/functions/pfgethttpsettings"},{"title":"PFSetHttpRetrySettings","description":"Sets global HTTP retry settings for the SDK.","href":"/services/playfab/api-references/c/pfhttpconfig/functions/pfsethttpretrysettings"},{"title":"PFSetHttpSettings","description":"Sets global generic HTTP settings for the SDK.","href":"/services/playfab/api-references/c/pfhttpconfig/functions/pfsethttpsettings"}]},{"group":"Structs","pages":[{"title":"PFHttpRetrySettings","description":"Struct the defines retry settings for PlayFab HTTP requests.","href":"/services/playfab/api-references/c/pfhttpconfig/structs/pfhttpretrysettings"},{"title":"PFHttpSettings","description":"Struct that defines generic Http settings for PlayFab HTTP requests. Currently holds settings to enable gzip compression on all sdk responses.","href":"/services/playfab/api-references/c/pfhttpconfig/structs/pfhttpsettings"}]}]},{"group":"PFInventory","pages":[{"title":"Services C API overview - PFInventory.h","description":"Services C API overview - PFInventory.h","sidebarTitle":"PFInventory","href":"/services/playfab/api-references/c/pfinventory/pfinventory_members"},{"group":"Functions","pages":[{"title":"PFInventoryAddInventoryItemsAsync","description":"Add inventory items. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryaddinventoryitemsasync"},{"title":"PFInventoryAddInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryAddInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryaddinventoryitemsgetresult"},{"title":"PFInventoryAddInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a AddInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryaddinventoryitemsgetresultsize"},{"title":"PFInventoryDeleteInventoryCollectionAsync","description":"Delete an Inventory Collection. More information about Inventory Collections can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/inventory/collections","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorydeleteinventorycollectionasync"},{"title":"PFInventoryDeleteInventoryItemsAsync","description":"Delete inventory items","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorydeleteinventoryitemsasync"},{"title":"PFInventoryDeleteInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryDeleteInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorydeleteinventoryitemsgetresult"},{"title":"PFInventoryDeleteInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a DeleteInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorydeleteinventoryitemsgetresultsize"},{"title":"PFInventoryExecuteInventoryOperationsAsync","description":"Execute a list of Inventory Operations. A maximum list of 50 operations can be performed by a single request. There is also a limit to 300 items that can be.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryexecuteinventoryoperationsasync"},{"title":"PFInventoryExecuteInventoryOperationsGetResult","description":"Gets the result of a successful PFInventoryExecuteInventoryOperationsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryexecuteinventoryoperationsgetresult"},{"title":"PFInventoryExecuteInventoryOperationsGetResultSize","description":"Get the size in bytes needed to store the result of a ExecuteInventoryOperations call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryexecuteinventoryoperationsgetresultsize"},{"title":"PFInventoryExecuteTransferOperationsAsync","description":"Transfer a list of inventory items. A maximum list of 50 operations can be performed by a single request. When the response code is 202, one or more operations did not complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryexecutetransferoperationsasync"},{"title":"PFInventoryExecuteTransferOperationsGetResult","description":"Gets the result of a successful PFInventoryExecuteTransferOperationsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryexecutetransferoperationsgetresult"},{"title":"PFInventoryExecuteTransferOperationsGetResultSize","description":"Get the size in bytes needed to store the result of a ExecuteTransferOperations call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryexecutetransferoperationsgetresultsize"},{"title":"PFInventoryGetInventoryCollectionIdsAsync","description":"Get Inventory Collection Ids. Up to 50 Ids can be returned at once (or 250 with response compression enabled). You can use continuation tokens to paginate.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventorycollectionidsasync"},{"title":"PFInventoryGetInventoryCollectionIdsGetResult","description":"Gets the result of a successful PFInventoryGetInventoryCollectionIdsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventorycollectionidsgetresult"},{"title":"PFInventoryGetInventoryCollectionIdsGetResultSize","description":"Get the size in bytes needed to store the result of a GetInventoryCollectionIds call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventorycollectionidsgetresultsize"},{"title":"PFInventoryGetInventoryItemsAsync","description":"Get current inventory items.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventoryitemsasync"},{"title":"PFInventoryGetInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryGetInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventoryitemsgetresult"},{"title":"PFInventoryGetInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a GetInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventoryitemsgetresultsize"},{"title":"PFInventoryGetInventoryOperationStatusAsync","description":"Get the status of an inventory operation using an OperationToken. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the this API.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventoryoperationstatusasync"},{"title":"PFInventoryGetInventoryOperationStatusGetResult","description":"Gets the result of a successful PFInventoryGetInventoryOperationStatusAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventoryoperationstatusgetresult"},{"title":"PFInventoryGetInventoryOperationStatusGetResultSize","description":"Get the size in bytes needed to store the result of a GetInventoryOperationStatus call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventoryoperationstatusgetresultsize"},{"title":"PFInventoryGetMicrosoftStoreAccessTokensGetResult","description":"Gets the result of a successful PFInventoryGetMicrosoftStoreAccessTokensAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetmicrosoftstoreaccesstokensgetresult"},{"title":"PFInventoryGetMicrosoftStoreAccessTokensGetResultSize","description":"Get the size in bytes needed to store the result of a GetMicrosoftStoreAccessTokens call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygetmicrosoftstoreaccesstokensgetresultsize"},{"title":"PFInventoryGetTransactionHistoryAsync","description":"Get transaction history for a player. Up to 50 Events can be returned at once (or 250 with response compression enabled). You can use continuation tokens to paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygettransactionhistoryasync"},{"title":"PFInventoryGetTransactionHistoryGetResult","description":"Gets the result of a successful PFInventoryGetTransactionHistoryAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygettransactionhistorygetresult"},{"title":"PFInventoryGetTransactionHistoryGetResultSize","description":"Get the size in bytes needed to store the result of a GetTransactionHistory call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorygettransactionhistorygetresultsize"},{"title":"PFInventoryPurchaseInventoryItemsAsync","description":"Purchase an item or bundle. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorypurchaseinventoryitemsasync"},{"title":"PFInventoryPurchaseInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryPurchaseInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorypurchaseinventoryitemsgetresult"},{"title":"PFInventoryPurchaseInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a PurchaseInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorypurchaseinventoryitemsgetresultsize"},{"title":"PFInventoryRedeemAppleAppStoreInventoryItemsAsync","description":"Redeem inventory items from the Apple App Store for an entity. Available on Windows and iOS; get the result size and result after the async task completes.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemappleappstoreinventoryitemsasync"},{"title":"PFInventoryRedeemAppleAppStoreInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryRedeemAppleAppStoreInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemappleappstoreinventoryitemsgetresult"},{"title":"PFInventoryRedeemAppleAppStoreInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a RedeemAppleAppStoreInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemappleappstoreinventoryitemsgetresultsize"},{"title":"PFInventoryRedeemGooglePlayInventoryItemsAsync","description":"Redeem inventory items from the Google Play Store for an entity. Available on Windows and Android; get the result size and result when the task completes.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemgoogleplayinventoryitemsasync"},{"title":"PFInventoryRedeemGooglePlayInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryRedeemGooglePlayInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemgoogleplayinventoryitemsgetresult"},{"title":"PFInventoryRedeemGooglePlayInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a RedeemGooglePlayInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemgoogleplayinventoryitemsgetresultsize"},{"title":"PFInventoryRedeemMicrosoftStoreInventoryItemsAsync","description":"Redeem items from the Microsoft Store. Supported entitlement types are Developer Manager Consumable and Durable.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemmicrosoftstoreinventoryitemsasync"},{"title":"PFInventoryRedeemMicrosoftStoreInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryRedeemMicrosoftStoreInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemmicrosoftstoreinventoryitemsgetresult"},{"title":"PFInventoryRedeemMicrosoftStoreInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a RedeemMicrosoftStoreInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemmicrosoftstoreinventoryitemsgetresultsize"},{"title":"PFInventoryRedeemNintendoEShopInventoryItemsAsync","description":"Redeems items purchased on the Nintendo eShop into a PlayFab inventory collection so entitlements from Nintendo Switch purchases are granted to the player.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemnintendoeshopinventoryitemsasync"},{"title":"PFInventoryRedeemNintendoEShopInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryRedeemNintendoEShopInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemnintendoeshopinventoryitemsgetresult"},{"title":"PFInventoryRedeemNintendoEShopInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a RedeemNintendoEShopInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemnintendoeshopinventoryitemsgetresultsize"},{"title":"PFInventoryRedeemPlayStationStoreInventoryItemsAsync","description":"Redeems items purchased on the PlayStation Store into a PlayFab inventory collection so entitlements from PlayStation purchases are granted to the player.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemplaystationstoreinventoryitemsasync"},{"title":"PFInventoryRedeemPlayStationStoreInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryRedeemPlayStationStoreInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemplaystationstoreinventoryitemsgetresult"},{"title":"PFInventoryRedeemPlayStationStoreInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a RedeemPlayStationStoreInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemplaystationstoreinventoryitemsgetresultsize"},{"title":"PFInventoryRedeemSteamInventoryItemsAsync","description":"Redeems items purchased on Steam into a PlayFab inventory collection so entitlements from Steamworks purchases are granted to the corresponding PlayFab player.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemsteaminventoryitemsasync"},{"title":"PFInventoryRedeemSteamInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryRedeemSteamInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemsteaminventoryitemsgetresult"},{"title":"PFInventoryRedeemSteamInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a RedeemSteamInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryredeemsteaminventoryitemsgetresultsize"},{"title":"PFInventorySubtractInventoryItemsAsync","description":"Subtract inventory items.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorysubtractinventoryitemsasync"},{"title":"PFInventorySubtractInventoryItemsGetResult","description":"Gets the result of a successful PFInventorySubtractInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorysubtractinventoryitemsgetresult"},{"title":"PFInventorySubtractInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a SubtractInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorysubtractinventoryitemsgetresultsize"},{"title":"PFInventoryTransferInventoryItemsAsync","description":"Transfer inventory items. When transferring across collections, a 202 response indicates that the transfer did not complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API. More information about item transfer scenarios can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/inventory/?tabs=inventory-game-manager#transfer-inventory-items","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorytransferinventoryitemsasync"},{"title":"PFInventoryTransferInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryTransferInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorytransferinventoryitemsgetresult"},{"title":"PFInventoryTransferInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a TransferInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventorytransferinventoryitemsgetresultsize"},{"title":"PFInventoryUpdateInventoryItemsAsync","description":"Update inventory items","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryupdateinventoryitemsasync"},{"title":"PFInventoryUpdateInventoryItemsGetResult","description":"Gets the result of a successful PFInventoryUpdateInventoryItemsAsync call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryupdateinventoryitemsgetresult"},{"title":"PFInventoryUpdateInventoryItemsGetResultSize","description":"Get the size in bytes needed to store the result of a UpdateInventoryItems call.","href":"/services/playfab/api-references/c/pfinventory/functions/pfinventoryupdateinventoryitemsgetresultsize"}]}]},{"group":"PFInventoryTypes","pages":[{"title":"Services C API overview - PFInventoryTypes.h","description":"Services C API overview - PFInventoryTypes.h","sidebarTitle":"PFInventoryTypes","href":"/services/playfab/api-references/c/pfinventorytypes/pfinventorytypes_members"},{"group":"Structs","pages":[{"title":"PFInventoryAddInventoryItemsOperation","description":"PFInventoryAddInventoryItemsOperation data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryaddinventoryitemsoperation"},{"title":"PFInventoryAddInventoryItemsRequest","description":"PFInventoryAddInventoryItemsRequest data model. Given an entity type, entity identifier and container details, will add the specified inventory items.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryaddinventoryitemsrequest"},{"title":"PFInventoryAddInventoryItemsResponse","description":"PFInventoryAddInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryaddinventoryitemsresponse"},{"title":"PFInventoryAlternateId","description":"PFInventoryAlternateId data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryalternateid"},{"title":"PFInventoryDeleteInventoryCollectionRequest","description":"PFInventoryDeleteInventoryCollectionRequest data model. Delete an Inventory Collection by the specified Id for an Entity.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorydeleteinventorycollectionrequest"},{"title":"PFInventoryDeleteInventoryItemsOperation","description":"PFInventoryDeleteInventoryItemsOperation data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorydeleteinventoryitemsoperation"},{"title":"PFInventoryDeleteInventoryItemsRequest","description":"PFInventoryDeleteInventoryItemsRequest data model. Given an entity type, entity identifier and container details, will delete the entity's inventory items.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorydeleteinventoryitemsrequest"},{"title":"PFInventoryDeleteInventoryItemsResponse","description":"PFInventoryDeleteInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorydeleteinventoryitemsresponse"},{"title":"PFInventoryExecuteInventoryOperationsRequest","description":"PFInventoryExecuteInventoryOperationsRequest data model. Execute a list of Inventory Operations for an Entity.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryexecuteinventoryoperationsrequest"},{"title":"PFInventoryExecuteInventoryOperationsResponse","description":"PFInventoryExecuteInventoryOperationsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryexecuteinventoryoperationsresponse"},{"title":"PFInventoryExecuteTransferOperationsRequest","description":"PFInventoryExecuteTransferOperationsRequest data model. Transfer the specified list of inventory items of an entity's container Id to another entity's container Id.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryexecutetransferoperationsrequest"},{"title":"PFInventoryExecuteTransferOperationsResponse","description":"PFInventoryExecuteTransferOperationsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryexecutetransferoperationsresponse"},{"title":"PFInventoryGetInventoryCollectionIdsRequest","description":"PFInventoryGetInventoryCollectionIdsRequest data model. Get a list of Inventory Collection Ids for the specified Entity.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygetinventorycollectionidsrequest"},{"title":"PFInventoryGetInventoryCollectionIdsResponse","description":"PFInventoryGetInventoryCollectionIdsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygetinventorycollectionidsresponse"},{"title":"PFInventoryGetInventoryItemsRequest","description":"PFInventoryGetInventoryItemsRequest data model. Given an entity type, entity identifier and container details, will get the entity's inventory items. .","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygetinventoryitemsrequest"},{"title":"PFInventoryGetInventoryItemsResponse","description":"PFInventoryGetInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygetinventoryitemsresponse"},{"title":"PFInventoryGetInventoryOperationStatusRequest","description":"PFInventoryGetInventoryOperationStatusRequest data model. Get the status of an Inventory Operation using an OperationToken.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygetinventoryoperationstatusrequest"},{"title":"PFInventoryGetInventoryOperationStatusResponse","description":"PFInventoryGetInventoryOperationStatusResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygetinventoryoperationstatusresponse"},{"title":"PFInventoryGetMicrosoftStoreAccessTokensRequest","description":"PFInventoryGetMicrosoftStoreAccessTokensRequest data model. Gets the access tokens for Microsoft Store authentication.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygetmicrosoftstoreaccesstokensrequest"},{"title":"PFInventoryGetTransactionHistoryRequest","description":"PFInventoryGetTransactionHistoryRequest data model. Get transaction history for specified entity and collection.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygettransactionhistoryrequest"},{"title":"PFInventoryGetTransactionHistoryResponse","description":"PFInventoryGetTransactionHistoryResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygettransactionhistoryresponse"},{"title":"PFInventoryGooglePlayProductPurchase","description":"PFInventoryGooglePlayProductPurchase data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygoogleplayproductpurchase"},{"title":"PFInventoryInitialValues","description":"PFInventoryInitialValues data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryinitialvalues"},{"title":"PFInventoryInventoryItem","description":"PFInventoryInventoryItem data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryinventoryitem"},{"title":"PFInventoryInventoryItemReference","description":"PFInventoryInventoryItemReference data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryinventoryitemreference"},{"title":"PFInventoryInventoryOperation","description":"PFInventoryInventoryOperation data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryinventoryoperation"},{"title":"PFInventoryPurchaseInventoryItemsOperation","description":"PFInventoryPurchaseInventoryItemsOperation data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorypurchaseinventoryitemsoperation"},{"title":"PFInventoryPurchaseInventoryItemsRequest","description":"PFInventoryPurchaseInventoryItemsRequest data model. Purchase a single item or bundle, paying the associated price.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorypurchaseinventoryitemsrequest"},{"title":"PFInventoryPurchaseInventoryItemsResponse","description":"PFInventoryPurchaseInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorypurchaseinventoryitemsresponse"},{"title":"PFInventoryPurchasePriceAmount","description":"PFInventoryPurchasePriceAmount data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorypurchasepriceamount"},{"title":"PFInventoryRedeemAppleAppStoreInventoryItemsRequest","description":"PFInventoryRedeemAppleAppStoreInventoryItemsRequest data model. Redeem items from the Apple App Store.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemappleappstoreinventoryitemsrequest"},{"title":"PFInventoryRedeemAppleAppStoreInventoryItemsResponse","description":"PFInventoryRedeemAppleAppStoreInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemappleappstoreinventoryitemsresponse"},{"title":"PFInventoryRedeemGooglePlayInventoryItemsRequest","description":"PFInventoryRedeemGooglePlayInventoryItemsRequest data model. Redeem items from the Google Play Store.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemgoogleplayinventoryitemsrequest"},{"title":"PFInventoryRedeemGooglePlayInventoryItemsResponse","description":"PFInventoryRedeemGooglePlayInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemgoogleplayinventoryitemsresponse"},{"title":"PFInventoryRedeemMicrosoftStoreInventoryItemsRequest","description":"PFInventoryRedeemMicrosoftStoreInventoryItemsRequest data model. Redeem items from the Microsoft Store.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemmicrosoftstoreinventoryitemsrequest"},{"title":"PFInventoryRedeemMicrosoftStoreInventoryItemsResponse","description":"PFInventoryRedeemMicrosoftStoreInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemmicrosoftstoreinventoryitemsresponse"},{"title":"PFInventoryRedeemNintendoEShopInventoryItemsRequest","description":"PFInventoryRedeemNintendoEShopInventoryItemsRequest data model. Redeem items from the Nintendo EShop.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemnintendoeshopinventoryitemsrequest"},{"title":"PFInventoryRedeemNintendoEShopInventoryItemsResponse","description":"PFInventoryRedeemNintendoEShopInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemnintendoeshopinventoryitemsresponse"},{"title":"PFInventoryRedeemPlayStationStoreInventoryItemsRequest","description":"PFInventoryRedeemPlayStationStoreInventoryItemsRequest data model. Redeem items from the PlayStation Store.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemplaystationstoreinventoryitemsrequest"},{"title":"PFInventoryRedeemPlayStationStoreInventoryItemsResponse","description":"PFInventoryRedeemPlayStationStoreInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemplaystationstoreinventoryitemsresponse"},{"title":"PFInventoryRedeemSteamInventoryItemsRequest","description":"PFInventoryRedeemSteamInventoryItemsRequest data model. Redeem inventory items from Steam.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemsteaminventoryitemsrequest"},{"title":"PFInventoryRedeemSteamInventoryItemsResponse","description":"PFInventoryRedeemSteamInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredeemsteaminventoryitemsresponse"},{"title":"PFInventoryRedemptionFailure","description":"PFInventoryRedemptionFailure data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredemptionfailure"},{"title":"PFInventoryRedemptionSuccess","description":"PFInventoryRedemptionSuccess data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryredemptionsuccess"},{"title":"PFInventorySubtractInventoryItemsOperation","description":"PFInventorySubtractInventoryItemsOperation data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorysubtractinventoryitemsoperation"},{"title":"PFInventorySubtractInventoryItemsRequest","description":"PFInventorySubtractInventoryItemsRequest data model. Given an entity type, entity identifier and container details, will subtract the specified inventory items. .","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorysubtractinventoryitemsrequest"},{"title":"PFInventorySubtractInventoryItemsResponse","description":"PFInventorySubtractInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorysubtractinventoryitemsresponse"},{"title":"PFInventoryTransaction","description":"PFInventoryTransaction data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorytransaction"},{"title":"PFInventoryTransactionClawbackDetails","description":"PFInventoryTransactionClawbackDetails data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorytransactionclawbackdetails"},{"title":"PFInventoryTransactionOperation","description":"PFInventoryTransactionOperation data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorytransactionoperation"},{"title":"PFInventoryTransactionPurchaseDetails","description":"PFInventoryTransactionPurchaseDetails data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorytransactionpurchasedetails"},{"title":"PFInventoryTransactionRedeemDetails","description":"PFInventoryTransactionRedeemDetails data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorytransactionredeemdetails"},{"title":"PFInventoryTransactionTransferDetails","description":"PFInventoryTransactionTransferDetails data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorytransactiontransferdetails"},{"title":"PFInventoryTransferInventoryItemsOperation","description":"PFInventoryTransferInventoryItemsOperation data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorytransferinventoryitemsoperation"},{"title":"PFInventoryTransferInventoryItemsRequest","description":"PFInventoryTransferInventoryItemsRequest data model. Transfer the specified inventory items of an entity's container Id to another entity's container Id.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorytransferinventoryitemsrequest"},{"title":"PFInventoryTransferInventoryItemsResponse","description":"PFInventoryTransferInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorytransferinventoryitemsresponse"},{"title":"PFInventoryUpdateInventoryItemsOperation","description":"PFInventoryUpdateInventoryItemsOperation data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryupdateinventoryitemsoperation"},{"title":"PFInventoryUpdateInventoryItemsRequest","description":"PFInventoryUpdateInventoryItemsRequest data model. Given an entity type, entity identifier and container details, will update the entity's inventory items.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryupdateinventoryitemsrequest"},{"title":"PFInventoryUpdateInventoryItemsResponse","description":"PFInventoryUpdateInventoryItemsResponse data model.","href":"/services/playfab/api-references/c/pfinventorytypes/structs/pfinventoryupdateinventoryitemsresponse"}]}]},{"group":"PFLeaderboards","pages":[{"title":"Services C API overview - PFLeaderboards.h","description":"Overview of the PFLeaderboards.h header in the PlayFab Services C API, listing the functions for creating, updating, and querying leaderboards.","sidebarTitle":"PFLeaderboards","href":"/services/playfab/api-references/c/pfleaderboards/pfleaderboards_members"},{"group":"Functions","pages":[{"title":"PFLeaderboardsCreateLeaderboardDefinitionAsync","description":"Reference for PFLeaderboardsCreateLeaderboardDefinitionAsync, a PlayFab Services C API function that creates a new leaderboard definition.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardscreateleaderboarddefinitionasync"},{"title":"PFLeaderboardsDeleteLeaderboardDefinitionAsync","description":"Reference for PFLeaderboardsDeleteLeaderboardDefinitionAsync, a PlayFab Services C API function that deletes a leaderboard definition.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsdeleteleaderboarddefinitionasync"},{"title":"PFLeaderboardsDeleteLeaderboardEntriesAsync","description":"Reference for PFLeaderboardsDeleteLeaderboardEntriesAsync, a PlayFab Services C API function that deletes specified entries from a leaderboard.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsdeleteleaderboardentriesasync"},{"title":"PFLeaderboardsGetFriendLeaderboardForEntityAsync","description":"Reference for PFLeaderboardsGetFriendLeaderboardForEntityAsync, a PlayFab Services C API function that gets a friend leaderboard of up to 25 entries.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetfriendleaderboardforentityasync"},{"title":"PFLeaderboardsGetFriendLeaderboardForEntityGetResult","description":"Reference for PFLeaderboardsGetFriendLeaderboardForEntityGetResult, which retrieves the result of a friend leaderboard call in the PlayFab C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetfriendleaderboardforentitygetresult"},{"title":"PFLeaderboardsGetFriendLeaderboardForEntityGetResultSize","description":"Reference for PFLeaderboardsGetFriendLeaderboardForEntityGetResultSize, which gets the result buffer size in bytes in the PlayFab C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetfriendleaderboardforentitygetresultsize"},{"title":"PFLeaderboardsGetLeaderboardAroundEntityAsync","description":"Reference for PFLeaderboardsGetLeaderboardAroundEntityAsync, a PlayFab Services C API function that gets leaderboard entries around an entity.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardaroundentityasync"},{"title":"PFLeaderboardsGetLeaderboardAroundEntityGetResult","description":"Reference for PFLeaderboardsGetLeaderboardAroundEntityGetResult, which retrieves a completed leaderboard-around-entity result in the PlayFab C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardaroundentitygetresult"},{"title":"PFLeaderboardsGetLeaderboardAroundEntityGetResultSize","description":"Reference for PFLeaderboardsGetLeaderboardAroundEntityGetResultSize, which returns the buffer size in bytes for the result in the PlayFab C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardaroundentitygetresultsize"},{"title":"PFLeaderboardsGetLeaderboardAsync","description":"Reference for PFLeaderboardsGetLeaderboardAsync, a PlayFab Services C API function that gets a leaderboard for an entity type and statistic.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardasync"},{"title":"PFLeaderboardsGetLeaderboardDefinitionAsync","description":"Reference for PFLeaderboardsGetLeaderboardDefinitionAsync, a PlayFab Services C API function that gets a specified leaderboard definition.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboarddefinitionasync"},{"title":"PFLeaderboardsGetLeaderboardDefinitionGetResult","description":"Reference for PFLeaderboardsGetLeaderboardDefinitionGetResult, which retrieves the leaderboard definition result in the PlayFab Services C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboarddefinitiongetresult"},{"title":"PFLeaderboardsGetLeaderboardDefinitionGetResultSize","description":"Reference for PFLeaderboardsGetLeaderboardDefinitionGetResultSize, which returns the result buffer size in bytes in the PlayFab C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboarddefinitiongetresultsize"},{"title":"PFLeaderboardsGetLeaderboardForEntitiesAsync","description":"Reference for PFLeaderboardsGetLeaderboardForEntitiesAsync, a PlayFab Services C API function that gets a leaderboard for a set of entities.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardforentitiesasync"},{"title":"PFLeaderboardsGetLeaderboardForEntitiesGetResult","description":"Reference for PFLeaderboardsGetLeaderboardForEntitiesGetResult, which retrieves the entity set leaderboard result in the PlayFab Services C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardforentitiesgetresult"},{"title":"PFLeaderboardsGetLeaderboardForEntitiesGetResultSize","description":"Reference for PFLeaderboardsGetLeaderboardForEntitiesGetResultSize, which returns the result buffer size in bytes in the PlayFab C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardforentitiesgetresultsize"},{"title":"PFLeaderboardsGetLeaderboardGetResult","description":"Reference for PFLeaderboardsGetLeaderboardGetResult, which retrieves the result of a completed GetLeaderboardAsync call in the PlayFab Services C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardgetresult"},{"title":"PFLeaderboardsGetLeaderboardGetResultSize","description":"Reference for PFLeaderboardsGetLeaderboardGetResultSize, which returns the buffer size in bytes for the leaderboard result in the PlayFab C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardgetresultsize"},{"title":"PFLeaderboardsIncrementLeaderboardVersionAsync","description":"Reference for PFLeaderboardsIncrementLeaderboardVersionAsync, a PlayFab Services C API function that increments a leaderboard version.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsincrementleaderboardversionasync"},{"title":"PFLeaderboardsIncrementLeaderboardVersionGetResult","description":"Gets the result of a successful PFLeaderboardsIncrementLeaderboardVersionAsync call.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsincrementleaderboardversiongetresult"},{"title":"PFLeaderboardsListLeaderboardDefinitionsAsync","description":"Reference for PFLeaderboardsListLeaderboardDefinitionsAsync, a PlayFab Services C API function that lists a title's leaderboard definitions.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardslistleaderboarddefinitionsasync"},{"title":"PFLeaderboardsListLeaderboardDefinitionsGetResult","description":"Reference for PFLeaderboardsListLeaderboardDefinitionsGetResult, which retrieves the list of leaderboard definitions in the PlayFab C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardslistleaderboarddefinitionsgetresult"},{"title":"PFLeaderboardsListLeaderboardDefinitionsGetResultSize","description":"Reference for PFLeaderboardsListLeaderboardDefinitionsGetResultSize, which returns the result buffer size in bytes in the PlayFab C API.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardslistleaderboarddefinitionsgetresultsize"},{"title":"PFLeaderboardsUnlinkLeaderboardFromStatisticAsync","description":"Reference for PFLeaderboardsUnlinkLeaderboardFromStatisticAsync, a PlayFab Services C API function that unlinks a leaderboard from its statistic.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsunlinkleaderboardfromstatisticasync"},{"title":"PFLeaderboardsUpdateLeaderboardDefinitionAsync","description":"Reference for PFLeaderboardsUpdateLeaderboardDefinitionAsync, a PlayFab Services C API function that updates a leaderboard definition.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsupdateleaderboarddefinitionasync"},{"title":"PFLeaderboardsUpdateLeaderboardEntriesAsync","description":"Reference for PFLeaderboardsUpdateLeaderboardEntriesAsync, a PlayFab Services C API function that adds or updates leaderboard entries.","href":"/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsupdateleaderboardentriesasync"}]}]},{"group":"PFLeaderboardsTypes","pages":[{"title":"Services C API overview - PFLeaderboardsTypes.h","description":"Overview of the PFLeaderboardsTypes.h header in the PlayFab Services C API, listing the structs and enumerations used for leaderboard operations.","sidebarTitle":"PFLeaderboardsTypes","href":"/services/playfab/api-references/c/pfleaderboardstypes/pfleaderboardstypes_members"},{"group":"Structs","pages":[{"title":"PFLeaderboardsCreateLeaderboardDefinitionRequest","description":"Reference for the PFLeaderboardsCreateLeaderboardDefinitionRequest struct in the PlayFab Services C API, describing columns, name, and version settings.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardscreateleaderboarddefinitionrequest"},{"title":"PFLeaderboardsDeleteLeaderboardDefinitionRequest","description":"Reference for the PFLeaderboardsDeleteLeaderboardDefinitionRequest struct in the PlayFab Services C API, naming the leaderboard definition to delete.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsdeleteleaderboarddefinitionrequest"},{"title":"PFLeaderboardsDeleteLeaderboardEntriesRequest","description":"Reference for the PFLeaderboardsDeleteLeaderboardEntriesRequest struct in the PlayFab Services C API, specifying entity IDs to remove from a leaderboard.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsdeleteleaderboardentriesrequest"},{"title":"PFLeaderboardsEntityLeaderboardEntry","description":"Reference for the PFLeaderboardsEntityLeaderboardEntry struct in the PlayFab Services C API, describing an entity's rank, scores, and metadata.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsentityleaderboardentry"},{"title":"PFLeaderboardsGetEntityLeaderboardRequest","description":"Reference for the PFLeaderboardsGetEntityLeaderboardRequest struct in the PlayFab Services C API, with members to request a page of leaderboard rankings.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsgetentityleaderboardrequest"},{"title":"PFLeaderboardsGetEntityLeaderboardResponse","description":"Reference for the PFLeaderboardsGetEntityLeaderboardResponse struct in the PlayFab Services C API, describing returned columns, rankings, and version.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsgetentityleaderboardresponse"},{"title":"PFLeaderboardsGetFriendLeaderboardForEntityRequest","description":"Reference for the PFLeaderboardsGetFriendLeaderboardForEntityRequest struct in the PlayFab Services C API, used to query a friend leaderboard.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsgetfriendleaderboardforentityrequest"},{"title":"PFLeaderboardsGetLeaderboardAroundEntityRequest","description":"PFLeaderboardsGetLeaderboardAroundEntityRequest data model. Request to load a section of a leaderboard centered on a specific entity.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsgetleaderboardaroundentityrequest"},{"title":"PFLeaderboardsGetLeaderboardDefinitionRequest","description":"Reference for the PFLeaderboardsGetLeaderboardDefinitionRequest struct in the PlayFab Services C API, naming the leaderboard whose definition to retrieve.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsgetleaderboarddefinitionrequest"},{"title":"PFLeaderboardsGetLeaderboardDefinitionResponse","description":"Reference for the PFLeaderboardsGetLeaderboardDefinitionResponse struct in the PlayFab Services C API, describing a leaderboard's columns and version.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsgetleaderboarddefinitionresponse"},{"title":"PFLeaderboardsGetLeaderboardForEntitiesRequest","description":"Reference for the PFLeaderboardsGetLeaderboardForEntitiesRequest struct in the PlayFab Services C API, used to request rankings for a set of entity IDs.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsgetleaderboardforentitiesrequest"},{"title":"PFLeaderboardsIncrementLeaderboardVersionRequest","description":"Reference for the PFLeaderboardsIncrementLeaderboardVersionRequest struct in the PlayFab Services C API, naming the leaderboard version to increment.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsincrementleaderboardversionrequest"},{"title":"PFLeaderboardsIncrementLeaderboardVersionResponse","description":"Reference for the PFLeaderboardsIncrementLeaderboardVersionResponse struct in the PlayFab Services C API, returning the new leaderboard version number.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsincrementleaderboardversionresponse"},{"title":"PFLeaderboardsLeaderboardColumn","description":"Reference for the PFLeaderboardsLeaderboardColumn struct in the PlayFab Services C API, describing a column's name, sort direction, and linked statistic.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsleaderboardcolumn"},{"title":"PFLeaderboardsLeaderboardDefinition","description":"Reference for the PFLeaderboardsLeaderboardDefinition struct in the PlayFab Services C API, listing a leaderboard's columns, entity type, and versioning.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsleaderboarddefinition"},{"title":"PFLeaderboardsLeaderboardEntityRankOnVersionEndConfig","description":"Reference for the PFLeaderboardsLeaderboardEntityRankOnVersionEndConfig struct in the PlayFab Services C API, configuring top rank events on version end.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsleaderboardentityrankonversionendconfig"},{"title":"PFLeaderboardsLeaderboardEntryUpdate","description":"Reference for the PFLeaderboardsLeaderboardEntryUpdate struct in the PlayFab Services C API, describing entity ID, scores, and metadata for an entry.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsleaderboardentryupdate"},{"title":"PFLeaderboardsLeaderboardEventEmissionConfig","description":"Reference for the PFLeaderboardsLeaderboardEventEmissionConfig struct in the PlayFab Services C API, for events emitted on leaderboard version end.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsleaderboardeventemissionconfig"},{"title":"PFLeaderboardsLeaderboardVersionEndConfig","description":"Reference for the PFLeaderboardsLeaderboardVersionEndConfig struct in the PlayFab Services C API, with the event type emitted on leaderboard version end.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsleaderboardversionendconfig"},{"title":"PFLeaderboardsLinkedStatisticColumn","description":"Reference for the PFLeaderboardsLinkedStatisticColumn struct in the PlayFab Services C API, linking a leaderboard column to a statistic column by name.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardslinkedstatisticcolumn"},{"title":"PFLeaderboardsListLeaderboardDefinitionsRequest","description":"Reference for the PFLeaderboardsListLeaderboardDefinitionsRequest struct in the PlayFab Services C API, with page size and skip token paging members.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardslistleaderboarddefinitionsrequest"},{"title":"PFLeaderboardsListLeaderboardDefinitionsResponse","description":"Reference for the PFLeaderboardsListLeaderboardDefinitionsResponse struct in the PlayFab Services C API, listing a title's leaderboard definitions.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardslistleaderboarddefinitionsresponse"},{"title":"PFLeaderboardsUnlinkLeaderboardFromStatisticRequest","description":"Reference for the PFLeaderboardsUnlinkLeaderboardFromStatisticRequest struct in the PlayFab Services C API, for unlinking a leaderboard from a statistic.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsunlinkleaderboardfromstatisticrequest"},{"title":"PFLeaderboardsUpdateLeaderboardDefinitionRequest","description":"Reference for the PFLeaderboardsUpdateLeaderboardDefinitionRequest struct in the PlayFab Services C API, with members to modify an existing leaderboard.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsupdateleaderboarddefinitionrequest"},{"title":"PFLeaderboardsUpdateLeaderboardEntriesRequest","description":"Reference for the PFLeaderboardsUpdateLeaderboardEntriesRequest struct in the PlayFab Services C API, with entry updates to apply to a named leaderboard.","href":"/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsupdateleaderboardentriesrequest"}]},{"group":"Enums","pages":[{"title":"PFExternalFriendSources","description":"External friend sources enum defined in PFLeaderboardsTypes.h, a uint32_t flags type with values for None, Steam, Facebook, Xbox, Psn, and All.","href":"/services/playfab/api-references/c/pfleaderboardstypes/enums/pfexternalfriendsources"},{"title":"PFLeaderboardsLeaderboardSortDirection","description":"Reference for the PFLeaderboardsLeaderboardSortDirection enumeration in the PlayFab Services C API, listing Descending and Ascending column sort values.","href":"/services/playfab/api-references/c/pfleaderboardstypes/enums/pfleaderboardsleaderboardsortdirection"}]}]},{"group":"PFLocalization","pages":[{"title":"Services C API overview - PFLocalization.h","description":"Overview of the PFLocalization.h header in the PlayFab Services C API, listing the functions for retrieving the list of allowed languages for a title.","sidebarTitle":"PFLocalization","href":"/services/playfab/api-references/c/pflocalization/pflocalization_members"},{"group":"Functions","pages":[{"title":"PFLocalizationGetLanguageListAsync","description":"Reference for PFLocalizationGetLanguageListAsync, a PlayFab Services C API function that retrieves the list of allowed languages for a title entity.","href":"/services/playfab/api-references/c/pflocalization/functions/pflocalizationgetlanguagelistasync"},{"title":"PFLocalizationGetLanguageListGetResult","description":"Reference for PFLocalizationGetLanguageListGetResult, which retrieves the result of a completed GetLanguageListAsync call in the PlayFab Services C API.","href":"/services/playfab/api-references/c/pflocalization/functions/pflocalizationgetlanguagelistgetresult"},{"title":"PFLocalizationGetLanguageListGetResultSize","description":"Reference for PFLocalizationGetLanguageListGetResultSize, which returns the buffer size in bytes needed for a GetLanguageList result in the PlayFab C API.","href":"/services/playfab/api-references/c/pflocalization/functions/pflocalizationgetlanguagelistgetresultsize"}]}]},{"group":"PFLocalizationTypes","pages":[{"title":"Services C API overview - PFLocalizationTypes.h","description":"Overview of the PFLocalizationTypes.h header in the PlayFab Services C API, listing the request and response structs used by GetLanguageList calls.","sidebarTitle":"PFLocalizationTypes","href":"/services/playfab/api-references/c/pflocalizationtypes/pflocalizationtypes_members"},{"group":"Structs","pages":[{"title":"PFLocalizationGetLanguageListRequest","description":"Reference for the PFLocalizationGetLanguageListRequest struct in the PlayFab C API, describing the members used to request the allowed language list.","href":"/services/playfab/api-references/c/pflocalizationtypes/structs/pflocalizationgetlanguagelistrequest"},{"title":"PFLocalizationGetLanguageListResponse","description":"Reference for the PFLocalizationGetLanguageListResponse struct in the PlayFab C API, describing the returned list of allowed languages in BCP47 format.","href":"/services/playfab/api-references/c/pflocalizationtypes/structs/pflocalizationgetlanguagelistresponse"}]}]},{"group":"PFMultiplayerServer","pages":[{"title":"Services C API overview - PFMultiplayerServer.h","description":"Services C API overview - PFMultiplayerServer.h","sidebarTitle":"PFMultiplayerServer","href":"/services/playfab/api-references/c/pfmultiplayerserver/pfmultiplayerserver_members"},{"group":"Functions","pages":[{"title":"PFMultiplayerServerListBuildAliasesAsync","description":"Lists details of all build aliases for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverlistbuildaliasesasync"},{"title":"PFMultiplayerServerListBuildAliasesGetResult","description":"Gets the result of a successful PFMultiplayerServerListBuildAliasesAsync call.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverlistbuildaliasesgetresult"},{"title":"PFMultiplayerServerListBuildAliasesGetResultSize","description":"Get the size in bytes needed to store the result of a ListBuildAliases call.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverlistbuildaliasesgetresultsize"},{"title":"PFMultiplayerServerListBuildSummariesV2Async","description":"Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client access is enabled, allows game client to.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverlistbuildsummariesv2async"},{"title":"PFMultiplayerServerListBuildSummariesV2GetResult","description":"Gets the result of a successful PFMultiplayerServerListBuildSummariesV2Async call.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverlistbuildsummariesv2getresult"},{"title":"PFMultiplayerServerListBuildSummariesV2GetResultSize","description":"Get the size in bytes needed to store the result of a ListBuildSummariesV2 call.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverlistbuildsummariesv2getresultsize"},{"title":"PFMultiplayerServerListQosServersForTitleAsync","description":"Lists quality of service servers for the title. By default, servers are only returned for regions where a Multiplayer Servers build has been deployed.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverlistqosserversfortitleasync"},{"title":"PFMultiplayerServerListQosServersForTitleGetResult","description":"Gets the result of a successful PFMultiplayerServerListQosServersForTitleAsync call.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverlistqosserversfortitlegetresult"},{"title":"PFMultiplayerServerListQosServersForTitleGetResultSize","description":"Get the size in bytes needed to store the result of a ListQosServersForTitle call.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverlistqosserversfortitlegetresultsize"},{"title":"PFMultiplayerServerRequestMultiplayerServerAsync","description":"Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client to request a server with player.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverrequestmultiplayerserverasync"},{"title":"PFMultiplayerServerRequestMultiplayerServerGetResult","description":"Gets the result of a successful PFMultiplayerServerRequestMultiplayerServerAsync call.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverrequestmultiplayerservergetresult"},{"title":"PFMultiplayerServerRequestMultiplayerServerGetResultSize","description":"Get the size in bytes needed to store the result of a RequestMultiplayerServer call.","href":"/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverrequestmultiplayerservergetresultsize"}]}]},{"group":"PFMultiplayerServerTypes","pages":[{"title":"Services C API overview - PFMultiplayerServerTypes.h","description":"Services C API overview - PFMultiplayerServerTypes.h","sidebarTitle":"PFMultiplayerServerTypes","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/pfmultiplayerservertypes_members"},{"group":"Enums","pages":[{"title":"PFMultiplayerServerAzureVmSize","description":"AzureVmSize enum.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/enums/pfmultiplayerserverazurevmsize"},{"title":"PFMultiplayerServerProtocolType","description":"ProtocolType enum.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/enums/pfmultiplayerserverprotocoltype"}]},{"group":"Structs","pages":[{"title":"PFMultiplayerServerBuildAliasDetailsResponse","description":"PFMultiplayerServerBuildAliasDetailsResponse data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverbuildaliasdetailsresponse"},{"title":"PFMultiplayerServerBuildAliasParams","description":"PFMultiplayerServerBuildAliasParams data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverbuildaliasparams"},{"title":"PFMultiplayerServerBuildRegion","description":"PFMultiplayerServerBuildRegion data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverbuildregion"},{"title":"PFMultiplayerServerBuildSelectionCriterion","description":"PFMultiplayerServerBuildSelectionCriterion data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverbuildselectioncriterion"},{"title":"PFMultiplayerServerBuildSummary","description":"PFMultiplayerServerBuildSummary data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverbuildsummary"},{"title":"PFMultiplayerServerConnectedPlayer","description":"PFMultiplayerServerConnectedPlayer data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverconnectedplayer"},{"title":"PFMultiplayerServerCurrentServerStats","description":"PFMultiplayerServerCurrentServerStats data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerservercurrentserverstats"},{"title":"PFMultiplayerServerDynamicStandbySettings","description":"PFMultiplayerServerDynamicStandbySettings data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverdynamicstandbysettings"},{"title":"PFMultiplayerServerDynamicStandbyThreshold","description":"PFMultiplayerServerDynamicStandbyThreshold data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverdynamicstandbythreshold"},{"title":"PFMultiplayerServerListBuildAliasesRequest","description":"PFMultiplayerServerListBuildAliasesRequest data model. Returns a list of summarized details of all multiplayer server builds for a title.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverlistbuildaliasesrequest"},{"title":"PFMultiplayerServerListBuildAliasesResponse","description":"PFMultiplayerServerListBuildAliasesResponse data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverlistbuildaliasesresponse"},{"title":"PFMultiplayerServerListBuildSummariesRequest","description":"PFMultiplayerServerListBuildSummariesRequest data model. Returns a list of summarized details of all multiplayer server builds for a title.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverlistbuildsummariesrequest"},{"title":"PFMultiplayerServerListBuildSummariesResponse","description":"PFMultiplayerServerListBuildSummariesResponse data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverlistbuildsummariesresponse"},{"title":"PFMultiplayerServerListQosServersForTitleRequest","description":"PFMultiplayerServerListQosServersForTitleRequest data model. Returns a list of quality of service servers for a title.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverlistqosserversfortitlerequest"},{"title":"PFMultiplayerServerListQosServersForTitleResponse","description":"PFMultiplayerServerListQosServersForTitleResponse data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverlistqosserversfortitleresponse"},{"title":"PFMultiplayerServerPartyInvitationConfiguration","description":"PFMultiplayerServerPartyInvitationConfiguration data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverpartyinvitationconfiguration"},{"title":"PFMultiplayerServerPartyNetworkConfiguration","description":"PFMultiplayerServerPartyNetworkConfiguration data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverpartynetworkconfiguration"},{"title":"PFMultiplayerServerPort","description":"PFMultiplayerServerPort data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverport"},{"title":"PFMultiplayerServerPublicIpAddress","description":"PFMultiplayerServerPublicIpAddress data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverpublicipaddress"},{"title":"PFMultiplayerServerQosServer","description":"PFMultiplayerServerQosServer data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverqosserver"},{"title":"PFMultiplayerServerRequestMultiplayerServerRequest","description":"PFMultiplayerServerRequestMultiplayerServerRequest data model. Requests a multiplayer server session from a particular build in any of the given preferred regions.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverrequestmultiplayerserverrequest"},{"title":"PFMultiplayerServerRequestMultiplayerServerResponse","description":"PFMultiplayerServerRequestMultiplayerServerResponse data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverrequestmultiplayerserverresponse"},{"title":"PFMultiplayerServerRequestPartyServiceResponse","description":"PFMultiplayerServerRequestPartyServiceResponse data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverrequestpartyserviceresponse"},{"title":"PFMultiplayerServerSchedule","description":"PFMultiplayerServerSchedule data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverschedule"},{"title":"PFMultiplayerServerScheduledStandbySettings","description":"PFMultiplayerServerScheduledStandbySettings data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverscheduledstandbysettings"},{"title":"PFMultiplayerServerSecret","description":"PFMultiplayerServerSecret data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserversecret"},{"title":"PFMultiplayerServerSecretSummary","description":"PFMultiplayerServerSecretSummary data model.","href":"/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserversecretsummary"}]}]},{"group":"PFPlatform","pages":[{"title":"Services C API overview - PFPlatform.h","description":"Services C API overview - PFPlatform.h","sidebarTitle":"PFPlatform","href":"/services/playfab/api-references/c/pfplatform/pfplatform_members"},{"group":"Functions","pages":[{"title":"PFMemGetFunctions","description":"Gets the memory hook functions to allow callers to control route memory allocations to their own memory manager. This method allows the application get the.","href":"/services/playfab/api-references/c/pfplatform/functions/pfmemgetfunctions"},{"title":"PFMemIsUsingCustomMemoryFunctions","description":"Determines if custom memory functions are being used.","href":"/services/playfab/api-references/c/pfplatform/functions/pfmemisusingcustommemoryfunctions"},{"title":"PFMemSetFunctions","description":"Optionally sets the memory hook functions to allow callers to control route memory allocations to their own memory manager. This must be called before.","href":"/services/playfab/api-references/c/pfplatform/functions/pfmemsetfunctions"},{"title":"PFPlatformGetPlatformType","description":"PFPlatformGetPlatformType returns an HRESULT and writes the platform type to its PFPlatformType output parameter. Declared in the PFPlatform.h header.","href":"/services/playfab/api-references/c/pfplatform/functions/pfplatformgetplatformtype"},{"title":"PFPlatformIsGRTSAvailable","description":"Syntax for PFPlatformIsGRTSAvailable, which returns an HRESULT and reports through the isGRTSAvailable bool output parameter whether GRTS is available.","href":"/services/playfab/api-references/c/pfplatform/functions/pfplatformisgrtsavailable"},{"title":"PFPlatformLocalStorageSetHandlers","description":"Sets the storage event handlers. If custom storage handlers are not set, a default implementation based on cstdio and std::fstream objects will be used.","href":"/services/playfab/api-references/c/pfplatform/functions/pfplatformlocalstoragesethandlers"}]},{"group":"Structs","pages":[{"title":"PFLocalStorageHooks","description":"Struct encapsulating the storage hooks.","href":"/services/playfab/api-references/c/pfplatform/structs/pflocalstoragehooks"},{"title":"PFMemoryHooks","description":"Struct encapsulating memory hooks.","href":"/services/playfab/api-references/c/pfplatform/structs/pfmemoryhooks"}]},{"group":"Enums","pages":[{"title":"PFPlatformType","description":"Enum of platform types in PFPlatform.h, with constants for Windows, Xbox, Linux, Nintendo, PlayStation, iOS, Android, SteamPc, SteamDeck, and Unknown.","href":"/services/playfab/api-references/c/pfplatform/enums/pfplatformtype"}]}]},{"group":"PFPlatformSpecific","pages":[{"title":"Services C API overview - PFPlatformSpecific.h","description":"Overview of the PFPlatformSpecific.h header in the PlayFab Services C API, listing functions for Android and iOS push registration and Steam achievements.","sidebarTitle":"PFPlatformSpecific","href":"/services/playfab/api-references/c/pfplatformspecific/pfplatformspecific_members"},{"group":"Functions","pages":[{"title":"PFPlatformSpecificClientAndroidDevicePushNotificationRegistrationAsync","description":"Registers the Android device to receive push notifications","href":"/services/playfab/api-references/c/pfplatformspecific/functions/pfplatformspecificclientandroiddevicepushnotificationregistrationasync"},{"title":"PFPlatformSpecificClientRegisterForIOSPushNotificationAsync","description":"Registers the iOS device to receive push notifications","href":"/services/playfab/api-references/c/pfplatformspecific/functions/pfplatformspecificclientregisterforiospushnotificationasync"},{"title":"PFPlatformSpecificServerAwardSteamAchievementAsync","description":"Reference for PFPlatformSpecificServerAwardSteamAchievementAsync, a PlayFab Services C API function that awards Steam achievements to the specified users.","href":"/services/playfab/api-references/c/pfplatformspecific/functions/pfplatformspecificserverawardsteamachievementasync"},{"title":"PFPlatformSpecificServerAwardSteamAchievementGetResult","description":"Reference for PFPlatformSpecificServerAwardSteamAchievementGetResult, which gets the result of an AwardSteamAchievementAsync call in the PlayFab C API.","href":"/services/playfab/api-references/c/pfplatformspecific/functions/pfplatformspecificserverawardsteamachievementgetresult"},{"title":"PFPlatformSpecificServerAwardSteamAchievementGetResultSize","description":"Reference for PFPlatformSpecificServerAwardSteamAchievementGetResultSize, which returns the size in bytes needed for a Steam achievement award result.","href":"/services/playfab/api-references/c/pfplatformspecific/functions/pfplatformspecificserverawardsteamachievementgetresultsize"}]}]},{"group":"PFPlatformSpecificTypes","pages":[{"title":"PFPlatformSpecificTypes.h push and Steam structs","description":"Lists PFPlatformSpecificTypes.h structures for Android and iOS push notification registration requests and Steam achievement award requests and results.","sidebarTitle":"PFPlatformSpecificTypes","href":"/services/playfab/api-references/c/pfplatformspecifictypes/pfplatformspecifictypes_members"},{"group":"Structs","pages":[{"title":"PFPlatformSpecificAndroidDevicePushNotificationRegistrationRequest","description":"PFPlatformSpecificAndroidDevicePushNotificationRegistrationRequest data model. More information can be found on configuring your game for the Google Cloud Messaging service in the Google developer documentation, here: http://developer.android.com/google/gcm/client.html. The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://docs.microsoft.com/gaming/playfab/features/engagement/push-notifications/quickstart.","href":"/services/playfab/api-references/c/pfplatformspecifictypes/structs/pfplatformspecificandroiddevicepushnotificationregistrationrequest"},{"title":"PFPlatformSpecificAwardSteamAchievementItem","description":"Reference for the PFPlatformSpecificAwardSteamAchievementItem struct in the PlayFab C API, pairing a Steam achievement name with a target PlayFab ID.","href":"/services/playfab/api-references/c/pfplatformspecifictypes/structs/pfplatformspecificawardsteamachievementitem"},{"title":"PFPlatformSpecificAwardSteamAchievementRequest","description":"Reference for the PFPlatformSpecificAwardSteamAchievementRequest struct in the PlayFab Services C API, describing the array of Steam achievements to grant.","href":"/services/playfab/api-references/c/pfplatformspecifictypes/structs/pfplatformspecificawardsteamachievementrequest"},{"title":"PFPlatformSpecificAwardSteamAchievementResult","description":"Reference for the PFPlatformSpecificAwardSteamAchievementResult struct in the PlayFab Services C API, describing the array of Steam achievements granted.","href":"/services/playfab/api-references/c/pfplatformspecifictypes/structs/pfplatformspecificawardsteamachievementresult"},{"title":"PFPlatformSpecificRegisterForIOSPushNotificationRequest","description":"PFPlatformSpecificRegisterForIOSPushNotificationRequest data model. The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://docs.microsoft.com/gaming/playfab/features/engagement/push-notifications/quickstart.","href":"/services/playfab/api-references/c/pfplatformspecifictypes/structs/pfplatformspecificregisterforiospushnotificationrequest"}]}]},{"group":"PFPlayerDataManagement","pages":[{"title":"Services C API overview - PFPlayerDataManagement.h","description":"Services C API overview - PFPlayerDataManagement.h","sidebarTitle":"PFPlayerDataManagement","href":"/services/playfab/api-references/c/pfplayerdatamanagement/pfplayerdatamanagement_members"},{"group":"Functions","pages":[{"title":"PFPlayerDataManagementClientDeletePlayerCustomPropertiesAsync","description":"Client API that asynchronously deletes title-specific custom properties for a player using a PFEntityHandle. The property name list must be non-empty.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientdeleteplayercustompropertiesasync"},{"title":"PFPlayerDataManagementClientDeletePlayerCustomPropertiesGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientDeletePlayerCustomPropertiesAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientdeleteplayercustompropertiesgetresult"},{"title":"PFPlayerDataManagementClientDeletePlayerCustomPropertiesGetResultSize","description":"Get the size in bytes needed to store the result of a ClientDeletePlayerCustomProperties call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientdeleteplayercustompropertiesgetresultsize"},{"title":"PFPlayerDataManagementClientGetPlayerCustomPropertyAsync","description":"Client API that asynchronously retrieves a single title-specific custom property value for a player, authenticated with a PFEntityHandle. All platforms.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetplayercustompropertyasync"},{"title":"PFPlayerDataManagementClientGetPlayerCustomPropertyGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientGetPlayerCustomPropertyAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetplayercustompropertygetresult"},{"title":"PFPlayerDataManagementClientGetPlayerCustomPropertyGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayerCustomProperty call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetplayercustompropertygetresultsize"},{"title":"PFPlayerDataManagementClientGetUserDataAsync","description":"Client API to retrieve title-specific custom user data readable and writable by the client for the authenticated PlayFab player from Player Data Management.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserdataasync"},{"title":"PFPlayerDataManagementClientGetUserDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientGetUserDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserdatagetresult"},{"title":"PFPlayerDataManagementClientGetUserDataGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetUserData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserdatagetresultsize"},{"title":"PFPlayerDataManagementClientGetUserPublisherDataAsync","description":"Client API to retrieve publisher-scoped custom user data readable and writable by the client for the authenticated PlayFab player from Player Data Management.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserpublisherdataasync"},{"title":"PFPlayerDataManagementClientGetUserPublisherDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientGetUserPublisherDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserpublisherdatagetresult"},{"title":"PFPlayerDataManagementClientGetUserPublisherDataGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetUserPublisherData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserpublisherdatagetresultsize"},{"title":"PFPlayerDataManagementClientGetUserPublisherReadOnlyDataAsync","description":"Client API to retrieve publisher-scoped user data that can only be read by the client for the authenticated PlayFab player from Player Data Management APIs.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserpublisherreadonlydataasync"},{"title":"PFPlayerDataManagementClientGetUserPublisherReadOnlyDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientGetUserPublisherReadOnlyDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserpublisherreadonlydatagetresult"},{"title":"PFPlayerDataManagementClientGetUserPublisherReadOnlyDataGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetUserPublisherReadOnlyData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserpublisherreadonlydatagetresultsize"},{"title":"PFPlayerDataManagementClientGetUserReadOnlyDataAsync","description":"Client API to retrieve title-specific user data that can only be read by the client for the authenticated PlayFab player from Player Data Management APIs.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserreadonlydataasync"},{"title":"PFPlayerDataManagementClientGetUserReadOnlyDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientGetUserReadOnlyDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserreadonlydatagetresult"},{"title":"PFPlayerDataManagementClientGetUserReadOnlyDataGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetUserReadOnlyData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetuserreadonlydatagetresultsize"},{"title":"PFPlayerDataManagementClientListPlayerCustomPropertiesAsync","description":"Client API that lists all title-specific custom property values for the player, taking only a PFEntityHandle and XAsyncBlock with no request object.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientlistplayercustompropertiesasync"},{"title":"PFPlayerDataManagementClientListPlayerCustomPropertiesGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientListPlayerCustomPropertiesAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientlistplayercustompropertiesgetresult"},{"title":"PFPlayerDataManagementClientListPlayerCustomPropertiesGetResultSize","description":"Get the size in bytes needed to store the result of a ClientListPlayerCustomProperties call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientlistplayercustompropertiesgetresultsize"},{"title":"PFPlayerDataManagementClientUpdatePlayerCustomPropertiesAsync","description":"Client API that performs an additive update of a player's custom properties. Existing properties are overwritten, and unspecified ones stay unchanged.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientupdateplayercustompropertiesasync"},{"title":"PFPlayerDataManagementClientUpdatePlayerCustomPropertiesGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientUpdatePlayerCustomPropertiesAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientupdateplayercustompropertiesgetresult"},{"title":"PFPlayerDataManagementClientUpdateUserDataAsync","description":"Creates and updates the title-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientupdateuserdataasync"},{"title":"PFPlayerDataManagementClientUpdateUserDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientUpdateUserDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientupdateuserdatagetresult"},{"title":"PFPlayerDataManagementClientUpdateUserPublisherDataAsync","description":"Creates and updates the publisher-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientupdateuserpublisherdataasync"},{"title":"PFPlayerDataManagementClientUpdateUserPublisherDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementClientUpdateUserPublisherDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientupdateuserpublisherdatagetresult"},{"title":"PFPlayerDataManagementServerDeletePlayerCustomPropertiesAsync","description":"Server API that deletes a player's custom properties using a title entity handle from PFAuthenticationGetEntityWithSecretKeyAsync. Available on Windows.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverdeleteplayercustompropertiesasync"},{"title":"PFPlayerDataManagementServerDeletePlayerCustomPropertiesGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerDeletePlayerCustomPropertiesAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverdeleteplayercustompropertiesgetresult"},{"title":"PFPlayerDataManagementServerDeletePlayerCustomPropertiesGetResultSize","description":"Get the size in bytes needed to store the result of a ServerDeletePlayerCustomProperties call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverdeleteplayercustompropertiesgetresultsize"},{"title":"PFPlayerDataManagementServerGetPlayerCustomPropertyAsync","description":"Server API that retrieves one custom property value for a player using a title entity handle and a server request object. Available on Windows only.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetplayercustompropertyasync"},{"title":"PFPlayerDataManagementServerGetPlayerCustomPropertyGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerGetPlayerCustomPropertyAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetplayercustompropertygetresult"},{"title":"PFPlayerDataManagementServerGetPlayerCustomPropertyGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayerCustomProperty call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetplayercustompropertygetresultsize"},{"title":"PFPlayerDataManagementServerGetUserDataAsync","description":"Server API to retrieve title-specific custom user data readable and writable by the client for a specified PlayFab player, callable from trusted game servers.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserdataasync"},{"title":"PFPlayerDataManagementServerGetUserDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerGetUserDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserdatagetresult"},{"title":"PFPlayerDataManagementServerGetUserDataGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetUserData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserdatagetresultsize"},{"title":"PFPlayerDataManagementServerGetUserInternalDataAsync","description":"Retrieves the title-specific custom data for the user which cannot be accessed by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserinternaldataasync"},{"title":"PFPlayerDataManagementServerGetUserInternalDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerGetUserInternalDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserinternaldatagetresult"},{"title":"PFPlayerDataManagementServerGetUserInternalDataGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetUserInternalData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserinternaldatagetresultsize"},{"title":"PFPlayerDataManagementServerGetUserPublisherDataAsync","description":"Server API to retrieve publisher-scoped custom user data readable and writable by the client for a specified PlayFab player, callable from trusted game servers.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserpublisherdataasync"},{"title":"PFPlayerDataManagementServerGetUserPublisherDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerGetUserPublisherDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserpublisherdatagetresult"},{"title":"PFPlayerDataManagementServerGetUserPublisherDataGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetUserPublisherData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserpublisherdatagetresultsize"},{"title":"PFPlayerDataManagementServerGetUserPublisherInternalDataAsync","description":"Retrieves the publisher-specific custom data for the user which cannot be accessed by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserpublisherinternaldataasync"},{"title":"PFPlayerDataManagementServerGetUserPublisherInternalDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerGetUserPublisherInternalDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserpublisherinternaldatagetresult"},{"title":"PFPlayerDataManagementServerGetUserPublisherInternalDataGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetUserPublisherInternalData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserpublisherinternaldatagetresultsize"},{"title":"PFPlayerDataManagementServerGetUserPublisherReadOnlyDataAsync","description":"Server API to retrieve publisher-scoped user data that is read-only on the client for a specified PlayFab player, callable from trusted game servers over HTTPS.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserpublisherreadonlydataasync"},{"title":"PFPlayerDataManagementServerGetUserPublisherReadOnlyDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerGetUserPublisherReadOnlyDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserpublisherreadonlydatagetresult"},{"title":"PFPlayerDataManagementServerGetUserPublisherReadOnlyDataGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetUserPublisherReadOnlyData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserpublisherreadonlydatagetresultsize"},{"title":"PFPlayerDataManagementServerGetUserReadOnlyDataAsync","description":"Server API to retrieve title-specific user data that is read-only for the client for a specified PlayFab player, callable from trusted game servers over HTTPS.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserreadonlydataasync"},{"title":"PFPlayerDataManagementServerGetUserReadOnlyDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerGetUserReadOnlyDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserreadonlydatagetresult"},{"title":"PFPlayerDataManagementServerGetUserReadOnlyDataGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetUserReadOnlyData call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetuserreadonlydatagetresultsize"},{"title":"PFPlayerDataManagementServerListPlayerCustomPropertiesAsync","description":"Server API that lists a player's custom property values using a title entity handle and a PFPlayerDataManagementListPlayerCustomPropertiesRequest.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverlistplayercustompropertiesasync"},{"title":"PFPlayerDataManagementServerListPlayerCustomPropertiesGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerListPlayerCustomPropertiesAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverlistplayercustompropertiesgetresult"},{"title":"PFPlayerDataManagementServerListPlayerCustomPropertiesGetResultSize","description":"Get the size in bytes needed to store the result of a ServerListPlayerCustomProperties call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverlistplayercustompropertiesgetresultsize"},{"title":"PFPlayerDataManagementServerUpdatePlayerCustomPropertiesAsync","description":"Server API for additive updates to a player's custom properties using a title entity handle. Existing values are overwritten. Available on Windows.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateplayercustompropertiesasync"},{"title":"PFPlayerDataManagementServerUpdatePlayerCustomPropertiesGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerUpdatePlayerCustomPropertiesAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateplayercustompropertiesgetresult"},{"title":"PFPlayerDataManagementServerUpdatePlayerCustomPropertiesGetResultSize","description":"Get the size in bytes needed to store the result of a ServerUpdatePlayerCustomProperties call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateplayercustompropertiesgetresultsize"},{"title":"PFPlayerDataManagementServerUpdateUserDataAsync","description":"Updates the title-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserdataasync"},{"title":"PFPlayerDataManagementServerUpdateUserDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerUpdateUserDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserdatagetresult"},{"title":"PFPlayerDataManagementServerUpdateUserInternalDataAsync","description":"Updates the title-specific custom data for the user which cannot be accessed by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserinternaldataasync"},{"title":"PFPlayerDataManagementServerUpdateUserInternalDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerUpdateUserInternalDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserinternaldatagetresult"},{"title":"PFPlayerDataManagementServerUpdateUserPublisherDataAsync","description":"Updates the publisher-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserpublisherdataasync"},{"title":"PFPlayerDataManagementServerUpdateUserPublisherDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerUpdateUserPublisherDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserpublisherdatagetresult"},{"title":"PFPlayerDataManagementServerUpdateUserPublisherInternalDataAsync","description":"Updates the publisher-specific custom data for the user which cannot be accessed by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserpublisherinternaldataasync"},{"title":"PFPlayerDataManagementServerUpdateUserPublisherInternalDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerUpdateUserPublisherInternalDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserpublisherinternaldatagetresult"},{"title":"PFPlayerDataManagementServerUpdateUserPublisherReadOnlyDataAsync","description":"Updates the publisher-specific custom data for the user which can only be read by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserpublisherreadonlydataasync"},{"title":"PFPlayerDataManagementServerUpdateUserPublisherReadOnlyDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerUpdateUserPublisherReadOnlyDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserpublisherreadonlydatagetresult"},{"title":"PFPlayerDataManagementServerUpdateUserReadOnlyDataAsync","description":"Updates the title-specific custom data for the user which can only be read by the client","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserreadonlydataasync"},{"title":"PFPlayerDataManagementServerUpdateUserReadOnlyDataGetResult","description":"Gets the result of a successful PFPlayerDataManagementServerUpdateUserReadOnlyDataAsync call.","href":"/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserreadonlydatagetresult"}]}]},{"group":"PFPlayerDataManagementTypes","pages":[{"title":"Services C API overview - PFPlayerDataManagementTypes.h","description":"Services C API overview - PFPlayerDataManagementTypes.h","sidebarTitle":"PFPlayerDataManagementTypes","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/pfplayerdatamanagementtypes_members"},{"group":"Structs","pages":[{"title":"PFPlayerDataManagementClientDeletePlayerCustomPropertiesRequest","description":"PFPlayerDataManagementClientDeletePlayerCustomPropertiesRequest data model. Deletes custom properties for the specified player. The list of provided property names must be non-empty.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientdeleteplayercustompropertiesrequest"},{"title":"PFPlayerDataManagementClientDeletePlayerCustomPropertiesResult","description":"PFPlayerDataManagementClientDeletePlayerCustomPropertiesResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientdeleteplayercustompropertiesresult"},{"title":"PFPlayerDataManagementClientGetPlayerCustomPropertyRequest","description":"PFPlayerDataManagementClientGetPlayerCustomPropertyRequest data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientgetplayercustompropertyrequest"},{"title":"PFPlayerDataManagementClientGetPlayerCustomPropertyResult","description":"PFPlayerDataManagementClientGetPlayerCustomPropertyResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientgetplayercustompropertyresult"},{"title":"PFPlayerDataManagementClientGetUserDataResult","description":"PFPlayerDataManagementClientGetUserDataResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientgetuserdataresult"},{"title":"PFPlayerDataManagementClientListPlayerCustomPropertiesResult","description":"PFPlayerDataManagementClientListPlayerCustomPropertiesResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientlistplayercustompropertiesresult"},{"title":"PFPlayerDataManagementClientUpdatePlayerCustomPropertiesRequest","description":"PFPlayerDataManagementClientUpdatePlayerCustomPropertiesRequest data model. Performs an additive update of the custom properties for the specified player. In updating the player's custom properties, properties which already exist will have their values overwritten. No other properties will be changed apart from those specified in the call.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientupdateplayercustompropertiesrequest"},{"title":"PFPlayerDataManagementClientUpdatePlayerCustomPropertiesResult","description":"PFPlayerDataManagementClientUpdatePlayerCustomPropertiesResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientupdateplayercustompropertiesresult"},{"title":"PFPlayerDataManagementClientUpdateUserDataRequest","description":"PFPlayerDataManagementClientUpdateUserDataRequest data model. This function performs an additive update of the arbitrary strings containing the custom data.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientupdateuserdatarequest"},{"title":"PFPlayerDataManagementCustomPropertyDetails","description":"PFPlayerDataManagementCustomPropertyDetails data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementcustompropertydetails"},{"title":"PFPlayerDataManagementDeletedPropertyDetails","description":"PFPlayerDataManagementDeletedPropertyDetails data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementdeletedpropertydetails"},{"title":"PFPlayerDataManagementGetUserDataRequest","description":"PFPlayerDataManagementGetUserDataRequest data model. Data is stored as JSON key-value pairs. Every time the data is updated via any source, the version counter is incremented. If the Version parameter is provided, then this call will only return data if the current version on the system is greater than the value provided. If the Keys parameter is provided, the data object returned will only contain the data specific to the indicated Keys. Otherwise, the full set of custom user data will be returned.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementgetuserdatarequest"},{"title":"PFPlayerDataManagementListPlayerCustomPropertiesRequest","description":"PFPlayerDataManagementListPlayerCustomPropertiesRequest data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementlistplayercustompropertiesrequest"},{"title":"PFPlayerDataManagementServerDeletePlayerCustomPropertiesRequest","description":"PFPlayerDataManagementServerDeletePlayerCustomPropertiesRequest data model. Deletes custom properties for the specified player. The list of provided property names must be non-empty.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementserverdeleteplayercustompropertiesrequest"},{"title":"PFPlayerDataManagementServerDeletePlayerCustomPropertiesResult","description":"PFPlayerDataManagementServerDeletePlayerCustomPropertiesResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementserverdeleteplayercustompropertiesresult"},{"title":"PFPlayerDataManagementServerGetPlayerCustomPropertyRequest","description":"PFPlayerDataManagementServerGetPlayerCustomPropertyRequest data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementservergetplayercustompropertyrequest"},{"title":"PFPlayerDataManagementServerGetPlayerCustomPropertyResult","description":"PFPlayerDataManagementServerGetPlayerCustomPropertyResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementservergetplayercustompropertyresult"},{"title":"PFPlayerDataManagementServerGetUserDataResult","description":"PFPlayerDataManagementServerGetUserDataResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementservergetuserdataresult"},{"title":"PFPlayerDataManagementServerListPlayerCustomPropertiesResult","description":"PFPlayerDataManagementServerListPlayerCustomPropertiesResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementserverlistplayercustompropertiesresult"},{"title":"PFPlayerDataManagementServerUpdatePlayerCustomPropertiesRequest","description":"PFPlayerDataManagementServerUpdatePlayerCustomPropertiesRequest data model. Performs an additive update of the custom properties for the specified player. In updating the player's custom properties, properties which already exist will have their values overwritten. No other properties will be changed apart from those specified in the call.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementserverupdateplayercustompropertiesrequest"},{"title":"PFPlayerDataManagementServerUpdatePlayerCustomPropertiesResult","description":"PFPlayerDataManagementServerUpdatePlayerCustomPropertiesResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementserverupdateplayercustompropertiesresult"},{"title":"PFPlayerDataManagementServerUpdateUserDataRequest","description":"PFPlayerDataManagementServerUpdateUserDataRequest data model. This function performs an additive update of the arbitrary JSON object containing the custom.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementserverupdateuserdatarequest"},{"title":"PFPlayerDataManagementUpdateProperty","description":"PFPlayerDataManagementUpdateProperty data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementupdateproperty"},{"title":"PFPlayerDataManagementUpdateUserDataResult","description":"PFPlayerDataManagementUpdateUserDataResult data model.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementupdateuserdataresult"},{"title":"PFPlayerDataManagementUpdateUserInternalDataRequest","description":"PFPlayerDataManagementUpdateUserInternalDataRequest data model. This function performs an additive update of the arbitrary JSON object containing the custom.","href":"/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementupdateuserinternaldatarequest"}]}]},{"group":"PFProfiles","pages":[{"title":"Services C API overview - PFProfiles.h","description":"Services C API overview - PFProfiles.h","sidebarTitle":"PFProfiles","href":"/services/playfab/api-references/c/pfprofiles/pfprofiles_members"},{"group":"Functions","pages":[{"title":"PFProfilesGetProfileAsync","description":"Retrieves the PlayFab entity profile for a single entity, including display name, avatar, statistics, and objects tied to the specified entity key.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilesgetprofileasync"},{"title":"PFProfilesGetProfileGetResult","description":"Gets the result of a successful PFProfilesGetProfileAsync call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilesgetprofilegetresult"},{"title":"PFProfilesGetProfileGetResultSize","description":"Get the size in bytes needed to store the result of a GetProfile call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilesgetprofilegetresultsize"},{"title":"PFProfilesGetProfilesAsync","description":"Retrieves PlayFab entity profiles for a batch of entities in one call, returning display names, avatars, statistics, and objects for each specified entity key.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilesgetprofilesasync"},{"title":"PFProfilesGetProfilesGetResult","description":"Gets the result of a successful PFProfilesGetProfilesAsync call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilesgetprofilesgetresult"},{"title":"PFProfilesGetProfilesGetResultSize","description":"Get the size in bytes needed to store the result of a GetProfiles call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilesgetprofilesgetresultsize"},{"title":"PFProfilesGetTitlePlayersFromMasterPlayerAccountIdsAsync","description":"Retrieves the title player accounts associated with the given master player account.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilesgettitleplayersfrommasterplayeraccountidsasync"},{"title":"PFProfilesGetTitlePlayersFromMasterPlayerAccountIdsGetResult","description":"Gets the result of a successful PFProfilesGetTitlePlayersFromMasterPlayerAccountIdsAsync call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilesgettitleplayersfrommasterplayeraccountidsgetresult"},{"title":"PFProfilesGetTitlePlayersFromMasterPlayerAccountIdsGetResultSize","description":"Get the size in bytes needed to store the result of a GetTitlePlayersFromMasterPlayerAccountIds call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilesgettitleplayersfrommasterplayeraccountidsgetresultsize"},{"title":"PFProfilesSetProfileLanguageAsync","description":"Updates the entity's language. The precedence hierarchy for communication to the player is Title Player Account language, Master Player Account language, and.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilessetprofilelanguageasync"},{"title":"PFProfilesSetProfileLanguageGetResult","description":"Gets the result of a successful PFProfilesSetProfileLanguageAsync call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilessetprofilelanguagegetresult"},{"title":"PFProfilesSetProfileLanguageGetResultSize","description":"Get the size in bytes needed to store the result of a SetProfileLanguage call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilessetprofilelanguagegetresultsize"},{"title":"PFProfilesSetProfilePolicyAsync","description":"Sets the profiles access policy","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilessetprofilepolicyasync"},{"title":"PFProfilesSetProfilePolicyGetResult","description":"Gets the result of a successful PFProfilesSetProfilePolicyAsync call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilessetprofilepolicygetresult"},{"title":"PFProfilesSetProfilePolicyGetResultSize","description":"Get the size in bytes needed to store the result of a SetProfilePolicy call.","href":"/services/playfab/api-references/c/pfprofiles/functions/pfprofilessetprofilepolicygetresultsize"}]}]},{"group":"PFProfilesTypes","pages":[{"title":"Services C API overview - PFProfilesTypes.h","description":"Services C API overview - PFProfilesTypes.h","sidebarTitle":"PFProfilesTypes","href":"/services/playfab/api-references/c/pfprofilestypes/pfprofilestypes_members"},{"group":"Enums","pages":[{"title":"PFProfilesEffectType","description":"EffectType enum.","href":"/services/playfab/api-references/c/pfprofilestypes/enums/pfprofileseffecttype"},{"title":"PFStatisticAggregationMethod","description":"StatisticAggregationMethod enum.","href":"/services/playfab/api-references/c/pfprofilestypes/enums/pfstatisticaggregationmethod"}]},{"group":"Structs","pages":[{"title":"PFEntityStatisticValue","description":"PFEntityStatisticValue data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfentitystatisticvalue"},{"title":"PFEntityStatisticValueDictionaryEntry","description":"Dictionary entry for an associative array with PFProfilesEntityStatisticValue values.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfentitystatisticvaluedictionaryentry"},{"title":"PFProfilesEntityDataObject","description":"PFProfilesEntityDataObject data model. An entity object and its associated meta data.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesentitydataobject"},{"title":"PFProfilesEntityDataObjectDictionaryEntry","description":"Dictionary entry for an associative array with PFProfilesEntityDataObject values.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesentitydataobjectdictionaryentry"},{"title":"PFProfilesEntityPermissionStatement","description":"PFProfilesEntityPermissionStatement data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesentitypermissionstatement"},{"title":"PFProfilesEntityProfileBody","description":"PFProfilesEntityProfileBody data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesentityprofilebody"},{"title":"PFProfilesEntityProfileFileMetadata","description":"PFProfilesEntityProfileFileMetadata data model. An entity file's meta data. To get a download URL call File/GetFiles API.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesentityprofilefilemetadata"},{"title":"PFProfilesEntityProfileFileMetadataDictionaryEntry","description":"Dictionary entry for an associative array with PFProfilesEntityProfileFileMetadata values.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesentityprofilefilemetadatadictionaryentry"},{"title":"PFProfilesGetEntityProfileRequest","description":"PFProfilesGetEntityProfileRequest data model. Given an entity type and entity identifier will retrieve the profile from the entity store. If the profile being retrieved is the caller's, then the read operation is consistent, if not it is an inconsistent read. An inconsistent read means that we do not guarantee all committed writes have occurred before reading the profile, allowing for a stale read. If consistency is important the Version Number on the result can be used to compare which version of the profile any reader has.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesgetentityprofilerequest"},{"title":"PFProfilesGetEntityProfileResponse","description":"PFProfilesGetEntityProfileResponse data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesgetentityprofileresponse"},{"title":"PFProfilesGetEntityProfilesRequest","description":"PFProfilesGetEntityProfilesRequest data model. Given a set of entity types and entity identifiers will retrieve all readable profiles properties for the caller. Profiles that the caller is not allowed to read will silently not be included in the results.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesgetentityprofilesrequest"},{"title":"PFProfilesGetEntityProfilesResponse","description":"PFProfilesGetEntityProfilesResponse data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesgetentityprofilesresponse"},{"title":"PFProfilesGetTitlePlayersFromMasterPlayerAccountIdsRequest","description":"PFProfilesGetTitlePlayersFromMasterPlayerAccountIdsRequest data model. Given a master player account id (PlayFab ID), returns all title player accounts.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesgettitleplayersfrommasterplayeraccountidsrequest"},{"title":"PFProfilesGetTitlePlayersFromMasterPlayerAccountIdsResponse","description":"PFProfilesGetTitlePlayersFromMasterPlayerAccountIdsResponse data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilesgettitleplayersfrommasterplayeraccountidsresponse"},{"title":"PFProfilesSetEntityProfilePolicyRequest","description":"PFProfilesSetEntityProfilePolicyRequest data model. This will set the access policy statements on the given entity profile. This is not additive, any.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilessetentityprofilepolicyrequest"},{"title":"PFProfilesSetEntityProfilePolicyResponse","description":"PFProfilesSetEntityProfilePolicyResponse data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilessetentityprofilepolicyresponse"},{"title":"PFProfilesSetProfileLanguageRequest","description":"PFProfilesSetProfileLanguageRequest data model. Given an entity profile, will update its language to the one passed in if the profile's version is equal to.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilessetprofilelanguagerequest"},{"title":"PFProfilesSetProfileLanguageResponse","description":"PFProfilesSetProfileLanguageResponse data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfprofilessetprofilelanguageresponse"},{"title":"PFStatisticColumn","description":"PFStatisticColumn data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfstatisticcolumn"},{"title":"PFStatisticColumnCollection","description":"PFStatisticColumnCollection data model.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfstatisticcolumncollection"},{"title":"PFStatisticColumnCollectionDictionaryEntry","description":"Dictionary entry for an associative array with PFProfilesStatisticColumnCollection values.","href":"/services/playfab/api-references/c/pfprofilestypes/structs/pfstatisticcolumncollectiondictionaryentry"}]}]},{"group":"PFPushNotifications","pages":[{"title":"Services C API overview - PFPushNotifications.h","description":"Overview of the PFPushNotifications.h header in the PlayFab Services C API, listing server functions for sending push notifications to iOS and Android.","sidebarTitle":"PFPushNotifications","href":"/services/playfab/api-references/c/pfpushnotifications/pfpushnotifications_members"},{"group":"Functions","pages":[{"title":"PFPushNotificationsServerSendPushNotificationAsync","description":"Reference for PFPushNotificationsServerSendPushNotificationAsync, a PlayFab Services C API function that sends a push notification to a specific user.","href":"/services/playfab/api-references/c/pfpushnotifications/functions/pfpushnotificationsserversendpushnotificationasync"},{"title":"ServerSendPushNotificationFromTemplateAsync","description":"Reference for PFPushNotificationsServerSendPushNotificationFromTemplateAsync, a PlayFab C API function that sends a push notification template to a user.","href":"/services/playfab/api-references/c/pfpushnotifications/functions/pfpushnotificationsserversendpushnotificationfromtemplateasync"}]}]},{"group":"PFPushNotificationsTypes","pages":[{"title":"Services C API overview - PFPushNotificationsTypes.h","description":"Overview of the PFPushNotificationsTypes.h header in the PlayFab Services C API, listing the structs used to build and send push notification requests.","sidebarTitle":"PFPushNotificationsTypes","href":"/services/playfab/api-references/c/pfpushnotificationstypes/pfpushnotificationstypes_members"},{"group":"Structs","pages":[{"title":"PFPushNotificationsAdvancedPushPlatformMsg","description":"Reference for the PFPushNotificationsAdvancedPushPlatformMsg struct in the PlayFab Services C API, describing per-platform JSON payloads for push delivery.","href":"/services/playfab/api-references/c/pfpushnotificationstypes/structs/pfpushnotificationsadvancedpushplatformmsg"},{"title":"PFPushNotificationsPushNotificationPackage","description":"Reference for the PFPushNotificationsPushNotificationPackage struct in the PlayFab C API, describing badge, icon, message, sound, and title fields.","href":"/services/playfab/api-references/c/pfpushnotificationstypes/structs/pfpushnotificationspushnotificationpackage"},{"title":"PFPushNotificationsSendPushNotificationFromTemplateRequest","description":"PFPushNotificationsSendPushNotificationFromTemplateRequest data model. Represents the request for sending a push notification template to a recipient.","href":"/services/playfab/api-references/c/pfpushnotificationstypes/structs/pfpushnotificationssendpushnotificationfromtemplaterequest"},{"title":"PFPushNotificationsSendPushNotificationRequest","description":"Reference for the PFPushNotificationsSendPushNotificationRequest struct in the PlayFab C API, describing the members used to send a push notification.","href":"/services/playfab/api-references/c/pfpushnotificationstypes/structs/pfpushnotificationssendpushnotificationrequest"}]}]},{"group":"PFSegments","pages":[{"title":"Services C API overview - PFSegments.h","description":"Services C API overview - PFSegments.h","sidebarTitle":"PFSegments","href":"/services/playfab/api-references/c/pfsegments/pfsegments_members"},{"group":"Functions","pages":[{"title":"PFSegmentsClientGetPlayerSegmentsAsync","description":"Client API to list all PlayFab segments the authenticated player currently belongs to at this moment in time, for personalization and matchmaking.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsclientgetplayersegmentsasync"},{"title":"PFSegmentsClientGetPlayerSegmentsGetResult","description":"Gets the result of a successful PFSegmentsClientGetPlayerSegmentsAsync call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsclientgetplayersegmentsgetresult"},{"title":"PFSegmentsClientGetPlayerSegmentsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayerSegments call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsclientgetplayersegmentsgetresultsize"},{"title":"PFSegmentsClientGetPlayerTagsAsync","description":"Client API to get all tags in an optional namespace on the authenticated player's PlayFab profile, letting titles read player metadata used by segmentation.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsclientgetplayertagsasync"},{"title":"PFSegmentsClientGetPlayerTagsGetResult","description":"Gets the result of a successful PFSegmentsClientGetPlayerTagsAsync call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsclientgetplayertagsgetresult"},{"title":"PFSegmentsClientGetPlayerTagsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPlayerTags call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsclientgetplayertagsgetresultsize"},{"title":"PFSegmentsServerAddPlayerTagAsync","description":"Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsserveraddplayertagasync"},{"title":"PFSegmentsServerGetAllSegmentsAsync","description":"Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetallsegmentsasync"},{"title":"PFSegmentsServerGetAllSegmentsGetResult","description":"Gets the result of a successful PFSegmentsServerGetAllSegmentsAsync call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetallsegmentsgetresult"},{"title":"PFSegmentsServerGetAllSegmentsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetAllSegments call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetallsegmentsgetresultsize"},{"title":"PFSegmentsServerGetPlayerSegmentsAsync","description":"Server API to list all PlayFab segments a specified player currently belongs to at this moment in time, callable from trusted game servers for segmentation.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersegmentsasync"},{"title":"PFSegmentsServerGetPlayerSegmentsGetResult","description":"Gets the result of a successful PFSegmentsServerGetPlayerSegmentsAsync call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersegmentsgetresult"},{"title":"PFSegmentsServerGetPlayerSegmentsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayerSegments call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersegmentsgetresultsize"},{"title":"PFSegmentsServerGetPlayersInSegmentGetResult","description":"Gets the result of a successful PFSegmentsServerGetPlayersInSegmentAsync call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersinsegmentgetresult"},{"title":"PFSegmentsServerGetPlayerTagsAsync","description":"Server API to get all tags in an optional namespace on a specified player's PlayFab profile, callable from trusted game servers for segmentation logic.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayertagsasync"},{"title":"PFSegmentsServerGetPlayerTagsGetResult","description":"Gets the result of a successful PFSegmentsServerGetPlayerTagsAsync call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayertagsgetresult"},{"title":"PFSegmentsServerGetPlayerTagsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPlayerTags call.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayertagsgetresultsize"},{"title":"PFSegmentsServerRemovePlayerTagAsync","description":"Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.","href":"/services/playfab/api-references/c/pfsegments/functions/pfsegmentsserverremoveplayertagasync"}]}]},{"group":"PFSegmentsTypes","pages":[{"title":"Services C API overview - PFSegmentsTypes.h","description":"Services C API overview - PFSegmentsTypes.h","sidebarTitle":"PFSegmentsTypes","href":"/services/playfab/api-references/c/pfsegmentstypes/pfsegmentstypes_members"},{"group":"Structs","pages":[{"title":"PFSegmentsAddPlayerTagRequest","description":"PFSegmentsAddPlayerTagRequest data model. This API will trigger a player_tag_added event and add a tag with the given TagName and PlayFabID to the.","href":"/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsaddplayertagrequest"},{"title":"PFSegmentsGetAllSegmentsResult","description":"PFSegmentsGetAllSegmentsResult data model.","href":"/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetallsegmentsresult"},{"title":"PFSegmentsGetPlayerSegmentsResult","description":"PFSegmentsGetPlayerSegmentsResult data model.","href":"/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayersegmentsresult"},{"title":"PFSegmentsGetPlayersSegmentsRequest","description":"PFSegmentsGetPlayersSegmentsRequest data model.","href":"/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayerssegmentsrequest"},{"title":"PFSegmentsGetPlayerTagsRequest","description":"PFSegmentsGetPlayerTagsRequest data model. This API will return a list of canonical tags which includes both namespace and tag's name.","href":"/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayertagsrequest"},{"title":"PFSegmentsGetPlayerTagsResult","description":"PFSegmentsGetPlayerTagsResult data model.","href":"/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayertagsresult"},{"title":"PFSegmentsGetSegmentResult","description":"PFSegmentsGetSegmentResult data model.","href":"/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetsegmentresult"},{"title":"PFSegmentsRemovePlayerTagRequest","description":"PFSegmentsRemovePlayerTagRequest data model. This API will trigger a player_tag_removed event and remove a tag with the given TagName and PlayFabID from the.","href":"/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsremoveplayertagrequest"}]}]},{"group":"PFServiceConfig","pages":[{"title":"Services C API overview - PFServiceConfig.h","description":"Services C API overview - PFServiceConfig.h","sidebarTitle":"PFServiceConfig","href":"/services/playfab/api-references/c/pfserviceconfig/pfserviceconfig_members"},{"group":"Functions","pages":[{"title":"PFServiceConfigCloseHandle","description":"Closes a PFServiceConfigHandle.","href":"/services/playfab/api-references/c/pfserviceconfig/functions/pfserviceconfigclosehandle"},{"title":"PFServiceConfigCreateHandle","description":"Creates a PlayFab service configuration.","href":"/services/playfab/api-references/c/pfserviceconfig/functions/pfserviceconfigcreatehandle"},{"title":"PFServiceConfigDuplicateHandle","description":"Duplicates a PFServiceConfigHandle.","href":"/services/playfab/api-references/c/pfserviceconfig/functions/pfserviceconfigduplicatehandle"},{"title":"PFServiceConfigGetAPIEndpoint","description":"Gets the API endpoint for a service configuration.","href":"/services/playfab/api-references/c/pfserviceconfig/functions/pfserviceconfiggetapiendpoint"},{"title":"PFServiceConfigGetAPIEndpointSize","description":"Gets the size of the buffer needed to hold the API endpoint for a service configuration.","href":"/services/playfab/api-references/c/pfserviceconfig/functions/pfserviceconfiggetapiendpointsize"},{"title":"PFServiceConfigGetTitleId","description":"Gets the PlayFab titleId for a service configuration.","href":"/services/playfab/api-references/c/pfserviceconfig/functions/pfserviceconfiggettitleid"},{"title":"PFServiceConfigGetTitleIdSize","description":"Gets the size of the buffer needed to hold the PlayFab titleId for a service configuration.","href":"/services/playfab/api-references/c/pfserviceconfig/functions/pfserviceconfiggettitleidsize"}]}]},{"group":"PFServices","pages":[{"title":"Services C API overview - PFServices.h","description":"Services C API overview - PFServices.h","sidebarTitle":"PFServices","href":"/services/playfab/api-references/c/pfservices/pfservices_members"},{"group":"Functions","pages":[{"title":"PFServicesInitialize","description":"Initializes PlayFab Services global state so title code can call PlayFab Services APIs. A reserved XTaskQueueHandle parameter is retained for future use.","href":"/services/playfab/api-references/c/pfservices/functions/pfservicesinitialize"},{"title":"PFServicesInitialize (background queue overload)","description":"Overload of PFServicesInitialize that accepts a background XTaskQueueHandle and HCInitArgs to initialize PlayFab Services global state with custom HTTP.","href":"/services/playfab/api-references/c/pfservices/functions/pfservicesinitialize_2"},{"title":"PFServicesUninitializeAsync","description":"Cleanup PlayFab Services global state.","href":"/services/playfab/api-references/c/pfservices/functions/pfservicesuninitializeasync"}]}]},{"group":"PFStatistics","pages":[{"title":"Services C API overview - PFStatistics.h","description":"Overview of the PFStatistics.h header in the PlayFab Services C API, listing the functions it defines for entity statistics and statistic definitions.","sidebarTitle":"PFStatistics","href":"/services/playfab/api-references/c/pfstatistics/pfstatistics_members"},{"group":"Functions","pages":[{"title":"PFStatisticsCreateStatisticDefinitionAsync","description":"Reference for PFStatisticsCreateStatisticDefinitionAsync, a PlayFab Services C API function that creates a new entity statistic definition.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticscreatestatisticdefinitionasync"},{"title":"PFStatisticsDeleteStatisticDefinitionAsync","description":"Reference for PFStatisticsDeleteStatisticDefinitionAsync, a PlayFab Services C API function that deletes a statistic definition and its data.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsdeletestatisticdefinitionasync"},{"title":"PFStatisticsDeleteStatisticsAsync","description":"Reference for PFStatisticsDeleteStatisticsAsync, a PlayFab Services C API function that deletes entity statistics and leaderboard rankings.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsdeletestatisticsasync"},{"title":"PFStatisticsDeleteStatisticsGetResult","description":"Reference for PFStatisticsDeleteStatisticsGetResult, which retrieves the result of a PFStatisticsDeleteStatisticsAsync call in the PlayFab Services C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsdeletestatisticsgetresult"},{"title":"PFStatisticsDeleteStatisticsGetResultSize","description":"Reference for PFStatisticsDeleteStatisticsGetResultSize, returning the buffer size in bytes for the result of DeleteStatisticsAsync in the PlayFab C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsdeletestatisticsgetresultsize"},{"title":"PFStatisticsGetStatisticDefinitionAsync","description":"Reference for PFStatisticsGetStatisticDefinitionAsync, a PlayFab Services C API function that gets information about a statistic definition.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsgetstatisticdefinitionasync"},{"title":"PFStatisticsGetStatisticDefinitionGetResult","description":"Reference for PFStatisticsGetStatisticDefinitionGetResult, which retrieves the result of a GetStatisticDefinitionAsync call in the PlayFab Services C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsgetstatisticdefinitiongetresult"},{"title":"PFStatisticsGetStatisticDefinitionGetResultSize","description":"Reference for PFStatisticsGetStatisticDefinitionGetResultSize, which returns the result buffer size for GetStatisticDefinitionAsync in the PlayFab C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsgetstatisticdefinitiongetresultsize"},{"title":"PFStatisticsGetStatisticsAsync","description":"Reference for PFStatisticsGetStatisticsAsync, a PlayFab Services C API function that gets statistics for a specified entity, with syntax and parameters.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsgetstatisticsasync"},{"title":"PFStatisticsGetStatisticsForEntitiesAsync","description":"Reference for PFStatisticsGetStatisticsForEntitiesAsync, a PlayFab Services C API function that gets statistics for a collection of entities.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsgetstatisticsforentitiesasync"},{"title":"PFStatisticsGetStatisticsForEntitiesGetResult","description":"Reference for PFStatisticsGetStatisticsForEntitiesGetResult, which retrieves the result of a GetStatisticsForEntitiesAsync call in the PlayFab C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsgetstatisticsforentitiesgetresult"},{"title":"PFStatisticsGetStatisticsForEntitiesGetResultSize","description":"Reference for PFStatisticsGetStatisticsForEntitiesGetResultSize, returning the result buffer size for GetStatisticsForEntitiesAsync in the PlayFab C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsgetstatisticsforentitiesgetresultsize"},{"title":"PFStatisticsGetStatisticsGetResult","description":"Reference for PFStatisticsGetStatisticsGetResult, which retrieves the result of a PFStatisticsGetStatisticsAsync call in the PlayFab Services C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsgetstatisticsgetresult"},{"title":"PFStatisticsGetStatisticsGetResultSize","description":"Reference for PFStatisticsGetStatisticsGetResultSize, returning the buffer size in bytes for the result of GetStatisticsAsync in the PlayFab C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsgetstatisticsgetresultsize"},{"title":"PFStatisticsIncrementStatisticVersionAsync","description":"Reference for PFStatisticsIncrementStatisticVersionAsync, a PlayFab Services C API function that increments an entity statistic definition version.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsincrementstatisticversionasync"},{"title":"PFStatisticsIncrementStatisticVersionGetResult","description":"Reference for PFStatisticsIncrementStatisticVersionGetResult, which retrieves the result of an IncrementStatisticVersionAsync call in the PlayFab C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsincrementstatisticversiongetresult"},{"title":"PFStatisticsListStatisticDefinitionsAsync","description":"Reference for PFStatisticsListStatisticDefinitionsAsync, a PlayFab Services C API function that gets information for all current statistic definitions.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsliststatisticdefinitionsasync"},{"title":"PFStatisticsListStatisticDefinitionsGetResult","description":"Reference for PFStatisticsListStatisticDefinitionsGetResult, which retrieves the result of a ListStatisticDefinitionsAsync call in the PlayFab C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsliststatisticdefinitionsgetresult"},{"title":"PFStatisticsListStatisticDefinitionsGetResultSize","description":"Reference for PFStatisticsListStatisticDefinitionsGetResultSize, returning the result buffer size for ListStatisticDefinitionsAsync in the PlayFab C API.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsliststatisticdefinitionsgetresultsize"},{"title":"PFStatisticsUpdateStatisticDefinitionAsync","description":"Reference for PFStatisticsUpdateStatisticDefinitionAsync, a PlayFab Services C API function that updates an existing entity statistic definition.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsupdatestatisticdefinitionasync"},{"title":"PFStatisticsUpdateStatisticsAsync","description":"Update statistics on an entity profile. Depending on the statistic definition, this may result in entity being ranked on various leaderboards.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsupdatestatisticsasync"},{"title":"PFStatisticsUpdateStatisticsGetResult","description":"Gets the result of a successful PFStatisticsUpdateStatisticsAsync call.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsupdatestatisticsgetresult"},{"title":"PFStatisticsUpdateStatisticsGetResultSize","description":"Get the size in bytes needed to store the result of a UpdateStatistics call.","href":"/services/playfab/api-references/c/pfstatistics/functions/pfstatisticsupdatestatisticsgetresultsize"}]}]},{"group":"PFStatisticsTypes","pages":[{"title":"Services C API overview - PFStatisticsTypes.h","description":"Overview of the PFStatisticsTypes.h header in the PlayFab Services C API, listing the structs and enums used for statistics data models.","sidebarTitle":"PFStatisticsTypes","href":"/services/playfab/api-references/c/pfstatisticstypes/pfstatisticstypes_members"},{"group":"Structs","pages":[{"title":"PFStatisticsCreateStatisticDefinitionRequest","description":"Reference for the PFStatisticsCreateStatisticDefinitionRequest struct in the PlayFab Services C API, with members to define a new statistic.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticscreatestatisticdefinitionrequest"},{"title":"PFStatisticsDeleteStatisticDefinitionRequest","description":"Reference for the PFStatisticsDeleteStatisticDefinitionRequest struct in the PlayFab Services C API, with members that name the statistic to delete.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsdeletestatisticdefinitionrequest"},{"title":"PFStatisticsDeleteStatisticsRequest","description":"Reference for the PFStatisticsDeleteStatisticsRequest struct in the PlayFab Services C API, describing the entity and statistics to remove.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsdeletestatisticsrequest"},{"title":"PFStatisticsDeleteStatisticsResponse","description":"Reference for the PFStatisticsDeleteStatisticsResponse struct in the PlayFab Services C API, returning the entity key after statistics are deleted.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsdeletestatisticsresponse"},{"title":"PFStatisticsEntityStatistics","description":"Reference for the PFStatisticsEntityStatistics struct in the PlayFab Services C API, pairing an entity key with its list of statistic values.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsentitystatistics"},{"title":"PFStatisticsEntityStatisticValue","description":"Reference for the PFStatisticsEntityStatisticValue struct in the PlayFab Services C API, holding a statistic's name, scores, version, and metadata.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsentitystatisticvalue"},{"title":"PFStatisticsEntityStatisticValueDictionaryEntry","description":"Reference for the PFStatisticsEntityStatisticValueDictionaryEntry struct in the PlayFab Services C API, a key and statistic value map entry.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsentitystatisticvaluedictionaryentry"},{"title":"PFStatisticsGetStatisticDefinitionRequest","description":"Reference for the PFStatisticsGetStatisticDefinitionRequest struct in the PlayFab Services C API, naming the statistic definition to retrieve.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsgetstatisticdefinitionrequest"},{"title":"PFStatisticsGetStatisticDefinitionResponse","description":"Reference for the PFStatisticsGetStatisticDefinitionResponse struct in the PlayFab Services C API, returning a statistic's columns and versions.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsgetstatisticdefinitionresponse"},{"title":"PFStatisticsGetStatisticsForEntitiesRequest","description":"Reference for the PFStatisticsGetStatisticsForEntitiesRequest struct in the PlayFab Services C API, listing entities whose statistics to fetch.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsgetstatisticsforentitiesrequest"},{"title":"PFStatisticsGetStatisticsForEntitiesResponse","description":"Reference for the PFStatisticsGetStatisticsForEntitiesResponse struct in the PlayFab Services C API, with statistics and column details per entity.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsgetstatisticsforentitiesresponse"},{"title":"PFStatisticsGetStatisticsRequest","description":"Reference for the PFStatisticsGetStatisticsRequest struct in the PlayFab Services C API, specifying the entity and statistic names to retrieve.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsgetstatisticsrequest"},{"title":"PFStatisticsGetStatisticsResponse","description":"Reference for the PFStatisticsGetStatisticsResponse struct in the PlayFab Services C API, returning an entity's statistic values and column details.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsgetstatisticsresponse"},{"title":"PFStatisticsIncrementStatisticVersionRequest","description":"Reference for the PFStatisticsIncrementStatisticVersionRequest struct in the PlayFab Services C API, naming the statistic whose version to increment.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsincrementstatisticversionrequest"},{"title":"PFStatisticsIncrementStatisticVersionResponse","description":"Reference for the PFStatisticsIncrementStatisticVersionResponse struct in the PlayFab Services C API, returning the new statistic version number.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsincrementstatisticversionresponse"},{"title":"PFStatisticsListStatisticDefinitionsRequest","description":"Reference for the PFStatisticsListStatisticDefinitionsRequest struct in the PlayFab Services C API, with page size and skip token paging options.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsliststatisticdefinitionsrequest"},{"title":"PFStatisticsListStatisticDefinitionsResponse","description":"Reference for the PFStatisticsListStatisticDefinitionsResponse struct in the PlayFab Services C API, returning a page of statistic definitions.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsliststatisticdefinitionsresponse"},{"title":"PFStatisticsStatisticColumn","description":"Reference for the PFStatisticsStatisticColumn struct in the PlayFab Services C API, describing a column's name and aggregation method.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsstatisticcolumn"},{"title":"PFStatisticsStatisticColumnCollection","description":"Reference for the PFStatisticsStatisticColumnCollection struct in the PlayFab Services C API, wrapping an array of statistic column definitions.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsstatisticcolumncollection"},{"title":"PFStatisticsStatisticColumnCollectionDictionaryEntry","description":"Reference for the PFStatisticsStatisticColumnCollectionDictionaryEntry struct in the PlayFab Services C API, a key and column collection map entry.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsstatisticcolumncollectiondictionaryentry"},{"title":"PFStatisticsStatisticDefinition","description":"Reference for the PFStatisticsStatisticDefinition struct in the PlayFab Services C API, describing a statistic's columns, versions, and entity type.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsstatisticdefinition"},{"title":"PFStatisticsStatisticDelete","description":"Reference for the PFStatisticsStatisticDelete struct in the PlayFab Services C API, naming a statistic to remove in a DeleteStatistics request.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsstatisticdelete"},{"title":"PFStatisticsStatisticsEventEmissionConfig","description":"Reference for the PFStatisticsStatisticsEventEmissionConfig struct in the PlayFab Services C API, configuring events emitted when statistics update.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsstatisticseventemissionconfig"},{"title":"PFStatisticsStatisticsUpdateEventConfig","description":"Reference for the PFStatisticsStatisticsUpdateEventConfig struct in the PlayFab Services C API, setting the event type emitted on statistic updates.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsstatisticsupdateeventconfig"},{"title":"PFStatisticsStatisticUpdate","description":"PFStatisticsStatisticUpdate data model.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsstatisticupdate"},{"title":"PFStatisticsUpdateStatisticDefinitionRequest","description":"Reference for the PFStatisticsUpdateStatisticDefinitionRequest struct in the PlayFab Services C API, updating a statistic's version configuration.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsupdatestatisticdefinitionrequest"},{"title":"PFStatisticsUpdateStatisticsRequest","description":"Reference for the PFStatisticsUpdateStatisticsRequest struct in the PlayFab Services C API, specifying the entity and statistic values to write.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsupdatestatisticsrequest"},{"title":"PFStatisticsUpdateStatisticsResponse","description":"Reference for the PFStatisticsUpdateStatisticsResponse struct in the PlayFab Services C API, returning updated statistic values for the entity.","href":"/services/playfab/api-references/c/pfstatisticstypes/structs/pfstatisticsupdatestatisticsresponse"}]},{"group":"Enums","pages":[{"title":"PFStatisticsStatisticAggregationMethod","description":"Reference for the PFStatisticsStatisticAggregationMethod enumeration in the PlayFab Services C API, listing the Last, Min, Max, and Sum values.","href":"/services/playfab/api-references/c/pfstatisticstypes/enums/pfstatisticsstatisticaggregationmethod"}]}]},{"group":"PFTitleDataManagement","pages":[{"title":"Services C API overview - PFTitleDataManagement.h","description":"Services C API overview - PFTitleDataManagement.h","sidebarTitle":"PFTitleDataManagement","href":"/services/playfab/api-references/c/pftitledatamanagement/pftitledatamanagement_members"},{"group":"Functions","pages":[{"title":"PFTitleDataManagementClientGetPublisherDataAsync","description":"Client API to retrieve the key-value store of custom publisher settings for the current PlayFab title, giving clients read access to publisher configuration.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgetpublisherdataasync"},{"title":"PFTitleDataManagementClientGetPublisherDataGetResult","description":"Gets the result of a successful PFTitleDataManagementClientGetPublisherDataAsync call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgetpublisherdatagetresult"},{"title":"PFTitleDataManagementClientGetPublisherDataGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetPublisherData call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgetpublisherdatagetresultsize"},{"title":"PFTitleDataManagementClientGetTimeAsync","description":"Client API to retrieve the current PlayFab server time as a UTC timestamp, useful for reconciling client clocks and driving time-based gameplay logic.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgettimeasync"},{"title":"PFTitleDataManagementClientGetTimeGetResult","description":"Gets the result of a successful PFTitleDataManagementClientGetTimeAsync call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgettimegetresult"},{"title":"PFTitleDataManagementClientGetTitleDataAsync","description":"Client API to retrieve the key-value store of custom title settings for the current PlayFab title, letting clients read title-scoped configuration data.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgettitledataasync"},{"title":"PFTitleDataManagementClientGetTitleDataGetResult","description":"Gets the result of a successful PFTitleDataManagementClientGetTitleDataAsync call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgettitledatagetresult"},{"title":"PFTitleDataManagementClientGetTitleDataGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetTitleData call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgettitledatagetresultsize"},{"title":"PFTitleDataManagementClientGetTitleNewsAsync","description":"Client API to retrieve the PlayFab title news feed as configured in Game Manager, letting titles surface latest announcements to authenticated players.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgettitlenewsasync"},{"title":"PFTitleDataManagementClientGetTitleNewsGetResult","description":"Gets the result of a successful PFTitleDataManagementClientGetTitleNewsAsync call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgettitlenewsgetresult"},{"title":"PFTitleDataManagementClientGetTitleNewsGetResultSize","description":"Get the size in bytes needed to store the result of a ClientGetTitleNews call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementclientgettitlenewsgetresultsize"},{"title":"PFTitleDataManagementServerGetPublisherDataAsync","description":"Server API to retrieve the key-value store of custom publisher settings for the current PlayFab title, callable from trusted game servers for configuration.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergetpublisherdataasync"},{"title":"PFTitleDataManagementServerGetPublisherDataGetResult","description":"Gets the result of a successful PFTitleDataManagementServerGetPublisherDataAsync call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergetpublisherdatagetresult"},{"title":"PFTitleDataManagementServerGetPublisherDataGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetPublisherData call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergetpublisherdatagetresultsize"},{"title":"PFTitleDataManagementServerGetTimeAsync","description":"Server API to retrieve the current PlayFab server time as a UTC timestamp, callable from trusted game servers to keep server-side game logic in sync.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettimeasync"},{"title":"PFTitleDataManagementServerGetTimeGetResult","description":"Gets the result of a successful PFTitleDataManagementServerGetTimeAsync call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettimegetresult"},{"title":"PFTitleDataManagementServerGetTitleDataAsync","description":"Server API to retrieve the key-value store of custom title settings for the current PlayFab title, callable from trusted game servers for configuration data.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettitledataasync"},{"title":"PFTitleDataManagementServerGetTitleDataGetResult","description":"Gets the result of a successful PFTitleDataManagementServerGetTitleDataAsync call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettitledatagetresult"},{"title":"PFTitleDataManagementServerGetTitleDataGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetTitleData call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettitledatagetresultsize"},{"title":"PFTitleDataManagementServerGetTitleInternalDataAsync","description":"Retrieves the key-value store of custom internal title settings","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettitleinternaldataasync"},{"title":"PFTitleDataManagementServerGetTitleInternalDataGetResult","description":"Gets the result of a successful PFTitleDataManagementServerGetTitleInternalDataAsync call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettitleinternaldatagetresult"},{"title":"PFTitleDataManagementServerGetTitleInternalDataGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetTitleInternalData call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettitleinternaldatagetresultsize"},{"title":"PFTitleDataManagementServerGetTitleNewsAsync","description":"Server API to retrieve the PlayFab title news feed as configured in Game Manager, callable from trusted game servers when driving announcements server-side.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettitlenewsasync"},{"title":"PFTitleDataManagementServerGetTitleNewsGetResult","description":"Gets the result of a successful PFTitleDataManagementServerGetTitleNewsAsync call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettitlenewsgetresult"},{"title":"PFTitleDataManagementServerGetTitleNewsGetResultSize","description":"Get the size in bytes needed to store the result of a ServerGetTitleNews call.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementservergettitlenewsgetresultsize"},{"title":"PFTitleDataManagementServerSetPublisherDataAsync","description":"Updates the key-value store of custom publisher settings","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementserversetpublisherdataasync"},{"title":"PFTitleDataManagementServerSetTitleDataAsync","description":"Server API to update the key-value store of custom title settings visible to clients, callable from trusted game servers to change title-scoped configuration.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementserversettitledataasync"},{"title":"PFTitleDataManagementServerSetTitleInternalDataAsync","description":"Server API to update the key-value store of internal, server-only title settings hidden from clients, for confidential PlayFab configuration used by game logic.","href":"/services/playfab/api-references/c/pftitledatamanagement/functions/pftitledatamanagementserversettitleinternaldataasync"}]}]},{"group":"PFTitleDataManagementTypes","pages":[{"title":"Services C API overview - PFTitleDataManagementTypes.h","description":"Services C API overview - PFTitleDataManagementTypes.h","sidebarTitle":"PFTitleDataManagementTypes","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/pftitledatamanagementtypes_members"},{"group":"Structs","pages":[{"title":"PFTitleDataManagementGetPublisherDataRequest","description":"PFTitleDataManagementGetPublisherDataRequest data model. This API is designed to return publisher-specific values which can be read, but not written to, by.","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementgetpublisherdatarequest"},{"title":"PFTitleDataManagementGetPublisherDataResult","description":"PFTitleDataManagementGetPublisherDataResult data model.","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementgetpublisherdataresult"},{"title":"PFTitleDataManagementGetTimeResult","description":"PFTitleDataManagementGetTimeResult data model. Time is always returned as Coordinated Universal Time (UTC).","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementgettimeresult"},{"title":"PFTitleDataManagementGetTitleDataRequest","description":"PFTitleDataManagementGetTitleDataRequest data model. This API is designed to return title specific values which can be read, but not written to, by the client.","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementgettitledatarequest"},{"title":"PFTitleDataManagementGetTitleDataResult","description":"PFTitleDataManagementGetTitleDataResult data model.","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementgettitledataresult"},{"title":"PFTitleDataManagementGetTitleNewsRequest","description":"PFTitleDataManagementGetTitleNewsRequest data model.","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementgettitlenewsrequest"},{"title":"PFTitleDataManagementGetTitleNewsResult","description":"PFTitleDataManagementGetTitleNewsResult data model.","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementgettitlenewsresult"},{"title":"PFTitleDataManagementSetPublisherDataRequest","description":"PFTitleDataManagementSetPublisherDataRequest data model. This API is designed to store publisher-specific values which can be read, but not written to, by.","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementsetpublisherdatarequest"},{"title":"PFTitleDataManagementSetTitleDataRequest","description":"PFTitleDataManagementSetTitleDataRequest data model. This API is designed to store title specific values which can be read, but not written to, by the client.","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementsettitledatarequest"},{"title":"PFTitleDataManagementTitleNewsItem","description":"PFTitleDataManagementTitleNewsItem data model.","href":"/services/playfab/api-references/c/pftitledatamanagementtypes/structs/pftitledatamanagementtitlenewsitem"}]}]},{"group":"PFTrace","pages":[{"title":"Services C API overview - PFTrace.h","description":"Services C API overview - PFTrace.h","sidebarTitle":"PFTrace","href":"/services/playfab/api-references/c/pftrace/pftrace_members"},{"group":"Functions","pages":[{"title":"PFTraceEnableTraceToFile","description":"Enables PlayFab trace logging to a file.","href":"/services/playfab/api-references/c/pftrace/functions/pftraceenabletracetofile"}]}]},{"group":"PFTypes","pages":[{"title":"PFTypes.h shared data model structs and enums","description":"Lists structures and enumerations in PFTypes.h, including player profile, user account info, item instance, dictionary entry, and country code types.","sidebarTitle":"PFTypes","href":"/services/playfab/api-references/c/pftypes/pftypes_members"},{"group":"Enums","pages":[{"title":"PFContinentCode","description":"ContinentCode enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfcontinentcode"},{"title":"PFCountryCode","description":"CountryCode enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfcountrycode"},{"title":"PFCurrency","description":"Currency enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfcurrency"},{"title":"PFEmailVerificationStatus","description":"EmailVerificationStatus enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfemailverificationstatus"},{"title":"PFEventType","description":"Reference for the PFEventType enumeration in the PlayFab Services C API, listing the None, Telemetry, and PlayStream event type values in PFTypes.h.","href":"/services/playfab/api-references/c/pftypes/enums/pfeventtype"},{"title":"PFLoginIdentityProvider","description":"LoginIdentityProvider enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfloginidentityprovider"},{"title":"PFOperationTypes","description":"OperationTypes enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfoperationtypes"},{"title":"PFPushNotificationPlatform","description":"PushNotificationPlatform enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfpushnotificationplatform"},{"title":"PFResetInterval","description":"ResetInterval enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfresetinterval"},{"title":"PFSubscriptionProviderStatus","description":"SubscriptionProviderStatus enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfsubscriptionproviderstatus"},{"title":"PFTitleActivationStatus","description":"TitleActivationStatus enum.","href":"/services/playfab/api-references/c/pftypes/enums/pftitleactivationstatus"},{"title":"PFUserDataPermission","description":"UserDataPermission enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfuserdatapermission"},{"title":"PFUserOrigination","description":"UserOrigination enum.","href":"/services/playfab/api-references/c/pftypes/enums/pfuserorigination"}]},{"group":"Structs","pages":[{"title":"PFAdCampaignAttributionModel","description":"PFAdCampaignAttributionModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfadcampaignattributionmodel"},{"title":"PFCharacterInventory","description":"PFCharacterInventory data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfcharacterinventory"},{"title":"PFCharacterResult","description":"PFCharacterResult data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfcharacterresult"},{"title":"PFContactEmailInfoModel","description":"PFContactEmailInfoModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfcontactemailinfomodel"},{"title":"PFDateTimeDictionaryEntry","description":"Dictionary entry for an associative array with time_t values.","href":"/services/playfab/api-references/c/pftypes/structs/pfdatetimedictionaryentry"},{"title":"PFEntityKey C API","description":"PFEntityKey data model. Combined entity type and ID structure which uniquely identifies a single entity.","href":"/services/playfab/api-references/c/pftypes/structs/pfentitykey-c"},{"title":"PFEntityKeyDictionaryEntry","description":"Dictionary entry for an associative array with PFEntityKey values.","href":"/services/playfab/api-references/c/pftypes/structs/pfentitykeydictionaryentry"},{"title":"PFEntityLineage","description":"PFEntityLineage data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfentitylineage"},{"title":"PFEntityLineageDictionaryEntry","description":"Dictionary entry for an associative array with PFEntityLineage values.","href":"/services/playfab/api-references/c/pftypes/structs/pfentitylineagedictionaryentry"},{"title":"PFGetPlayerCombinedInfoRequestParams","description":"PFGetPlayerCombinedInfoRequestParams data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfgetplayercombinedinforequestparams"},{"title":"PFGetPlayerCombinedInfoResultPayload","description":"PFGetPlayerCombinedInfoResultPayload data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfgetplayercombinedinforesultpayload"},{"title":"PFInt32DictionaryEntry","description":"Dictionary entry for an associative array with int32_t values.","href":"/services/playfab/api-references/c/pftypes/structs/pfint32dictionaryentry"},{"title":"PFItemInstance","description":"PFItemInstance data model. A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description.","href":"/services/playfab/api-references/c/pftypes/structs/pfiteminstance"},{"title":"PFJsonObject","description":"String representation of a Json Object","href":"/services/playfab/api-references/c/pftypes/structs/pfjsonobject"},{"title":"PFLinkedPlatformAccountModel","description":"PFLinkedPlatformAccountModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pflinkedplatformaccountmodel"},{"title":"PFLocationModel","description":"PFLocationModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pflocationmodel"},{"title":"PFMembershipModel","description":"PFMembershipModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfmembershipmodel"},{"title":"PFPlayerProfileModel","description":"PFPlayerProfileModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfplayerprofilemodel"},{"title":"PFPlayerProfileViewConstraints","description":"PFPlayerProfileViewConstraints data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfplayerprofileviewconstraints"},{"title":"PFPushNotificationRegistrationModel","description":"PFPushNotificationRegistrationModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfpushnotificationregistrationmodel"},{"title":"PFStatisticModel","description":"PFStatisticModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfstatisticmodel"},{"title":"PFStatisticValue","description":"PFStatisticValue data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfstatisticvalue"},{"title":"PFStringDictionaryEntry","description":"Dictionary entry for an associative array with string values.","href":"/services/playfab/api-references/c/pftypes/structs/pfstringdictionaryentry"},{"title":"PFSubscriptionModel","description":"PFSubscriptionModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfsubscriptionmodel"},{"title":"PFTagModel","description":"PFTagModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pftagmodel"},{"title":"PFTreatmentAssignment","description":"PFTreatmentAssignment data model.","href":"/services/playfab/api-references/c/pftypes/structs/pftreatmentassignment"},{"title":"PFUint32DictionaryEntry","description":"Dictionary entry for an associative array with uint32_t values.","href":"/services/playfab/api-references/c/pftypes/structs/pfuint32dictionaryentry"},{"title":"PFUserAccountInfo","description":"PFUserAccountInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuseraccountinfo"},{"title":"PFUserAndroidDeviceInfo","description":"PFUserAndroidDeviceInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserandroiddeviceinfo"},{"title":"PFUserAppleIdInfo","description":"PFUserAppleIdInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserappleidinfo"},{"title":"PFUserBattleNetInfo","description":"PFUserBattleNetInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserbattlenetinfo"},{"title":"PFUserCustomIdInfo","description":"PFUserCustomIdInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfusercustomidinfo"},{"title":"PFUserDataRecord","description":"PFUserDataRecord data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserdatarecord"},{"title":"PFUserDataRecordDictionaryEntry","description":"Dictionary entry for an associative array with PFUserDataRecord values.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserdatarecorddictionaryentry"},{"title":"PFUserFacebookInfo","description":"PFUserFacebookInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserfacebookinfo"},{"title":"PFUserFacebookInstantGamesIdInfo","description":"PFUserFacebookInstantGamesIdInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserfacebookinstantgamesidinfo"},{"title":"PFUserGameCenterInfo","description":"PFUserGameCenterInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfusergamecenterinfo"},{"title":"PFUserGoogleInfo","description":"PFUserGoogleInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfusergoogleinfo"},{"title":"PFUserGooglePlayGamesInfo","description":"PFUserGooglePlayGamesInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfusergoogleplaygamesinfo"},{"title":"PFUserIosDeviceInfo","description":"PFUserIosDeviceInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuseriosdeviceinfo"},{"title":"PFUserKongregateInfo","description":"PFUserKongregateInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserkongregateinfo"},{"title":"PFUserNintendoSwitchAccountIdInfo","description":"PFUserNintendoSwitchAccountIdInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfusernintendoswitchaccountidinfo"},{"title":"PFUserNintendoSwitchDeviceIdInfo","description":"PFUserNintendoSwitchDeviceIdInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfusernintendoswitchdeviceidinfo"},{"title":"PFUserOpenIdInfo","description":"PFUserOpenIdInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuseropenidinfo"},{"title":"PFUserPrivateAccountInfo","description":"PFUserPrivateAccountInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserprivateaccountinfo"},{"title":"PFUserPsnInfo","description":"PFUserPsnInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserpsninfo"},{"title":"PFUserServerCustomIdInfo","description":"PFUserServerCustomIdInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserservercustomidinfo"},{"title":"PFUserSteamInfo","description":"PFUserSteamInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfusersteaminfo"},{"title":"PFUserTitleInfo","description":"PFUserTitleInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfusertitleinfo"},{"title":"PFUserTwitchInfo","description":"PFUserTwitchInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfusertwitchinfo"},{"title":"PFUserXboxInfo","description":"PFUserXboxInfo data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfuserxboxinfo"},{"title":"PFValueToDateModel","description":"PFValueToDateModel data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfvaluetodatemodel"},{"title":"PFVariable","description":"PFVariable data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfvariable"},{"title":"PFVersionConfiguration","description":"PFVersionConfiguration data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfversionconfiguration"},{"title":"PFVirtualCurrencyRechargeTime","description":"PFVirtualCurrencyRechargeTime data model.","href":"/services/playfab/api-references/c/pftypes/structs/pfvirtualcurrencyrechargetime"},{"title":"PFVirtualCurrencyRechargeTimeDictionaryEntry","description":"Dictionary entry for an associative array with PFVirtualCurrencyRechargeTime values.","href":"/services/playfab/api-references/c/pftypes/structs/pfvirtualcurrencyrechargetimedictionaryentry"}]}]}]},{"group":"Events","pages":[{"title":"PlayStream event model reference for PlayFab","description":"Reference for built-in PlayStream events generated by PlayFab Game Services APIs, plus custom events written through the WriteEvents API and their properties.","sidebarTitle":"Model reference","href":"/services/playfab/api-references/events/index"},{"group":"Addons","pages":[{"title":"title_addon_changed","description":"title_addon_changed event.","href":"/services/playfab/api-references/events/Addons/title-addon-changed"}]},{"group":"AdPlacement","pages":[{"title":"player_ad_closed","description":"player_ad_closed event.","href":"/services/playfab/api-references/events/AdPlacement/player-ad-closed"},{"title":"player_ad_ended","description":"player_ad_ended event.","href":"/services/playfab/api-references/events/AdPlacement/player-ad-ended"},{"title":"player_ad_opened","description":"player_ad_opened event.","href":"/services/playfab/api-references/events/AdPlacement/player-ad-opened"},{"title":"player_ad_rewarded","description":"player_ad_rewarded event.","href":"/services/playfab/api-references/events/AdPlacement/player-ad-rewarded"},{"title":"player_ad_started","description":"player_ad_started event.","href":"/services/playfab/api-references/events/AdPlacement/player-ad-started"}]},{"group":"ApiAccessPolicy","pages":[{"title":"title_api_settings_changed","description":"title_api_settings_changed event.","href":"/services/playfab/api-references/events/ApiAccessPolicy/title-api-settings-changed"},{"title":"title_permission_policy_changed","description":"title_permission_policy_changed event.","href":"/services/playfab/api-references/events/ApiAccessPolicy/title-permission-policy-changed"}]},{"group":"CatalogV1","pages":[{"title":"title_catalog_updated","description":"title_catalog_updated event.","href":"/services/playfab/api-references/events/CatalogV1/title-catalog-updated"},{"title":"title_store_updated","description":"title_store_updated event.","href":"/services/playfab/api-references/events/CatalogV1/title-store-updated"}]},{"group":"CatalogV2","pages":[{"title":"item_created","description":"ItemCreated event.","href":"/services/playfab/api-references/events/CatalogV2/item-created"},{"title":"item_deleted","description":"ItemDeleted event.","href":"/services/playfab/api-references/events/CatalogV2/item-deleted"},{"title":"item_moderation_state_changed","description":"ItemModerationStateChanged event.","href":"/services/playfab/api-references/events/CatalogV2/item-moderation-state-changed"},{"title":"item-publish-requested","description":"ItemPublishRequested event.","sidebarTitle":"item_publish_requested","href":"/services/playfab/api-references/events/CatalogV2/item-publish-requested"},{"title":"item_purchased","description":"item_purchased event.","href":"/services/playfab/api-references/events/CatalogV2/item-purchased"},{"title":"item_reported","description":"ItemReported event.","href":"/services/playfab/api-references/events/CatalogV2/item-reported"},{"title":"item_updated","description":"ItemUpdated event.","href":"/services/playfab/api-references/events/CatalogV2/item-updated"},{"title":"review_reported","description":"ReviewReported event.","href":"/services/playfab/api-references/events/CatalogV2/review-reported"},{"title":"reviews_takedown_requested","description":"ReviewsTakedownRequested event.","href":"/services/playfab/api-references/events/CatalogV2/reviews-takedown-requested"}]},{"group":"Character","pages":[{"title":"character_consumed_item","description":"character_consumed_item event.","href":"/services/playfab/api-references/events/Character/character-consumed-item"},{"title":"character_inventory_item_added","description":"character_inventory_item_added event.","href":"/services/playfab/api-references/events/Character/character-inventory-item-added"},{"title":"character_vc_item_purchased","description":"character_vc_item_purchased event.","href":"/services/playfab/api-references/events/Character/character-vc-item-purchased"},{"title":"character_virtual_currency_balance_changed","description":"character_virtual_currency_balance_changed event.","href":"/services/playfab/api-references/events/Character/character-virtual-currency-balance-changed"}]},{"group":"CloudScript","pages":[{"title":"cloudscript_executed","description":"cloudscript_executed event.","href":"/services/playfab/api-references/events/CloudScript/cloudscript-executed"},{"title":"entity_executed_cloud_script","description":"entity_executed_cloud_script event.","href":"/services/playfab/api-references/events/CloudScript/entity-executed-cloud-script"},{"title":"player_executed_cloudscript","description":"player_executed_cloudscript event.","href":"/services/playfab/api-references/events/CloudScript/player-executed-cloudscript"},{"title":"player_triggered_action_executed_cloudscript","description":"player_triggered_action_executed_cloudscript event.","href":"/services/playfab/api-references/events/CloudScript/player-triggered-action-executed-cloudscript"},{"title":"title_added_cloudscript","description":"title_added_cloudscript event.","href":"/services/playfab/api-references/events/CloudScript/title-added-cloudscript"},{"title":"title_published_cloudscript","description":"title_published_cloudscript event.","href":"/services/playfab/api-references/events/CloudScript/title-published-cloudscript"},{"title":"title_scheduled_cloudscript_executed","description":"title_scheduled_cloudscript_executed event.","href":"/services/playfab/api-references/events/CloudScript/title-scheduled-cloudscript-executed"}]},{"group":"Data types","pages":[{"title":"ActionEventDetails","description":"ActionEventDetails data type.","href":"/services/playfab/api-references/events/data-types/actioneventdetails"},{"title":"ActionExecutionError","description":"ActionExecutionError data type.","href":"/services/playfab/api-references/events/data-types/actionexecutionerror"},{"title":"ActionFailure","description":"ActionFailure data type.","href":"/services/playfab/api-references/events/data-types/actionfailure"},{"title":"ActionResultDetails","description":"ActionResultDetails data type.","href":"/services/playfab/api-references/events/data-types/actionresultdetails"},{"title":"ActionTrigger","description":"ActionTrigger data type.","href":"/services/playfab/api-references/events/data-types/actiontrigger"},{"title":"ActionType","description":"ActionType data type.","href":"/services/playfab/api-references/events/data-types/actiontype"},{"title":"AdCampaignAttribution","description":"AdCampaignAttribution data type.","href":"/services/playfab/api-references/events/data-types/adcampaignattribution"},{"title":"AddOnProvisioningState data type","description":"Reference for the PlayFab AddOnProvisioningState data type used in PlayStream events to represent the provisioning state of a title add-on.","href":"/services/playfab/api-references/events/data-types/addonprovisioningstate"},{"title":"AlertLevel","description":"AlertLevel data type.","href":"/services/playfab/api-references/events/data-types/alertlevel"},{"title":"AlertStates","description":"AlertStates data type.","href":"/services/playfab/api-references/events/data-types/alertstates"},{"title":"APIKeyActivatedPayload","description":"Payload for when an entity API key is activated.","href":"/services/playfab/api-references/events/data-types/apikeyactivatedpayload"},{"title":"APIKeyCreatedPayload","description":"Payload for when an entity API key is created.","href":"/services/playfab/api-references/events/data-types/apikeycreatedpayload"},{"title":"APIKeyDeactivatedPayload","description":"Payload for when an entity API key is deactivated.","href":"/services/playfab/api-references/events/data-types/apikeydeactivatedpayload"},{"title":"APIKeyDeletedPayload","description":"Payload for when an entity API key is deleted.","href":"/services/playfab/api-references/events/data-types/apikeydeletedpayload"},{"title":"APISettings","description":"APISettings data type.","href":"/services/playfab/api-references/events/data-types/apisettings"},{"title":"Artifact","description":"Artifact data type.","href":"/services/playfab/api-references/events/data-types/artifact"},{"title":"AuthenticationProvider","description":"AuthenticationProvider data type.","href":"/services/playfab/api-references/events/data-types/authenticationprovider"},{"title":"AzureRegion","description":"AzureRegion data type.","href":"/services/playfab/api-references/events/data-types/azureregion"},{"title":"BuildAliasCreatedEventPayload","description":"BuildAliasCreatedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/buildaliascreatedeventpayload"},{"title":"BuildAliasDeletedEventPayload","description":"BuildAliasDeletedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/buildaliasdeletedeventpayload"},{"title":"BuildAliasUpdatedEventPayload","description":"BuildAliasUpdatedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/buildaliasupdatedeventpayload"},{"title":"BuildDeletedEventPayload","description":"BuildDeletedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/builddeletedeventpayload"},{"title":"BuildRegion","description":"BuildRegion data type.","href":"/services/playfab/api-references/events/data-types/buildregion"},{"title":"BuildRegionStatusChangedEventPayload","description":"BuildRegionStatusChangedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/buildregionstatuschangedeventpayload"},{"title":"BuildRegionUpdatedEventPayload","description":"BuildRegionUpdatedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/buildregionupdatedeventpayload"},{"title":"BuildRegionUtilizationEventPayload","description":"BuildRegionUtilizationEventPayload data type.","href":"/services/playfab/api-references/events/data-types/buildregionutilizationeventpayload"},{"title":"CartItem","description":"CartItem data type.","href":"/services/playfab/api-references/events/data-types/cartitem"},{"title":"CertificateDeletedEventPayload","description":"CertificateDeletedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/certificatedeletedeventpayload"},{"title":"CertificateUploadedEventPayload","description":"CertificateUploadedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/certificateuploadedeventpayload"},{"title":"ChurnRiskLevel","description":"ChurnRiskLevel data type.","href":"/services/playfab/api-references/events/data-types/churnrisklevel"},{"title":"ClientFocusChangePayload","description":"ClientFocusChangePayload data type.","href":"/services/playfab/api-references/events/data-types/clientfocuschangepayload"},{"title":"ClientSessionStartPayload","description":"ClientSessionStartPayload data type.","href":"/services/playfab/api-references/events/data-types/clientsessionstartpayload"},{"title":"ContactEmailDetails data type","description":"Reference for the PlayFab ContactEmailDetails data type describing a contact email address attached to an entity profile in PlayStream events.","href":"/services/playfab/api-references/events/data-types/contactemaildetails"},{"title":"ContactEmailInfo","description":"ContactEmailInfo data type.","href":"/services/playfab/api-references/events/data-types/contactemailinfo"},{"title":"ContinentCode","description":"ContinentCode data type.","href":"/services/playfab/api-references/events/data-types/continentcode"},{"title":"CountryCode","description":"CountryCode data type.","href":"/services/playfab/api-references/events/data-types/countrycode"},{"title":"CouponGrantedInventoryItem","description":"CouponGrantedInventoryItem data type.","href":"/services/playfab/api-references/events/data-types/coupongrantedinventoryitem"},{"title":"CrashDetectedEventPayload","description":"CrashDetectedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/crashdetectedeventpayload"},{"title":"CreateBuildInitiatedEventPayload","description":"CreateBuildInitiatedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/createbuildinitiatedeventpayload"},{"title":"Currency","description":"Currency data type.","href":"/services/playfab/api-references/events/data-types/currency"},{"title":"EmailTemplateType","description":"EmailTemplateType data type.","href":"/services/playfab/api-references/events/data-types/emailtemplatetype"},{"title":"EmailVerificationStatus","description":"EmailVerificationStatus data type.","href":"/services/playfab/api-references/events/data-types/emailverificationstatus"},{"title":"EntityKey","description":"EntityKey data type.","href":"/services/playfab/api-references/events/data-types/entitykey"},{"title":"EntityLineage","description":"EntityLineage data type.","href":"/services/playfab/api-references/events/data-types/entitylineage"},{"title":"EntityObject","description":"EntityObject data type.","href":"/services/playfab/api-references/events/data-types/entityobject"},{"title":"EventExportCompletionStatus","description":"EventExportCompletionStatus data type.","href":"/services/playfab/api-references/events/data-types/eventexportcompletionstatus"},{"title":"EventLocation","description":"EventLocation data type.","href":"/services/playfab/api-references/events/data-types/eventlocation"},{"title":"EventRuleMatch","description":"EventRuleMatch data type.","href":"/services/playfab/api-references/events/data-types/eventrulematch"},{"title":"ExecuteCloudScriptResult","description":"ExecuteCloudScriptResult data type.","href":"/services/playfab/api-references/events/data-types/executecloudscriptresult"},{"title":"ExecuteFunctionResult","description":"ExecuteFunctionResult data type.","href":"/services/playfab/api-references/events/data-types/executefunctionresult"},{"title":"Experiment","description":"Experiment data type.","href":"/services/playfab/api-references/events/data-types/experiment"},{"title":"ExperimentRequestOrigin","description":"ExperimentRequestOrigin data type.","href":"/services/playfab/api-references/events/data-types/experimentrequestorigin"},{"title":"ExperimentVariable","description":"ExperimentVariable data type.","href":"/services/playfab/api-references/events/data-types/experimentvariable"},{"title":"ExperimentVariant","description":"ExperimentVariant data type.","href":"/services/playfab/api-references/events/data-types/experimentvariant"},{"title":"FileDetails data type","description":"Reference for the PlayFab FileDetails data type describing metadata about a file attached to an entity in PlayStream event payloads.","href":"/services/playfab/api-references/events/data-types/filedetails"},{"title":"FileSet","description":"FileSet data type.","href":"/services/playfab/api-references/events/data-types/fileset"},{"title":"FullNameObject","description":"FullNameObject data type.","href":"/services/playfab/api-references/events/data-types/fullnameobject"},{"title":"GameAssetDeletedEventPayload","description":"GameAssetDeletedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/gameassetdeletedeventpayload"},{"title":"GameCertificateDeployed","description":"GameCertificateDeployed data type.","href":"/services/playfab/api-references/events/data-types/gamecertificatedeployed"},{"title":"GameSaveConflict","description":"GameSaveConflict data type.","href":"/services/playfab/api-references/events/data-types/gamesaveconflict"},{"title":"GameServerHostStopReason","description":"GameServerHostStopReason data type.","href":"/services/playfab/api-references/events/data-types/gameserverhoststopreason"},{"title":"GenericErrorCodes","description":"GenericErrorCodes data type.","href":"/services/playfab/api-references/events/data-types/genericerrorcodes"},{"title":"GroupPropertyValues","description":"GroupPropertyValues data type.","href":"/services/playfab/api-references/events/data-types/grouppropertyvalues"},{"title":"ItemPurchasedCurrency data type","description":"Reference for the PlayFab ItemPurchasedCurrency data type describing the currency used in a purchase event within PlayStream event payloads.","href":"/services/playfab/api-references/events/data-types/itempurchasedcurrency"},{"title":"ItemPurchasedOverride data type","description":"Reference for the PlayFab ItemPurchasedOverride data type describing pricing or currency overrides applied to purchase events in PlayStream payloads.","href":"/services/playfab/api-references/events/data-types/itempurchasedoverride"},{"title":"ItemsClawbackCompletedPayload","description":"ItemsClawbackCompletedPayload data type.","href":"/services/playfab/api-references/events/data-types/itemsclawbackcompletedpayload"},{"title":"ItemsClawbackReversalCompletedPayload","description":"ItemsClawbackReversalCompletedPayload data type.","href":"/services/playfab/api-references/events/data-types/itemsclawbackreversalcompletedpayload"},{"title":"ItemsExpiredPayload","description":"ItemsExpiredPayload data type.","href":"/services/playfab/api-references/events/data-types/itemsexpiredpayload"},{"title":"LeaderboardSource","description":"LeaderboardSource data type.","href":"/services/playfab/api-references/events/data-types/leaderboardsource"},{"title":"LeaderboardVersionChangeBehavior","description":"LeaderboardVersionChangeBehavior data type.","href":"/services/playfab/api-references/events/data-types/leaderboardversionchangebehavior"},{"title":"LoginIdentityProvider","description":"LoginIdentityProvider data type.","href":"/services/playfab/api-references/events/data-types/loginidentityprovider"},{"title":"LogStatement","description":"LogStatement data type.","href":"/services/playfab/api-references/events/data-types/logstatement"},{"title":"MatchmakingMatchFoundPayload","description":"MatchmakingMatchFoundPayload data type.","href":"/services/playfab/api-references/events/data-types/matchmakingmatchfoundpayload"},{"title":"MatchmakingTicketCompletePayload","description":"MatchmakingTicketCompletePayload data type.","href":"/services/playfab/api-references/events/data-types/matchmakingticketcompletepayload"},{"title":"MatchmakingUserTicketCompletePayload","description":"MatchmakingUserTicketCompletePayload data type.","href":"/services/playfab/api-references/events/data-types/matchmakinguserticketcompletepayload"},{"title":"MatchmakingUserTicketInvitePayload","description":"MatchmakingUserTicketInvitePayload data type.","href":"/services/playfab/api-references/events/data-types/matchmakinguserticketinvitepayload"},{"title":"Member","description":"Member data type.","href":"/services/playfab/api-references/events/data-types/member"},{"title":"MetricUnit","description":"MetricUnit data type.","href":"/services/playfab/api-references/events/data-types/metricunit"},{"title":"MonitoringOutputSavedEventPayload","description":"MonitoringOutputSavedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/monitoringoutputsavedeventpayload"},{"title":"NameId","description":"NameId data type.","href":"/services/playfab/api-references/events/data-types/nameid"},{"title":"NameIdentifier","description":"NameIdentifier data type.","href":"/services/playfab/api-references/events/data-types/nameidentifier"},{"title":"NewsStatus","description":"NewsStatus data type.","href":"/services/playfab/api-references/events/data-types/newsstatus"},{"title":"ObjectDetails data type","description":"Reference for the PlayFab ObjectDetails data type describing metadata about an object attached to an entity in PlayStream event payloads.","href":"/services/playfab/api-references/events/data-types/objectdetails"},{"title":"ObjectSet","description":"ObjectSet data type.","href":"/services/playfab/api-references/events/data-types/objectset"},{"title":"OperationTypes","description":"OperationTypes data type.","href":"/services/playfab/api-references/events/data-types/operationtypes"},{"title":"OriginatorObject","description":"OriginatorObject data type.","href":"/services/playfab/api-references/events/data-types/originatorobject"},{"title":"PasswordResetInitiationSource","description":"PasswordResetInitiationSource data type.","href":"/services/playfab/api-references/events/data-types/passwordresetinitiationsource"},{"title":"PaymentOptionPerMauPriceTier","description":"PaymentOptionPerMauPriceTier data type.","href":"/services/playfab/api-references/events/data-types/paymentoptionpermaupricetier"},{"title":"PaymentType","description":"PaymentType data type.","href":"/services/playfab/api-references/events/data-types/paymenttype"},{"title":"PhotonServicesEnum","description":"PhotonServicesEnum data type.","href":"/services/playfab/api-references/events/data-types/photonservicesenum"},{"title":"PlayerCustomPropertiesChangedDetails data type","description":"Reference for the PlayFab PlayerCustomPropertiesChangedDetails data type describing changes to custom player properties in PlayStream events.","href":"/services/playfab/api-references/events/data-types/playercustompropertieschangeddetails"},{"title":"PlayerLinkedAccount","description":"PlayerLinkedAccount data type.","href":"/services/playfab/api-references/events/data-types/playerlinkedaccount"},{"title":"PlayerLocation","description":"PlayerLocation data type.","href":"/services/playfab/api-references/events/data-types/playerlocation"},{"title":"PlayerMemberships","description":"Player Memberships data type.","href":"/services/playfab/api-references/events/data-types/playermemberships"},{"title":"PlayerProfile","description":"PlayerProfile data type.","href":"/services/playfab/api-references/events/data-types/playerprofile"},{"title":"PlayerProfileProperty","description":"PlayerProfileProperty data type.","href":"/services/playfab/api-references/events/data-types/playerprofileproperty"},{"title":"PlayerStatistic","description":"PlayerStatistic data type.","href":"/services/playfab/api-references/events/data-types/playerstatistic"},{"title":"PlayStreamEventHistory","description":"PlayStreamEventHistory data type.","href":"/services/playfab/api-references/events/data-types/playstreameventhistory"},{"title":"PurchasePriceAmount","description":"PurchasePriceAmount data type.","href":"/services/playfab/api-references/events/data-types/purchasepriceamount"},{"title":"PushNotificationPlatform","description":"PushNotificationPlatform data type.","href":"/services/playfab/api-references/events/data-types/pushnotificationplatform"},{"title":"PushNotificationRegistration","description":"PushNotificationRegistration data type.","href":"/services/playfab/api-references/events/data-types/pushnotificationregistration"},{"title":"Region","description":"Region data type.","href":"/services/playfab/api-references/events/data-types/region"},{"title":"review_takedown","description":"ReviewTakedown data type.","href":"/services/playfab/api-references/events/data-types/review-takedown"},{"title":"RolePropertyValues","description":"RolePropertyValues data type.","href":"/services/playfab/api-references/events/data-types/rolepropertyvalues"},{"title":"ScriptExecutionError","description":"ScriptExecutionError data type.","href":"/services/playfab/api-references/events/data-types/scriptexecutionerror"},{"title":"SecretAddedEventPayload","description":"SecretAddedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/secretaddedeventpayload"},{"title":"SecretDeletedEventPayload","description":"SecretDeletedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/secretdeletedeventpayload"},{"title":"SegmentMembershipChange","description":"SegmentMembershipChange data type.","href":"/services/playfab/api-references/events/data-types/segmentmembershipchange"},{"title":"SegmentMembershipChangeType","description":"SegmentMembershipChangeType data type.","href":"/services/playfab/api-references/events/data-types/segmentmembershipchangetype"},{"title":"SegmentOperation","description":"SegmentOperation data type.","href":"/services/playfab/api-references/events/data-types/segmentoperation"},{"title":"SegmentOperationStatus","description":"SegmentOperationStatus data type.","href":"/services/playfab/api-references/events/data-types/segmentoperationstatus"},{"title":"ServerRequestedEventPayload","description":"ServerRequestedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/serverrequestedeventpayload"},{"title":"ServerStateChangedEventPayload","description":"ServerStateChangedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/serverstatechangedeventpayload"},{"title":"SourceType","description":"SourceType data type.","href":"/services/playfab/api-references/events/data-types/sourcetype"},{"title":"StatisticAggregationMethod","description":"StatisticAggregationMethod data type.","href":"/services/playfab/api-references/events/data-types/statisticaggregationmethod"},{"title":"StatisticLeaderboardSource","description":"StatisticLeaderboardSource data type.","href":"/services/playfab/api-references/events/data-types/statisticleaderboardsource"},{"title":"StatisticResetIntervalOption","description":"StatisticResetIntervalOption data type.","href":"/services/playfab/api-references/events/data-types/statisticresetintervaloption"},{"title":"Subscriptions","description":"Subscriptions data type.","href":"/services/playfab/api-references/events/data-types/subscriptions"},{"title":"TaskInstanceStatus","description":"TaskInstanceStatus data type.","href":"/services/playfab/api-references/events/data-types/taskinstancestatus"},{"title":"TitleDataType data type","description":"Reference for the PlayFab TitleDataType enumeration that specifies the type of title data referenced by PlayStream events and related APIs.","href":"/services/playfab/api-references/events/data-types/titledatatype"},{"title":"TransactionStatus","description":"TransactionStatus data type.","href":"/services/playfab/api-references/events/data-types/transactionstatus"},{"title":"VmAssignedEventPayload","description":"VmAssignedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/vmassignedeventpayload"},{"title":"VmGameCertificatesDeployedEventPayload","description":"VmGameCertificatesDeployedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/vmgamecertificatesdeployedeventpayload"},{"title":"VmRemoteUserCreatedEventPayload","description":"VmRemoteUserCreatedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/vmremoteusercreatedeventpayload"},{"title":"VmRemoteUserDeletedEventPayload","description":"VmRemoteUserDeletedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/vmremoteuserdeletedeventpayload"},{"title":"VmStateChangeEventPayload","description":"VmStateChangeEventPayload data type.","href":"/services/playfab/api-references/events/data-types/vmstatechangeeventpayload"},{"title":"VmUnassignmentStartedEventPayload","description":"VmUnassignmentStartedEventPayload data type.","href":"/services/playfab/api-references/events/data-types/vmunassignmentstartedeventpayload"},{"title":"VmUnhealthyEventPayload","description":"VmUnhealthyEventPayload data type.","href":"/services/playfab/api-references/events/data-types/vmunhealthyeventpayload"}]},{"group":"DeveloperIdentity","pages":[{"title":"studio_created","description":"studio_created event.","href":"/services/playfab/api-references/events/DeveloperIdentity/studio-created"},{"title":"studio_user_added","description":"studio_user_added event.","href":"/services/playfab/api-references/events/DeveloperIdentity/studio-user-added"},{"title":"studio_user_invited","description":"studio_user_invited event.","href":"/services/playfab/api-references/events/DeveloperIdentity/studio-user-invited"},{"title":"studio_user_removed","description":"studio_user_removed event.","href":"/services/playfab/api-references/events/DeveloperIdentity/studio-user-removed"}]},{"group":"Experimentation","pages":[{"title":"exclusion_group_created","description":"exclusion_group_created event.","href":"/services/playfab/api-references/events/Experimentation/exclusion-group-created"},{"title":"exclusion_group_deleted","description":"exclusion_group_deleted event.","href":"/services/playfab/api-references/events/Experimentation/exclusion-group-deleted"},{"title":"exclusion_group_updated","description":"exclusion_group_updated event.","href":"/services/playfab/api-references/events/Experimentation/exclusion-group-updated"},{"title":"experiment_created","description":"experiment_created event.","href":"/services/playfab/api-references/events/Experimentation/experiment-created"},{"title":"experiment_deleted","description":"experiment_deleted event.","href":"/services/playfab/api-references/events/Experimentation/experiment-deleted"},{"title":"experiment_start_requested","description":"experiment_start_requested event.","href":"/services/playfab/api-references/events/Experimentation/experiment-start-requested"},{"title":"experiment_stop_requested","description":"experiment_stop_requested event.","href":"/services/playfab/api-references/events/Experimentation/experiment-stop-requested"},{"title":"experiment_updated","description":"experiment_updated event.","href":"/services/playfab/api-references/events/Experimentation/experiment-updated"},{"title":"player_experiment_variants_changed","description":"player_experiment_variants_changed event.","href":"/services/playfab/api-references/events/Experimentation/player-experiment-variants-changed"}]},{"group":"Extension","pages":[{"title":"export_completed","description":"export_completed event.","href":"/services/playfab/api-references/events/Extension/export-completed"},{"title":"title_aborted_task","description":"title_aborted_task event.","href":"/services/playfab/api-references/events/Extension/title-aborted-task"},{"title":"title_completed_task","description":"title_completed_task event.","href":"/services/playfab/api-references/events/Extension/title-completed-task"},{"title":"title_created_task","description":"title_created_task event.","href":"/services/playfab/api-references/events/Extension/title-created-task"},{"title":"title_deleted_task","description":"title_deleted_task event.","href":"/services/playfab/api-references/events/Extension/title-deleted-task"},{"title":"title_exceeded_limit","description":"title_exceeded_limit event.","href":"/services/playfab/api-references/events/Extension/title-exceeded-limit"},{"title":"title_limit_changed","description":"title_limit_changed event.","href":"/services/playfab/api-references/events/Extension/title-limit-changed"},{"title":"title_started_task","description":"title_started_task event.","href":"/services/playfab/api-references/events/Extension/title-started-task"},{"title":"title_updated_task","description":"title_updated_task event.","href":"/services/playfab/api-references/events/Extension/title-updated-task"}]},{"group":"Functions","pages":[{"title":"function_executed","description":"function_executed event.","href":"/services/playfab/api-references/events/Functions/function-executed"},{"title":"function_registered","description":"function_registered event.","href":"/services/playfab/api-references/events/Functions/function-registered"},{"title":"function_unregistered","description":"function_unregistered event.","href":"/services/playfab/api-references/events/Functions/function-unregistered"},{"title":"player_triggered_action_executed_function","description":"player_triggered_action_executed_function event.","href":"/services/playfab/api-references/events/Functions/player-triggered-action-executed-function"},{"title":"title_scheduled_function_executed","description":"title_scheduled_function_executed event.","href":"/services/playfab/api-references/events/Functions/title-scheduled-function-executed"}]},{"group":"GameSave","pages":[{"title":"gamesave_version_finalized","description":"gamesave_version_finalized event.","href":"/services/playfab/api-references/events/GameSave/gamesave-version-finalized"},{"title":"gamesave_version_marked_known_good","description":"gamesave_version_marked_known_good event.","href":"/services/playfab/api-references/events/GameSave/gamesave-version-marked-known-good"}]},{"group":"General","pages":[{"title":"entity_virtual_currency_balances_changed","description":"entity_virtual_currency_balances_changed event.","href":"/services/playfab/api-references/events/General/entity-virtual-currency-balances-changed"},{"title":"studio_tier_updated","description":"studio_tier_updated event.","href":"/services/playfab/api-references/events/General/studio-tier-updated"},{"title":"tenancy_connector_onboard","description":"tenancy_connector_onboard event.","href":"/services/playfab/api-references/events/General/tenancy-connector-onboard"}]},{"group":"Groups","pages":[{"title":"group_created","description":"group_created event.","href":"/services/playfab/api-references/events/Groups/group-created"},{"title":"group_members_added","description":"group_members_added event.","href":"/services/playfab/api-references/events/Groups/group-members-added"},{"title":"group_members_removed","description":"group_members_removed event.","href":"/services/playfab/api-references/events/Groups/group-members-removed"},{"title":"group_role_created","description":"group_role_created event.","href":"/services/playfab/api-references/events/Groups/group-role-created"},{"title":"group_role_deleted","description":"group_role_deleted event.","href":"/services/playfab/api-references/events/Groups/group-role-deleted"},{"title":"group_role_members_added","description":"group_role_members_added event.","href":"/services/playfab/api-references/events/Groups/group-role-members-added"},{"title":"group_role_members_removed","description":"group_role_members_removed event.","href":"/services/playfab/api-references/events/Groups/group-role-members-removed"},{"title":"group_role_updated","description":"group_role_updated event.","href":"/services/playfab/api-references/events/Groups/group-role-updated"},{"title":"group_updated","description":"group_updated event.","href":"/services/playfab/api-references/events/Groups/group-updated"},{"title":"members_added","description":"members_added event.","href":"/services/playfab/api-references/events/Groups/members-added"},{"title":"members_removed","description":"members_removed event.","href":"/services/playfab/api-references/events/Groups/members-removed"},{"title":"members_role_updated","description":"members_role_updated event.","href":"/services/playfab/api-references/events/Groups/members-role-updated"},{"title":"player_updated_membership","description":"player_updated_membership event.","href":"/services/playfab/api-references/events/Groups/player-updated-membership"},{"title":"role_updated","description":"role_updated event.","href":"/services/playfab/api-references/events/Groups/role-updated"}]},{"group":"Inventory","pages":[{"title":"items_added","description":"ItemsAdded event.","href":"/services/playfab/api-references/events/Inventory/items-added"},{"title":"items_clawback_completed","description":"items_clawback_completed event.","href":"/services/playfab/api-references/events/Inventory/items-clawback-completed"},{"title":"items_clawback_reversal_completed","description":"items_clawback_reversal_completed event.","href":"/services/playfab/api-references/events/Inventory/items-clawback-reversal-completed"},{"title":"items_deleted","description":"ItemsDeleted event.","href":"/services/playfab/api-references/events/Inventory/items-deleted"},{"title":"items_expired","description":"items_expired event.","href":"/services/playfab/api-references/events/Inventory/items-expired"},{"title":"items_purchased","description":"ItemsPurchased event.","href":"/services/playfab/api-references/events/Inventory/items-purchased"},{"title":"items_redeemed","description":"ItemsRedeemed event.","href":"/services/playfab/api-references/events/Inventory/items-redeemed"},{"title":"items_subtracted","description":"ItemsSubtracted event.","href":"/services/playfab/api-references/events/Inventory/items-subtracted"},{"title":"items_transferred","description":"ItemsTransferred event.","href":"/services/playfab/api-references/events/Inventory/items-transferred"},{"title":"items_updated","description":"ItemsUpdated event.","href":"/services/playfab/api-references/events/Inventory/items-updated"},{"title":"marketplace_transaction_redeemed","description":"marketplace_transaction_redeemed event.","href":"/services/playfab/api-references/events/Inventory/marketplace-transaction-redeemed"}]},{"group":"Leaderboards","pages":[{"title":"character_statistic_changed","description":"character_statistic_changed event.","href":"/services/playfab/api-references/events/Leaderboards/character-statistic-changed"},{"title":"character_statistic_deleted","description":"character_statistic_deleted event.","href":"/services/playfab/api-references/events/Leaderboards/character-statistic-deleted"},{"title":"entity_rank_on_leaderboard_version_ended","description":"entity_rank_on_leaderboard_version_ended event.","href":"/services/playfab/api-references/events/Leaderboards/entity-rank-on-leaderboard-version-ended"},{"title":"leaderboard_version_ended","description":"leaderboard_version_ended event.","href":"/services/playfab/api-references/events/Leaderboards/leaderboard-version-ended"},{"title":"player_ranked_on_leaderboard_version","description":"player_ranked_on_leaderboard_version event.","href":"/services/playfab/api-references/events/Leaderboards/player-ranked-on-leaderboard-version"},{"title":"player_statistic_changed","description":"player_statistic_changed event.","href":"/services/playfab/api-references/events/Leaderboards/player-statistic-changed"},{"title":"player_statistic_deleted","description":"player_statistic_deleted event.","href":"/services/playfab/api-references/events/Leaderboards/player-statistic-deleted"},{"title":"title_statistic_deleted","description":"title_statistic_deleted event.","href":"/services/playfab/api-references/events/Leaderboards/title-statistic-deleted"},{"title":"title_statistic_version_changed","description":"title_statistic_version_changed event.","href":"/services/playfab/api-references/events/Leaderboards/title-statistic-version-changed"}]},{"group":"Matchmaking","pages":[{"title":"match_found","description":"match_found event.","href":"/services/playfab/api-references/events/Matchmaking/match-found"},{"title":"ticket_completed","description":"ticket_completed event.","href":"/services/playfab/api-references/events/Matchmaking/ticket-completed"},{"title":"title_queue_config_updated","description":"title_queue_config_updated event.","href":"/services/playfab/api-references/events/Matchmaking/title-queue-config-updated"},{"title":"user_ticket_invited","description":"user_ticket_invited event.","href":"/services/playfab/api-references/events/Matchmaking/user-ticket-invited"}]},{"group":"MultiplayerServers","pages":[{"title":"build_alias_created","description":"build_alias_created event.","href":"/services/playfab/api-references/events/MultiplayerServers/build-alias-created"},{"title":"build_alias_deleted","description":"build_alias_deleted event.","href":"/services/playfab/api-references/events/MultiplayerServers/build-alias-deleted"},{"title":"build_alias_updated","description":"build_alias_updated event.","href":"/services/playfab/api-references/events/MultiplayerServers/build-alias-updated"},{"title":"build_deleted","description":"build_deleted event.","href":"/services/playfab/api-references/events/MultiplayerServers/build-deleted"},{"title":"build_region_status_changed","description":"build_region_status_changed event.","href":"/services/playfab/api-references/events/MultiplayerServers/build-region-status-changed"},{"title":"build_region_updated","description":"build_region_updated event.","href":"/services/playfab/api-references/events/MultiplayerServers/build-region-updated"},{"title":"build_region_utilization","description":"build_region_utilization event.","href":"/services/playfab/api-references/events/MultiplayerServers/build-region-utilization"},{"title":"certificate_deleted","description":"certificate_deleted event.","href":"/services/playfab/api-references/events/MultiplayerServers/certificate-deleted"},{"title":"certificate_uploaded","description":"certificate_uploaded event.","href":"/services/playfab/api-references/events/MultiplayerServers/certificate-uploaded"},{"title":"crash_detected","description":"crash_detected event.","href":"/services/playfab/api-references/events/MultiplayerServers/crash-detected"},{"title":"create_build_initiated","description":"create_build_initiated event.","href":"/services/playfab/api-references/events/MultiplayerServers/create-build-initiated"},{"title":"enabled_for_title","description":"enabled_for_title event.","href":"/services/playfab/api-references/events/MultiplayerServers/enabled-for-title"},{"title":"game_asset_deleted","description":"game_asset_deleted event.","href":"/services/playfab/api-references/events/MultiplayerServers/game-asset-deleted"},{"title":"monitoring_output_saved","description":"monitoring_output_saved event.","href":"/services/playfab/api-references/events/MultiplayerServers/monitoring-output-saved"},{"title":"secret_added","description":"secret_added event.","href":"/services/playfab/api-references/events/MultiplayerServers/secret-added"},{"title":"secret_deleted","description":"secret_deleted event.","href":"/services/playfab/api-references/events/MultiplayerServers/secret-deleted"},{"title":"server_requested","description":"server_requested event.","href":"/services/playfab/api-references/events/MultiplayerServers/server-requested"},{"title":"server_state_changed","description":"server_state_changed event.","href":"/services/playfab/api-references/events/MultiplayerServers/server-state-changed"},{"title":"vm_assigned","description":"vm_assigned event.","href":"/services/playfab/api-references/events/MultiplayerServers/vm-assigned"},{"title":"vm_game_certificates_deployed","description":"vm_game_certificates_deployed event.","href":"/services/playfab/api-references/events/MultiplayerServers/vm-game-certificates-deployed"},{"title":"vm_remote_user_created","description":"vm_remote_user_created event.","href":"/services/playfab/api-references/events/MultiplayerServers/vm-remote-user-created"},{"title":"vm_remote_user_deleted","description":"vm_remote_user_deleted event.","href":"/services/playfab/api-references/events/MultiplayerServers/vm-remote-user-deleted"},{"title":"vm_state_change","description":"vm_state_change event.","href":"/services/playfab/api-references/events/MultiplayerServers/vm-state-change"},{"title":"vm_unassignment_started","description":"vm_unassignment_started event.","href":"/services/playfab/api-references/events/MultiplayerServers/vm-unassignment-started"},{"title":"vm_unhealthy","description":"vm_unhealthy event.","href":"/services/playfab/api-references/events/MultiplayerServers/vm-unhealthy"}]},{"group":"Networking","pages":[{"title":"client_authentication_completed","description":"client_authentication_completed event.","href":"/services/playfab/api-references/events/Networking/client-authentication-completed"},{"title":"client_connected_to_network","description":"client_connected_to_network event.","href":"/services/playfab/api-references/events/Networking/client-connected-to-network"},{"title":"client_initialization_completed","description":"client_initialization_completed event.","href":"/services/playfab/api-references/events/Networking/client-initialization-completed"},{"title":"client_network_created","description":"client_network_created event.","href":"/services/playfab/api-references/events/Networking/client-network-created"},{"title":"client_network_destroyed","description":"client_network_destroyed event.","href":"/services/playfab/api-references/events/Networking/client-network-destroyed"},{"title":"client_network_information_received","description":"client_network_information_received event.","href":"/services/playfab/api-references/events/Networking/client-network-information-received"},{"title":"client_request_failed","description":"client_request_failed event.","href":"/services/playfab/api-references/events/Networking/client-request-failed"},{"title":"data_received_by_clients","description":"data_received_by_clients event.","href":"/services/playfab/api-references/events/Networking/data-received-by-clients"},{"title":"data_sent_by_clients","description":"data_sent_by_clients event.","href":"/services/playfab/api-references/events/Networking/data-sent-by-clients"},{"title":"moderation_service_request_count","description":"moderation_service_request_count event.","href":"/services/playfab/api-references/events/Networking/moderation-service-request-count"},{"title":"player_disconnected_from_network","description":"player_disconnected_from_network event.","href":"/services/playfab/api-references/events/Networking/player-disconnected-from-network"},{"title":"unity_client_initialization_completed","description":"unity_client_initialization_completed event.","href":"/services/playfab/api-references/events/Networking/unity-client-initialization-completed"},{"title":"unreal_client_initialization_completed","description":"unreal_client_initialization_completed event.","href":"/services/playfab/api-references/events/Networking/unreal-client-initialization-completed"}]},{"group":"Partner","pages":[{"title":"display_name_filtered","description":"display_name_filtered event.","href":"/services/playfab/api-references/events/Partner/display-name-filtered"},{"title":"player_display_name_filtered","description":"player_display_name_filtered event.","href":"/services/playfab/api-references/events/Partner/player-display-name-filtered"},{"title":"player_photon_session_authenticated","description":"player_photon_session_authenticated event.","href":"/services/playfab/api-references/events/Partner/player-photon-session-authenticated"}]},{"group":"Player","pages":[{"title":"player_action_executed","description":"player_action_executed event.","href":"/services/playfab/api-references/events/Player/player-action-executed"},{"title":"player_ad_campaign_attribution","description":"player_ad_campaign_attribution event.","href":"/services/playfab/api-references/events/Player/player-ad-campaign-attribution"},{"title":"player_consumed_item","description":"player_consumed_item event.","href":"/services/playfab/api-references/events/Player/player-consumed-item"},{"title":"player_inventory_item_added","description":"player_inventory_item_added event.","href":"/services/playfab/api-references/events/Player/player-inventory-item-added"},{"title":"player_paid_for_purchase","description":"player_paid_for_purchase event.","href":"/services/playfab/api-references/events/Player/player-paid-for-purchase"},{"title":"player_realmoney_purchase","description":"player_realmoney_purchase event.","href":"/services/playfab/api-references/events/Player/player-realmoney-purchase"},{"title":"player_receipt_validation","description":"player_receipt_validation event.","href":"/services/playfab/api-references/events/Player/player-receipt-validation"},{"title":"player_redeemed_coupon","description":"player_redeemed_coupon event.","href":"/services/playfab/api-references/events/Player/player-redeemed-coupon"},{"title":"player_set_profile_property","description":"player_set_profile_property event.","href":"/services/playfab/api-references/events/Player/player-set-profile-property"},{"title":"player_started_purchase","description":"player_started_purchase event.","href":"/services/playfab/api-references/events/Player/player-started-purchase"},{"title":"player_vc_item_purchased","description":"player_vc_item_purchased event.","href":"/services/playfab/api-references/events/Player/player-vc-item-purchased"},{"title":"player_virtual_currency_balance_changed","description":"player_virtual_currency_balance_changed event.","href":"/services/playfab/api-references/events/Player/player-virtual-currency-balance-changed"}]},{"group":"PlayerIdentity","pages":[{"title":"auth_token_validated","description":"auth_token_validated event.","href":"/services/playfab/api-references/events/PlayerIdentity/auth-token-validated"},{"title":"character_created","description":"character_created event.","href":"/services/playfab/api-references/events/PlayerIdentity/character-created"},{"title":"entity_created","description":"entity_created event.","href":"/services/playfab/api-references/events/PlayerIdentity/entity-created"},{"title":"entity_deleted","description":"entity_deleted event.","href":"/services/playfab/api-references/events/PlayerIdentity/entity-deleted"},{"title":"entity_logged_in","description":"entity_logged_in event.","href":"/services/playfab/api-references/events/PlayerIdentity/entity-logged-in"},{"title":"logged_in_to_title","description":"logged_in_to_title event.","href":"/services/playfab/api-references/events/PlayerIdentity/logged-in-to-title"},{"title":"player_added_title","description":"player_added_title event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-added-title"},{"title":"player_authenticated","description":"player_authenticated event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-authenticated"},{"title":"player_banned","description":"player_banned event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-banned"},{"title":"player_changed_avatar","description":"player_changed_avatar event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-changed-avatar"},{"title":"player_completed_password_reset","description":"player_completed_password_reset event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-completed-password-reset"},{"title":"player_created","description":"player_created event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-created"},{"title":"player_custom_properties_changed","description":"player_custom_properties_changed event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-custom-properties-changed"},{"title":"player_data_exported","description":"player_data_exported event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-data-exported"},{"title":"player_device_info","description":"player_device_info event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-device-info"},{"title":"player_displayname_changed","description":"player_displayname_changed event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-displayname-changed"},{"title":"player_identity_link_added","description":"player_identity_link_added event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-identity-link-added"},{"title":"player_identity_link_removed","description":"player_identity_link_removed event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-identity-link-removed"},{"title":"player_linked_account","description":"player_linked_account event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-linked-account"},{"title":"player_logged_in","description":"player_logged_in event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-logged-in"},{"title":"player_password_reset_link_sent","description":"player_password_reset_link_sent event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-password-reset-link-sent"},{"title":"player_removed_title","description":"player_removed_title event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-removed-title"},{"title":"player_reported_as_abusive","description":"player_reported_as_abusive event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-reported-as-abusive"},{"title":"player_tag_added","description":"player_tag_added event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-tag-added"},{"title":"player_tag_removed","description":"player_tag_removed event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-tag-removed"},{"title":"player_unlinked_account","description":"player_unlinked_account event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-unlinked-account"},{"title":"player_updated_contact_email","description":"player_updated_contact_email event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-updated-contact-email"},{"title":"player_updated_login_email","description":"player_updated_login_email event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-updated-login-email"},{"title":"player_verified_contact_email","description":"player_verified_contact_email event.","href":"/services/playfab/api-references/events/PlayerIdentity/player-verified-contact-email"},{"title":"title_deleted_master_player","description":"title_deleted_master_player event.","href":"/services/playfab/api-references/events/PlayerIdentity/title-deleted-master-player"},{"title":"title_initiated_player_password_reset","description":"title_initiated_player_password_reset event.","href":"/services/playfab/api-references/events/PlayerIdentity/title-initiated-player-password-reset"},{"title":"title_profile_view_constraints_changed","description":"title_profile_view_constraints_changed event.","href":"/services/playfab/api-references/events/PlayerIdentity/title-profile-view-constraints-changed"}]},{"group":"PlayerProfile","pages":[{"title":"access_policy_updated","description":"access_policy_updated event.","href":"/services/playfab/api-references/events/PlayerProfile/access-policy-updated"},{"title":"avatar_url_updated","description":"avatar_url_updated event.","href":"/services/playfab/api-references/events/PlayerProfile/avatar-url-updated"},{"title":"contact_email_updated","description":"contact_email_updated event.","href":"/services/playfab/api-references/events/PlayerProfile/contact-email-updated"},{"title":"entity_files_set","description":"entity_files_set event.","href":"/services/playfab/api-references/events/PlayerProfile/entity-files-set"},{"title":"entity_language_updated","description":"entity_language_updated event.","href":"/services/playfab/api-references/events/PlayerProfile/entity-language-updated"},{"title":"entity_objects_set","description":"entity_objects_set event.","href":"/services/playfab/api-references/events/PlayerProfile/entity-objects-set"},{"title":"files_changed","description":"files_changed event.","href":"/services/playfab/api-references/events/PlayerProfile/files-changed"},{"title":"language_updated","description":"language_updated event.","href":"/services/playfab/api-references/events/PlayerProfile/language-updated"},{"title":"objects_updated","description":"objects_updated event.","href":"/services/playfab/api-references/events/PlayerProfile/objects-updated"}]},{"group":"PlayStream","pages":[{"title":"action_executed","description":"action_executed event.","href":"/services/playfab/api-references/events/PlayStream/action-executed"},{"title":"action_failed","description":"action_failed event.","href":"/services/playfab/api-references/events/PlayStream/action-failed"}]},{"group":"Segmentation","pages":[{"title":"api_operation","description":"api_operation event.","href":"/services/playfab/api-references/events/Segmentation/api-operation"},{"title":"segment_entered","description":"segment_entered event.","href":"/services/playfab/api-references/events/Segmentation/segment-entered"},{"title":"segment_exited","description":"segment_exited event.","href":"/services/playfab/api-references/events/Segmentation/segment-exited"}]},{"group":"Session","pages":[{"title":"client_focus_change","description":"client_focus_change event.","href":"/services/playfab/api-references/events/Session/client-focus-change"},{"title":"client_session_start","description":"client_session_start event.","href":"/services/playfab/api-references/events/Session/client-session-start"}]},{"group":"Statistics","pages":[{"title":"statistic_updated","description":"statistic_updated event","href":"/services/playfab/api-references/events/Statistics/statistic-updated"}]},{"group":"TargetedConfiguration","pages":[{"title":"player_churn_prediction_changed","description":"player_churn_prediction_changed event.","href":"/services/playfab/api-references/events/TargetedConfiguration/player-churn-prediction-changed"}]},{"group":"Telemetry","pages":[{"title":"apikey_activated","description":"apikey_activated event.","href":"/services/playfab/api-references/events/Telemetry/apikey-activated"},{"title":"apikey_created","description":"apikey_created event.","href":"/services/playfab/api-references/events/Telemetry/apikey-created"},{"title":"apikey_deactivated","description":"apikey_deactivated event.","href":"/services/playfab/api-references/events/Telemetry/apikey-deactivated"},{"title":"apikey_deleted","description":"apikey_deleted event.","href":"/services/playfab/api-references/events/Telemetry/apikey-deleted"}]},{"group":"Title","pages":[{"title":"api_rate_limit_alert","description":"Preview PlayFab event raised when an API caller approaches or reaches a rate limit, with properties for the API, caller entity, and limit crossings.","href":"/services/playfab/api-references/events/Title/api-rate-limit-alert"},{"title":"title_client_rate_limited_alert","description":"title_client_rate_limited_alert event.","href":"/services/playfab/api-references/events/Title/title-client-rate-limited-alert"},{"title":"title_high_error_rate_alert","description":"title_high_error_rate_alert event.","href":"/services/playfab/api-references/events/Title/title-high-error-rate-alert"},{"title":"title_requested_limit_change","description":"title_requested_limit_change event.","href":"/services/playfab/api-references/events/Title/title-requested-limit-change"},{"title":"title_saved_survey","description":"title_saved_survey event.","href":"/services/playfab/api-references/events/Title/title-saved-survey"}]},{"group":"TitleCommunications","pages":[{"title":"email_sent","description":"email_sent event.","href":"/services/playfab/api-references/events/TitleCommunications/email-sent"},{"title":"player_registered_push_notifications","description":"player_registered_push_notifications event.","href":"/services/playfab/api-references/events/TitleCommunications/player-registered-push-notifications"},{"title":"push_notification_sent","description":"push_notification_sent event.","href":"/services/playfab/api-references/events/TitleCommunications/push-notification-sent"},{"title":"sent_email","description":"sent_email event.","href":"/services/playfab/api-references/events/TitleCommunications/sent-email"},{"title":"sent_push_notification","description":"sent_push_notification event.","href":"/services/playfab/api-references/events/TitleCommunications/sent-push-notification"}]},{"group":"TitleData","pages":[{"title":"title_activated","description":"title_activated event.","href":"/services/playfab/api-references/events/TitleData/title-activated"},{"title":"title_data_override_deleted","description":"title_data_override_deleted event.","href":"/services/playfab/api-references/events/TitleData/title-data-override-deleted"},{"title":"title_data_updated","description":"title_data_updated event.","href":"/services/playfab/api-references/events/TitleData/title-data-updated"},{"title":"title_deactivated","description":"title_deactivated event.","href":"/services/playfab/api-references/events/TitleData/title-deactivated"},{"title":"title_news_updated","description":"title_news_updated event.","href":"/services/playfab/api-references/events/TitleData/title-news-updated"},{"title":"title_secret_key_changed","description":"title_secret_key_changed event.","href":"/services/playfab/api-references/events/TitleData/title-secret-key-changed"}]}]}]},{"group":"PlayFab REST API References","icon":"code","pages":[{"title":"PlayFab REST APIs","description":"Browse the PlayFab REST APIs that let your title call PlayFab services over HTTPS, with operations, schemas, error codes, and a try-it playground.","href":"/services/playfab/api-references/rest/overview"},{"group":"Addon","pages":[{"title":"PlayFab Addon API","description":"Overview of the PlayFab Addon REST API for managing addons, including the API version and the Addon operation group that lists every available operation.","href":"/services/playfab/api-references/rest/addons/overview"},{"group":"Addon","pages":[{"title":"Configure PSN Event Streams","openapi":"post /Addon/ConfigurePSNEventStreams","description":"Configures PSN event streams for an existing PSN addon on a title, without requiring a full addon upsert.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| CatalogFeatureDisabled | 4009 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/configure-psn-event-streams"},{"title":"Create Or Update Apple","openapi":"post /Addon/CreateOrUpdateApple","description":"Creates the Apple addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-apple"},{"title":"Create Or Update Facebook","openapi":"post /Addon/CreateOrUpdateFacebook","description":"Creates the Facebook addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-facebook"},{"title":"Create Or Update Facebook Instant Games","openapi":"post /Addon/CreateOrUpdateFacebookInstantGames","description":"Creates the Facebook Instant Games addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-facebook-instant-games"},{"title":"Create Or Update Google","openapi":"post /Addon/CreateOrUpdateGoogle","description":"Creates the Google addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-google"},{"title":"Create Or Update Kongregate","openapi":"post /Addon/CreateOrUpdateKongregate","description":"Creates the Kongregate addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-kongregate"},{"title":"Create Or Update Nintendo","openapi":"post /Addon/CreateOrUpdateNintendo","description":"Creates the Nintendo addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-nintendo"},{"title":"Create Or Update PSN","openapi":"post /Addon/CreateOrUpdatePSN","description":"Creates the PSN addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-psn"},{"title":"Create Or Update Steam","openapi":"post /Addon/CreateOrUpdateSteam","description":"Creates the Steam addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-steam"},{"title":"Create Or Update Tox Mod","openapi":"post /Addon/CreateOrUpdateToxMod","description":"Creates the ToxMod addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-tox-mod"},{"title":"Create Or Update Twitch","openapi":"post /Addon/CreateOrUpdateTwitch","description":"Creates the Twitch addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/create-or-update-twitch"},{"title":"Delete Apple","openapi":"post /Addon/DeleteApple","description":"Deletes the Apple addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-apple"},{"title":"Delete Facebook","openapi":"post /Addon/DeleteFacebook","description":"Deletes the Facebook addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-facebook"},{"title":"Delete Facebook Instant Games","openapi":"post /Addon/DeleteFacebookInstantGames","description":"Deletes the Facebook addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-facebook-instant-games"},{"title":"Delete Google","openapi":"post /Addon/DeleteGoogle","description":"Deletes the Google addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-google"},{"title":"Delete Kongregate","openapi":"post /Addon/DeleteKongregate","description":"Deletes the Kongregate addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-kongregate"},{"title":"Delete Nintendo","openapi":"post /Addon/DeleteNintendo","description":"Deletes the Nintendo addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-nintendo"},{"title":"Delete PSN","openapi":"post /Addon/DeletePSN","description":"Deletes the PSN addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-psn"},{"title":"Delete Steam","openapi":"post /Addon/DeleteSteam","description":"Deletes the Steam addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-steam"},{"title":"Delete Tox Mod","openapi":"post /Addon/DeleteToxMod","description":"Deletes the ToxMod addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-tox-mod"},{"title":"Delete Twitch","openapi":"post /Addon/DeleteTwitch","description":"Deletes the Twitch addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/delete-twitch"},{"title":"Get Apple","openapi":"post /Addon/GetApple","description":"Gets information of the Apple addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-apple"},{"title":"Get Facebook","openapi":"post /Addon/GetFacebook","description":"Gets information of the Facebook addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-facebook"},{"title":"Get Facebook Instant Games","openapi":"post /Addon/GetFacebookInstantGames","description":"Gets information of the Facebook Instant Games addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-facebook-instant-games"},{"title":"Get Google","openapi":"post /Addon/GetGoogle","description":"Gets information of the Google addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-google"},{"title":"Get Kongregate","openapi":"post /Addon/GetKongregate","description":"Gets information of the Kongregate addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-kongregate"},{"title":"Get Nintendo","openapi":"post /Addon/GetNintendo","description":"Gets information of the Nintendo addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-nintendo"},{"title":"Get PSN","openapi":"post /Addon/GetPSN","description":"Gets information of the PSN addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-psn"},{"title":"Get Steam","openapi":"post /Addon/GetSteam","description":"Gets information of the Steam addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-steam"},{"title":"Get Tox Mod","openapi":"post /Addon/GetToxMod","description":"Gets information of the ToxMod addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-tox-mod"},{"title":"Get Twitch","openapi":"post /Addon/GetTwitch","description":"Gets information of the Twitch addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","href":"/services/playfab/api-references/rest/addons/addon/get-twitch"}]},{"group":"Addon","pages":[{"title":"Configure PSN Event Streams","description":"Configures PSN event streams for an existing PSN addon on a title, without requiring a full addon upsert.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| CatalogFeatureDisabled | 4009 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/ConfigurePSNEventStreams","href":"/api-reference/addon/configure-psn-event-streams","autogeneratedByOpenApi":true},{"title":"Create Or Update Apple","description":"Creates the Apple addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdateApple","href":"/api-reference/addon/create-or-update-apple","autogeneratedByOpenApi":true},{"title":"Create Or Update Facebook","description":"Creates the Facebook addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdateFacebook","href":"/api-reference/addon/create-or-update-facebook","autogeneratedByOpenApi":true},{"title":"Create Or Update Facebook Instant Games","description":"Creates the Facebook Instant Games addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdateFacebookInstantGames","href":"/api-reference/addon/create-or-update-facebook-instant-games","autogeneratedByOpenApi":true},{"title":"Create Or Update Google","description":"Creates the Google addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdateGoogle","href":"/api-reference/addon/create-or-update-google","autogeneratedByOpenApi":true},{"title":"Create Or Update Kongregate","description":"Creates the Kongregate addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdateKongregate","href":"/api-reference/addon/create-or-update-kongregate","autogeneratedByOpenApi":true},{"title":"Create Or Update Nintendo","description":"Creates the Nintendo addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdateNintendo","href":"/api-reference/addon/create-or-update-nintendo","autogeneratedByOpenApi":true},{"title":"Create Or Update PSN","description":"Creates the PSN addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdatePSN","href":"/api-reference/addon/create-or-update-psn","autogeneratedByOpenApi":true},{"title":"Create Or Update Steam","description":"Creates the Steam addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdateSteam","href":"/api-reference/addon/create-or-update-steam","autogeneratedByOpenApi":true},{"title":"Create Or Update Tox Mod","description":"Creates the ToxMod addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdateToxMod","href":"/api-reference/addon/create-or-update-tox-mod","autogeneratedByOpenApi":true},{"title":"Create Or Update Twitch","description":"Creates the Twitch addon on a title, or updates it if it already exists.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonAlreadyExists | 19008 |\n| BillingInformationRequired | 1266 |\n| CatalogBadRequest | 4013 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/CreateOrUpdateTwitch","href":"/api-reference/addon/create-or-update-twitch","autogeneratedByOpenApi":true},{"title":"Delete Apple","description":"Deletes the Apple addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeleteApple","href":"/api-reference/addon/delete-apple","autogeneratedByOpenApi":true},{"title":"Delete Facebook","description":"Deletes the Facebook addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeleteFacebook","href":"/api-reference/addon/delete-facebook","autogeneratedByOpenApi":true},{"title":"Delete Facebook Instant Games","description":"Deletes the Facebook addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeleteFacebookInstantGames","href":"/api-reference/addon/delete-facebook-instant-games","autogeneratedByOpenApi":true},{"title":"Delete Google","description":"Deletes the Google addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeleteGoogle","href":"/api-reference/addon/delete-google","autogeneratedByOpenApi":true},{"title":"Delete Kongregate","description":"Deletes the Kongregate addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeleteKongregate","href":"/api-reference/addon/delete-kongregate","autogeneratedByOpenApi":true},{"title":"Delete Nintendo","description":"Deletes the Nintendo addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeleteNintendo","href":"/api-reference/addon/delete-nintendo","autogeneratedByOpenApi":true},{"title":"Delete PSN","description":"Deletes the PSN addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeletePSN","href":"/api-reference/addon/delete-psn","autogeneratedByOpenApi":true},{"title":"Delete Steam","description":"Deletes the Steam addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeleteSteam","href":"/api-reference/addon/delete-steam","autogeneratedByOpenApi":true},{"title":"Delete Tox Mod","description":"Deletes the ToxMod addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeleteToxMod","href":"/api-reference/addon/delete-tox-mod","autogeneratedByOpenApi":true},{"title":"Delete Twitch","description":"Deletes the Twitch addon on a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AddonDoesntExist | 19009 |\n| CatalogBadRequest | 4013 |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/DeleteTwitch","href":"/api-reference/addon/delete-twitch","autogeneratedByOpenApi":true},{"title":"Get Apple","description":"Gets information of the Apple addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetApple","href":"/api-reference/addon/get-apple","autogeneratedByOpenApi":true},{"title":"Get Facebook","description":"Gets information of the Facebook addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetFacebook","href":"/api-reference/addon/get-facebook","autogeneratedByOpenApi":true},{"title":"Get Facebook Instant Games","description":"Gets information of the Facebook Instant Games addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetFacebookInstantGames","href":"/api-reference/addon/get-facebook-instant-games","autogeneratedByOpenApi":true},{"title":"Get Google","description":"Gets information of the Google addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetGoogle","href":"/api-reference/addon/get-google","autogeneratedByOpenApi":true},{"title":"Get Kongregate","description":"Gets information of the Kongregate addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetKongregate","href":"/api-reference/addon/get-kongregate","autogeneratedByOpenApi":true},{"title":"Get Nintendo","description":"Gets information of the Nintendo addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetNintendo","href":"/api-reference/addon/get-nintendo","autogeneratedByOpenApi":true},{"title":"Get PSN","description":"Gets information of the PSN addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetPSN","href":"/api-reference/addon/get-psn","autogeneratedByOpenApi":true},{"title":"Get Steam","description":"Gets information of the Steam addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetSteam","href":"/api-reference/addon/get-steam","autogeneratedByOpenApi":true},{"title":"Get Tox Mod","description":"Gets information of the ToxMod addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetToxMod","href":"/api-reference/addon/get-tox-mod","autogeneratedByOpenApi":true},{"title":"Get Twitch","description":"Gets information of the Twitch addon on a title, omits secrets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| InvalidParams | 1000 |\n| InvalidTitleId | 1004 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/addons/addons.openapi.json post /Addon/GetTwitch","href":"/api-reference/addon/get-twitch","autogeneratedByOpenApi":true}]}]},{"group":"Admin","pages":[{"title":"PlayFab Admin API","description":"Overview of the PlayFab Admin REST API for managing title configurations, game server code, and user data, with its API version and operation groups.","href":"/services/playfab/api-references/rest/admin/overview"},{"group":"Account Management","pages":[{"title":"Ban Users","openapi":"post /Admin/BanUsers","description":"Bans users by PlayFab ID with optional IP address for the provided game.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/admin/account-management/ban-users"},{"title":"Create IP Ban","openapi":"post /Admin/CreateIPBan","description":"Bans an IP address or CIDR range for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ConcurrentEditError | 1133 |\n| InvalidParams | 1000 |\n| OverLimit | 1214 |\n| ValueAlreadyExists | 1031 |\n","href":"/services/playfab/api-references/rest/admin/account-management/create-ip-ban"},{"title":"Delete Master Player Account","openapi":"post /Admin/DeleteMasterPlayerAccount","description":"Removes a master player account entirely from all titles and deletes all associated data","href":"/services/playfab/api-references/rest/admin/account-management/delete-master-player-account"},{"title":"Delete Master Player Event Data","openapi":"post /Admin/DeleteMasterPlayerEventData","description":"Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage","href":"/services/playfab/api-references/rest/admin/account-management/delete-master-player-event-data"},{"title":"Delete Membership Subscription","openapi":"post /Admin/DeleteMembershipSubscription","description":"Deletes a player's subscription\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MembershipNotFound | 1331 |\n","href":"/services/playfab/api-references/rest/admin/account-management/delete-membership-subscription"},{"title":"Delete Player","openapi":"post /Admin/DeletePlayer","description":"Removes a user's player account from a title and deletes all associated data","href":"/services/playfab/api-references/rest/admin/account-management/delete-player"},{"title":"Delete Title","openapi":"post /Admin/DeleteTitle","description":"Permanently deletes a title and all associated configuration\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleContainsUserAccounts | 1348 |\n","href":"/services/playfab/api-references/rest/admin/account-management/delete-title"},{"title":"Export Master Player Data","openapi":"post /Admin/ExportMasterPlayerData","description":"Exports all associated data of a master player account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailAddressNotAvailable | 1006 |\n","href":"/services/playfab/api-references/rest/admin/account-management/export-master-player-data"},{"title":"Get IP Bans For IP","openapi":"post /Admin/GetIPBansForIP","description":"Gets all IP bans that apply to a specific IP address.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidParams | 1000 |\n","href":"/services/playfab/api-references/rest/admin/account-management/get-ip-bans-for-ip"},{"title":"Get IP Bans For Title","openapi":"post /Admin/GetIPBansForTitle","description":"Gets all IP bans for a title.","href":"/services/playfab/api-references/rest/admin/account-management/get-ip-bans-for-title"},{"title":"Get Played Title List","openapi":"post /Admin/GetPlayedTitleList","description":"Get the list of titles that the player has played","href":"/services/playfab/api-references/rest/admin/account-management/get-played-title-list"},{"title":"Get Player Id From Auth Token","openapi":"post /Admin/GetPlayerIdFromAuthToken","description":"Gets a player's ID from an auth token.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AuthTokenDoesNotExist | 1327 |\n","href":"/services/playfab/api-references/rest/admin/account-management/get-player-id-from-auth-token"},{"title":"Get Player Profile","openapi":"post /Admin/GetPlayerProfile","description":"Retrieves the player's profile\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerNotInGame | 1033 |\n","href":"/services/playfab/api-references/rest/admin/account-management/get-player-profile"},{"title":"Get User Account Info","openapi":"post /Admin/GetUserAccountInfo","description":"Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleNotActivated | 1042 |\n","href":"/services/playfab/api-references/rest/admin/account-management/get-user-account-info"},{"title":"Get User Bans","openapi":"post /Admin/GetUserBans","description":"Gets all bans for a user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/admin/account-management/get-user-bans"},{"title":"Reset Password","openapi":"post /Admin/ResetPassword","description":"Reset a player's password for a given title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AuthTokenAlreadyUsedToResetPassword | 1329 |\n| AuthTokenDoesNotExist | 1327 |\n| AuthTokenExpired | 1328 |\n| InvalidAuthToken | 1326 |\n| NoContactEmailAddressFound | 1325 |\n","href":"/services/playfab/api-references/rest/admin/account-management/reset-password"},{"title":"Revoke All Bans For User","openapi":"post /Admin/RevokeAllBansForUser","description":"Revoke all active bans for a user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/admin/account-management/revoke-all-bans-for-user"},{"title":"Revoke Bans","openapi":"post /Admin/RevokeBans","description":"Revoke all active bans specified with BanId.","href":"/services/playfab/api-references/rest/admin/account-management/revoke-bans"},{"title":"Revoke IP Ban","openapi":"post /Admin/RevokeIPBan","description":"Revokes an active IP ban.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidParams | 1000 |\n| IPAddressNotFound | 1616 |\n","href":"/services/playfab/api-references/rest/admin/account-management/revoke-ip-ban"},{"title":"Send Account Recovery Email","openapi":"post /Admin/SendAccountRecoveryEmail","description":"Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailRecipientBlacklisted | 1427 |\n| InvalidEmailAddress | 1005 |\n| NoContactEmailAddressFound | 1325 |\n| SmtpAddonNotEnabled | 1341 |\n","href":"/services/playfab/api-references/rest/admin/account-management/send-account-recovery-email"},{"title":"Set Membership Override","openapi":"post /Admin/SetMembershipOverride","description":"Sets the override expiration for a membership subscription\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MembershipNotFound | 1331 |\n","href":"/services/playfab/api-references/rest/admin/account-management/set-membership-override"},{"title":"Update Bans","openapi":"post /Admin/UpdateBans","description":"Updates information of a list of existing bans specified with Ban Ids.","href":"/services/playfab/api-references/rest/admin/account-management/update-bans"},{"title":"Update IP Ban","openapi":"post /Admin/UpdateIPBan","description":"Updates an existing IP ban.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidParams | 1000 |\n| IPAddressNotFound | 1616 |\n","href":"/services/playfab/api-references/rest/admin/account-management/update-ip-ban"},{"title":"Update User Title Display Name","openapi":"post /Admin/UpdateUserTitleDisplayName","description":"Updates the title specific display name for a user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InsufficientFunds | 1059 |\n| NameNotAvailable | 1058 |\n","href":"/services/playfab/api-references/rest/admin/account-management/update-user-title-display-name"}]},{"group":"Authentication","pages":[{"title":"Create OpenId Connection","openapi":"post /Admin/CreateOpenIdConnection","description":"Registers a relationship between a title and an Open ID Connect provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ValueAlreadyExists | 1031 |\n","href":"/services/playfab/api-references/rest/admin/authentication/create-openid-connection"},{"title":"Create Player Shared Secret","openapi":"post /Admin/CreatePlayerSharedSecret","description":"Creates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after this API returns.","href":"/services/playfab/api-references/rest/admin/authentication/create-player-shared-secret"},{"title":"Delete OpenId Connection","openapi":"post /Admin/DeleteOpenIdConnection","description":"Removes a relationship between a title and an OpenID Connect provider.","href":"/services/playfab/api-references/rest/admin/authentication/delete-openid-connection"},{"title":"Delete Player Shared Secret","openapi":"post /Admin/DeletePlayerSharedSecret","description":"Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API returns.","href":"/services/playfab/api-references/rest/admin/authentication/delete-player-shared-secret"},{"title":"Get Player Shared Secrets","openapi":"post /Admin/GetPlayerSharedSecrets","description":"Returns all Player Shared Secret Keys including disabled and expired.","href":"/services/playfab/api-references/rest/admin/authentication/get-player-shared-secrets"},{"title":"Get Policy","openapi":"post /Admin/GetPolicy","description":"Gets the requested policy.","href":"/services/playfab/api-references/rest/admin/authentication/get-policy"},{"title":"List OpenId Connection","openapi":"post /Admin/ListOpenIdConnection","description":"Retrieves a list of all Open ID Connect providers registered to a title.","href":"/services/playfab/api-references/rest/admin/authentication/list-openid-connection"},{"title":"Set Player Secret","openapi":"post /Admin/SetPlayerSecret","description":"Sets or resets the player's secret. Player secrets are used to sign API requests.","href":"/services/playfab/api-references/rest/admin/authentication/set-player-secret"},{"title":"Update OpenId Connection","openapi":"post /Admin/UpdateOpenIdConnection","description":"Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider","href":"/services/playfab/api-references/rest/admin/authentication/update-openid-connection"},{"title":"Update Player Shared Secret","openapi":"post /Admin/UpdatePlayerSharedSecret","description":"Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available after this API returns.","href":"/services/playfab/api-references/rest/admin/authentication/update-player-shared-secret"},{"title":"Update Policy","openapi":"post /Admin/UpdatePolicy","description":"Changes a policy for a title","href":"/services/playfab/api-references/rest/admin/authentication/update-policy"},{"title":"Validate Api Policy","openapi":"post /Admin/ValidateApiPolicy","description":"Validates the result of a policy update without persisting it.","href":"/services/playfab/api-references/rest/admin/authentication/validate-api-policy"}]},{"group":"Characters","pages":[{"title":"Reset Character Statistics","openapi":"post /Admin/ResetCharacterStatistics","description":"Completely removes all statistics for the specified character, for the current game\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/characters/reset-character-statistics"}]},{"group":"Content","pages":[{"title":"Delete Content","openapi":"post /Admin/DeleteContent","description":"Delete a content file from the title. When deleting a file that does not exist, it returns success.","href":"/services/playfab/api-references/rest/admin/content/delete-content"},{"title":"Get Content List","openapi":"post /Admin/GetContentList","description":"List all contents of the title and get statistics such as size\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ContentS3OriginBucketNotConfigured | 1299 |\n","href":"/services/playfab/api-references/rest/admin/content/get-content-list"},{"title":"Get Content Upload Url","openapi":"post /Admin/GetContentUploadUrl","description":"Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| ContentQuotaExceeded | 1137 |\n| NotAuthorized | 1089 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/content/get-content-upload-url"}]},{"group":"Player Data Management","pages":[{"title":"Create Player Statistic Definition","openapi":"post /Admin/CreatePlayerStatisticDefinition","description":"Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticCountLimitExceeded | 1203 |\n| StatisticNameConflict | 1196 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/create-player-statistic-definition"},{"title":"Delete Player Custom Properties","openapi":"post /Admin/DeletePlayerCustomProperties","description":"Deletes title-specific custom properties for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/delete-player-custom-properties"},{"title":"Get Data Report","openapi":"post /Admin/GetDataReport","description":"Retrieves a download URL for the requested report\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataNotAvailable | 1604 |\n| InvalidParams | 1000 |\n| InvalidReportDate | 1111 |\n| InvalidReportName | 1605 |\n| ProductDisabledForTitle | 1609 |\n| ReportDataNotRetrievedSuccessfully | 1597 |\n| ReportNotProcessed | 1603 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/get-data-report"},{"title":"Get Player Custom Property","openapi":"post /Admin/GetPlayerCustomProperty","description":"Retrieves a title-specific custom property value for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesPropertyDoesNotExist | 19007 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/get-player-custom-property"},{"title":"Get Player Statistic Definitions","openapi":"post /Admin/GetPlayerStatisticDefinitions","description":"Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/get-player-statistic-definitions"},{"title":"Get Player Statistic Versions","openapi":"post /Admin/GetPlayerStatisticVersions","description":"Retrieves the information on the available versions of the specified statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/get-player-statistic-versions"},{"title":"Get User Data","openapi":"post /Admin/GetUserData","description":"Retrieves the title-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/rest/admin/player-data-management/get-user-data"},{"title":"Get User Internal Data","openapi":"post /Admin/GetUserInternalData","description":"Retrieves the title-specific custom data for the user which cannot be accessed by the client","href":"/services/playfab/api-references/rest/admin/player-data-management/get-user-internal-data"},{"title":"Get User Publisher Data","openapi":"post /Admin/GetUserPublisherData","description":"Retrieves the publisher-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/rest/admin/player-data-management/get-user-publisher-data"},{"title":"Get User Publisher Internal Data","openapi":"post /Admin/GetUserPublisherInternalData","description":"Retrieves the publisher-specific custom data for the user which cannot be accessed by the client","href":"/services/playfab/api-references/rest/admin/player-data-management/get-user-publisher-internal-data"},{"title":"Get User Publisher Read Only Data","openapi":"post /Admin/GetUserPublisherReadOnlyData","description":"Retrieves the publisher-specific custom data for the user which can only be read by the client","href":"/services/playfab/api-references/rest/admin/player-data-management/get-user-publisher-read-only-data"},{"title":"Get User Read Only Data","openapi":"post /Admin/GetUserReadOnlyData","description":"Retrieves the title-specific custom data for the user which can only be read by the client","href":"/services/playfab/api-references/rest/admin/player-data-management/get-user-read-only-data"},{"title":"Increment Player Statistic Version","openapi":"post /Admin/IncrementPlayerStatisticVersion","description":"Resets the indicated statistic, removing all player entries for it and backing up the old values.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateInProgress | 1276 |\n| StatisticVersionIncrementRateExceeded | 1204 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/increment-player-statistic-version"},{"title":"List Player Custom Properties","openapi":"post /Admin/ListPlayerCustomProperties","description":"Retrieves title-specific custom property values for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/list-player-custom-properties"},{"title":"Refund Purchase","openapi":"post /Admin/RefundPurchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Attempts to process an order refund through the original real money payment provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/refund-purchase"},{"title":"Reset User Statistics","openapi":"post /Admin/ResetUserStatistics","description":"Completely removes all statistics for the specified user, for the current game\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/reset-user-statistics"},{"title":"Resolve Purchase Dispute","openapi":"post /Admin/ResolvePurchaseDispute","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Attempts to resolve a dispute with the original order's payment provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/resolve-purchase-dispute"},{"title":"Update Player Custom Properties","openapi":"post /Admin/UpdatePlayerCustomProperties","description":"Updates the title-specific custom property values for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesDuplicatePropertyName | 19006 |\n| PlayerCustomPropertiesPropertyCountTooHigh | 19005 |\n| PlayerCustomPropertiesPropertyNameIsInvalid | 19001 |\n| PlayerCustomPropertiesPropertyNameTooLong | 19000 |\n| PlayerCustomPropertiesStringPropertyValueTooLong | 19002 |\n| PlayerCustomPropertiesValueIsInvalidType | 19003 |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/update-player-custom-properties"},{"title":"Update Player Statistic Definition","openapi":"post /Admin/UpdatePlayerStatisticDefinition","description":"Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateInProgress | 1276 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/update-player-statistic-definition"},{"title":"Update User Data","openapi":"post /Admin/UpdateUserData","description":"Updates the title-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/rest/admin/player-data-management/update-user-data"},{"title":"Update User Internal Data","openapi":"post /Admin/UpdateUserInternalData","description":"Updates the title-specific custom data for the user which cannot be accessed by the client","href":"/services/playfab/api-references/rest/admin/player-data-management/update-user-internal-data"},{"title":"Update User Publisher Data","openapi":"post /Admin/UpdateUserPublisherData","description":"Updates the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/update-user-publisher-data"},{"title":"Update User Publisher Internal Data","openapi":"post /Admin/UpdateUserPublisherInternalData","description":"Updates the publisher-specific custom data for the user which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/update-user-publisher-internal-data"},{"title":"Update User Publisher Read Only Data","openapi":"post /Admin/UpdateUserPublisherReadOnlyData","description":"Updates the publisher-specific custom data for the user which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/admin/player-data-management/update-user-publisher-read-only-data"},{"title":"Update User Read Only Data","openapi":"post /Admin/UpdateUserReadOnlyData","description":"Updates the title-specific custom data for the user which can only be read by the client","href":"/services/playfab/api-references/rest/admin/player-data-management/update-user-read-only-data"}]},{"group":"Player Item Management","pages":[{"title":"Add User Virtual Currency","openapi":"post /Admin/AddUserVirtualCurrency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the specified virtual currency by the stated amount\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","href":"/services/playfab/api-references/rest/admin/player-item-management/add-user-virtual-currency"},{"title":"Check Limited Edition Item Availability","openapi":"post /Admin/CheckLimitedEditionItemAvailability","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Checks the global count for the limited edition item.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-item-management/check-limited-edition-item-availability"},{"title":"Get User Inventory","openapi":"post /Admin/GetUserInventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified user's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-item-management/get-user-inventory"},{"title":"Grant Items To Users","openapi":"post /Admin/GrantItemsToUsers","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified user inventories\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-item-management/grant-items-to-users"},{"title":"Increment Limited Edition Item Availability","openapi":"post /Admin/IncrementLimitedEditionItemAvailability","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increases the global count for the given scarce resource.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| RequestAlreadyRunning | 1249 |\n","href":"/services/playfab/api-references/rest/admin/player-item-management/increment-limited-edition-item-availability"},{"title":"Revoke Inventory Item","openapi":"post /Admin/RevokeInventoryItem","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access to an item in a user's inventory\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-item-management/revoke-inventory-item"},{"title":"Revoke Inventory Items","openapi":"post /Admin/RevokeInventoryItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access for up to 25 items across multiple users and characters.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/player-item-management/revoke-inventory-items"},{"title":"Subtract User Virtual Currency","openapi":"post /Admin/SubtractUserVirtualCurrency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the specified virtual currency by the stated amount\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","href":"/services/playfab/api-references/rest/admin/player-item-management/subtract-user-virtual-currency"}]},{"group":"Play Stream","pages":[{"title":"Add Player Tag","openapi":"post /Admin/AddPlayerTag","description":"Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerTagCountLimitExceeded | 1248 |\n","href":"/services/playfab/api-references/rest/admin/play-stream/add-player-tag"},{"title":"Export Players In Segment","openapi":"post /Admin/ExportPlayersInSegment","description":"Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which match the segment definition at the time of the API call. Profiles which change while an export is in progress will not be reflected in the results.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AsyncExportNotInFlight | 10011 |\n| AsyncExportRateLimitExceeded | 10013 |\n| ExportUnknownError | 5013 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","href":"/services/playfab/api-references/rest/admin/play-stream/export-players-in-segment"},{"title":"Get All Segments","openapi":"post /Admin/GetAllSegments","description":"Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/play-stream/get-all-segments"},{"title":"Get Player Segments","openapi":"post /Admin/GetPlayerSegments","description":"List all segments that a player currently belongs to at this moment in time.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","href":"/services/playfab/api-references/rest/admin/play-stream/get-player-segments"},{"title":"Get Player Tags","openapi":"post /Admin/GetPlayerTags","description":"Get all tags with a given Namespace (optional) from a player profile.","href":"/services/playfab/api-references/rest/admin/play-stream/get-player-tags"},{"title":"Get Segment Export","openapi":"post /Admin/GetSegmentExport","description":"Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of the export\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AsyncExportNotInFlight | 10011 |\n| AsyncExportRateLimitExceeded | 10013 |\n| ExportNotFound | 5004 |\n| ExportUnknownError | 5013 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/play-stream/get-segment-export"},{"title":"Get Segment Player Count","openapi":"post /Admin/GetSegmentPlayerCount","description":"Returns the total number of players in a given segment.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GetSegmentPlayerCountNotInFlight | 10016 |\n| GetSegmentPlayerCountRateLimitExceeded | 10017 |\n| InternalServerError | 1110 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","href":"/services/playfab/api-references/rest/admin/play-stream/get-segment-player-count"},{"title":"Remove Player Tag","openapi":"post /Admin/RemovePlayerTag","description":"Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.","href":"/services/playfab/api-references/rest/admin/play-stream/remove-player-tag"}]},{"group":"Scheduled Task","pages":[{"title":"Abort Task Instance","openapi":"post /Admin/AbortTaskInstance","description":"Abort an ongoing task instance.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TaskInstanceNotFound | 1262 |\n","href":"/services/playfab/api-references/rest/admin/scheduled-task/abort-task-instance"},{"title":"Create Actions On Players In Segment Task","openapi":"post /Admin/CreateActionsOnPlayersInSegmentTask","description":"Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogBadRequest | 4013 |\n| CloudScriptAzureFunctionsArgumentSizeExceeded | 1471 |\n| InvalidJSONContent | 1200 |\n| InvalidParams | 1000 |\n| InvalidScheduledTaskName | 1256 |\n| InvalidTaskSchedule | 1257 |\n| InvalidVirtualCurrencyCode | 1236 |\n| OverLimit | 1214 |\n| PushNotEnabledForAccount | 1094 |\n| PushNotificationTemplateInvalidSyntax | 1419 |\n| PushNotificationTemplateNotFound | 1417 |\n| ScheduledTaskCreateConflict | 1255 |\n| ScheduledTaskNameConflict | 1254 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/admin/scheduled-task/create-actions-on-players-in-segment-task"},{"title":"Create Cloud Script Task","openapi":"post /Admin/CreateCloudScriptTask","description":"Create a CloudScript task, which can run a CloudScript on a schedule.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidScheduledTaskName | 1256 |\n| InvalidTaskSchedule | 1257 |\n| ProductDisabledForTitle | 1609 |\n| ScheduledTaskCreateConflict | 1255 |\n| ScheduledTaskNameConflict | 1254 |\n","href":"/services/playfab/api-references/rest/admin/scheduled-task/create-cloud-script-task"},{"title":"Create Insights Scheduled Scaling Task","openapi":"post /Admin/CreateInsightsScheduledScalingTask","description":"Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidScheduledTaskName | 1256 |\n| InvalidTaskSchedule | 1257 |\n| ProductDisabledForTitle | 1609 |\n| ScheduledTaskCreateConflict | 1255 |\n| ScheduledTaskNameConflict | 1254 |\n| TitleNotOnUpdatedPricingPlan | 9000 |\n","href":"/services/playfab/api-references/rest/admin/scheduled-task/create-insights-scheduled-scaling-task"},{"title":"Delete Task","openapi":"post /Admin/DeleteTask","description":"Delete a task.","href":"/services/playfab/api-references/rest/admin/scheduled-task/delete-task"},{"title":"Get Actions On Players In Segment Task Instance","openapi":"post /Admin/GetActionsOnPlayersInSegmentTaskInstance","description":"Get information about a ActionsOnPlayersInSegment task instance.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TaskInstanceNotFound | 1262 |\n","href":"/services/playfab/api-references/rest/admin/scheduled-task/get-actions-on-players-in-segment-task-instance"},{"title":"Get Cloud Script Task Instance","openapi":"post /Admin/GetCloudScriptTaskInstance","description":"Get detail information about a CloudScript task instance.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TaskInstanceNotFound | 1262 |\n","href":"/services/playfab/api-references/rest/admin/scheduled-task/get-cloud-script-task-instance"},{"title":"Get Task Instances","openapi":"post /Admin/GetTaskInstances","description":"Query for task instances by task, status, or time range.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TaskNotFound | 1261 |\n","href":"/services/playfab/api-references/rest/admin/scheduled-task/get-task-instances"},{"title":"Get Tasks","openapi":"post /Admin/GetTasks","description":"Get definition information on a specified task or all tasks within a title.","href":"/services/playfab/api-references/rest/admin/scheduled-task/get-tasks"},{"title":"Run Task","openapi":"post /Admin/RunTask","description":"Run a task immediately regardless of its schedule.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TaskNotFound | 1261 |\n","href":"/services/playfab/api-references/rest/admin/scheduled-task/run-task"},{"title":"Update Task","openapi":"post /Admin/UpdateTask","description":"Update an existing task.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAzureFunctionsArgumentSizeExceeded | 1471 |\n| InvalidJSONContent | 1200 |\n| InvalidParams | 1000 |\n| InvalidScheduledTaskName | 1256 |\n| InvalidScheduledTaskParameter | 1391 |\n| InvalidScheduledTaskType | 1265 |\n| InvalidTaskSchedule | 1257 |\n| InvalidVirtualCurrencyCode | 1236 |\n| OverLimit | 1214 |\n| PushNotEnabledForAccount | 1094 |\n| PushNotificationTemplateInvalidSyntax | 1419 |\n| PushNotificationTemplateNotFound | 1417 |\n| ScheduledTaskCreateConflict | 1255 |\n| ScheduledTaskNameConflict | 1254 |\n| StatisticNotFound | 1195 |\n| TaskNotFound | 1261 |\n","href":"/services/playfab/api-references/rest/admin/scheduled-task/update-task"}]},{"group":"Segments","pages":[{"title":"Create Segment","openapi":"post /Admin/CreateSegment","description":"Creates a new player segment by defining the conditions on player properties. Also, create actions to target the player segments for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSegment | 1242 |\n| NameNotAvailable | 1058 |\n| ProductDisabledForTitle | 1609 |\n| SegmentManagementInvalidInput | 10005 |\n| SegmentManagementInvalidSegmentId | 10004 |\n| SegmentManagementInvalidSegmentName | 10006 |\n| SegmentManagementNoExpressionTree | 10001 |\n| SegmentManagementSegmentCountOverLimit | 10003 |\n| SegmentManagementTriggerActionCountOverLimit | 10002 |\n| UnknownError | 1039 |\n","href":"/services/playfab/api-references/rest/admin/segments/create-segment"},{"title":"Delete Segment","openapi":"post /Admin/DeleteSegment","description":"Deletes an existing player segment and its associated action(s) for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| SegmentManagementInvalidSegmentId | 10004 |\n| UnknownError | 1039 |\n","href":"/services/playfab/api-references/rest/admin/segments/delete-segment"},{"title":"Get Segments","openapi":"post /Admin/GetSegments","description":"Get detail information of a segment and its associated definition(s) and action(s) for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GetSegmentsRateLimitExceeded | 10010 |\n| ProductDisabledForTitle | 1609 |\n| UnknownError | 1039 |\n","href":"/services/playfab/api-references/rest/admin/segments/get-segments"},{"title":"Update Segment","openapi":"post /Admin/UpdateSegment","description":"Updates an existing player segment and its associated definition(s) and action(s) for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSegment | 1242 |\n| NameNotAvailable | 1058 |\n| ProductDisabledForTitle | 1609 |\n| SegmentManagementInvalidInput | 10005 |\n| SegmentManagementInvalidSegmentId | 10004 |\n| SegmentManagementInvalidSegmentName | 10006 |\n| SegmentManagementNoExpressionTree | 10001 |\n| SegmentManagementSegmentCountOverLimit | 10003 |\n| SegmentManagementTriggerActionCountOverLimit | 10002 |\n| UnknownError | 1039 |\n| UpdateSegmentRateLimitExceeded | 10009 |\n","href":"/services/playfab/api-references/rest/admin/segments/update-segment"}]},{"group":"Server-Side Cloud Script","pages":[{"title":"Get Cloud Script Revision","openapi":"post /Admin/GetCloudScriptRevision","description":"Gets the contents and information of a specific Cloud Script revision.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| RevisionNotFound | 1125 |\n| VersionNotFound | 1124 |\n","href":"/services/playfab/api-references/rest/admin/server-side-cloud-script/get-cloud-script-revision"},{"title":"Get Cloud Script Versions","openapi":"post /Admin/GetCloudScriptVersions","description":"Lists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/server-side-cloud-script/get-cloud-script-versions"},{"title":"Set Published Revision","openapi":"post /Admin/SetPublishedRevision","description":"Sets the currently published revision of a title Cloud Script\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RevisionNotFound | 1125 |\n| VersionNotFound | 1124 |\n","href":"/services/playfab/api-references/rest/admin/server-side-cloud-script/set-published-revision"},{"title":"Update Cloud Script","openapi":"post /Admin/UpdateCloudScript","description":"Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be submitted in the revision.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| JavascriptException | 1099 |\n| ProductDisabledForTitle | 1609 |\n| TitleDeleted | 1347 |\n","href":"/services/playfab/api-references/rest/admin/server-side-cloud-script/update-cloud-script"}]},{"group":"Shared Group Data","pages":[{"title":"Set Publisher Data","openapi":"post /Admin/SetPublisherData","description":"Updates the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/admin/shared-group-data/set-publisher-data"}]},{"group":"Title-Wide Data Management","pages":[{"title":"Add Localized News","openapi":"post /Admin/AddLocalizedNews","description":"Update news item to include localized version\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleDefaultLanguageNotSet | 1393 |\n| TitleNewsDuplicateLanguage | 1424 |\n| TitleNewsInvalidLanguage | 1426 |\n| TitleNewsNotFound | 1423 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/add-localized-news"},{"title":"Add News","openapi":"post /Admin/AddNews","description":"Adds a new news item to the title's news feed\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleNewsItemCountLimitExceeded | 1231 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/add-news"},{"title":"Add Virtual Currency Types","openapi":"post /Admin/AddVirtualCurrencyTypes","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum value of 2,147,483,647 when granted to a player. Any value over that will be discarded.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrencyCode | 1236 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCodeExists | 1230 |\n| VirtualCurrencyCountLimitExceeded | 1229 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/add-virtual-currency-types"},{"title":"Delete Store","openapi":"post /Admin/DeleteStore","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Deletes an existing virtual item store\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/delete-store"},{"title":"Delete Title Data Override","openapi":"post /Admin/DeleteTitleDataOverride","description":"Deletes a specified set of title data overrides.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleDataOverrideNotFound | 1508 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/delete-title-data-override"},{"title":"Get Catalog Items","openapi":"post /Admin/GetCatalogItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/get-catalog-items"},{"title":"Get Publisher Data","openapi":"post /Admin/GetPublisherData","description":"Retrieves the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/get-publisher-data"},{"title":"Get Random Result Tables","openapi":"post /Admin/GetRandomResultTables","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the random drop table configuration for the title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/get-random-result-tables"},{"title":"Get Store Items","openapi":"post /Admin/GetStoreItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items defined for the specified store, including all prices defined\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/get-store-items"},{"title":"Get Title Data","openapi":"post /Admin/GetTitleData","description":"Retrieves the key-value store of custom title settings which can be read by the client","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/get-title-data"},{"title":"Get Title Internal Data","openapi":"post /Admin/GetTitleInternalData","description":"Retrieves the key-value store of custom title settings which cannot be read by the client","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/get-title-internal-data"},{"title":"List Virtual Currency Types","openapi":"post /Admin/ListVirtualCurrencyTypes","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retuns the list of all defined virtual currencies for the title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/list-virtual-currency-types"},{"title":"Remove Virtual Currency Types","openapi":"post /Admin/RemoveVirtualCurrencyTypes","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Removes one or more virtual currencies from the set defined for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrencyCode | 1236 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCannotBeDeleted | 1237 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/remove-virtual-currency-types"},{"title":"Set Catalog Items","openapi":"post /Admin/SetCatalogItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Creates the catalog configuration of all virtual goods for the specified catalog version\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidDropTable | 1201 |\n| InvalidItemId | 1093 |\n| InvalidItemProperties | 1091 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/set-catalog-items"},{"title":"Set Store Items","openapi":"post /Admin/SetStoreItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Sets all the items in one virtual store\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| InvalidItemId | 1093 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/set-store-items"},{"title":"Set Title Data","openapi":"post /Admin/SetTitleData","description":"Creates and updates the key-value store of custom title settings which can be read by the client. For example, a developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths, movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new build. \n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| TooManyKeys | 1147 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/set-title-data"},{"title":"Set Title Data And Overrides","openapi":"post /Admin/SetTitleDataAndOverrides","description":"Set and delete key-value pairs in a title data override instance.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| DuplicateKeys | 1509 |\n| InvalidParams | 1000 |\n| TooManyKeys | 1147 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/set-title-data-and-overrides"},{"title":"Set Title Internal Data","openapi":"post /Admin/SetTitleInternalData","description":"Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy. \n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| TooManyKeys | 1147 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/set-title-internal-data"},{"title":"Setup Push Notification","openapi":"post /Admin/SetupPushNotification","description":"Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device Messaging is not supported.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PushServiceError | 1095 |\n| ValueAlreadyExists | 1031 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/setup-push-notification"},{"title":"Update Catalog Items","openapi":"post /Admin/UpdateCatalogItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the catalog configuration for virtual goods in the specified catalog version\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidDropTable | 1201 |\n| InvalidItemProperties | 1091 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/update-catalog-items"},{"title":"Update Random Result Tables","openapi":"post /Admin/UpdateRandomResultTables","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the random drop table configuration for the title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidDropTable | 1201 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/update-random-result-tables"},{"title":"Update Store Items","openapi":"post /Admin/UpdateStoreItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates an existing virtual item store with new or modified items\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| InvalidItemId | 1093 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/admin/title-wide-data-management/update-store-items"}]},{"group":"ScheduledTask","pages":[{"title":"Abort Task Instance","description":"Abort an ongoing task instance.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TaskInstanceNotFound | 1262 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/AbortTaskInstance","href":"/api-reference/scheduledtask/abort-task-instance","autogeneratedByOpenApi":true},{"title":"Create Actions On Players In Segment Task","description":"Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogBadRequest | 4013 |\n| CloudScriptAzureFunctionsArgumentSizeExceeded | 1471 |\n| InvalidJSONContent | 1200 |\n| InvalidParams | 1000 |\n| InvalidScheduledTaskName | 1256 |\n| InvalidTaskSchedule | 1257 |\n| InvalidVirtualCurrencyCode | 1236 |\n| OverLimit | 1214 |\n| PushNotEnabledForAccount | 1094 |\n| PushNotificationTemplateInvalidSyntax | 1419 |\n| PushNotificationTemplateNotFound | 1417 |\n| ScheduledTaskCreateConflict | 1255 |\n| ScheduledTaskNameConflict | 1254 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/CreateActionsOnPlayersInSegmentTask","href":"/api-reference/scheduledtask/create-actions-on-players-in-segment-task","autogeneratedByOpenApi":true},{"title":"Create Cloud Script Task","description":"Create a CloudScript task, which can run a CloudScript on a schedule.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidScheduledTaskName | 1256 |\n| InvalidTaskSchedule | 1257 |\n| ProductDisabledForTitle | 1609 |\n| ScheduledTaskCreateConflict | 1255 |\n| ScheduledTaskNameConflict | 1254 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/CreateCloudScriptTask","href":"/api-reference/scheduledtask/create-cloud-script-task","autogeneratedByOpenApi":true},{"title":"Create Insights Scheduled Scaling Task","description":"Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidScheduledTaskName | 1256 |\n| InvalidTaskSchedule | 1257 |\n| ProductDisabledForTitle | 1609 |\n| ScheduledTaskCreateConflict | 1255 |\n| ScheduledTaskNameConflict | 1254 |\n| TitleNotOnUpdatedPricingPlan | 9000 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/CreateInsightsScheduledScalingTask","href":"/api-reference/scheduledtask/create-insights-scheduled-scaling-task","autogeneratedByOpenApi":true},{"title":"Delete Task","description":"Delete a task.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteTask","href":"/api-reference/scheduledtask/delete-task","autogeneratedByOpenApi":true},{"title":"Get Actions On Players In Segment Task Instance","description":"Get information about a ActionsOnPlayersInSegment task instance.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TaskInstanceNotFound | 1262 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetActionsOnPlayersInSegmentTaskInstance","href":"/api-reference/scheduledtask/get-actions-on-players-in-segment-task-instance","autogeneratedByOpenApi":true},{"title":"Get Cloud Script Task Instance","description":"Get detail information about a CloudScript task instance.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TaskInstanceNotFound | 1262 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetCloudScriptTaskInstance","href":"/api-reference/scheduledtask/get-cloud-script-task-instance","autogeneratedByOpenApi":true},{"title":"Get Task Instances","description":"Query for task instances by task, status, or time range.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TaskNotFound | 1261 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetTaskInstances","href":"/api-reference/scheduledtask/get-task-instances","autogeneratedByOpenApi":true},{"title":"Get Tasks","description":"Get definition information on a specified task or all tasks within a title.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetTasks","href":"/api-reference/scheduledtask/get-tasks","autogeneratedByOpenApi":true},{"title":"Run Task","description":"Run a task immediately regardless of its schedule.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TaskNotFound | 1261 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/RunTask","href":"/api-reference/scheduledtask/run-task","autogeneratedByOpenApi":true},{"title":"Update Task","description":"Update an existing task.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAzureFunctionsArgumentSizeExceeded | 1471 |\n| InvalidJSONContent | 1200 |\n| InvalidParams | 1000 |\n| InvalidScheduledTaskName | 1256 |\n| InvalidScheduledTaskParameter | 1391 |\n| InvalidScheduledTaskType | 1265 |\n| InvalidTaskSchedule | 1257 |\n| InvalidVirtualCurrencyCode | 1236 |\n| OverLimit | 1214 |\n| PushNotEnabledForAccount | 1094 |\n| PushNotificationTemplateInvalidSyntax | 1419 |\n| PushNotificationTemplateNotFound | 1417 |\n| ScheduledTaskCreateConflict | 1255 |\n| ScheduledTaskNameConflict | 1254 |\n| StatisticNotFound | 1195 |\n| TaskNotFound | 1261 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdateTask","href":"/api-reference/scheduledtask/update-task","autogeneratedByOpenApi":true}]},{"group":"Title-Wide Data Management","pages":[{"title":"Add Localized News","description":"Update news item to include localized version\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleDefaultLanguageNotSet | 1393 |\n| TitleNewsDuplicateLanguage | 1424 |\n| TitleNewsInvalidLanguage | 1426 |\n| TitleNewsNotFound | 1423 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/AddLocalizedNews","href":"/api-reference/title-wide-data-management/add-localized-news","autogeneratedByOpenApi":true},{"title":"Add News","description":"Adds a new news item to the title's news feed\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleNewsItemCountLimitExceeded | 1231 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/AddNews","href":"/api-reference/title-wide-data-management/add-news","autogeneratedByOpenApi":true},{"title":"Add Virtual Currency Types","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum value of 2,147,483,647 when granted to a player. Any value over that will be discarded.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrencyCode | 1236 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCodeExists | 1230 |\n| VirtualCurrencyCountLimitExceeded | 1229 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/AddVirtualCurrencyTypes","href":"/api-reference/title-wide-data-management/add-virtual-currency-types","autogeneratedByOpenApi":true},{"title":"Delete Store","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Deletes an existing virtual item store\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteStore","href":"/api-reference/title-wide-data-management/delete-store","autogeneratedByOpenApi":true},{"title":"Delete Title Data Override","description":"Deletes a specified set of title data overrides.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleDataOverrideNotFound | 1508 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteTitleDataOverride","href":"/api-reference/title-wide-data-management/delete-title-data-override","autogeneratedByOpenApi":true},{"title":"Get Catalog Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCatalogItems","href":"/api-reference/title-wide-data-management/get-catalog-items","autogeneratedByOpenApi":true},{"title":"Get Publisher Data","description":"Retrieves the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPublisherData","href":"/api-reference/title-wide-data-management/get-publisher-data","autogeneratedByOpenApi":true},{"title":"Get Random Result Tables","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the random drop table configuration for the title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetRandomResultTables","href":"/api-reference/title-wide-data-management/get-random-result-tables","autogeneratedByOpenApi":true},{"title":"Get Store Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetStoreItems","href":"/api-reference/title-wide-data-management/get-store-items","autogeneratedByOpenApi":true},{"title":"Get Title Data","description":"Retrieves the key-value store of custom title settings","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetTitleData","href":"/api-reference/title-wide-data-management/get-title-data","autogeneratedByOpenApi":true},{"title":"Get Title Internal Data","description":"Retrieves the key-value store of custom internal title settings","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetTitleInternalData","href":"/api-reference/title-wide-data-management/get-title-internal-data","autogeneratedByOpenApi":true},{"title":"List Virtual Currency Types","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retuns the list of all defined virtual currencies for the title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/ListVirtualCurrencyTypes","href":"/api-reference/title-wide-data-management/list-virtual-currency-types","autogeneratedByOpenApi":true},{"title":"Remove Virtual Currency Types","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Removes one or more virtual currencies from the set defined for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrencyCode | 1236 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCannotBeDeleted | 1237 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/RemoveVirtualCurrencyTypes","href":"/api-reference/title-wide-data-management/remove-virtual-currency-types","autogeneratedByOpenApi":true},{"title":"Set Catalog Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Creates the catalog configuration of all virtual goods for the specified catalog version\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidDropTable | 1201 |\n| InvalidItemId | 1093 |\n| InvalidItemProperties | 1091 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/SetCatalogItems","href":"/api-reference/title-wide-data-management/set-catalog-items","autogeneratedByOpenApi":true},{"title":"Set Store Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Sets all the items in one virtual store\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| InvalidItemId | 1093 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/SetStoreItems","href":"/api-reference/title-wide-data-management/set-store-items","autogeneratedByOpenApi":true},{"title":"Set Title Data","description":"Updates the key-value store of custom title settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| TooManyKeys | 1147 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetTitleData","href":"/api-reference/title-wide-data-management/set-title-data","autogeneratedByOpenApi":true},{"title":"Set Title Data And Overrides","description":"Set and delete key-value pairs in a title data override instance.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| DuplicateKeys | 1509 |\n| InvalidParams | 1000 |\n| TooManyKeys | 1147 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/SetTitleDataAndOverrides","href":"/api-reference/title-wide-data-management/set-title-data-and-overrides","autogeneratedByOpenApi":true},{"title":"Set Title Internal Data","description":"Updates the key-value store of custom title settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| TooManyKeys | 1147 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetTitleInternalData","href":"/api-reference/title-wide-data-management/set-title-internal-data","autogeneratedByOpenApi":true},{"title":"Setup Push Notification","description":"Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device Messaging is not supported.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PushServiceError | 1095 |\n| ValueAlreadyExists | 1031 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/SetupPushNotification","href":"/api-reference/title-wide-data-management/setup-push-notification","autogeneratedByOpenApi":true},{"title":"Update Catalog Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the catalog configuration for virtual goods in the specified catalog version\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidDropTable | 1201 |\n| InvalidItemProperties | 1091 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdateCatalogItems","href":"/api-reference/title-wide-data-management/update-catalog-items","autogeneratedByOpenApi":true},{"title":"Update Random Result Tables","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the random drop table configuration for the title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidDropTable | 1201 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdateRandomResultTables","href":"/api-reference/title-wide-data-management/update-random-result-tables","autogeneratedByOpenApi":true},{"title":"Update Store Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates an existing virtual item store with new or modified items\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| InvalidItemId | 1093 |\n| InvalidJSONContent | 1200 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdateStoreItems","href":"/api-reference/title-wide-data-management/update-store-items","autogeneratedByOpenApi":true}]},{"group":"PlayStream","pages":[{"title":"Add Player Tag","description":"Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerTagCountLimitExceeded | 1248 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddPlayerTag","href":"/api-reference/playstream/add-player-tag","autogeneratedByOpenApi":true},{"title":"Export Players In Segment","description":"Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which match the segment definition at the time of the API call. Profiles which change while an export is in progress will not be reflected in the results.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AsyncExportNotInFlight | 10011 |\n| AsyncExportRateLimitExceeded | 10013 |\n| ExportUnknownError | 5013 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ExportPlayersInSegment","href":"/api-reference/playstream/export-players-in-segment","autogeneratedByOpenApi":true},{"title":"Get All Segments","description":"Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetAllSegments","href":"/api-reference/playstream/get-all-segments","autogeneratedByOpenApi":true},{"title":"Get Player Segments","description":"List all segments that a player currently belongs to at this moment in time.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerSegments","href":"/api-reference/playstream/get-player-segments","autogeneratedByOpenApi":true},{"title":"Get Player Tags","description":"Get all tags with a given Namespace (optional) from a player profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerTags","href":"/api-reference/playstream/get-player-tags","autogeneratedByOpenApi":true},{"title":"Get Segment Export","description":"Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of the export\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AsyncExportNotInFlight | 10011 |\n| AsyncExportRateLimitExceeded | 10013 |\n| ExportNotFound | 5004 |\n| ExportUnknownError | 5013 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetSegmentExport","href":"/api-reference/playstream/get-segment-export","autogeneratedByOpenApi":true},{"title":"Get Segment Player Count","description":"Returns the total number of players in a given segment.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GetSegmentPlayerCountNotInFlight | 10016 |\n| GetSegmentPlayerCountRateLimitExceeded | 10017 |\n| InternalServerError | 1110 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetSegmentPlayerCount","href":"/api-reference/playstream/get-segment-player-count","autogeneratedByOpenApi":true},{"title":"Remove Player Tag","description":"Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RemovePlayerTag","href":"/api-reference/playstream/remove-player-tag","autogeneratedByOpenApi":true}]},{"group":"Player Item Management","pages":[{"title":"Add User Virtual Currency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the user's balance of the specified virtual currency by the stated amount\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddUserVirtualCurrency","href":"/api-reference/player-item-management/add-user-virtual-currency","autogeneratedByOpenApi":true},{"title":"Check Limited Edition Item Availability","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Checks the global count for the limited edition item.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/CheckLimitedEditionItemAvailability","href":"/api-reference/player-item-management/check-limited-edition-item-availability","autogeneratedByOpenApi":true},{"title":"Get User Inventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified user's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserInventory","href":"/api-reference/player-item-management/get-user-inventory","autogeneratedByOpenApi":true},{"title":"Grant Items To Users","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified user inventories\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GrantItemsToUsers","href":"/api-reference/player-item-management/grant-items-to-users","autogeneratedByOpenApi":true},{"title":"Increment Limited Edition Item Availability","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increases the global count for the given scarce resource.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| RequestAlreadyRunning | 1249 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/IncrementLimitedEditionItemAvailability","href":"/api-reference/player-item-management/increment-limited-edition-item-availability","autogeneratedByOpenApi":true},{"title":"Revoke Inventory Item","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access to an item in a user's inventory\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RevokeInventoryItem","href":"/api-reference/player-item-management/revoke-inventory-item","autogeneratedByOpenApi":true},{"title":"Revoke Inventory Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access for up to 25 items across multiple users and characters.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RevokeInventoryItems","href":"/api-reference/player-item-management/revoke-inventory-items","autogeneratedByOpenApi":true},{"title":"Subtract User Virtual Currency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SubtractUserVirtualCurrency","href":"/api-reference/player-item-management/subtract-user-virtual-currency","autogeneratedByOpenApi":true}]},{"group":"Account Management","pages":[{"title":"Ban Users","description":"Bans users by PlayFab ID with optional IP address for the provided game.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/BanUsers","href":"/api-reference/account-management/ban-users","autogeneratedByOpenApi":true},{"title":"Create IP Ban","description":"Bans an IP address or CIDR range for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ConcurrentEditError | 1133 |\n| InvalidParams | 1000 |\n| OverLimit | 1214 |\n| ValueAlreadyExists | 1031 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/CreateIPBan","href":"/api-reference/account-management/create-ip-ban","autogeneratedByOpenApi":true},{"title":"Delete Master Player Account","description":"Removes a master player account entirely from all titles and deletes all associated data","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteMasterPlayerAccount","href":"/api-reference/account-management/delete-master-player-account","autogeneratedByOpenApi":true},{"title":"Delete Master Player Event Data","description":"Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteMasterPlayerEventData","href":"/api-reference/account-management/delete-master-player-event-data","autogeneratedByOpenApi":true},{"title":"Delete Membership Subscription","description":"Deletes a player's subscription\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MembershipNotFound | 1331 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteMembershipSubscription","href":"/api-reference/account-management/delete-membership-subscription","autogeneratedByOpenApi":true},{"title":"Delete Player","description":"Removes a user's player account from a title and deletes all associated data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameServerAccess | 1194 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/DeletePlayer","href":"/api-reference/account-management/delete-player","autogeneratedByOpenApi":true},{"title":"Delete Title","description":"Permanently deletes a title and all associated configuration\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleContainsUserAccounts | 1348 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteTitle","href":"/api-reference/account-management/delete-title","autogeneratedByOpenApi":true},{"title":"Export Master Player Data","description":"Exports all associated data of a master player account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailAddressNotAvailable | 1006 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/ExportMasterPlayerData","href":"/api-reference/account-management/export-master-player-data","autogeneratedByOpenApi":true},{"title":"Get IP Bans For IP","description":"Gets all IP bans that apply to a specific IP address.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidParams | 1000 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetIPBansForIP","href":"/api-reference/account-management/get-ip-bans-for-ip","autogeneratedByOpenApi":true},{"title":"Get IP Bans For Title","description":"Gets all IP bans for a title.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetIPBansForTitle","href":"/api-reference/account-management/get-ip-bans-for-title","autogeneratedByOpenApi":true},{"title":"Get Played Title List","description":"Get the list of titles that the player has played","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetPlayedTitleList","href":"/api-reference/account-management/get-played-title-list","autogeneratedByOpenApi":true},{"title":"Get Player Id From Auth Token","description":"Gets a player's ID from an auth token.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AuthTokenDoesNotExist | 1327 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetPlayerIdFromAuthToken","href":"/api-reference/account-management/get-player-id-from-auth-token","autogeneratedByOpenApi":true},{"title":"Get Player Profile","description":"Retrieves the player's profile\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerNotInGame | 1033 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerProfile","href":"/api-reference/account-management/get-player-profile","autogeneratedByOpenApi":true},{"title":"Get User Account Info","description":"Retrieves the relevant details for a specified user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleNotActivated | 1042 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserAccountInfo","href":"/api-reference/account-management/get-user-account-info","autogeneratedByOpenApi":true},{"title":"Get User Bans","description":"Gets all bans for a user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserBans","href":"/api-reference/account-management/get-user-bans","autogeneratedByOpenApi":true},{"title":"Reset Password","description":"Reset a player's password for a given title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AuthTokenAlreadyUsedToResetPassword | 1329 |\n| AuthTokenDoesNotExist | 1327 |\n| AuthTokenExpired | 1328 |\n| InvalidAuthToken | 1326 |\n| NoContactEmailAddressFound | 1325 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/ResetPassword","href":"/api-reference/account-management/reset-password","autogeneratedByOpenApi":true},{"title":"Revoke All Bans For User","description":"Revoke all active bans for a user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RevokeAllBansForUser","href":"/api-reference/account-management/revoke-all-bans-for-user","autogeneratedByOpenApi":true},{"title":"Revoke Bans","description":"Revoke all active bans specified with BanId.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RevokeBans","href":"/api-reference/account-management/revoke-bans","autogeneratedByOpenApi":true},{"title":"Revoke IP Ban","description":"Revokes an active IP ban.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidParams | 1000 |\n| IPAddressNotFound | 1616 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/RevokeIPBan","href":"/api-reference/account-management/revoke-ip-ban","autogeneratedByOpenApi":true},{"title":"Send Account Recovery Email","description":"Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailRecipientBlacklisted | 1427 |\n| InvalidEmailAddress | 1005 |\n| NoContactEmailAddressFound | 1325 |\n| SmtpAddonNotEnabled | 1341 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/SendAccountRecoveryEmail","href":"/api-reference/account-management/send-account-recovery-email","autogeneratedByOpenApi":true},{"title":"Set Membership Override","description":"Sets the override expiration for a membership subscription\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MembershipNotFound | 1331 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/SetMembershipOverride","href":"/api-reference/account-management/set-membership-override","autogeneratedByOpenApi":true},{"title":"Update Bans","description":"Updates information of a list of existing bans specified with Ban Ids.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateBans","href":"/api-reference/account-management/update-bans","autogeneratedByOpenApi":true},{"title":"Update IP Ban","description":"Updates an existing IP ban.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidParams | 1000 |\n| IPAddressNotFound | 1616 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdateIPBan","href":"/api-reference/account-management/update-ip-ban","autogeneratedByOpenApi":true},{"title":"Update User Title Display Name","description":"Updates the title specific display name for the user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| ConcurrentEditError | 1133 |\n| EntityProfileConstraintValidationFailed | 1398 |\n| EntityProfileVersionMismatch | 1352 |\n| InvalidPartnerResponse | 1193 |\n| NameNotAvailable | 1058 |\n| ProfaneDisplayName | 1234 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UpdateUserTitleDisplayName","href":"/api-reference/account-management/update-user-title-display-name","autogeneratedByOpenApi":true}]},{"group":"Authentication","pages":[{"title":"Create Open Id Connection","description":"Registers a relationship between a title and an Open ID Connect provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ValueAlreadyExists | 1031 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/CreateOpenIdConnection","href":"/api-reference/authentication/create-open-id-connection","autogeneratedByOpenApi":true},{"title":"Create Player Shared Secret","description":"Creates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after this API returns.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/CreatePlayerSharedSecret","href":"/api-reference/authentication/create-player-shared-secret","autogeneratedByOpenApi":true},{"title":"Delete Open Id Connection","description":"Removes a relationship between a title and an OpenID Connect provider.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteOpenIdConnection","href":"/api-reference/authentication/delete-open-id-connection","autogeneratedByOpenApi":true},{"title":"Delete Player Shared Secret","description":"Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API returns.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeletePlayerSharedSecret","href":"/api-reference/authentication/delete-player-shared-secret","autogeneratedByOpenApi":true},{"title":"Get Player Shared Secrets","description":"Returns all Player Shared Secret Keys including disabled and expired.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetPlayerSharedSecrets","href":"/api-reference/authentication/get-player-shared-secrets","autogeneratedByOpenApi":true},{"title":"Get Policy","description":"Gets the requested policy.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetPolicy","href":"/api-reference/authentication/get-policy","autogeneratedByOpenApi":true},{"title":"List Open Id Connection","description":"Retrieves a list of all Open ID Connect providers registered to a title.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/ListOpenIdConnection","href":"/api-reference/authentication/list-open-id-connection","autogeneratedByOpenApi":true},{"title":"Set Player Secret","description":"Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's secret use the Admin or Server API method SetPlayerSecret.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerSecretAlreadyConfigured | 1294 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetPlayerSecret","href":"/api-reference/authentication/set-player-secret","autogeneratedByOpenApi":true},{"title":"Update Open Id Connection","description":"Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdateOpenIdConnection","href":"/api-reference/authentication/update-open-id-connection","autogeneratedByOpenApi":true},{"title":"Update Player Shared Secret","description":"Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available after this API returns.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdatePlayerSharedSecret","href":"/api-reference/authentication/update-player-shared-secret","autogeneratedByOpenApi":true},{"title":"Update Policy","description":"Changes a policy for a title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdatePolicy","href":"/api-reference/authentication/update-policy","autogeneratedByOpenApi":true},{"title":"Validate Api Policy","description":"Validates the result of a policy update without persisting it.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/ValidateApiPolicy","href":"/api-reference/authentication/validate-api-policy","autogeneratedByOpenApi":true}]},{"group":"Player Data Management","pages":[{"title":"Create Player Statistic Definition","description":"Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticCountLimitExceeded | 1203 |\n| StatisticNameConflict | 1196 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/CreatePlayerStatisticDefinition","href":"/api-reference/player-data-management/create-player-statistic-definition","autogeneratedByOpenApi":true},{"title":"Delete Player Custom Properties","description":"Deletes title-specific custom properties for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/DeletePlayerCustomProperties","href":"/api-reference/player-data-management/delete-player-custom-properties","autogeneratedByOpenApi":true},{"title":"Get Data Report","description":"Retrieves a download URL for the requested report\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataNotAvailable | 1604 |\n| InvalidParams | 1000 |\n| InvalidReportDate | 1111 |\n| InvalidReportName | 1605 |\n| ProductDisabledForTitle | 1609 |\n| ReportDataNotRetrievedSuccessfully | 1597 |\n| ReportNotProcessed | 1603 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetDataReport","href":"/api-reference/player-data-management/get-data-report","autogeneratedByOpenApi":true},{"title":"Get Player Custom Property","description":"Retrieves a title-specific custom property value for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesPropertyDoesNotExist | 19007 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerCustomProperty","href":"/api-reference/player-data-management/get-player-custom-property","autogeneratedByOpenApi":true},{"title":"Get Player Statistic Definitions","description":"Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetPlayerStatisticDefinitions","href":"/api-reference/player-data-management/get-player-statistic-definitions","autogeneratedByOpenApi":true},{"title":"Get Player Statistic Versions","description":"Retrieves the information on the available versions of the specified statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerStatisticVersions","href":"/api-reference/player-data-management/get-player-statistic-versions","autogeneratedByOpenApi":true},{"title":"Get User Data","description":"Retrieves the title-specific custom data for the user which is readable and writable by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserData","href":"/api-reference/player-data-management/get-user-data","autogeneratedByOpenApi":true},{"title":"Get User Internal Data","description":"Retrieves the title-specific custom data for the user which cannot be accessed by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserInternalData","href":"/api-reference/player-data-management/get-user-internal-data","autogeneratedByOpenApi":true},{"title":"Get User Publisher Data","description":"Retrieves the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserPublisherData","href":"/api-reference/player-data-management/get-user-publisher-data","autogeneratedByOpenApi":true},{"title":"Get User Publisher Internal Data","description":"Retrieves the publisher-specific custom data for the user which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserPublisherInternalData","href":"/api-reference/player-data-management/get-user-publisher-internal-data","autogeneratedByOpenApi":true},{"title":"Get User Publisher Read Only Data","description":"Retrieves the publisher-specific custom data for the user which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserPublisherReadOnlyData","href":"/api-reference/player-data-management/get-user-publisher-read-only-data","autogeneratedByOpenApi":true},{"title":"Get User Read Only Data","description":"Retrieves the title-specific custom data for the user which can only be read by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserReadOnlyData","href":"/api-reference/player-data-management/get-user-read-only-data","autogeneratedByOpenApi":true},{"title":"Increment Player Statistic Version","description":"Resets the indicated statistic, removing all player entries for it and backing up the old values.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateInProgress | 1276 |\n| StatisticVersionIncrementRateExceeded | 1204 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/IncrementPlayerStatisticVersion","href":"/api-reference/player-data-management/increment-player-statistic-version","autogeneratedByOpenApi":true},{"title":"List Player Custom Properties","description":"Retrieves title-specific custom property values for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ListPlayerCustomProperties","href":"/api-reference/player-data-management/list-player-custom-properties","autogeneratedByOpenApi":true},{"title":"Refund Purchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Attempts to process an order refund through the original real money payment provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/RefundPurchase","href":"/api-reference/player-data-management/refund-purchase","autogeneratedByOpenApi":true},{"title":"Reset User Statistics","description":"Completely removes all statistics for the specified user, for the current game\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/ResetUserStatistics","href":"/api-reference/player-data-management/reset-user-statistics","autogeneratedByOpenApi":true},{"title":"Resolve Purchase Dispute","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Attempts to resolve a dispute with the original order's payment provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/ResolvePurchaseDispute","href":"/api-reference/player-data-management/resolve-purchase-dispute","autogeneratedByOpenApi":true},{"title":"Update Player Custom Properties","description":"Updates the title-specific custom property values for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesDuplicatePropertyName | 19006 |\n| PlayerCustomPropertiesPropertyCountTooHigh | 19005 |\n| PlayerCustomPropertiesPropertyNameIsInvalid | 19001 |\n| PlayerCustomPropertiesPropertyNameTooLong | 19000 |\n| PlayerCustomPropertiesStringPropertyValueTooLong | 19002 |\n| PlayerCustomPropertiesValueIsInvalidType | 19003 |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdatePlayerCustomProperties","href":"/api-reference/player-data-management/update-player-custom-properties","autogeneratedByOpenApi":true},{"title":"Update Player Statistic Definition","description":"Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateInProgress | 1276 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdatePlayerStatisticDefinition","href":"/api-reference/player-data-management/update-player-statistic-definition","autogeneratedByOpenApi":true},{"title":"Update User Data","description":"Updates the title-specific custom data for the user which is readable and writable by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserData","href":"/api-reference/player-data-management/update-user-data","autogeneratedByOpenApi":true},{"title":"Update User Internal Data","description":"Updates the title-specific custom data for the user which cannot be accessed by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserInternalData","href":"/api-reference/player-data-management/update-user-internal-data","autogeneratedByOpenApi":true},{"title":"Update User Publisher Data","description":"Updates the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserPublisherData","href":"/api-reference/player-data-management/update-user-publisher-data","autogeneratedByOpenApi":true},{"title":"Update User Publisher Internal Data","description":"Updates the publisher-specific custom data for the user which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserPublisherInternalData","href":"/api-reference/player-data-management/update-user-publisher-internal-data","autogeneratedByOpenApi":true},{"title":"Update User Publisher Read Only Data","description":"Updates the publisher-specific custom data for the user which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserPublisherReadOnlyData","href":"/api-reference/player-data-management/update-user-publisher-read-only-data","autogeneratedByOpenApi":true},{"title":"Update User Read Only Data","description":"Updates the title-specific custom data for the user which can only be read by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserReadOnlyData","href":"/api-reference/player-data-management/update-user-read-only-data","autogeneratedByOpenApi":true}]},{"group":"Segments","pages":[{"title":"Create Segment","description":"Creates a new player segment by defining the conditions on player properties. Also, create actions to target the player segments for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSegment | 1242 |\n| NameNotAvailable | 1058 |\n| ProductDisabledForTitle | 1609 |\n| SegmentManagementInvalidInput | 10005 |\n| SegmentManagementInvalidSegmentId | 10004 |\n| SegmentManagementInvalidSegmentName | 10006 |\n| SegmentManagementNoExpressionTree | 10001 |\n| SegmentManagementSegmentCountOverLimit | 10003 |\n| SegmentManagementTriggerActionCountOverLimit | 10002 |\n| UnknownError | 1039 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/CreateSegment","href":"/api-reference/segments/create-segment","autogeneratedByOpenApi":true},{"title":"Delete Segment","description":"Deletes an existing player segment and its associated action(s) for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| SegmentManagementInvalidSegmentId | 10004 |\n| UnknownError | 1039 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteSegment","href":"/api-reference/segments/delete-segment","autogeneratedByOpenApi":true},{"title":"Get Segments","description":"Get detail information of a segment and its associated definition(s) and action(s) for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GetSegmentsRateLimitExceeded | 10010 |\n| ProductDisabledForTitle | 1609 |\n| UnknownError | 1039 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetSegments","href":"/api-reference/segments/get-segments","autogeneratedByOpenApi":true},{"title":"Update Segment","description":"Updates an existing player segment and its associated definition(s) and action(s) for a title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSegment | 1242 |\n| NameNotAvailable | 1058 |\n| ProductDisabledForTitle | 1609 |\n| SegmentManagementInvalidInput | 10005 |\n| SegmentManagementInvalidSegmentId | 10004 |\n| SegmentManagementInvalidSegmentName | 10006 |\n| SegmentManagementNoExpressionTree | 10001 |\n| SegmentManagementSegmentCountOverLimit | 10003 |\n| SegmentManagementTriggerActionCountOverLimit | 10002 |\n| UnknownError | 1039 |\n| UpdateSegmentRateLimitExceeded | 10009 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdateSegment","href":"/api-reference/segments/update-segment","autogeneratedByOpenApi":true}]},{"group":"Content","pages":[{"title":"Delete Content","description":"Delete a content file from the title. When deleting a file that does not exist, it returns success.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/DeleteContent","href":"/api-reference/content/delete-content","autogeneratedByOpenApi":true},{"title":"Get Content List","description":"List all contents of the title and get statistics such as size\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ContentS3OriginBucketNotConfigured | 1299 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetContentList","href":"/api-reference/content/get-content-list","autogeneratedByOpenApi":true},{"title":"Get Content Upload Url","description":"Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| ContentQuotaExceeded | 1137 |\n| NotAuthorized | 1089 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetContentUploadUrl","href":"/api-reference/content/get-content-upload-url","autogeneratedByOpenApi":true}]},{"group":"Server-Side Cloud Script","pages":[{"title":"Get Cloud Script Revision","description":"Gets the contents and information of a specific Cloud Script revision.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| RevisionNotFound | 1125 |\n| VersionNotFound | 1124 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetCloudScriptRevision","href":"/api-reference/server-side-cloud-script/get-cloud-script-revision","autogeneratedByOpenApi":true},{"title":"Get Cloud Script Versions","description":"Lists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/GetCloudScriptVersions","href":"/api-reference/server-side-cloud-script/get-cloud-script-versions","autogeneratedByOpenApi":true},{"title":"Set Published Revision","description":"Sets the currently published revision of a title Cloud Script\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RevisionNotFound | 1125 |\n| VersionNotFound | 1124 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/SetPublishedRevision","href":"/api-reference/server-side-cloud-script/set-published-revision","autogeneratedByOpenApi":true},{"title":"Update Cloud Script","description":"Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be submitted in the revision.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| JavascriptException | 1099 |\n| ProductDisabledForTitle | 1609 |\n| TitleDeleted | 1347 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/UpdateCloudScript","href":"/api-reference/server-side-cloud-script/update-cloud-script","autogeneratedByOpenApi":true}]},{"group":"Characters","pages":[{"title":"Reset Character Statistics","description":"Completely removes all statistics for the specified character, for the current game\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/ResetCharacterStatistics","href":"/api-reference/characters/reset-character-statistics","autogeneratedByOpenApi":true}]},{"group":"Shared Group Data","pages":[{"title":"Set Publisher Data","description":"Updates the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/admin/admin.openapi.json post /Admin/SetPublisherData","href":"/api-reference/shared-group-data/set-publisher-data","autogeneratedByOpenApi":true}]}]},{"group":"Authentication","pages":[{"title":"PlayFab Authentication API","description":"Overview of the PlayFab Authentication REST API, which converts classic authentication responses into entity tokens needed for subsequent Entity API calls.","href":"/services/playfab/api-references/rest/authentication/overview"},{"group":"Authentication","pages":[{"title":"Authenticate Game Server With Custom Id","openapi":"post /GameServerIdentity/AuthenticateGameServerWithCustomId","description":"Create a game_server entity token and return a new or existing game_server entity.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/authentication/authentication/authenticate-game-server-with-custom-id"},{"title":"Delete","openapi":"post /GameServerIdentity/Delete","description":"Delete a game_server entity.\n\nAllowed entity token types: title, game_server","href":"/services/playfab/api-references/rest/authentication/authentication/delete"},{"title":"Get Entity Token","openapi":"post /Authentication/GetEntityToken","description":"Method to exchange a legacy AuthenticationTicket or title SecretKey for an Entity Token or to refresh a still valid Entity Token.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyBroken | 1291 |\n| NoValidCertificateForAad | 1376 |\n","href":"/services/playfab/api-references/rest/authentication/authentication/get-entity-token"},{"title":"Validate Entity Token","openapi":"post /Authentication/ValidateEntityToken","description":"Method for a server to validate a client provided EntityToken. Only callable by the title entity.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/authentication/authentication/validate-entity-token"}]},{"group":"Authentication","pages":[{"title":"Get Entity Token","description":"Method to exchange a legacy AuthenticationTicket or title SecretKey for an Entity Token or to refresh a still valid Entity Token.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyBroken | 1291 |\n| NoValidCertificateForAad | 1376 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/authentication/authentication.openapi.json post /Authentication/GetEntityToken","href":"/api-reference/authentication/get-entity-token","autogeneratedByOpenApi":true},{"title":"Validate Entity Token","description":"Method for a server to validate a client provided EntityToken. Only callable by the title entity.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/authentication/authentication.openapi.json post /Authentication/ValidateEntityToken","href":"/api-reference/authentication/validate-entity-token","autogeneratedByOpenApi":true},{"title":"Authenticate Game Server With Custom Id","description":"Create a game_server entity token and return a new or existing game_server entity.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/authentication/authentication.openapi.json post /GameServerIdentity/AuthenticateGameServerWithCustomId","href":"/api-reference/authentication/authenticate-game-server-with-custom-id","autogeneratedByOpenApi":true},{"title":"Delete","description":"Delete a game_server entity.\n\nAllowed entity token types: title, game_server","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/authentication/authentication.openapi.json post /GameServerIdentity/Delete","href":"/api-reference/authentication/delete","autogeneratedByOpenApi":true}]}]},{"group":"Client","pages":[{"title":"PlayFab Client API","description":"Overview of the PlayFab Client REST API, covering client authentication, account and data management, inventory, friends, and matchmaking operations.","href":"/services/playfab/api-references/rest/client/overview"},{"group":"Account Management","pages":[{"title":"Add Generic ID","openapi":"post /Client/AddGenericID","description":"Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| IdentifierAlreadyClaimed | 1238 |\n","href":"/services/playfab/api-references/rest/client/account-management/add-generic-id"},{"title":"Add Or Update Contact Email","openapi":"post /Client/AddOrUpdateContactEmail","description":"Adds or updates a contact email to the player's profile.","href":"/services/playfab/api-references/rest/client/account-management/add-or-update-contact-email"},{"title":"Add Username Password","openapi":"post /Client/AddUsernamePassword","description":"Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| EmailAddressNotAvailable | 1006 |\n| InvalidEmailAddress | 1005 |\n| InvalidPassword | 1008 |\n| InvalidUsername | 1007 |\n| UsernameNotAvailable | 1009 |\n","href":"/services/playfab/api-references/rest/client/account-management/add-username-password"},{"title":"Get Account Info","openapi":"post /Client/GetAccountInfo","description":"Retrieves the user's PlayFab account details","href":"/services/playfab/api-references/rest/client/account-management/get-account-info"},{"title":"Get Player Combined Info","openapi":"post /Client/GetPlayerCombinedInfo","description":"Retrieves all of the user's different kinds of info.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/account-management/get-player-combined-info"},{"title":"Get Player Profile","openapi":"post /Client/GetPlayerProfile","description":"Retrieves the player's profile\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerNotInGame | 1033 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/account-management/get-player-profile"},{"title":"Get PlayFab IDs From Battle Net Account Ids","openapi":"post /Client/GetPlayFabIDsFromBattleNetAccountIds","description":"Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-battle-net-account-ids"},{"title":"Get PlayFab IDs From Facebook IDs","openapi":"post /Client/GetPlayFabIDsFromFacebookIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-facebook-ids"},{"title":"Get PlayFab IDs From Facebook Instant Games Ids","openapi":"post /Client/GetPlayFabIDsFromFacebookInstantGamesIds","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-facebook-instant-games-ids"},{"title":"Get PlayFab IDs From Game Center IDs","openapi":"post /Client/GetPlayFabIDsFromGameCenterIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier).","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-game-center-ids"},{"title":"Get PlayFab IDs From Generic IDs","openapi":"post /Client/GetPlayFabIDsFromGenericIDs","description":"Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-generic-ids"},{"title":"Get PlayFab IDs From Google IDs","openapi":"post /Client/GetPlayFabIDsFromGoogleIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as \"id\" in the Google+ People API calls.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-google-ids"},{"title":"Get PlayFab IDs From Google Play Games Player IDs","openapi":"post /Client/GetPlayFabIDsFromGooglePlayGamesPlayerIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games identifiers are the IDs for the user accounts, available as \"playerId\" in the Google Play Games Services - Players API calls.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-google-play-games-player-ids"},{"title":"Get PlayFab IDs From Kongregate IDs","openapi":"post /Client/GetPlayFabIDsFromKongregateIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as \"user_id\" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId).","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-kongregate-ids"},{"title":"Get PlayFab IDs From Nintendo Service Account Ids","openapi":"post /Client/GetPlayFabIDsFromNintendoServiceAccountIds","description":"Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-nintendo-service-account-ids"},{"title":"Get PlayFab IDs From Nintendo Switch Device Ids","openapi":"post /Client/GetPlayFabIDsFromNintendoSwitchDeviceIds","description":"Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-nintendo-switch-device-ids"},{"title":"Get PlayFab IDs From OpenId Subject Identifiers","openapi":"post /Client/GetPlayFabIDsFromOpenIdSubjectIdentifiers","description":"Retrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId identifier is the service name plus the service-specific ID for the player, as specified by the title when the OpenId identifier was added to the player account.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-openid-subject-identifiers"},{"title":"Get PlayFab IDs From PSN Account IDs","openapi":"post /Client/GetPlayFabIDsFromPSNAccountIDs","description":"Retrieves the unique PlayFab identifiers for the given set of PlayStation™ Network identifiers.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidPSNAuthCode | 1092 |\n","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-psn-account-ids"},{"title":"Get PlayFab IDs From PSN Online IDs","openapi":"post /Client/GetPlayFabIDsFromPSNOnlineIDs","description":"Retrieves the unique PlayFab identifiers for the given set of PlayStation™ Network identifiers.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidPSNAuthCode | 1092 |\n","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-psn-online-ids"},{"title":"Get PlayFab IDs From Steam IDs","openapi":"post /Client/GetPlayFabIDsFromSteamIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-steam-ids"},{"title":"Get PlayFab IDs From Steam Names","openapi":"post /Client/GetPlayFabIDsFromSteamNames","description":"Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-steam-names"},{"title":"Get PlayFab IDs From Twitch IDs","openapi":"post /Client/GetPlayFabIDsFromTwitchIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as \"_id\" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-twitch-ids"},{"title":"Get PlayFab IDs From Xbox Live IDs","openapi":"post /Client/GetPlayFabIDsFromXboxLiveIDs","description":"Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.","href":"/services/playfab/api-references/rest/client/account-management/get-playfab-ids-from-xbox-live-ids"},{"title":"Link Android Device ID","openapi":"post /Client/LinkAndroidDeviceID","description":"Links the Android device identifier to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| LinkedDeviceAlreadyClaimed | 1118 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-android-device-id"},{"title":"Link Apple","openapi":"post /Client/LinkApple","description":"Links the Apple account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| AppleNotEnabledForTitle | 1501 |\n| InvalidIdentityProviderId | 1263 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| TokenSigningKeyNotFound | 1568 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-apple"},{"title":"Link Battle Net Account","openapi":"post /Client/LinkBattleNetAccount","description":"Links the Battle.net account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BattleNetNotEnabledForTitle | 1602 |\n| InvalidIdentityProviderId | 1263 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| TokenSigningKeyNotFound | 1568 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-battle-net-account"},{"title":"Link Custom ID","openapi":"post /Client/LinkCustomID","description":"Links the custom identifier, generated by the title, to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-custom-id"},{"title":"Link Facebook Account","openapi":"post /Client/LinkFacebookAccount","description":"Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| AccountNotFound | 1001 |\n| FacebookAPIError | 1143 |\n| InvalidFacebookToken | 1013 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-facebook-account"},{"title":"Link Facebook Instant Games Id","openapi":"post /Client/LinkFacebookInstantGamesId","description":"Links the Facebook Instant Games Id to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| FacebookInstantGamesAuthNotConfiguredForTitle | 1397 |\n| InvalidFacebookInstantGamesSignature | 1396 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-facebook-instant-games-id"},{"title":"Link Game Center Account","openapi":"post /Client/LinkGameCenterAccount","description":"Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| GameCenterAuthenticationFailed | 1429 |\n| InvalidGameCenterAuthRequest | 1428 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-game-center-account"},{"title":"Link Google Account","openapi":"post /Client/LinkGoogleAccount","description":"Links the currently signed-in user account to their Google account, using their Google account credentials\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| GoogleOAuthError | 1271 |\n| GoogleOAuthNoIdTokenIncludedInResponse | 1275 |\n| GoogleOAuthNotConfiguredForTitle | 1270 |\n| InvalidGoogleToken | 1026 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-google-account"},{"title":"Link Google Play Games Services Account","openapi":"post /Client/LinkGooglePlayGamesServicesAccount","description":"Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account credentials\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| GoogleOAuthError | 1271 |\n| GoogleOAuthNotConfiguredForTitle | 1270 |\n| InvalidGooglePlayGamesServerAuthCode | 1545 |\n| InvalidGoogleToken | 1026 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-google-play-games-services-account"},{"title":"Link IOS Device ID","openapi":"post /Client/LinkIOSDeviceID","description":"Links the vendor-specific iOS device identifier to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| LinkedDeviceAlreadyClaimed | 1118 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-ios-device-id"},{"title":"Link Kongregate","openapi":"post /Client/LinkKongregate","description":"Links the Kongregate identifier to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidKongregateToken | 1176 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-kongregate"},{"title":"Link Nintendo Service Account","openapi":"post /Client/LinkNintendoServiceAccount","description":"Links the Nintendo account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| InvalidIdentityProviderId | 1263 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-nintendo-service-account"},{"title":"Link Nintendo Switch Device Id","openapi":"post /Client/LinkNintendoSwitchDeviceId","description":"Links the NintendoSwitchDeviceId to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-nintendo-switch-device-id"},{"title":"Link OpenId Connect","openapi":"post /Client/LinkOpenIdConnect","description":"Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an Open ID Connect provider and the OpenId Connect JWT from that provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| InvalidIdentityProviderId | 1263 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-openid-connect"},{"title":"Link PSN Account","openapi":"post /Client/LinkPSNAccount","description":"Links the PlayStation™ Network account associated with the provided access code to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| InvalidParams | 1000 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| PSNInaccessible | 1152 |\n| PSNNextGenNotConfiguredForTitle | 1617 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-psn-account"},{"title":"Link Steam Account","openapi":"post /Client/LinkSteamAccount","description":"Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| InvalidSteamTicket | 1010 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| SteamNotEnabledForTitle | 1258 |\n| SteamUserNotFound | 1513 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-steam-account"},{"title":"Link Twitch","openapi":"post /Client/LinkTwitch","description":"Links the Twitch account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidTwitchToken | 1232 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| TwitchResponseError | 1233 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-twitch"},{"title":"Link Xbox Account","openapi":"post /Client/LinkXboxAccount","description":"Links the Xbox Live account associated with the provided access code to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| ExpiredXboxLiveToken | 1189 |\n| InvalidXboxLiveToken | 1188 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","href":"/services/playfab/api-references/rest/client/account-management/link-xbox-account"},{"title":"Remove Contact Email","openapi":"post /Client/RemoveContactEmail","description":"Removes a contact email from the player's profile.","href":"/services/playfab/api-references/rest/client/account-management/remove-contact-email"},{"title":"Remove Generic ID","openapi":"post /Client/RemoveGenericID","description":"Removes the specified generic service identifier from the player's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| IdentifierNotLinked | 1239 |\n","href":"/services/playfab/api-references/rest/client/account-management/remove-generic-id"},{"title":"Report Player","openapi":"post /Client/ReportPlayer","description":"Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players.","href":"/services/playfab/api-references/rest/client/account-management/report-player"},{"title":"Send Account Recovery Email","openapi":"post /Client/SendAccountRecoveryEmail","description":"Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailRecipientBlacklisted | 1427 |\n| InvalidEmailAddress | 1005 |\n| NoContactEmailAddressFound | 1325 |\n| SmtpAddonNotEnabled | 1341 |\n","href":"/services/playfab/api-references/rest/client/account-management/send-account-recovery-email"},{"title":"Unlink Android Device ID","openapi":"post /Client/UnlinkAndroidDeviceID","description":"Unlinks the related Android device identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| DeviceNotLinked | 1120 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-android-device-id"},{"title":"Unlink Apple","openapi":"post /Client/UnlinkApple","description":"Unlinks the related Apple account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| AppleNotEnabledForTitle | 1501 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-apple"},{"title":"Unlink Battle Net Account","openapi":"post /Client/UnlinkBattleNetAccount","description":"Unlinks the related Battle.net account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| BattleNetNotEnabledForTitle | 1602 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-battle-net-account"},{"title":"Unlink Custom ID","openapi":"post /Client/UnlinkCustomID","description":"Unlinks the related custom identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| CustomIdNotLinked | 1185 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-custom-id"},{"title":"Unlink Facebook Account","openapi":"post /Client/UnlinkFacebookAccount","description":"Unlinks the related Facebook account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-facebook-account"},{"title":"Unlink Facebook Instant Games Id","openapi":"post /Client/UnlinkFacebookInstantGamesId","description":"Unlinks the related Facebook Instant Game Ids from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| FacebookInstantGamesIdNotLinked | 1395 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-facebook-instant-games-id"},{"title":"Unlink Game Center Account","openapi":"post /Client/UnlinkGameCenterAccount","description":"Unlinks the related Game Center account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-game-center-account"},{"title":"Unlink Google Account","openapi":"post /Client/UnlinkGoogleAccount","description":"Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-google-account"},{"title":"Unlink Google Play Games Services Account","openapi":"post /Client/UnlinkGooglePlayGamesServicesAccount","description":"Unlinks the related Google Play Games account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-google-play-games-services-account"},{"title":"Unlink IOS Device ID","openapi":"post /Client/UnlinkIOSDeviceID","description":"Unlinks the related iOS device identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| DeviceNotLinked | 1120 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-ios-device-id"},{"title":"Unlink Kongregate","openapi":"post /Client/UnlinkKongregate","description":"Unlinks the related Kongregate identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-kongregate"},{"title":"Unlink Nintendo Service Account","openapi":"post /Client/UnlinkNintendoServiceAccount","description":"Unlinks the related Nintendo account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-nintendo-service-account"},{"title":"Unlink Nintendo Switch Device Id","openapi":"post /Client/UnlinkNintendoSwitchDeviceId","description":"Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| NintendoSwitchDeviceIdNotLinked | 2034 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-nintendo-switch-device-id"},{"title":"Unlink OpenId Connect","openapi":"post /Client/UnlinkOpenIdConnect","description":"Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship between a title and an Open ID Connect provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-openid-connect"},{"title":"Unlink PSN Account","openapi":"post /Client/UnlinkPSNAccount","description":"Unlinks the related PlayStation™ Network account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-psn-account"},{"title":"Unlink Steam Account","openapi":"post /Client/UnlinkSteamAccount","description":"Unlinks the related Steam account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-steam-account"},{"title":"Unlink Twitch","openapi":"post /Client/UnlinkTwitch","description":"Unlinks the related Twitch account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidTwitchToken | 1232 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-twitch"},{"title":"Unlink Xbox Account","openapi":"post /Client/UnlinkXboxAccount","description":"Unlinks the related Xbox Live account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| InvalidXboxLiveToken | 1188 |\n","href":"/services/playfab/api-references/rest/client/account-management/unlink-xbox-account"},{"title":"Update Avatar Url","openapi":"post /Client/UpdateAvatarUrl","description":"Update the avatar URL of the player","href":"/services/playfab/api-references/rest/client/account-management/update-avatar-url"},{"title":"Update User Title Display Name","openapi":"post /Client/UpdateUserTitleDisplayName","description":"Updates the title specific display name for the user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| ConcurrentEditError | 1133 |\n| EntityProfileConstraintValidationFailed | 1398 |\n| EntityProfileVersionMismatch | 1352 |\n| InvalidPartnerResponse | 1193 |\n| NameNotAvailable | 1058 |\n| ProfaneDisplayName | 1234 |\n","href":"/services/playfab/api-references/rest/client/account-management/update-user-title-display-name"}]},{"group":"Advertising","pages":[{"title":"Attribute Install","openapi":"post /Client/AttributeInstall","description":"Attributes an install for advertisment.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| NoPartnerEnabled | 1192 |\n","href":"/services/playfab/api-references/rest/client/advertising/attribute-install"},{"title":"Get Ad Placements","openapi":"post /Client/GetAdPlacements","description":"Returns a list of ad placements and a reward for each\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/advertising/get-ad-placements"},{"title":"Report Ad Activity","openapi":"post /Client/ReportAdActivity","description":"Report player's ad activity\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidAdPlacementAndReward | 1268 |\n","href":"/services/playfab/api-references/rest/client/advertising/report-ad-activity"},{"title":"Reward Ad Activity","openapi":"post /Client/RewardAdActivity","description":"Reward player's ad activity\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ActionGroupNotFound | 1250 |\n| AllAdPlacementViewsAlreadyConsumed | 1269 |\n| InvalidAdPlacementAndReward | 1268 |\n","href":"/services/playfab/api-references/rest/client/advertising/reward-ad-activity"}]},{"group":"Analytics","pages":[{"title":"Report Device Info","openapi":"post /Client/ReportDeviceInfo","description":"Write a PlayStream event to describe the provided player device information. This API method is not designed to be called directly by developers. Each PlayFab client SDK will eventually report this information automatically.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BodyTooLarge | 1068 |\n","href":"/services/playfab/api-references/rest/client/analytics/report-device-info"},{"title":"Write Character Event","openapi":"post /Client/WriteCharacterEvent","description":"Writes a character-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InvalidEventField | 1216 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/analytics/write-character-event"},{"title":"Write Player Event","openapi":"post /Client/WritePlayerEvent","description":"Writes a player-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEventField | 1216 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/analytics/write-player-event"},{"title":"Write Title Event","openapi":"post /Client/WriteTitleEvent","description":"Writes a title-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEventField | 1216 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/analytics/write-title-event"}]},{"group":"Authentication","pages":[{"title":"Get Photon Authentication Token","openapi":"post /Client/GetPhotonAuthenticationToken","description":"Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://learn.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PhotonApplicationNotAssociatedWithTitle | 1141 |\n| PhotonApplicationNotFound | 1140 |\n| PhotonNotEnabledForTitle | 1139 |\n","href":"/services/playfab/api-references/rest/client/authentication/get-photon-authentication-token"},{"title":"Get Title Public Key","openapi":"post /Client/GetTitlePublicKey","description":"Returns the title's base 64 encoded RSA CSP blob.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyBroken | 1291 |\n| InvalidSharedSecretKey | 1296 |\n| NoSharedSecretKeyConfigured | 1292 |\n","href":"/services/playfab/api-references/rest/client/authentication/get-title-public-key"},{"title":"Login With Android Device ID","openapi":"post /Client/LoginWithAndroidDeviceID","description":"Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerCreationDisabled | 22000 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| SignedRequestNotAllowed | 1302 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-android-device-id"},{"title":"Login With Apple","openapi":"post /Client/LoginWithApple","description":"Signs in the user with a Sign in with Apple identity token.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AppleNotEnabledForTitle | 1501 |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| TokenSigningKeyNotFound | 1568 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-apple"},{"title":"Login With Battle Net","openapi":"post /Client/LoginWithBattleNet","description":"Sign in the user with a Battle.net identity token\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| BattleNetNotEnabledForTitle | 1602 |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidAuthToken | 1326 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| InvalidTitleId | 1004 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-battle-net"},{"title":"Login With Custom ID","openapi":"post /Client/LoginWithCustomID","description":"Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptedRequestNotAllowed | 1301 |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerCreationDisabled | 22000 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| SignedRequestNotAllowed | 1302 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-custom-id"},{"title":"Login With Email Address","openapi":"post /Client/LoginWithEmailAddress","description":"Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEmailOrPassword | 1142 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-email-address"},{"title":"Login With Facebook","openapi":"post /Client/LoginWithFacebook","description":"Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FacebookAPIError | 1143 |\n| InvalidFacebookToken | 1013 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-facebook"},{"title":"Login With Facebook Instant Games Id","openapi":"post /Client/LoginWithFacebookInstantGamesId","description":"Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Requires Facebook Instant Games to be configured.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FacebookInstantGamesAuthNotConfiguredForTitle | 1397 |\n| InvalidFacebookInstantGamesSignature | 1396 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-facebook-instant-games-id"},{"title":"Login With Game Center","openapi":"post /Client/LoginWithGameCenter","description":"Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| GameCenterAuthenticationFailed | 1429 |\n| InvalidGameCenterAuthRequest | 1428 |\n| InvalidGameCenterId | 1554 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-game-center"},{"title":"Login With Google Account","openapi":"post /Client/LoginWithGoogleAccount","description":"Signs the user in using their Google account credentials\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| GoogleOAuthError | 1271 |\n| GoogleOAuthNoIdTokenIncludedInResponse | 1275 |\n| GoogleOAuthNotConfiguredForTitle | 1270 |\n| InvalidGoogleToken | 1026 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-google-account"},{"title":"Login With Google Play Games Services","openapi":"post /Client/LoginWithGooglePlayGamesServices","description":"Signs the user in using their Google Play Games account credentials\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| GoogleOAuthError | 1271 |\n| GoogleOAuthNotConfiguredForTitle | 1270 |\n| InvalidGooglePlayGamesServerAuthCode | 1545 |\n| InvalidGoogleToken | 1026 |\n| InvalidGoogleToken | 1026 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-google-play-games-services"},{"title":"Login With IOS Device ID","openapi":"post /Client/LoginWithIOSDeviceID","description":"Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerCreationDisabled | 22000 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| SignedRequestNotAllowed | 1302 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-ios-device-id"},{"title":"Login With Kongregate","openapi":"post /Client/LoginWithKongregate","description":"Signs the user in using a Kongregate player account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidKongregateToken | 1176 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-kongregate"},{"title":"Login With Nintendo Service Account","openapi":"post /Client/LoginWithNintendoServiceAccount","description":"Signs in the user with a Nintendo service account token.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-nintendo-service-account"},{"title":"Login With Nintendo Switch Device Id","openapi":"post /Client/LoginWithNintendoSwitchDeviceId","description":"Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerCreationDisabled | 22000 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-nintendo-switch-device-id"},{"title":"Login With OpenId Connect","openapi":"post /Client/LoginWithOpenIdConnect","description":"Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidIdentityProviderId | 1263 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-openid-connect"},{"title":"Login With PlayFab","openapi":"post /Client/LoginWithPlayFab","description":"Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSignature | 1273 |\n| InvalidUsernameOrPassword | 1003 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-playfab"},{"title":"Login With PSN","openapi":"post /Client/LoginWithPSN","description":"Signs the user in using a PlayStation™ Network authentication code, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidParams | 1000 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| PSNInaccessible | 1152 |\n| PSNNextGenNotConfiguredForTitle | 1617 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-psn"},{"title":"Login With Steam","openapi":"post /Client/LoginWithSteam","description":"Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSteamTicket | 1010 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| SteamNotEnabledForTitle | 1258 |\n| SteamUserNotFound | 1513 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-steam"},{"title":"Login With Twitch","openapi":"post /Client/LoginWithTwitch","description":"Signs the user in using a Twitch access token.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidTwitchToken | 1232 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| TwitchResponseError | 1233 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-twitch"},{"title":"Login With Xbox","openapi":"post /Client/LoginWithXbox","description":"Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| ExpiredXboxLiveToken | 1189 |\n| InvalidXboxLiveToken | 1188 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| SignedRequestNotAllowed | 1302 |\n| XboxInaccessible | 1339 |\n| XboxRejectedXSTSExchangeRequest | 1343 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/client/authentication/login-with-xbox"},{"title":"Register PlayFab User","openapi":"post /Client/RegisterPlayFabUser","description":"Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply a username and an email address.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailAddressNotAvailable | 1006 |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidEmailAddress | 1005 |\n| InvalidPartnerResponse | 1193 |\n| InvalidPassword | 1008 |\n| InvalidUsername | 1007 |\n| NameNotAvailable | 1058 |\n| ProfaneDisplayName | 1234 |\n| SignedRequestNotAllowed | 1302 |\n| UsernameNotAvailable | 1009 |\n","href":"/services/playfab/api-references/rest/client/authentication/register-playfab-user"},{"title":"Set Player Secret","openapi":"post /Client/SetPlayerSecret","description":"Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's secret use the Admin or Server API method SetPlayerSecret.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n","href":"/services/playfab/api-references/rest/client/authentication/set-player-secret"}]},{"group":"Character Data","pages":[{"title":"Get Character Data","openapi":"post /Client/GetCharacterData","description":"Retrieves the title-specific custom data for the character which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/client/character-data/get-character-data"},{"title":"Get Character Read Only Data","openapi":"post /Client/GetCharacterReadOnlyData","description":"Retrieves the title-specific custom data for the character which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/client/character-data/get-character-read-only-data"},{"title":"Update Character Data","openapi":"post /Client/UpdateCharacterData","description":"Creates and updates the title-specific custom data for the user's character which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n","href":"/services/playfab/api-references/rest/client/character-data/update-character-data"}]},{"group":"Characters","pages":[{"title":"Get All Users Characters","openapi":"post /Client/GetAllUsersCharacters","description":"Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.","href":"/services/playfab/api-references/rest/client/characters/get-all-users-characters"},{"title":"Get Character Leaderboard","openapi":"post /Client/GetCharacterLeaderboard","description":"Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/characters/get-character-leaderboard"},{"title":"Get Character Statistics","openapi":"post /Client/GetCharacterStatistics","description":"Retrieves the details of all title-specific statistics for the user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/characters/get-character-statistics"},{"title":"Get Leaderboard Around Character","openapi":"post /Client/GetLeaderboardAroundCharacter","description":"Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/characters/get-leaderboard-around-character"},{"title":"Get Leaderboard For User Characters","openapi":"post /Client/GetLeaderboardForUserCharacters","description":"Retrieves a list of all of the user's characters for the given statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/characters/get-leaderboard-for-user-characters"},{"title":"Grant Character To User","openapi":"post /Client/GrantCharacterToUser","description":"Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidItemProperties | 1091 |\n| ItemNotOwned | 1048 |\n","href":"/services/playfab/api-references/rest/client/characters/grant-character-to-user"},{"title":"Update Character Statistics","openapi":"post /Client/UpdateCharacterStatistics","description":"Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| CharacterNotFound | 1135 |\n| InvalidCharacterStatistics | 1138 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/characters/update-character-statistics"}]},{"group":"Content","pages":[{"title":"Get Content Download Url","openapi":"post /Client/GetContentDownloadUrl","description":"This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ContentS3OriginBucketNotConfigured | 1299 |\n","href":"/services/playfab/api-references/rest/client/content/get-content-download-url"}]},{"group":"Friend List Management","pages":[{"title":"Add Friend","openapi":"post /Client/AddFriend","description":"Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UsersAlreadyFriends | 1183 |\n","href":"/services/playfab/api-references/rest/client/friend-list-management/add-friend"},{"title":"Get Friends List","openapi":"post /Client/GetFriendsList","description":"Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidXboxLiveToken | 1188 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/client/friend-list-management/get-friends-list"},{"title":"Remove Friend","openapi":"post /Client/RemoveFriend","description":"Removes a specified user from the friend list of the local user","href":"/services/playfab/api-references/rest/client/friend-list-management/remove-friend"},{"title":"Set Friend Tags","openapi":"post /Client/SetFriendTags","description":"Updates the tag list for a specified user in the friend list of the local user","href":"/services/playfab/api-references/rest/client/friend-list-management/set-friend-tags"}]},{"group":"Platform Specific Methods","pages":[{"title":"Android Device Push Notification Registration","openapi":"post /Client/AndroidDevicePushNotificationRegistration","description":"Registers the Android device to receive push notifications\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| NoPushNotificationARNForTitle | 1083 |\n| PushServiceError | 1095 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/android-device-push-notification-registration"},{"title":"Consume Microsoft Store Entitlements","openapi":"post /Client/ConsumeMicrosoftStoreEntitlements","description":"Grants the player's current entitlements from Microsoft Store's Collection API\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/consume-microsoft-store-entitlements"},{"title":"Consume PS5 Entitlements","openapi":"post /Client/ConsumePS5Entitlements","description":"Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as PlayFab items\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DownstreamServiceUnavailable | 1127 |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/consume-ps5-entitlements"},{"title":"Consume PSN Entitlements","openapi":"post /Client/ConsumePSNEntitlements","description":"Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DownstreamServiceUnavailable | 1127 |\n| ExpiredAuthToken | 1153 |\n| FailedToGetEntitlements | 1154 |\n| ProductDisabledForTitle | 1609 |\n| PSNInaccessible | 1152 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/consume-psn-entitlements"},{"title":"Consume Xbox Entitlements","openapi":"post /Client/ConsumeXboxEntitlements","description":"Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExpiredXboxLiveToken | 1189 |\n| InvalidXboxLiveToken | 1188 |\n| ProductDisabledForTitle | 1609 |\n| XboxInaccessible | 1339 |\n| XboxRejectedXSTSExchangeRequest | 1343 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/consume-xbox-entitlements"},{"title":"Refresh PSN Auth Token","openapi":"post /Client/RefreshPSNAuthToken","description":"Uses the supplied OAuth code to refresh the internally cached player PlayStation™ Network auth token\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DownstreamServiceUnavailable | 1127 |\n| InvalidPSNAuthCode | 1092 |\n| PSNInaccessible | 1152 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/refresh-psn-auth-token"},{"title":"Register For IOS Push Notification","openapi":"post /Client/RegisterForIOSPushNotification","description":"Registers the iOS device to receive push notifications\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| NoPushNotificationARNForTitle | 1083 |\n| PushServiceError | 1095 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/register-for-ios-push-notification"},{"title":"Restore IOS Purchases","openapi":"post /Client/RestoreIOSPurchases","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Restores all in-app purchases based on the given restore receipt\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidBundleID | 1098 |\n| InvalidCurrencyCode | 1179 |\n| InvalidEnvironmentForReceipt | 1300 |\n| InvalidReceipt | 1021 |\n| InvalidVirtualCurrency | 1051 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n| ReceiptContainsMultipleInAppItems | 1097 |\n| ReceiptDoesNotContainInAppItems | 1096 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/restore-ios-purchases"},{"title":"Validate Amazon IAP Receipt","openapi":"post /Client/ValidateAmazonIAPReceipt","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AmazonValidationError | 1150 |\n| InvalidReceipt | 1021 |\n| MissingAmazonSharedKey | 1149 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/validate-amazon-iap-receipt"},{"title":"Validate Google Play Purchase","openapi":"post /Client/ValidateGooglePlayPurchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates a Google Play purchase and gives the corresponding item to the player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GoogleAPIServiceUnavailable | 1534 |\n| GoogleAPIServiceUnknownError | 1535 |\n| GoogleServiceAccountFailedAuth | 1533 |\n| GoogleServiceAccountInvalid | 1332 |\n| InvalidBundleID | 1098 |\n| InvalidProductForSubscription | 1338 |\n| InvalidPurchaseTransactionStatus | 1081 |\n| InvalidReceipt | 1021 |\n| MissingTitleGoogleProperties | 1090 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| NoRealMoneyPriceForCatalogItem | 1180 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n| ReceiptCancelled | 1023 |\n| SubscriptionAlreadyTaken | 1340 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/validate-google-play-purchase"},{"title":"Validate IOS Receipt","openapi":"post /Client/ValidateIOSReceipt","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidBundleID | 1098 |\n| InvalidCurrencyCode | 1179 |\n| InvalidEnvironmentForReceipt | 1300 |\n| InvalidProductForSubscription | 1338 |\n| InvalidReceipt | 1021 |\n| InvalidVirtualCurrency | 1051 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n| ReceiptContainsMultipleInAppItems | 1097 |\n| ReceiptDoesNotContainInAppItems | 1096 |\n| SubscriptionAlreadyTaken | 1340 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/validate-ios-receipt"},{"title":"Validate Windows Store Receipt","openapi":"post /Client/ValidateWindowsStoreReceipt","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidReceipt | 1021 |\n| MissingAmazonSharedKey | 1149 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n","href":"/services/playfab/api-references/rest/client/platform-specific-methods/validate-windows-store-receipt"}]},{"group":"Player Data Management","pages":[{"title":"Delete Player Custom Properties","openapi":"post /Client/DeletePlayerCustomProperties","description":"Deletes title-specific custom properties for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/delete-player-custom-properties"},{"title":"Get Friend Leaderboard","openapi":"post /Client/GetFriendLeaderboard","description":"Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidXboxLiveToken | 1188 |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/get-friend-leaderboard"},{"title":"Get Friend Leaderboard Around Player","openapi":"post /Client/GetFriendLeaderboardAroundPlayer","description":"Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidXboxLiveToken | 1188 |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/get-friend-leaderboard-around-player"},{"title":"Get Leaderboard","openapi":"post /Client/GetLeaderboard","description":"Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/get-leaderboard"},{"title":"Get Leaderboard Around Player","openapi":"post /Client/GetLeaderboardAroundPlayer","description":"Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/get-leaderboard-around-player"},{"title":"Get Player Custom Property","openapi":"post /Client/GetPlayerCustomProperty","description":"Retrieves a title-specific custom property value for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesPropertyDoesNotExist | 19007 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/get-player-custom-property"},{"title":"Get Player Statistics","openapi":"post /Client/GetPlayerStatistics","description":"Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/get-player-statistics"},{"title":"Get Player Statistic Versions","openapi":"post /Client/GetPlayerStatisticVersions","description":"Retrieves the information on the available versions of the specified statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/get-player-statistic-versions"},{"title":"Get User Data","openapi":"post /Client/GetUserData","description":"Retrieves the title-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/rest/client/player-data-management/get-user-data"},{"title":"Get User Publisher Data","openapi":"post /Client/GetUserPublisherData","description":"Retrieves the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/get-user-publisher-data"},{"title":"Get User Publisher Read Only Data","openapi":"post /Client/GetUserPublisherReadOnlyData","description":"Retrieves the publisher-specific custom data for the user which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/get-user-publisher-read-only-data"},{"title":"Get User Read Only Data","openapi":"post /Client/GetUserReadOnlyData","description":"Retrieves the title-specific custom data for the user which can only be read by the client","href":"/services/playfab/api-references/rest/client/player-data-management/get-user-read-only-data"},{"title":"List Player Custom Properties","openapi":"post /Client/ListPlayerCustomProperties","description":"Retrieves title-specific custom property values for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/list-player-custom-properties"},{"title":"Update Player Custom Properties","openapi":"post /Client/UpdatePlayerCustomProperties","description":"Updates the title-specific custom property values for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesDuplicatePropertyName | 19006 |\n| PlayerCustomPropertiesPropertyCountTooHigh | 19005 |\n| PlayerCustomPropertiesPropertyNameIsInvalid | 19001 |\n| PlayerCustomPropertiesPropertyNameTooLong | 19000 |\n| PlayerCustomPropertiesStringPropertyValueTooLong | 19002 |\n| PlayerCustomPropertiesValueIsInvalidType | 19003 |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/update-player-custom-properties"},{"title":"Update Player Statistics","openapi":"post /Client/UpdatePlayerStatistics","description":"Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| DuplicateStatisticName | 1253 |\n| ProductDisabledForTitle | 1609 |\n| StatisticCountLimitExceeded | 1203 |\n| StatisticNameConflict | 1196 |\n| StatisticNotFound | 1195 |\n| StatisticValueAggregationOverflow | 1308 |\n| StatisticVersionClosedForWrites | 1197 |\n| StatisticVersionInvalid | 1198 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/update-player-statistics"},{"title":"Update User Data","openapi":"post /Client/UpdateUserData","description":"Creates and updates the title-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/rest/client/player-data-management/update-user-data"},{"title":"Update User Publisher Data","openapi":"post /Client/UpdateUserPublisherData","description":"Creates and updates the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/client/player-data-management/update-user-publisher-data"}]},{"group":"Player Item Management","pages":[{"title":"Add User Virtual Currency","openapi":"post /Client/AddUserVirtualCurrency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the user's balance of the specified virtual currency by the stated amount\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/add-user-virtual-currency"},{"title":"Confirm Purchase","openapi":"post /Client/ConfirmPurchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FailedByPaymentProvider | 1015 |\n| ProductDisabledForTitle | 1609 |\n| PurchaseDoesNotExist | 1080 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/confirm-purchase"},{"title":"Consume Item","openapi":"post /Client/ConsumeItem","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InvalidItemProperties | 1091 |\n| ItemNotFound | 1047 |\n| NoRemainingUses | 1062 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/consume-item"},{"title":"Get Character Inventory","openapi":"post /Client/GetCharacterInventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified character's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/get-character-inventory"},{"title":"Get Payment Token","openapi":"post /Client/GetPaymentToken","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidPaymentProvider | 1063 |\n| NoPartnerEnabled | 1192 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/get-payment-token"},{"title":"Get Purchase","openapi":"post /Client/GetPurchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that are still active.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| PurchaseDoesNotExist | 1080 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/get-purchase"},{"title":"Get User Inventory","openapi":"post /Client/GetUserInventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the user's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/get-user-inventory"},{"title":"Pay For Purchase","openapi":"post /Client/PayForPurchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Selects a payment option for purchase order created via StartPurchase\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DuplicatePurchaseTransactionId | 1489 |\n| FailedByPaymentProvider | 1015 |\n| InsufficientFunds | 1059 |\n| InvalidPaymentProvider | 1063 |\n| InvalidPurchaseTransactionStatus | 1081 |\n| ProductDisabledForTitle | 1609 |\n| PurchaseDoesNotExist | 1080 |\n| PurchaseInitializationFailure | 1064 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/pay-for-purchase"},{"title":"Purchase Item","openapi":"post /Client/PurchaseItem","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InsufficientFunds | 1059 |\n| InvalidVirtualCurrency | 1051 |\n| ItemNotFound | 1047 |\n| OperationNotSupportedForPlatform | 1219 |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n| WrongPrice | 1053 |\n| WrongVirtualCurrency | 1052 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/purchase-item"},{"title":"Redeem Coupon","openapi":"post /Client/RedeemCoupon","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| CharacterNotFound | 1135 |\n| CouponAlreadyRedeemed | 1226 |\n| CouponCodeNotFound | 1016 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/redeem-coupon"},{"title":"Start Purchase","openapi":"post /Client/StartPurchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Creates an order for a list of items from the title catalog\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/start-purchase"},{"title":"Subtract User Virtual Currency","openapi":"post /Client/SubtractUserVirtualCurrency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/subtract-user-virtual-currency"},{"title":"Unlock Container Instance","openapi":"post /Client/UnlockContainerInstance","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ContainerKeyInvalid | 1205 |\n| ContainerNotOwned | 1018 |\n| InvalidContainerItem | 1017 |\n| InvalidItemIdInTable | 1020 |\n| InvalidItemProperties | 1091 |\n| KeyNotOwned | 1019 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/unlock-container-instance"},{"title":"Unlock Container Item","openapi":"post /Client/UnlockContainerItem","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ContainerKeyInvalid | 1205 |\n| ContainerNotOwned | 1018 |\n| InvalidContainerItem | 1017 |\n| InvalidItemIdInTable | 1020 |\n| InvalidItemProperties | 1091 |\n| KeyNotOwned | 1019 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/player-item-management/unlock-container-item"}]},{"group":"Play Stream","pages":[{"title":"Get Player Segments","openapi":"post /Client/GetPlayerSegments","description":"List all segments that a player currently belongs to at this moment in time.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/play-stream/get-player-segments"},{"title":"Get Player Tags","openapi":"post /Client/GetPlayerTags","description":"Get all tags with a given Namespace (optional) from a player profile.","href":"/services/playfab/api-references/rest/client/play-stream/get-player-tags"}]},{"group":"Server-Side Cloud Script","pages":[{"title":"Execute Cloud Script","openapi":"post /Client/ExecuteCloudScript","description":"Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The PlayFab ID is the entity ID of the player's master_player_account entity.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAPIRequestCountExceeded | 1209 |\n| CloudScriptAPIRequestError | 1210 |\n| CloudScriptFunctionArgumentSizeExceeded | 1208 |\n| CloudScriptHTTPRequestError | 1211 |\n| CloudScriptNotFound | 1136 |\n| JavascriptException | 1099 |\n| TitleDeleted | 1347 |\n","href":"/services/playfab/api-references/rest/client/server-side-cloud-script/execute-cloud-script"}]},{"group":"Shared Group Data","pages":[{"title":"Add Shared Group Members","openapi":"post /Client/AddSharedGroupMembers","description":"Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| UserAlreadyAdded | 1235 |\n","href":"/services/playfab/api-references/rest/client/shared-group-data/add-shared-group-members"},{"title":"Create Shared Group","openapi":"post /Client/CreateSharedGroup","description":"Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/shared-group-data/create-shared-group"},{"title":"Get Shared Group Data","openapi":"post /Client/GetSharedGroupData","description":"Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/shared-group-data/get-shared-group-data"},{"title":"Remove Shared Group Members","openapi":"post /Client/RemoveSharedGroupMembers","description":"Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/shared-group-data/remove-shared-group-members"},{"title":"Update Shared Group Data","openapi":"post /Client/UpdateSharedGroupData","description":"Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/shared-group-data/update-shared-group-data"}]},{"group":"Title-Wide Data Management","pages":[{"title":"Get Catalog Items","openapi":"post /Client/GetCatalogItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/title-wide-data-management/get-catalog-items"},{"title":"Get Publisher Data","openapi":"post /Client/GetPublisherData","description":"Retrieves the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/client/title-wide-data-management/get-publisher-data"},{"title":"Get Store Items","openapi":"post /Client/GetStoreItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items defined for the specified store, including all prices defined\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","href":"/services/playfab/api-references/rest/client/title-wide-data-management/get-store-items"},{"title":"Get Time","openapi":"post /Client/GetTime","description":"Retrieves the current server time\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/client/title-wide-data-management/get-time"},{"title":"Get Title Data","openapi":"post /Client/GetTitleData","description":"Retrieves the key-value store of custom title settings","href":"/services/playfab/api-references/rest/client/title-wide-data-management/get-title-data"},{"title":"Get Title News","openapi":"post /Client/GetTitleNews","description":"Retrieves the title news feed, as configured in the developer portal","href":"/services/playfab/api-references/rest/client/title-wide-data-management/get-title-news"}]},{"group":"Trading","pages":[{"title":"Accept Trade","openapi":"post /Client/AcceptTrade","description":"Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TradeAcceptedCatalogItemInvalid | 1170 |\n| TradeAcceptedItemsMismatch | 1175 |\n| TradeAcceptingUserNotAllowed | 1156 |\n| TradeAllowedUsersInvalid | 1171 |\n| TradeAlreadyFilled | 1163 |\n| TradeCancelled | 1162 |\n| TradeDoesNotExist | 1161 |\n| TradeInventoryItemDoesNotExist | 1172 |\n| TradeInventoryItemExpired | 1165 |\n| TradeInventoryItemInvalidStatus | 1169 |\n| TradeInventoryItemIsAssignedToCharacter | 1157 |\n| TradeInventoryItemIsBundle | 1158 |\n| TradeInventoryItemIsConsumed | 1173 |\n| TradeInventoryItemIsNotTradable | 1181 |\n| TradeInventoryItemIsStackable | 1174 |\n| TradeStatusNotValidForAccepting | 1160 |\n| TradeWaitForStatusTimeout | 1164 |\n","href":"/services/playfab/api-references/rest/client/trading/accept-trade"},{"title":"Cancel Trade","openapi":"post /Client/CancelTrade","description":"Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player).\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TradeAlreadyFilled | 1163 |\n| TradeCancelled | 1162 |\n| TradeDoesNotExist | 1161 |\n| TradeStatusNotValidForCancelling | 1159 |\n| TradeWaitForStatusTimeout | 1164 |\n","href":"/services/playfab/api-references/rest/client/trading/cancel-trade"},{"title":"Get Player Trades","openapi":"post /Client/GetPlayerTrades","description":"Gets all trades the player has either opened or accepted, optionally filtered by trade status.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/client/trading/get-player-trades"},{"title":"Get Trade Status","openapi":"post /Client/GetTradeStatus","description":"Gets the current status of an existing trade.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TradeDoesNotExist | 1161 |\n","href":"/services/playfab/api-references/rest/client/trading/get-trade-status"},{"title":"Open Trade","openapi":"post /Client/OpenTrade","description":"Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TradeAcceptedCatalogItemInvalid | 1170 |\n| TradeAcceptedCatalogItemIsNotTradable | 1182 |\n| TradeAcceptedItemIsBundle | 1167 |\n| TradeAllowedUsersInvalid | 1171 |\n| TradeInventoryItemDoesNotExist | 1172 |\n| TradeInventoryItemExpired | 1165 |\n| TradeInventoryItemInvalidStatus | 1169 |\n| TradeInventoryItemIsAssignedToCharacter | 1157 |\n| TradeInventoryItemIsBundle | 1158 |\n| TradeInventoryItemIsConsumed | 1173 |\n| TradeInventoryItemIsNotTradable | 1181 |\n| TradeInventoryItemIsStackable | 1174 |\n| TradeMissingOfferedAndAcceptedItems | 1166 |\n| TradeWaitForStatusTimeout | 1164 |\n","href":"/services/playfab/api-references/rest/client/trading/open-trade"}]},{"group":"Trading","pages":[{"title":"Accept Trade","description":"Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TradeAcceptedCatalogItemInvalid | 1170 |\n| TradeAcceptedItemsMismatch | 1175 |\n| TradeAcceptingUserNotAllowed | 1156 |\n| TradeAllowedUsersInvalid | 1171 |\n| TradeAlreadyFilled | 1163 |\n| TradeCancelled | 1162 |\n| TradeDoesNotExist | 1161 |\n| TradeInventoryItemDoesNotExist | 1172 |\n| TradeInventoryItemExpired | 1165 |\n| TradeInventoryItemInvalidStatus | 1169 |\n| TradeInventoryItemIsAssignedToCharacter | 1157 |\n| TradeInventoryItemIsBundle | 1158 |\n| TradeInventoryItemIsConsumed | 1173 |\n| TradeInventoryItemIsNotTradable | 1181 |\n| TradeInventoryItemIsStackable | 1174 |\n| TradeStatusNotValidForAccepting | 1160 |\n| TradeWaitForStatusTimeout | 1164 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/AcceptTrade","href":"/api-reference/trading/accept-trade","autogeneratedByOpenApi":true},{"title":"Cancel Trade","description":"Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player).\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TradeAlreadyFilled | 1163 |\n| TradeCancelled | 1162 |\n| TradeDoesNotExist | 1161 |\n| TradeStatusNotValidForCancelling | 1159 |\n| TradeWaitForStatusTimeout | 1164 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/CancelTrade","href":"/api-reference/trading/cancel-trade","autogeneratedByOpenApi":true},{"title":"Get Player Trades","description":"Gets all trades the player has either opened or accepted, optionally filtered by trade status.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetPlayerTrades","href":"/api-reference/trading/get-player-trades","autogeneratedByOpenApi":true},{"title":"Get Trade Status","description":"Gets the current status of an existing trade.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TradeDoesNotExist | 1161 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetTradeStatus","href":"/api-reference/trading/get-trade-status","autogeneratedByOpenApi":true},{"title":"Open Trade","description":"Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| TradeAcceptedCatalogItemInvalid | 1170 |\n| TradeAcceptedCatalogItemIsNotTradable | 1182 |\n| TradeAcceptedItemIsBundle | 1167 |\n| TradeAllowedUsersInvalid | 1171 |\n| TradeInventoryItemDoesNotExist | 1172 |\n| TradeInventoryItemExpired | 1165 |\n| TradeInventoryItemInvalidStatus | 1169 |\n| TradeInventoryItemIsAssignedToCharacter | 1157 |\n| TradeInventoryItemIsBundle | 1158 |\n| TradeInventoryItemIsConsumed | 1173 |\n| TradeInventoryItemIsNotTradable | 1181 |\n| TradeInventoryItemIsStackable | 1174 |\n| TradeMissingOfferedAndAcceptedItems | 1166 |\n| TradeWaitForStatusTimeout | 1164 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/OpenTrade","href":"/api-reference/trading/open-trade","autogeneratedByOpenApi":true}]},{"group":"Friend List Management","pages":[{"title":"Add Friend","description":"Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UsersAlreadyFriends | 1183 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddFriend","href":"/api-reference/friend-list-management/add-friend","autogeneratedByOpenApi":true},{"title":"Get Friends List","description":"Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| InvalidXboxLiveToken | 1188 |\n| PlayerSecretNotConfigured | 1323 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetFriendsList","href":"/api-reference/friend-list-management/get-friends-list","autogeneratedByOpenApi":true},{"title":"Remove Friend","description":"Removes the specified friend from the the user's friend list\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RemoveFriend","href":"/api-reference/friend-list-management/remove-friend","autogeneratedByOpenApi":true},{"title":"Set Friend Tags","description":"Updates the tag list for a specified user in the friend list of another user","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetFriendTags","href":"/api-reference/friend-list-management/set-friend-tags","autogeneratedByOpenApi":true}]},{"group":"Account Management","pages":[{"title":"Add Generic ID","description":"Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| IdentifierAlreadyClaimed | 1238 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddGenericID","href":"/api-reference/account-management/add-generic-id","autogeneratedByOpenApi":true},{"title":"Add Or Update Contact Email","description":"Adds or updates a contact email to the specified player's profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddOrUpdateContactEmail","href":"/api-reference/account-management/add-or-update-contact-email","autogeneratedByOpenApi":true},{"title":"Add Username Password","description":"Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| EmailAddressNotAvailable | 1006 |\n| InvalidEmailAddress | 1005 |\n| InvalidPassword | 1008 |\n| InvalidUsername | 1007 |\n| UsernameNotAvailable | 1009 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/AddUsernamePassword","href":"/api-reference/account-management/add-username-password","autogeneratedByOpenApi":true},{"title":"Get Account Info","description":"Retrieves the user's PlayFab account details","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetAccountInfo","href":"/api-reference/account-management/get-account-info","autogeneratedByOpenApi":true},{"title":"Get Player Combined Info","description":"Retrieves all of the user's different kinds of info.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetPlayerCombinedInfo","href":"/api-reference/account-management/get-player-combined-info","autogeneratedByOpenApi":true},{"title":"Get Player Profile","description":"Retrieves the player's profile\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerNotInGame | 1033 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerProfile","href":"/api-reference/account-management/get-player-profile","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Battle Net Account Ids","description":"Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromBattleNetAccountIds","href":"/api-reference/account-management/get-play-fab-ids-from-battle-net-account-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Facebook IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromFacebookIDs","href":"/api-reference/account-management/get-play-fab-ids-from-facebook-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Facebook Instant Games Ids","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromFacebookInstantGamesIds","href":"/api-reference/account-management/get-play-fab-ids-from-facebook-instant-games-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Game Center IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier).","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetPlayFabIDsFromGameCenterIDs","href":"/api-reference/account-management/get-play-fab-ids-from-game-center-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Generic IDs","description":"Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromGenericIDs","href":"/api-reference/account-management/get-play-fab-ids-from-generic-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Google IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as \"id\" in the Google+ People API calls.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetPlayFabIDsFromGoogleIDs","href":"/api-reference/account-management/get-play-fab-ids-from-google-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Google Play Games Player IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games identifiers are the IDs for the user accounts, available as \"playerId\" in the Google Play Games Services - Players API calls.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetPlayFabIDsFromGooglePlayGamesPlayerIDs","href":"/api-reference/account-management/get-play-fab-ids-from-google-play-games-player-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Kongregate IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as \"user_id\" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId).","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetPlayFabIDsFromKongregateIDs","href":"/api-reference/account-management/get-play-fab-ids-from-kongregate-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Nintendo Service Account Ids","description":"Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromNintendoServiceAccountIds","href":"/api-reference/account-management/get-play-fab-ids-from-nintendo-service-account-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Nintendo Switch Device Ids","description":"Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromNintendoSwitchDeviceIds","href":"/api-reference/account-management/get-play-fab-ids-from-nintendo-switch-device-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Open Id Subject Identifiers","description":"Retrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId subject identifier is the OpenId issuer plus the OpenId subject for the player, as specified by the title when the OpenId identifier was added to the player account.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromOpenIdSubjectIdentifiers","href":"/api-reference/account-management/get-play-fab-ids-from-open-id-subject-identifiers","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From PSN Account IDs","description":"Retrieves the unique PlayFab identifiers for the given set of PlayStation™ Network identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromPSNAccountIDs","href":"/api-reference/account-management/get-play-fab-ids-from-psn-account-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From PSN Online IDs","description":"Retrieves the unique PlayFab identifiers for the given set of PlayStation™ Network identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromPSNOnlineIDs","href":"/api-reference/account-management/get-play-fab-ids-from-psn-online-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Steam IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromSteamIDs","href":"/api-reference/account-management/get-play-fab-ids-from-steam-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Steam Names","description":"Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromSteamNames","href":"/api-reference/account-management/get-play-fab-ids-from-steam-names","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Twitch IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as \"_id\" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromTwitchIDs","href":"/api-reference/account-management/get-play-fab-ids-from-twitch-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Xbox Live IDs","description":"Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromXboxLiveIDs","href":"/api-reference/account-management/get-play-fab-ids-from-xbox-live-ids","autogeneratedByOpenApi":true},{"title":"Link Android Device ID","description":"Links the Android device identifier to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| LinkedDeviceAlreadyClaimed | 1118 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkAndroidDeviceID","href":"/api-reference/account-management/link-android-device-id","autogeneratedByOpenApi":true},{"title":"Link Apple","description":"Links the Apple account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| AppleNotEnabledForTitle | 1501 |\n| InvalidIdentityProviderId | 1263 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| TokenSigningKeyNotFound | 1568 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkApple","href":"/api-reference/account-management/link-apple","autogeneratedByOpenApi":true},{"title":"Link Battle Net Account","description":"Links the Battle.net account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| BattleNetNotEnabledForTitle | 1602 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkBattleNetAccount","href":"/api-reference/account-management/link-battle-net-account","autogeneratedByOpenApi":true},{"title":"Link Custom ID","description":"Links the custom identifier, generated by the title, to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkCustomID","href":"/api-reference/account-management/link-custom-id","autogeneratedByOpenApi":true},{"title":"Link Facebook Account","description":"Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| AccountNotFound | 1001 |\n| FacebookAPIError | 1143 |\n| InvalidFacebookToken | 1013 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkFacebookAccount","href":"/api-reference/account-management/link-facebook-account","autogeneratedByOpenApi":true},{"title":"Link Facebook Instant Games Id","description":"Links the Facebook Instant Games Id to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| FacebookInstantGamesAuthNotConfiguredForTitle | 1397 |\n| InvalidFacebookInstantGamesSignature | 1396 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkFacebookInstantGamesId","href":"/api-reference/account-management/link-facebook-instant-games-id","autogeneratedByOpenApi":true},{"title":"Link Game Center Account","description":"Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| GameCenterAuthenticationFailed | 1429 |\n| InvalidGameCenterAuthRequest | 1428 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkGameCenterAccount","href":"/api-reference/account-management/link-game-center-account","autogeneratedByOpenApi":true},{"title":"Link Google Account","description":"Links the currently signed-in user account to their Google account, using their Google account credentials\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| GoogleOAuthError | 1271 |\n| GoogleOAuthNoIdTokenIncludedInResponse | 1275 |\n| GoogleOAuthNotConfiguredForTitle | 1270 |\n| InvalidGoogleToken | 1026 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkGoogleAccount","href":"/api-reference/account-management/link-google-account","autogeneratedByOpenApi":true},{"title":"Link Google Play Games Services Account","description":"Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account credentials\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| GoogleOAuthError | 1271 |\n| GoogleOAuthNotConfiguredForTitle | 1270 |\n| InvalidGooglePlayGamesServerAuthCode | 1545 |\n| InvalidGoogleToken | 1026 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkGooglePlayGamesServicesAccount","href":"/api-reference/account-management/link-google-play-games-services-account","autogeneratedByOpenApi":true},{"title":"Link IOS Device ID","description":"Links the vendor-specific iOS device identifier to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| LinkedDeviceAlreadyClaimed | 1118 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkIOSDeviceID","href":"/api-reference/account-management/link-ios-device-id","autogeneratedByOpenApi":true},{"title":"Link Kongregate","description":"Links the Kongregate identifier to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidKongregateToken | 1176 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkKongregate","href":"/api-reference/account-management/link-kongregate","autogeneratedByOpenApi":true},{"title":"Link Nintendo Service Account","description":"Links the Nintendo account associated with the token to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidIdentityProviderId | 1263 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkNintendoServiceAccount","href":"/api-reference/account-management/link-nintendo-service-account","autogeneratedByOpenApi":true},{"title":"Link Nintendo Switch Device Id","description":"Links the NintendoSwitchDeviceId to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkNintendoSwitchDeviceId","href":"/api-reference/account-management/link-nintendo-switch-device-id","autogeneratedByOpenApi":true},{"title":"Link Open Id Connect","description":"Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an Open ID Connect provider and the OpenId Connect JWT from that provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountLinkedToABannedPlayer | 1613 |\n| InvalidIdentityProviderId | 1263 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkOpenIdConnect","href":"/api-reference/account-management/link-open-id-connect","autogeneratedByOpenApi":true},{"title":"Link PSN Account","description":"Links the PlayStation™ Network account associated with the provided access code to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| DownstreamServiceUnavailable | 1127 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidParams | 1000 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| PSNInaccessible | 1152 |\n| PSNNextGenNotConfiguredForTitle | 1617 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkPSNAccount","href":"/api-reference/account-management/link-psn-account","autogeneratedByOpenApi":true},{"title":"Link Steam Account","description":"Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| InvalidSteamTicket | 1010 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| SteamNotEnabledForTitle | 1258 |\n| SteamUserNotFound | 1513 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkSteamAccount","href":"/api-reference/account-management/link-steam-account","autogeneratedByOpenApi":true},{"title":"Link Twitch","description":"Links the Twitch account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountLinkedToABannedPlayer | 1613 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidTwitchToken | 1232 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| TwitchResponseError | 1233 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LinkTwitch","href":"/api-reference/account-management/link-twitch","autogeneratedByOpenApi":true},{"title":"Link Xbox Account","description":"Links the Xbox Live account associated with the provided access code to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidXboxLiveToken | 1188 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkXboxAccount","href":"/api-reference/account-management/link-xbox-account","autogeneratedByOpenApi":true},{"title":"Remove Contact Email","description":"Removes a contact email from the player's profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/RemoveContactEmail","href":"/api-reference/account-management/remove-contact-email","autogeneratedByOpenApi":true},{"title":"Remove Generic ID","description":"Removes the specified generic service identifier from the player's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| IdentifierNotLinked | 1239 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RemoveGenericID","href":"/api-reference/account-management/remove-generic-id","autogeneratedByOpenApi":true},{"title":"Report Player","description":"Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ReportPlayer","href":"/api-reference/account-management/report-player","autogeneratedByOpenApi":true},{"title":"Send Account Recovery Email","description":"Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailRecipientBlacklisted | 1427 |\n| InvalidEmailAddress | 1005 |\n| NoContactEmailAddressFound | 1325 |\n| SmtpAddonNotEnabled | 1341 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/SendAccountRecoveryEmail","href":"/api-reference/account-management/send-account-recovery-email","autogeneratedByOpenApi":true},{"title":"Unlink Android Device ID","description":"Unlinks the related Android device identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| DeviceNotLinked | 1120 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UnlinkAndroidDeviceID","href":"/api-reference/account-management/unlink-android-device-id","autogeneratedByOpenApi":true},{"title":"Unlink Apple","description":"Unlinks the related Apple account from the specified user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| AppleNotEnabledForTitle | 1501 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkApple","href":"/api-reference/account-management/unlink-apple","autogeneratedByOpenApi":true},{"title":"Unlink Battle Net Account","description":"Unlinks the related Battle.net account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| BattleNetNotEnabledForTitle | 1602 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkBattleNetAccount","href":"/api-reference/account-management/unlink-battle-net-account","autogeneratedByOpenApi":true},{"title":"Unlink Custom ID","description":"Unlinks the related custom identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| CustomIdNotLinked | 1185 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UnlinkCustomID","href":"/api-reference/account-management/unlink-custom-id","autogeneratedByOpenApi":true},{"title":"Unlink Facebook Account","description":"Unlinks the related Facebook account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkFacebookAccount","href":"/api-reference/account-management/unlink-facebook-account","autogeneratedByOpenApi":true},{"title":"Unlink Facebook Instant Games Id","description":"Unlinks the related Facebook Instant Games identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| FacebookInstantGamesIdNotLinked | 1395 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkFacebookInstantGamesId","href":"/api-reference/account-management/unlink-facebook-instant-games-id","autogeneratedByOpenApi":true},{"title":"Unlink Game Center Account","description":"Unlinks the related Game Center account from the specified user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkGameCenterAccount","href":"/api-reference/account-management/unlink-game-center-account","autogeneratedByOpenApi":true},{"title":"Unlink Google Account","description":"Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UnlinkGoogleAccount","href":"/api-reference/account-management/unlink-google-account","autogeneratedByOpenApi":true},{"title":"Unlink Google Play Games Services Account","description":"Unlinks the related Google Play Games account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UnlinkGooglePlayGamesServicesAccount","href":"/api-reference/account-management/unlink-google-play-games-services-account","autogeneratedByOpenApi":true},{"title":"Unlink IOS Device ID","description":"Unlinks the related iOS device identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| DeviceNotLinked | 1120 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UnlinkIOSDeviceID","href":"/api-reference/account-management/unlink-ios-device-id","autogeneratedByOpenApi":true},{"title":"Unlink Kongregate","description":"Unlinks the related Kongregate identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UnlinkKongregate","href":"/api-reference/account-management/unlink-kongregate","autogeneratedByOpenApi":true},{"title":"Unlink Nintendo Service Account","description":"Unlinks the related Nintendo account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkNintendoServiceAccount","href":"/api-reference/account-management/unlink-nintendo-service-account","autogeneratedByOpenApi":true},{"title":"Unlink Nintendo Switch Device Id","description":"Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n| NintendoSwitchDeviceIdNotLinked | 2034 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkNintendoSwitchDeviceId","href":"/api-reference/account-management/unlink-nintendo-switch-device-id","autogeneratedByOpenApi":true},{"title":"Unlink Open Id Connect","description":"Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship between a title and an Open ID Connect provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UnlinkOpenIdConnect","href":"/api-reference/account-management/unlink-open-id-connect","autogeneratedByOpenApi":true},{"title":"Unlink PSN Account","description":"Unlinks the related PlayStation™ Network account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkPSNAccount","href":"/api-reference/account-management/unlink-psn-account","autogeneratedByOpenApi":true},{"title":"Unlink Steam Account","description":"Unlinks the related Steam account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UnlinkSteamAccount","href":"/api-reference/account-management/unlink-steam-account","autogeneratedByOpenApi":true},{"title":"Unlink Twitch","description":"Unlinks the related Twitch account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidTwitchToken | 1232 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UnlinkTwitch","href":"/api-reference/account-management/unlink-twitch","autogeneratedByOpenApi":true},{"title":"Unlink Xbox Account","description":"Unlinks the related Xbox Live account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidXboxLiveToken | 1188 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkXboxAccount","href":"/api-reference/account-management/unlink-xbox-account","autogeneratedByOpenApi":true},{"title":"Update Avatar Url","description":"Update the avatar URL of the specified player","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateAvatarUrl","href":"/api-reference/account-management/update-avatar-url","autogeneratedByOpenApi":true},{"title":"Update User Title Display Name","description":"Updates the title specific display name for the user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| ConcurrentEditError | 1133 |\n| EntityProfileConstraintValidationFailed | 1398 |\n| EntityProfileVersionMismatch | 1352 |\n| InvalidPartnerResponse | 1193 |\n| NameNotAvailable | 1058 |\n| ProfaneDisplayName | 1234 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/UpdateUserTitleDisplayName","href":"/api-reference/account-management/update-user-title-display-name","autogeneratedByOpenApi":true}]},{"group":"Shared Group Data","pages":[{"title":"Add Shared Group Members","description":"Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n| UserAlreadyAdded | 1235 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddSharedGroupMembers","href":"/api-reference/shared-group-data/add-shared-group-members","autogeneratedByOpenApi":true},{"title":"Create Shared Group","description":"Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/CreateSharedGroup","href":"/api-reference/shared-group-data/create-shared-group","autogeneratedByOpenApi":true},{"title":"Get Shared Group Data","description":"Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetSharedGroupData","href":"/api-reference/shared-group-data/get-shared-group-data","autogeneratedByOpenApi":true},{"title":"Remove Shared Group Members","description":"Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RemoveSharedGroupMembers","href":"/api-reference/shared-group-data/remove-shared-group-members","autogeneratedByOpenApi":true},{"title":"Update Shared Group Data","description":"Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group (and the server) can update the data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerSecretNotConfigured | 1323 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateSharedGroupData","href":"/api-reference/shared-group-data/update-shared-group-data","autogeneratedByOpenApi":true}]},{"group":"Player Item Management","pages":[{"title":"Add User Virtual Currency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the user's balance of the specified virtual currency by the stated amount\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddUserVirtualCurrency","href":"/api-reference/player-item-management/add-user-virtual-currency","autogeneratedByOpenApi":true},{"title":"Confirm Purchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FailedByPaymentProvider | 1015 |\n| ProductDisabledForTitle | 1609 |\n| PurchaseDoesNotExist | 1080 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ConfirmPurchase","href":"/api-reference/player-item-management/confirm-purchase","autogeneratedByOpenApi":true},{"title":"Consume Item","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InvalidItemProperties | 1091 |\n| ItemNotFound | 1047 |\n| NoRemainingUses | 1062 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ConsumeItem","href":"/api-reference/player-item-management/consume-item","autogeneratedByOpenApi":true},{"title":"Get Character Inventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified character's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterInventory","href":"/api-reference/player-item-management/get-character-inventory","autogeneratedByOpenApi":true},{"title":"Get Payment Token","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidPaymentProvider | 1063 |\n| NoPartnerEnabled | 1192 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetPaymentToken","href":"/api-reference/player-item-management/get-payment-token","autogeneratedByOpenApi":true},{"title":"Get Purchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that are still active.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| PurchaseDoesNotExist | 1080 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetPurchase","href":"/api-reference/player-item-management/get-purchase","autogeneratedByOpenApi":true},{"title":"Get User Inventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified user's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserInventory","href":"/api-reference/player-item-management/get-user-inventory","autogeneratedByOpenApi":true},{"title":"Pay For Purchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Selects a payment option for purchase order created via StartPurchase\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DuplicatePurchaseTransactionId | 1489 |\n| FailedByPaymentProvider | 1015 |\n| InsufficientFunds | 1059 |\n| InvalidPaymentProvider | 1063 |\n| InvalidPurchaseTransactionStatus | 1081 |\n| ProductDisabledForTitle | 1609 |\n| PurchaseDoesNotExist | 1080 |\n| PurchaseInitializationFailure | 1064 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/PayForPurchase","href":"/api-reference/player-item-management/pay-for-purchase","autogeneratedByOpenApi":true},{"title":"Purchase Item","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InsufficientFunds | 1059 |\n| InvalidVirtualCurrency | 1051 |\n| ItemNotFound | 1047 |\n| OperationNotSupportedForPlatform | 1219 |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n| WrongPrice | 1053 |\n| WrongVirtualCurrency | 1052 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/PurchaseItem","href":"/api-reference/player-item-management/purchase-item","autogeneratedByOpenApi":true},{"title":"Redeem Coupon","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| CharacterNotFound | 1135 |\n| CouponAlreadyRedeemed | 1226 |\n| CouponCodeNotFound | 1016 |\n| LegacyEconomyDisabled | 4016 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RedeemCoupon","href":"/api-reference/player-item-management/redeem-coupon","autogeneratedByOpenApi":true},{"title":"Start Purchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Creates an order for a list of items from the title catalog\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/StartPurchase","href":"/api-reference/player-item-management/start-purchase","autogeneratedByOpenApi":true},{"title":"Subtract User Virtual Currency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SubtractUserVirtualCurrency","href":"/api-reference/player-item-management/subtract-user-virtual-currency","autogeneratedByOpenApi":true},{"title":"Unlock Container Instance","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ContainerKeyInvalid | 1205 |\n| ContainerNotOwned | 1018 |\n| InvalidContainerItem | 1017 |\n| InvalidItemIdInTable | 1020 |\n| InvalidItemProperties | 1091 |\n| KeyNotOwned | 1019 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlockContainerInstance","href":"/api-reference/player-item-management/unlock-container-instance","autogeneratedByOpenApi":true},{"title":"Unlock Container Item","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ContainerKeyInvalid | 1205 |\n| ContainerNotOwned | 1018 |\n| InvalidContainerItem | 1017 |\n| InvalidItemIdInTable | 1020 |\n| InvalidItemProperties | 1091 |\n| KeyNotOwned | 1019 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlockContainerItem","href":"/api-reference/player-item-management/unlock-container-item","autogeneratedByOpenApi":true}]},{"group":"Platform Specific Methods","pages":[{"title":"Android Device Push Notification Registration","description":"Registers the Android device to receive push notifications\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| NoPushNotificationARNForTitle | 1083 |\n| PushServiceError | 1095 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/AndroidDevicePushNotificationRegistration","href":"/api-reference/platform-specific-methods/android-device-push-notification-registration","autogeneratedByOpenApi":true},{"title":"Consume Microsoft Store Entitlements","description":"Grants the player's current entitlements from Microsoft Store's Collection API\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ConsumeMicrosoftStoreEntitlements","href":"/api-reference/platform-specific-methods/consume-microsoft-store-entitlements","autogeneratedByOpenApi":true},{"title":"Consume PS5 Entitlements","description":"Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as PlayFab items\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DownstreamServiceUnavailable | 1127 |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ConsumePS5Entitlements","href":"/api-reference/platform-specific-methods/consume-ps5-entitlements","autogeneratedByOpenApi":true},{"title":"Consume PSN Entitlements","description":"Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DownstreamServiceUnavailable | 1127 |\n| ExpiredAuthToken | 1153 |\n| FailedToGetEntitlements | 1154 |\n| ProductDisabledForTitle | 1609 |\n| PSNInaccessible | 1152 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ConsumePSNEntitlements","href":"/api-reference/platform-specific-methods/consume-psn-entitlements","autogeneratedByOpenApi":true},{"title":"Consume Xbox Entitlements","description":"Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExpiredXboxLiveToken | 1189 |\n| InvalidXboxLiveToken | 1188 |\n| ProductDisabledForTitle | 1609 |\n| XboxInaccessible | 1339 |\n| XboxRejectedXSTSExchangeRequest | 1343 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ConsumeXboxEntitlements","href":"/api-reference/platform-specific-methods/consume-xbox-entitlements","autogeneratedByOpenApi":true},{"title":"Refresh PSN Auth Token","description":"Uses the supplied OAuth code to refresh the internally cached player PlayStation™ Network auth token\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DownstreamServiceUnavailable | 1127 |\n| InvalidPSNAuthCode | 1092 |\n| PSNInaccessible | 1152 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/RefreshPSNAuthToken","href":"/api-reference/platform-specific-methods/refresh-psn-auth-token","autogeneratedByOpenApi":true},{"title":"Register For IOS Push Notification","description":"Registers the iOS device to receive push notifications\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| NoPushNotificationARNForTitle | 1083 |\n| PushServiceError | 1095 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/RegisterForIOSPushNotification","href":"/api-reference/platform-specific-methods/register-for-ios-push-notification","autogeneratedByOpenApi":true},{"title":"Restore IOS Purchases","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Restores all in-app purchases based on the given restore receipt\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidBundleID | 1098 |\n| InvalidCurrencyCode | 1179 |\n| InvalidEnvironmentForReceipt | 1300 |\n| InvalidReceipt | 1021 |\n| InvalidVirtualCurrency | 1051 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n| ReceiptContainsMultipleInAppItems | 1097 |\n| ReceiptDoesNotContainInAppItems | 1096 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/RestoreIOSPurchases","href":"/api-reference/platform-specific-methods/restore-ios-purchases","autogeneratedByOpenApi":true},{"title":"Validate Amazon IAP Receipt","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AmazonValidationError | 1150 |\n| InvalidReceipt | 1021 |\n| MissingAmazonSharedKey | 1149 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ValidateAmazonIAPReceipt","href":"/api-reference/platform-specific-methods/validate-amazon-iap-receipt","autogeneratedByOpenApi":true},{"title":"Validate Google Play Purchase","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates a Google Play purchase and gives the corresponding item to the player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GoogleAPIServiceUnavailable | 1534 |\n| GoogleAPIServiceUnknownError | 1535 |\n| GoogleServiceAccountFailedAuth | 1533 |\n| GoogleServiceAccountInvalid | 1332 |\n| InvalidBundleID | 1098 |\n| InvalidProductForSubscription | 1338 |\n| InvalidPurchaseTransactionStatus | 1081 |\n| InvalidReceipt | 1021 |\n| MissingTitleGoogleProperties | 1090 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| NoRealMoneyPriceForCatalogItem | 1180 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n| ReceiptCancelled | 1023 |\n| SubscriptionAlreadyTaken | 1340 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ValidateGooglePlayPurchase","href":"/api-reference/platform-specific-methods/validate-google-play-purchase","autogeneratedByOpenApi":true},{"title":"Validate IOS Receipt","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidBundleID | 1098 |\n| InvalidCurrencyCode | 1179 |\n| InvalidEnvironmentForReceipt | 1300 |\n| InvalidProductForSubscription | 1338 |\n| InvalidReceipt | 1021 |\n| InvalidVirtualCurrency | 1051 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n| ReceiptContainsMultipleInAppItems | 1097 |\n| ReceiptDoesNotContainInAppItems | 1096 |\n| SubscriptionAlreadyTaken | 1340 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ValidateIOSReceipt","href":"/api-reference/platform-specific-methods/validate-ios-receipt","autogeneratedByOpenApi":true},{"title":"Validate Windows Store Receipt","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidReceipt | 1021 |\n| MissingAmazonSharedKey | 1149 |\n| NoMatchingCatalogItemForReceipt | 1178 |\n| ProductDisabledForTitle | 1609 |\n| ReceiptAlreadyUsed | 1022 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ValidateWindowsStoreReceipt","href":"/api-reference/platform-specific-methods/validate-windows-store-receipt","autogeneratedByOpenApi":true}]},{"group":"Advertising","pages":[{"title":"Attribute Install","description":"Attributes an install for advertisment.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| NoPartnerEnabled | 1192 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/AttributeInstall","href":"/api-reference/advertising/attribute-install","autogeneratedByOpenApi":true},{"title":"Get Ad Placements","description":"Returns a list of ad placements and a reward for each\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetAdPlacements","href":"/api-reference/advertising/get-ad-placements","autogeneratedByOpenApi":true},{"title":"Report Ad Activity","description":"Report player's ad activity\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidAdPlacementAndReward | 1268 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ReportAdActivity","href":"/api-reference/advertising/report-ad-activity","autogeneratedByOpenApi":true},{"title":"Reward Ad Activity","description":"Reward player's ad activity\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ActionGroupNotFound | 1250 |\n| AllAdPlacementViewsAlreadyConsumed | 1269 |\n| InvalidAdPlacementAndReward | 1268 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/RewardAdActivity","href":"/api-reference/advertising/reward-ad-activity","autogeneratedByOpenApi":true}]},{"group":"Player Data Management","pages":[{"title":"Delete Player Custom Properties","description":"Deletes title-specific custom properties for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/DeletePlayerCustomProperties","href":"/api-reference/player-data-management/delete-player-custom-properties","autogeneratedByOpenApi":true},{"title":"Get Friend Leaderboard","description":"Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidXboxLiveToken | 1188 |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetFriendLeaderboard","href":"/api-reference/player-data-management/get-friend-leaderboard","autogeneratedByOpenApi":true},{"title":"Get Friend Leaderboard Around Player","description":"Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidXboxLiveToken | 1188 |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetFriendLeaderboardAroundPlayer","href":"/api-reference/player-data-management/get-friend-leaderboard-around-player","autogeneratedByOpenApi":true},{"title":"Get Leaderboard","description":"Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetLeaderboard","href":"/api-reference/player-data-management/get-leaderboard","autogeneratedByOpenApi":true},{"title":"Get Leaderboard Around Player","description":"Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetLeaderboardAroundPlayer","href":"/api-reference/player-data-management/get-leaderboard-around-player","autogeneratedByOpenApi":true},{"title":"Get Player Custom Property","description":"Retrieves a title-specific custom property value for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesPropertyDoesNotExist | 19007 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerCustomProperty","href":"/api-reference/player-data-management/get-player-custom-property","autogeneratedByOpenApi":true},{"title":"Get Player Statistics","description":"Retrieves the current version and values for the indicated statistics, for the local player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerStatistics","href":"/api-reference/player-data-management/get-player-statistics","autogeneratedByOpenApi":true},{"title":"Get Player Statistic Versions","description":"Retrieves the information on the available versions of the specified statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerStatisticVersions","href":"/api-reference/player-data-management/get-player-statistic-versions","autogeneratedByOpenApi":true},{"title":"Get User Data","description":"Retrieves the title-specific custom data for the user which is readable and writable by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserData","href":"/api-reference/player-data-management/get-user-data","autogeneratedByOpenApi":true},{"title":"Get User Publisher Data","description":"Retrieves the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserPublisherData","href":"/api-reference/player-data-management/get-user-publisher-data","autogeneratedByOpenApi":true},{"title":"Get User Publisher Read Only Data","description":"Retrieves the publisher-specific custom data for the user which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserPublisherReadOnlyData","href":"/api-reference/player-data-management/get-user-publisher-read-only-data","autogeneratedByOpenApi":true},{"title":"Get User Read Only Data","description":"Retrieves the title-specific custom data for the user which can only be read by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserReadOnlyData","href":"/api-reference/player-data-management/get-user-read-only-data","autogeneratedByOpenApi":true},{"title":"List Player Custom Properties","description":"Retrieves title-specific custom property values for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ListPlayerCustomProperties","href":"/api-reference/player-data-management/list-player-custom-properties","autogeneratedByOpenApi":true},{"title":"Update Player Custom Properties","description":"Updates the title-specific custom property values for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesDuplicatePropertyName | 19006 |\n| PlayerCustomPropertiesPropertyCountTooHigh | 19005 |\n| PlayerCustomPropertiesPropertyNameIsInvalid | 19001 |\n| PlayerCustomPropertiesPropertyNameTooLong | 19000 |\n| PlayerCustomPropertiesStringPropertyValueTooLong | 19002 |\n| PlayerCustomPropertiesValueIsInvalidType | 19003 |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdatePlayerCustomProperties","href":"/api-reference/player-data-management/update-player-custom-properties","autogeneratedByOpenApi":true},{"title":"Update Player Statistics","description":"Updates the values of the specified title-specific statistics for the user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DuplicateStatisticName | 1253 |\n| ProductDisabledForTitle | 1609 |\n| StatisticCountLimitExceeded | 1203 |\n| StatisticNameConflict | 1196 |\n| StatisticNotFound | 1195 |\n| StatisticValueAggregationOverflow | 1308 |\n| StatisticVersionClosedForWrites | 1197 |\n| StatisticVersionInvalid | 1198 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdatePlayerStatistics","href":"/api-reference/player-data-management/update-player-statistics","autogeneratedByOpenApi":true},{"title":"Update User Data","description":"Updates the title-specific custom data for the user which is readable and writable by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserData","href":"/api-reference/player-data-management/update-user-data","autogeneratedByOpenApi":true},{"title":"Update User Publisher Data","description":"Updates the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserPublisherData","href":"/api-reference/player-data-management/update-user-publisher-data","autogeneratedByOpenApi":true}]},{"group":"Server-Side Cloud Script","pages":[{"title":"Execute Cloud Script","description":"Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The PlayFab ID is the entity ID of the player's master_player_account entity.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAPIRequestCountExceeded | 1209 |\n| CloudScriptAPIRequestError | 1210 |\n| CloudScriptFunctionArgumentSizeExceeded | 1208 |\n| CloudScriptHTTPRequestError | 1211 |\n| CloudScriptNotFound | 1136 |\n| JavascriptException | 1099 |\n| ProductDisabledForTitle | 1609 |\n| TitleDeleted | 1347 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ExecuteCloudScript","href":"/api-reference/server-side-cloud-script/execute-cloud-script","autogeneratedByOpenApi":true}]},{"group":"Characters","pages":[{"title":"Get All Users Characters","description":"Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetAllUsersCharacters","href":"/api-reference/characters/get-all-users-characters","autogeneratedByOpenApi":true},{"title":"Get Character Leaderboard","description":"Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterLeaderboard","href":"/api-reference/characters/get-character-leaderboard","autogeneratedByOpenApi":true},{"title":"Get Character Statistics","description":"Retrieves the details of all title-specific statistics for the specific character\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterStatistics","href":"/api-reference/characters/get-character-statistics","autogeneratedByOpenApi":true},{"title":"Get Leaderboard Around Character","description":"Retrieves a list of ranked characters for the given statistic, centered on the requested user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetLeaderboardAroundCharacter","href":"/api-reference/characters/get-leaderboard-around-character","autogeneratedByOpenApi":true},{"title":"Get Leaderboard For User Characters","description":"Retrieves a list of all of the user's characters for the given statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetLeaderboardForUserCharacters","href":"/api-reference/characters/get-leaderboard-for-user-characters","autogeneratedByOpenApi":true},{"title":"Grant Character To User","description":"Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GrantCharacterToUser","href":"/api-reference/characters/grant-character-to-user","autogeneratedByOpenApi":true},{"title":"Update Character Statistics","description":"Updates the values of the specified title-specific statistics for the specific character\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InvalidCharacterStatistics | 1138 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateCharacterStatistics","href":"/api-reference/characters/update-character-statistics","autogeneratedByOpenApi":true}]},{"group":"Title-Wide Data Management","pages":[{"title":"Get Catalog Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCatalogItems","href":"/api-reference/title-wide-data-management/get-catalog-items","autogeneratedByOpenApi":true},{"title":"Get Publisher Data","description":"Retrieves the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPublisherData","href":"/api-reference/title-wide-data-management/get-publisher-data","autogeneratedByOpenApi":true},{"title":"Get Store Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetStoreItems","href":"/api-reference/title-wide-data-management/get-store-items","autogeneratedByOpenApi":true},{"title":"Get Time","description":"Retrieves the current server time\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetTime","href":"/api-reference/title-wide-data-management/get-time","autogeneratedByOpenApi":true},{"title":"Get Title Data","description":"Retrieves the key-value store of custom title settings","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetTitleData","href":"/api-reference/title-wide-data-management/get-title-data","autogeneratedByOpenApi":true},{"title":"Get Title News","description":"Retrieves the title news feed, as configured in the developer portal","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetTitleNews","href":"/api-reference/title-wide-data-management/get-title-news","autogeneratedByOpenApi":true}]},{"group":"Character Data","pages":[{"title":"Get Character Data","description":"Retrieves the title-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterData","href":"/api-reference/character-data/get-character-data","autogeneratedByOpenApi":true},{"title":"Get Character Read Only Data","description":"Retrieves the title-specific custom data for the user's character which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterReadOnlyData","href":"/api-reference/character-data/get-character-read-only-data","autogeneratedByOpenApi":true},{"title":"Update Character Data","description":"Updates the title-specific custom data for the user's character which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateCharacterData","href":"/api-reference/character-data/update-character-data","autogeneratedByOpenApi":true}]},{"group":"Content","pages":[{"title":"Get Content Download Url","description":"This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetContentDownloadUrl","href":"/api-reference/content/get-content-download-url","autogeneratedByOpenApi":true}]},{"group":"Authentication","pages":[{"title":"Get Photon Authentication Token","description":"Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://learn.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PhotonApplicationNotAssociatedWithTitle | 1141 |\n| PhotonApplicationNotFound | 1140 |\n| PhotonNotEnabledForTitle | 1139 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetPhotonAuthenticationToken","href":"/api-reference/authentication/get-photon-authentication-token","autogeneratedByOpenApi":true},{"title":"Get Title Public Key","description":"Returns the title's base 64 encoded RSA CSP blob.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyBroken | 1291 |\n| InvalidSharedSecretKey | 1296 |\n| NoSharedSecretKeyConfigured | 1292 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/GetTitlePublicKey","href":"/api-reference/authentication/get-title-public-key","autogeneratedByOpenApi":true},{"title":"Login With Android Device ID","description":"Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithAndroidDeviceID","href":"/api-reference/authentication/login-with-android-device-id","autogeneratedByOpenApi":true},{"title":"Login With Apple","description":"Signs in the user with a Sign in with Apple identity token.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AppleNotEnabledForTitle | 1501 |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| TokenSigningKeyNotFound | 1568 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithApple","href":"/api-reference/authentication/login-with-apple","autogeneratedByOpenApi":true},{"title":"Login With Battle Net","description":"Sign in the user with a Battle.net identity token\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| BattleNetNotEnabledForTitle | 1602 |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidAuthToken | 1326 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| InvalidTitleId | 1004 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithBattleNet","href":"/api-reference/authentication/login-with-battle-net","autogeneratedByOpenApi":true},{"title":"Login With Custom ID","description":"Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithCustomID","href":"/api-reference/authentication/login-with-custom-id","autogeneratedByOpenApi":true},{"title":"Login With Email Address","description":"Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEmailOrPassword | 1142 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithEmailAddress","href":"/api-reference/authentication/login-with-email-address","autogeneratedByOpenApi":true},{"title":"Login With Facebook","description":"Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FacebookAPIError | 1143 |\n| InvalidFacebookToken | 1013 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithFacebook","href":"/api-reference/authentication/login-with-facebook","autogeneratedByOpenApi":true},{"title":"Login With Facebook Instant Games Id","description":"Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Requires Facebook Instant Games to be configured.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FacebookInstantGamesAuthNotConfiguredForTitle | 1397 |\n| InvalidFacebookInstantGamesSignature | 1396 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithFacebookInstantGamesId","href":"/api-reference/authentication/login-with-facebook-instant-games-id","autogeneratedByOpenApi":true},{"title":"Login With Game Center","description":"Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| GameCenterAuthenticationFailed | 1429 |\n| InvalidGameCenterAuthRequest | 1428 |\n| InvalidGameCenterId | 1554 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithGameCenter","href":"/api-reference/authentication/login-with-game-center","autogeneratedByOpenApi":true},{"title":"Login With Google Account","description":"Signs the user in using their Google account credentials\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| GoogleOAuthError | 1271 |\n| GoogleOAuthNoIdTokenIncludedInResponse | 1275 |\n| GoogleOAuthNotConfiguredForTitle | 1270 |\n| InvalidGoogleToken | 1026 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithGoogleAccount","href":"/api-reference/authentication/login-with-google-account","autogeneratedByOpenApi":true},{"title":"Login With Google Play Games Services","description":"Signs the user in using their Google Play Games account credentials\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| GoogleOAuthError | 1271 |\n| GoogleOAuthNotConfiguredForTitle | 1270 |\n| InvalidGooglePlayGamesServerAuthCode | 1545 |\n| InvalidGoogleToken | 1026 |\n| InvalidGoogleToken | 1026 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithGooglePlayGamesServices","href":"/api-reference/authentication/login-with-google-play-games-services","autogeneratedByOpenApi":true},{"title":"Login With IOS Device ID","description":"Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithIOSDeviceID","href":"/api-reference/authentication/login-with-ios-device-id","autogeneratedByOpenApi":true},{"title":"Login With Kongregate","description":"Signs the user in using a Kongregate player account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidKongregateToken | 1176 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithKongregate","href":"/api-reference/authentication/login-with-kongregate","autogeneratedByOpenApi":true},{"title":"Login With Nintendo Service Account","description":"Signs in the user with a Nintendo service account token.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithNintendoServiceAccount","href":"/api-reference/authentication/login-with-nintendo-service-account","autogeneratedByOpenApi":true},{"title":"Login With Nintendo Switch Device Id","description":"Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerCreationDisabled | 22000 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithNintendoSwitchDeviceId","href":"/api-reference/authentication/login-with-nintendo-switch-device-id","autogeneratedByOpenApi":true},{"title":"Login With Open Id Connect","description":"Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect provider.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidIdentityProviderId | 1263 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithOpenIdConnect","href":"/api-reference/authentication/login-with-open-id-connect","autogeneratedByOpenApi":true},{"title":"Login With Play Fab","description":"Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSignature | 1273 |\n| InvalidUsernameOrPassword | 1003 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithPlayFab","href":"/api-reference/authentication/login-with-play-fab","autogeneratedByOpenApi":true},{"title":"Login With PSN","description":"Signs the user in using a PlayStation™ Network authentication code, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidParams | 1000 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| PSNInaccessible | 1152 |\n| PSNNextGenNotConfiguredForTitle | 1617 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithPSN","href":"/api-reference/authentication/login-with-psn","autogeneratedByOpenApi":true},{"title":"Login With Steam","description":"Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSteamTicket | 1010 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| SteamNotEnabledForTitle | 1258 |\n| SteamUserNotFound | 1513 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/LoginWithSteam","href":"/api-reference/authentication/login-with-steam","autogeneratedByOpenApi":true},{"title":"Login With Twitch","description":"Sign in the user with a Twitch access token\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidTwitchToken | 1232 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| TwitchResponseError | 1233 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithTwitch","href":"/api-reference/authentication/login-with-twitch","autogeneratedByOpenApi":true},{"title":"Login With Xbox","description":"Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| ExpiredXboxLiveToken | 1189 |\n| InvalidXboxLiveToken | 1188 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| XboxInaccessible | 1339 |\n| XboxRejectedXSTSExchangeRequest | 1343 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithXbox","href":"/api-reference/authentication/login-with-xbox","autogeneratedByOpenApi":true},{"title":"Register Play Fab User","description":"Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply a username and an email address.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailAddressNotAvailable | 1006 |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidEmailAddress | 1005 |\n| InvalidPartnerResponse | 1193 |\n| InvalidPassword | 1008 |\n| InvalidUsername | 1007 |\n| NameNotAvailable | 1058 |\n| ProfaneDisplayName | 1234 |\n| SignedRequestNotAllowed | 1302 |\n| UsernameNotAvailable | 1009 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/RegisterPlayFabUser","href":"/api-reference/authentication/register-play-fab-user","autogeneratedByOpenApi":true},{"title":"Set Player Secret","description":"Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's secret use the Admin or Server API method SetPlayerSecret.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerSecretAlreadyConfigured | 1294 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetPlayerSecret","href":"/api-reference/authentication/set-player-secret","autogeneratedByOpenApi":true}]},{"group":"PlayStream","pages":[{"title":"Get Player Segments","description":"List all segments that a player currently belongs to at this moment in time.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerSegments","href":"/api-reference/playstream/get-player-segments","autogeneratedByOpenApi":true},{"title":"Get Player Tags","description":"Get all tags with a given Namespace (optional) from a player profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerTags","href":"/api-reference/playstream/get-player-tags","autogeneratedByOpenApi":true}]},{"group":"Analytics","pages":[{"title":"Report Device Info","description":"Write a PlayStream event to describe the provided player device information. This API method is not designed to be called directly by developers. Each PlayFab client SDK will eventually report this information automatically.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BodyTooLarge | 1068 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/client/client.openapi.json post /Client/ReportDeviceInfo","href":"/api-reference/analytics/report-device-info","autogeneratedByOpenApi":true},{"title":"Write Character Event","description":"Writes a character-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/WriteCharacterEvent","href":"/api-reference/analytics/write-character-event","autogeneratedByOpenApi":true},{"title":"Write Player Event","description":"Writes a player-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEventField | 1216 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/WritePlayerEvent","href":"/api-reference/analytics/write-player-event","autogeneratedByOpenApi":true},{"title":"Write Title Event","description":"Writes a title-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEventField | 1216 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/WriteTitleEvent","href":"/api-reference/analytics/write-title-event","autogeneratedByOpenApi":true}]}]},{"group":"CloudScript","pages":[{"title":"PlayFab CloudScript API","description":"Overview of the PlayFab CloudScript REST API for executing CloudScript using an entity profile, with its API version and Server-Side Cloud Script group.","href":"/services/playfab/api-references/rest/cloudscript/overview"},{"group":"Server-Side Cloud Script","pages":[{"title":"Execute Entity Cloud Script","openapi":"post /CloudScript/ExecuteEntityCloudScript","description":"Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAPIRequestCountExceeded | 1209 |\n| CloudScriptAPIRequestError | 1210 |\n| CloudScriptFunctionArgumentSizeExceeded | 1208 |\n| CloudScriptHTTPRequestError | 1211 |\n| CloudScriptNotFound | 1136 |\n| InvalidEntityType | 1373 |\n| JavascriptException | 1099 |\n| TitleDeleted | 1347 |\n","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/execute-entity-cloud-script"},{"title":"Execute Function","openapi":"post /CloudScript/ExecuteFunction","description":"Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAzureFunctionsArgumentSizeExceeded | 1471 |\n| CloudScriptAzureFunctionsEventHubRequestError | 1579 |\n| CloudScriptAzureFunctionsExecutionTimeLimitExceeded | 1470 |\n| CloudScriptAzureFunctionsHTTPRequestError | 1473 |\n| CloudScriptAzureFunctionsQueueRequestError | 1494 |\n| CloudScriptAzureFunctionsReturnSizeExceeded | 1472 |\n| InvalidEntityType | 1373 |\n","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/execute-function"},{"title":"Get Function","openapi":"post /CloudScript/GetFunction","description":"Gets registered Azure Functions for a given title id and function name.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptNotFound | 1136 |\n","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/get-function"},{"title":"List Event Hub Functions","openapi":"post /CloudScript/ListEventHubFunctions","description":"Lists all currently registered Event Hub triggered Azure Functions for a given title.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/list-event-hub-functions"},{"title":"List Functions","openapi":"post /CloudScript/ListFunctions","description":"Lists all currently registered Azure Functions for a given title.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/list-functions"},{"title":"List Http Functions","openapi":"post /CloudScript/ListHttpFunctions","description":"Lists all currently registered HTTP triggered Azure Functions for a given title.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/list-http-functions"},{"title":"List Queued Functions","openapi":"post /CloudScript/ListQueuedFunctions","description":"Lists all currently registered Queue triggered Azure Functions for a given title.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/list-queued-functions"},{"title":"Post Function Result For Entity Triggered Action","openapi":"post /CloudScript/PostFunctionResultForEntityTriggeredAction","description":"Generate an entity PlayStream event for the provided function result.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/post-function-result-for-entity-triggered-action"},{"title":"Post Function Result For Function Execution","openapi":"post /CloudScript/PostFunctionResultForFunctionExecution","description":"Generate an entity PlayStream event for the provided function result.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/post-function-result-for-function-execution"},{"title":"Post Function Result For Player Triggered Action","openapi":"post /CloudScript/PostFunctionResultForPlayerTriggeredAction","description":"Generate a player PlayStream event for the provided function result.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/post-function-result-for-player-triggered-action"},{"title":"Post Function Result For Scheduled Task","openapi":"post /CloudScript/PostFunctionResultForScheduledTask","description":"Generate a PlayStream event for the provided function result.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/post-function-result-for-scheduled-task"},{"title":"Register Event Hub Function","openapi":"post /CloudScript/RegisterEventHubFunction","description":"Registers an event hub triggered Azure Function with a title.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/register-event-hub-function"},{"title":"Register Http Function","openapi":"post /CloudScript/RegisterHttpFunction","description":"Registers an HTTP triggered Azure function with a title.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/register-http-function"},{"title":"Register Queued Function","openapi":"post /CloudScript/RegisterQueuedFunction","description":"Registers a queue triggered Azure Function with a title.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/register-queued-function"},{"title":"Unregister Function","openapi":"post /CloudScript/UnregisterFunction","description":"Unregisters an Azure Function with a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptNotFound | 1136 |\n","href":"/services/playfab/api-references/rest/cloudscript/server-side-cloud-script/unregister-function"}]},{"group":"Server-Side Cloud Script","pages":[{"title":"Execute Entity Cloud Script","description":"Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAPIRequestCountExceeded | 1209 |\n| CloudScriptAPIRequestError | 1210 |\n| CloudScriptFunctionArgumentSizeExceeded | 1208 |\n| CloudScriptHTTPRequestError | 1211 |\n| CloudScriptNotFound | 1136 |\n| InvalidEntityType | 1373 |\n| JavascriptException | 1099 |\n| TitleDeleted | 1347 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/ExecuteEntityCloudScript","href":"/api-reference/server-side-cloud-script/execute-entity-cloud-script","autogeneratedByOpenApi":true},{"title":"Execute Function","description":"Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAzureFunctionsArgumentSizeExceeded | 1471 |\n| CloudScriptAzureFunctionsEventHubRequestError | 1579 |\n| CloudScriptAzureFunctionsExecutionTimeLimitExceeded | 1470 |\n| CloudScriptAzureFunctionsHTTPRequestError | 1473 |\n| CloudScriptAzureFunctionsQueueRequestError | 1494 |\n| CloudScriptAzureFunctionsReturnSizeExceeded | 1472 |\n| InvalidEntityType | 1373 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/ExecuteFunction","href":"/api-reference/server-side-cloud-script/execute-function","autogeneratedByOpenApi":true},{"title":"Get Function","description":"Gets registered Azure Functions for a given title id and function name.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptNotFound | 1136 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/GetFunction","href":"/api-reference/server-side-cloud-script/get-function","autogeneratedByOpenApi":true},{"title":"List Event Hub Functions","description":"Lists all currently registered Event Hub triggered Azure Functions for a given title.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/ListEventHubFunctions","href":"/api-reference/server-side-cloud-script/list-event-hub-functions","autogeneratedByOpenApi":true},{"title":"List Functions","description":"Lists all currently registered Azure Functions for a given title.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/ListFunctions","href":"/api-reference/server-side-cloud-script/list-functions","autogeneratedByOpenApi":true},{"title":"List Http Functions","description":"Lists all currently registered HTTP triggered Azure Functions for a given title.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/ListHttpFunctions","href":"/api-reference/server-side-cloud-script/list-http-functions","autogeneratedByOpenApi":true},{"title":"List Queued Functions","description":"Lists all currently registered Queue triggered Azure Functions for a given title.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/ListQueuedFunctions","href":"/api-reference/server-side-cloud-script/list-queued-functions","autogeneratedByOpenApi":true},{"title":"Post Function Result For Entity Triggered Action","description":"Generate an entity PlayStream event for the provided function result.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/PostFunctionResultForEntityTriggeredAction","href":"/api-reference/server-side-cloud-script/post-function-result-for-entity-triggered-action","autogeneratedByOpenApi":true},{"title":"Post Function Result For Function Execution","description":"Generate an entity PlayStream event for the provided function result.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/PostFunctionResultForFunctionExecution","href":"/api-reference/server-side-cloud-script/post-function-result-for-function-execution","autogeneratedByOpenApi":true},{"title":"Post Function Result For Player Triggered Action","description":"Generate a player PlayStream event for the provided function result.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/PostFunctionResultForPlayerTriggeredAction","href":"/api-reference/server-side-cloud-script/post-function-result-for-player-triggered-action","autogeneratedByOpenApi":true},{"title":"Post Function Result For Scheduled Task","description":"Generate a PlayStream event for the provided function result.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/PostFunctionResultForScheduledTask","href":"/api-reference/server-side-cloud-script/post-function-result-for-scheduled-task","autogeneratedByOpenApi":true},{"title":"Register Event Hub Function","description":"Registers an event hub triggered Azure Function with a title.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/RegisterEventHubFunction","href":"/api-reference/server-side-cloud-script/register-event-hub-function","autogeneratedByOpenApi":true},{"title":"Register Http Function","description":"Registers an HTTP triggered Azure function with a title.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/RegisterHttpFunction","href":"/api-reference/server-side-cloud-script/register-http-function","autogeneratedByOpenApi":true},{"title":"Register Queued Function","description":"Registers a queue triggered Azure Function with a title.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/RegisterQueuedFunction","href":"/api-reference/server-side-cloud-script/register-queued-function","autogeneratedByOpenApi":true},{"title":"Unregister Function","description":"Unregisters an Azure Function with a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptNotFound | 1136 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/cloudscript/cloudscript.openapi.json post /CloudScript/UnregisterFunction","href":"/api-reference/server-side-cloud-script/unregister-function","autogeneratedByOpenApi":true}]}]},{"group":"Data","pages":[{"title":"PlayFab Data API","description":"Overview of the PlayFab Data REST API for storing small JSON objects and files on an entity profile, with its File and Object operation groups.","href":"/services/playfab/api-references/rest/data/overview"},{"group":"File","pages":[{"title":"Abort File Uploads","openapi":"post /File/AbortFileUploads","description":"Abort pending file uploads to an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FileNotFound | 1045 |\n| NoEntityFileOperationPending | 1351 |\n","href":"/services/playfab/api-references/rest/data/file/abort-file-uploads"},{"title":"Delete Files","openapi":"post /File/DeleteFiles","description":"Delete files on an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityFileOperationPending | 1350 |\n| FileNotFound | 1045 |\n","href":"/services/playfab/api-references/rest/data/file/delete-files"},{"title":"Finalize File Uploads","openapi":"post /File/FinalizeFileUploads","description":"Finalize file uploads to an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FileNotFound | 1045 |\n| NoEntityFileOperationPending | 1351 |\n","href":"/services/playfab/api-references/rest/data/file/finalize-file-uploads"},{"title":"Get Files","openapi":"post /File/GetFiles","description":"Retrieves file metadata from an entity's profile.","href":"/services/playfab/api-references/rest/data/file/get-files"},{"title":"Initiate File Uploads","openapi":"post /File/InitiateFileUploads","description":"Initiates file uploads to an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityFileOperationPending | 1350 |\n","href":"/services/playfab/api-references/rest/data/file/initiate-file-uploads"}]},{"group":"Object","pages":[{"title":"Get Objects","openapi":"post /Object/GetObjects","description":"Retrieves objects from an entity's profile.","href":"/services/playfab/api-references/rest/data/object/get-objects"},{"title":"Set Objects","openapi":"post /Object/SetObjects","description":"Sets objects on an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidJSONContent | 1200 |\n","href":"/services/playfab/api-references/rest/data/object/set-objects"}]},{"group":"File","pages":[{"title":"Abort File Uploads","description":"Abort pending file uploads to an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FileNotFound | 1045 |\n| NoEntityFileOperationPending | 1351 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/data/data.openapi.json post /File/AbortFileUploads","href":"/api-reference/file/abort-file-uploads","autogeneratedByOpenApi":true},{"title":"Delete Files","description":"Delete files on an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityFileOperationPending | 1350 |\n| FileNotFound | 1045 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/data/data.openapi.json post /File/DeleteFiles","href":"/api-reference/file/delete-files","autogeneratedByOpenApi":true},{"title":"Finalize File Uploads","description":"Finalize file uploads to an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FileNotFound | 1045 |\n| NoEntityFileOperationPending | 1351 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/data/data.openapi.json post /File/FinalizeFileUploads","href":"/api-reference/file/finalize-file-uploads","autogeneratedByOpenApi":true},{"title":"Get Files","description":"Retrieves file metadata from an entity's profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/data/data.openapi.json post /File/GetFiles","href":"/api-reference/file/get-files","autogeneratedByOpenApi":true},{"title":"Initiate File Uploads","description":"Initiates file uploads to an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityFileOperationPending | 1350 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/data/data.openapi.json post /File/InitiateFileUploads","href":"/api-reference/file/initiate-file-uploads","autogeneratedByOpenApi":true}]},{"group":"Object","pages":[{"title":"Get Objects","description":"Retrieves objects from an entity's profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/data/data.openapi.json post /Object/GetObjects","href":"/api-reference/object/get-objects","autogeneratedByOpenApi":true},{"title":"Set Objects","description":"Sets objects on an entity's profile.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidJSONContent | 1200 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/data/data.openapi.json post /Object/SetObjects","href":"/api-reference/object/set-objects","autogeneratedByOpenApi":true}]}]},{"group":"Economy","pages":[{"title":"PlayFab Economy API","description":"Overview of the PlayFab Economy REST API for managing versioned catalogs and player inventory, including operation groups and their request rate limits.","href":"/services/playfab/api-references/rest/economy/overview"},{"group":"Catalog","pages":[{"title":"Create Draft Item","openapi":"post /Catalog/CreateDraftItem","description":"Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogBadRequest | 4013 |\n| DatabaseThroughputExceeded | 1113 |\n| InvalidRequest | 1071 |\n| ItemNotFound | 1047 |\n| NotImplemented | 1515 |\n","href":"/services/playfab/api-references/rest/economy/catalog/create-draft-item"},{"title":"Create Upload Urls","openapi":"post /Catalog/CreateUploadUrls","description":"Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info around uploading content can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/pricing/meters/catalog-meters\n\nAllowed entity token types: title, master_player_account, title_player_account","href":"/services/playfab/api-references/rest/economy/catalog/create-upload-urls"},{"title":"Delete Entity Item Reviews","openapi":"post /Catalog/DeleteEntityItemReviews","description":"Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProfileDoesNotExist | 1298 |\n","href":"/services/playfab/api-references/rest/economy/catalog/delete-entity-item-reviews"},{"title":"Delete Item","openapi":"post /Catalog/DeleteItem","description":"Removes an item from working catalog and all published versions from the public catalog.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/delete-item"},{"title":"Get Catalog Config","openapi":"post /Catalog/GetCatalogConfig","description":"Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| InvalidEntityType | 1373 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-catalog-config"},{"title":"Get Draft Item","openapi":"post /Catalog/GetDraftItem","description":"Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are valid for 1 hour.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n| NotImplemented | 1515 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-draft-item"},{"title":"Get Draft Items","openapi":"post /Catalog/GetDraftItems","description":"Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request. GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note: SAS tokens provided are valid for 1 hour.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-draft-items"},{"title":"Get Entity Draft Items","openapi":"post /Catalog/GetEntityDraftItems","description":"Retrieves a paginated list of the items from the draft catalog created by the Entity. Up to 50 items can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. GetEntityDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-entity-draft-items"},{"title":"Get Entity Item Review","openapi":"post /Catalog/GetEntityItemReview","description":"Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update in near real time with delays within a few seconds.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-entity-item-review"},{"title":"Get Item","openapi":"post /Catalog/GetItem","description":"Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-item"},{"title":"Get Item Containers","openapi":"post /Catalog/GetItemContainers","description":"Search for a given item and return a set of bundles and stores containing the item. Up to 50 items can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. This API is intended for tooling/automation scenarios and has a reduced RPS with Player Entities limited to 30 requests in 300 seconds and Title Entities limited to 100 requests in 10 seconds.\n\nAllowed entity token types: title, title_player_account, master_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-item-containers"},{"title":"Get Item Moderation State","openapi":"post /Catalog/GetItemModerationState","description":"Gets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-item-moderation-state"},{"title":"Get Item Publish Status","openapi":"post /Catalog/GetItemPublishStatus","description":"Gets the status of a publish of an item.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-item-publish-status"},{"title":"Get Item Reviews","openapi":"post /Catalog/GetItemReviews","description":"Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near real time with delays within a few seconds.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-item-reviews"},{"title":"Get Item Review Summary","openapi":"post /Catalog/GetItemReviewSummary","description":"Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update data coming within 15 minutes.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-item-review-summary"},{"title":"Get Items","openapi":"post /Catalog/GetItems","description":"Retrieves items from the public catalog. Up to 50 items can be returned at once. GetItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| NotImplemented | 1515 |\n","href":"/services/playfab/api-references/rest/economy/catalog/get-items"},{"title":"Publish Draft Item","openapi":"post /Catalog/PublishDraftItem","description":"Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API to track the state of the item publish.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/publish-draft-item"},{"title":"Report Item","openapi":"post /Catalog/ReportItem","description":"Submit a report for an item, indicating in what way the item is inappropriate.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/report-item"},{"title":"Report Item Review","openapi":"post /Catalog/ReportItemReview","description":"Submit a report for a review\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n","href":"/services/playfab/api-references/rest/economy/catalog/report-item-review"},{"title":"Review Item","openapi":"post /Catalog/ReviewItem","description":"Creates or updates a review for the specified item. More information around the caching surrounding item ratings and reviews can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/ratings#ratings-design-and-caching\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/review-item"},{"title":"Search Items","openapi":"post /Catalog/SearchItems","description":"Executes a search against the public catalog using the provided search parameters and returns a set of paginated results. SearchItems uses a cache of the catalog with item updates taking up to a few minutes to propagate. You should use the GetItem API for when trying to immediately get recent item updates. More information about the Search API can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n| NotImplemented | 1515 |\n","href":"/services/playfab/api-references/rest/economy/catalog/search-items"},{"title":"Set Item Moderation State","openapi":"post /Catalog/SetItemModerationState","description":"Sets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/set-item-moderation-state"},{"title":"Submit Item Review Vote","openapi":"post /Catalog/SubmitItemReviewVote","description":"Submit a vote for a review, indicating whether the review was helpful or unhelpful.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n","href":"/services/playfab/api-references/rest/economy/catalog/submit-item-review-vote"},{"title":"Takedown Item Reviews","openapi":"post /Catalog/TakedownItemReviews","description":"Submit a request to takedown one or more reviews.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/takedown-item-reviews"},{"title":"Update Catalog Config","openapi":"post /Catalog/UpdateCatalogConfig","description":"Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n","href":"/services/playfab/api-references/rest/economy/catalog/update-catalog-config"},{"title":"Update Draft Item","openapi":"post /Catalog/UpdateDraftItem","description":"Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InvalidRequest | 1071 |\n| ItemNotFound | 1047 |\n","href":"/services/playfab/api-references/rest/economy/catalog/update-draft-item"}]},{"group":"Inventory","pages":[{"title":"Add Inventory Items","openapi":"post /Inventory/AddInventoryItems","description":"Add inventory items. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InvalidCatalogItemConfiguration | 4015 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/add-inventory-items"},{"title":"Delete Inventory Collection","openapi":"post /Inventory/DeleteInventoryCollection","description":"Delete an Inventory Collection. More information about Inventory Collections can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/collections\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InventoryCollectionDeletionDisallowed | 12001 |\n","href":"/services/playfab/api-references/rest/economy/inventory/delete-inventory-collection"},{"title":"Delete Inventory Items","openapi":"post /Inventory/DeleteInventoryItems","description":"Delete inventory items\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/delete-inventory-items"},{"title":"Execute Inventory Operations","openapi":"post /Inventory/ExecuteInventoryOperations","description":"Execute a list of Inventory Operations. A maximum list of 50 operations can be performed by a single request. There is also a limit to 300 items that can be modified/added in a single request. For example, adding a bundle with 50 items counts as 50 items modified. All operations must be done within a single inventory collection. This API has a reduced RPS compared to an individual inventory operation with Player Entities limited to 60 requests in 90 seconds.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| InvalidCatalogItemConfiguration | 4015 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/execute-inventory-operations"},{"title":"Execute Transfer Operations","openapi":"post /Inventory/ExecuteTransferOperations","description":"Transfer a list of inventory items. A maximum list of 50 operations can be performed by a single request. When the response code is 202, one or more operations did not complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/execute-transfer-operations"},{"title":"Get Inventory Collection Ids","openapi":"post /Inventory/GetInventoryCollectionIds","description":"Get Inventory Collection Ids. Up to 50 Ids can be returned at once (or 250 with response compression enabled). You can use continuation tokens to paginate through results that return greater than the limit. It can take a few seconds for new collection Ids to show up.\n\nAllowed entity token types: title, master_player_account, title_player_account","href":"/services/playfab/api-references/rest/economy/inventory/get-inventory-collection-ids"},{"title":"Get Inventory Items","openapi":"post /Inventory/GetInventoryItems","description":"Get current inventory items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountDeleted | 1322 |\n| DatabaseThroughputExceeded | 1113 |\n| PreconditionFailed | 1610 |\n| ResourceNotModified | 1606 |\n","href":"/services/playfab/api-references/rest/economy/inventory/get-inventory-items"},{"title":"Get Inventory Operation Status","openapi":"post /Inventory/GetInventoryOperationStatus","description":"Get the status of an inventory operation using an OperationToken. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the this API.\n\nAllowed entity token types: title, master_player_account, title_player_account","href":"/services/playfab/api-references/rest/economy/inventory/get-inventory-operation-status"},{"title":"Get Transaction History","openapi":"post /Inventory/GetTransactionHistory","description":"Get transaction history for a player. Up to 50 Events can be returned at once (or 250 with response compression enabled). You can use continuation tokens to paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds.\n\nAllowed entity token types: title, master_player_account, title_player_account","href":"/services/playfab/api-references/rest/economy/inventory/get-transaction-history"},{"title":"Purchase Inventory Items","openapi":"post /Inventory/PurchaseInventoryItems","description":"Purchase an item or bundle. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| InvalidCatalogItemConfiguration | 4015 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/purchase-inventory-items"},{"title":"Redeem Apple App Store Inventory Items","openapi":"post /Inventory/RedeemAppleAppStoreInventoryItems","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidCatalogItemConfiguration | 4015 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/redeem-apple-app-store-inventory-items"},{"title":"Redeem Apple App Store With Jws Inventory Items","openapi":"post /Inventory/RedeemAppleAppStoreWithJwsInventoryItems","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidCatalogItemConfiguration | 4015 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/redeem-apple-app-store-with-jws-inventory-items"},{"title":"Redeem Google Play Inventory Items","openapi":"post /Inventory/RedeemGooglePlayInventoryItems","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidCatalogItemConfiguration | 4015 |\n","href":"/services/playfab/api-references/rest/economy/inventory/redeem-google-play-inventory-items"},{"title":"Redeem Microsoft Store Inventory Items","openapi":"post /Inventory/RedeemMicrosoftStoreInventoryItems","description":"Redeem items from the Microsoft Store. Supported entitlement types are Developer Manager Consumable and Durable.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| InvalidCatalogItemConfiguration | 4015 |\n| InvalidXboxLiveToken | 1188 |\n| XboxInaccessible | 1339 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/economy/inventory/redeem-microsoft-store-inventory-items"},{"title":"Redeem Nintendo E Shop Inventory Items","openapi":"post /Inventory/RedeemNintendoEShopInventoryItems","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| InvalidCatalogItemConfiguration | 4015 |\n| InvalidNintendoSwitchAccountId | 1555 |\n","href":"/services/playfab/api-references/rest/economy/inventory/redeem-nintendo-e-shop-inventory-items"},{"title":"Redeem Play Station Store Inventory Items","openapi":"post /Inventory/RedeemPlayStationStoreInventoryItems","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| InvalidCatalogItemConfiguration | 4015 |\n| InvalidPSNAuthCode | 1092 |\n| NotAuthorized | 1089 |\n","href":"/services/playfab/api-references/rest/economy/inventory/redeem-play-station-store-inventory-items"},{"title":"Redeem Steam Inventory Items","openapi":"post /Inventory/RedeemSteamInventoryItems","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| InvalidCatalogItemConfiguration | 4015 |\n","href":"/services/playfab/api-references/rest/economy/inventory/redeem-steam-inventory-items"},{"title":"Subtract Inventory Items","openapi":"post /Inventory/SubtractInventoryItems","description":"Subtract inventory items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/subtract-inventory-items"},{"title":"Transfer Inventory Items","openapi":"post /Inventory/TransferInventoryItems","description":"Transfer inventory items. When transferring across collections, a 202 response indicates that the transfer did not complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API. More information about item transfer scenarios can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/?tabs=inventory-game-manager#transfer-inventory-items\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/transfer-inventory-items"},{"title":"Update Inventory Items","openapi":"post /Inventory/UpdateInventoryItems","description":"Update inventory items\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","href":"/services/playfab/api-references/rest/economy/inventory/update-inventory-items"}]},{"group":"Catalog","pages":[{"title":"Create Draft Item","description":"Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogBadRequest | 4013 |\n| DatabaseThroughputExceeded | 1113 |\n| InvalidRequest | 1071 |\n| ItemNotFound | 1047 |\n| NotImplemented | 1515 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/CreateDraftItem","href":"/api-reference/catalog/create-draft-item","autogeneratedByOpenApi":true},{"title":"Create Upload Urls","description":"Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info around uploading content can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/pricing/meters/catalog-meters\n\nAllowed entity token types: title, master_player_account, title_player_account","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/CreateUploadUrls","href":"/api-reference/catalog/create-upload-urls","autogeneratedByOpenApi":true},{"title":"Delete Entity Item Reviews","description":"Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProfileDoesNotExist | 1298 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/DeleteEntityItemReviews","href":"/api-reference/catalog/delete-entity-item-reviews","autogeneratedByOpenApi":true},{"title":"Delete Item","description":"Removes an item from working catalog and all published versions from the public catalog.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/DeleteItem","href":"/api-reference/catalog/delete-item","autogeneratedByOpenApi":true},{"title":"Get Catalog Config","description":"Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| InvalidEntityType | 1373 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetCatalogConfig","href":"/api-reference/catalog/get-catalog-config","autogeneratedByOpenApi":true},{"title":"Get Draft Item","description":"Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are valid for 1 hour.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n| NotImplemented | 1515 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetDraftItem","href":"/api-reference/catalog/get-draft-item","autogeneratedByOpenApi":true},{"title":"Get Draft Items","description":"Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request. GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note: SAS tokens provided are valid for 1 hour.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetDraftItems","href":"/api-reference/catalog/get-draft-items","autogeneratedByOpenApi":true},{"title":"Get Entity Draft Items","description":"Retrieves a paginated list of the items from the draft catalog created by the Entity. Up to 50 items can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. GetEntityDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetEntityDraftItems","href":"/api-reference/catalog/get-entity-draft-items","autogeneratedByOpenApi":true},{"title":"Get Entity Item Review","description":"Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update in near real time with delays within a few seconds.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetEntityItemReview","href":"/api-reference/catalog/get-entity-item-review","autogeneratedByOpenApi":true},{"title":"Get Item","description":"Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetItem","href":"/api-reference/catalog/get-item","autogeneratedByOpenApi":true},{"title":"Get Item Containers","description":"Search for a given item and return a set of bundles and stores containing the item. Up to 50 items can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. This API is intended for tooling/automation scenarios and has a reduced RPS with Player Entities limited to 30 requests in 300 seconds and Title Entities limited to 100 requests in 10 seconds.\n\nAllowed entity token types: title, title_player_account, master_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetItemContainers","href":"/api-reference/catalog/get-item-containers","autogeneratedByOpenApi":true},{"title":"Get Item Moderation State","description":"Gets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetItemModerationState","href":"/api-reference/catalog/get-item-moderation-state","autogeneratedByOpenApi":true},{"title":"Get Item Publish Status","description":"Gets the status of a publish of an item.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetItemPublishStatus","href":"/api-reference/catalog/get-item-publish-status","autogeneratedByOpenApi":true},{"title":"Get Item Reviews","description":"Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near real time with delays within a few seconds.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetItemReviews","href":"/api-reference/catalog/get-item-reviews","autogeneratedByOpenApi":true},{"title":"Get Item Review Summary","description":"Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update data coming within 15 minutes.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetItemReviewSummary","href":"/api-reference/catalog/get-item-review-summary","autogeneratedByOpenApi":true},{"title":"Get Items","description":"Retrieves items from the public catalog. Up to 50 items can be returned at once. GetItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| NotImplemented | 1515 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/GetItems","href":"/api-reference/catalog/get-items","autogeneratedByOpenApi":true},{"title":"Publish Draft Item","description":"Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API to track the state of the item publish.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/PublishDraftItem","href":"/api-reference/catalog/publish-draft-item","autogeneratedByOpenApi":true},{"title":"Report Item","description":"Submit a report for an item, indicating in what way the item is inappropriate.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/ReportItem","href":"/api-reference/catalog/report-item","autogeneratedByOpenApi":true},{"title":"Report Item Review","description":"Submit a report for a review\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/ReportItemReview","href":"/api-reference/catalog/report-item-review","autogeneratedByOpenApi":true},{"title":"Review Item","description":"Creates or updates a review for the specified item. More information around the caching surrounding item ratings and reviews can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/ratings#ratings-design-and-caching\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/ReviewItem","href":"/api-reference/catalog/review-item","autogeneratedByOpenApi":true},{"title":"Search Items","description":"Executes a search against the public catalog using the provided search parameters and returns a set of paginated results. SearchItems uses a cache of the catalog with item updates taking up to a few minutes to propagate. You should use the GetItem API for when trying to immediately get recent item updates. More information about the Search API can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n| NotImplemented | 1515 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/SearchItems","href":"/api-reference/catalog/search-items","autogeneratedByOpenApi":true},{"title":"Set Item Moderation State","description":"Sets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/SetItemModerationState","href":"/api-reference/catalog/set-item-moderation-state","autogeneratedByOpenApi":true},{"title":"Submit Item Review Vote","description":"Submit a vote for a review, indicating whether the review was helpful or unhelpful.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/SubmitItemReviewVote","href":"/api-reference/catalog/submit-item-review-vote","autogeneratedByOpenApi":true},{"title":"Takedown Item Reviews","description":"Submit a request to takedown one or more reviews.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/TakedownItemReviews","href":"/api-reference/catalog/takedown-item-reviews","autogeneratedByOpenApi":true},{"title":"Update Catalog Config","description":"Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| CatalogConfigInvalid | 4010 |\n| InvalidEntityType | 1373 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/UpdateCatalogConfig","href":"/api-reference/catalog/update-catalog-config","autogeneratedByOpenApi":true},{"title":"Update Draft Item","description":"Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InvalidRequest | 1071 |\n| ItemNotFound | 1047 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Catalog/UpdateDraftItem","href":"/api-reference/catalog/update-draft-item","autogeneratedByOpenApi":true}]},{"group":"Inventory","pages":[{"title":"Add Inventory Items","description":"Add inventory items. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InvalidCatalogItemConfiguration | 4015 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/AddInventoryItems","href":"/api-reference/inventory/add-inventory-items","autogeneratedByOpenApi":true},{"title":"Delete Inventory Collection","description":"Delete an Inventory Collection. More information about Inventory Collections can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/collections\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InventoryCollectionDeletionDisallowed | 12001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/DeleteInventoryCollection","href":"/api-reference/inventory/delete-inventory-collection","autogeneratedByOpenApi":true},{"title":"Delete Inventory Items","description":"Delete inventory items\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/DeleteInventoryItems","href":"/api-reference/inventory/delete-inventory-items","autogeneratedByOpenApi":true},{"title":"Execute Inventory Operations","description":"Execute a list of Inventory Operations. A maximum list of 50 operations can be performed by a single request. There is also a limit to 300 items that can be modified/added in a single request. For example, adding a bundle with 50 items counts as 50 items modified. All operations must be done within a single inventory collection. This API has a reduced RPS compared to an individual inventory operation with Player Entities limited to 60 requests in 90 seconds.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| InvalidCatalogItemConfiguration | 4015 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/ExecuteInventoryOperations","href":"/api-reference/inventory/execute-inventory-operations","autogeneratedByOpenApi":true},{"title":"Execute Transfer Operations","description":"Transfer a list of inventory items. A maximum list of 50 operations can be performed by a single request. When the response code is 202, one or more operations did not complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/ExecuteTransferOperations","href":"/api-reference/inventory/execute-transfer-operations","autogeneratedByOpenApi":true},{"title":"Get Inventory Collection Ids","description":"Get Inventory Collection Ids. Up to 50 Ids can be returned at once (or 250 with response compression enabled). You can use continuation tokens to paginate through results that return greater than the limit. It can take a few seconds for new collection Ids to show up.\n\nAllowed entity token types: title, master_player_account, title_player_account","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/GetInventoryCollectionIds","href":"/api-reference/inventory/get-inventory-collection-ids","autogeneratedByOpenApi":true},{"title":"Get Inventory Items","description":"Get current inventory items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountDeleted | 1322 |\n| DatabaseThroughputExceeded | 1113 |\n| PreconditionFailed | 1610 |\n| ResourceNotModified | 1606 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/GetInventoryItems","href":"/api-reference/inventory/get-inventory-items","autogeneratedByOpenApi":true},{"title":"Get Inventory Operation Status","description":"Get the status of an inventory operation using an OperationToken. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the this API.\n\nAllowed entity token types: title, master_player_account, title_player_account","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/GetInventoryOperationStatus","href":"/api-reference/inventory/get-inventory-operation-status","autogeneratedByOpenApi":true},{"title":"Get Transaction History","description":"Get transaction history for a player. Up to 50 Events can be returned at once (or 250 with response compression enabled). You can use continuation tokens to paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds.\n\nAllowed entity token types: title, master_player_account, title_player_account","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/GetTransactionHistory","href":"/api-reference/inventory/get-transaction-history","autogeneratedByOpenApi":true},{"title":"Purchase Inventory Items","description":"Purchase an item or bundle. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| InvalidCatalogItemConfiguration | 4015 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/PurchaseInventoryItems","href":"/api-reference/inventory/purchase-inventory-items","autogeneratedByOpenApi":true},{"title":"Redeem Apple App Store Inventory Items","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidCatalogItemConfiguration | 4015 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/RedeemAppleAppStoreInventoryItems","href":"/api-reference/inventory/redeem-apple-app-store-inventory-items","autogeneratedByOpenApi":true},{"title":"Redeem Apple App Store With Jws Inventory Items","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidCatalogItemConfiguration | 4015 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/RedeemAppleAppStoreWithJwsInventoryItems","href":"/api-reference/inventory/redeem-apple-app-store-with-jws-inventory-items","autogeneratedByOpenApi":true},{"title":"Redeem Google Play Inventory Items","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidCatalogItemConfiguration | 4015 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/RedeemGooglePlayInventoryItems","href":"/api-reference/inventory/redeem-google-play-inventory-items","autogeneratedByOpenApi":true},{"title":"Redeem Microsoft Store Inventory Items","description":"Redeem items from the Microsoft Store. Supported entitlement types are Developer Manager Consumable and Durable.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| InvalidCatalogItemConfiguration | 4015 |\n| InvalidXboxLiveToken | 1188 |\n| XboxInaccessible | 1339 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/RedeemMicrosoftStoreInventoryItems","href":"/api-reference/inventory/redeem-microsoft-store-inventory-items","autogeneratedByOpenApi":true},{"title":"Redeem Nintendo E Shop Inventory Items","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| InvalidCatalogItemConfiguration | 4015 |\n| InvalidNintendoSwitchAccountId | 1555 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/RedeemNintendoEShopInventoryItems","href":"/api-reference/inventory/redeem-nintendo-e-shop-inventory-items","autogeneratedByOpenApi":true},{"title":"Redeem Play Station Store Inventory Items","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| InvalidCatalogItemConfiguration | 4015 |\n| InvalidPSNAuthCode | 1092 |\n| NotAuthorized | 1089 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/RedeemPlayStationStoreInventoryItems","href":"/api-reference/inventory/redeem-play-station-store-inventory-items","autogeneratedByOpenApi":true},{"title":"Redeem Steam Inventory Items","description":"Redeem items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| InvalidCatalogItemConfiguration | 4015 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/RedeemSteamInventoryItems","href":"/api-reference/inventory/redeem-steam-inventory-items","autogeneratedByOpenApi":true},{"title":"Subtract Inventory Items","description":"Subtract inventory items.\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/SubtractInventoryItems","href":"/api-reference/inventory/subtract-inventory-items","autogeneratedByOpenApi":true},{"title":"Transfer Inventory Items","description":"Transfer inventory items. When transferring across collections, a 202 response indicates that the transfer did not complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API. More information about item transfer scenarios can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/?tabs=inventory-game-manager#transfer-inventory-items\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| InsufficientFunds | 1059 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/TransferInventoryItems","href":"/api-reference/inventory/transfer-inventory-items","autogeneratedByOpenApi":true},{"title":"Update Inventory Items","description":"Update inventory items\n\nAllowed entity token types: title, master_player_account, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DatabaseThroughputExceeded | 1113 |\n| ItemNotFound | 1047 |\n| PreconditionFailed | 1610 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/economy/economy.openapi.json post /Inventory/UpdateInventoryItems","href":"/api-reference/inventory/update-inventory-items","autogeneratedByOpenApi":true}]}]},{"group":"Events","pages":[{"title":"PlayFab Events API","description":"Overview of the PlayFab Events REST API for writing custom PlayStream and Telemetry events for any PlayFab entity, plus its API version and operations.","href":"/services/playfab/api-references/rest/events/overview"},{"group":"PlayStream Events","pages":[{"title":"Create Telemetry Key","openapi":"post /Event/CreateTelemetryKey","description":"Creates a new telemetry key for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TelemetryKeyAlreadyExists | 14202 |\n| TelemetryKeyCountOverLimit | 14204 |\n| TelemetryKeyInvalidName | 14201 |\n| TelemetryKeyLongInsightsRetentionNotAllowed | 14206 |\n","href":"/services/playfab/api-references/rest/events/play-stream-events/create-telemetry-key"},{"title":"Delete Data Connection","openapi":"post /Event/DeleteDataConnection","description":"Deletes a Data Connection from a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EventSinkNotFound | 15005 |\n| ServiceUnavailable | 1123 |\n","href":"/services/playfab/api-references/rest/events/play-stream-events/delete-data-connection"},{"title":"Delete Telemetry Key","openapi":"post /Event/DeleteTelemetryKey","description":"Deletes a telemetry key configured for the title.","href":"/services/playfab/api-references/rest/events/play-stream-events/delete-telemetry-key"},{"title":"Get Data Connection","openapi":"post /Event/GetDataConnection","description":"Retrieves a single Data Connection associated with a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EventSinkNotFound | 15005 |\n| ServiceUnavailable | 1123 |\n","href":"/services/playfab/api-references/rest/events/play-stream-events/get-data-connection"},{"title":"Get Telemetry Key","openapi":"post /Event/GetTelemetryKey","description":"Gets information about a telemetry key configured for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TelemetryKeyNotFound | 14200 |\n","href":"/services/playfab/api-references/rest/events/play-stream-events/get-telemetry-key"},{"title":"List Data Connections","openapi":"post /Event/ListDataConnections","description":"Retrieves the list of Data Connections associated with a title.\n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/events/play-stream-events/list-data-connections"},{"title":"List Telemetry Keys","openapi":"post /Event/ListTelemetryKeys","description":"Lists all telemetry keys configured for the title.","href":"/services/playfab/api-references/rest/events/play-stream-events/list-telemetry-keys"},{"title":"Set Data Connection","openapi":"post /Event/SetDataConnection","description":"Creates or updates a Data Connection on a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| EventSinkConnectionInvalid | 15000 |\n| EventSinkConnectionUnauthorized | 15001 |\n| EventSinkDatabaseNotFound | 15011 |\n| EventSinkInsufficientRoleAssignment | 15013 |\n| EventSinkLimitExceeded | 15003 |\n| EventSinkRegionInvalid | 15002 |\n| EventSinkSasTokenInvalid | 15004 |\n| EventSinkSasTokenPermissionInvalid | 15007 |\n| EventSinkSecretInvalid | 15008 |\n| EventSinkTenantIdInvalid | 15015 |\n| EventSinkTitleUnauthorized | 15012 |\n| ServiceUnavailable | 1123 |\n","href":"/services/playfab/api-references/rest/events/play-stream-events/set-data-connection"},{"title":"Set Data Connection Active","openapi":"post /Event/SetDataConnectionActive","description":"Sets a Data Connection for the title to either the active or deactivated state.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| EventSinkConnectionInvalid | 15000 |\n| EventSinkConnectionUnauthorized | 15001 |\n| EventSinkDatabaseNotFound | 15011 |\n| EventSinkInsufficientRoleAssignment | 15013 |\n| EventSinkLimitExceeded | 15003 |\n| EventSinkNotFound | 15005 |\n| EventSinkRegionInvalid | 15002 |\n| EventSinkSasTokenInvalid | 15004 |\n| EventSinkSasTokenPermissionInvalid | 15007 |\n| EventSinkSecretInvalid | 15008 |\n| EventSinkTenantIdInvalid | 15015 |\n| EventSinkTitleUnauthorized | 15012 |\n| ServiceUnavailable | 1123 |\n","href":"/services/playfab/api-references/rest/events/play-stream-events/set-data-connection-active"},{"title":"Set Telemetry Key Active","openapi":"post /Event/SetTelemetryKeyActive","description":"Sets a telemetry key to the active or deactivated state.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TelemetryKeyNotFound | 14200 |\n","href":"/services/playfab/api-references/rest/events/play-stream-events/set-telemetry-key-active"},{"title":"Write Events","openapi":"post /Event/WriteEvents","description":"Write batches of entity based events to PlayStream. The namespace of the Event must be 'custom' or start with 'custom.'.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyBroken | 1291 |\n| EventEntityNotAllowed | 1372 |\n| EventNamespaceNotAllowed | 1371 |\n| InvalidEventContents | 1548 |\n| InvalidJSONContent | 1200 |\n| PerEntityEventRateLimitExceeded | 1392 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/events/play-stream-events/write-events"},{"title":"Write Telemetry Events","openapi":"post /Event/WriteTelemetryEvents","description":"Write batches of entity based events to as Telemetry events (bypass PlayStream). The namespace must be 'custom' or start with 'custom.'\n\nAllowed entity token types: title, title_player_account, master_player_account, service, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyBroken | 1291 |\n| EventEntityNotAllowed | 1372 |\n| EventNamespaceNotAllowed | 1371 |\n| InvalidEventContents | 1548 |\n| InvalidJSONContent | 1200 |\n| PerEntityEventRateLimitExceeded | 1392 |\n| ProductDisabledForTitle | 1609 |\n| TelemetryKeyDeactivated | 14205 |\n| TelemetryKeyInvalid | 14203 |\n","href":"/services/playfab/api-references/rest/events/play-stream-events/write-telemetry-events"}]},{"group":"PlayStream Events","pages":[{"title":"Create Telemetry Key","description":"Creates a new telemetry key for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TelemetryKeyAlreadyExists | 14202 |\n| TelemetryKeyCountOverLimit | 14204 |\n| TelemetryKeyInvalidName | 14201 |\n| TelemetryKeyLongInsightsRetentionNotAllowed | 14206 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/CreateTelemetryKey","href":"/api-reference/playstream-events/create-telemetry-key","autogeneratedByOpenApi":true},{"title":"Delete Data Connection","description":"Deletes a Data Connection from a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EventSinkNotFound | 15005 |\n| ServiceUnavailable | 1123 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/DeleteDataConnection","href":"/api-reference/playstream-events/delete-data-connection","autogeneratedByOpenApi":true},{"title":"Delete Telemetry Key","description":"Deletes a telemetry key configured for the title.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/DeleteTelemetryKey","href":"/api-reference/playstream-events/delete-telemetry-key","autogeneratedByOpenApi":true},{"title":"Get Data Connection","description":"Retrieves a single Data Connection associated with a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EventSinkNotFound | 15005 |\n| ServiceUnavailable | 1123 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/GetDataConnection","href":"/api-reference/playstream-events/get-data-connection","autogeneratedByOpenApi":true},{"title":"Get Telemetry Key","description":"Gets information about a telemetry key configured for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TelemetryKeyNotFound | 14200 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/GetTelemetryKey","href":"/api-reference/playstream-events/get-telemetry-key","autogeneratedByOpenApi":true},{"title":"List Data Connections","description":"Retrieves the list of Data Connections associated with a title.\n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/ListDataConnections","href":"/api-reference/playstream-events/list-data-connections","autogeneratedByOpenApi":true},{"title":"List Telemetry Keys","description":"Lists all telemetry keys configured for the title.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/ListTelemetryKeys","href":"/api-reference/playstream-events/list-telemetry-keys","autogeneratedByOpenApi":true},{"title":"Set Data Connection","description":"Creates or updates a Data Connection on a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| EventSinkConnectionInvalid | 15000 |\n| EventSinkConnectionUnauthorized | 15001 |\n| EventSinkDatabaseNotFound | 15011 |\n| EventSinkInsufficientRoleAssignment | 15013 |\n| EventSinkLimitExceeded | 15003 |\n| EventSinkRegionInvalid | 15002 |\n| EventSinkSasTokenInvalid | 15004 |\n| EventSinkSasTokenPermissionInvalid | 15007 |\n| EventSinkSecretInvalid | 15008 |\n| EventSinkTenantIdInvalid | 15015 |\n| EventSinkTitleUnauthorized | 15012 |\n| ServiceUnavailable | 1123 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/SetDataConnection","href":"/api-reference/playstream-events/set-data-connection","autogeneratedByOpenApi":true},{"title":"Set Data Connection Active","description":"Sets a Data Connection for the title to either the active or deactivated state.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| BillingInformationRequired | 1266 |\n| EventSinkConnectionInvalid | 15000 |\n| EventSinkConnectionUnauthorized | 15001 |\n| EventSinkDatabaseNotFound | 15011 |\n| EventSinkInsufficientRoleAssignment | 15013 |\n| EventSinkLimitExceeded | 15003 |\n| EventSinkNotFound | 15005 |\n| EventSinkRegionInvalid | 15002 |\n| EventSinkSasTokenInvalid | 15004 |\n| EventSinkSasTokenPermissionInvalid | 15007 |\n| EventSinkSecretInvalid | 15008 |\n| EventSinkTenantIdInvalid | 15015 |\n| EventSinkTitleUnauthorized | 15012 |\n| ServiceUnavailable | 1123 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/SetDataConnectionActive","href":"/api-reference/playstream-events/set-data-connection-active","autogeneratedByOpenApi":true},{"title":"Set Telemetry Key Active","description":"Sets a telemetry key to the active or deactivated state.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TelemetryKeyNotFound | 14200 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/SetTelemetryKeyActive","href":"/api-reference/playstream-events/set-telemetry-key-active","autogeneratedByOpenApi":true},{"title":"Write Events","description":"Write batches of entity based events to PlayStream. The namespace of the Event must be 'custom' or start with 'custom.'.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyBroken | 1291 |\n| EventEntityNotAllowed | 1372 |\n| EventNamespaceNotAllowed | 1371 |\n| InvalidEventContents | 1548 |\n| InvalidJSONContent | 1200 |\n| PerEntityEventRateLimitExceeded | 1392 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/WriteEvents","href":"/api-reference/playstream-events/write-events","autogeneratedByOpenApi":true},{"title":"Write Telemetry Events","description":"Write batches of entity based events to as Telemetry events (bypass PlayStream). The namespace must be 'custom' or start with 'custom.'\n\nAllowed entity token types: title, title_player_account, master_player_account, service, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyBroken | 1291 |\n| EventEntityNotAllowed | 1372 |\n| EventNamespaceNotAllowed | 1371 |\n| InvalidEventContents | 1548 |\n| InvalidJSONContent | 1200 |\n| PerEntityEventRateLimitExceeded | 1392 |\n| ProductDisabledForTitle | 1609 |\n| TelemetryKeyDeactivated | 14205 |\n| TelemetryKeyInvalid | 14203 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/events/events.openapi.json post /Event/WriteTelemetryEvents","href":"/api-reference/playstream-events/write-telemetry-events","autogeneratedByOpenApi":true}]}]},{"group":"Experimentation","pages":[{"title":"PlayFab Experimentation API","description":"Overview of the PlayFab Experimentation REST API for managing experiments, including the current API version and the Experimentation operation group.","href":"/services/playfab/api-references/rest/experimentation/overview"},{"group":"Experimentation","pages":[{"title":"Create Exclusion Group","openapi":"post /Experimentation/CreateExclusionGroup","description":"Creates a new experiment exclusion group for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupInvalidName | 7022 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/create-exclusion-group"},{"title":"Create Experiment","openapi":"post /Experimentation/CreateExperiment","description":"Creates a new experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupInsufficientCapacity | 7019 |\n| ExperimentationExclusionGroupInvalidTrafficAllocation | 7021 |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| ExperimentationInvalidEndDate | 7015 |\n| ExperimentationInvalidStartDate | 7016 |\n| ExperimentationMaxDurationExceeded | 7017 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/create-experiment"},{"title":"Delete Exclusion Group","openapi":"post /Experimentation/DeleteExclusionGroup","description":"Deletes an existing exclusion group for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupCannotDelete | 7020 |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/delete-exclusion-group"},{"title":"Delete Experiment","openapi":"post /Experimentation/DeleteExperiment","description":"Deletes an existing experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExperimentDeleteFailed | 7025 |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationExperimentRunning | 7001 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/delete-experiment"},{"title":"Get Exclusion Groups","openapi":"post /Experimentation/GetExclusionGroups","description":"Gets the details of all exclusion groups for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/get-exclusion-groups"},{"title":"Get Exclusion Group Traffic","openapi":"post /Experimentation/GetExclusionGroupTraffic","description":"Gets the details of all exclusion groups for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/get-exclusion-group-traffic"},{"title":"Get Experiments","openapi":"post /Experimentation/GetExperiments","description":"Gets the details of all experiments for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/get-experiments"},{"title":"Get Latest Scorecard","openapi":"post /Experimentation/GetLatestScorecard","description":"Gets the latest scorecard of the experiment for the title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationNoScorecard | 7009 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/get-latest-scorecard"},{"title":"Get Treatment Assignment","openapi":"post /Experimentation/GetTreatmentAssignment","description":"Gets the treatment assignments for a player for every running experiment in the title.\n\nAllowed entity token types: title, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationClientTimeout | 7005 |\n| ExperimentationTreatmentAssignmentDisabled | 7011 |\n| ExperimentationTreatmentAssignmentFailed | 7010 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidEntityType | 1373 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/get-treatment-assignment"},{"title":"Start Experiment","openapi":"post /Experimentation/StartExperiment","description":"Starts an existing experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationExperimentRunning | 7001 |\n| ExperimentationExperimentStartFailed | 7026 |\n| ExperimentationExperimentStopped | 7000 |\n| ExperimentationLegacyExperimentInvalidOperation | 7023 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/start-experiment"},{"title":"Stop Experiment","openapi":"post /Experimentation/StopExperiment","description":"Stops an existing experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExperimentNeverStarted | 7003 |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationExperimentStopped | 7000 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/stop-experiment"},{"title":"Update Exclusion Group","openapi":"post /Experimentation/UpdateExclusionGroup","description":"Updates an existing exclusion group for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/update-exclusion-group"},{"title":"Update Experiment","openapi":"post /Experimentation/UpdateExperiment","description":"Updates an existing experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupInsufficientCapacity | 7019 |\n| ExperimentationExclusionGroupInvalidTrafficAllocation | 7021 |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationExperimentRunning | 7001 |\n| ExperimentationExperimentStopped | 7000 |\n| ExperimentationInvalidDuration | 7012 |\n| ExperimentationInvalidEndDate | 7015 |\n| ExperimentationInvalidStartDate | 7016 |\n| ExperimentationLegacyExperimentInvalidOperation | 7023 |\n| ExperimentationMaxDurationExceeded | 7017 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","href":"/services/playfab/api-references/rest/experimentation/experimentation/update-experiment"}]},{"group":"Experimentation","pages":[{"title":"Create Exclusion Group","description":"Creates a new experiment exclusion group for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupInvalidName | 7022 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/CreateExclusionGroup","href":"/api-reference/experimentation/create-exclusion-group","autogeneratedByOpenApi":true},{"title":"Create Experiment","description":"Creates a new experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupInsufficientCapacity | 7019 |\n| ExperimentationExclusionGroupInvalidTrafficAllocation | 7021 |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| ExperimentationInvalidEndDate | 7015 |\n| ExperimentationInvalidStartDate | 7016 |\n| ExperimentationMaxDurationExceeded | 7017 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/CreateExperiment","href":"/api-reference/experimentation/create-experiment","autogeneratedByOpenApi":true},{"title":"Delete Exclusion Group","description":"Deletes an existing exclusion group for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupCannotDelete | 7020 |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/DeleteExclusionGroup","href":"/api-reference/experimentation/delete-exclusion-group","autogeneratedByOpenApi":true},{"title":"Delete Experiment","description":"Deletes an existing experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExperimentDeleteFailed | 7025 |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationExperimentRunning | 7001 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/DeleteExperiment","href":"/api-reference/experimentation/delete-experiment","autogeneratedByOpenApi":true},{"title":"Get Exclusion Groups","description":"Gets the details of all exclusion groups for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/GetExclusionGroups","href":"/api-reference/experimentation/get-exclusion-groups","autogeneratedByOpenApi":true},{"title":"Get Exclusion Group Traffic","description":"Gets the details of all exclusion groups for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/GetExclusionGroupTraffic","href":"/api-reference/experimentation/get-exclusion-group-traffic","autogeneratedByOpenApi":true},{"title":"Get Experiments","description":"Gets the details of all experiments for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/GetExperiments","href":"/api-reference/experimentation/get-experiments","autogeneratedByOpenApi":true},{"title":"Get Latest Scorecard","description":"Gets the latest scorecard of the experiment for the title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationNoScorecard | 7009 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/GetLatestScorecard","href":"/api-reference/experimentation/get-latest-scorecard","autogeneratedByOpenApi":true},{"title":"Get Treatment Assignment","description":"Gets the treatment assignments for a player for every running experiment in the title.\n\nAllowed entity token types: title, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationClientTimeout | 7005 |\n| ExperimentationTreatmentAssignmentDisabled | 7011 |\n| ExperimentationTreatmentAssignmentFailed | 7010 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidEntityType | 1373 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/GetTreatmentAssignment","href":"/api-reference/experimentation/get-treatment-assignment","autogeneratedByOpenApi":true},{"title":"Start Experiment","description":"Starts an existing experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationExperimentRunning | 7001 |\n| ExperimentationExperimentStartFailed | 7026 |\n| ExperimentationExperimentStopped | 7000 |\n| ExperimentationLegacyExperimentInvalidOperation | 7023 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/StartExperiment","href":"/api-reference/experimentation/start-experiment","autogeneratedByOpenApi":true},{"title":"Stop Experiment","description":"Stops an existing experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExperimentNeverStarted | 7003 |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationExperimentStopped | 7000 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/StopExperiment","href":"/api-reference/experimentation/stop-experiment","autogeneratedByOpenApi":true},{"title":"Update Exclusion Group","description":"Updates an existing exclusion group for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/UpdateExclusionGroup","href":"/api-reference/experimentation/update-exclusion-group","autogeneratedByOpenApi":true},{"title":"Update Experiment","description":"Updates an existing experiment for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExperimentationExclusionGroupInsufficientCapacity | 7019 |\n| ExperimentationExclusionGroupInvalidTrafficAllocation | 7021 |\n| ExperimentationExclusionGroupNotFound | 7018 |\n| ExperimentationExperimentNotFound | 7002 |\n| ExperimentationExperimentRunning | 7001 |\n| ExperimentationExperimentStopped | 7000 |\n| ExperimentationInvalidDuration | 7012 |\n| ExperimentationInvalidEndDate | 7015 |\n| ExperimentationInvalidStartDate | 7016 |\n| ExperimentationLegacyExperimentInvalidOperation | 7023 |\n| ExperimentationMaxDurationExceeded | 7017 |\n| FeatureNotConfiguredForTitle | 1177 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/experimentation/experimentation.openapi.json post /Experimentation/UpdateExperiment","href":"/api-reference/experimentation/update-experiment","autogeneratedByOpenApi":true}]}]},{"group":"Groups","pages":[{"title":"PlayFab Groups API","description":"Overview of the PlayFab Groups REST API for permanent or semi-permanent collections of entities, such as guilds and clans, with its operation groups.","href":"/services/playfab/api-references/rest/groups/overview"},{"group":"Groups","pages":[{"title":"Accept Group Application","openapi":"post /Group/AcceptGroupApplication","description":"Accepts an outstanding invitation to to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityBlockedByGroup | 1357 |\n| EntityIsAlreadyMember | 1359 |\n| GroupApplicationNotFound | 1362 |\n","href":"/services/playfab/api-references/rest/groups/groups/accept-group-application"},{"title":"Accept Group Invitation","openapi":"post /Group/AcceptGroupInvitation","description":"Accepts an invitation to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityBlockedByGroup | 1357 |\n| EntityIsAlreadyMember | 1359 |\n| GroupInvitationNotFound | 1361 |\n| RoleDoesNotExist | 1358 |\n","href":"/services/playfab/api-references/rest/groups/groups/accept-group-invitation"},{"title":"Add Members","openapi":"post /Group/AddMembers","description":"Adds members to a group or role.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","href":"/services/playfab/api-references/rest/groups/groups/add-members"},{"title":"Apply To Group","openapi":"post /Group/ApplyToGroup","description":"Applies to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityBlockedByGroup | 1357 |\n| EntityIsAlreadyMember | 1359 |\n| OutstandingInvitationAcceptedInstead | 1363 |\n| RoleDoesNotExist | 1358 |\n","href":"/services/playfab/api-references/rest/groups/groups/apply-to-group"},{"title":"Block Entity","openapi":"post /Group/BlockEntity","description":"Blocks a list of entities from joining a group.","href":"/services/playfab/api-references/rest/groups/groups/block-entity"},{"title":"Change Member Role","openapi":"post /Group/ChangeMemberRole","description":"Changes the role membership of a list of entities from one role to another.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","href":"/services/playfab/api-references/rest/groups/groups/change-member-role"},{"title":"Create Group","openapi":"post /Group/CreateGroup","description":"Creates a new group.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GroupNameNotAvailable | 1368 |\n","href":"/services/playfab/api-references/rest/groups/groups/create-group"},{"title":"Create Role","openapi":"post /Group/CreateRole","description":"Creates a new group role.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DuplicateRoleId | 1360 |\n| RoleNameNotAvailable | 1367 |\n","href":"/services/playfab/api-references/rest/groups/groups/create-role"},{"title":"Delete Group","openapi":"post /Group/DeleteGroup","description":"Deletes a group and all roles, invitations, join requests, and blocks associated with it.","href":"/services/playfab/api-references/rest/groups/groups/delete-group"},{"title":"Delete Role","openapi":"post /Group/DeleteRole","description":"Deletes an existing role in a group.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n| RoleIsGroupAdmin | 1366 |\n| RoleIsGroupDefaultMember | 1365 |\n","href":"/services/playfab/api-references/rest/groups/groups/delete-role"},{"title":"Get Group","openapi":"post /Group/GetGroup","description":"Gets information about a group and its roles","href":"/services/playfab/api-references/rest/groups/groups/get-group"},{"title":"Invite To Group","openapi":"post /Group/InviteToGroup","description":"Invites a player to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityBlockedByGroup | 1357 |\n| EntityIsAlreadyMember | 1359 |\n| OutstandingApplicationAcceptedInstead | 1364 |\n| RoleDoesNotExist | 1358 |\n","href":"/services/playfab/api-references/rest/groups/groups/invite-to-group"},{"title":"Is Member","openapi":"post /Group/IsMember","description":"Checks to see if an entity is a member of a group or role within the group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","href":"/services/playfab/api-references/rest/groups/groups/is-member"},{"title":"List Group Applications","openapi":"post /Group/ListGroupApplications","description":"Lists all outstanding requests to join a group","href":"/services/playfab/api-references/rest/groups/groups/list-group-applications"},{"title":"List Group Blocks","openapi":"post /Group/ListGroupBlocks","description":"Lists all entities blocked from joining a group","href":"/services/playfab/api-references/rest/groups/groups/list-group-blocks"},{"title":"List Group Invitations","openapi":"post /Group/ListGroupInvitations","description":"Lists all outstanding invitations for a group","href":"/services/playfab/api-references/rest/groups/groups/list-group-invitations"},{"title":"List Group Members","openapi":"post /Group/ListGroupMembers","description":"Lists all members for a group","href":"/services/playfab/api-references/rest/groups/groups/list-group-members"},{"title":"List Membership","openapi":"post /Group/ListMembership","description":"Lists all groups and roles for an entity","href":"/services/playfab/api-references/rest/groups/groups/list-membership"},{"title":"List Membership Opportunities","openapi":"post /Group/ListMembershipOpportunities","description":"Lists all outstanding invitations and group applications for an entity","href":"/services/playfab/api-references/rest/groups/groups/list-membership-opportunities"},{"title":"Remove Group Application","openapi":"post /Group/RemoveGroupApplication","description":"Removes an application to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GroupApplicationNotFound | 1362 |\n","href":"/services/playfab/api-references/rest/groups/groups/remove-group-application"},{"title":"Remove Group Invitation","openapi":"post /Group/RemoveGroupInvitation","description":"Removes an invitation join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GroupInvitationNotFound | 1361 |\n","href":"/services/playfab/api-references/rest/groups/groups/remove-group-invitation"},{"title":"Remove Members","openapi":"post /Group/RemoveMembers","description":"Removes members from a group.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","href":"/services/playfab/api-references/rest/groups/groups/remove-members"},{"title":"Unblock Entity","openapi":"post /Group/UnblockEntity","description":"Unblocks a list of entities from joining a group","href":"/services/playfab/api-references/rest/groups/groups/unblock-entity"},{"title":"Update Group","openapi":"post /Group/UpdateGroup","description":"Updates non-membership data about a group.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GroupNameNotAvailable | 1368 |\n| RoleDoesNotExist | 1358 |\n","href":"/services/playfab/api-references/rest/groups/groups/update-group"},{"title":"Update Role","openapi":"post /Group/UpdateRole","description":"Updates metadata about a role.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","href":"/services/playfab/api-references/rest/groups/groups/update-role"}]},{"group":"Groups","pages":[{"title":"Accept Group Application","description":"Accepts an outstanding invitation to to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityBlockedByGroup | 1357 |\n| EntityIsAlreadyMember | 1359 |\n| GroupApplicationNotFound | 1362 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/AcceptGroupApplication","href":"/api-reference/groups/accept-group-application","autogeneratedByOpenApi":true},{"title":"Accept Group Invitation","description":"Accepts an invitation to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityBlockedByGroup | 1357 |\n| EntityIsAlreadyMember | 1359 |\n| GroupInvitationNotFound | 1361 |\n| RoleDoesNotExist | 1358 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/AcceptGroupInvitation","href":"/api-reference/groups/accept-group-invitation","autogeneratedByOpenApi":true},{"title":"Add Members","description":"Adds members to a group or role.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/AddMembers","href":"/api-reference/groups/add-members","autogeneratedByOpenApi":true},{"title":"Apply To Group","description":"Applies to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityBlockedByGroup | 1357 |\n| EntityIsAlreadyMember | 1359 |\n| OutstandingInvitationAcceptedInstead | 1363 |\n| RoleDoesNotExist | 1358 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/ApplyToGroup","href":"/api-reference/groups/apply-to-group","autogeneratedByOpenApi":true},{"title":"Block Entity","description":"Blocks a list of entities from joining a group.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/BlockEntity","href":"/api-reference/groups/block-entity","autogeneratedByOpenApi":true},{"title":"Change Member Role","description":"Changes the role membership of a list of entities from one role to another.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/ChangeMemberRole","href":"/api-reference/groups/change-member-role","autogeneratedByOpenApi":true},{"title":"Create Group","description":"Creates a new group.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GroupNameNotAvailable | 1368 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/CreateGroup","href":"/api-reference/groups/create-group","autogeneratedByOpenApi":true},{"title":"Create Role","description":"Creates a new group role.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DuplicateRoleId | 1360 |\n| RoleNameNotAvailable | 1367 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/CreateRole","href":"/api-reference/groups/create-role","autogeneratedByOpenApi":true},{"title":"Delete Group","description":"Deletes a group and all roles, invitations, join requests, and blocks associated with it.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/DeleteGroup","href":"/api-reference/groups/delete-group","autogeneratedByOpenApi":true},{"title":"Delete Role","description":"Deletes an existing role in a group.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n| RoleIsGroupAdmin | 1366 |\n| RoleIsGroupDefaultMember | 1365 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/DeleteRole","href":"/api-reference/groups/delete-role","autogeneratedByOpenApi":true},{"title":"Get Group","description":"Gets information about a group and its roles","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/GetGroup","href":"/api-reference/groups/get-group","autogeneratedByOpenApi":true},{"title":"Invite To Group","description":"Invites a player to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EntityBlockedByGroup | 1357 |\n| EntityIsAlreadyMember | 1359 |\n| OutstandingApplicationAcceptedInstead | 1364 |\n| RoleDoesNotExist | 1358 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/InviteToGroup","href":"/api-reference/groups/invite-to-group","autogeneratedByOpenApi":true},{"title":"Is Member","description":"Checks to see if an entity is a member of a group or role within the group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/IsMember","href":"/api-reference/groups/is-member","autogeneratedByOpenApi":true},{"title":"List Group Applications","description":"Lists all outstanding requests to join a group","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/ListGroupApplications","href":"/api-reference/groups/list-group-applications","autogeneratedByOpenApi":true},{"title":"List Group Blocks","description":"Lists all entities blocked from joining a group","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/ListGroupBlocks","href":"/api-reference/groups/list-group-blocks","autogeneratedByOpenApi":true},{"title":"List Group Invitations","description":"Lists all outstanding invitations for a group","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/ListGroupInvitations","href":"/api-reference/groups/list-group-invitations","autogeneratedByOpenApi":true},{"title":"List Group Members","description":"Lists all members for a group","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/ListGroupMembers","href":"/api-reference/groups/list-group-members","autogeneratedByOpenApi":true},{"title":"List Membership","description":"Lists all groups and roles for an entity","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/ListMembership","href":"/api-reference/groups/list-membership","autogeneratedByOpenApi":true},{"title":"List Membership Opportunities","description":"Lists all outstanding invitations and group applications for an entity","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/ListMembershipOpportunities","href":"/api-reference/groups/list-membership-opportunities","autogeneratedByOpenApi":true},{"title":"Remove Group Application","description":"Removes an application to join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GroupApplicationNotFound | 1362 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/RemoveGroupApplication","href":"/api-reference/groups/remove-group-application","autogeneratedByOpenApi":true},{"title":"Remove Group Invitation","description":"Removes an invitation join a group\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GroupInvitationNotFound | 1361 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/RemoveGroupInvitation","href":"/api-reference/groups/remove-group-invitation","autogeneratedByOpenApi":true},{"title":"Remove Members","description":"Removes members from a group.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/RemoveMembers","href":"/api-reference/groups/remove-members","autogeneratedByOpenApi":true},{"title":"Unblock Entity","description":"Unblocks a list of entities from joining a group","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/UnblockEntity","href":"/api-reference/groups/unblock-entity","autogeneratedByOpenApi":true},{"title":"Update Group","description":"Updates non-membership data about a group.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GroupNameNotAvailable | 1368 |\n| RoleDoesNotExist | 1358 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/UpdateGroup","href":"/api-reference/groups/update-group","autogeneratedByOpenApi":true},{"title":"Update Role","description":"Updates metadata about a role.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| RoleDoesNotExist | 1358 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/groups/groups.openapi.json post /Group/UpdateRole","href":"/api-reference/groups/update-role","autogeneratedByOpenApi":true}]}]},{"group":"Insights","pages":[{"title":"PlayFab Insights API","description":"Overview of the PlayFab Insights REST API for managing the Insights performance level and data storage retention, with its API version and operations.","href":"/services/playfab/api-references/rest/insights/overview"},{"group":"Analytics","pages":[{"title":"Get Details","openapi":"post /Insights/GetDetails","description":"Gets the current values for the Insights performance and data storage retention, list of pending operations, and the performance and data storage retention limits.","href":"/services/playfab/api-references/rest/insights/analytics/get-details"},{"title":"Get Limits","openapi":"post /Insights/GetLimits","description":"Retrieves the range of allowed values for performance and data storage retention values as well as the submeter details for each performance level.","href":"/services/playfab/api-references/rest/insights/analytics/get-limits"},{"title":"Get Operation Status","openapi":"post /Insights/GetOperationStatus","description":"Gets the status of a SetPerformance or SetStorageRetention operation.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InsightsManagementGetOperationStatusInvalidParameter | 1488 |\n| InsightsManagementOperationNotFound | 1483 |\n","href":"/services/playfab/api-references/rest/insights/analytics/get-operation-status"},{"title":"Get Pending Operations","openapi":"post /Insights/GetPendingOperations","description":"Gets a list of pending SetPerformance and/or SetStorageRetention operations for the title.","href":"/services/playfab/api-references/rest/insights/analytics/get-pending-operations"},{"title":"Set Performance","openapi":"post /Insights/SetPerformance","description":"Sets the Insights performance level value for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InsightsManagementDatabaseNotFound | 1482 |\n| InsightsManagementErrorPendingOperationExists | 1484 |\n| InsightsManagementSetPerformanceLevelInvalidParameter | 1485 |\n| PaidInsightsFeaturesNotEnabled | 1493 |\n| TitleNotOnUpdatedPricingPlan | 9000 |\n","href":"/services/playfab/api-references/rest/insights/analytics/set-performance"},{"title":"Set Storage Retention","openapi":"post /Insights/SetStorageRetention","description":"Sets the Insights data storage retention days value for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InsightsManagementDatabaseNotFound | 1482 |\n| InsightsManagementErrorPendingOperationExists | 1484 |\n| InsightsManagementSetStorageRetentionAboveMaximum | 1500 |\n| InsightsManagementSetStorageRetentionBelowMinimum | 1499 |\n| InsightsManagementSetStorageRetentionInvalidParameter | 1486 |\n| PaidInsightsFeaturesNotEnabled | 1493 |\n| TelemetryKeyLongInsightsRetentionNotAllowed | 14206 |\n| TitleNotOnUpdatedPricingPlan | 9000 |\n","href":"/services/playfab/api-references/rest/insights/analytics/set-storage-retention"}]},{"group":"Analytics","pages":[{"title":"Get Details","description":"Gets the current values for the Insights performance and data storage retention, list of pending operations, and the performance and data storage retention limits.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/insights/insights.openapi.json post /Insights/GetDetails","href":"/api-reference/analytics/get-details","autogeneratedByOpenApi":true},{"title":"Get Limits","description":"Retrieves the range of allowed values for performance and data storage retention values as well as the submeter details for each performance level.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/insights/insights.openapi.json post /Insights/GetLimits","href":"/api-reference/analytics/get-limits","autogeneratedByOpenApi":true},{"title":"Get Operation Status","description":"Gets the status of a SetPerformance or SetStorageRetention operation.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InsightsManagementGetOperationStatusInvalidParameter | 1488 |\n| InsightsManagementOperationNotFound | 1483 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/insights/insights.openapi.json post /Insights/GetOperationStatus","href":"/api-reference/analytics/get-operation-status","autogeneratedByOpenApi":true},{"title":"Get Pending Operations","description":"Gets a list of pending SetPerformance and/or SetStorageRetention operations for the title.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/insights/insights.openapi.json post /Insights/GetPendingOperations","href":"/api-reference/analytics/get-pending-operations","autogeneratedByOpenApi":true},{"title":"Set Performance","description":"Sets the Insights performance level value for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InsightsManagementDatabaseNotFound | 1482 |\n| InsightsManagementErrorPendingOperationExists | 1484 |\n| InsightsManagementSetPerformanceLevelInvalidParameter | 1485 |\n| PaidInsightsFeaturesNotEnabled | 1493 |\n| TitleNotOnUpdatedPricingPlan | 9000 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/insights/insights.openapi.json post /Insights/SetPerformance","href":"/api-reference/analytics/set-performance","autogeneratedByOpenApi":true},{"title":"Set Storage Retention","description":"Sets the Insights data storage retention days value for the title.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InsightsManagementDatabaseNotFound | 1482 |\n| InsightsManagementErrorPendingOperationExists | 1484 |\n| InsightsManagementSetStorageRetentionAboveMaximum | 1500 |\n| InsightsManagementSetStorageRetentionBelowMinimum | 1499 |\n| InsightsManagementSetStorageRetentionInvalidParameter | 1486 |\n| PaidInsightsFeaturesNotEnabled | 1493 |\n| TelemetryKeyLongInsightsRetentionNotAllowed | 14206 |\n| TitleNotOnUpdatedPricingPlan | 9000 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/insights/insights.openapi.json post /Insights/SetStorageRetention","href":"/api-reference/analytics/set-storage-retention","autogeneratedByOpenApi":true}]}]},{"group":"Localization","pages":[{"title":"PlayFab Localization API","description":"Overview of the PlayFab Localization REST API for managing language setup in your title, including the current API version and Localization operations.","href":"/services/playfab/api-references/rest/localization/overview"},{"group":"Localization","pages":[{"title":"Get Language List","openapi":"post /Locale/GetLanguageList","description":"Retrieves the list of allowed languages, only accessible by title entities","href":"/services/playfab/api-references/rest/localization/localization/get-language-list"}]},{"group":"Localization","pages":[{"title":"Get Language List","description":"Retrieves the list of allowed languages, only accessible by title entities","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/localization/localization.openapi.json post /Locale/GetLanguageList","href":"/api-reference/localization/get-language-list","autogeneratedByOpenApi":true}]}]},{"group":"Multiplayer","pages":[{"title":"PlayFab Multiplayer API","description":"Overview of the PlayFab Multiplayer REST API for multiplayer servers, parties, lobbies, matchmaking, PubSub, and TrueSkill, with its operation groups.","href":"/services/playfab/api-references/rest/multiplayer/overview"},{"group":"Lobby","pages":[{"title":"Create Lobby","openapi":"post /Lobby/CreateLobby","description":"Create a lobby.\n\nAllowed entity token types: game_server, title_player_account, title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyPlayerMaxLobbyLimitExceeded | 13008 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/create-lobby"},{"title":"Delete Lobby","openapi":"post /Lobby/DeleteLobby","description":"Delete a lobby.\n\nAllowed entity token types: game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/delete-lobby"},{"title":"Find Friend Lobbies","openapi":"post /Lobby/FindFriendLobbies","description":"Find lobbies which match certain criteria, and which friends are in.\n\nAllowed entity token types: title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/find-friend-lobbies"},{"title":"Find Lobbies","openapi":"post /Lobby/FindLobbies","description":"Find all the lobbies that match certain criteria.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/find-lobbies"},{"title":"Get Lobby","openapi":"post /Lobby/GetLobby","description":"Get a lobby.\n\nAllowed entity token types: title, game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/get-lobby"},{"title":"Invite To Lobby","openapi":"post /Lobby/InviteToLobby","description":"Send a notification to invite a player to a lobby.\n\nAllowed entity token types: title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyPlayerNotPresent | 13006 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/invite-to-lobby"},{"title":"Join Arranged Lobby","openapi":"post /Lobby/JoinArrangedLobby","description":"Join an Arranged lobby.\n\nAllowed entity token types: title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyMemberCannotRejoin | 13004 |\n| LobbyNotJoinable | 13003 |\n| LobbyPlayerAlreadyJoined | 13002 |\n| LobbyPlayerMaxLobbyLimitExceeded | 13008 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/join-arranged-lobby"},{"title":"Join Lobby","openapi":"post /Lobby/JoinLobby","description":"Join a lobby.\n\nAllowed entity token types: title_player_account, title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyMemberCannotRejoin | 13004 |\n| LobbyNotJoinable | 13003 |\n| LobbyPlayerAlreadyJoined | 13002 |\n| LobbyPlayerMaxLobbyLimitExceeded | 13008 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/join-lobby"},{"title":"Join Lobby As Server","openapi":"post /Lobby/JoinLobbyAsServer","description":"Preview: Join a lobby as a server entity. This is restricted to client lobbies which are using connections.\n\nAllowed entity token types: game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDifferentServerAlreadyJoined | 13014 |\n| LobbyDoesNotExist | 13000 |\n| LobbyDoesNotUseConnections | 13017 |\n| LobbyIsNotClientOwned | 13016 |\n| LobbyRateLimitExceeded | 13001 |\n| LobbyServerAlreadyJoined | 13015 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/join-lobby-as-server"},{"title":"Leave Lobby","openapi":"post /Lobby/LeaveLobby","description":"Leave a lobby.\n\nAllowed entity token types: title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyPlayerNotPresent | 13006 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/leave-lobby"},{"title":"Leave Lobby As Server","openapi":"post /Lobby/LeaveLobbyAsServer","description":"Preview: Request for server to leave a lobby. This is restricted to client owned lobbies which are using connections.\n\nAllowed entity token types: game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyDoesNotUseConnections | 13017 |\n| LobbyIsNotClientOwned | 13016 |\n| LobbyRateLimitExceeded | 13001 |\n| LobbyServerMismatch | 13012 |\n| LobbyServerNotFound | 13013 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/leave-lobby-as-server"},{"title":"Remove Member","openapi":"post /Lobby/RemoveMember","description":"Remove a member from a lobby.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyPlayerNotPresent | 13006 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/remove-member"},{"title":"Subscribe To Lobby Resource","openapi":"post /Lobby/SubscribeToLobbyResource","description":"Subscribe to lobby resource notifications.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n| PubSubConnectionHandleInvalid | 2503 |\n| PubSubConnectionNotFoundForEntity | 2502 |\n| PubSubSubscriptionLimitExceeded | 2504 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/subscribe-to-lobby-resource"},{"title":"Unsubscribe From Lobby Resource","openapi":"post /Lobby/UnsubscribeFromLobbyResource","description":"Unsubscribe from lobby notifications.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n| PubSubConnectionHandleInvalid | 2503 |\n| PubSubConnectionNotFoundForEntity | 2502 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/unsubscribe-from-lobby-resource"},{"title":"Update Lobby","openapi":"post /Lobby/UpdateLobby","description":"Update a lobby.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyCurrentOwnerStillConnected | 13010 |\n| LobbyCurrentPlayersMoreThanMaxPlayers | 13005 |\n| LobbyDoesNotExist | 13000 |\n| LobbyMemberIsNotOwner | 13011 |\n| LobbyNewOwnerMustBeConnected | 13009 |\n| LobbyRateLimitExceeded | 13001 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/update-lobby"},{"title":"Update Lobby As Server","openapi":"post /Lobby/UpdateLobbyAsServer","description":"Preview: Update fields related to a joined server in the lobby the server is in. Servers can keep a lobby from expiring by being the one to \"update\" the lobby in some way. Servers have no impact on last member leave/last member disconnect behavior.\n\nAllowed entity token types: game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n| LobbyServerMismatch | 13012 |\n| LobbyServerNotFound | 13013 |\n","href":"/services/playfab/api-references/rest/multiplayer/lobby/update-lobby-as-server"}]},{"group":"Matchmaking","pages":[{"title":"Cancel All Matchmaking Tickets For Player","openapi":"post /Match/CancelAllMatchmakingTicketsForPlayer","description":"Cancel all active tickets the player is a member of in a given queue.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/cancel-all-matchmaking-tickets-for-player"},{"title":"Cancel All Server Backfill Tickets For Player","openapi":"post /Match/CancelAllServerBackfillTicketsForPlayer","description":"Cancel all active backfill tickets the player is a member of in a given queue.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/cancel-all-server-backfill-tickets-for-player"},{"title":"Cancel Matchmaking Ticket","openapi":"post /Match/CancelMatchmakingTicket","description":"Cancel a matchmaking ticket.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingPlayerHasNotJoinedTicket | 2053 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingRequestTypeMismatch | 2058 |\n| MatchmakingTicketAlreadyCompleted | 2029 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/cancel-matchmaking-ticket"},{"title":"Cancel Server Backfill Ticket","openapi":"post /Match/CancelServerBackfillTicket","description":"Cancel a server backfill ticket.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRequestTypeMismatch | 2058 |\n| MatchmakingTicketAlreadyCompleted | 2029 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/cancel-server-backfill-ticket"},{"title":"Create Matchmaking Ticket","openapi":"post /Match/CreateMatchmakingTicket","description":"Create a matchmaking ticket as a client.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingBadRequest | 2059 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMemberProfileInvalid | 2032 |\n| MatchmakingNumberOfPlayersInTicketTooLarge | 2044 |\n| MatchmakingPlayerAttributesInvalid | 2002 |\n| MatchmakingPlayerAttributesTooLarge | 2043 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingTicketMembershipLimitExceeded | 2055 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/create-matchmaking-ticket"},{"title":"Create Server Backfill Ticket","openapi":"post /Match/CreateServerBackfillTicket","description":"Create a backfill matchmaking ticket as a server. A backfill ticket represents an ongoing game. The matchmaking service automatically starts matching the backfill ticket against other matchmaking tickets. Backfill tickets cannot match with other backfill tickets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingBadRequest | 2059 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMemberProfileInvalid | 2032 |\n| MatchmakingNumberOfPlayersInTicketTooLarge | 2044 |\n| MatchmakingPlayerAttributesInvalid | 2002 |\n| MatchmakingPlayerAttributesTooLarge | 2043 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingTicketMembershipLimitExceeded | 2055 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/create-server-backfill-ticket"},{"title":"Create Server Matchmaking Ticket","openapi":"post /Match/CreateServerMatchmakingTicket","description":"Create a matchmaking ticket as a server. The matchmaking service automatically starts matching the ticket against other matchmaking tickets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMemberProfileInvalid | 2032 |\n| MatchmakingNumberOfPlayersInTicketTooLarge | 2044 |\n| MatchmakingPlayerAttributesInvalid | 2002 |\n| MatchmakingPlayerAttributesTooLarge | 2043 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingTicketMembershipLimitExceeded | 2055 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/create-server-matchmaking-ticket"},{"title":"Get Match","openapi":"post /Match/GetMatch","description":"Get a match.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMatchNotFound | 2017 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/get-match"},{"title":"Get Matchmaking Ticket","openapi":"post /Match/GetMatchmakingTicket","description":"Get a matchmaking ticket by ticket Id.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingRequestTypeMismatch | 2058 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/get-matchmaking-ticket"},{"title":"Get Queue Statistics","openapi":"post /Match/GetQueueStatistics","description":"Get the statistics for a queue.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/get-queue-statistics"},{"title":"Get Server Backfill Ticket","openapi":"post /Match/GetServerBackfillTicket","description":"Get a matchmaking backfill ticket by ticket Id.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingRequestTypeMismatch | 2058 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/get-server-backfill-ticket"},{"title":"Join Matchmaking Ticket","openapi":"post /Match/JoinMatchmakingTicket","description":"Join a matchmaking ticket.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAlreadyJoinedTicket | 2028 |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMemberProfileInvalid | 2032 |\n| MatchmakingPlayerAttributesInvalid | 2002 |\n| MatchmakingPlayerAttributesTooLarge | 2043 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingTicketAlreadyCompleted | 2029 |\n| MatchmakingTicketMembershipLimitExceeded | 2055 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/join-matchmaking-ticket"},{"title":"List Matchmaking Tickets For Player","openapi":"post /Match/ListMatchmakingTicketsForPlayer","description":"List all matchmaking ticket Ids the user is a member of.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/list-matchmaking-tickets-for-player"},{"title":"List Server Backfill Tickets For Player","openapi":"post /Match/ListServerBackfillTicketsForPlayer","description":"List all server backfill ticket Ids the user is a member of.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/list-server-backfill-tickets-for-player"},{"title":"Subscribe To Matchmaking Resource","openapi":"post /Match/SubscribeToMatchmakingResource","description":"Subscribe to match resource notifications.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingBadRequest | 2059 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n| PubSubConnectionHandleInvalid | 2503 |\n| PubSubConnectionNotFoundForEntity | 2502 |\n| PubSubSubscriptionLimitExceeded | 2504 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/subscribe-to-matchmaking-resource"},{"title":"Unsubscribe From Matchmaking Resource","openapi":"post /Match/UnsubscribeFromMatchmakingResource","description":"Unsubscribe from match resource notifications.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingBadRequest | 2059 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n| PubSubConnectionHandleInvalid | 2503 |\n| PubSubConnectionNotFoundForEntity | 2502 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking/unsubscribe-from-matchmaking-resource"}]},{"group":"Matchmaking Admin","pages":[{"title":"Get Matchmaking Queue","openapi":"post /Match/GetMatchmakingQueue","description":"SDK support is limited to C# and Java for this API. Get a matchmaking queue configuration.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingQueueNotFound | 2016 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking-admin/get-matchmaking-queue"},{"title":"List Matchmaking Queues","openapi":"post /Match/ListMatchmakingQueues","description":"SDK support is limited to C# and Java for this API. List all matchmaking queue configs.","href":"/services/playfab/api-references/rest/multiplayer/matchmaking-admin/list-matchmaking-queues"},{"title":"Remove Matchmaking Queue","openapi":"post /Match/RemoveMatchmakingQueue","description":"SDK support is limited to C# and Java for this API. Remove a matchmaking queue config.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingQueueNotFound | 2016 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking-admin/remove-matchmaking-queue"},{"title":"Set Matchmaking Queue","openapi":"post /Match/SetMatchmakingQueue","description":"SDK support is limited to C# and Java for this API. Create or update a matchmaking queue configuration.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingQueueConfigInvalid | 2031 |\n| MatchmakingQueueLimitExceeded | 2057 |\n","href":"/services/playfab/api-references/rest/multiplayer/matchmaking-admin/set-matchmaking-queue"}]},{"group":"Multiplayer Server","pages":[{"title":"Create Build Alias","openapi":"post /MultiplayerServer/CreateBuildAlias","description":"Creates a multiplayer server build alias.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/create-build-alias"},{"title":"Create Build With Custom Container","openapi":"post /MultiplayerServer/CreateBuildWithCustomContainer","description":"Creates a multiplayer server build with a custom container.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/create-build-with-custom-container"},{"title":"Create Build With Managed Container","openapi":"post /MultiplayerServer/CreateBuildWithManagedContainer","description":"Creates a multiplayer server build with a managed container.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/create-build-with-managed-container"},{"title":"Create Build With Process Based Server","openapi":"post /MultiplayerServer/CreateBuildWithProcessBasedServer","description":"Creates a multiplayer server build with the server running as a process.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/create-build-with-process-based-server"},{"title":"Create Remote User","openapi":"post /MultiplayerServer/CreateRemoteUser","description":"Creates a remote user to log on to a VM for a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/create-remote-user"},{"title":"Create Title Multiplayer Servers Quota Change","openapi":"post /MultiplayerServer/CreateTitleMultiplayerServersQuotaChange","description":"Creates a request to change a title's multiplayer server quotas.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/create-title-multiplayer-servers-quota-change"},{"title":"Delete Asset","openapi":"post /MultiplayerServer/DeleteAsset","description":"Deletes a multiplayer server game asset for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/delete-asset"},{"title":"Delete Build","openapi":"post /MultiplayerServer/DeleteBuild","description":"Deletes a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerBuildReferencedByMatchmakingQueue | 6002 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/delete-build"},{"title":"Delete Build Alias","openapi":"post /MultiplayerServer/DeleteBuildAlias","description":"Deletes a multiplayer server build alias.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBuildAliasReferencedByMatchmakingQueue | 6004 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/delete-build-alias"},{"title":"Delete Build Region","openapi":"post /MultiplayerServer/DeleteBuildRegion","description":"Removes a multiplayer server build's region.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/delete-build-region"},{"title":"Delete Certificate","openapi":"post /MultiplayerServer/DeleteCertificate","description":"Deletes a multiplayer server game certificate.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/delete-certificate"},{"title":"Delete Container Image Repository","openapi":"post /MultiplayerServer/DeleteContainerImageRepository","description":"Deletes a container image repository.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/delete-container-image-repository"},{"title":"Delete Remote User","openapi":"post /MultiplayerServer/DeleteRemoteUser","description":"Deletes a remote user to log on to a VM for a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/delete-remote-user"},{"title":"Delete Secret","openapi":"post /MultiplayerServer/DeleteSecret","description":"Deletes a multiplayer server game secret.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/delete-secret"},{"title":"Enable Multiplayer Servers For Title","openapi":"post /MultiplayerServer/EnableMultiplayerServersForTitle","description":"Enables the multiplayer server feature for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| CannotEnableMultiplayerServersForTitle | 1443 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/enable-multiplayer-servers-for-title"},{"title":"Get Asset Download Url","openapi":"post /MultiplayerServer/GetAssetDownloadUrl","description":"Gets a URL that can be used to download the specified asset. A sample pre-authenticated url - https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05\u0026ss=b\u0026srt=sco\u0026sp=rw\u0026st=startDate\u0026se=endDate\u0026spr=https\u0026sig=sampleSig\u0026api-version=2017-07-29\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-asset-download-url"},{"title":"Get Asset Upload Url","openapi":"post /MultiplayerServer/GetAssetUploadUrl","description":"Gets the URL to upload assets to. A sample pre-authenticated url - https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05\u0026ss=b\u0026srt=sco\u0026sp=rw\u0026st=startDate\u0026se=endDate\u0026spr=https\u0026sig=sampleSig\u0026api-version=2017-07-29\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-asset-upload-url"},{"title":"Get Build","openapi":"post /MultiplayerServer/GetBuild","description":"Gets a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-build"},{"title":"Get Build Alias","openapi":"post /MultiplayerServer/GetBuildAlias","description":"Gets a multiplayer server build alias.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-build-alias"},{"title":"Get Container Registry Credentials","openapi":"post /MultiplayerServer/GetContainerRegistryCredentials","description":"Gets the credentials to the container registry.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-container-registry-credentials"},{"title":"Get Multiplayer Server Details","openapi":"post /MultiplayerServer/GetMultiplayerServerDetails","description":"Gets multiplayer server session details for a build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-multiplayer-server-details"},{"title":"Get Multiplayer Server Logs","openapi":"post /MultiplayerServer/GetMultiplayerServerLogs","description":"Gets multiplayer server logs after a server has terminated.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-multiplayer-server-logs"},{"title":"Get Multiplayer Session Logs By Session Id","openapi":"post /MultiplayerServer/GetMultiplayerSessionLogsBySessionId","description":"Gets multiplayer server logs after a server has terminated.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-multiplayer-session-logs-by-session-id"},{"title":"Get Remote Login Endpoint","openapi":"post /MultiplayerServer/GetRemoteLoginEndpoint","description":"Gets a remote login endpoint to a VM that is hosting a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-remote-login-endpoint"},{"title":"Get Title Enabled For Multiplayer Servers Status","openapi":"post /MultiplayerServer/GetTitleEnabledForMultiplayerServersStatus","description":"Gets the status of whether a title is enabled for the multiplayer server feature.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-title-enabled-for-multiplayer-servers-status"},{"title":"Get Title Multiplayer Servers Quota Change","openapi":"post /MultiplayerServer/GetTitleMultiplayerServersQuotaChange","description":"Gets a title's server quota change request.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-title-multiplayer-servers-quota-change"},{"title":"Get Title Multiplayer Servers Quotas","openapi":"post /MultiplayerServer/GetTitleMultiplayerServersQuotas","description":"Gets the quotas for a title in relation to multiplayer servers.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/get-title-multiplayer-servers-quotas"},{"title":"List Archived Multiplayer Servers","openapi":"post /MultiplayerServer/ListArchivedMultiplayerServers","description":"Lists archived multiplayer server sessions for a build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-archived-multiplayer-servers"},{"title":"List Asset Summaries","openapi":"post /MultiplayerServer/ListAssetSummaries","description":"Lists multiplayer server game assets for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-asset-summaries"},{"title":"List Build Aliases","openapi":"post /MultiplayerServer/ListBuildAliases","description":"Lists details of all build aliases for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.\n\nAllowed entity token types: title, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-build-aliases"},{"title":"List Build Summaries V2","openapi":"post /MultiplayerServer/ListBuildSummariesV2","description":"Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.\n\nAllowed entity token types: title, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-build-summaries-v2"},{"title":"List Certificate Summaries","openapi":"post /MultiplayerServer/ListCertificateSummaries","description":"Lists multiplayer server game certificates for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-certificate-summaries"},{"title":"List Container Images","openapi":"post /MultiplayerServer/ListContainerImages","description":"Lists custom container images for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-container-images"},{"title":"List Container Image Tags","openapi":"post /MultiplayerServer/ListContainerImageTags","description":"Lists the tags for a custom container image.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-container-image-tags"},{"title":"List Multiplayer Servers","openapi":"post /MultiplayerServer/ListMultiplayerServers","description":"Lists multiplayer server sessions for a build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-multiplayer-servers"},{"title":"List Party Qos Servers","openapi":"post /MultiplayerServer/ListPartyQosServers","description":"Lists quality of service servers for party.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-party-qos-servers"},{"title":"List Qos Servers For Title","openapi":"post /MultiplayerServer/ListQosServersForTitle","description":"Lists quality of service servers for the title. By default, servers are only returned for regions where a Multiplayer Servers build has been deployed.\n\nAllowed entity token types: title_player_account, title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-qos-servers-for-title"},{"title":"List Secret Summaries","openapi":"post /MultiplayerServer/ListSecretSummaries","description":"Lists multiplayer server game secrets for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-secret-summaries"},{"title":"List Title Multiplayer Servers Quota Changes","openapi":"post /MultiplayerServer/ListTitleMultiplayerServersQuotaChanges","description":"List all server quota change requests for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-title-multiplayer-servers-quota-changes"},{"title":"List Virtual Machine Summaries","openapi":"post /MultiplayerServer/ListVirtualMachineSummaries","description":"Lists virtual machines for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-virtual-machine-summaries"},{"title":"Request Multiplayer Server","openapi":"post /MultiplayerServer/RequestMultiplayerServer","description":"Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client to request a server with player entity token.\n\nAllowed entity token types: title, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/request-multiplayer-server"},{"title":"Request Party Service","openapi":"post /Party/RequestPartyService","description":"Request a party session.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PartyBadRequest | 1434 |\n| PartyInternalServerError | 1439 |\n| PartyNotFound | 1437 |\n| PartyRequestsThrottledFromRateLimiter | 1504 |\n| PartyTooManyRequests | 1441 |\n| PartyUnauthorized | 1435 |\n| PartyUnavailable | 1440 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/request-party-service"},{"title":"Rollover Container Registry Credentials","openapi":"post /MultiplayerServer/RolloverContainerRegistryCredentials","description":"Rolls over the credentials to the container registry.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/rollover-container-registry-credentials"},{"title":"Shutdown Multiplayer Server","openapi":"post /MultiplayerServer/ShutdownMultiplayerServer","description":"Shuts down a multiplayer server session.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/shutdown-multiplayer-server"},{"title":"Untag Container Image","openapi":"post /MultiplayerServer/UntagContainerImage","description":"Untags a container image.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/untag-container-image"},{"title":"Update Build Alias","openapi":"post /MultiplayerServer/UpdateBuildAlias","description":"Creates a multiplayer server build alias.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/update-build-alias"},{"title":"Update Build Name","openapi":"post /MultiplayerServer/UpdateBuildName","description":"Updates a multiplayer server build's name.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/update-build-name"},{"title":"Update Build Region","openapi":"post /MultiplayerServer/UpdateBuildRegion","description":"Updates a multiplayer server build's region. If the region is not yet created, it will be created\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/update-build-region"},{"title":"Update Build Regions","openapi":"post /MultiplayerServer/UpdateBuildRegions","description":"Updates a multiplayer server build's regions.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/update-build-regions"},{"title":"Upload Certificate","openapi":"post /MultiplayerServer/UploadCertificate","description":"Uploads a multiplayer server game certificate.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/upload-certificate"},{"title":"Upload Secret","openapi":"post /MultiplayerServer/UploadSecret","description":"Uploads a multiplayer server game secret.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/multiplayer/multiplayer-server/upload-secret"}]},{"group":"Pub Sub","pages":[{"title":"Negotiate","openapi":"post /PubSub/Negotiate","description":"Negotiate a SignalR Connection to the PubSub service, as the first step of establishing the connection. Note: SignalR client implementations expect the Hub URL to omit the `/negotiate` portion of this path (ex: HubConnection should be passed a URL that ends in `...playfabapi.com/pubsub`). When starting the connection, SignalR clients will automatically append `/negotiate` to the end of the URL of the hub. The SignalR client will interpret the response object to establish a persistent connection to PubSub. https://learn.microsoft.com/aspnet/core/signalr/dotnet-client#connect-to-a-hub https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md#post-endpoint-basenegotiate-request\n\nAllowed entity token types: title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InternalServerError | 1110 |\n| InvalidParams | 1000 |\n| PubSubFeatureNotEnabledForTitle | 2500 |\n| PubSubTooManyRequests | 2501 |\n| ServiceUnavailable | 1123 |\n","href":"/services/playfab/api-references/rest/multiplayer/pub-sub/negotiate"}]},{"group":"Lobby","pages":[{"title":"Create Lobby","description":"Create a lobby.\n\nAllowed entity token types: game_server, title_player_account, title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyPlayerMaxLobbyLimitExceeded | 13008 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/CreateLobby","href":"/api-reference/lobby/create-lobby","autogeneratedByOpenApi":true},{"title":"Delete Lobby","description":"Delete a lobby.\n\nAllowed entity token types: game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/DeleteLobby","href":"/api-reference/lobby/delete-lobby","autogeneratedByOpenApi":true},{"title":"Find Friend Lobbies","description":"Find lobbies which match certain criteria, and which friends are in.\n\nAllowed entity token types: title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/FindFriendLobbies","href":"/api-reference/lobby/find-friend-lobbies","autogeneratedByOpenApi":true},{"title":"Find Lobbies","description":"Find all the lobbies that match certain criteria.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/FindLobbies","href":"/api-reference/lobby/find-lobbies","autogeneratedByOpenApi":true},{"title":"Get Lobby","description":"Get a lobby.\n\nAllowed entity token types: title, game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/GetLobby","href":"/api-reference/lobby/get-lobby","autogeneratedByOpenApi":true},{"title":"Invite To Lobby","description":"Send a notification to invite a player to a lobby.\n\nAllowed entity token types: title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyPlayerNotPresent | 13006 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/InviteToLobby","href":"/api-reference/lobby/invite-to-lobby","autogeneratedByOpenApi":true},{"title":"Join Arranged Lobby","description":"Join an Arranged lobby.\n\nAllowed entity token types: title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyMemberCannotRejoin | 13004 |\n| LobbyNotJoinable | 13003 |\n| LobbyPlayerAlreadyJoined | 13002 |\n| LobbyPlayerMaxLobbyLimitExceeded | 13008 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/JoinArrangedLobby","href":"/api-reference/lobby/join-arranged-lobby","autogeneratedByOpenApi":true},{"title":"Join Lobby","description":"Join a lobby.\n\nAllowed entity token types: title_player_account, title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyMemberCannotRejoin | 13004 |\n| LobbyNotJoinable | 13003 |\n| LobbyPlayerAlreadyJoined | 13002 |\n| LobbyPlayerMaxLobbyLimitExceeded | 13008 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/JoinLobby","href":"/api-reference/lobby/join-lobby","autogeneratedByOpenApi":true},{"title":"Join Lobby As Server","description":"Preview: Join a lobby as a server entity. This is restricted to client lobbies which are using connections.\n\nAllowed entity token types: game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDifferentServerAlreadyJoined | 13014 |\n| LobbyDoesNotExist | 13000 |\n| LobbyDoesNotUseConnections | 13017 |\n| LobbyIsNotClientOwned | 13016 |\n| LobbyRateLimitExceeded | 13001 |\n| LobbyServerAlreadyJoined | 13015 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/JoinLobbyAsServer","href":"/api-reference/lobby/join-lobby-as-server","autogeneratedByOpenApi":true},{"title":"Leave Lobby","description":"Leave a lobby.\n\nAllowed entity token types: title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyPlayerNotPresent | 13006 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/LeaveLobby","href":"/api-reference/lobby/leave-lobby","autogeneratedByOpenApi":true},{"title":"Leave Lobby As Server","description":"Preview: Request for server to leave a lobby. This is restricted to client owned lobbies which are using connections.\n\nAllowed entity token types: game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyDoesNotUseConnections | 13017 |\n| LobbyIsNotClientOwned | 13016 |\n| LobbyRateLimitExceeded | 13001 |\n| LobbyServerMismatch | 13012 |\n| LobbyServerNotFound | 13013 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/LeaveLobbyAsServer","href":"/api-reference/lobby/leave-lobby-as-server","autogeneratedByOpenApi":true},{"title":"Remove Member","description":"Remove a member from a lobby.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyPlayerNotPresent | 13006 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/RemoveMember","href":"/api-reference/lobby/remove-member","autogeneratedByOpenApi":true},{"title":"Subscribe To Lobby Resource","description":"Subscribe to lobby resource notifications.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n| PubSubConnectionHandleInvalid | 2503 |\n| PubSubConnectionNotFoundForEntity | 2502 |\n| PubSubSubscriptionLimitExceeded | 2504 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/SubscribeToLobbyResource","href":"/api-reference/lobby/subscribe-to-lobby-resource","autogeneratedByOpenApi":true},{"title":"Unsubscribe From Lobby Resource","description":"Unsubscribe from lobby notifications.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n| PubSubConnectionHandleInvalid | 2503 |\n| PubSubConnectionNotFoundForEntity | 2502 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/UnsubscribeFromLobbyResource","href":"/api-reference/lobby/unsubscribe-from-lobby-resource","autogeneratedByOpenApi":true},{"title":"Update Lobby","description":"Update a lobby.\n\nAllowed entity token types: game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyCurrentOwnerStillConnected | 13010 |\n| LobbyCurrentPlayersMoreThanMaxPlayers | 13005 |\n| LobbyDoesNotExist | 13000 |\n| LobbyMemberIsNotOwner | 13011 |\n| LobbyNewOwnerMustBeConnected | 13009 |\n| LobbyRateLimitExceeded | 13001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/UpdateLobby","href":"/api-reference/lobby/update-lobby","autogeneratedByOpenApi":true},{"title":"Update Lobby As Server","description":"Preview: Update fields related to a joined server in the lobby the server is in. Servers can keep a lobby from expiring by being the one to \"update\" the lobby in some way. Servers have no impact on last member leave/last member disconnect behavior.\n\nAllowed entity token types: game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LobbyBadRequest | 13007 |\n| LobbyDoesNotExist | 13000 |\n| LobbyRateLimitExceeded | 13001 |\n| LobbyServerMismatch | 13012 |\n| LobbyServerNotFound | 13013 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Lobby/UpdateLobbyAsServer","href":"/api-reference/lobby/update-lobby-as-server","autogeneratedByOpenApi":true}]},{"group":"Matchmaking","pages":[{"title":"Cancel All Matchmaking Tickets For Player","description":"Cancel all active tickets the player is a member of in a given queue.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/CancelAllMatchmakingTicketsForPlayer","href":"/api-reference/matchmaking/cancel-all-matchmaking-tickets-for-player","autogeneratedByOpenApi":true},{"title":"Cancel All Server Backfill Tickets For Player","description":"Cancel all active backfill tickets the player is a member of in a given queue.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/CancelAllServerBackfillTicketsForPlayer","href":"/api-reference/matchmaking/cancel-all-server-backfill-tickets-for-player","autogeneratedByOpenApi":true},{"title":"Cancel Matchmaking Ticket","description":"Cancel a matchmaking ticket.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingPlayerHasNotJoinedTicket | 2053 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingRequestTypeMismatch | 2058 |\n| MatchmakingTicketAlreadyCompleted | 2029 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/CancelMatchmakingTicket","href":"/api-reference/matchmaking/cancel-matchmaking-ticket","autogeneratedByOpenApi":true},{"title":"Cancel Server Backfill Ticket","description":"Cancel a server backfill ticket.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRequestTypeMismatch | 2058 |\n| MatchmakingTicketAlreadyCompleted | 2029 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/CancelServerBackfillTicket","href":"/api-reference/matchmaking/cancel-server-backfill-ticket","autogeneratedByOpenApi":true},{"title":"Create Matchmaking Ticket","description":"Create a matchmaking ticket as a client.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingBadRequest | 2059 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMemberProfileInvalid | 2032 |\n| MatchmakingNumberOfPlayersInTicketTooLarge | 2044 |\n| MatchmakingPlayerAttributesInvalid | 2002 |\n| MatchmakingPlayerAttributesTooLarge | 2043 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingTicketMembershipLimitExceeded | 2055 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/CreateMatchmakingTicket","href":"/api-reference/matchmaking/create-matchmaking-ticket","autogeneratedByOpenApi":true},{"title":"Create Server Backfill Ticket","description":"Create a backfill matchmaking ticket as a server. A backfill ticket represents an ongoing game. The matchmaking service automatically starts matching the backfill ticket against other matchmaking tickets. Backfill tickets cannot match with other backfill tickets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingBadRequest | 2059 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMemberProfileInvalid | 2032 |\n| MatchmakingNumberOfPlayersInTicketTooLarge | 2044 |\n| MatchmakingPlayerAttributesInvalid | 2002 |\n| MatchmakingPlayerAttributesTooLarge | 2043 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingTicketMembershipLimitExceeded | 2055 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/CreateServerBackfillTicket","href":"/api-reference/matchmaking/create-server-backfill-ticket","autogeneratedByOpenApi":true},{"title":"Create Server Matchmaking Ticket","description":"Create a matchmaking ticket as a server. The matchmaking service automatically starts matching the ticket against other matchmaking tickets.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMemberProfileInvalid | 2032 |\n| MatchmakingNumberOfPlayersInTicketTooLarge | 2044 |\n| MatchmakingPlayerAttributesInvalid | 2002 |\n| MatchmakingPlayerAttributesTooLarge | 2043 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingTicketMembershipLimitExceeded | 2055 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/CreateServerMatchmakingTicket","href":"/api-reference/matchmaking/create-server-matchmaking-ticket","autogeneratedByOpenApi":true},{"title":"Get Match","description":"Get a match.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMatchNotFound | 2017 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/GetMatch","href":"/api-reference/matchmaking/get-match","autogeneratedByOpenApi":true},{"title":"Get Matchmaking Ticket","description":"Get a matchmaking ticket by ticket Id.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingRequestTypeMismatch | 2058 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/GetMatchmakingTicket","href":"/api-reference/matchmaking/get-matchmaking-ticket","autogeneratedByOpenApi":true},{"title":"Get Queue Statistics","description":"Get the statistics for a queue.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/GetQueueStatistics","href":"/api-reference/matchmaking/get-queue-statistics","autogeneratedByOpenApi":true},{"title":"Get Server Backfill Ticket","description":"Get a matchmaking backfill ticket by ticket Id.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingRequestTypeMismatch | 2058 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/GetServerBackfillTicket","href":"/api-reference/matchmaking/get-server-backfill-ticket","autogeneratedByOpenApi":true},{"title":"Join Matchmaking Ticket","description":"Join a matchmaking ticket.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAlreadyJoinedTicket | 2028 |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingMemberProfileInvalid | 2032 |\n| MatchmakingPlayerAttributesInvalid | 2002 |\n| MatchmakingPlayerAttributesTooLarge | 2043 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingTicketAlreadyCompleted | 2029 |\n| MatchmakingTicketMembershipLimitExceeded | 2055 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/JoinMatchmakingTicket","href":"/api-reference/matchmaking/join-matchmaking-ticket","autogeneratedByOpenApi":true},{"title":"List Matchmaking Tickets For Player","description":"List all matchmaking ticket Ids the user is a member of.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/ListMatchmakingTicketsForPlayer","href":"/api-reference/matchmaking/list-matchmaking-tickets-for-player","autogeneratedByOpenApi":true},{"title":"List Server Backfill Tickets For Player","description":"List all server backfill ticket Ids the user is a member of.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingQueueNotFound | 2016 |\n| MatchmakingRateLimitExceeded | 2054 |\n| MatchmakingUnauthorized | 2056 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/ListServerBackfillTicketsForPlayer","href":"/api-reference/matchmaking/list-server-backfill-tickets-for-player","autogeneratedByOpenApi":true},{"title":"Subscribe To Matchmaking Resource","description":"Subscribe to match resource notifications.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingBadRequest | 2059 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n| PubSubConnectionHandleInvalid | 2503 |\n| PubSubConnectionNotFoundForEntity | 2502 |\n| PubSubSubscriptionLimitExceeded | 2504 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/SubscribeToMatchmakingResource","href":"/api-reference/matchmaking/subscribe-to-matchmaking-resource","autogeneratedByOpenApi":true},{"title":"Unsubscribe From Matchmaking Resource","description":"Unsubscribe from match resource notifications.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingAttributeInvalid | 2046 |\n| MatchmakingBadRequest | 2059 |\n| MatchmakingEntityInvalid | 2001 |\n| MatchmakingTicketNotFound | 2018 |\n| MatchmakingUnauthorized | 2056 |\n| PubSubConnectionHandleInvalid | 2503 |\n| PubSubConnectionNotFoundForEntity | 2502 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/UnsubscribeFromMatchmakingResource","href":"/api-reference/matchmaking/unsubscribe-from-matchmaking-resource","autogeneratedByOpenApi":true}]},{"group":"Matchmaking Admin","pages":[{"title":"Get Matchmaking Queue","description":"SDK support is limited to C# and Java for this API. Get a matchmaking queue configuration.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingQueueNotFound | 2016 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/GetMatchmakingQueue","href":"/api-reference/matchmaking-admin/get-matchmaking-queue","autogeneratedByOpenApi":true},{"title":"List Matchmaking Queues","description":"SDK support is limited to C# and Java for this API. List all matchmaking queue configs.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/ListMatchmakingQueues","href":"/api-reference/matchmaking-admin/list-matchmaking-queues","autogeneratedByOpenApi":true},{"title":"Remove Matchmaking Queue","description":"SDK support is limited to C# and Java for this API. Remove a matchmaking queue config.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingQueueNotFound | 2016 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/RemoveMatchmakingQueue","href":"/api-reference/matchmaking-admin/remove-matchmaking-queue","autogeneratedByOpenApi":true},{"title":"Set Matchmaking Queue","description":"SDK support is limited to C# and Java for this API. Create or update a matchmaking queue configuration.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MatchmakingQueueConfigInvalid | 2031 |\n| MatchmakingQueueLimitExceeded | 2057 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Match/SetMatchmakingQueue","href":"/api-reference/matchmaking-admin/set-matchmaking-queue","autogeneratedByOpenApi":true}]},{"group":"MultiplayerServer","pages":[{"title":"Create Build Alias","description":"Creates a multiplayer server build alias.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/CreateBuildAlias","href":"/api-reference/multiplayerserver/create-build-alias","autogeneratedByOpenApi":true},{"title":"Create Build With Custom Container","description":"Creates a multiplayer server build with a custom container.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/CreateBuildWithCustomContainer","href":"/api-reference/multiplayerserver/create-build-with-custom-container","autogeneratedByOpenApi":true},{"title":"Create Build With Managed Container","description":"Creates a multiplayer server build with a managed container.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/CreateBuildWithManagedContainer","href":"/api-reference/multiplayerserver/create-build-with-managed-container","autogeneratedByOpenApi":true},{"title":"Create Build With Process Based Server","description":"Creates a multiplayer server build with the server running as a process.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/CreateBuildWithProcessBasedServer","href":"/api-reference/multiplayerserver/create-build-with-process-based-server","autogeneratedByOpenApi":true},{"title":"Create Remote User","description":"Creates a remote user to log on to a VM for a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/CreateRemoteUser","href":"/api-reference/multiplayerserver/create-remote-user","autogeneratedByOpenApi":true},{"title":"Create Title Multiplayer Servers Quota Change","description":"Creates a request to change a title's multiplayer server quotas.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/CreateTitleMultiplayerServersQuotaChange","href":"/api-reference/multiplayerserver/create-title-multiplayer-servers-quota-change","autogeneratedByOpenApi":true},{"title":"Delete Asset","description":"Deletes a multiplayer server game asset for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/DeleteAsset","href":"/api-reference/multiplayerserver/delete-asset","autogeneratedByOpenApi":true},{"title":"Delete Build","description":"Deletes a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerBuildReferencedByMatchmakingQueue | 6002 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/DeleteBuild","href":"/api-reference/multiplayerserver/delete-build","autogeneratedByOpenApi":true},{"title":"Delete Build Alias","description":"Deletes a multiplayer server build alias.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBuildAliasReferencedByMatchmakingQueue | 6004 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/DeleteBuildAlias","href":"/api-reference/multiplayerserver/delete-build-alias","autogeneratedByOpenApi":true},{"title":"Delete Build Region","description":"Removes a multiplayer server build's region.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/DeleteBuildRegion","href":"/api-reference/multiplayerserver/delete-build-region","autogeneratedByOpenApi":true},{"title":"Delete Certificate","description":"Deletes a multiplayer server game certificate.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/DeleteCertificate","href":"/api-reference/multiplayerserver/delete-certificate","autogeneratedByOpenApi":true},{"title":"Delete Container Image Repository","description":"Deletes a container image repository.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/DeleteContainerImageRepository","href":"/api-reference/multiplayerserver/delete-container-image-repository","autogeneratedByOpenApi":true},{"title":"Delete Remote User","description":"Deletes a remote user to log on to a VM for a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/DeleteRemoteUser","href":"/api-reference/multiplayerserver/delete-remote-user","autogeneratedByOpenApi":true},{"title":"Delete Secret","description":"Deletes a multiplayer server game secret.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/DeleteSecret","href":"/api-reference/multiplayerserver/delete-secret","autogeneratedByOpenApi":true},{"title":"Enable Multiplayer Servers For Title","description":"Enables the multiplayer server feature for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| CannotEnableMultiplayerServersForTitle | 1443 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/EnableMultiplayerServersForTitle","href":"/api-reference/multiplayerserver/enable-multiplayer-servers-for-title","autogeneratedByOpenApi":true},{"title":"Get Asset Download Url","description":"Gets a URL that can be used to download the specified asset. A sample pre-authenticated url - https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05\u0026ss=b\u0026srt=sco\u0026sp=rw\u0026st=startDate\u0026se=endDate\u0026spr=https\u0026sig=sampleSig\u0026api-version=2017-07-29\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetAssetDownloadUrl","href":"/api-reference/multiplayerserver/get-asset-download-url","autogeneratedByOpenApi":true},{"title":"Get Asset Upload Url","description":"Gets the URL to upload assets to. A sample pre-authenticated url - https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05\u0026ss=b\u0026srt=sco\u0026sp=rw\u0026st=startDate\u0026se=endDate\u0026spr=https\u0026sig=sampleSig\u0026api-version=2017-07-29\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetAssetUploadUrl","href":"/api-reference/multiplayerserver/get-asset-upload-url","autogeneratedByOpenApi":true},{"title":"Get Build","description":"Gets a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetBuild","href":"/api-reference/multiplayerserver/get-build","autogeneratedByOpenApi":true},{"title":"Get Build Alias","description":"Gets a multiplayer server build alias.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetBuildAlias","href":"/api-reference/multiplayerserver/get-build-alias","autogeneratedByOpenApi":true},{"title":"Get Container Registry Credentials","description":"Gets the credentials to the container registry.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetContainerRegistryCredentials","href":"/api-reference/multiplayerserver/get-container-registry-credentials","autogeneratedByOpenApi":true},{"title":"Get Multiplayer Server Details","description":"Gets multiplayer server session details for a build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetMultiplayerServerDetails","href":"/api-reference/multiplayerserver/get-multiplayer-server-details","autogeneratedByOpenApi":true},{"title":"Get Multiplayer Server Logs","description":"Gets multiplayer server logs after a server has terminated.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetMultiplayerServerLogs","href":"/api-reference/multiplayerserver/get-multiplayer-server-logs","autogeneratedByOpenApi":true},{"title":"Get Multiplayer Session Logs By Session Id","description":"Gets multiplayer server logs after a server has terminated.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetMultiplayerSessionLogsBySessionId","href":"/api-reference/multiplayerserver/get-multiplayer-session-logs-by-session-id","autogeneratedByOpenApi":true},{"title":"Get Remote Login Endpoint","description":"Gets a remote login endpoint to a VM that is hosting a multiplayer server build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetRemoteLoginEndpoint","href":"/api-reference/multiplayerserver/get-remote-login-endpoint","autogeneratedByOpenApi":true},{"title":"Get Title Enabled For Multiplayer Servers Status","description":"Gets the status of whether a title is enabled for the multiplayer server feature.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetTitleEnabledForMultiplayerServersStatus","href":"/api-reference/multiplayerserver/get-title-enabled-for-multiplayer-servers-status","autogeneratedByOpenApi":true},{"title":"Get Title Multiplayer Servers Quota Change","description":"Gets a title's server quota change request.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetTitleMultiplayerServersQuotaChange","href":"/api-reference/multiplayerserver/get-title-multiplayer-servers-quota-change","autogeneratedByOpenApi":true},{"title":"Get Title Multiplayer Servers Quotas","description":"Gets the quotas for a title in relation to multiplayer servers.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/GetTitleMultiplayerServersQuotas","href":"/api-reference/multiplayerserver/get-title-multiplayer-servers-quotas","autogeneratedByOpenApi":true},{"title":"List Archived Multiplayer Servers","description":"Lists archived multiplayer server sessions for a build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListArchivedMultiplayerServers","href":"/api-reference/multiplayerserver/list-archived-multiplayer-servers","autogeneratedByOpenApi":true},{"title":"List Asset Summaries","description":"Lists multiplayer server game assets for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListAssetSummaries","href":"/api-reference/multiplayerserver/list-asset-summaries","autogeneratedByOpenApi":true},{"title":"List Build Aliases","description":"Lists details of all build aliases for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.\n\nAllowed entity token types: title, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListBuildAliases","href":"/api-reference/multiplayerserver/list-build-aliases","autogeneratedByOpenApi":true},{"title":"List Build Summaries V2","description":"Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.\n\nAllowed entity token types: title, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListBuildSummariesV2","href":"/api-reference/multiplayerserver/list-build-summaries-v2","autogeneratedByOpenApi":true},{"title":"List Certificate Summaries","description":"Lists multiplayer server game certificates for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListCertificateSummaries","href":"/api-reference/multiplayerserver/list-certificate-summaries","autogeneratedByOpenApi":true},{"title":"List Container Images","description":"Lists custom container images for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListContainerImages","href":"/api-reference/multiplayerserver/list-container-images","autogeneratedByOpenApi":true},{"title":"List Container Image Tags","description":"Lists the tags for a custom container image.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListContainerImageTags","href":"/api-reference/multiplayerserver/list-container-image-tags","autogeneratedByOpenApi":true},{"title":"List Multiplayer Servers","description":"Lists multiplayer server sessions for a build.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListMultiplayerServers","href":"/api-reference/multiplayerserver/list-multiplayer-servers","autogeneratedByOpenApi":true},{"title":"List Party Qos Servers","description":"Lists quality of service servers for party.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListPartyQosServers","href":"/api-reference/multiplayerserver/list-party-qos-servers","autogeneratedByOpenApi":true},{"title":"List Qos Servers For Title","description":"Lists quality of service servers for the title. By default, servers are only returned for regions where a Multiplayer Servers build has been deployed.\n\nAllowed entity token types: title_player_account, title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListQosServersForTitle","href":"/api-reference/multiplayerserver/list-qos-servers-for-title","autogeneratedByOpenApi":true},{"title":"List Secret Summaries","description":"Lists multiplayer server game secrets for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListSecretSummaries","href":"/api-reference/multiplayerserver/list-secret-summaries","autogeneratedByOpenApi":true},{"title":"List Title Multiplayer Servers Quota Changes","description":"List all server quota change requests for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerUnauthorized | 1383 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListTitleMultiplayerServersQuotaChanges","href":"/api-reference/multiplayerserver/list-title-multiplayer-servers-quota-changes","autogeneratedByOpenApi":true},{"title":"List Virtual Machine Summaries","description":"Lists virtual machines for a title.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ListVirtualMachineSummaries","href":"/api-reference/multiplayerserver/list-virtual-machine-summaries","autogeneratedByOpenApi":true},{"title":"Request Multiplayer Server","description":"Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client to request a server with player entity token.\n\nAllowed entity token types: title, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/RequestMultiplayerServer","href":"/api-reference/multiplayerserver/request-multiplayer-server","autogeneratedByOpenApi":true},{"title":"Rollover Container Registry Credentials","description":"Rolls over the credentials to the container registry.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/RolloverContainerRegistryCredentials","href":"/api-reference/multiplayerserver/rollover-container-registry-credentials","autogeneratedByOpenApi":true},{"title":"Shutdown Multiplayer Server","description":"Shuts down a multiplayer server session.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/ShutdownMultiplayerServer","href":"/api-reference/multiplayerserver/shutdown-multiplayer-server","autogeneratedByOpenApi":true},{"title":"Untag Container Image","description":"Untags a container image.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/UntagContainerImage","href":"/api-reference/multiplayerserver/untag-container-image","autogeneratedByOpenApi":true},{"title":"Update Build Alias","description":"Creates a multiplayer server build alias.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/UpdateBuildAlias","href":"/api-reference/multiplayerserver/update-build-alias","autogeneratedByOpenApi":true},{"title":"Update Build Name","description":"Updates a multiplayer server build's name.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/UpdateBuildName","href":"/api-reference/multiplayerserver/update-build-name","autogeneratedByOpenApi":true},{"title":"Update Build Region","description":"Updates a multiplayer server build's region. If the region is not yet created, it will be created\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/UpdateBuildRegion","href":"/api-reference/multiplayerserver/update-build-region","autogeneratedByOpenApi":true},{"title":"Update Build Regions","description":"Updates a multiplayer server build's regions.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTitleQuotaCoresExceeded | 1445 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/UpdateBuildRegions","href":"/api-reference/multiplayerserver/update-build-regions","autogeneratedByOpenApi":true},{"title":"Upload Certificate","description":"Uploads a multiplayer server game certificate.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/UploadCertificate","href":"/api-reference/multiplayerserver/upload-certificate","autogeneratedByOpenApi":true},{"title":"Upload Secret","description":"Uploads a multiplayer server game secret.\n\nAllowed entity token types: title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| MultiplayerServerBadRequest | 1382 |\n| MultiplayerServerConflict | 1386 |\n| MultiplayerServerForbidden | 1384 |\n| MultiplayerServerInternalServerError | 1387 |\n| MultiplayerServerNoContent | 1381 |\n| MultiplayerServerNotFound | 1385 |\n| MultiplayerServerTooManyRequests | 1380 |\n| MultiplayerServerUnauthorized | 1383 |\n| MultiplayerServerUnavailable | 1388 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /MultiplayerServer/UploadSecret","href":"/api-reference/multiplayerserver/upload-secret","autogeneratedByOpenApi":true},{"title":"Request Party Service","description":"Request a party session.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PartyBadRequest | 1434 |\n| PartyInternalServerError | 1439 |\n| PartyNotFound | 1437 |\n| PartyRequestsThrottledFromRateLimiter | 1504 |\n| PartyTooManyRequests | 1441 |\n| PartyUnauthorized | 1435 |\n| PartyUnavailable | 1440 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /Party/RequestPartyService","href":"/api-reference/multiplayerserver/request-party-service","autogeneratedByOpenApi":true}]},{"group":"PubSub","pages":[{"title":"Negotiate","description":"Negotiate a SignalR Connection to the PubSub service, as the first step of establishing the connection. Note: SignalR client implementations expect the Hub URL to omit the `/negotiate` portion of this path (ex: HubConnection should be passed a URL that ends in `...playfabapi.com/pubsub`). When starting the connection, SignalR clients will automatically append `/negotiate` to the end of the URL of the hub. The SignalR client will interpret the response object to establish a persistent connection to PubSub. https://learn.microsoft.com/aspnet/core/signalr/dotnet-client#connect-to-a-hub https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md#post-endpoint-basenegotiate-request\n\nAllowed entity token types: title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InternalServerError | 1110 |\n| InvalidParams | 1000 |\n| PubSubFeatureNotEnabledForTitle | 2500 |\n| PubSubTooManyRequests | 2501 |\n| ServiceUnavailable | 1123 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/multiplayer/multiplayer.openapi.json post /PubSub/Negotiate","href":"/api-reference/pubsub/negotiate","autogeneratedByOpenApi":true}]}]},{"group":"Profiles","pages":[{"title":"PlayFab Profiles API","description":"Overview of the PlayFab Profiles REST API for managing entity profiles, which hold top-level properties about each PlayFab entity, and its operations.","href":"/services/playfab/api-references/rest/profiles/overview"},{"group":"Account Management","pages":[{"title":"Get Global Policy","openapi":"post /Profile/GetGlobalPolicy","description":"Gets the global title access policy \n\nAllowed entity token types: title","href":"/services/playfab/api-references/rest/profiles/account-management/get-global-policy"},{"title":"Get Profile","openapi":"post /Profile/GetProfile","description":"Retrieves the entity's profile.","href":"/services/playfab/api-references/rest/profiles/account-management/get-profile"},{"title":"Get Profiles","openapi":"post /Profile/GetProfiles","description":"Retrieves the entity's profile.","href":"/services/playfab/api-references/rest/profiles/account-management/get-profiles"},{"title":"Get Title Players From Master Player Account Ids","openapi":"post /Profile/GetTitlePlayersFromMasterPlayerAccountIds","description":"Retrieves the title player accounts associated with the given master player account.","href":"/services/playfab/api-references/rest/profiles/account-management/get-title-players-from-master-player-account-ids"},{"title":"Get Title Players From Xbox Live IDs","openapi":"post /Profile/GetTitlePlayersFromXboxLiveIDs","description":"Retrieves the title player accounts associated with the given XUIDs.","href":"/services/playfab/api-references/rest/profiles/account-management/get-title-players-from-xbox-live-ids"},{"title":"Set Display Name","openapi":"post /Profile/SetDisplayName","description":"Update the display name of the entity\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| CharacterNotFound | 1135 |\n| ConcurrentEditError | 1133 |\n| EntityProfileConstraintValidationFailed | 1398 |\n| EntityProfileVersionMismatch | 1352 |\n| InvalidPartnerResponse | 1193 |\n| NameNotAvailable | 1058 |\n| ProfaneDisplayName | 1234 |\n","href":"/services/playfab/api-references/rest/profiles/account-management/set-display-name"},{"title":"Set Global Policy","openapi":"post /Profile/SetGlobalPolicy","description":"Sets the global title access policy ","href":"/services/playfab/api-references/rest/profiles/account-management/set-global-policy"},{"title":"Set Profile Language","openapi":"post /Profile/SetProfileLanguage","description":"Updates the entity's language. The precedence hierarchy for communication to the player is Title Player Account language, Master Player Account language, and then title default language if the first two aren't set or supported.","href":"/services/playfab/api-references/rest/profiles/account-management/set-profile-language"},{"title":"Set Profile Policy","openapi":"post /Profile/SetProfilePolicy","description":"Sets the profiles access policy","href":"/services/playfab/api-references/rest/profiles/account-management/set-profile-policy"}]},{"group":"Account Management","pages":[{"title":"Get Global Policy","description":"Gets the global title access policy \n\nAllowed entity token types: title","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/profiles/profiles.openapi.json post /Profile/GetGlobalPolicy","href":"/api-reference/account-management/get-global-policy","autogeneratedByOpenApi":true},{"title":"Get Profile","description":"Retrieves the entity's profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/profiles/profiles.openapi.json post /Profile/GetProfile","href":"/api-reference/account-management/get-profile","autogeneratedByOpenApi":true},{"title":"Get Profiles","description":"Retrieves the entity's profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/profiles/profiles.openapi.json post /Profile/GetProfiles","href":"/api-reference/account-management/get-profiles","autogeneratedByOpenApi":true},{"title":"Get Title Players From Master Player Account Ids","description":"Retrieves the title player accounts associated with the given master player account.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/profiles/profiles.openapi.json post /Profile/GetTitlePlayersFromMasterPlayerAccountIds","href":"/api-reference/account-management/get-title-players-from-master-player-account-ids","autogeneratedByOpenApi":true},{"title":"Get Title Players From Xbox Live IDs","description":"Retrieves the title player accounts associated with the given XUIDs.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/profiles/profiles.openapi.json post /Profile/GetTitlePlayersFromXboxLiveIDs","href":"/api-reference/account-management/get-title-players-from-xbox-live-ids","autogeneratedByOpenApi":true},{"title":"Set Display Name","description":"Update the display name of the entity\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| CharacterNotFound | 1135 |\n| ConcurrentEditError | 1133 |\n| EntityProfileConstraintValidationFailed | 1398 |\n| EntityProfileVersionMismatch | 1352 |\n| InvalidPartnerResponse | 1193 |\n| NameNotAvailable | 1058 |\n| ProfaneDisplayName | 1234 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/profiles/profiles.openapi.json post /Profile/SetDisplayName","href":"/api-reference/account-management/set-display-name","autogeneratedByOpenApi":true},{"title":"Set Global Policy","description":"Sets the global title access policy ","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/profiles/profiles.openapi.json post /Profile/SetGlobalPolicy","href":"/api-reference/account-management/set-global-policy","autogeneratedByOpenApi":true},{"title":"Set Profile Language","description":"Updates the entity's language. The precedence hierarchy for communication to the player is Title Player Account language, Master Player Account language, and then title default language if the first two aren't set or supported.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/profiles/profiles.openapi.json post /Profile/SetProfileLanguage","href":"/api-reference/account-management/set-profile-language","autogeneratedByOpenApi":true},{"title":"Set Profile Policy","description":"Sets the profiles access policy","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/profiles/profiles.openapi.json post /Profile/SetProfilePolicy","href":"/api-reference/account-management/set-profile-policy","autogeneratedByOpenApi":true}]}]},{"group":"Progression","pages":[{"title":"PlayFab Progression API","description":"Overview of the PlayFab Progression REST API for managing entity statistics and leaderboards, with its API version and Leaderboards and Statistics groups.","href":"/services/playfab/api-references/rest/progression/overview"},{"group":"Leaderboards","pages":[{"title":"Create Leaderboard Definition","openapi":"post /Leaderboard/CreateLeaderboardDefinition","description":"Creates a new leaderboard definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| DuplicateColumnNameFound | 1585 |\n| DuplicateLinkedStatisticColumnNameFound | 1589 |\n| EntityTypeMismatchWithStatDefinition | 1582 |\n| ExternalEntityNotAllowedForTier | 1580 |\n| InvalidBaseTimeForInterval | 1581 |\n| LeaderboardCountLimitExceeded | 1574 |\n| LeaderboardNameConflict | 1569 |\n| LeaderboardSizeLimitExceeded | 1575 |\n| LinkedStatisticColumnMismatch | 1570 |\n| LinkedStatisticColumnNotFound | 1586 |\n| LinkedStatisticColumnRequired | 1587 |\n| LinkingStatsNotAllowedForEntityType | 1573 |\n| MaxQueryableVersionsExceeded | 23015 |\n| MaxQueryableVersionsValueNotAllowedForTier | 1591 |\n| MultipleLinkedStatisticsNotAllowed | 1588 |\n| PlayFabErrorEventNotSupportedForEntityType | 23013 |\n| StatDefinitionAlreadyLinkedToLeaderboard | 1572 |\n| StatisticNotFound | 1195 |\n| VersionConfigurationIsRequired | 23005 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/create-leaderboard-definition"},{"title":"Delete Leaderboard Definition","openapi":"post /Leaderboard/DeleteLeaderboardDefinition","description":"Deletes a leaderboard definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardDefinitionModificationNotAllowedWhileLinked | 1576 |\n| LeaderboardNotFound | 1567 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/delete-leaderboard-definition"},{"title":"Delete Leaderboard Entries","openapi":"post /Leaderboard/DeleteLeaderboardEntries","description":"Deletes the specified entries from the given leaderboard.\n\nAllowed entity token types: title, game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| LeaderboardNotFound | 1567 |\n| LeaderboardUpdateNotAllowedWhileLinked | 1578 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/delete-leaderboard-entries"},{"title":"Get Friend Leaderboard For Entity","openapi":"post /Leaderboard/GetFriendLeaderboardForEntity","description":"Get the friend leaderboard for the specified entity. A maximum of 25 friend entries are listed in the leaderboard.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| ApiNotEnabledForTitle | 1520 |\n| DownstreamServiceUnavailable | 1127 |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidEntityType | 1373 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| InvalidXboxLiveToken | 1188 |\n| LeaderboardNotFound | 1567 |\n| NoLeaderboardForStatistic | 1421 |\n| PlayerSecretNotConfigured | 1323 |\n| SpecifiedVersionLeaderboardNotFound | 1583 |\n| StatisticNotFound | 1195 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/get-friend-leaderboard-for-entity"},{"title":"Get Leaderboard","openapi":"post /Leaderboard/GetLeaderboard","description":"Get the leaderboard for a specific entity type and statistic.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardNotFound | 1567 |\n| NoLeaderboardForStatistic | 1421 |\n| SpecifiedVersionLeaderboardNotFound | 1583 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/get-leaderboard"},{"title":"Get Leaderboard Around Entity","openapi":"post /Leaderboard/GetLeaderboardAroundEntity","description":"Get the leaderboard around a specific entity.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardNotFound | 1567 |\n| NoLeaderboardForStatistic | 1421 |\n| SpecifiedVersionLeaderboardNotFound | 1583 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/get-leaderboard-around-entity"},{"title":"Get Leaderboard Definition","openapi":"post /Leaderboard/GetLeaderboardDefinition","description":"Gets the specified leaderboard definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| LeaderboardColumnLengthMismatchWithStatDefinition | 1584 |\n| LeaderboardNotFound | 1567 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/get-leaderboard-definition"},{"title":"Get Leaderboard For Entities","openapi":"post /Leaderboard/GetLeaderboardForEntities","description":"Get the leaderboard limited to a set of entities.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| LeaderboardNotFound | 1567 |\n| NoLeaderboardForStatistic | 1421 |\n| SpecifiedVersionLeaderboardNotFound | 1583 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/get-leaderboard-for-entities"},{"title":"Increment Leaderboard Version","openapi":"post /Leaderboard/IncrementLeaderboardVersion","description":"Increment a leaderboard version.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ConcurrentEditError | 1133 |\n| ExternalEntityNotAllowedForTier | 1580 |\n| InvalidVersionResetForLinkedLeaderboard | 1601 |\n| LeaderboardDefinitionModificationNotAllowedWhileLinked | 1576 |\n| LeaderboardNotFound | 1567 |\n| VersionIncrementRateExceeded | 1599 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/increment-leaderboard-version"},{"title":"List Leaderboard Definitions","openapi":"post /Leaderboard/ListLeaderboardDefinitions","description":"Lists the leaderboard definitions defined for the Title.\n\nAllowed entity token types: title, game_server","href":"/services/playfab/api-references/rest/progression/leaderboards/list-leaderboard-definitions"},{"title":"Unlink Leaderboard From Statistic","openapi":"post /Leaderboard/UnlinkLeaderboardFromStatistic","description":"Unlinks a leaderboard definition from it's linked statistic definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardNotFound | 1567 |\n| NoLinkedStatisticToLeaderboard | 1571 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/unlink-leaderboard-from-statistic"},{"title":"Update Leaderboard Definition","openapi":"post /Leaderboard/UpdateLeaderboardDefinition","description":"Updates a leaderboard definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardSizeLimitExceeded | 1575 |\n| MaxQueryableVersionsExceeded | 23015 |\n| MaxQueryableVersionsValueNotAllowedForTier | 1591 |\n| PlayFabErrorEventNotSupportedForEntityType | 23013 |\n| ResetIntervalCannotBeModified | 1598 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/update-leaderboard-definition"},{"title":"Update Leaderboard Entries","openapi":"post /Leaderboard/UpdateLeaderboardEntries","description":"Adds or updates entries on the specified leaderboard.\n\nAllowed entity token types: title, game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| LeaderboardColumnLengthMismatch | 1562 |\n| LeaderboardNotFound | 1567 |\n| LeaderboardUpdateNotAllowedWhileLinked | 1578 |\n| MetadataLengthExceeded | 23014 |\n","href":"/services/playfab/api-references/rest/progression/leaderboards/update-leaderboard-entries"}]},{"group":"Statistics","pages":[{"title":"Create Statistic Definition","openapi":"post /Statistic/CreateStatisticDefinition","description":"Create a new entity statistic definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AggregationTypeNotAllowedForLinkedStat | 23008 |\n| AggregationTypeNotAllowedForMultiColumnStatistic | 1590 |\n| ApiNotEnabledForTitle | 1520 |\n| DuplicateColumnNameFound | 1585 |\n| DuplicateStatisticName | 1253 |\n| EntityTypeSpecifiedRequiresAggregationSource | 23012 |\n| ExternalEntityNotAllowedForTier | 1580 |\n| InvalidBaseTimeForInterval | 1581 |\n| InvalidEntityTypeForAggregation | 23006 |\n| MaxQueryableVersionsExceeded | 23015 |\n| MaxQueryableVersionsValueNotAllowedForTier | 1591 |\n| MultiLevelAggregationNotAllowed | 23007 |\n| PlayFabErrorEventNotSupportedForEntityType | 23013 |\n| StatisticColumnAggregationMismatch | 23002 |\n| StatisticColumnLengthMismatch | 1593 |\n| StatisticCountLimitExceeded | 1203 |\n| StatisticDefinitionHasNullOrEmptyVersionConfiguration | 1592 |\n| StatisticNameConflict | 1196 |\n| StatisticNotFound | 1195 |\n| VersionConfigurationCannotBeSpecifiedForLinkedStat | 23004 |\n| VersionConfigurationIsRequired | 23005 |\n","href":"/services/playfab/api-references/rest/progression/statistics/create-statistic-definition"},{"title":"Delete Statistic Definition","openapi":"post /Statistic/DeleteStatisticDefinition","description":"Delete an entity statistic definition. Will delete all statistics on entity profiles and leaderboards.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| StatisticDefinitionModificationNotAllowedWhileLinked | 1577 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateInProgress | 1276 |\n","href":"/services/playfab/api-references/rest/progression/statistics/delete-statistic-definition"},{"title":"Delete Statistics","openapi":"post /Statistic/DeleteStatistics","description":"Delete statistics on an entity profile. This will remove all rankings from associated leaderboards.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n","href":"/services/playfab/api-references/rest/progression/statistics/delete-statistics"},{"title":"Get Statistic Definition","openapi":"post /Statistic/GetStatisticDefinition","description":"Get current statistic definition information\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/progression/statistics/get-statistic-definition"},{"title":"Get Statistics","openapi":"post /Statistic/GetStatistics","description":"Gets statistics for the specified entity.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| InvalidEntityType | 1373 |\n| NotAuthorized | 1089 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/progression/statistics/get-statistics"},{"title":"Get Statistics For Entities","openapi":"post /Statistic/GetStatisticsForEntities","description":"Gets statistics for the specified collection of entities.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| NotAuthorized | 1089 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/progression/statistics/get-statistics-for-entities"},{"title":"Increment Statistic Version","openapi":"post /Statistic/IncrementStatisticVersion","description":"Increment an entity statistic definition version.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExternalEntityNotAllowedForTier | 1580 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateInProgress | 1276 |\n| StatisticVersionIncrementRateExceeded | 1204 |\n| VersionIncrementRateExceeded | 1599 |\n","href":"/services/playfab/api-references/rest/progression/statistics/increment-statistic-version"},{"title":"List Statistic Definitions","openapi":"post /Statistic/ListStatisticDefinitions","description":"Get all current statistic definitions information\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| StatisticCountLimitExceeded | 1203 |\n","href":"/services/playfab/api-references/rest/progression/statistics/list-statistic-definitions"},{"title":"Unlink Aggregation Source From Statistic","openapi":"post /Statistic/UnlinkAggregationSourceFromStatistic","description":"Unlinks an aggregation source from a statistic definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/progression/statistics/unlink-aggregation-source-from-statistic"},{"title":"Update Statistic Definition","openapi":"post /Statistic/UpdateStatisticDefinition","description":"Update an existing entity statistic definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| InvalidBaseTimeForInterval | 1581 |\n| MaxQueryableVersionsExceeded | 23015 |\n| MaxQueryableVersionsValueNotAllowedForTier | 1591 |\n| ResetIntervalCannotBeModified | 1598 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/progression/statistics/update-statistic-definition"},{"title":"Update Statistics","openapi":"post /Statistic/UpdateStatistics","description":"Update statistics on an entity profile. Depending on the statistic definition, this may result in entity being ranked on various leaderboards.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| EntityIsNotAMember | 1615 |\n| EntityTypeMismatchWithStatDefinition | 1582 |\n| InvalidEntityType | 1373 |\n| InvalidEntityTypeForAggregation | 23006 |\n| InvalidExternalEntityId | 1594 |\n| InvalidStatisticScore | 1563 |\n| MetadataLengthExceeded | 23014 |\n| NotAuthorized | 1089 |\n| StatisticColumnLengthMismatch | 1593 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateNotAllowedWhileLinked | 23010 |\n| TransactionAlreadyApplied | 1596 |\n| UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier | 1595 |\n","href":"/services/playfab/api-references/rest/progression/statistics/update-statistics"}]},{"group":"Leaderboards","pages":[{"title":"Create Leaderboard Definition","description":"Creates a new leaderboard definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| DuplicateColumnNameFound | 1585 |\n| DuplicateLinkedStatisticColumnNameFound | 1589 |\n| EntityTypeMismatchWithStatDefinition | 1582 |\n| ExternalEntityNotAllowedForTier | 1580 |\n| InvalidBaseTimeForInterval | 1581 |\n| LeaderboardCountLimitExceeded | 1574 |\n| LeaderboardNameConflict | 1569 |\n| LeaderboardSizeLimitExceeded | 1575 |\n| LinkedStatisticColumnMismatch | 1570 |\n| LinkedStatisticColumnNotFound | 1586 |\n| LinkedStatisticColumnRequired | 1587 |\n| LinkingStatsNotAllowedForEntityType | 1573 |\n| MaxQueryableVersionsExceeded | 23015 |\n| MaxQueryableVersionsValueNotAllowedForTier | 1591 |\n| MultipleLinkedStatisticsNotAllowed | 1588 |\n| PlayFabErrorEventNotSupportedForEntityType | 23013 |\n| StatDefinitionAlreadyLinkedToLeaderboard | 1572 |\n| StatisticNotFound | 1195 |\n| VersionConfigurationIsRequired | 23005 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/CreateLeaderboardDefinition","href":"/api-reference/leaderboards/create-leaderboard-definition","autogeneratedByOpenApi":true},{"title":"Delete Leaderboard Definition","description":"Deletes a leaderboard definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardDefinitionModificationNotAllowedWhileLinked | 1576 |\n| LeaderboardNotFound | 1567 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/DeleteLeaderboardDefinition","href":"/api-reference/leaderboards/delete-leaderboard-definition","autogeneratedByOpenApi":true},{"title":"Delete Leaderboard Entries","description":"Deletes the specified entries from the given leaderboard.\n\nAllowed entity token types: title, game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| LeaderboardNotFound | 1567 |\n| LeaderboardUpdateNotAllowedWhileLinked | 1578 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/DeleteLeaderboardEntries","href":"/api-reference/leaderboards/delete-leaderboard-entries","autogeneratedByOpenApi":true},{"title":"Get Friend Leaderboard For Entity","description":"Get the friend leaderboard for the specified entity. A maximum of 25 friend entries are listed in the leaderboard.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| ApiNotEnabledForTitle | 1520 |\n| DownstreamServiceUnavailable | 1127 |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidEntityType | 1373 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| InvalidXboxLiveToken | 1188 |\n| LeaderboardNotFound | 1567 |\n| NoLeaderboardForStatistic | 1421 |\n| PlayerSecretNotConfigured | 1323 |\n| SpecifiedVersionLeaderboardNotFound | 1583 |\n| StatisticNotFound | 1195 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/GetFriendLeaderboardForEntity","href":"/api-reference/leaderboards/get-friend-leaderboard-for-entity","autogeneratedByOpenApi":true},{"title":"Get Leaderboard","description":"Get the leaderboard for a specific entity type and statistic.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardNotFound | 1567 |\n| NoLeaderboardForStatistic | 1421 |\n| SpecifiedVersionLeaderboardNotFound | 1583 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/GetLeaderboard","href":"/api-reference/leaderboards/get-leaderboard","autogeneratedByOpenApi":true},{"title":"Get Leaderboard Around Entity","description":"Get the leaderboard around a specific entity.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardNotFound | 1567 |\n| NoLeaderboardForStatistic | 1421 |\n| SpecifiedVersionLeaderboardNotFound | 1583 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/GetLeaderboardAroundEntity","href":"/api-reference/leaderboards/get-leaderboard-around-entity","autogeneratedByOpenApi":true},{"title":"Get Leaderboard Definition","description":"Gets the specified leaderboard definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| LeaderboardColumnLengthMismatchWithStatDefinition | 1584 |\n| LeaderboardNotFound | 1567 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/GetLeaderboardDefinition","href":"/api-reference/leaderboards/get-leaderboard-definition","autogeneratedByOpenApi":true},{"title":"Get Leaderboard For Entities","description":"Get the leaderboard limited to a set of entities.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| LeaderboardNotFound | 1567 |\n| NoLeaderboardForStatistic | 1421 |\n| SpecifiedVersionLeaderboardNotFound | 1583 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/GetLeaderboardForEntities","href":"/api-reference/leaderboards/get-leaderboard-for-entities","autogeneratedByOpenApi":true},{"title":"Increment Leaderboard Version","description":"Increment a leaderboard version.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ConcurrentEditError | 1133 |\n| ExternalEntityNotAllowedForTier | 1580 |\n| InvalidVersionResetForLinkedLeaderboard | 1601 |\n| LeaderboardDefinitionModificationNotAllowedWhileLinked | 1576 |\n| LeaderboardNotFound | 1567 |\n| VersionIncrementRateExceeded | 1599 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/IncrementLeaderboardVersion","href":"/api-reference/leaderboards/increment-leaderboard-version","autogeneratedByOpenApi":true},{"title":"List Leaderboard Definitions","description":"Lists the leaderboard definitions defined for the Title.\n\nAllowed entity token types: title, game_server","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/ListLeaderboardDefinitions","href":"/api-reference/leaderboards/list-leaderboard-definitions","autogeneratedByOpenApi":true},{"title":"Unlink Leaderboard From Statistic","description":"Unlinks a leaderboard definition from it's linked statistic definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardNotFound | 1567 |\n| NoLinkedStatisticToLeaderboard | 1571 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/UnlinkLeaderboardFromStatistic","href":"/api-reference/leaderboards/unlink-leaderboard-from-statistic","autogeneratedByOpenApi":true},{"title":"Update Leaderboard Definition","description":"Updates a leaderboard definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardSizeLimitExceeded | 1575 |\n| MaxQueryableVersionsExceeded | 23015 |\n| MaxQueryableVersionsValueNotAllowedForTier | 1591 |\n| PlayFabErrorEventNotSupportedForEntityType | 23013 |\n| ResetIntervalCannotBeModified | 1598 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/UpdateLeaderboardDefinition","href":"/api-reference/leaderboards/update-leaderboard-definition","autogeneratedByOpenApi":true},{"title":"Update Leaderboard Entries","description":"Adds or updates entries on the specified leaderboard.\n\nAllowed entity token types: title, game_server, title_player_account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| LeaderboardColumnLengthMismatch | 1562 |\n| LeaderboardNotFound | 1567 |\n| LeaderboardUpdateNotAllowedWhileLinked | 1578 |\n| MetadataLengthExceeded | 23014 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Leaderboard/UpdateLeaderboardEntries","href":"/api-reference/leaderboards/update-leaderboard-entries","autogeneratedByOpenApi":true}]},{"group":"Statistics","pages":[{"title":"Create Statistic Definition","description":"Create a new entity statistic definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AggregationTypeNotAllowedForLinkedStat | 23008 |\n| AggregationTypeNotAllowedForMultiColumnStatistic | 1590 |\n| ApiNotEnabledForTitle | 1520 |\n| DuplicateColumnNameFound | 1585 |\n| DuplicateStatisticName | 1253 |\n| EntityTypeSpecifiedRequiresAggregationSource | 23012 |\n| ExternalEntityNotAllowedForTier | 1580 |\n| InvalidBaseTimeForInterval | 1581 |\n| InvalidEntityTypeForAggregation | 23006 |\n| MaxQueryableVersionsExceeded | 23015 |\n| MaxQueryableVersionsValueNotAllowedForTier | 1591 |\n| MultiLevelAggregationNotAllowed | 23007 |\n| PlayFabErrorEventNotSupportedForEntityType | 23013 |\n| StatisticColumnAggregationMismatch | 23002 |\n| StatisticColumnLengthMismatch | 1593 |\n| StatisticCountLimitExceeded | 1203 |\n| StatisticDefinitionHasNullOrEmptyVersionConfiguration | 1592 |\n| StatisticNameConflict | 1196 |\n| StatisticNotFound | 1195 |\n| VersionConfigurationCannotBeSpecifiedForLinkedStat | 23004 |\n| VersionConfigurationIsRequired | 23005 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/CreateStatisticDefinition","href":"/api-reference/statistics/create-statistic-definition","autogeneratedByOpenApi":true},{"title":"Delete Statistic Definition","description":"Delete an entity statistic definition. Will delete all statistics on entity profiles and leaderboards.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| StatisticDefinitionModificationNotAllowedWhileLinked | 1577 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateInProgress | 1276 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/DeleteStatisticDefinition","href":"/api-reference/statistics/delete-statistic-definition","autogeneratedByOpenApi":true},{"title":"Delete Statistics","description":"Delete statistics on an entity profile. This will remove all rankings from associated leaderboards.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/DeleteStatistics","href":"/api-reference/statistics/delete-statistics","autogeneratedByOpenApi":true},{"title":"Get Statistic Definition","description":"Get current statistic definition information\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/GetStatisticDefinition","href":"/api-reference/statistics/get-statistic-definition","autogeneratedByOpenApi":true},{"title":"Get Statistics","description":"Gets statistics for the specified entity.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| InvalidEntityType | 1373 |\n| NotAuthorized | 1089 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/GetStatistics","href":"/api-reference/statistics/get-statistics","autogeneratedByOpenApi":true},{"title":"Get Statistics For Entities","description":"Gets statistics for the specified collection of entities.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEntityType | 1373 |\n| NotAuthorized | 1089 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/GetStatisticsForEntities","href":"/api-reference/statistics/get-statistics-for-entities","autogeneratedByOpenApi":true},{"title":"Increment Statistic Version","description":"Increment an entity statistic definition version.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExternalEntityNotAllowedForTier | 1580 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateInProgress | 1276 |\n| StatisticVersionIncrementRateExceeded | 1204 |\n| VersionIncrementRateExceeded | 1599 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/IncrementStatisticVersion","href":"/api-reference/statistics/increment-statistic-version","autogeneratedByOpenApi":true},{"title":"List Statistic Definitions","description":"Get all current statistic definitions information\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| StatisticCountLimitExceeded | 1203 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/ListStatisticDefinitions","href":"/api-reference/statistics/list-statistic-definitions","autogeneratedByOpenApi":true},{"title":"Unlink Aggregation Source From Statistic","description":"Unlinks an aggregation source from a statistic definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/UnlinkAggregationSourceFromStatistic","href":"/api-reference/statistics/unlink-aggregation-source-from-statistic","autogeneratedByOpenApi":true},{"title":"Update Statistic Definition","description":"Update an existing entity statistic definition.\n\nAllowed entity token types: title, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ApiNotEnabledForTitle | 1520 |\n| InvalidBaseTimeForInterval | 1581 |\n| MaxQueryableVersionsExceeded | 23015 |\n| MaxQueryableVersionsValueNotAllowedForTier | 1591 |\n| ResetIntervalCannotBeModified | 1598 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/UpdateStatisticDefinition","href":"/api-reference/statistics/update-statistic-definition","autogeneratedByOpenApi":true},{"title":"Update Statistics","description":"Update statistics on an entity profile. Depending on the statistic definition, this may result in entity being ranked on various leaderboards.\n\nAllowed entity token types: title, title_player_account, game_server\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameClientAccess | 1082 |\n| EntityIsNotAMember | 1615 |\n| EntityTypeMismatchWithStatDefinition | 1582 |\n| InvalidEntityType | 1373 |\n| InvalidEntityTypeForAggregation | 23006 |\n| InvalidExternalEntityId | 1594 |\n| InvalidStatisticScore | 1563 |\n| MetadataLengthExceeded | 23014 |\n| NotAuthorized | 1089 |\n| StatisticColumnLengthMismatch | 1593 |\n| StatisticNotFound | 1195 |\n| StatisticUpdateNotAllowedWhileLinked | 23010 |\n| TransactionAlreadyApplied | 1596 |\n| UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier | 1595 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/progression/progression.openapi.json post /Statistic/UpdateStatistics","href":"/api-reference/statistics/update-statistics","autogeneratedByOpenApi":true}]}]},{"group":"Server","pages":[{"title":"PlayFab Server API","description":"Overview of the PlayFab Server REST API, which lets developer-controlled servers manage user inventories, data, and matchmaking in a trusted manner.","href":"/services/playfab/api-references/rest/server/overview"},{"group":"Account Management","pages":[{"title":"Add Generic ID","openapi":"post /Server/AddGenericID","description":"Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| IdentifierAlreadyClaimed | 1238 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/account-management/add-generic-id"},{"title":"Add Or Update Contact Email","openapi":"post /Server/AddOrUpdateContactEmail","description":"Adds or updates a contact email to the specified player's profile.","href":"/services/playfab/api-references/rest/server/account-management/add-or-update-contact-email"},{"title":"Ban Users","openapi":"post /Server/BanUsers","description":"Bans users by PlayFab ID with optional IP address for the provided game.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/account-management/ban-users"},{"title":"Delete Player","openapi":"post /Server/DeletePlayer","description":"Removes a user's player account from a title and deletes all associated data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameServerAccess | 1194 |\n","href":"/services/playfab/api-references/rest/server/account-management/delete-player"},{"title":"Delete Push Notification Template","openapi":"post /Server/DeletePushNotificationTemplate","description":"Deletes push notification template for title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PushNotificationTemplateNotFound | 1417 |\n","href":"/services/playfab/api-references/rest/server/account-management/delete-push-notification-template"},{"title":"Get Player Profile","openapi":"post /Server/GetPlayerProfile","description":"Retrieves the player's profile\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerNotInGame | 1033 |\n","href":"/services/playfab/api-references/rest/server/account-management/get-player-profile"},{"title":"Get PlayFab IDs From Battle Net Account Ids","openapi":"post /Server/GetPlayFabIDsFromBattleNetAccountIds","description":"Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-battle-net-account-ids"},{"title":"Get PlayFab IDs From Facebook IDs","openapi":"post /Server/GetPlayFabIDsFromFacebookIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-facebook-ids"},{"title":"Get PlayFab IDs From Facebook Instant Games Ids","openapi":"post /Server/GetPlayFabIDsFromFacebookInstantGamesIds","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-facebook-instant-games-ids"},{"title":"Get PlayFab IDs From Generic IDs","openapi":"post /Server/GetPlayFabIDsFromGenericIDs","description":"Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-generic-ids"},{"title":"Get PlayFab IDs From Nintendo Service Account Ids","openapi":"post /Server/GetPlayFabIDsFromNintendoServiceAccountIds","description":"Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-nintendo-service-account-ids"},{"title":"Get PlayFab IDs From Nintendo Switch Device Ids","openapi":"post /Server/GetPlayFabIDsFromNintendoSwitchDeviceIds","description":"Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-nintendo-switch-device-ids"},{"title":"Get PlayFab IDs From OpenId Subject Identifiers","openapi":"post /Server/GetPlayFabIDsFromOpenIdSubjectIdentifiers","description":"Retrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId subject identifier is the OpenId issuer plus the OpenId subject for the player, as specified by the title when the OpenId identifier was added to the player account.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-openid-subject-identifiers"},{"title":"Get PlayFab IDs From PSN Account IDs","openapi":"post /Server/GetPlayFabIDsFromPSNAccountIDs","description":"Retrieves the unique PlayFab identifiers for the given set of PlayStation™ Network identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-psn-account-ids"},{"title":"Get PlayFab IDs From PSN Online IDs","openapi":"post /Server/GetPlayFabIDsFromPSNOnlineIDs","description":"Retrieves the unique PlayFab identifiers for the given set of PlayStation™ Network identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-psn-online-ids"},{"title":"Get PlayFab IDs From Server Custom IDs","openapi":"post /Server/GetPlayFabIDsFromServerCustomIDs","description":"Retrieves the associated PlayFab account identifiers for the given set of server custom player identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-server-custom-ids"},{"title":"Get PlayFab IDs From Steam IDs","openapi":"post /Server/GetPlayFabIDsFromSteamIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-steam-ids"},{"title":"Get PlayFab IDs From Steam Names","openapi":"post /Server/GetPlayFabIDsFromSteamNames","description":"Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-steam-names"},{"title":"Get PlayFab IDs From Twitch IDs","openapi":"post /Server/GetPlayFabIDsFromTwitchIDs","description":"Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as \"_id\" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-twitch-ids"},{"title":"Get PlayFab IDs From Xbox Live IDs","openapi":"post /Server/GetPlayFabIDsFromXboxLiveIDs","description":"Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-playfab-ids-from-xbox-live-ids"},{"title":"Get Server Custom IDs From PlayFab IDs","openapi":"post /Server/GetServerCustomIDsFromPlayFabIDs","description":"Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.","href":"/services/playfab/api-references/rest/server/account-management/get-server-custom-ids-from-playfab-ids"},{"title":"Get User Account Info","openapi":"post /Server/GetUserAccountInfo","description":"Retrieves the relevant details for a specified user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleNotActivated | 1042 |\n","href":"/services/playfab/api-references/rest/server/account-management/get-user-account-info"},{"title":"Get User Bans","openapi":"post /Server/GetUserBans","description":"Gets all bans for a user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/account-management/get-user-bans"},{"title":"Link Battle Net Account","openapi":"post /Server/LinkBattleNetAccount","description":"Links the Battle.net account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| BattleNetNotEnabledForTitle | 1602 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-battle-net-account"},{"title":"Link Nintendo Service Account","openapi":"post /Server/LinkNintendoServiceAccount","description":"Links the Nintendo account associated with the token to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidIdentityProviderId | 1263 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-nintendo-service-account"},{"title":"Link Nintendo Service Account Subject","openapi":"post /Server/LinkNintendoServiceAccountSubject","description":"Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidIdentityProviderId | 1263 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-nintendo-service-account-subject"},{"title":"Link Nintendo Switch Device Id","openapi":"post /Server/LinkNintendoSwitchDeviceId","description":"Links the NintendoSwitchDeviceId to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-nintendo-switch-device-id"},{"title":"Link PSN Account","openapi":"post /Server/LinkPSNAccount","description":"Links the PlayStation™ Network account associated with the provided access code to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| DownstreamServiceUnavailable | 1127 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidParams | 1000 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| PSNInaccessible | 1152 |\n| PSNNextGenNotConfiguredForTitle | 1617 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-psn-account"},{"title":"Link PSN Id","openapi":"post /Server/LinkPSNId","description":"Links the PlayStation™ Network account associated with the provided user id to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| PSNInaccessible | 1152 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-psn-id"},{"title":"Link Server Custom Id","openapi":"post /Server/LinkServerCustomId","description":"Links the custom server identifier, generated by the title, to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-server-custom-id"},{"title":"Link Steam Id","openapi":"post /Server/LinkSteamId","description":"Links the Steam account associated with the provided Steam ID to the user's PlayFab account \n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidSteamTicket | 1010 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| SteamNotEnabledForTitle | 1258 |\n| SteamUserNotFound | 1513 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-steam-id"},{"title":"Link Twitch Account","openapi":"post /Server/LinkTwitchAccount","description":"Links the Twitch account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidTwitchToken | 1232 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| TwitchResponseError | 1233 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-twitch-account"},{"title":"Link Xbox Account","openapi":"post /Server/LinkXboxAccount","description":"Links the Xbox Live account associated with the provided access code to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidXboxLiveToken | 1188 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-xbox-account"},{"title":"Link Xbox Id","openapi":"post /Server/LinkXboxId","description":"Links the Xbox Live account associated with the provided Xbox ID and Sandbox to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","href":"/services/playfab/api-references/rest/server/account-management/link-xbox-id"},{"title":"Remove Generic ID","openapi":"post /Server/RemoveGenericID","description":"Removes the specified generic service identifier from the player's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| IdentifierNotLinked | 1239 |\n","href":"/services/playfab/api-references/rest/server/account-management/remove-generic-id"},{"title":"Revoke All Bans For User","openapi":"post /Server/RevokeAllBansForUser","description":"Revoke all active bans for a user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/account-management/revoke-all-bans-for-user"},{"title":"Revoke Bans","openapi":"post /Server/RevokeBans","description":"Revoke all active bans specified with BanId.","href":"/services/playfab/api-references/rest/server/account-management/revoke-bans"},{"title":"Save Push Notification Template","openapi":"post /Server/SavePushNotificationTemplate","description":"Saves push notification template for title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidLocalizedPushNotificationLanguage | 1409 |\n| MissingLocalizedPushNotificationMessage | 1410 |\n| PushNotificationTemplateAndroidPayloadMissingNotificationBody | 1416 |\n| PushNotificationTemplateContainsInvalidAndroidPayload | 1414 |\n| PushNotificationTemplateContainsInvalidIosPayload | 1413 |\n| PushNotificationTemplateInvalidPayload | 1408 |\n| PushNotificationTemplateInvalidSyntax | 1419 |\n| PushNotificationTemplateIosPayloadMissingNotificationBody | 1415 |\n| PushNotificationTemplateMissingDefaultVersion | 1418 |\n| PushNotificationTemplateMissingName | 1442 |\n| PushNotificationTemplateMissingPlatformPayload | 1411 |\n| PushNotificationTemplateNoCustomPayloadForV1 | 1420 |\n| PushNotificationTemplatePayloadContainsInvalidJson | 1412 |\n| TitleDefaultLanguageNotSet | 1393 |\n","href":"/services/playfab/api-references/rest/server/account-management/save-push-notification-template"},{"title":"Send Custom Account Recovery Email","openapi":"post /Server/SendCustomAccountRecoveryEmail","description":"Forces an email to be sent to the registered contact email address for the user's account based on an account recovery email template\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailClientCanceledTask | 1317 |\n| EmailClientTimeout | 1316 |\n| EmailMessageToAddressIsMissing | 1310 |\n| EmailTemplateMissing | 1318 |\n| NoContactEmailAddressFound | 1325 |\n| SmtpAddonNotEnabled | 1341 |\n","href":"/services/playfab/api-references/rest/server/account-management/send-custom-account-recovery-email"},{"title":"Send Email From Template","openapi":"post /Server/SendEmailFromTemplate","description":"Sends an email based on an email template to a player's contact email \n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailClientCanceledTask | 1317 |\n| EmailClientTimeout | 1316 |\n| EmailTemplateMissing | 1318 |\n| NoContactEmailAddressFound | 1325 |\n| SmtpAddonNotEnabled | 1341 |\n","href":"/services/playfab/api-references/rest/server/account-management/send-email-from-template"},{"title":"Send Push Notification","openapi":"post /Server/SendPushNotification","description":"Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PushNotEnabledForAccount | 1094 |\n| PushServiceError | 1095 |\n","href":"/services/playfab/api-references/rest/server/account-management/send-push-notification"},{"title":"Send Push Notification From Template","openapi":"post /Server/SendPushNotificationFromTemplate","description":"Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PushNotEnabledForAccount | 1094 |\n| PushNotificationTemplateNotFound | 1417 |\n| PushServiceError | 1095 |\n","href":"/services/playfab/api-references/rest/server/account-management/send-push-notification-from-template"},{"title":"Unlink Apple","openapi":"post /Server/UnlinkApple","description":"Unlinks the related Apple account from the specified user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| AppleNotEnabledForTitle | 1501 |\n| InvalidNamespaceMismatch | 1561 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-apple"},{"title":"Unlink Battle Net Account","openapi":"post /Server/UnlinkBattleNetAccount","description":"Unlinks the related Battle.net account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| BattleNetNotEnabledForTitle | 1602 |\n| InvalidNamespaceMismatch | 1561 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-battle-net-account"},{"title":"Unlink Facebook Account","openapi":"post /Server/UnlinkFacebookAccount","description":"Unlinks the related Facebook account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-facebook-account"},{"title":"Unlink Facebook Instant Games Id","openapi":"post /Server/UnlinkFacebookInstantGamesId","description":"Unlinks the related Facebook Instant Games identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| FacebookInstantGamesIdNotLinked | 1395 |\n| InvalidNamespaceMismatch | 1561 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-facebook-instant-games-id"},{"title":"Unlink Game Center Account","openapi":"post /Server/UnlinkGameCenterAccount","description":"Unlinks the related Game Center account from the specified user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-game-center-account"},{"title":"Unlink Nintendo Service Account","openapi":"post /Server/UnlinkNintendoServiceAccount","description":"Unlinks the related Nintendo account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-nintendo-service-account"},{"title":"Unlink Nintendo Switch Device Id","openapi":"post /Server/UnlinkNintendoSwitchDeviceId","description":"Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n| NintendoSwitchDeviceIdNotLinked | 2034 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-nintendo-switch-device-id"},{"title":"Unlink PSN Account","openapi":"post /Server/UnlinkPSNAccount","description":"Unlinks the related PlayStation™ Network account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-psn-account"},{"title":"Unlink Server Custom Id","openapi":"post /Server/UnlinkServerCustomId","description":"Unlinks the custom server identifier from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| IdentifierNotLinked | 1239 |\n| InvalidNamespaceMismatch | 1561 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-server-custom-id"},{"title":"Unlink Steam Id","openapi":"post /Server/UnlinkSteamId","description":"Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account \n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-steam-id"},{"title":"Unlink Twitch Account","openapi":"post /Server/UnlinkTwitchAccount","description":"Unlinks the related Twitch account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidTwitchToken | 1232 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-twitch-account"},{"title":"Unlink Xbox Account","openapi":"post /Server/UnlinkXboxAccount","description":"Unlinks the related Xbox Live account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidXboxLiveToken | 1188 |\n","href":"/services/playfab/api-references/rest/server/account-management/unlink-xbox-account"},{"title":"Update Avatar Url","openapi":"post /Server/UpdateAvatarUrl","description":"Update the avatar URL of the specified player","href":"/services/playfab/api-references/rest/server/account-management/update-avatar-url"},{"title":"Update Bans","openapi":"post /Server/UpdateBans","description":"Updates information of a list of existing bans specified with Ban Ids.","href":"/services/playfab/api-references/rest/server/account-management/update-bans"}]},{"group":"Analytics","pages":[{"title":"Write Character Event","openapi":"post /Server/WriteCharacterEvent","description":"Writes a character-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/analytics/write-character-event"},{"title":"Write Player Event","openapi":"post /Server/WritePlayerEvent","description":"Writes a player-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEventField | 1216 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/analytics/write-player-event"},{"title":"Write Title Event","openapi":"post /Server/WriteTitleEvent","description":"Writes a title-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEventField | 1216 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/analytics/write-title-event"}]},{"group":"Authentication","pages":[{"title":"Authenticate Session Ticket","openapi":"post /Server/AuthenticateSessionTicket","description":"Validated a client's session ticket, and if successful, returns details for that user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSessionTicket | 1100 |\n","href":"/services/playfab/api-references/rest/server/authentication/authenticate-session-ticket"},{"title":"Login With Android Device ID","openapi":"post /Server/LoginWithAndroidDeviceID","description":"Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-android-device-id"},{"title":"Login With Battle Net","openapi":"post /Server/LoginWithBattleNet","description":"Sign in the user with a Battle.net identity token\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| BattleNetNotEnabledForTitle | 1602 |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidAuthToken | 1326 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| InvalidTitleId | 1004 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-battle-net"},{"title":"Login With Custom ID","openapi":"post /Server/LoginWithCustomID","description":"Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-custom-id"},{"title":"Login With IOS Device ID","openapi":"post /Server/LoginWithIOSDeviceID","description":"Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-ios-device-id"},{"title":"Login With PSN","openapi":"post /Server/LoginWithPSN","description":"Signs the user in using a PlayStation™ Network authentication code, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidParams | 1000 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| PSNInaccessible | 1152 |\n| PSNNextGenNotConfiguredForTitle | 1617 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-psn"},{"title":"Login With Server Custom Id","openapi":"post /Server/LoginWithServerCustomId","description":"Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-server-custom-id"},{"title":"Login With Steam Id","openapi":"post /Server/LoginWithSteamId","description":"Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| SteamNotEnabledForTitle | 1258 |\n| SteamUserNotFound | 1513 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-steam-id"},{"title":"Login With Twitch","openapi":"post /Server/LoginWithTwitch","description":"Sign in the user with a Twitch access token\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidTwitchToken | 1232 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| TwitchResponseError | 1233 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-twitch"},{"title":"Login With Xbox","openapi":"post /Server/LoginWithXbox","description":"Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| ExpiredXboxLiveToken | 1189 |\n| InvalidXboxLiveToken | 1188 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| XboxInaccessible | 1339 |\n| XboxRejectedXSTSExchangeRequest | 1343 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-xbox"},{"title":"Login With Xbox Id","openapi":"post /Server/LoginWithXboxId","description":"Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| XboxInaccessible | 1339 |\n| XboxRejectedXSTSExchangeRequest | 1343 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/server/authentication/login-with-xbox-id"},{"title":"Set Player Secret","openapi":"post /Server/SetPlayerSecret","description":"Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's secret use the Admin or Server API method SetPlayerSecret.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerSecretAlreadyConfigured | 1294 |\n","href":"/services/playfab/api-references/rest/server/authentication/set-player-secret"}]},{"group":"Character Data","pages":[{"title":"Get Character Data","openapi":"post /Server/GetCharacterData","description":"Retrieves the title-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/character-data/get-character-data"},{"title":"Get Character Internal Data","openapi":"post /Server/GetCharacterInternalData","description":"Retrieves the title-specific custom data for the user's character which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/character-data/get-character-internal-data"},{"title":"Get Character Read Only Data","openapi":"post /Server/GetCharacterReadOnlyData","description":"Retrieves the title-specific custom data for the user's character which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/character-data/get-character-read-only-data"},{"title":"Update Character Data","openapi":"post /Server/UpdateCharacterData","description":"Updates the title-specific custom data for the user's character which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/character-data/update-character-data"},{"title":"Update Character Internal Data","openapi":"post /Server/UpdateCharacterInternalData","description":"Updates the title-specific custom data for the user's character which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/character-data/update-character-internal-data"},{"title":"Update Character Read Only Data","openapi":"post /Server/UpdateCharacterReadOnlyData","description":"Updates the title-specific custom data for the user's character which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/character-data/update-character-read-only-data"}]},{"group":"Characters","pages":[{"title":"Delete Character From User","openapi":"post /Server/DeleteCharacterFromUser","description":"Deletes the specific character ID from the specified user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n","href":"/services/playfab/api-references/rest/server/characters/delete-character-from-user"},{"title":"Get All Users Characters","openapi":"post /Server/GetAllUsersCharacters","description":"Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.","href":"/services/playfab/api-references/rest/server/characters/get-all-users-characters"},{"title":"Get Character Leaderboard","openapi":"post /Server/GetCharacterLeaderboard","description":"Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/characters/get-character-leaderboard"},{"title":"Get Character Statistics","openapi":"post /Server/GetCharacterStatistics","description":"Retrieves the details of all title-specific statistics for the specific character\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/characters/get-character-statistics"},{"title":"Get Leaderboard Around Character","openapi":"post /Server/GetLeaderboardAroundCharacter","description":"Retrieves a list of ranked characters for the given statistic, centered on the requested user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/characters/get-leaderboard-around-character"},{"title":"Get Leaderboard For User Characters","openapi":"post /Server/GetLeaderboardForUserCharacters","description":"Retrieves a list of all of the user's characters for the given statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/characters/get-leaderboard-for-user-characters"},{"title":"Grant Character To User","openapi":"post /Server/GrantCharacterToUser","description":"Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.","href":"/services/playfab/api-references/rest/server/characters/grant-character-to-user"},{"title":"Update Character Statistics","openapi":"post /Server/UpdateCharacterStatistics","description":"Updates the values of the specified title-specific statistics for the specific character\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InvalidCharacterStatistics | 1138 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/characters/update-character-statistics"}]},{"group":"Content","pages":[{"title":"Get Content Download Url","openapi":"post /Server/GetContentDownloadUrl","description":"This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.","href":"/services/playfab/api-references/rest/server/content/get-content-download-url"}]},{"group":"Friend List Management","pages":[{"title":"Add Friend","openapi":"post /Server/AddFriend","description":"Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UsersAlreadyFriends | 1183 |\n","href":"/services/playfab/api-references/rest/server/friend-list-management/add-friend"},{"title":"Get Friends List","openapi":"post /Server/GetFriendsList","description":"Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| InvalidXboxLiveToken | 1188 |\n| PlayerSecretNotConfigured | 1323 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/server/friend-list-management/get-friends-list"},{"title":"Remove Friend","openapi":"post /Server/RemoveFriend","description":"Removes the specified friend from the the user's friend list\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n","href":"/services/playfab/api-references/rest/server/friend-list-management/remove-friend"},{"title":"Set Friend Tags","openapi":"post /Server/SetFriendTags","description":"Updates the tag list for a specified user in the friend list of another user","href":"/services/playfab/api-references/rest/server/friend-list-management/set-friend-tags"}]},{"group":"Platform Specific Methods","pages":[{"title":"Award Steam Achievement","openapi":"post /Server/AwardSteamAchievement","description":"Awards the specified users the specified Steam achievements\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| UserisNotValid | 1030 |\n","href":"/services/playfab/api-references/rest/server/platform-specific-methods/award-steam-achievement"}]},{"group":"Player Data Management","pages":[{"title":"Delete Player Custom Properties","openapi":"post /Server/DeletePlayerCustomProperties","description":"Deletes title-specific custom properties for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/delete-player-custom-properties"},{"title":"Get Friend Leaderboard","openapi":"post /Server/GetFriendLeaderboard","description":"Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidXboxLiveToken | 1188 |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/get-friend-leaderboard"},{"title":"Get Leaderboard","openapi":"post /Server/GetLeaderboard","description":"Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/get-leaderboard"},{"title":"Get Leaderboard Around User","openapi":"post /Server/GetLeaderboardAroundUser","description":"Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/get-leaderboard-around-user"},{"title":"Get Player Combined Info","openapi":"post /Server/GetPlayerCombinedInfo","description":"Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false.","href":"/services/playfab/api-references/rest/server/player-data-management/get-player-combined-info"},{"title":"Get Player Custom Property","openapi":"post /Server/GetPlayerCustomProperty","description":"Retrieves a title-specific custom property value for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesPropertyDoesNotExist | 19007 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/get-player-custom-property"},{"title":"Get Player Statistics","openapi":"post /Server/GetPlayerStatistics","description":"Retrieves the current version and values for the indicated statistics, for the local player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/get-player-statistics"},{"title":"Get Player Statistic Versions","openapi":"post /Server/GetPlayerStatisticVersions","description":"Retrieves the information on the available versions of the specified statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/get-player-statistic-versions"},{"title":"Get User Data","openapi":"post /Server/GetUserData","description":"Retrieves the title-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/rest/server/player-data-management/get-user-data"},{"title":"Get User Internal Data","openapi":"post /Server/GetUserInternalData","description":"Retrieves the title-specific custom data for the user which cannot be accessed by the client","href":"/services/playfab/api-references/rest/server/player-data-management/get-user-internal-data"},{"title":"Get User Publisher Data","openapi":"post /Server/GetUserPublisherData","description":"Retrieves the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/get-user-publisher-data"},{"title":"Get User Publisher Internal Data","openapi":"post /Server/GetUserPublisherInternalData","description":"Retrieves the publisher-specific custom data for the user which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/get-user-publisher-internal-data"},{"title":"Get User Publisher Read Only Data","openapi":"post /Server/GetUserPublisherReadOnlyData","description":"Retrieves the publisher-specific custom data for the user which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/get-user-publisher-read-only-data"},{"title":"Get User Read Only Data","openapi":"post /Server/GetUserReadOnlyData","description":"Retrieves the title-specific custom data for the user which can only be read by the client","href":"/services/playfab/api-references/rest/server/player-data-management/get-user-read-only-data"},{"title":"List Player Custom Properties","openapi":"post /Server/ListPlayerCustomProperties","description":"Retrieves title-specific custom property values for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/list-player-custom-properties"},{"title":"Update Player Custom Properties","openapi":"post /Server/UpdatePlayerCustomProperties","description":"Updates the title-specific custom property values for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesDuplicatePropertyName | 19006 |\n| PlayerCustomPropertiesPropertyCountTooHigh | 19005 |\n| PlayerCustomPropertiesPropertyNameIsInvalid | 19001 |\n| PlayerCustomPropertiesPropertyNameTooLong | 19000 |\n| PlayerCustomPropertiesStringPropertyValueTooLong | 19002 |\n| PlayerCustomPropertiesValueIsInvalidType | 19003 |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/update-player-custom-properties"},{"title":"Update Player Statistics","openapi":"post /Server/UpdatePlayerStatistics","description":"Updates the values of the specified title-specific statistics for the user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DuplicateStatisticName | 1253 |\n| ProductDisabledForTitle | 1609 |\n| StatisticCountLimitExceeded | 1203 |\n| StatisticNameConflict | 1196 |\n| StatisticNotFound | 1195 |\n| StatisticValueAggregationOverflow | 1308 |\n| StatisticVersionClosedForWrites | 1197 |\n| StatisticVersionInvalid | 1198 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/update-player-statistics"},{"title":"Update User Data","openapi":"post /Server/UpdateUserData","description":"Updates the title-specific custom data for the user which is readable and writable by the client","href":"/services/playfab/api-references/rest/server/player-data-management/update-user-data"},{"title":"Update User Internal Data","openapi":"post /Server/UpdateUserInternalData","description":"Updates the title-specific custom data for the user which cannot be accessed by the client","href":"/services/playfab/api-references/rest/server/player-data-management/update-user-internal-data"},{"title":"Update User Publisher Data","openapi":"post /Server/UpdateUserPublisherData","description":"Updates the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/update-user-publisher-data"},{"title":"Update User Publisher Internal Data","openapi":"post /Server/UpdateUserPublisherInternalData","description":"Updates the publisher-specific custom data for the user which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/update-user-publisher-internal-data"},{"title":"Update User Publisher Read Only Data","openapi":"post /Server/UpdateUserPublisherReadOnlyData","description":"Updates the publisher-specific custom data for the user which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/server/player-data-management/update-user-publisher-read-only-data"},{"title":"Update User Read Only Data","openapi":"post /Server/UpdateUserReadOnlyData","description":"Updates the title-specific custom data for the user which can only be read by the client","href":"/services/playfab/api-references/rest/server/player-data-management/update-user-read-only-data"}]},{"group":"Player Item Management","pages":[{"title":"Add Character Virtual Currency","openapi":"post /Server/AddCharacterVirtualCurrency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the character's balance of the specified virtual currency by the stated amount\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/add-character-virtual-currency"},{"title":"Add User Virtual Currency","openapi":"post /Server/AddUserVirtualCurrency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the user's balance of the specified virtual currency by the stated amount\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/add-user-virtual-currency"},{"title":"Consume Item","openapi":"post /Server/ConsumeItem","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InvalidItemProperties | 1091 |\n| ItemNotFound | 1047 |\n| NoRemainingUses | 1062 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/consume-item"},{"title":"Evaluate Random Result Table","openapi":"post /Server/EvaluateRandomResultTable","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| InvalidDropTable | 1201 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/evaluate-random-result-table"},{"title":"Get Character Inventory","openapi":"post /Server/GetCharacterInventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified character's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/get-character-inventory"},{"title":"Get Random Result Tables","openapi":"post /Server/GetRandomResultTables","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| InvalidDropTable | 1201 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/get-random-result-tables"},{"title":"Get User Inventory","openapi":"post /Server/GetUserInventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified user's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/get-user-inventory"},{"title":"Grant Items To Character","openapi":"post /Server/GrantItemsToCharacter","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified character's inventory\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/grant-items-to-character"},{"title":"Grant Items To User","openapi":"post /Server/GrantItemsToUser","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified user's inventory\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/grant-items-to-user"},{"title":"Grant Items To Users","openapi":"post /Server/GrantItemsToUsers","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified user inventories\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/grant-items-to-users"},{"title":"Modify Item Uses","openapi":"post /Server/ModifyItemUses","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Modifies the number of remaining uses of a player's inventory item\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidItemProperties | 1091 |\n| NoRemainingUses | 1062 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/modify-item-uses"},{"title":"Move Item To Character From Character","openapi":"post /Server/MoveItemToCharacterFromCharacter","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a character's inventory into another of the users's character's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ItemNotOwned | 1048 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/move-item-to-character-from-character"},{"title":"Move Item To Character From User","openapi":"post /Server/MoveItemToCharacterFromUser","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a user's inventory into their character's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ItemNotOwned | 1048 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/move-item-to-character-from-user"},{"title":"Move Item To User From Character","openapi":"post /Server/MoveItemToUserFromCharacter","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a character's inventory into the owning user's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ItemNotOwned | 1048 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/move-item-to-user-from-character"},{"title":"Redeem Coupon","openapi":"post /Server/RedeemCoupon","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| CharacterNotFound | 1135 |\n| CouponAlreadyRedeemed | 1226 |\n| CouponCodeNotFound | 1016 |\n| LegacyEconomyDisabled | 4016 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/redeem-coupon"},{"title":"Report Player","openapi":"post /Server/ReportPlayer","description":"Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players.","href":"/services/playfab/api-references/rest/server/player-item-management/report-player"},{"title":"Revoke Inventory Item","openapi":"post /Server/RevokeInventoryItem","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access to an item in a user's inventory\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/revoke-inventory-item"},{"title":"Revoke Inventory Items","openapi":"post /Server/RevokeInventoryItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access for up to 25 items across multiple users and characters.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/revoke-inventory-items"},{"title":"Subtract Character Virtual Currency","openapi":"post /Server/SubtractCharacterVirtualCurrency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the character's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/subtract-character-virtual-currency"},{"title":"Subtract User Virtual Currency","openapi":"post /Server/SubtractUserVirtualCurrency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/subtract-user-virtual-currency"},{"title":"Unlock Container Instance","openapi":"post /Server/UnlockContainerInstance","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ContainerKeyInvalid | 1205 |\n| ContainerNotOwned | 1018 |\n| InvalidContainerItem | 1017 |\n| InvalidItemIdInTable | 1020 |\n| InvalidItemProperties | 1091 |\n| KeyNotOwned | 1019 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/unlock-container-instance"},{"title":"Unlock Container Item","openapi":"post /Server/UnlockContainerItem","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ContainerKeyInvalid | 1205 |\n| ContainerNotOwned | 1018 |\n| InvalidContainerItem | 1017 |\n| InvalidItemIdInTable | 1020 |\n| InvalidItemProperties | 1091 |\n| KeyNotOwned | 1019 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/unlock-container-item"},{"title":"Update User Inventory Item Custom Data","openapi":"post /Server/UpdateUserInventoryItemCustomData","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the key-value pair data tagged to the specified item, which is read-only from the client.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/player-item-management/update-user-inventory-item-custom-data"}]},{"group":"Play Stream","pages":[{"title":"Add Player Tag","openapi":"post /Server/AddPlayerTag","description":"Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerTagCountLimitExceeded | 1248 |\n","href":"/services/playfab/api-references/rest/server/play-stream/add-player-tag"},{"title":"Export Players In Segment","openapi":"post /Server/ExportPlayersInSegment","description":"Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which match the segment definition at the time of the API call. Profiles which change while an export is in progress will not be reflected in the results.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AsyncExportNotInFlight | 10011 |\n| AsyncExportRateLimitExceeded | 10013 |\n| ExportUnknownError | 5013 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","href":"/services/playfab/api-references/rest/server/play-stream/export-players-in-segment"},{"title":"Get All Segments","openapi":"post /Server/GetAllSegments","description":"Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/play-stream/get-all-segments"},{"title":"Get Player Segments","openapi":"post /Server/GetPlayerSegments","description":"List all segments that a player currently belongs to at this moment in time.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/play-stream/get-player-segments"},{"title":"Get Player Tags","openapi":"post /Server/GetPlayerTags","description":"Get all tags with a given Namespace (optional) from a player profile.","href":"/services/playfab/api-references/rest/server/play-stream/get-player-tags"},{"title":"Get Segment Export","openapi":"post /Server/GetSegmentExport","description":"Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of the export\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AsyncExportNotInFlight | 10011 |\n| AsyncExportRateLimitExceeded | 10013 |\n| ExportNotFound | 5004 |\n| ExportUnknownError | 5013 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/play-stream/get-segment-export"},{"title":"Get Segment Player Count","openapi":"post /Server/GetSegmentPlayerCount","description":"Returns the total number of players in a given segment.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GetSegmentPlayerCountNotInFlight | 10016 |\n| GetSegmentPlayerCountRateLimitExceeded | 10017 |\n| InternalServerError | 1110 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","href":"/services/playfab/api-references/rest/server/play-stream/get-segment-player-count"},{"title":"Remove Player Tag","openapi":"post /Server/RemovePlayerTag","description":"Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.","href":"/services/playfab/api-references/rest/server/play-stream/remove-player-tag"}]},{"group":"Server-Side Cloud Script","pages":[{"title":"Execute Cloud Script","openapi":"post /Server/ExecuteCloudScript","description":"Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The PlayFab ID is the entity ID of the player's master_player_account entity.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAPIRequestCountExceeded | 1209 |\n| CloudScriptAPIRequestError | 1210 |\n| CloudScriptFunctionArgumentSizeExceeded | 1208 |\n| CloudScriptHTTPRequestError | 1211 |\n| CloudScriptNotFound | 1136 |\n| JavascriptException | 1099 |\n| ProductDisabledForTitle | 1609 |\n| TitleDeleted | 1347 |\n","href":"/services/playfab/api-references/rest/server/server-side-cloud-script/execute-cloud-script"}]},{"group":"Shared Group Data","pages":[{"title":"Add Shared Group Members","openapi":"post /Server/AddSharedGroupMembers","description":"Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n| UserAlreadyAdded | 1235 |\n","href":"/services/playfab/api-references/rest/server/shared-group-data/add-shared-group-members"},{"title":"Create Shared Group","openapi":"post /Server/CreateSharedGroup","description":"Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/shared-group-data/create-shared-group"},{"title":"Delete Shared Group","openapi":"post /Server/DeleteSharedGroup","description":"Deletes a shared group, freeing up the shared group ID to be reused for a new group. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/shared-group-data/delete-shared-group"},{"title":"Get Shared Group Data","openapi":"post /Server/GetSharedGroupData","description":"Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/shared-group-data/get-shared-group-data"},{"title":"Remove Shared Group Members","openapi":"post /Server/RemoveSharedGroupMembers","description":"Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/shared-group-data/remove-shared-group-members"},{"title":"Update Shared Group Data","openapi":"post /Server/UpdateSharedGroupData","description":"Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group (and the server) can update the data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerSecretNotConfigured | 1323 |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/shared-group-data/update-shared-group-data"}]},{"group":"Title-Wide Data Management","pages":[{"title":"Get Catalog Items","openapi":"post /Server/GetCatalogItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","href":"/services/playfab/api-references/rest/server/title-wide-data-management/get-catalog-items"},{"title":"Get Publisher Data","openapi":"post /Server/GetPublisherData","description":"Retrieves the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/server/title-wide-data-management/get-publisher-data"},{"title":"Get Store Items","openapi":"post /Server/GetStoreItems","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","href":"/services/playfab/api-references/rest/server/title-wide-data-management/get-store-items"},{"title":"Get Time","openapi":"post /Server/GetTime","description":"Retrieves the current server time\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/server/title-wide-data-management/get-time"},{"title":"Get Title Data","openapi":"post /Server/GetTitleData","description":"Retrieves the key-value store of custom title settings","href":"/services/playfab/api-references/rest/server/title-wide-data-management/get-title-data"},{"title":"Get Title Internal Data","openapi":"post /Server/GetTitleInternalData","description":"Retrieves the key-value store of custom internal title settings","href":"/services/playfab/api-references/rest/server/title-wide-data-management/get-title-internal-data"},{"title":"Get Title News","openapi":"post /Server/GetTitleNews","description":"Retrieves the title news feed, as configured in the developer portal","href":"/services/playfab/api-references/rest/server/title-wide-data-management/get-title-news"},{"title":"Set Publisher Data","openapi":"post /Server/SetPublisherData","description":"Updates the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","href":"/services/playfab/api-references/rest/server/title-wide-data-management/set-publisher-data"},{"title":"Set Title Data","openapi":"post /Server/SetTitleData","description":"Updates the key-value store of custom title settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| TooManyKeys | 1147 |\n","href":"/services/playfab/api-references/rest/server/title-wide-data-management/set-title-data"},{"title":"Set Title Internal Data","openapi":"post /Server/SetTitleInternalData","description":"Updates the key-value store of custom title settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| TooManyKeys | 1147 |\n","href":"/services/playfab/api-references/rest/server/title-wide-data-management/set-title-internal-data"}]},{"group":"Player Item Management","pages":[{"title":"Add Character Virtual Currency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the character's balance of the specified virtual currency by the stated amount\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddCharacterVirtualCurrency","href":"/api-reference/player-item-management/add-character-virtual-currency","autogeneratedByOpenApi":true},{"title":"Add User Virtual Currency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the user's balance of the specified virtual currency by the stated amount\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddUserVirtualCurrency","href":"/api-reference/player-item-management/add-user-virtual-currency","autogeneratedByOpenApi":true},{"title":"Consume Item","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InvalidItemProperties | 1091 |\n| ItemNotFound | 1047 |\n| NoRemainingUses | 1062 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ConsumeItem","href":"/api-reference/player-item-management/consume-item","autogeneratedByOpenApi":true},{"title":"Evaluate Random Result Table","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| InvalidDropTable | 1201 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/EvaluateRandomResultTable","href":"/api-reference/player-item-management/evaluate-random-result-table","autogeneratedByOpenApi":true},{"title":"Get Character Inventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified character's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterInventory","href":"/api-reference/player-item-management/get-character-inventory","autogeneratedByOpenApi":true},{"title":"Get Random Result Tables","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| InvalidDropTable | 1201 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetRandomResultTables","href":"/api-reference/player-item-management/get-random-result-tables","autogeneratedByOpenApi":true},{"title":"Get User Inventory","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified user's current inventory of virtual goods\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserInventory","href":"/api-reference/player-item-management/get-user-inventory","autogeneratedByOpenApi":true},{"title":"Grant Items To Character","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified character's inventory\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GrantItemsToCharacter","href":"/api-reference/player-item-management/grant-items-to-character","autogeneratedByOpenApi":true},{"title":"Grant Items To User","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified user's inventory\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GrantItemsToUser","href":"/api-reference/player-item-management/grant-items-to-user","autogeneratedByOpenApi":true},{"title":"Grant Items To Users","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified user inventories\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GrantItemsToUsers","href":"/api-reference/player-item-management/grant-items-to-users","autogeneratedByOpenApi":true},{"title":"Modify Item Uses","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Modifies the number of remaining uses of a player's inventory item\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidItemProperties | 1091 |\n| NoRemainingUses | 1062 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ModifyItemUses","href":"/api-reference/player-item-management/modify-item-uses","autogeneratedByOpenApi":true},{"title":"Move Item To Character From Character","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a character's inventory into another of the users's character's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ItemNotOwned | 1048 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/MoveItemToCharacterFromCharacter","href":"/api-reference/player-item-management/move-item-to-character-from-character","autogeneratedByOpenApi":true},{"title":"Move Item To Character From User","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a user's inventory into their character's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ItemNotOwned | 1048 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/MoveItemToCharacterFromUser","href":"/api-reference/player-item-management/move-item-to-character-from-user","autogeneratedByOpenApi":true},{"title":"Move Item To User From Character","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a character's inventory into the owning user's inventory.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ItemNotOwned | 1048 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/MoveItemToUserFromCharacter","href":"/api-reference/player-item-management/move-item-to-user-from-character","autogeneratedByOpenApi":true},{"title":"Redeem Coupon","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| CharacterNotFound | 1135 |\n| CouponAlreadyRedeemed | 1226 |\n| CouponCodeNotFound | 1016 |\n| LegacyEconomyDisabled | 4016 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RedeemCoupon","href":"/api-reference/player-item-management/redeem-coupon","autogeneratedByOpenApi":true},{"title":"Report Player","description":"Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ReportPlayer","href":"/api-reference/player-item-management/report-player","autogeneratedByOpenApi":true},{"title":"Revoke Inventory Item","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access to an item in a user's inventory\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RevokeInventoryItem","href":"/api-reference/player-item-management/revoke-inventory-item","autogeneratedByOpenApi":true},{"title":"Revoke Inventory Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access for up to 25 items across multiple users and characters.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ItemNotFound | 1047 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RevokeInventoryItems","href":"/api-reference/player-item-management/revoke-inventory-items","autogeneratedByOpenApi":true},{"title":"Subtract Character Virtual Currency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the character's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SubtractCharacterVirtualCurrency","href":"/api-reference/player-item-management/subtract-character-virtual-currency","autogeneratedByOpenApi":true},{"title":"Subtract User Virtual Currency","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidVirtualCurrency | 1051 |\n| ProductDisabledForTitle | 1609 |\n| VirtualCurrencyCurrentlyUnavailable | 1512 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SubtractUserVirtualCurrency","href":"/api-reference/player-item-management/subtract-user-virtual-currency","autogeneratedByOpenApi":true},{"title":"Unlock Container Instance","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ContainerKeyInvalid | 1205 |\n| ContainerNotOwned | 1018 |\n| InvalidContainerItem | 1017 |\n| InvalidItemIdInTable | 1020 |\n| InvalidItemProperties | 1091 |\n| KeyNotOwned | 1019 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlockContainerInstance","href":"/api-reference/player-item-management/unlock-container-instance","autogeneratedByOpenApi":true},{"title":"Unlock Container Item","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ContainerKeyInvalid | 1205 |\n| ContainerNotOwned | 1018 |\n| InvalidContainerItem | 1017 |\n| InvalidItemIdInTable | 1020 |\n| InvalidItemProperties | 1091 |\n| KeyNotOwned | 1019 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlockContainerItem","href":"/api-reference/player-item-management/unlock-container-item","autogeneratedByOpenApi":true},{"title":"Update User Inventory Item Custom Data","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the key-value pair data tagged to the specified item, which is read-only from the client.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserInventoryItemCustomData","href":"/api-reference/player-item-management/update-user-inventory-item-custom-data","autogeneratedByOpenApi":true}]},{"group":"Friend List Management","pages":[{"title":"Add Friend","description":"Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UsersAlreadyFriends | 1183 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddFriend","href":"/api-reference/friend-list-management/add-friend","autogeneratedByOpenApi":true},{"title":"Get Friends List","description":"Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| InvalidXboxLiveToken | 1188 |\n| PlayerSecretNotConfigured | 1323 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetFriendsList","href":"/api-reference/friend-list-management/get-friends-list","autogeneratedByOpenApi":true},{"title":"Remove Friend","description":"Removes the specified friend from the the user's friend list\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RemoveFriend","href":"/api-reference/friend-list-management/remove-friend","autogeneratedByOpenApi":true},{"title":"Set Friend Tags","description":"Updates the tag list for a specified user in the friend list of another user","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetFriendTags","href":"/api-reference/friend-list-management/set-friend-tags","autogeneratedByOpenApi":true}]},{"group":"Account Management","pages":[{"title":"Add Generic ID","description":"Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| IdentifierAlreadyClaimed | 1238 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddGenericID","href":"/api-reference/account-management/add-generic-id","autogeneratedByOpenApi":true},{"title":"Add Or Update Contact Email","description":"Adds or updates a contact email to the specified player's profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddOrUpdateContactEmail","href":"/api-reference/account-management/add-or-update-contact-email","autogeneratedByOpenApi":true},{"title":"Ban Users","description":"Bans users by PlayFab ID with optional IP address for the provided game.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/BanUsers","href":"/api-reference/account-management/ban-users","autogeneratedByOpenApi":true},{"title":"Delete Player","description":"Removes a user's player account from a title and deletes all associated data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| APINotEnabledForGameServerAccess | 1194 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/DeletePlayer","href":"/api-reference/account-management/delete-player","autogeneratedByOpenApi":true},{"title":"Delete Push Notification Template","description":"Deletes push notification template for title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PushNotificationTemplateNotFound | 1417 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/DeletePushNotificationTemplate","href":"/api-reference/account-management/delete-push-notification-template","autogeneratedByOpenApi":true},{"title":"Get Player Profile","description":"Retrieves the player's profile\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerNotInGame | 1033 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerProfile","href":"/api-reference/account-management/get-player-profile","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Battle Net Account Ids","description":"Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromBattleNetAccountIds","href":"/api-reference/account-management/get-play-fab-ids-from-battle-net-account-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Facebook IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromFacebookIDs","href":"/api-reference/account-management/get-play-fab-ids-from-facebook-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Facebook Instant Games Ids","description":"Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromFacebookInstantGamesIds","href":"/api-reference/account-management/get-play-fab-ids-from-facebook-instant-games-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Generic IDs","description":"Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromGenericIDs","href":"/api-reference/account-management/get-play-fab-ids-from-generic-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Nintendo Service Account Ids","description":"Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromNintendoServiceAccountIds","href":"/api-reference/account-management/get-play-fab-ids-from-nintendo-service-account-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Nintendo Switch Device Ids","description":"Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromNintendoSwitchDeviceIds","href":"/api-reference/account-management/get-play-fab-ids-from-nintendo-switch-device-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Open Id Subject Identifiers","description":"Retrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId subject identifier is the OpenId issuer plus the OpenId subject for the player, as specified by the title when the OpenId identifier was added to the player account.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromOpenIdSubjectIdentifiers","href":"/api-reference/account-management/get-play-fab-ids-from-open-id-subject-identifiers","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From PSN Account IDs","description":"Retrieves the unique PlayFab identifiers for the given set of PlayStation™ Network identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromPSNAccountIDs","href":"/api-reference/account-management/get-play-fab-ids-from-psn-account-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From PSN Online IDs","description":"Retrieves the unique PlayFab identifiers for the given set of PlayStation™ Network identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromPSNOnlineIDs","href":"/api-reference/account-management/get-play-fab-ids-from-psn-online-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Server Custom IDs","description":"Retrieves the associated PlayFab account identifiers for the given set of server custom player identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromServerCustomIDs","href":"/api-reference/account-management/get-play-fab-ids-from-server-custom-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Steam IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromSteamIDs","href":"/api-reference/account-management/get-play-fab-ids-from-steam-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Steam Names","description":"Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromSteamNames","href":"/api-reference/account-management/get-play-fab-ids-from-steam-names","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Twitch IDs","description":"Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as \"_id\" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromTwitchIDs","href":"/api-reference/account-management/get-play-fab-ids-from-twitch-ids","autogeneratedByOpenApi":true},{"title":"Get Play Fab IDs From Xbox Live IDs","description":"Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayFabIDsFromXboxLiveIDs","href":"/api-reference/account-management/get-play-fab-ids-from-xbox-live-ids","autogeneratedByOpenApi":true},{"title":"Get Server Custom IDs From Play Fab IDs","description":"Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetServerCustomIDsFromPlayFabIDs","href":"/api-reference/account-management/get-server-custom-ids-from-play-fab-ids","autogeneratedByOpenApi":true},{"title":"Get User Account Info","description":"Retrieves the relevant details for a specified user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| TitleNotActivated | 1042 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserAccountInfo","href":"/api-reference/account-management/get-user-account-info","autogeneratedByOpenApi":true},{"title":"Get User Bans","description":"Gets all bans for a user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserBans","href":"/api-reference/account-management/get-user-bans","autogeneratedByOpenApi":true},{"title":"Link Battle Net Account","description":"Links the Battle.net account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| BattleNetNotEnabledForTitle | 1602 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkBattleNetAccount","href":"/api-reference/account-management/link-battle-net-account","autogeneratedByOpenApi":true},{"title":"Link Nintendo Service Account","description":"Links the Nintendo account associated with the token to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidIdentityProviderId | 1263 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkNintendoServiceAccount","href":"/api-reference/account-management/link-nintendo-service-account","autogeneratedByOpenApi":true},{"title":"Link Nintendo Service Account Subject","description":"Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidIdentityProviderId | 1263 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkNintendoServiceAccountSubject","href":"/api-reference/account-management/link-nintendo-service-account-subject","autogeneratedByOpenApi":true},{"title":"Link Nintendo Switch Device Id","description":"Links the NintendoSwitchDeviceId to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkNintendoSwitchDeviceId","href":"/api-reference/account-management/link-nintendo-switch-device-id","autogeneratedByOpenApi":true},{"title":"Link PSN Account","description":"Links the PlayStation™ Network account associated with the provided access code to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| DownstreamServiceUnavailable | 1127 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidParams | 1000 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| PSNInaccessible | 1152 |\n| PSNNextGenNotConfiguredForTitle | 1617 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkPSNAccount","href":"/api-reference/account-management/link-psn-account","autogeneratedByOpenApi":true},{"title":"Link PSN Id","description":"Links the PlayStation™ Network account associated with the provided user id to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| PSNInaccessible | 1152 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkPSNId","href":"/api-reference/account-management/link-psn-id","autogeneratedByOpenApi":true},{"title":"Link Server Custom Id","description":"Links the custom server identifier, generated by the title, to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkServerCustomId","href":"/api-reference/account-management/link-server-custom-id","autogeneratedByOpenApi":true},{"title":"Link Steam Id","description":"Links the Steam account associated with the provided Steam ID to the user's PlayFab account \n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidSteamTicket | 1010 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| SteamNotEnabledForTitle | 1258 |\n| SteamUserNotFound | 1513 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkSteamId","href":"/api-reference/account-management/link-steam-id","autogeneratedByOpenApi":true},{"title":"Link Twitch Account","description":"Links the Twitch account associated with the token to the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidTwitchToken | 1232 |\n| LinkedAccountAlreadyClaimed | 1012 |\n| LinkedIdentifierAlreadyClaimed | 1184 |\n| TwitchResponseError | 1233 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkTwitchAccount","href":"/api-reference/account-management/link-twitch-account","autogeneratedByOpenApi":true},{"title":"Link Xbox Account","description":"Links the Xbox Live account associated with the provided access code to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidXboxLiveToken | 1188 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkXboxAccount","href":"/api-reference/account-management/link-xbox-account","autogeneratedByOpenApi":true},{"title":"Link Xbox Id","description":"Links the Xbox Live account associated with the provided Xbox ID and Sandbox to the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountAlreadyLinked | 1011 |\n| AccountNotFound | 1001 |\n| InvalidNamespaceMismatch | 1561 |\n| LinkedAccountAlreadyClaimed | 1012 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LinkXboxId","href":"/api-reference/account-management/link-xbox-id","autogeneratedByOpenApi":true},{"title":"Remove Generic ID","description":"Removes the specified generic service identifier from the player's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotLinked | 1014 |\n| IdentifierNotLinked | 1239 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RemoveGenericID","href":"/api-reference/account-management/remove-generic-id","autogeneratedByOpenApi":true},{"title":"Revoke All Bans For User","description":"Revoke all active bans for a user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RevokeAllBansForUser","href":"/api-reference/account-management/revoke-all-bans-for-user","autogeneratedByOpenApi":true},{"title":"Revoke Bans","description":"Revoke all active bans specified with BanId.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RevokeBans","href":"/api-reference/account-management/revoke-bans","autogeneratedByOpenApi":true},{"title":"Save Push Notification Template","description":"Saves push notification template for title\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidLocalizedPushNotificationLanguage | 1409 |\n| MissingLocalizedPushNotificationMessage | 1410 |\n| PushNotificationTemplateAndroidPayloadMissingNotificationBody | 1416 |\n| PushNotificationTemplateContainsInvalidAndroidPayload | 1414 |\n| PushNotificationTemplateContainsInvalidIosPayload | 1413 |\n| PushNotificationTemplateInvalidPayload | 1408 |\n| PushNotificationTemplateInvalidSyntax | 1419 |\n| PushNotificationTemplateIosPayloadMissingNotificationBody | 1415 |\n| PushNotificationTemplateMissingDefaultVersion | 1418 |\n| PushNotificationTemplateMissingName | 1442 |\n| PushNotificationTemplateMissingPlatformPayload | 1411 |\n| PushNotificationTemplateNoCustomPayloadForV1 | 1420 |\n| PushNotificationTemplatePayloadContainsInvalidJson | 1412 |\n| TitleDefaultLanguageNotSet | 1393 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SavePushNotificationTemplate","href":"/api-reference/account-management/save-push-notification-template","autogeneratedByOpenApi":true},{"title":"Send Custom Account Recovery Email","description":"Forces an email to be sent to the registered contact email address for the user's account based on an account recovery email template\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailClientCanceledTask | 1317 |\n| EmailClientTimeout | 1316 |\n| EmailMessageToAddressIsMissing | 1310 |\n| EmailTemplateMissing | 1318 |\n| NoContactEmailAddressFound | 1325 |\n| SmtpAddonNotEnabled | 1341 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SendCustomAccountRecoveryEmail","href":"/api-reference/account-management/send-custom-account-recovery-email","autogeneratedByOpenApi":true},{"title":"Send Email From Template","description":"Sends an email based on an email template to a player's contact email \n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EmailClientCanceledTask | 1317 |\n| EmailClientTimeout | 1316 |\n| EmailTemplateMissing | 1318 |\n| NoContactEmailAddressFound | 1325 |\n| SmtpAddonNotEnabled | 1341 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SendEmailFromTemplate","href":"/api-reference/account-management/send-email-from-template","autogeneratedByOpenApi":true},{"title":"Send Push Notification","description":"Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PushNotEnabledForAccount | 1094 |\n| PushServiceError | 1095 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SendPushNotification","href":"/api-reference/account-management/send-push-notification","autogeneratedByOpenApi":true},{"title":"Send Push Notification From Template","description":"Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PushNotEnabledForAccount | 1094 |\n| PushNotificationTemplateNotFound | 1417 |\n| PushServiceError | 1095 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SendPushNotificationFromTemplate","href":"/api-reference/account-management/send-push-notification-from-template","autogeneratedByOpenApi":true},{"title":"Unlink Apple","description":"Unlinks the related Apple account from the specified user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| AppleNotEnabledForTitle | 1501 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkApple","href":"/api-reference/account-management/unlink-apple","autogeneratedByOpenApi":true},{"title":"Unlink Battle Net Account","description":"Unlinks the related Battle.net account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| BattleNetNotEnabledForTitle | 1602 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkBattleNetAccount","href":"/api-reference/account-management/unlink-battle-net-account","autogeneratedByOpenApi":true},{"title":"Unlink Facebook Account","description":"Unlinks the related Facebook account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkFacebookAccount","href":"/api-reference/account-management/unlink-facebook-account","autogeneratedByOpenApi":true},{"title":"Unlink Facebook Instant Games Id","description":"Unlinks the related Facebook Instant Games identifier from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| FacebookInstantGamesIdNotLinked | 1395 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkFacebookInstantGamesId","href":"/api-reference/account-management/unlink-facebook-instant-games-id","autogeneratedByOpenApi":true},{"title":"Unlink Game Center Account","description":"Unlinks the related Game Center account from the specified user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkGameCenterAccount","href":"/api-reference/account-management/unlink-game-center-account","autogeneratedByOpenApi":true},{"title":"Unlink Nintendo Service Account","description":"Unlinks the related Nintendo account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n| NintendoSwitchNotEnabledForTitle | 1506 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkNintendoServiceAccount","href":"/api-reference/account-management/unlink-nintendo-service-account","autogeneratedByOpenApi":true},{"title":"Unlink Nintendo Switch Device Id","description":"Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n| NintendoSwitchDeviceIdNotLinked | 2034 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkNintendoSwitchDeviceId","href":"/api-reference/account-management/unlink-nintendo-switch-device-id","autogeneratedByOpenApi":true},{"title":"Unlink PSN Account","description":"Unlinks the related PlayStation™ Network account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkPSNAccount","href":"/api-reference/account-management/unlink-psn-account","autogeneratedByOpenApi":true},{"title":"Unlink Server Custom Id","description":"Unlinks the custom server identifier from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| IdentifierNotLinked | 1239 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkServerCustomId","href":"/api-reference/account-management/unlink-server-custom-id","autogeneratedByOpenApi":true},{"title":"Unlink Steam Id","description":"Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account \n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkSteamId","href":"/api-reference/account-management/unlink-steam-id","autogeneratedByOpenApi":true},{"title":"Unlink Twitch Account","description":"Unlinks the related Twitch account from the user's PlayFab account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidTwitchToken | 1232 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkTwitchAccount","href":"/api-reference/account-management/unlink-twitch-account","autogeneratedByOpenApi":true},{"title":"Unlink Xbox Account","description":"Unlinks the related Xbox Live account from the user's PlayFab account\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| AccountNotLinked | 1014 |\n| InvalidNamespaceMismatch | 1561 |\n| InvalidXboxLiveToken | 1188 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UnlinkXboxAccount","href":"/api-reference/account-management/unlink-xbox-account","autogeneratedByOpenApi":true},{"title":"Update Avatar Url","description":"Update the avatar URL of the specified player","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateAvatarUrl","href":"/api-reference/account-management/update-avatar-url","autogeneratedByOpenApi":true},{"title":"Update Bans","description":"Updates information of a list of existing bans specified with Ban Ids.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateBans","href":"/api-reference/account-management/update-bans","autogeneratedByOpenApi":true}]},{"group":"PlayStream","pages":[{"title":"Add Player Tag","description":"Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerTagCountLimitExceeded | 1248 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddPlayerTag","href":"/api-reference/playstream/add-player-tag","autogeneratedByOpenApi":true},{"title":"Export Players In Segment","description":"Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which match the segment definition at the time of the API call. Profiles which change while an export is in progress will not be reflected in the results.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AsyncExportNotInFlight | 10011 |\n| AsyncExportRateLimitExceeded | 10013 |\n| ExportUnknownError | 5013 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ExportPlayersInSegment","href":"/api-reference/playstream/export-players-in-segment","autogeneratedByOpenApi":true},{"title":"Get All Segments","description":"Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetAllSegments","href":"/api-reference/playstream/get-all-segments","autogeneratedByOpenApi":true},{"title":"Get Player Segments","description":"List all segments that a player currently belongs to at this moment in time.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerSegments","href":"/api-reference/playstream/get-player-segments","autogeneratedByOpenApi":true},{"title":"Get Player Tags","description":"Get all tags with a given Namespace (optional) from a player profile.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerTags","href":"/api-reference/playstream/get-player-tags","autogeneratedByOpenApi":true},{"title":"Get Segment Export","description":"Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of the export\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AsyncExportNotInFlight | 10011 |\n| AsyncExportRateLimitExceeded | 10013 |\n| ExportNotFound | 5004 |\n| ExportUnknownError | 5013 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetSegmentExport","href":"/api-reference/playstream/get-segment-export","autogeneratedByOpenApi":true},{"title":"Get Segment Player Count","description":"Returns the total number of players in a given segment.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| GetSegmentPlayerCountNotInFlight | 10016 |\n| GetSegmentPlayerCountRateLimitExceeded | 10017 |\n| InternalServerError | 1110 |\n| InvalidSegment | 1242 |\n| ProductDisabledForTitle | 1609 |\n| SegmentNotFound | 1220 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetSegmentPlayerCount","href":"/api-reference/playstream/get-segment-player-count","autogeneratedByOpenApi":true},{"title":"Remove Player Tag","description":"Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RemovePlayerTag","href":"/api-reference/playstream/remove-player-tag","autogeneratedByOpenApi":true}]},{"group":"Shared Group Data","pages":[{"title":"Add Shared Group Members","description":"Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n| UserAlreadyAdded | 1235 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AddSharedGroupMembers","href":"/api-reference/shared-group-data/add-shared-group-members","autogeneratedByOpenApi":true},{"title":"Create Shared Group","description":"Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/CreateSharedGroup","href":"/api-reference/shared-group-data/create-shared-group","autogeneratedByOpenApi":true},{"title":"Delete Shared Group","description":"Deletes a shared group, freeing up the shared group ID to be reused for a new group. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/DeleteSharedGroup","href":"/api-reference/shared-group-data/delete-shared-group","autogeneratedByOpenApi":true},{"title":"Get Shared Group Data","description":"Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetSharedGroupData","href":"/api-reference/shared-group-data/get-shared-group-data","autogeneratedByOpenApi":true},{"title":"Remove Shared Group Members","description":"Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/RemoveSharedGroupMembers","href":"/api-reference/shared-group-data/remove-shared-group-members","autogeneratedByOpenApi":true},{"title":"Update Shared Group Data","description":"Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group (and the server) can update the data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSharedGroupId | 1088 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| PlayerSecretNotConfigured | 1323 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateSharedGroupData","href":"/api-reference/shared-group-data/update-shared-group-data","autogeneratedByOpenApi":true}]},{"group":"Authentication","pages":[{"title":"Authenticate Session Ticket","description":"Validated a client's session ticket, and if successful, returns details for that user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidSessionTicket | 1100 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AuthenticateSessionTicket","href":"/api-reference/authentication/authenticate-session-ticket","autogeneratedByOpenApi":true},{"title":"Login With Android Device ID","description":"Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithAndroidDeviceID","href":"/api-reference/authentication/login-with-android-device-id","autogeneratedByOpenApi":true},{"title":"Login With Battle Net","description":"Sign in the user with a Battle.net identity token\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| BattleNetNotEnabledForTitle | 1602 |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidAuthToken | 1326 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| InvalidTitleId | 1004 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithBattleNet","href":"/api-reference/authentication/login-with-battle-net","autogeneratedByOpenApi":true},{"title":"Login With Custom ID","description":"Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithCustomID","href":"/api-reference/authentication/login-with-custom-id","autogeneratedByOpenApi":true},{"title":"Login With IOS Device ID","description":"Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithIOSDeviceID","href":"/api-reference/authentication/login-with-ios-device-id","autogeneratedByOpenApi":true},{"title":"Login With PSN","description":"Signs the user in using a PlayStation™ Network authentication code, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EncryptionKeyMissing | 1290 |\n| EvaluationModePlayerCountExceeded | 1490 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidParams | 1000 |\n| InvalidPSNAuthCode | 1092 |\n| InvalidPSNIssuerId | 1151 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| PSNInaccessible | 1152 |\n| PSNNextGenNotConfiguredForTitle | 1617 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithPSN","href":"/api-reference/authentication/login-with-psn","autogeneratedByOpenApi":true},{"title":"Login With Server Custom Id","description":"Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithServerCustomId","href":"/api-reference/authentication/login-with-server-custom-id","autogeneratedByOpenApi":true},{"title":"Login With Steam Id","description":"Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| InvalidSignature | 1273 |\n| InvalidSignatureTime | 1324 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| SteamNotEnabledForTitle | 1258 |\n| SteamUserNotFound | 1513 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithSteamId","href":"/api-reference/authentication/login-with-steam-id","autogeneratedByOpenApi":true},{"title":"Login With Twitch","description":"Sign in the user with a Twitch access token\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| AccountNotFound | 1001 |\n| FeatureNotConfiguredForTitle | 1177 |\n| InvalidTwitchToken | 1232 |\n| PlayerSecretAlreadyConfigured | 1294 |\n| PlayerSecretNotConfigured | 1323 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| TwitchResponseError | 1233 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithTwitch","href":"/api-reference/authentication/login-with-twitch","autogeneratedByOpenApi":true},{"title":"Login With Xbox","description":"Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| ExpiredXboxLiveToken | 1189 |\n| InvalidXboxLiveToken | 1188 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| XboxInaccessible | 1339 |\n| XboxRejectedXSTSExchangeRequest | 1343 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithXbox","href":"/api-reference/authentication/login-with-xbox","autogeneratedByOpenApi":true},{"title":"Login With Xbox Id","description":"Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| EvaluationModePlayerCountExceeded | 1490 |\n| RequestViewConstraintParamsNotAllowed | 1303 |\n| XboxInaccessible | 1339 |\n| XboxRejectedXSTSExchangeRequest | 1343 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/LoginWithXboxId","href":"/api-reference/authentication/login-with-xbox-id","autogeneratedByOpenApi":true},{"title":"Set Player Secret","description":"Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's secret use the Admin or Server API method SetPlayerSecret.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerSecretAlreadyConfigured | 1294 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetPlayerSecret","href":"/api-reference/authentication/set-player-secret","autogeneratedByOpenApi":true}]},{"group":"Platform Specific Methods","pages":[{"title":"Award Steam Achievement","description":"Awards the specified users the specified Steam achievements\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/AwardSteamAchievement","href":"/api-reference/platform-specific-methods/award-steam-achievement","autogeneratedByOpenApi":true}]},{"group":"Characters","pages":[{"title":"Delete Character From User","description":"Deletes the specific character ID from the specified user.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/DeleteCharacterFromUser","href":"/api-reference/characters/delete-character-from-user","autogeneratedByOpenApi":true},{"title":"Get All Users Characters","description":"Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetAllUsersCharacters","href":"/api-reference/characters/get-all-users-characters","autogeneratedByOpenApi":true},{"title":"Get Character Leaderboard","description":"Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterLeaderboard","href":"/api-reference/characters/get-character-leaderboard","autogeneratedByOpenApi":true},{"title":"Get Character Statistics","description":"Retrieves the details of all title-specific statistics for the specific character\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterStatistics","href":"/api-reference/characters/get-character-statistics","autogeneratedByOpenApi":true},{"title":"Get Leaderboard Around Character","description":"Retrieves a list of ranked characters for the given statistic, centered on the requested user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetLeaderboardAroundCharacter","href":"/api-reference/characters/get-leaderboard-around-character","autogeneratedByOpenApi":true},{"title":"Get Leaderboard For User Characters","description":"Retrieves a list of all of the user's characters for the given statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetLeaderboardForUserCharacters","href":"/api-reference/characters/get-leaderboard-for-user-characters","autogeneratedByOpenApi":true},{"title":"Grant Character To User","description":"Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GrantCharacterToUser","href":"/api-reference/characters/grant-character-to-user","autogeneratedByOpenApi":true},{"title":"Update Character Statistics","description":"Updates the values of the specified title-specific statistics for the specific character\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| InvalidCharacterStatistics | 1138 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateCharacterStatistics","href":"/api-reference/characters/update-character-statistics","autogeneratedByOpenApi":true}]},{"group":"Player Data Management","pages":[{"title":"Delete Player Custom Properties","description":"Deletes title-specific custom properties for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/DeletePlayerCustomProperties","href":"/api-reference/player-data-management/delete-player-custom-properties","autogeneratedByOpenApi":true},{"title":"Get Friend Leaderboard","description":"Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ExpiredXboxLiveToken | 1189 |\n| FacebookAPIError | 1143 |\n| InvalidXboxLiveToken | 1188 |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n| XboxInaccessible | 1339 |\n| XboxServiceTooManyRequests | 1505 |\n| XboxXASSExchangeFailure | 1306 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetFriendLeaderboard","href":"/api-reference/player-data-management/get-friend-leaderboard","autogeneratedByOpenApi":true},{"title":"Get Leaderboard","description":"Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetLeaderboard","href":"/api-reference/player-data-management/get-leaderboard","autogeneratedByOpenApi":true},{"title":"Get Leaderboard Around User","description":"Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| LeaderboardVersionNotAvailable | 1277 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetLeaderboardAroundUser","href":"/api-reference/player-data-management/get-leaderboard-around-user","autogeneratedByOpenApi":true},{"title":"Get Player Combined Info","description":"Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerCombinedInfo","href":"/api-reference/player-data-management/get-player-combined-info","autogeneratedByOpenApi":true},{"title":"Get Player Custom Property","description":"Retrieves a title-specific custom property value for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesPropertyDoesNotExist | 19007 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerCustomProperty","href":"/api-reference/player-data-management/get-player-custom-property","autogeneratedByOpenApi":true},{"title":"Get Player Statistics","description":"Retrieves the current version and values for the indicated statistics, for the local player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerStatistics","href":"/api-reference/player-data-management/get-player-statistics","autogeneratedByOpenApi":true},{"title":"Get Player Statistic Versions","description":"Retrieves the information on the available versions of the specified statistic.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n| StatisticNotFound | 1195 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPlayerStatisticVersions","href":"/api-reference/player-data-management/get-player-statistic-versions","autogeneratedByOpenApi":true},{"title":"Get User Data","description":"Retrieves the title-specific custom data for the user which is readable and writable by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserData","href":"/api-reference/player-data-management/get-user-data","autogeneratedByOpenApi":true},{"title":"Get User Internal Data","description":"Retrieves the title-specific custom data for the user which cannot be accessed by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserInternalData","href":"/api-reference/player-data-management/get-user-internal-data","autogeneratedByOpenApi":true},{"title":"Get User Publisher Data","description":"Retrieves the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserPublisherData","href":"/api-reference/player-data-management/get-user-publisher-data","autogeneratedByOpenApi":true},{"title":"Get User Publisher Internal Data","description":"Retrieves the publisher-specific custom data for the user which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserPublisherInternalData","href":"/api-reference/player-data-management/get-user-publisher-internal-data","autogeneratedByOpenApi":true},{"title":"Get User Publisher Read Only Data","description":"Retrieves the publisher-specific custom data for the user which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserPublisherReadOnlyData","href":"/api-reference/player-data-management/get-user-publisher-read-only-data","autogeneratedByOpenApi":true},{"title":"Get User Read Only Data","description":"Retrieves the title-specific custom data for the user which can only be read by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetUserReadOnlyData","href":"/api-reference/player-data-management/get-user-read-only-data","autogeneratedByOpenApi":true},{"title":"List Player Custom Properties","description":"Retrieves title-specific custom property values for a player.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ListPlayerCustomProperties","href":"/api-reference/player-data-management/list-player-custom-properties","autogeneratedByOpenApi":true},{"title":"Update Player Custom Properties","description":"Updates the title-specific custom property values for a player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PlayerCustomPropertiesDuplicatePropertyName | 19006 |\n| PlayerCustomPropertiesPropertyCountTooHigh | 19005 |\n| PlayerCustomPropertiesPropertyNameIsInvalid | 19001 |\n| PlayerCustomPropertiesPropertyNameTooLong | 19000 |\n| PlayerCustomPropertiesStringPropertyValueTooLong | 19002 |\n| PlayerCustomPropertiesValueIsInvalidType | 19003 |\n| PlayerCustomPropertiesVersionMismatch | 19004 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdatePlayerCustomProperties","href":"/api-reference/player-data-management/update-player-custom-properties","autogeneratedByOpenApi":true},{"title":"Update Player Statistics","description":"Updates the values of the specified title-specific statistics for the user\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DuplicateStatisticName | 1253 |\n| ProductDisabledForTitle | 1609 |\n| StatisticCountLimitExceeded | 1203 |\n| StatisticNameConflict | 1196 |\n| StatisticNotFound | 1195 |\n| StatisticValueAggregationOverflow | 1308 |\n| StatisticVersionClosedForWrites | 1197 |\n| StatisticVersionInvalid | 1198 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdatePlayerStatistics","href":"/api-reference/player-data-management/update-player-statistics","autogeneratedByOpenApi":true},{"title":"Update User Data","description":"Updates the title-specific custom data for the user which is readable and writable by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserData","href":"/api-reference/player-data-management/update-user-data","autogeneratedByOpenApi":true},{"title":"Update User Internal Data","description":"Updates the title-specific custom data for the user which cannot be accessed by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserInternalData","href":"/api-reference/player-data-management/update-user-internal-data","autogeneratedByOpenApi":true},{"title":"Update User Publisher Data","description":"Updates the publisher-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserPublisherData","href":"/api-reference/player-data-management/update-user-publisher-data","autogeneratedByOpenApi":true},{"title":"Update User Publisher Internal Data","description":"Updates the publisher-specific custom data for the user which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserPublisherInternalData","href":"/api-reference/player-data-management/update-user-publisher-internal-data","autogeneratedByOpenApi":true},{"title":"Update User Publisher Read Only Data","description":"Updates the publisher-specific custom data for the user which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserPublisherReadOnlyData","href":"/api-reference/player-data-management/update-user-publisher-read-only-data","autogeneratedByOpenApi":true},{"title":"Update User Read Only Data","description":"Updates the title-specific custom data for the user which can only be read by the client","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateUserReadOnlyData","href":"/api-reference/player-data-management/update-user-read-only-data","autogeneratedByOpenApi":true}]},{"group":"Server-Side Cloud Script","pages":[{"title":"Execute Cloud Script","description":"Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The PlayFab ID is the entity ID of the player's master_player_account entity.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CloudScriptAPIRequestCountExceeded | 1209 |\n| CloudScriptAPIRequestError | 1210 |\n| CloudScriptFunctionArgumentSizeExceeded | 1208 |\n| CloudScriptHTTPRequestError | 1211 |\n| CloudScriptNotFound | 1136 |\n| JavascriptException | 1099 |\n| ProductDisabledForTitle | 1609 |\n| TitleDeleted | 1347 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/ExecuteCloudScript","href":"/api-reference/server-side-cloud-script/execute-cloud-script","autogeneratedByOpenApi":true}]},{"group":"Title-Wide Data Management","pages":[{"title":"Get Catalog Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCatalogItems","href":"/api-reference/title-wide-data-management/get-catalog-items","autogeneratedByOpenApi":true},{"title":"Get Publisher Data","description":"Retrieves the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetPublisherData","href":"/api-reference/title-wide-data-management/get-publisher-data","autogeneratedByOpenApi":true},{"title":"Get Store Items","description":"_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified player\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CatalogNotConfigured | 1218 |\n| ProductDisabledForTitle | 1609 |\n| StoreNotFound | 1221 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetStoreItems","href":"/api-reference/title-wide-data-management/get-store-items","autogeneratedByOpenApi":true},{"title":"Get Time","description":"Retrieves the current server time\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetTime","href":"/api-reference/title-wide-data-management/get-time","autogeneratedByOpenApi":true},{"title":"Get Title Data","description":"Retrieves the key-value store of custom title settings","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetTitleData","href":"/api-reference/title-wide-data-management/get-title-data","autogeneratedByOpenApi":true},{"title":"Get Title Internal Data","description":"Retrieves the key-value store of custom internal title settings","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetTitleInternalData","href":"/api-reference/title-wide-data-management/get-title-internal-data","autogeneratedByOpenApi":true},{"title":"Get Title News","description":"Retrieves the title news feed, as configured in the developer portal","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetTitleNews","href":"/api-reference/title-wide-data-management/get-title-news","autogeneratedByOpenApi":true},{"title":"Set Publisher Data","description":"Updates the key-value store of custom publisher settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| PublisherNotSet | 1122 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetPublisherData","href":"/api-reference/title-wide-data-management/set-publisher-data","autogeneratedByOpenApi":true},{"title":"Set Title Data","description":"Updates the key-value store of custom title settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| TooManyKeys | 1147 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetTitleData","href":"/api-reference/title-wide-data-management/set-title-data","autogeneratedByOpenApi":true},{"title":"Set Title Internal Data","description":"Updates the key-value store of custom title settings\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| DataLengthExceeded | 1146 |\n| TooManyKeys | 1147 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/SetTitleInternalData","href":"/api-reference/title-wide-data-management/set-title-internal-data","autogeneratedByOpenApi":true}]},{"group":"Character Data","pages":[{"title":"Get Character Data","description":"Retrieves the title-specific custom data for the user which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterData","href":"/api-reference/character-data/get-character-data","autogeneratedByOpenApi":true},{"title":"Get Character Internal Data","description":"Retrieves the title-specific custom data for the user's character which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterInternalData","href":"/api-reference/character-data/get-character-internal-data","autogeneratedByOpenApi":true},{"title":"Get Character Read Only Data","description":"Retrieves the title-specific custom data for the user's character which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetCharacterReadOnlyData","href":"/api-reference/character-data/get-character-read-only-data","autogeneratedByOpenApi":true},{"title":"Update Character Data","description":"Updates the title-specific custom data for the user's character which is readable and writable by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateCharacterData","href":"/api-reference/character-data/update-character-data","autogeneratedByOpenApi":true},{"title":"Update Character Internal Data","description":"Updates the title-specific custom data for the user's character which cannot be accessed by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateCharacterInternalData","href":"/api-reference/character-data/update-character-internal-data","autogeneratedByOpenApi":true},{"title":"Update Character Read Only Data","description":"Updates the title-specific custom data for the user's character which can only be read by the client\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/UpdateCharacterReadOnlyData","href":"/api-reference/character-data/update-character-read-only-data","autogeneratedByOpenApi":true}]},{"group":"Content","pages":[{"title":"Get Content Download Url","description":"This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/GetContentDownloadUrl","href":"/api-reference/content/get-content-download-url","autogeneratedByOpenApi":true}]},{"group":"Analytics","pages":[{"title":"Write Character Event","description":"Writes a character-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| CharacterNotFound | 1135 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/WriteCharacterEvent","href":"/api-reference/analytics/write-character-event","autogeneratedByOpenApi":true},{"title":"Write Player Event","description":"Writes a player-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEventField | 1216 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n| UserisNotValid | 1030 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/WritePlayerEvent","href":"/api-reference/analytics/write-player-event","autogeneratedByOpenApi":true},{"title":"Write Title Event","description":"Writes a title-based event into PlayStream.\n\n## Error codes\n\nThis operation may return the following PlayFab errors:\n\n| Error | Code |\n| --- | --- |\n| InvalidEventField | 1216 |\n| NoWritePermissionsForEvent | 1207 |\n| ProductDisabledForTitle | 1609 |\n","deprecated":null,"version":null,"openapi":"/services/playfab/api-references/rest/server/server.openapi.json post /Server/WriteTitleEvent","href":"/api-reference/analytics/write-title-event","autogeneratedByOpenApi":true}]}]}]}]},{"tab":"Microsoft Store APIs","groups":[{"group":"Microsoft Store APIs","pages":[{"title":"Microsoft Store service APIs","description":"Reference articles for the Microsoft Store service-to-service APIs used by game services, covering purchases, entitlements, subscriptions, and clawback.","sidebarTitle":"Microsoft Store service APIs","icon":"store","href":"/reference/microsoft-store-apis/xstore-nav"},{"title":"purchase.mp.microsoft.com/v8.0/b2b/orders/query","description":"Deprecated Microsoft Store v8 orders/query API that lets a game service look up a user's consumable purchases from the last 90 days, including ShortOrderID.","sidebarTitle":"Purchase.mp.microsoft.com/v8.0/b2b/order","icon":"rotate-left","href":"/reference/microsoft-store-apis/xstore-v8-clawbackv1"},{"title":"purchase.mp.microsoft.com/v8.0/b2b/clawback/sastoken","description":"Microsoft Store v8 clawback SAS token endpoint that generates an Azure Storage SAS token for reading your game service's Clawback event message queue.","sidebarTitle":"Purchase.mp.microsoft.com/v8.0/b2b/clawb","icon":"right-to-bracket","href":"/reference/microsoft-store-apis/xstore-v8-clawbackv2-sastoken"},{"title":"collections.mp.microsoft.com/v8.0/collections/consume","description":"Microsoft Store v8 Collections consume API to report store-managed and developer-managed consumables as used from a user's balance in game services.","sidebarTitle":"Collections.mp.microsoft.com/v8.0/collec","icon":"store","href":"/reference/microsoft-store-apis/xstore-v8-consume"},{"title":"purchase.mp.microsoft.com/v8.0/purchases/grant","description":"Microsoft Store v8 purchases/grant API that lets a game service grant a free app or add-on directly to a user's account using Microsoft Entra ID auth.","sidebarTitle":"Purchase.mp.microsoft.com/v8.0/purchases","icon":"store","href":"/reference/microsoft-store-apis/xstore-v8-grant"},{"title":"Microsoft Store v8 Collections b2bLicensePreview API","description":"Microsoft Store v8 Collections b2bLicensePreview API for game services to query a user's owned products, entitlements, and consumables by product SKU ID.","sidebarTitle":"Collections.mp.microsoft.com/v8.0/collec","icon":"tags","href":"/reference/microsoft-store-apis/xstore-v8-query-for-products"},{"title":"Microsoft Store v8 subscription recurrence change API","description":"Microsoft Store v8 recurrences change endpoint that lets a game service cancel, extend, or refund a user's subscription recurrence by recurrence ID.","sidebarTitle":"Purchase.mp.microsoft.com/v8.0/b2b/recur","icon":"arrows-rotate","href":"/reference/microsoft-store-apis/xstore-v8-recurrence-change"},{"title":"purchase.mp.microsoft.com/v8.0/b2b/recurrences/query","description":"Microsoft Store v8 recurrences/query endpoint that returns subscription status for a user, including grace-period details after a failed auto-renew.","sidebarTitle":"Purchase.mp.microsoft.com/v8.0/b2b/recur","icon":"store","href":"/reference/microsoft-store-apis/xstore-v8-recurrence-query"},{"title":"collections.mp.microsoft.com/v9.0/collections/publisherQuery","description":"Microsoft Store v9 Collections publisherQuery API that lets game services query a user's products, entitlements, and XBOX Game Pass subscription status.","sidebarTitle":"Collections.mp.microsoft.com/v9.0/collec","icon":"rocket","href":"/reference/microsoft-store-apis/xstore-v9-query-for-products"}]}]},{"tab":"NDA Topics","groups":[{"group":"NDA Overview","pages":[{"title":"NDA topics index for XBOX GDK console development","description":"Index of NDA-protected XBOX GDK console development topics collected in one tab for authors and NDA-cleared readers to reach through the GDKX portal.","href":"/nda/nda-overview"},{"title":"NDA topic directory - live Microsoft Learn links","description":"Directory of NDA-protected XBOX GDK console development pages, each linking to its live Microsoft Learn article during the platform transition.","href":"/nda/nda-topic-directory"}]}]}]},{"language":"es","pages":[{"title":"es","href":"/es"}]},{"language":"fr-CA","pages":[{"title":"fr-CA","href":"/fr-CA"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr"}]},{"language":"ja-jp","pages":[{"title":"ja-jp","href":"/ja-jp"}]},{"language":"ko","pages":[{"title":"ko","href":"/ko"}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-BR"}]},{"language":"zh-CN","pages":[{"title":"zh-CN","href":"/zh-CN"}]},{"language":"zh-TW","pages":[{"title":"zh-TW","href":"/zh-TW"}]}]},"title":"Property (JSON) - XBOX Game Development Documentation","buildId":"dpl_33ETnXRdsYLr97cjMPs66KyshzXB","deploymentId":"dpl_33ETnXRdsYLr97cjMPs66KyshzXB","dynamics":[],"chunks":[]}
