Inworld Studio
InworldStudio is a data processing class for communicating with the GRPC server. Its response data would be stored in InworldUserSettings.
API
Function | Return Type | Description | Parameters |
---|---|---|---|
InworldStudio | InworldStudio | Constructor | owner: The StudioDataHandler Interface: In Editor, it is InworldEditorStudio. In Runtime, it is RuntimeInworldStudio. |
GetUserToken | System.Threading.Tasks.Task | Gets the user token (i.e., studio access token). If returned, data would be overwritten in InworldAI.User. The studio handler would then invoke OnUserTokenCompleted . If failed, the studio handler will invoke OnStudioError . | tokenForExchange: ID Token used to exchange the user token (i.e., studio access token), or {OculusNonce and OculusID} if you are using Oculus. authType: authType, by default this is firebase. |
ListWorkspace | System.Threading.Tasks.Task | Lists the workspaces. If returned, the handler for the studio will invoke CreateWorkspaces . Otherwise, the handler will invoke OnStudioError . | N/A |
ListScenes | System.Threading.Tasks.Task | Lists the scenes. If returned, the handler of Inworld Studio will invoke CreateScenes . Otherwise, the handler will invoke OnStudioError . | workspace: list InworldScenes in InworldWorkspaceData |
ListCharacters | System.Threading.Tasks.Task | Lists the characters. If returned, the handler of the studio will invoke CreateCharacters . Otherwise, the handler will invoke OnStudioError . | workspace: lists the characters in InworldWorkspaceData |
ListSharedCharacters | System.Threading.Tasks.Task | Lists shared characters. This function works in Oculus only. It needs Oculus Nonce and an ID instead of an ID Token to get shared characters. If returned, the handler of the studio will invoke CreateCharacters . Otherwise, the handler will invoke OnStudioError . | sharedWorkspace: the InworldWorkspaceData for list sharing characters. oculusNonce: data obtained from Oculus. oculusID: data obtained from Oculus |
ListAPIKey | System.Threading.Tasks.Task | Lists API Keys. If returned, the handler of the studio will invoke CreateIntegrations , Otherwise, the handler will invoke OnStudioError . | workspaceData: list of API Keys and Secrets in InworldWorkspaceData |