VR Voice Chat with MUN ver.2.7.0 API Reference
MonobitEngine.VoiceChat.MonobitVoiceBase Class Reference

ボイスチャットAPI(Base Class). More...

Inheritance diagram for MonobitEngine.VoiceChat.MonobitVoiceBase:
Collaboration diagram for MonobitEngine.VoiceChat.MonobitVoiceBase:

Public Member Functions

 MonobitVoiceBase ()
 コンストラクタ More...
 
void UpdateChatState ()
 チャット状態を更新する More...
 
virtual bool OnBeginEncode (int channels, int samplingRate)
 エンコード前処理 More...
 
virtual bool OnPreEncode (float[] voice, int channels, int samplingRate)
 エンコード前のボイスの加工処理 More...
 
virtual void OnEndEncode ()
 エンコード後処理 More...
 
virtual bool OnBeginDecode (int channels, int samplingRate)
 デコード前処理 More...
 
virtual bool OnPreDecode (float[] decodeVoice, int channels, int samplingRate)
 ボイスデータ再生前処理 More...
 
virtual void OnEndDecode (bool success)
 ボイスデータ再生後処理 More...
 
virtual void OnSendVoice (bool debugMode, object[] header, byte[] voice, int voice_size)
 エンコードボイスデータ送信デリゲート More...
 
virtual void OnBps (int bps)
 送信時の音声データのbps取得コールバック More...
 
void PlaybackVoice ()
 PlaybackVoiceDataでdelay_playback = false設定した後に任意で再生する More...
 
void PlaybackVoiceData (object[] parameters, byte[] voice, int voice_size, bool unreliable=false, bool delay_playback=false, bool ignore_allow_lag=false)
 ボイスデータの再生 More...
 
void PauseVoice ()
 再生を一時停止する More...
 
void StopVoice ()
 再生を停止する More...
 
AudioClip GetAudioClip ()
 AudioClip情報の取得 More...
 
int GetCaptureSamplingRate ()
 録音データのサンプリングレートの取得 More...
 
int GetCaptureBufferSize ()
 録音データのバッファサイズの取得 More...
 
virtual void Awake ()
 インスタンスの開始 More...
 
virtual void Start ()
 コンポーネントの開始 More...
 
virtual void Update ()
 更新 More...
 
virtual void OnDestroy ()
 破棄 More...
 

Public Attributes

bool m_ShowVoiceDataBps = false
 音声データのbps表示モード More...
 
bool m_PlaybackVoiceLocalNoCheck = false
 再生ボイスデータのローカルチェックの無効化 More...
 

Protected Attributes

Codec.Opus.Application m_Application = Codec.Opus.Application.VoIP
 コーデックのアプリケーション設定 More...
 
OpusSignal m_OpusSignal = OpusSignal.Voice
 コーデックのシグナル設定 More...
 
EncodeMode m_EncodeMode = EncodeMode.VBR
 VBRか判定 More...
 
CompressedBitRatePreset m_compressedBitRatePreset = CompressedBitRatePreset.VoipLow
 圧縮ビットレートのプリセット More...
 
int m_nCompressedBitRate = 32000
 圧縮ビットレート More...
 
OpusBandwidth m_bandWidth = OpusBandwidth.WideBand
 帯域設定 More...
 
SampligRatePreset m_samplingRatePreset = SampligRatePreset.Medium
 サンプリングレートのプリセット More...
 
int m_encodeSamplingRate = 16000
 サンプリングレート More...
 
DecodeSamplingRatePreset m_decodeSamplingRatePreset = DecodeSamplingRatePreset.Preset_16000Hz
 デコード用のサンプリングレートのプリセット More...
 
int m_complexity = 10
 エンコード品質 More...
 
FrameSizeMs m_FrameSizeMs = FrameSizeMs.FrameSize40ms
 録音時間 More...
 
bool m_Surround3D = false
 3Dサラウンド設定 More...
 
bool m_VoiceActivityDetector = false
 無音検出をするかどうか More...
 
