The top level object for the Hyperbeam API. This is responsible for calling into the Hyperbeam JSLib and controlling the browser.
It is not recommended to instantiate this directly, instead it is preferable to call HyperbeamController.StartHyperbeamStream and then access these methods using it’s Instance property.
Properties
float
Sets the stream’s volume in a range of [0, 1]
Methods
GetHyperbeamTexture
IEnumerator GetHyperbeamTexture(Action<Texture2D> callback)A coroutine to be invoked by MonoBehaviour.StartCoroutine it will check once
every frame for a texture to be available. When one is found, or if one already exists, calls callbackMethod Params
Action<Texture2D>
A callback to be invoked that takes a Texture2D parameter
GetTexttureWidth
int GetTextureWidth()Gets the virtual browser’s width in pixels.
GetTextureHeight
int GetTextureHeight()Gets the virtual browser’s height in pixels.
SendKeyDown
void SendKeyDown(char Key, bool Ctrl, bool Meta)Sends a keydown event to the virtual browser.Method Params
char
The Key to send this event for.
bool
Whether or not ctrl should be sent with the key.
bool
Whether or not alt should be sent with the key.
SendKeyUp
void SendKeyUp(char Key, bool Ctrl, bool Meta)Sends a keyup event to the virtual browser.Method Params
char
The Key to send this event for.
bool
Whether or not ctrl should be sent with the key.
bool
Whether or not alt should be sent with the key.
SendMouseDown
void SendMouseDown(float X, float Y, PointerEventData.InputButton button)Sends a mousedown event to the virtual browser.Method Params
float
The X coordinate in the range [0, 1] where 0 is the left edge.
float
The Y coordinate in the range [0, 1] where 0 is the top edge.
PointerEventData.InputButton
Which mouse button to send the event for.
SendMouseUp
void SendMouseUp(float X, float Y, PointerEventData.InputButton button)Sends a mouseup event to the virtual browser.Method Params
float
The X coordinate in the range [0, 1] where 0 is the left edge.
float
The Y coordinate in the range [0, 1] where 0 is the top edge.
PointerEventData.InputButton
Which mouse button to send the event for.
SendMouseMove
void SendMouseMove(float X, float Y)Sends a mousemove event to the virtual browser.Method Params
float
The X coordinate in the range [0, 1] where 0 is the left edge.
float
The Y coordinate in the range [0, 1] where 0 is the top edge.
SendWheel
void SendWheel(float DeltaY)Sends a mouse wheel event to the virtual browser.Method Params
float
The scroll wheel’s delta
SetVideoPause
void SetVideoPause(bool pause)Pauses or unpauses the video stream. While the video stream is paused it is not sending any data, saving on CPU and Bandwidth.
Prefer to use HyperbeamController.Paused where you can as it can be queried easier.Method Params
bool
Whether to pause or unpause the video stream.
GiveHyperbeamControl
void GiveHyperbeamControl(string closeKey, bool ctrl, bool meta, bool alt, bool shift)This will inform hyperbeam it has ‘control’ of the browser and make it register event listeners for keypresses.
Prefer to use HyperbeamController.PassControlToBrowser
because it first tells unity to stop listening and will avoid registering multiple listeners.Method Parameters
string
The Keydown that will trigger unity regaining control
bool
Whether or not the ctrl key must be held down to regain control
bool
Whether or not the meta key must be held down to regain control
bool
Whether or not the alt key must be held down to regain control
bool
Whether or not the shift key must be held down to regain control
TakeBackControl
void TakeBackControl()Forcibly takes control back from the browser and unregisters any event listeners that may have been registered by Hyperbeam.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Hyperbeam","colors":{"primary":"#a888ff","light":"#c4b5fd","dark":"#7c3aed"},"favicon":"https://mintcdn.com/hyperbeam/a_-YqggCLYinqc0g/favicon.png?fit=max\u0026auto=format\u0026n=a_-YqggCLYinqc0g\u0026q=85\u0026s=d1f84bca91f42b29a636cac9700a80e7","logo":"https://mintcdn.com/hyperbeam/a_-YqggCLYinqc0g/logo.svg?fit=max\u0026auto=format\u0026n=a_-YqggCLYinqc0g\u0026q=85\u0026s=bb70cd791725d043c35e578fbcc5d2e8","navbar":{"links":[{"label":"Community","href":"https://discord.gg/D78RsGfQjq"}],"primary":{"type":"button","label":"Use Hyperbeam","href":"https://hyperbeam.com/dashboard"}},"footer":{"socials":{"github":"https://github.com/hyperbeam","website":"https://hyperbeam.dev","discord":"https://discord.gg/D78RsGfQjq"}},"integrations":{"amplitude":{"apiKey":"e46b9bf5b5d19f5fd43d1a2b8630aba5"},"ga4":{"measurementId":"G-LFMF4P54KV"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperbeam","hasAudioNarration":false,"actualSubdomain":"hyperbeam","customDomains":["docs.hyperbeam.com"],"gitSource":{"type":"github","owner":"hyperbeam","repo":"docs","deployBranch":"master","contentDirectory":"docs","mountPath":"","label":""},"feedback":{"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6acfda85d5256df464a472e8","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"Documentation","count":32},{"language":"default","tag":"REST API","count":14},{"language":"default","tag":"Dispatch API","count":8},{"language":"default","tag":"Client SDKs","count":7},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Session API","count":6},{"language":"default","tag":"Home","count":5},{"language":"default","tag":"Unity SDKs","count":4},{"language":"default","tag":"JavaScript SDK","count":3},{"language":"default","tag":"WebGL SDK","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"client-sdk/unity/webgl/hyperbeam","slug":"/client-sdk/unity/webgl/hyperbeam","pageMetadata":{"title":"Hyperbeam.cs","description":null,"href":"/client-sdk/unity/webgl/hyperbeam"},"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`,hr:`hr`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,ParamField}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The top level object for the Hyperbeam API. This is responsible for calling into the Hyperbeam JSLib and controlling the browser.\nIt is not recommended to instantiate this directly, instead it is preferable to call `,_jsx(_components.a,{href:`/client-sdk/unity/webgl/hyperbeam-controller#starthyperbeamstream`,children:`HyperbeamController.StartHyperbeamStream`}),` and then access these methods using it’s Instance property.`]}),`\n`,_jsx(Heading,{level:`2`,id:`properties`,children:`Properties`}),`\n`,_jsx(ParamField,{body:`Volume`,type:`float`,id:`param-volume`,children:_jsx(_components.p,{children:`Sets the stream’s volume in a range of [0, 1]`})}),`\n`,_jsx(Heading,{level:`2`,id:`methods`,children:`Methods`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`gethyperbeamtexture`,children:_jsx(Heading,{hidden:true,children:`GetHyperbeamTexture`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`IEnumerator GetHyperbeamTexture(Action\u003cTexture2D> callback)`})}),`\n`,_jsxs(_components.p,{children:[`A coroutine to be invoked by `,_jsx(_components.code,{children:`MonoBehaviour.StartCoroutine`}),` it will check once\nevery frame for a texture to be available. When one is found, or if one already exists, calls `,_jsx(_components.code,{children:`callback`})]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Method Params`})}),`\n`,_jsx(ParamField,{body:`callback`,type:`Action\u003cTexture2D>`,id:`param-callback`,children:`A callback to be invoked that takes a Texture2D parameter`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`gettextturewidth`,children:_jsx(Heading,{hidden:true,children:`GetTexttureWidth`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`int GetTextureWidth()`})}),`\n`,_jsx(_components.p,{children:`Gets the virtual browser’s width in pixels.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`gettextureheight`,children:_jsx(Heading,{hidden:true,children:`GetTextureHeight`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`int GetTextureHeight()`})}),`\n`,_jsx(_components.p,{children:`Gets the virtual browser’s height in pixels.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`sendkeydown`,children:_jsx(Heading,{hidden:true,children:`SendKeyDown`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`void SendKeyDown(char Key, bool Ctrl, bool Meta)`})}),`\n`,_jsx(_components.p,{children:`Sends a keydown event to the virtual browser.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Method Params`})}),`\n`,_jsx(ParamField,{body:`Key`,type:`char`,id:`param-key`,children:`The Key to send this event for.`}),`\n`,_jsx(ParamField,{body:`Ctrl`,type:`bool`,id:`param-ctrl`,children:`Whether or not ctrl should be sent with the key.`}),`\n`,_jsx(ParamField,{body:`Alt`,type:`bool`,id:`param-alt`,children:`Whether or not alt should be sent with the key.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`sendkeyup`,children:_jsx(Heading,{hidden:true,children:`SendKeyUp`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`void SendKeyUp(char Key, bool Ctrl, bool Meta)`})}),`\n`,_jsx(_components.p,{children:`Sends a keyup event to the virtual browser.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Method Params`})}),`\n`,_jsx(ParamField,{body:`Key`,type:`char`,id:`param-key-1`,children:`The Key to send this event for.`}),`\n`,_jsx(ParamField,{body:`Ctrl`,type:`bool`,id:`param-ctrl-1`,children:`Whether or not ctrl should be sent with the key.`}),`\n`,_jsx(ParamField,{body:`Alt`,type:`bool`,id:`param-alt-1`,children:`Whether or not alt should be sent with the key.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`sendmousedown`,children:_jsx(Heading,{hidden:true,children:`SendMouseDown`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`void SendMouseDown(float X, float Y, PointerEventData.InputButton button)`})}),`\n`,_jsx(_components.p,{children:`Sends a mousedown event to the virtual browser.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Method Params`})}),`\n`,_jsx(ParamField,{body:`x`,type:`float`,id:`param-x`,children:`The X coordinate in the range [0, 1] where 0 is the left edge.`}),`\n`,_jsx(ParamField,{body:`y`,type:`float`,id:`param-y`,children:`The Y coordinate in the range [0, 1] where 0 is the top edge.`}),`\n`,_jsx(ParamField,{body:`button`,type:`PointerEventData.InputButton`,id:`param-button`,children:`Which mouse button to send the event for.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`sendmouseup`,children:_jsx(Heading,{hidden:true,children:`SendMouseUp`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`void SendMouseUp(float X, float Y, PointerEventData.InputButton button)`})}),`\n`,_jsx(_components.p,{children:`Sends a mouseup event to the virtual browser.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Method Params`})}),`\n`,_jsx(ParamField,{body:`x`,type:`float`,id:`param-x-1`,children:`The X coordinate in the range [0, 1] where 0 is the left edge.`}),`\n`,_jsx(ParamField,{body:`y`,type:`float`,id:`param-y-1`,children:`The Y coordinate in the range [0, 1] where 0 is the top edge.`}),`\n`,_jsx(ParamField,{body:`button`,type:`PointerEventData.InputButton`,id:`param-button-1`,children:`Which mouse button to send the event for.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`sendmousemove`,children:_jsx(Heading,{hidden:true,children:`SendMouseMove`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`void SendMouseMove(float X, float Y)`})}),`\n`,_jsx(_components.p,{children:`Sends a mousemove event to the virtual browser.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Method Params`})}),`\n`,_jsx(ParamField,{body:`x`,type:`float`,id:`param-x-2`,children:`The X coordinate in the range [0, 1] where 0 is the left edge.`}),`\n`,_jsx(ParamField,{body:`y`,type:`float`,id:`param-y-2`,children:`The Y coordinate in the range [0, 1] where 0 is the top edge.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`sendwheel`,children:_jsx(Heading,{hidden:true,children:`SendWheel`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`void SendWheel(float DeltaY)`})}),`\n`,_jsx(_components.p,{children:`Sends a mouse wheel event to the virtual browser.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Method Params`})}),`\n`,_jsx(ParamField,{body:`DeltaY`,type:`float`,id:`param-delta-y`,children:`The scroll wheel’s delta`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`setvideopause`,children:_jsx(Heading,{hidden:true,children:`SetVideoPause`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`void SetVideoPause(bool pause)`})}),`\n`,_jsxs(_components.p,{children:[`Pauses or unpauses the video stream. While the video stream is paused it is not sending any data, saving on CPU and Bandwidth.\nPrefer to use `,_jsx(_components.a,{href:`/client-sdk/unity/webgl/hyperbeam-controller#properties`,children:`HyperbeamController.Paused`}),` where you can as it can be queried easier.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Method Params`})}),`\n`,_jsx(ParamField,{body:`pause`,type:`bool`,id:`param-pause`,children:`Whether to pause or unpause the video stream.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`givehyperbeamcontrol`,children:_jsx(Heading,{hidden:true,children:`GiveHyperbeamControl`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`void GiveHyperbeamControl(string closeKey, bool ctrl, bool meta, bool alt, bool shift)`})}),`\n`,_jsxs(_components.p,{children:[`This will inform hyperbeam it has ‘control’ of the browser and make it register event listeners for keypresses.\nPrefer to use `,_jsx(_components.a,{href:`/client-sdk/unity/webgl/hyperbeam-controller#passcontroltobrowser`,children:`HyperbeamController.PassControlToBrowser`}),`\nbecause it first tells unity to stop listening and will avoid registering multiple listeners.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Method Parameters`})}),`\n`,_jsx(ParamField,{body:`closeKey`,type:`string`,id:`param-close-key`,children:`The Keydown that will trigger unity regaining control`}),`\n`,_jsx(ParamField,{body:`ctrl`,type:`bool`,id:`param-ctrl-2`,children:`Whether or not the ctrl key must be held down to regain control`}),`\n`,_jsx(ParamField,{body:`meta`,type:`bool`,id:`param-meta`,children:`Whether or not the meta key must be held down to regain control`}),`\n`,_jsx(ParamField,{body:`alt`,type:`bool`,id:`param-alt-2`,children:`Whether or not the alt key must be held down to regain control`}),`\n`,_jsx(ParamField,{body:`shift`,type:`bool`,id:`param-shift`,children:`Whether or not the shift key must be held down to regain control`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`takebackcontrol`,children:_jsx(Heading,{hidden:true,children:`TakeBackControl`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`void TakeBackControl()`})}),`\n`,_jsx(_components.p,{children:`Forcibly takes control back from the browser and unregisters any event listeners that may have been registered by Hyperbeam.`}),`\n`,_jsx(_components.hr,{})]})}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":"Hyperbeam.cs","description":null,"href":"/client-sdk/unity/webgl/hyperbeam"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Properties","slug":"properties","depth":2,"children":[]},{"title":"Methods","slug":"methods","depth":2,"children":[{"title":"GetHyperbeamTexture","slug":"gethyperbeamtexture","depth":3,"children":[]},{"title":"GetTexttureWidth","slug":"gettextturewidth","depth":3,"children":[]},{"title":"GetTextureHeight","slug":"gettextureheight","depth":3,"children":[]},{"title":"SendKeyDown","slug":"sendkeydown","depth":3,"children":[]},{"title":"SendKeyUp","slug":"sendkeyup","depth":3,"children":[]},{"title":"SendMouseDown","slug":"sendmousedown","depth":3,"children":[]},{"title":"SendMouseUp","slug":"sendmouseup","depth":3,"children":[]},{"title":"SendMouseMove","slug":"sendmousemove","depth":3,"children":[]},{"title":"SendWheel","slug":"sendwheel","depth":3,"children":[]},{"title":"SetVideoPause","slug":"setvideopause","depth":3,"children":[]},{"title":"GiveHyperbeamControl","slug":"givehyperbeamcontrol","depth":3,"children":[]},{"title":"TakeBackControl","slug":"takebackcontrol","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"hyperbeam","siteName":"Hyperbeam","title":"Hyperbeam.cs - Hyperbeam","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-02T07:06:54.410Z","originalFileLocation":"client-sdk/unity/webgl/hyperbeam.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperbeam\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Hyperbeam.cs - Hyperbeam\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperbeam\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hyperbeam.mintlify.site/_mintlify/api/og/v2?division=WebGL+SDK\u0026amp;title=Hyperbeam.cs\u0026amp;theme=67ff4b0b4936b6c8e30a52ae\u0026amp;signature=bc78149943cc078fe3e01b5ce3b83a2d8d576abd5b8b446a4de27ee1add58ac3\">\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=\"Hyperbeam.cs - Hyperbeam\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hyperbeam.mintlify.site/_mintlify/api/og/v2?division=WebGL+SDK\u0026amp;title=Hyperbeam.cs\u0026amp;theme=67ff4b0b4936b6c8e30a52ae\u0026amp;signature=bc78149943cc078fe3e01b5ce3b83a2d8d576abd5b8b446a4de27ee1add58ac3\">\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=\"/mintlify-assets/_mintlify/favicons/hyperbeam/befxcaaaMvq2vDLO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperbeam\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#a888ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/client-sdk/unity/webgl/hyperbeam.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hyperbeam.com/#organization\",\"name\":\"Hyperbeam\",\"url\":\"https://docs.hyperbeam.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hyperbeam/a_-YqggCLYinqc0g/logo.svg?fit=max\u0026auto=format\u0026n=a_-YqggCLYinqc0g\u0026q=85\u0026s=bb70cd791725d043c35e578fbcc5d2e8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hyperbeam.com#website\",\"name\":\"Hyperbeam\",\"url\":\"https://docs.hyperbeam.com\",\"publisher\":{\"@id\":\"https://docs.hyperbeam.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam#webpage\",\"url\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam\",\"name\":\"Hyperbeam.cs\",\"dateModified\":\"2026-01-02T07:06:54.410Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperbeam.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Client SDKs\",\"item\":\"https://docs.hyperbeam.com/client-sdk/javascript/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Unity SDKs\",\"item\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"WebGL SDK\",\"item\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/overview\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Hyperbeam.cs\",\"item\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam#article\",\"headline\":\"Hyperbeam.cs\",\"name\":\"Hyperbeam.cs\",\"url\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperbeam.com/client-sdk/unity/webgl/hyperbeam#webpage\"},\"dateModified\":\"2026-01-02T07:06:54.410Z\",\"publisher\":{\"@id\":\"https://docs.hyperbeam.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hyperbeam.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperbeam\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperbeam\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/client-sdk/unity/webgl/hyperbeam.md","siteName":"Hyperbeam","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Home","pages":[{"title":"Introduction","href":"/home/introduction"},{"title":"Features","href":"/home/features"},{"title":"Examples","href":"/home/examples"},{"title":"Getting Started","href":"/home/getting-started"},{"title":"FAQ","href":"/home/faq"}]},{"group":"Guides","pages":[{"title":"Timeouts","href":"/guides/timeouts"},{"title":"Persist Session State","href":"/guides/persist-session-state"},{"title":"Authenticating Participants","href":"/guides/authenticating-participants"},{"title":"Install Custom Chrome Extension","href":"/guides/install-chrome-extension"},{"title":"Resize Browser Window","href":"/guides/resize-browser-window"},{"title":"Roles","href":"/guides/roles"}]},{"group":"REST API","pages":[{"group":"Dispatch API","pages":[{"title":"Dispatch Endpoints","href":"/rest-api/dispatch/dispatch-overview"},{"title":"Starting a Chromium Session","api":"POST https://engine.hyperbeam.com/v0/vm","href":"/rest-api/dispatch/start-chromium-session"},{"title":"Starting a Android Emulator","api":"POST https://engine.hyperbeam.com/v0/android","href":"/rest-api/dispatch/start-android-emulator-session"},{"title":"Starting a Console Emulator","api":"POST https://engine.hyperbeam.com/console","href":"/rest-api/dispatch/start-console-emulator-session"},{"title":"Ending a Session","api":"DELETE https://engine.hyperbeam.com/v0/vm/{session_id}","href":"/rest-api/dispatch/ending-session"},{"title":"Get Active Sessions","api":"GET https://engine.hyperbeam.com/v0/vm","href":"/rest-api/dispatch/get-sessions"},{"title":"Get Single Session","api":"GET https://engine.hyperbeam.com/v0/vm/{session_id}","href":"/rest-api/dispatch/get-session"},{"title":"Get Usage","api":"GET https://engine.hyperbeam.com/v0/vm/usage","href":"/rest-api/dispatch/get-usage"}]},{"group":"Session API","pages":[{"title":"Session Endpoints","href":"/rest-api/session/session-overview"},{"title":"Add Roles","api":"POST https://\u003cembed_url>/addRoles","playground":"none","href":"/rest-api/session/add-roles"},{"title":"Remove Roles","api":"POST https://\u003cembed_url>/removeRoles","playground":"none","href":"/rest-api/session/remove-roles"},{"title":"Removing Users","api":"DELETE https://engine.hyperbeam.com/users/{user_id}","href":"/rest-api/session/removing-users"},{"title":"Set Bookmarks","api":"POST https://\u003cembed_url>/bookmarks","playground":"none","href":"/rest-api/session/bookmarks"},{"title":"Set User Permissions","api":"POST https://\u003cembed_url>/setPermissions","playground":"none","deprecated":true,"href":"/rest-api/session/set-user-permission"}]}]},{"group":"Client SDKs","pages":[{"group":"JavaScript SDK","pages":[{"title":"Overview","href":"/client-sdk/javascript/overview"},{"title":"Reference","href":"/client-sdk/javascript/reference"},{"title":"Examples","href":"/client-sdk/javascript/examples"}]},{"group":"Unity SDKs","pages":[{"group":"WebGL SDK","pages":[{"title":"WebGL Overview","href":"/client-sdk/unity/webgl/overview"},{"title":"HyperbeamController.cs","description":null,"href":"/client-sdk/unity/webgl/hyperbeam-controller"},{"title":"Hyperbeam.cs","href":"/client-sdk/unity/webgl/hyperbeam"}]},{"title":"Unity Desktop Application SDK","sidebarTitle":"Unity Desktop","description":null,"href":"/client-sdk/unity/unity-desktop-sdk"}]}]}]},{"anchor":"GitHub","href":"https://github.com/hyperbeam","icon":"github","color":{"light":"#a888ff","dark":"#a888ff"}},{"anchor":"Community","href":"https://discord.gg/D78RsGfQjq","icon":"discord","color":{"light":"#a888ff","dark":"#a888ff"}},{"anchor":"Contact Us","href":"mailto:founders@hyperbeam.com","icon":"envelope","color":{"light":"#a888ff","dark":"#a888ff"}}]},"basePath":"","title":"Hyperbeam.cs - Hyperbeam","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":[],"chunks":[]}