ResoniteLink

https://yellow-dog-man.github.io/ResoniteLink/
Admin
ResoniteLink is an interoperability layer built on top of WebSockets that allows external tools to...
Tokens:63,656
Snippets:612
Trust Score:9.7
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Start()

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkSessionListener.html

Starts the session listener to begin discovering sessions.

```APIDOC
## Start()

### Description
Starts the session listener to begin discovering sessions.

### Method
Start

### Signature
```csharp
public void Start()
```

```

--------------------------------

### Property: Arguments

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Command.html

Gets the arguments associated with the command.

```APIDOC
## Property Arguments

### Description
Gets the arguments for the command.

### Property Value
- **Type**: string
- **Access**: Read-only (getter only)

### Return Example
`string` representing the command arguments.
```

--------------------------------

### addSlot message example

Source: https://yellow-dog-man.github.io/ResoniteLink/docs/websocket/slots.html

Example of the addSlot message to create a new slot. The data field contains the slot definition, including id, parent, name, and position. Omitted parameters are left to defaults.

```json
{
    "$type" : "addSlot",
    "data" : {
        "id" : "MySDK_0",
        "parent" : {
            "$type" : "reference",
            "targetId" : "Root"
        },
        "name" : {
            "$type" : "string",
            "value" : "Hello from MySDK!"
        },
        "position" : {
            "$type" : "float3",
            "value" : {
                "x" : 0,
                "y" : 1.5,
                "z" : 10
            }
        }
    }
}
```

--------------------------------

### Property: CommandType

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Command.html

Gets the type of the command.

```APIDOC
## Property CommandType

### Description
Gets the type of the command.

### Property Value
- **Type**: CommandType
- **Access**: Read-only (getter only)

### Return Example
`CommandType` enumeration value representing the command type.
```

--------------------------------

### updateSlot message example

Source: https://yellow-dog-man.github.io/ResoniteLink/docs/websocket/slots.html

Example of the updateSlot message to update an existing slot. The data field uses the same schema as addSlot, but only includes properties to change. The id field is mandatory to specify which slot to update.

```json
{
    "$type" : "updateSlot",
    "data" : {
        "id" : "MySDK_0",
        "scale" : {
            "$type" : "float3",
            "value" : {
                "x" : 2.5,
                "y" : 2.5,
                "z" : 2.5
            }
        }
    }
}
```

--------------------------------

### getSlot message example

Source: https://yellow-dog-man.github.io/ResoniteLink/docs/websocket/slots.html

Example of the getSlot message to fetch information about the scene hierarchy. The slotId field specifies the slot to fetch, with "Root" as the special root slot ID. includeComponentData controls whether full component data is included, and depth controls how deep to fetch slots.

```json
{
    "$type" : "getSlot",
    "slotId" : "Root",
    "includeComponentData" : false,
    "depth" : 0
}
```

--------------------------------

### Install YellowDogMan.ResoniteLink package

Source: https://yellow-dog-man.github.io/ResoniteLink/docs/started.html

Adds the YellowDogMan.ResoniteLink NuGet package to a .NET project. Run this command in the project directory.

```bash
$ dotnet add package YellowDogMan.ResoniteLink
```

--------------------------------

### REPL_Controller.CurrentComponent Property

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.REPL_Controller.html

Gets the current component associated with the REPL controller.

```APIDOC
## Property: CurrentComponent

### Description
Gets the current component.

### Signature
```csharp
public Component CurrentComponent { get; }
```

### Property Value
- **Component** - The current component.

```

--------------------------------

### BoundingBox.min

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.BoundingBox.html

Gets or sets the minimum corner of the bounding box as a float3.

```APIDOC
## Property: min

### Description
Gets or sets the minimum corner of the bounding box.

### Property Value
- **min** (float3) - The minimum corner of the bounding box.

### Example
```csharp
[JsonPropertyName("min")]
public float3 min { get; set; }
```
```

--------------------------------

### SyncDictionary.KeyType

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.SyncDictionary.html

Gets the type of the key for the dictionary. This property is abstract and must be implemented by derived classes.

```APIDOC
## SyncDictionary.KeyType

### Description
Gets the type of the key for the dictionary.

### Property Value
- **Type** - The type of the key.

### Remarks
This property is abstract and must be implemented by derived classes.
```

--------------------------------

### Constructor: Command(CommandType, string)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Command.html

Initializes a new instance of the Command class with the specified command type and arguments.

```APIDOC
## Constructor Command(CommandType, string)

### Description
Initializes a new instance of the Command class with the specified command type and arguments.

### Method
Constructor

### Signature
`public Command(CommandType commandType, string arguments)`

### Parameters
- **commandType** (CommandType) - The type of the command.
- **arguments** (string) - The arguments associated with the command.

### Remarks
The fields are read-only to ensure immutability after creation.
```

--------------------------------

### MemberDefinition.Type

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.MemberDefinition.html

Gets or sets the full type of the member. It is recommended to use subtypes for more structured information, but the full type is useful for matching members for references.

```APIDOC
## Property: Type

### Description
Gets or sets the full type of the member. It's recommended to use the subtypes as they provide more structured information for various subtypes when possible. The full type is however useful when matching up members for references.

### Property Value
- **TypeReference** - The full type of the member.

### Attributes
- `[JsonPropertyName("type")]`

### Example
```csharp
public TypeReference Type { get; set; }
```
```

