Photon Voice  v2.8
English | 日本語 | 한국
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
LocalVoice Class Reference

Represents outgoing data stream. More...

Inherits IDisposable.

Inherited by LocalVoiceAudioDummy, and LocalVoiceFramedBase.

Public Member Functions

virtual IEncoder CreateDefaultEncoder (VoiceInfo info)
 
void RemoveSelf ()
 Remove this voice from it's VoiceClient (using VoiceClient.RemoveLocalVoice More...
 
virtual void Dispose ()
 

Public Attributes

const int DATA_POOL_CAPACITY = 50
 

Protected Member Functions

void resetNoTransmitCnt ()
 

Protected Attributes

IEncoder encoder
 
VoiceClient voiceClient
 
volatile bool disposed
 
object disposeLock = new object()
 

Properties

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...
 

Detailed Description

Represents outgoing data stream.

Member Function Documentation

void RemoveSelf ( )

Remove this voice from it's VoiceClient (using VoiceClient.RemoveLocalVoice

.

Property Documentation

bool DebugEchoMode
getset

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.

bool Encrypt
getset

Send data encrypted.

int FramesSent
get

Sent frames counter.

int FramesSentBytes
get

Sent frames bytes counter.

VoiceInfo Info
get

Returns Info structure assigned on local voice cration.

byte InterestGroup
getset

If InterestGroup != 0, voice's data is sent only to clients listening to this group (if supported by transport).

bool IsCurrentlyTransmitting
getprotected set

Returns true if stream broadcasts.

IServiceable LocalUserServiceable
getset

Optional user object attached to LocalVoice. its Service() will be called at each VoiceClient.Service() call.

bool Reliable
getset

Send data reliable.

bool TransmitEnabled
getset

If true, stream data broadcasted.