Class FluentCeVIO

A wrapper library for FluentCeVIOWrapper Client

Inheritance
object
FluentCeVIO
Implements
Namespace: FluentCeVIOWrapper.Common
Assembly: FluentCeVIOWrapper.Common.dll
Syntax
public class FluentCeVIO : IDisposable
Remarks
  • .NET Core系(.NET 5/6/...)でもCeVIOの.NET Framework APIにアクセスできるラッパーライブラリ
  • async/awaitに対応したモダンな書き方ができます

Fields

PipeName

内部のプロセス間通信で使用される名前です。 複数サーバーを立てる場合はサーバーと共にこの名前を変更します。

Declaration
public const string PipeName = "FluentCeVIOPipe"
Field Value
Type Description
string

Properties

CurrentPipeName

現在の内部のプロセス間通信で使用される名前です。

Declaration
public string CurrentPipeName { get; set; }
Property Value
Type Description
string

CurrentProduct

現在の制御CeVIO製品

Declaration
public Product CurrentProduct { get; }
Property Value
Type Description
Product

CurrentVersion

現在の制御しているCeVIOのバージョン

Declaration
public Version? CurrentVersion { get; }
Property Value
Type Description
Version

Methods

CloseAsync()

非同期で終了処理

Declaration
public Task<bool> CloseAsync()
Returns
Type Description
Task<bool>
Examples
await CloseHost();		//通常の使い方
var _ = CloseHost();	//同期的に処理

CreateParam()

まとめてパラメータを設定するための準備 メソッドチェーンでパラメータを指定できます

Declaration
public FluentCeVIOParam CreateParam()
Returns
Type Description
FluentCeVIOParam
Examples
var fcw = FluentCeVIO.FactoryAsync();
await fcw.CreateParam()
	.Cast("さとうささら")
	.Alpha(50)
	.Speed(75)
	.SendAsync();

FactoryAsync(string?, Product)

呼び出しのファクトリメソッド

Declaration
public static ValueTask<FluentCeVIO> FactoryAsync(string? pipeName = "FluentCeVIOPipe", Product product = Product.CeVIO_AI)
Parameters
Type Name Description
string pipeName 内部のプロセス間通信で使用される名前です。 複数サーバーを立てる場合はサーバーと共にこの名前を変更します。
Product product

呼び出すCeVIO製品
Returns
Type Description
ValueTask<FluentCeVIO>

GetAlphaAsync()

声質（0～100）を取得します。

Declaration
public Task<uint> GetAlphaAsync()
Returns
Type Description
Task<uint>

声質（0～100）
See Also

GetAvailableCastsAsync()

利用可能なキャスト名 string[] を取得します。

Declaration
public Task<string[]> GetAvailableCastsAsync()
Returns
Type Description
Task<string[]>

利用可能なキャスト名の配列
Remarks

備考：インストールされているボイスによります。

See Also

GetCastAsync()

現在のキャスト(話者)を取得します。

Declaration
public Task<string> GetCastAsync()
Returns
Type Description
Task<string>

キャスト名
See Also

GetComponentsAsync()

現在のキャストの感情パラメータマップコレクションを取得します。

Declaration
public Task<ReadOnlyCollection<TalkerComponent>> GetComponentsAsync()
Returns
Type Description
Task<ReadOnlyCollection<TalkerComponent>>

感情パラメータの管理オブジェクトTalkerComponentのReadOnlyCollection<T>
Remarks

戻り値は、元のAPIと異なり、汎用のReadOnlyCollection<T>で返ります。

See Also

GetHostVersionAsync()

ホストアプリ（CeVIO）のバージョンをVersion型で返す

Declaration
public Task<Version> GetHostVersionAsync()
Returns
Type Description
Task<Version>

バージョン
See Also

GetIsHostStartedAsync()

ホストアプリ（CeVIO）が起動中かどうか

Declaration
public Task<bool> GetIsHostStartedAsync()
Returns
Type Description
Task<bool>

GetPhonemesAsync(string)

指定したセリフの音素単位のデータを取得します。

Declaration
public Task<ReadOnlyCollection<PhonemeData>> GetPhonemesAsync(string text)
Parameters
Type Name Description
string text

セリフ。日本語は最大200文字（古いバージョンは150文字）。
Returns
Type Description
Task<ReadOnlyCollection<PhonemeData>>

音素単位のデータのコレクション
Remarks

リップシンク等に利用できます。 戻り値は、元のAPIと異なり、汎用のReadOnlyCollection<T>で返ります。

See Also

GetSpeedAsync()

話す速さ（0～100）を取得します。