--------------------------------

### Connect(Uri, CancellationToken)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Establishes a connection to the specified target URI. This method is asynchronous and can be cancelled.

```APIDOC
## Connect(Uri, CancellationToken)

### Description
Establishes a connection to the specified target URI.

### Method
Connect

### Parameters
- **target** (Uri) - Required - The URI of the server to connect to.
- **cancellationToken** (CancellationToken) - Required - A token to cancel the connection operation.

### Returns
Task
```

--------------------------------

### REPL_Controller Constructor

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.REPL_Controller.html

Initializes a new instance of the REPL_Controller class with the specified link interface, messaging interface, and optional prefix.

```APIDOC
## Constructor: REPL_Controller(LinkInterface, ICommandIO, string)

### Description
Initializes a new instance of the REPL_Controller class.

### Signature
```csharp
public REPL_Controller(LinkInterface link, ICommandIO messaging, string prefix = null)
```

### Parameters
- **link** (LinkInterface) - The link interface.
- **messaging** (ICommandIO) - The messaging interface for command I/O.
- **prefix** (string) - Optional prefix for the REPL prompt. Default is null.

```

--------------------------------

### BlendShape.Name

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.BlendShape.html

Gets or sets the name of the blendshape.

```APIDOC
## Property: Name

### Description
Name of the Blendshape.

### Property Signature
```csharp
[JsonPropertyName("name")]
public string Name { get; set; }
```

### Property Value
- **Type**: string
- **Access**: Read/Write
```

--------------------------------

### LinkSessionListener()

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkSessionListener.html

Initializes a new instance of the LinkSessionListener class.

```APIDOC
## LinkSessionListener()

### Description
Initializes a new instance of the LinkSessionListener class.

### Method
Constructor

### Signature
```csharp
public LinkSessionListener()
```

```

--------------------------------

### Array_ulong4.ElementType

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Array_ulong4.html

Gets the type of the elements in the array.

```APIDOC
## Property: ElementType

### Description
Gets the type of the elements in the array.

### Property Signature
```csharp
[JsonIgnore]
public override Type ElementType { get; }
```

### Property Value
- **Type**: Type
- **Access**: Read-only

### Attributes
- `JsonIgnore` - Ignored during JSON serialization.
```

--------------------------------

### ImportCubemapFiles

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ImportCubemapFiles.html

Documentation for the ImportCubemapFiles class, including its properties for specifying cubemap face texture file paths.

```APIDOC
## Class: ImportCubemapFiles

### Description
Import a cubemap asset from files on the local file system. Note that all image files need to be supported by Resonite, otherwise this will fail. If you are unsure if the file format is supported, send raw texture data instead. Ideally all files should also be same format and size. Otherwise they will be resized to match the largest dimensions, which can lower the quality.

### Namespace
ResoniteLink

### Assembly
ResoniteLink.dll

### Inheritance
object → Message → ImportCubemapFiles

### Properties

#### FilePathNegativeX
- **Type**: string
- **JSON Property Name**: `filePathNegativeX`
- **Description**: Path to a texture file representing negative X axis face

#### FilePathNegativeY
- **Type**: string
- **JSON Property Name**: `filePathNegativeY`
- **Description**: Path to a texture file representing negative Y axis face

#### FilePathNegativeZ
- **Type**: string
- **JSON Property Name**: `filePathNegativeZ`
- **Description**: Path to a texture file representing negative Z axis face

#### FilePathPositiveX
- **Type**: string
- **JSON Property Name**: `filePathPositiveX`
- **Description**: Path to a texture file representing positive X axis face

#### FilePathPositiveY
- **Type**: string
- **JSON Property Name**: `filePathPositiveY`
- **Description**: Path to a texture file representing positive Y axis face

#### FilePathPositiveZ
- **Type**: string
- **JSON Property Name**: `filePathPositiveZ`
- **Description**: Path to a texture file representing positive Z axis face
```

--------------------------------

### REPL_Controller.RunLoop Method

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.REPL_Controller.html

Runs the main loop of the REPL controller.

```APIDOC
## Method: RunLoop()

### Description
Runs the main loop of the REPL controller.

### Signature
```csharp
public Task RunLoop()
```

### Returns
- **Task** - A task representing the asynchronous operation.

```

--------------------------------

### Array_color.ElementType

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Array_color.html

Gets the type of elements contained in the array.

```APIDOC
## Property: ElementType

### Description
Gets the type of elements contained in the array.

### Signature
csharp
[JsonIgnore]
public override Type ElementType { get; }


### Property Value
- **Type**: `Type`
- **Description**: The type of elements in the array.
```

--------------------------------

### Array_Uri.ElementType

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Array_Uri.html

Gets the type of elements contained in the array.

```APIDOC
## Property: ElementType

### Description
Gets the type of elements contained in the array.

### Property Signature
```csharp
[JsonIgnore]
public override Type ElementType { get; }
```

### Property Value
- **Type**: Type
- **Access**: Read-only

### Remarks
This property is ignored during JSON serialization.
```

--------------------------------

### REPL_Controller.CurrentSlot Property

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.REPL_Controller.html

Gets the current slot associated with the REPL controller.

