Search Results for

    Show / Hide Table of Contents

    Class Voice

    Inheritance
    object
    Object
    ScriptableObject
    AIResourceBase
    Voice
    Implements
    IAIResource
    IData
    IHasId<string>
    IHasName
    IDeprecatable
    Inherited Members
    AIResourceBase.id
    AIResourceBase.displayName
    AIResourceBase.api
    AIResourceBase.deprecated
    AIResourceBase.locked
    AIResourceBase.Id
    AIResourceBase.Api
    AIResourceBase.IsDeprecated
    AIResourceBase.ToString()
    AIResourceBase.Equals(AIResourceBase)
    AIResourceBase.Equals(object)
    AIResourceBase.GetHashCode()
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetEntityId()
    Object.GetInstanceID()
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Glitch9.AIDevKit
    Assembly: Glitch9.AIDevKit.dll
    Syntax
    [JsonConverter(typeof(VoiceConverter))]
    [CreateAssetMenu(menuName = "AI DevKit/AI Voice", order = 2057)]
    public class Voice : AIResourceBase, IAIResource, IData, IHasId<string>, IHasName, IDeprecatable

    Properties

    | Edit this page View Source

    Age

    The age category of the voice actor (e.g., Child, Adult, Senior).

    Declaration
    public VoiceAge Age { get; }
    Property Value
    Type Description
    VoiceAge
    | Edit this page View Source

    Gender

    The gender of the voice actor (e.g., Male, Female, Neutral).

    Declaration
    public VoiceGender Gender { get; }
    Property Value
    Type Description
    VoiceGender
    | Edit this page View Source

    IsCustom

    Indicates whether the asset is user-customized or not. If it's a model, it means the model is a fine-tuned version of a base model. If it's a voice, it means the voice is a custom voice created by the user.

    Declaration
    public override bool IsCustom { get; }
    Property Value
    Type Description
    bool
    Overrides
    AIResourceBase.IsCustom
    | Edit this page View Source

    Language

    The Unity UnityEngine.SystemLanguage corresponding to the locale of this voice.

    Declaration
    public SystemLanguage Language { get; }
    Property Value
    Type Description
    SystemLanguage
    | Edit this page View Source

    Locale

    The locale setting of this voice (e.g., en-US, ko-KR).

    Declaration
    public Locale Locale { get; }
    Property Value
    Type Description
    Locale
    | Edit this page View Source

    Metadata

    Additional metadata associated with the voice.

    Declaration
    public SerializableDictionary<string, string> Metadata { get; }
    Property Value
    Type Description
    SerializableDictionary<string, string>
    | Edit this page View Source

    Name

    The name of the voice actor.

    Declaration
    public override string Name { get; }
    Property Value
    Type Description
    string
    Overrides
    AIResourceBase.Name

    Methods

    | Edit this page View Source

    DefaultByApi(Api)

    Declaration
    public static string DefaultByApi(Api api)
    Parameters
    Type Name Description
    Api api
    Returns
    Type Description
    string
    | Edit this page View Source

    FirstValid(params string[])

    Declaration
    public static Voice FirstValid(params string[] candidateIds)
    Parameters
    Type Name Description
    string[] candidateIds
    Returns
    Type Description
    Voice
    | Edit this page View Source

    FirstValidId(params string[])

    Declaration
    public static string FirstValidId(params string[] candidateIds)
    Parameters
    Type Name Description
    string[] candidateIds
    Returns
    Type Description
    string
    | Edit this page View Source

    TryGet(out Voice, params string[])

    Declaration
    public static bool TryGet(out Voice voice, params string[] candidateIds)
    Parameters
    Type Name Description
    Voice voice
    string[] candidateIds
    Returns
    Type Description
    bool

    Operators

    | Edit this page View Source

    implicit operator Voice(string)

    Declaration
    public static implicit operator Voice(string voiceId)
    Parameters
    Type Name Description
    string voiceId
    Returns
    Type Description
    Voice

    Implements

    IAIResource
    IData
    IHasId<TId>
    IHasName
    IDeprecatable

    Extension Methods

    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    FileExtensions.ToFile<T>(T, string)
    ResponseCastingExtensions.GetResult<T>(T)
    CoreLibTypeExtensions.GetNameOrDash(IData)
    CoreLibTypeExtensions.GetIdOrNull(IHasId<string>)
    CoreLibTypeExtensions.IsNullOrEmptyId(IHasId<string>)
    SystemExtensions.GetName(object)
    UnityObjectExtensions.EncodeToBase64(Object)
    UnityObjectExtensions.ToBytes(Object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation