Photon Voice: LocalVoiceFramedBase Class Reference

Photon Voice

LocalVoiceFramedBase Class Reference

Typed re-framing LocalVoice More...

Inherits LocalVoice.

Inherited by LocalVoiceFramed< T >.

Properties

int FrameSize [get]
 Data flow will be repacked to frames of this size. May differ from input voiceInfo.FrameSize. Processors should resample in this case. More...
 
- Properties inherited from LocalVoice
byte Group [get, set]
 
byte InterestGroup [get, set]
 If InterestGroup != 0, voice's data is sent only to clients listening to this group (if supported by transport). More...
 
VoiceInfo Info [get]
 Returns Info structure assigned on local voice cration. More...
 
bool TransmitEnabled [get, set]
 If true, stream data broadcasted. More...
 
bool IsCurrentlyTransmitting [get, protected set]
 Returns true if stream broadcasts. More...
 
int FramesSent [get]
 Sent frames counter. More...
 
int FramesSentBytes [get]
 Sent frames bytes counter. More...
 
bool Reliable [get, set]
 Send data reliable. More...
 
bool Encrypt [get, set]
 Send data encrypted. More...
 
IServiceable LocalUserServiceable [get, set]
 Optional user object attached to LocalVoice. its Service() will be called at each VoiceClient.Service() call. More...
 
bool DebugEchoMode [get, set]
 If true, outgoing stream routed back to client via server same way as for remote client's streams. Can be swithed any time. OnRemoteVoiceInfoAction and OnRemoteVoiceRemoveAction are triggered if required. This functionality availability depends on transport. More...
 

Additional Inherited Members

- Public Member Functions inherited from LocalVoice
virtual IEncoder CreateDefaultEncoder (VoiceInfo info)
 
void RemoveSelf ()
 Remove this voice from it's VoiceClient (using VoiceClient.RemoveLocalVoice More...
 
virtual void Dispose ()
 
- Public Attributes inherited from LocalVoice
const int DATA_POOL_CAPACITY = 50
 
- Protected Member Functions inherited from LocalVoice
void resetNoTransmitCnt ()
 
- Protected Attributes inherited from LocalVoice
IEncoder encoder
 
VoiceClient voiceClient
 
volatile bool disposed
 
object disposeLock = new object()
 

Detailed Description

Typed re-framing LocalVoice

Base class for typed re-framing LocalVoice implementation (LocalVoiceFramedBase<T>)

Property Documentation

int FrameSize
get

Data flow will be repacked to frames of this size. May differ from input voiceInfo.FrameSize. Processors should resample in this case.

Online Documentation  -  Dashboard  -  Support Forum Exit Games GmbH