```APIDOC
## Property: CurrentSlot

### Description
Gets the current slot.

### Signature
```csharp
public Slot CurrentSlot { get; }
```

### Property Value
- **Slot** - The current slot.

```

--------------------------------

### ImportCubemap(ImportCubemapFiles)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Imports a cubemap from multiple files using an ImportCubemapFiles request.

```APIDOC
## ImportCubemap(ImportCubemapFiles)

### Description
Imports a cubemap from multiple files using an ImportCubemapFiles request.

### Method
ImportCubemap

### Parameters
- **request** (ImportCubemapFiles) - Required - The request containing the cubemap files.

### Returns
Task<AssetData>
```

--------------------------------

### ICommandIO.PrintPrompt(string)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ICommandIO.html

Prints a prompt message. This method is part of the ICommandIO interface for asynchronous text output.

```APIDOC
## PrintPrompt(string)

### Description
Prints a prompt message. This method is part of the ICommandIO interface for text-based interaction.

### Method
PrintPrompt

### Signature
`Task PrintPrompt(string prompt)`

### Parameters
- **prompt** (string) - The prompt message to print.

### Returns
- **Task** - A task representing the asynchronous operation.
```

--------------------------------

### ImportAudioClip(ImportAudioClipFile)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Imports an audio clip from a file using an ImportAudioClipFile request.

```APIDOC
## ImportAudioClip(ImportAudioClipFile)

### Description
Imports an audio clip from a file using an ImportAudioClipFile request.

### Method
ImportAudioClip

### Parameters
- **request** (ImportAudioClipFile) - Required - The request containing the audio clip file data.

### Returns
Task<AssetData>
```

--------------------------------

### BoundingBox.max

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.BoundingBox.html

Gets or sets the maximum corner of the bounding box as a float3.

```APIDOC
## Property: max

### Description
Gets or sets the maximum corner of the bounding box.

### Property Value
- **max** (float3) - The maximum corner of the bounding box.

### Example
```csharp
[JsonPropertyName("max")]
public float3 max { get; set; }
```
```

--------------------------------

### ImportCubemapFileWithRegions

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ImportCubemapFileWithRegions.html

Documentation for the ImportCubemapFileWithRegions message class, including its properties for specifying the cubemap file path and face regions.

```APIDOC
## ImportCubemapFileWithRegions

### Description
Import cubemap asset from a local file system from a single image file with regions specifying location of each face. The image file needs to be supported by Resonite, otherwise this will fail. Regions are in normalized coordinates from 0...1 range and will be calculated to actual pixel locations.

### Class
`public class ImportCubemapFileWithRegions : Message`

### Namespace
`ResoniteLink`

### Assembly
`ResoniteLink.dll`

### Properties

#### FilePath
- **Type**: `string`
- **JSON Property Name**: `filePath`
- **Description**: Path to a texture file representing the cubemap.

#### NegativeXRegion
- **Type**: `Rect`
- **JSON Property Name**: `negativeXregion`
- **Description**: Normalized region of the image file representing negative X face.

#### NegativeYRegion
- **Type**: `Rect`
- **JSON Property Name**: `negativeYregion`
- **Description**: Normalized region of the image file representing negative Y face.

#### NegativeZRegion
- **Type**: `Rect`
- **JSON Property Name**: `negativeZregion`
- **Description**: Normalized region of the image file representing negative Z face.

#### PositiveXRegion
- **Type**: `Rect`
- **JSON Property Name**: `positiveXregion`
- **Description**: Normalized region of the image file representing positive X face.

#### PositiveYRegion
- **Type**: `Rect`
- **JSON Property Name**: `positiveYregion`
- **Description**: Normalized region of the image file representing positive Y face.

#### PositiveZRegion
- **Type**: `Rect`
- **JSON Property Name**: `positiveZregion`
- **Description**: Normalized region of the image file representing positive Z face.

### Inherited Members
- `Message.MessageID`
- `Message.Validate()`
- `object.Equals(object)`
- `object.Equals(object, object)`
- `object.GetHashCode()`
- `object.GetType()`
- `object.MemberwiseClone()`
- `object.ReferenceEquals(object, object)`
- `object.ToString()`
```

--------------------------------

### Array_ulong4.Values

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Array_ulong4.html

Gets or sets the list of ulong4 values stored in the array.

```APIDOC
## Property: Values

### Description
Gets or sets the list of ulong4 values stored in the array.

### Property Signature
```csharp
[JsonPropertyName("values")]
public List<ulong4> Values { get; set; }
```

### Property Value
- **Type**: List<ulong4>
- **Access**: Read/Write

### Attributes
- `JsonPropertyName("values")` - Serialized as "values" in JSON.
```

--------------------------------

### ImportAudioClip(ImportAudioClipRawData)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Imports an audio clip from raw data using an ImportAudioClipRawData request.

```APIDOC
## ImportAudioClip(ImportAudioClipRawData)

### Description
Imports an audio clip from raw data using an ImportAudioClipRawData request.

### Method
ImportAudioClip

### Parameters
- **request** (ImportAudioClipRawData) - Required - The request containing the raw audio clip data.

### Returns
Task<AssetData>
```

--------------------------------

### Array_color.Values

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Array_color.html