int m_TalkingThreshold = -30
 無音検出閾値 More...
 
int m_VADLatitude = 5
 無音検知幅 More...
 
bool m_ReliableMode = true
 UDPモード More...
 
bool m_Encrypt = false
 暗号化 More...
 
bool m_DebugMode = false
 デバッグモード More...
 
MonobitMicrophone m_microphone = null
 マイクコンポーネント More...
 
MonobitStreamingPlayer m_player = null
 スピーカーコンポーネント More...
 
UInt32 m_requireIndex = 0
 シーケンス番号 More...
 

Properties

ushort Version [get]
 バージョン番号 More...
 
OpusCodec OpusCodec [get]
 Opusコーデック設定 More...
 
Codec.Opus.Application Application [get, set]
 コーデックのアプリケーション設定 More...
 
OpusSignal OpusSignal [get, set]
 コーデックのシグナル設定 More...
 
EncodeMode EncodeMode [get, set]
 VBRか判定 More...
 
CompressedBitRatePreset CompressedBitRatePreset [get, set]
 圧縮ビットレートのプリセット More...
 
int CompressedBitRate [get, set]
 圧縮ビットレート More...
 
OpusBandwidth OpusBandwidth [get, set]
 帯域設定 More...
 
SampligRatePreset SampligRatePreset [get, set]
 サンプリングレートのプリセット More...
 
int EncodeSamplingRate [get, set]
 サンプリングレート More...
 
DecodeSamplingRatePreset DecodeSamplingRatePreset [get, set]
 デコード用のサンプリングレートのプリセット More...
 
int Complexity [get, set]
 エンコード品質 More...
 
FrameSizeMs FrameSizeMs [get, set]
 録音時間 More...
 
bool Surround3D [get, set]
 3Dサラウンド設定 More...
 
bool VAD [get, set]
 無音検出をするかどうか More...
 
int TalkingThreshold [get, set]
 無音検出閾値 More...
 
int VADLatitude [get, set]
 無音検知幅 More...
 
bool ReliableMode [get, set]
 UDPモード More...
 
bool Encrypt [get, set]
 暗号化 More...
 
bool DebugMode [get, set]
 デバッグモード More...
 
bool ShowVoiceDataBps [get, set]
 音声データのbps表示モード More...
 
bool PlaybackVoiceLocalNoCheck [get, set]
 再生ボイスデータのローカルチェックの無効化 More...
 
MonobitMicrophone Microphone [get]
 マイクコンポーネント More...
 
MonobitStreamingPlayer StreamingPlayer [get]
 スピーカーコンポーネント More...
 
Hashtable customProperties [get, set]
 カスタムプロパティ More...
 
bool isLocalPlayer [get]
 ローカルプレイヤー More...
 
bool isLocal [get]
 MonobitViewがローカルプレイヤーか判定する More...
 
bool isDecoderStarting [get]
 デコーダーの開始フラグ More...
 
long RemainSamples [get]
 残りサンプル数の取得 More...
 
double RemainTime [get]
 残り再生時間の取得 More...
 
Int64 TotalWriteSample [get]
 総書き込みサンプル数 More...
 

Detailed Description

ボイスチャットAPI(Base Class).

Constructor & Destructor Documentation

MonobitEngine.VoiceChat.MonobitVoiceBase.MonobitVoiceBase ( )

コンストラクタ

Member Function Documentation

virtual void MonobitEngine.VoiceChat.MonobitVoiceBase.Awake ( )
virtual

インスタンスの開始

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

AudioClip MonobitEngine.VoiceChat.MonobitVoiceBase.GetAudioClip ( )

AudioClip情報の取得

Here is the call graph for this function:

int MonobitEngine.VoiceChat.MonobitVoiceBase.GetCaptureBufferSize ( )

録音データのバッファサイズの取得

Here is the call graph for this function:

int MonobitEngine.VoiceChat.MonobitVoiceBase.GetCaptureSamplingRate ( )