Declaration
public Task<uint> GetSpeedAsync()
Returns
Type Description
Task<uint>

話す速さ（0～100）
See Also

GetTextDurationAsync(string)

指定したセリフの長さを取得します。

Declaration
public Task<double> GetTextDurationAsync(string text)
Parameters
Type Name Description
string text

セリフ。日本語は最大200文字（古いバージョンは150文字）。
Returns
Type Description
Task<double>

長さ。単位は秒。

GetToneAsync()

音の高さ（0～100）を取得します。

Declaration
public Task<uint> GetToneAsync()
Returns
Type Description
Task<uint>

音の高さ（0～100）
See Also

GetToneScaleAsync()

抑揚（0～100）を取得します。

Declaration
public Task<uint> GetToneScaleAsync()
Returns
Type Description
Task<uint>

抑揚（0～100）
See Also

GetVolumeAsync()

音の大きさ（0～100）を取得します。

Declaration
public Task<uint> GetVolumeAsync()
Returns
Type Description
Task<uint>

音の大きさ（0～100）
See Also

OutputWaveToFileAsync(string, string)

指定したセリフをWAVファイルとして出力します。

Declaration
public Task<bool> OutputWaveToFileAsync(string text, string path)
Parameters
Type Name Description
string text

セリフ。
string path

出力先パス。
Returns
Type Description
Task<bool>

成功した場合はtrue。それ以外の場合はfalse。
Remarks

出力形式はサンプリングレート48kHz, ビットレート16bit, モノラルです。

SetAlphaAsync(uint)

声質（0～100）を設定します。

Declaration
public ValueTask SetAlphaAsync(uint value)
Parameters
Type Name Description
uint value

声質（0～100）
Returns
Type Description
ValueTask
See Also

SetCastAsync(string)

キャスト(話者)を設定します。

Declaration
public ValueTask SetCastAsync(string castName)
Parameters
Type Name Description
string castName

キャスト名。利用可能なキャスト名の文字列はGetAvailableCastsAsync()で取得可。
Returns
Type Description
ValueTask
See Also

SetComponentsAsync(IEnumerable<TalkerComponent>)

現在のキャストの感情パラメータマップコレクションを設定します。

Declaration
public ValueTask SetComponentsAsync(IEnumerable<TalkerComponent> value)
Parameters
Type Name Description
IEnumerable<TalkerComponent> value

感情パラメータの管理オブジェクト
Returns
Type Description
ValueTask
See Also

SetSpeedAsync(uint)

話す速さ（0～100）を設定します。

Declaration
public ValueTask SetSpeedAsync(uint value)
Parameters
Type Name Description
uint value

話す速さ（0～100）
Returns
Type Description
ValueTask
See Also

SetToneAsync(uint)

音の高さ（0～100）を設定します。

Declaration
public ValueTask SetToneAsync(uint value)
Parameters
Type Name Description
uint value

音の高さ（0～100）
Returns
Type Description
ValueTask
See Also

SetToneScaleAsync(uint)

抑揚（0～100）を設定します。

Declaration
public ValueTask SetToneScaleAsync(uint value)
Parameters
Type Name Description
uint value

抑揚（0～100）
Returns
Type Description
ValueTask
See Also

SetVolumeAsync(uint)

音の大きさ（0～100）を設定します。

Declaration
public ValueTask SetVolumeAsync(uint volume)
Parameters
Type Name Description
uint volume

音の大きさ（0～100）
Returns
Type Description
ValueTask
See Also

SpeakAsync(string, bool, SpeakSegment, CancellationToken?)

指定したセリフの再生を開始します。

Declaration
public Task<bool> SpeakAsync(string text, bool isWait = true, SpeakSegment segment = SpeakSegment.Short, CancellationToken? token = null)
Parameters
Type Name Description
string text

セリフ。日本語は最大200文字（古いバージョンは150文字）。
bool isWait

再生終了まで待つかどうか
SpeakSegment segment

セリフ文字列の分割モードの指定。
CancellationToken? token
Returns
Type Description
Task<bool>

セリフの再生に成功したかどうか。
Examples

await SpeakAsync("こんにちは"); //再生終了まで待つ await SpeakAsync("こんにちは",true);

See Also

StartAsync()

非同期で起動 元のStartHost

Declaration
public Task<HostStartResult> StartAsync()
Returns
Type Description
Task<HostStartResult>

StopAsync()

再生を停止します。

Declaration
public Task<bool> StopAsync()
Returns
Type Description
Task<bool>

成功した場合はtrue。それ以外の場合はfalse。

Implements

Extension Methods