Package dev.adlin.vts4j

Record Class PluginMeta

java.lang.Object
java.lang.Record
dev.adlin.vts4j.PluginMeta
Record Components:
name - the unique, human-readable name of the plugin
developer - the name of the organization or developer who created the plugin
icon - the optional Base64-encoded string or identifier of the plugin's icon, can be null if not provided
public record PluginMeta(@NonNull String name, @NonNull String developer, @Nullable String icon) extends Record
An immutable data record representing metadata configuration for a plugin.

This metadata is required by the VTube Studio API during the initial handshake and token authentication processes to identify the application.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PluginMeta(@NonNull String name, @NonNull String developer)
    Overloaded constructor to initialize plugin metadata without an icon.
    PluginMeta(@NonNull String name, @NonNull String developer, @Nullable String icon)
    Creates an instance of a PluginMeta record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    developer()
    Returns the value of the developer record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @Nullable String
    icon()
    Returns the value of the icon record component.
    @NonNull String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PluginMeta

      public PluginMeta(@NonNull String name, @NonNull String developer)
      Overloaded constructor to initialize plugin metadata without an icon.
      Parameters:
      name - the unique, human-readable name of the plugin
      developer - the name of the organization or developer who created the plugin

    • PluginMeta

      public PluginMeta(@NonNull String name, @NonNull String developer, @Nullable String icon)
      Creates an instance of a PluginMeta record class.
      Parameters:
      name - the value for the name record component
      developer - the value for the developer record component
      icon - the value for the icon record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public @NonNull String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • developer

      public @NonNull String developer()
      Returns the value of the developer record component.
      Returns:
      the value of the developer record component

    • icon

      public @Nullable String icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component