録音データのサンプリングレートの取得

Here is the call graph for this function:

virtual bool MonobitEngine.VoiceChat.MonobitVoiceBase.OnBeginDecode ( int  channels,
int  samplingRate 
)
virtual

デコード前処理

Parameters
channelsチャンネル数
samplingRateサンプリングレート
Returns
trueなら成功

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

virtual bool MonobitEngine.VoiceChat.MonobitVoiceBase.OnBeginEncode ( int  channels,
int  samplingRate 
)
virtual

エンコード前処理

Parameters
channelsチャンネル数
samplingRateサンプリングレート
Returns
trueなら成功

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

virtual void MonobitEngine.VoiceChat.MonobitVoiceBase.OnBps ( int  bps)
virtual

送信時の音声データのbps取得コールバック

Parameters
bpsボイスデータのbps値

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

virtual void MonobitEngine.VoiceChat.MonobitVoiceBase.OnDestroy ( )
virtual

破棄

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

Here is the call graph for this function:

virtual void MonobitEngine.VoiceChat.MonobitVoiceBase.OnEndDecode ( bool  success)
virtual

ボイスデータ再生後処理

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

virtual void MonobitEngine.VoiceChat.MonobitVoiceBase.OnEndEncode ( )
virtual

エンコード後処理

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

virtual bool MonobitEngine.VoiceChat.MonobitVoiceBase.OnPreDecode ( float[]  decodeVoice,
int  channels,
int  samplingRate 
)
virtual

ボイスデータ再生前処理

Parameters
decodeVoiceCodecでデコードされたボイスデータ
channelsチャンネル数
samplingRateサンプリングレート
Returns
trueなら成功

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

virtual bool MonobitEngine.VoiceChat.MonobitVoiceBase.OnPreEncode ( float[]  voice,
int  channels,
int  samplingRate 
)
virtual

エンコード前のボイスの加工処理

Parameters
voiceボイスデータ
channelsチャンネル数
samplingRateサンプリングレート
Returns
trueなら成功

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

virtual void MonobitEngine.VoiceChat.MonobitVoiceBase.OnSendVoice ( bool  debugMode,
object[]  header,
byte[]  voice,
int  voice_size 
)
virtual

エンコードボイスデータ送信デリゲート

Parameters
debugModetrueの場合、送信する音声が自分にも返ってくる
headerヘッダー
voice音声データ

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

void MonobitEngine.VoiceChat.MonobitVoiceBase.PauseVoice ( )

再生を一時停止する

Here is the call graph for this function:

void MonobitEngine.VoiceChat.MonobitVoiceBase.PlaybackVoice ( )

PlaybackVoiceDataでdelay_playback = false設定した後に任意で再生する

Here is the call graph for this function:

void MonobitEngine.VoiceChat.MonobitVoiceBase.PlaybackVoiceData ( object[]  parameters,
byte[]  voice,
int  voice_size,
bool  unreliable = false,
bool  delay_playback = false,
bool  ignore_allow_lag = false 
)

ボイスデータの再生

virtual void MonobitEngine.VoiceChat.MonobitVoiceBase.Start ( )
virtual

コンポーネントの開始

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

void MonobitEngine.VoiceChat.MonobitVoiceBase.StopVoice ( )

再生を停止する

Here is the call graph for this function:

virtual void MonobitEngine.VoiceChat.MonobitVoiceBase.Update ( )
virtual

更新

Reimplemented in MonobitEngine.VoiceChat.MonobitVoice.

void MonobitEngine.VoiceChat.MonobitVoiceBase.UpdateChatState ( )

チャット状態を更新する

MonobitViewがローカルプレイヤーの場合はチャット状態を維持する ローカルプレイヤーでなくなった場合はチャット状態を終了させる

Here is the call graph for this function:

Member Data Documentation

Codec.Opus.Application MonobitEngine.VoiceChat.MonobitVoiceBase.m_Application = Codec.Opus.Application.VoIP
protected

