CriLipsAtomPlugin Class Reference

Global class of the LipsAtom library. More...

Static Public Member Functions
static void	InitializeLibrary (uint maxHandles=8u)
	Initializes the LipsAtom library More...
static void	FinalizeLibrary ()
	Terminates the LipsAtom library More...
static uint	GetMemoryUsage ()
	Gets memory usage More...
static void	AttachAnalyzerToPlayer (CriAtomExPlayer player, CriLipsAtomAnalyzer analyzer)
	Attaches the LipsAtom analyzer to the AtomExPlayer More...
static bool	IsAnalyzerAttachedToPlayer (CriLipsAtomAnalyzer analyzer)
	Determine whether the LipsAtom analyzer is attached to an AtomExPlayer More...
static void	DetachAnalyzerFromPlayer (CriAtomExPlayer player, CriLipsAtomAnalyzer analyzer)
	Detaches the LipsAtom analyzer from the AtomExPlayer More...
static void	DetachAnalyzerFromInvalidPlayer (CriLipsAtomAnalyzer analyzer)
	Detaches the LipsAtom analyzer from the discarded AtomExPlayer More...

Detailed Description

Global class of the LipsAtom library.

Description:

A class containing the initialization functions for the LipsAtom library and the variable types shared in the library.

Member Function Documentation

static void InitializeLibrary ( uint  maxHandles = 8u )

inlinestatic

Initializes the LipsAtom library

Parameters

maxHandles

Maximum number of AtomAnalyzer handles to use at the same time (default is 8)

Description:

Initializes the LipsAtom library.
If you want to analyze the mouth shape in cooperation with Atom, initialize the library using this function. In addition, if you initialize the library by calling this function, be sure to call CriLipsAtomPlugin::FinalizeLibrary to terminate the library.

See also

CriLipsAtomPlugin::FinalizeLibrary

static void FinalizeLibrary ( )

inlinestatic

Terminates the LipsAtom library

Description:

Initializes the LipsAtom library.

See also

CriLipsAtomPlugin::InitializeLibrary

static uint GetMemoryUsage ( )

inlinestatic

Gets memory usage

Returns

Memory usage [byte]

Description:

Returns the memory usage of LipsAtom.

static void AttachAnalyzerToPlayer ( CriAtomExPlayer  player, CriLipsAtomAnalyzer  analyzer  )

inlinestatic

Attaches the LipsAtom analyzer to the AtomExPlayer

Parameters

player	AtomExPlayer handle
analyzer	LipsAtomAnalyzer handle

Description:

Attach the LipsAtom analyzer to the AtomExPlayer to be analyzed.
After calling this function, the audio played by the AtomExPlayer will be analyzed, and the mouth shape information can be acquired via the attached LipsAtom analyzer.

Note:

If you want to destroy the AtomExPlayer or LipsAtom analyzer attached with this function,
Make sure CriLipsAtomPlugin.IsAnalyzerAttachedToPlayer returns false.
If it returns true, call CriLipsAtomPlugin.DetachAnalyzerFromPlayer to detach the object first.
Illegal memory access may occur if you destroy the analyzer without detaching it.

See also

CriLipsAtomPlugin::DetachAnalyzerFromPlayer, CriLipsAtomPlugin.IsAnalyzerAttachedToPlayer

static bool IsAnalyzerAttachedToPlayer ( CriLipsAtomAnalyzer  analyzer )

inlinestatic

Determine whether the LipsAtom analyzer is attached to an AtomExPlayer

Parameters

analyzer

LipsAtomAnalyzer handle

Description:

Determine if the LipsAtom analyzer is attached to an AtomExPlayer.

See also

CriLipsAtomPlugin.AttachAnalyzerToPlayer, CriLipsAtomPlugin.DetachAnalyzerFromPlayer

static void DetachAnalyzerFromPlayer ( CriAtomExPlayer  player, CriLipsAtomAnalyzer  analyzer  )

inlinestatic

Detaches the LipsAtom analyzer from the AtomExPlayer

Parameters

player	AtomExPlayer handle
analyzer	LipsAtomAnalyzer handle

Description:

Detach (remove) the analyzer from the AtomExPlayer.

See also

CriLipsAtomPlugin::AttachAnalyzerToPlayer, CriLipsAtomPlugin.IsAnalyzerAttachedToPlayer

static void DetachAnalyzerFromInvalidPlayer ( CriLipsAtomAnalyzer  analyzer )

inlinestatic

Detaches the LipsAtom analyzer from the discarded AtomExPlayer

Parameters

analyzer

LipsAtomAnalyzer handle

Description:

Detaches (removes) the analyzer from the discarded AtomExPlayer.

See also

CriLipsAtomPlugin::AttachAnalyzerToPlayer

---

The documentation for this class was generated from the following file:

• CriLipsAtom.cs