👨‍💻
MYTY
MYTY SDK
MYTY SDK
  • MYTY SDK
  • How to use MYTY SDK?
    • Create Unity Project
    • Import MYTY Kit
    • Import MYTY SDK
    • Build MYTY SDK
    • Create Scene
  • MYTY SDK Interface
    • Load Avatar
    • Select Avatar
    • Choose View Mode
    • Control Avatar (Mediapipe)
    • Control Avatar (ARKit)
  • For Web Application
    • Interacting with browser scripting
    • Integrate with React Project
  • React Example
    • Handle WebGL view & interaction
    • Choose Video Device for input
    • Handle Mediapipe Holistic
    • Capture & Record
  • For iOS Application
    • Interact with native iOS application
    • Integrate with Flutter Project
    • Trouble Shooting (Flutter Integration)
  • Flutter Example
    • Handle UnityWidget & interaction
    • Use ARKit Plugin
  • Avatar Registry(API)
    • Overview
    • Getting Started
    • Auth & Rate Limit
    • Legacy - v0
  • Resources
    • License Agreement
    • Version Note (SDK vs Kit)
    • Display Logo
Powered by GitBook
On this page
  • Background
  • Input parameters
  • AvatarCollectionId
  • MetadataAssetUri
  • TokenId
  • TokenAssetUri
  • Example Usage
  1. MYTY SDK Interface

Load Avatar

Describe how to send message to Unity to load MYTY Avatar

PreviousMYTY SDK InterfaceNextSelect Avatar

Last updated 2 years ago

Background

To load avatar in MYTY Kit v1.2 or higher, we should provide two files. 1) shared metadata for collection, 2) the description and image trait file for each token ID. To get these information, you can refer to our Avatar Registry.

Input parameters

AvatarCollectionId

ID of AvatarCollection from Avatar Registry. When loading avatars with different token IDs, but with same AvatarCollectionId , shared metadata will be used.

MetadataAssetUri

This parameter refers to the URI for collection metadata. This is available in Avatar Registry.

TokenId

TokenId is required to identify which NFT is mapped to MYTY Avatar. The pair of AvatarCollectionId and TokenId allow users to specify MYTY Avatar.

TokenAssetUri

This parameter refers to the URI for token description and image trait(zipped). This is available in Avatar Registry.

Example Usage

function loadAvatar(avatarCollectionId: number, metadataAssetUri: string, tokenId: string, tokenAssetUri: string)
{
  sendMessage("MessageHandler", "LoadAvatar", JSON.stringify({
    avatarCollectionId: avatarCollectionId,
    metadataAssetUri: metadataAssetUri,
    tokenId: tokenId,
    tokenAssetUri: tokenAssetUri
  }))
}
Avatar Registry(API)