コーデックのアプリケーション設定

OpusBandwidth MonobitEngine.VoiceChat.MonobitVoiceBase.m_bandWidth = OpusBandwidth.WideBand
protected

帯域設定

int MonobitEngine.VoiceChat.MonobitVoiceBase.m_complexity = 10
protected

エンコード品質

CompressedBitRatePreset MonobitEngine.VoiceChat.MonobitVoiceBase.m_compressedBitRatePreset = CompressedBitRatePreset.VoipLow
protected

圧縮ビットレートのプリセット

bool MonobitEngine.VoiceChat.MonobitVoiceBase.m_DebugMode = false
protected

デバッグモード

DecodeSamplingRatePreset MonobitEngine.VoiceChat.MonobitVoiceBase.m_decodeSamplingRatePreset = DecodeSamplingRatePreset.Preset_16000Hz
protected

デコード用のサンプリングレートのプリセット

EncodeMode MonobitEngine.VoiceChat.MonobitVoiceBase.m_EncodeMode = EncodeMode.VBR
protected

VBRか判定

int MonobitEngine.VoiceChat.MonobitVoiceBase.m_encodeSamplingRate = 16000
protected

サンプリングレート

bool MonobitEngine.VoiceChat.MonobitVoiceBase.m_Encrypt = false
protected

暗号化

FrameSizeMs MonobitEngine.VoiceChat.MonobitVoiceBase.m_FrameSizeMs = FrameSizeMs.FrameSize40ms
protected

録音時間

MonobitMicrophone MonobitEngine.VoiceChat.MonobitVoiceBase.m_microphone = null
protected

マイクコンポーネント

int MonobitEngine.VoiceChat.MonobitVoiceBase.m_nCompressedBitRate = 32000
protected

圧縮ビットレート

OpusSignal MonobitEngine.VoiceChat.MonobitVoiceBase.m_OpusSignal = OpusSignal.Voice
protected

コーデックのシグナル設定

bool MonobitEngine.VoiceChat.MonobitVoiceBase.m_PlaybackVoiceLocalNoCheck = false

再生ボイスデータのローカルチェックの無効化

通常、MonobitVoiceの「Debug Mode」がON場合には自分自身の音声が聞こえるようになりますが、 その場合でもエディターよりPlaybackVoiceLocalNoCheckのトグルをON/OFFすることで音声のON/OFFができます。

MonobitStreamingPlayer MonobitEngine.VoiceChat.MonobitVoiceBase.m_player = null
protected

スピーカーコンポーネント

bool MonobitEngine.VoiceChat.MonobitVoiceBase.m_ReliableMode = true
protected

UDPモード

UInt32 MonobitEngine.VoiceChat.MonobitVoiceBase.m_requireIndex = 0
protected

シーケンス番号

SampligRatePreset MonobitEngine.VoiceChat.MonobitVoiceBase.m_samplingRatePreset = SampligRatePreset.Medium
protected

サンプリングレートのプリセット

bool MonobitEngine.VoiceChat.MonobitVoiceBase.m_ShowVoiceDataBps = false

音声データのbps表示モード

bool MonobitEngine.VoiceChat.MonobitVoiceBase.m_Surround3D = false
protected

3Dサラウンド設定

int MonobitEngine.VoiceChat.MonobitVoiceBase.m_TalkingThreshold = -30
protected

無音検出閾値

int MonobitEngine.VoiceChat.MonobitVoiceBase.m_VADLatitude = 5
protected

無音検知幅

bool MonobitEngine.VoiceChat.MonobitVoiceBase.m_VoiceActivityDetector = false
protected

無音検出をするかどうか

Property Documentation

Codec.Opus.Application MonobitEngine.VoiceChat.MonobitVoiceBase.Application
getset

コーデックのアプリケーション設定

int MonobitEngine.VoiceChat.MonobitVoiceBase.Complexity
getset

エンコード品質

int MonobitEngine.VoiceChat.MonobitVoiceBase.CompressedBitRate
getset