Gets or sets the list of color values stored in the array.

```APIDOC
## Property: Values

### Description
Gets or sets the list of color values stored in the array.

### Signature
csharp
[JsonPropertyName("values")]
public List<color> Values { get; set; }


### Property Value
- **Type**: `List<color>`
- **Description**: The list of color values.
```

--------------------------------

### ICommandIO.ReadCommand()

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ICommandIO.html

Reads a command from the implementing input source. This method is part of the ICommandIO interface for asynchronous text input.

```APIDOC
## ReadCommand()

### Description
Reads a command from the implementing input source. This method is part of the ICommandIO interface for text-based interaction.

### Method
ReadCommand

### Signature
`Task<string> ReadCommand()`

### Parameters
- None

### Returns
- **Task<string>** - A task representing the asynchronous operation, with a Command as the result.
```

--------------------------------

### Array_Uri.Values

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Array_Uri.html

Gets or sets the list of Uri values stored in the array.

```APIDOC
## Property: Values

### Description
Gets or sets the list of Uri values stored in the array.

### Property Signature
```csharp
[JsonPropertyName("values")]
public List<Uri> Values { get; set; }
```

### Property Value
- **Type**: List<Uri>
- **Access**: Read/Write

### Remarks
This property is serialized with the JSON name "values".
```

--------------------------------

### Property: ColorProfile

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ImportCubemapRawData.html

Gets or sets the color profile of the cubemap color data.

```APIDOC
## Property: ColorProfile

### Description
Color profile of the cubemap color data.

### Declaration
```csharp
[JsonPropertyName("colorProfile")]
public string ColorProfile { get; set; }
```

### Property Value
- **Type**: string
- **Access**: Read/Write
```

--------------------------------

### Field_Nullable_double.ValueType Property

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_Nullable_double.html

Gets the runtime type of the field's value, which is `double?`.

```APIDOC
### Property: ValueType

**Type:** `Type`

**JSON Handling:** Ignored during serialization (`[JsonIgnore]`)

**Description:** Gets the type of the value held by this field. For `Field_Nullable_double`, this is `typeof(double?)`.
```

--------------------------------

### GetAllComponentTypes()

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Retrieves a list of all component types available.

```APIDOC
## GetAllComponentTypes()

### Description
Retrieves a list of all component types available.

### Method
GetAllComponentTypes

### Returns
Task<ComponentTypeList>
```

--------------------------------

### ImportCubemap(ImportCubemapRawData)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Imports a cubemap from raw data using an ImportCubemapRawData request.

```APIDOC
## ImportCubemap(ImportCubemapRawData)

### Description
Imports a cubemap from raw data using an ImportCubemapRawData request.

### Method
ImportCubemap

### Parameters
- **request** (ImportCubemapRawData) - Required - The request containing the raw cubemap data.

### Returns
Task<AssetData>
```

--------------------------------

### BoneWeight.BoneIndex

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.BoneWeight.html

Gets or sets the index of the bone this maps to in the Bones list of the mesh.

```APIDOC
## Property: BoneIndex

### Description
Index of the bone this maps to in the Bones list of the mesh.

### Signature
```
[JsonPropertyName("boneIndex")]
public int BoneIndex { get; set; }
```

### Property Value
- **Type**: int
- **Description**: The index of the bone in the mesh's bones list.
```

--------------------------------

### SplitCommand(string command, out string keyword, out string arguments)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.CommandParser.html

Splits a command string into its keyword (first word) and arguments (subsequent words). Can also split arguments from values.

```APIDOC
## SplitCommand(string command, out string keyword, out string arguments)

### Description
Splits a command string into its keyword and arguments. Useful for parsing commands or separating values.

### Method
Static method on CommandParser class.

### Syntax
`public static void SplitCommand(string command, out string keyword, out string arguments)`

### Parameters
- **command** (string) - The full command string to split, or the string to split into keyword and arguments.
- **keyword** (out string) - The first word in the command string.
- **arguments** (out string) - Any subsequent words in the command string, or an empty string if none.

### Returns
- **void** - No return value. The keyword and arguments are set as output parameters.

```

--------------------------------

### ImportCubemap(ImportCubemapFileWithRegions)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Imports a cubemap from a file with regions using an ImportCubemapFileWithRegions request.

```APIDOC
## ImportCubemap(ImportCubemapFileWithRegions)

### Description
Imports a cubemap from a file with regions using an ImportCubemapFileWithRegions request.

### Method
ImportCubemap

### Parameters
- **request** (ImportCubemapFileWithRegions) - Required - The request containing the cubemap file and region data.

### Returns
Task<AssetData>
```

--------------------------------

### Field_doubleQ.ValueType

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_doubleQ.html

Gets the type of the value stored in the field. This property is ignored during JSON serialization.

```APIDOC
## Property: ValueType

### Description
Gets the type of the value stored in the field. This property is ignored during JSON serialization.

### Property Signature
```csharp
[JsonIgnore]
public override Type ValueType { get; }
```

### Property Value
- **Type** - The type of the value stored in the field.
```

--------------------------------

### Field_Nullable_color32.ValueType

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_Nullable_color32.html

Gets the type of the value stored in the field. This property is ignored during JSON serialization.

