Interface IAvatarFacial

Namespace

VMagicMirror.Buddy

アバターの表情の状態に関するAPIです。

public interface IAvatarFacial

Properties

CurrentFacial

現在アバターに適用されている表情のうち、表情トラッキング以外の方法で明示的に適用された表情のBlendShapeClipの名称を取得します。

string CurrentFacial { get; }

Property Value

string

Remarks

このプロパティでは、Word to Motion機能によって表情を切り替えたり、外部トラッキングによるFace Switch機能で表情を切り替えた場合の表情を取得できます。 HappyやSurprisedなど表情はこの方法で取得できます。

リップシンクやまばたきのブレンドシェイプはこのプロパティでは取得できません。

IsTalking

マイク入力で発声を検知し、アバターにリップシンクが適用されている場合はtrue、それ以外の場合はfalseを取得します。

bool IsTalking { get; }

Property Value

bool

Remarks

外部トラッキングによって口の開閉をトラッキングしている場合であっても、マイク入力が検知できなければfalseを返します。

UsePerfectSync

外部トラッキング機能を使用し、かつパーフェクトシンクが有効な場合にtrue、それ以外の場合はfalseを取得します。

bool UsePerfectSync { get; }

Property Value

bool

Methods

GetActiveFaceSwitch()

ユーザーが外部トラッキング機能に基づくFace Switch機能を使っている場合に、Face Switch機能で検出した表情の名称を取得します。

FaceSwitchState GetActiveFaceSwitch()

Returns

FaceSwitchState

GetCurrentValue(string, bool)

指定したブレンドシェイプの現在の値を取得します。

float GetCurrentValue(string name, bool customKey)

Parameters

name string

ブレンドシェイプ名

customKey bool

カスタムブレンドシェイプの値を取得する場合はtrue、そうでなければfalseを指定します。

Returns

float

ブレンドシェイプの値。0以上、1以下の値を返します。

Remarks

アバターがロードされていない場合や、指定したブレンドシェイプがアバターに定義されていない場合は、この関数は0を返します。

HasClip(string)

現在ロードしているアバターに指定した名称のカスタムブレンドシェイプが定義されているかどうかを取得します。

bool HasClip(string name)

Parameters

name string

ブレンドシェイプ名

Returns

bool

Remarks

アバターがロードされていない場合、この関数はfalseを返します。

Events

OnBlinked

アバターがまばたき動作を行うと発火します。

event Action OnBlinked

Event Type

Action

Remarks

このイベントは自動まばたきを適用している場合の自動でのまばたき、外部トラッキングによる目のトラッキングによる瞬きに対して発火します。 外部トラッキングを使用していて目をゆっくり開閉した場合や、短時間で連続でまばたきを行った場合には発火しない場合があります。 ウインクに対してもこのイベントは発火しません。