圧縮ビットレート

CompressedBitRatePreset MonobitEngine.VoiceChat.MonobitVoiceBase.CompressedBitRatePreset
getset

圧縮ビットレートのプリセット

Hashtable MonobitEngine.VoiceChat.MonobitVoiceBase.customProperties
getsetprotected

カスタムプロパティ

bool MonobitEngine.VoiceChat.MonobitVoiceBase.DebugMode
getset

デバッグモード

DecodeSamplingRatePreset MonobitEngine.VoiceChat.MonobitVoiceBase.DecodeSamplingRatePreset
getset

デコード用のサンプリングレートのプリセット

EncodeMode MonobitEngine.VoiceChat.MonobitVoiceBase.EncodeMode
getset

VBRか判定

int MonobitEngine.VoiceChat.MonobitVoiceBase.EncodeSamplingRate
getset

サンプリングレート

bool MonobitEngine.VoiceChat.MonobitVoiceBase.Encrypt
getset

暗号化

FrameSizeMs MonobitEngine.VoiceChat.MonobitVoiceBase.FrameSizeMs
getset

録音時間

bool MonobitEngine.VoiceChat.MonobitVoiceBase.isDecoderStarting
get

デコーダーの開始フラグ

bool MonobitEngine.VoiceChat.MonobitVoiceBase.isLocal
get

MonobitViewがローカルプレイヤーか判定する

bool MonobitEngine.VoiceChat.MonobitVoiceBase.isLocalPlayer
getprotected

ローカルプレイヤー

MonobitMicrophone MonobitEngine.VoiceChat.MonobitVoiceBase.Microphone
get

マイクコンポーネント

OpusBandwidth MonobitEngine.VoiceChat.MonobitVoiceBase.OpusBandwidth
getset

帯域設定

OpusCodec MonobitEngine.VoiceChat.MonobitVoiceBase.OpusCodec
get

Opusコーデック設定

OpusSignal MonobitEngine.VoiceChat.MonobitVoiceBase.OpusSignal
getset

コーデックのシグナル設定

bool MonobitEngine.VoiceChat.MonobitVoiceBase.PlaybackVoiceLocalNoCheck
getset

再生ボイスデータのローカルチェックの無効化

通常、MonobitVoiceの「Debug Mode」がON場合には自分自身の音声が聞こえるようになりますが、 その場合でもエディターよりPlaybackVoiceLocalNoCheckのトグルをON/OFFすることで音声のON/OFFができます。

bool MonobitEngine.VoiceChat.MonobitVoiceBase.ReliableMode
getset

UDPモード

long MonobitEngine.VoiceChat.MonobitVoiceBase.RemainSamples
get

残りサンプル数の取得

double MonobitEngine.VoiceChat.MonobitVoiceBase.RemainTime
get

残り再生時間の取得

SampligRatePreset MonobitEngine.VoiceChat.MonobitVoiceBase.SampligRatePreset
getset

サンプリングレートのプリセット

bool MonobitEngine.VoiceChat.MonobitVoiceBase.ShowVoiceDataBps
getset

音声データのbps表示モード

MonobitStreamingPlayer MonobitEngine.VoiceChat.MonobitVoiceBase.StreamingPlayer
get

スピーカーコンポーネント

bool MonobitEngine.VoiceChat.MonobitVoiceBase.Surround3D
getset

3Dサラウンド設定

int MonobitEngine.VoiceChat.MonobitVoiceBase.TalkingThreshold
getset

無音検出閾値

Int64 MonobitEngine.VoiceChat.MonobitVoiceBase.TotalWriteSample
get

総書き込みサンプル数

bool MonobitEngine.VoiceChat.MonobitVoiceBase.VAD
getset

無音検出をするかどうか

int MonobitEngine.VoiceChat.MonobitVoiceBase.VADLatitude
getset

無音検知幅

ushort MonobitEngine.VoiceChat.MonobitVoiceBase.Version
get

バージョン番号


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