```APIDOC
## Property: ValueType

### Description
Gets the type of the value stored in the field. This property is ignored during JSON serialization.

### Property Signature
```csharp
[JsonIgnore]
public override Type ValueType { get; }
```

### Property Value
- **Type**: Type
- **Access**: Read-only

### Attributes
- `[JsonIgnore]` - This property is excluded from JSON serialization.

```

--------------------------------

### Class Declaration

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ImportCubemapRawData.html

The ImportCubemapRawData class is declared as public and inherits from ImportCubemapRawDataBase<color32>.

```APIDOC
## ImportCubemapRawData Class

### Description
Imports cubemap from raw 8-bit color data. Resonite will take care of encoding the data into a file format.

### Declaration
```csharp
public class ImportCubemapRawData : ImportCubemapRawDataBase<color32>
```

### Inheritance
- object
- Message
- BinaryPayloadMessage
- ImportCubemapRawDataBase<color32>
- ImportCubemapRawData
```

--------------------------------

### ReadCommand(string input)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.CommandParser.html

Reads a command from console input and returns a Command object. Unknown commands return CommandType.Unknown with the keyword as arguments; empty or whitespace input returns CommandType.Unknown with empty arguments.

```APIDOC
## ReadCommand(string input)

### Description
Reads a command from the console input and returns a Command object containing the parsed command type and arguments.

### Method
Static method on CommandParser class.

### Syntax
`public static Command ReadCommand(string input)`

### Parameters
- **input** (string) - The command string to parse.

### Returns
- **Command** - The parsed command as a Command enum value and any arguments as a string. If the command is unknown, returns CommandType.Unknown with the keyword as arguments. If input is empty or whitespace, returns CommandType.Unknown with empty arguments.

```

--------------------------------

### Array_bool3.ElementType

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Array_bool3.html

Gets the type of elements contained in the array. This property is ignored during JSON serialization.

```APIDOC
## [Property] Array_bool3.ElementType

### Description
Gets the type of elements contained in the array. This property is ignored during JSON serialization.

### Property Signature
```csharp
[JsonIgnore]
public override Type ElementType { get; }
```

### Property Value
- **Type**: Type
- **Access**: Read-only
```

--------------------------------

### Class declaration for ImportCubemapRawData

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ImportCubemapRawData.html

Declares the ImportCubemapRawData class, which inherits from ImportCubemapRawDataBase<color32>. This class is used to import cubemaps from raw 8-bit color data.

```csharp
public class ImportCubemapRawData : ImportCubemapRawDataBase<color32>
```

--------------------------------

### RunDataModelOperationBatch(List<DataModelOperation>)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Runs a batch of data model operations.

```APIDOC
## RunDataModelOperationBatch(List<DataModelOperation>)

### Description
Runs a batch of data model operations.

### Method
RunDataModelOperationBatch

### Parameters
- **operations** (List<DataModelOperation>) - Required - The list of data model operations to run.

### Returns
Task<BatchResponse>
```

--------------------------------

### ID

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Member.html

Gets or sets the unique ID of this member. Can be used for anything needing to reference this member.

```APIDOC
## ID

### Description
Gets or sets the unique ID of this member. Can be used for anything needing to reference this member.

### Property
- **ID** (string) - Gets or sets the unique ID.

### Property Value
- **string** - The unique member ID.

```

--------------------------------

### ListDefinition.ElementDefinition

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ListDefinition.html

Gets or sets the definition of the elements in the list. Lists contain other members as their elements, all of the same type.

```APIDOC
## Property: ElementDefinition

### Description
Gets or sets the definition of the elements in the list. Lists contain other members as their elements, all of the same type.

### Property Value
- **Type**: MemberDefinition
- **JSON Property Name**: `elementDefinition`

### Example

{
  "elementDefinition": {
    "type": "string"
  }
}

```

--------------------------------

### ImportCubemap(ImportCubemapRawDataHDR)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Imports a cubemap from raw HDR data using an ImportCubemapRawDataHDR request.

```APIDOC
## ImportCubemap(ImportCubemapRawDataHDR)

### Description
Imports a cubemap from raw HDR data using an ImportCubemapRawDataHDR request.

### Method
ImportCubemap

### Parameters
- **request** (ImportCubemapRawDataHDR) - Required - The request containing the raw HDR cubemap data.

### Returns
Task<AssetData>
```

--------------------------------

### ImportAudioClipFile Class

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ImportAudioClipFile.html

The ImportAudioClipFile class is a message that carries the file path of an audio clip to import. It inherits from Message and includes a FilePath property.

```APIDOC
## ImportAudioClipFile Class

### Description
The ImportAudioClipFile class represents a message used to import an audio clip file. It contains a single property, FilePath, which specifies the path of the audio clip file to import.

### Namespace
ResoniteLink

### Assembly
ResoniteLink.dll

### Inheritance
- object
- Message
- ImportAudioClipFile

### Properties
#### FilePath
Path of the audio clip file to import.

- Type: string
- JSON Property Name: `filePath`
- Access: get; set;

### Property Value
string
```

--------------------------------

### Field_doubleQ.Value

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_doubleQ.html

Gets or sets the doubleQ value of the field. This property is serialized to JSON with the name 'value'.

