Skip to main content

Inworld Studio

InworldStudio is a data processing class for communicating with the GRPC server. Its response data would be stored in InworldUserSettings.

API

FunctionReturn TypeDescriptionParameters
InworldStudioInworldStudioConstructorowner: The StudioDataHandler Interface: In Editor, it is InworldEditorStudio. In Runtime, it is RuntimeInworldStudio.
GetUserTokenSystem.Threading.Tasks.TaskGets 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.
ListWorkspaceSystem.Threading.Tasks.TaskLists the workspaces. If returned, the handler for the studio will invoke CreateWorkspaces. Otherwise, the handler will invoke OnStudioError.N/A
ListScenesSystem.Threading.Tasks.TaskLists the scenes. If returned, the handler of Inworld Studio will invoke CreateScenes. Otherwise, the handler will invoke OnStudioError.workspace: list InworldScenes in InworldWorkspaceData
ListCharactersSystem.Threading.Tasks.TaskLists the characters. If returned, the handler of the studio will invoke CreateCharacters. Otherwise, the handler will invoke OnStudioError.workspace: lists the characters in InworldWorkspaceData
ListSharedCharactersSystem.Threading.Tasks.TaskLists 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
ListAPIKeySystem.Threading.Tasks.TaskLists 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