```APIDOC
## Property: Value

### Description
Gets or sets the doubleQ value of the field. This property is serialized to JSON with the name 'value'.

### Property Signature
```csharp
[JsonPropertyName("value")]
public doubleQ Value { get; set; }
```

### Property Value
- **doubleQ** - The doubleQ value stored in the field.
```

--------------------------------

### Field_doubleQ.BoxedValue

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_doubleQ.html

Gets or sets the boxed value of the field as an object. This property is ignored during JSON serialization.

```APIDOC
## Property: BoxedValue

### Description
Gets or sets the boxed value of the field as an object. This property is ignored during JSON serialization.

### Property Signature
```csharp
[JsonIgnore]
public override object BoxedValue { get; set; }
```

### Property Value
- **object** - The boxed value of the field.
```

--------------------------------

### Field_Nullable_color32.BoxedValue

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_Nullable_color32.html

Gets or sets the boxed value of the field as an object. This property is ignored during JSON serialization.

```APIDOC
## Property: BoxedValue

### Description
Gets or sets the boxed value of the field as an object. This property is ignored during JSON serialization.

### Property Signature
```csharp
[JsonIgnore]
public override object BoxedValue { get; set; }
```

### Property Value
- **Type**: object
- **Access**: Read/Write

### Attributes
- `[JsonIgnore]` - This property is excluded from JSON serialization.

```

--------------------------------

### Slot Class Reference

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Slot.html

Reference documentation for the Slot class, including its fields and properties.

```APIDOC
## Slot Class

### Description
The Slot class represents a slot in the Resonite object hierarchy. It provides access to slot properties such as children, components, transform data, and metadata.

### Namespace
ResoniteLink

### Assembly
ResoniteLink.dll

### Inheritance
- object
- Worker
- Slot

### Fields

#### ROOT_SLOT_ID
- **Type**: string
- **Value**: "Root"
- **Description**: Constant string representing the root slot ID.

### Properties

#### Children
- **Type**: List<Slot>
- **JSON Property Name**: "children"
- **Description**: All the children that this slot has.

#### Components
- **Type**: List<Component>
- **JSON Property Name**: "components"
- **Description**: All the components that belong to this slot.

#### IsActive
- **Type**: Field_bool
- **JSON Property Name**: "isActive"
- **Description**: Indicates whether the slot is active.

#### IsPersistent
- **Type**: Field_bool
- **JSON Property Name**: "isPersistent"
- **Description**: Indicates whether the slot is persistent.

#### Name
- **Type**: Field_string
- **JSON Property Name**: "name"
- **Description**: The name of the slot.

#### OrderOffset
- **Type**: Field_long
- **JSON Property Name**: "orderOffset"
- **Description**: The order offset of the slot.

#### Parent
- **Type**: Reference
- **JSON Property Name**: "parent"
- **Description**: Reference to the parent slot.

#### Position
- **Type**: Field_float3
- **JSON Property Name**: "position"
- **Description**: The position of the slot in 3D space.

#### Rotation
- **Type**: Field_floatQ
- **JSON Property Name**: "rotation"
- **Description**: The rotation of the slot as a quaternion.

#### Scale
- **Type**: Field_float3
- **JSON Property Name**: "scale"
- **Description**: The scale of the slot in 3D space.

#### Tag
- **Type**: Field_string
- **JSON Property Name**: "tag"
- **Description**: A tag associated with the slot.
```

--------------------------------

### EnumDefinitionData.Definition

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.EnumDefinitionData.html

Gets or sets the definition of the enum type. This property is serialized with the JSON name 'definition'.

```APIDOC
## EnumDefinitionData.Definition

### Description
Gets or sets the definition of the enum type.

### Property Value
- **Definition** (EnumDefinition) - The definition of the enum type.

### JSON Property Name
`definition`

### Example
```json
{
  "definition": {
    // EnumDefinition object
  }
}
```
```

--------------------------------

### GetSyncObjectDefinition

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.GetSyncObjectDefinition.html

Documentation for the GetSyncObjectDefinition class, including its properties and inheritance.

```APIDOC
## Class GetSyncObjectDefinition

### Description
Represents a message to fetch the definition of a sync object. It is used to retrieve the structure of a sync object, optionally including base class members.

### Namespace
ResoniteLink

### Assembly
ResoniteLink.dll

### Inheritance
- object
- Message
- GetSyncObjectDefinition

### Properties

#### Flattened
- **Type**: bool
- **Description**: When true, the sync object definition will include all base class members. When false, only members declared on the specific type are returned.
- **JSON Property Name**: `flattened`

#### SyncObjectType
- **Type**: string
- **Description**: The type of the sync object to fetch the definition for. Must be a generic type definition for generic sync objects.
- **JSON Property Name**: `syncObjectType`
```

--------------------------------

### Members Property

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Component.html

Gets or sets the members (fields, references, lists...) of this component and their data.

```APIDOC
## Members Property

### Description
Members (fields, references, lists...) of this component and their data.

### Property Value
Dictionary<string, Member>

### JSON Property Name
`members`

### Example
```csharp
[JsonPropertyName("members")]
public Dictionary<string, Member> Members { get; set; }
```
```

--------------------------------

### ImportAudioClipRawData Class

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ImportAudioClipRawData.html

The ImportAudioClipRawData class represents raw audio clip data for import. It includes properties for audio channel count, duration, sample count, and sample rate, and a method to access the raw audio data buffer.

```APIDOC
## ImportAudioClipRawData Class

### Description
The ImportAudioClipRawData class represents raw audio clip data for import. It inherits from BinaryPayloadMessage and provides properties for audio channel count, duration, sample count, and sample rate, along with a method to access the raw audio data buffer.

### Namespace
ResoniteLink

### Assembly
ResoniteLink.dll

### Inheritance
object → Message → BinaryPayloadMessage → ImportAudioClipRawData

### Properties

#### ChannelCount
- **Type**: int
- **Description**: Number of audio channels. 1 mono, 2 stereo, 6 is 5.1 surround. It's your responsibility to make sure that Resonite supports given audio channel count. The actual audio sample data is interleaved in the buffer.
- **JSON Property Name**: `channelCount`

#### Duration
- **Type**: double
- **Description**: The duration of the audio clip in seconds, computed from the sample count and sample rate. This is just a convenience property; setting it will update AudioSampleCount accordingly.
- **JSON Property Name**: Ignored (JsonIgnore)

#### SampleCount
- **Type**: int
- **Description**: Number of audio samples in this audio clip. This does NOT account for channel count and will be the same regardless of mono/stereo/5.1 etc.
- **JSON Property Name**: `sampleCount`

#### SampleRate
- **Type**: int
- **Description**: Sample rate of the audio data.
- **JSON Property Name**: `sampleRate`

### Methods

#### AccessRawData()
- **Returns**: Span<float>
- **Description**: Provides access to the raw audio data buffer.

```

--------------------------------

### SyncMethodDefinition Class

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.SyncMethodDefinition.html

The SyncMethodDefinition class provides metadata about a sync method, including its name, parameters, return type, and flags for async and static methods.

```APIDOC
## SyncMethodDefinition Class

### Description
Represents a sync method definition in ResoniteLink, containing metadata about the method's name, parameters, return type, and execution characteristics.

### Properties

#### IsAsync
- **Type**: bool
- **Description**: Indicates if this method is sync or async. Sync methods are called and respond in sequence, while async methods may take longer and respond out of order.

#### IsStatic
- **Type**: bool
- **Description**: Indicates if this sync method is static. Static methods are not called on an object but are still executed within a world context.

#### Name
- **Type**: string
- **Description**: The name of the method.

#### Parameters
- **Type**: Dictionary<string, TypeReference>
- **Description**: Definition of parameters of this method. If empty, the method has none.

#### ReturnType
- **Type**: TypeReference
- **Description**: The return type of the method.

```

--------------------------------

### BoneWeight.Weight

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.BoneWeight.html

Gets or sets the weight (0 to 1) that influences how much this vertex is affected by the bone.

```APIDOC
## Property: Weight

### Description
Weight from 0...1 that influences how much this vertex is affected by the bone.

### Signature
```
[JsonPropertyName("weight")]
public float Weight { get; set; }
```

### Property Value
- **Type**: float
- **Description**: The weight value (0 to 1) indicating the bone's influence on the vertex.
```

--------------------------------

### BlendShape.Frames

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.BlendShape.html

Gets or sets the frames that compose this blendshape. Blendshapes need at least 1 frame.

```APIDOC
## Property: Frames

### Description
Frames that compose this blendshape. Blendshapes need at least 1 frame.

### Property Signature
```csharp
[JsonPropertyName("frames")]
public List<BlendshapeFrame> Frames { get; set; }
```

### Property Value
- **Type**: List<BlendshapeFrame>
- **Access**: Read/Write
```

--------------------------------

### Array_ushort4 Class

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Array_ushort4.html

Documentation for the Array_ushort4 class, including its properties.

```APIDOC
## Class Array_ushort4

### Description
Represents a sync array of ushort4 values.

### Inheritance
- object
- Member
- SyncArray
- Array_ushort4

### Properties

#### ElementType

```csharp
[JsonIgnore]
public override Type ElementType { get; }
```

- **Type**: Type
- **Description**: Gets the element type of the array.

#### Values

```csharp
[JsonPropertyName("values")]
public List<ushort4> Values { get; set; }
```

- **Type**: List<ushort4>
- **Description**: Gets or sets the list of ushort4 values.
```

--------------------------------

### KeyType property with JsonIgnore

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.SyncDictionary.html

Gets the type of the dictionary keys. Marked with JsonIgnore to exclude it from JSON serialization.

```csharp
[JsonIgnore]
public abstract Type KeyType { get; }
```

--------------------------------

### Value property

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_ushort3.html

Gets or sets the ushort3 value of the field. Serialized with JSON property name 'value'.

```csharp
[JsonPropertyName("value")]
public ushort3 Value { get; set; }
```

--------------------------------

### Namespace property with JsonPropertyName

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.TypeDefinition.html

Property for the full namespace path where the type is defined.

```csharp
[JsonPropertyName("namespace")]
public string Namespace { get; set; }
```

--------------------------------

### Field_long4 Properties

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_long4.html

Properties of the Field_long4 class that users can access to get or set the field's value.

```APIDOC
## Field_long4 Properties

### BoxedValue

```csharp
[JsonIgnore]
public override object BoxedValue { get; set; }
```

- **Type**: object
- **Description**: Gets or sets the boxed value of the field.

### Value

```csharp
[JsonPropertyName("value")]
public long4 Value { get; set; }
```

- **Type**: long4
- **Description**: Gets or sets the long4 value of the field. Serialized as "value" in JSON.

### ValueType

```csharp
[JsonIgnore]
public override Type ValueType { get; }
```

- **Type**: Type
- **Description**: Gets the type of the value stored in the field.
```

--------------------------------

### Field_Nullable_sbyte2 Class

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_Nullable_sbyte2.html

Represents a nullable sbyte2 field. Provides properties to get or set the value and its type.

```APIDOC
## Field_Nullable_sbyte2 Class

### Description
Represents a nullable sbyte2 field in the ResoniteLink API.

### Properties

#### BoxedValue
- **Type**: object
- **Attributes**: [JsonIgnore]
- **Access**: public override get; set;
- **Description**: Gets or sets the boxed value of the field.

#### Value
- **Type**: sbyte2?
- **Attributes**: [JsonPropertyName("value")]
- **Access**: public get; set;
- **Description**: Gets or sets the nullable sbyte2 value.

#### ValueType
- **Type**: Type
- **Attributes**: [JsonIgnore]
- **Access**: public override get;
- **Description**: Gets the type of the value.

```

--------------------------------

### AddSlot(AddSlot)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Adds a slot to the Resonite world using the provided request.

```APIDOC
## AddSlot(AddSlot)

### Description
Adds a slot to the Resonite world using the provided request.

### Method
AddSlot

### Parameters
- **request** (AddSlot) - Required - The request containing slot details.

### Returns
Task<NewEntityId>
```

--------------------------------

### Field_Nullable_color32.Value

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_Nullable_color32.html

Gets or sets the nullable color32 value of the field. This property is serialized to JSON with the name 'value'.

```APIDOC
## Property: Value

### Description
Gets or sets the nullable color32 value of the field. This property is serialized to JSON with the name 'value'.

### Property Signature
```csharp
[JsonPropertyName("value")]
public color32? Value { get; set; }
```

### Property Value
- **Type**: color32?
- **Access**: Read/Write

### Attributes
- `[JsonPropertyName("value")]` - The JSON property name for this field is "value".

```

--------------------------------

### ImportTexture2DFile

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ImportTexture2DFile.html

Represents a message to import a texture asset from a local file. The file format must be supported by Resonite.

```APIDOC
## ImportTexture2DFile

### Description
Import a texture asset from a file on the local file system. Note that this must be a file format supported by Resonite, otherwise this will fail. If you are unsure if the file format is supported, send raw texture data instead.

### Class
`public class ImportTexture2DFile : Message`

### Namespace
`ResoniteLink`

### Assembly
`ResoniteLink.dll`

### Inheritance
- `object`
- `Message`
- `ImportTexture2DFile`

### Inherited Members
- `Message.MessageID`
- `Message.Validate()`
- `object.Equals(object)`
- `object.Equals(object, object)`
- `object.GetHashCode()`
- `object.GetType()`
- `object.MemberwiseClone()`
- `object.ReferenceEquals(object, object)`
- `object.ToString()`

### Properties

#### FilePath
Path of the texture file to import

```csharp
[JsonPropertyName("filePath")]
public string FilePath { get; set; }
```

##### Property Value
- `string`
```

--------------------------------

### Field_Nullable_double.BoxedValue Property

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.Field_Nullable_double.html

Gets or sets the boxed value of the field as an object. This property is ignored during JSON serialization.

```APIDOC
### Property: BoxedValue

**Type:** `object`

**JSON Handling:** Ignored during serialization (`[JsonIgnore]`)

**Description:** Gets or sets the boxed representation of the field's value. This is used for generic access to the field's data and is not part of the JSON representation.
```

--------------------------------

### ICommandIO.PrintLine(string)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.ICommandIO.html

Prints a message with a newline. This method is part of the ICommandIO interface for asynchronous text output.

```APIDOC
## PrintLine(string)

### Description
Prints a message with a newline. This method is part of the ICommandIO interface for text-based interaction.

### Method
PrintLine

### Signature
`Task PrintLine(string message)`

### Parameters
- **message** (string) - The message to print.

### Returns
- **Task** - A task representing the asynchronous operation.
```

--------------------------------

### AddComponent(AddComponent)

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.LinkInterface.html

Adds a component to the Resonite world using the provided request.

```APIDOC
## AddComponent(AddComponent)

### Description
Adds a component to the Resonite world using the provided request.

### Method
AddComponent

### Parameters
- **request** (AddComponent) - Required - The request containing component details.

### Returns
Task<NewEntityId>
```

--------------------------------

### BatchResponse.Responses

Source: https://yellow-dog-man.github.io/ResoniteLink/api/ResoniteLink.BatchResponse.html

Gets or sets the list of individual responses for a MessageBatch. This property is serialized with the JSON name 'responses'.

```APIDOC
## BatchResponse.Responses

### Description
Gets or sets the list of individual responses for a MessageBatch. This property is serialized with the JSON name 'responses'.

### Property Value
List<Response>

### JSON Property Name
responses

### Example
```json
{
  "responses": [
    {
      "success": true,
      "errorInfo": null
    }
  ]
}
```
```
Tokens:
Raw