LocalVoice Class Reference

Represents outgoing data stream. More...

Inheritance diagram for LocalVoice:

Collaboration diagram for LocalVoice:

Public Member Functions
void	removeSelf (void)
	Remove this voice from it's VoiceClient (using VoiceClient.RemoveLocalVoice More...
nByte	getId (void) const
int	getChannelId (void) const
const VoiceInfo &	getInfo (void) const
	Returns Info structure assigned on local voice cration. More...
nByte	getEvNumber (void) const
bool	getReliable (void) const
	Send data reliable. More...
void	setReliable (bool reliable)
bool	getEncrypt (void) const
	Send data encrypted. More...
void	setEncrypt (bool encrypt)
nByte	getInterestGroup (void) const
	If InterestGroup != 0, voice's data is sent only to clients listening to this group. More...
void	setInterestGroup (nByte group)
bool	getTransmitEnabled (void) const
void	setTransmitEnabled (bool transmitEnabled)
bool	getIsCurrentlyTransmitting (void) const
	Returns true if stream broadcasts. More...
int	getFramesSent (void) const
	Sent frames counter. More...
int	getFramesSentBytes (void) const
	Sent frames bytes counter. More...
bool	getDebugEchoMode (void) const
	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...
void	setDebugEchoMode (bool debugEchoMode)
const ILogger &	getLogger (void) const
Common::JString	getName (void) const
Common::JString	getLogPrefix (void) const
virtual Common::JString &	toString (Common::JString &retStr, bool withTypes=false) const
virtual JString &	toString (JString &retStr, bool withTypes=false) const=0
JString	toString (bool withTypes=false) const
Public Member Functions inherited from ToString
virtual	~ToString (void)
virtual JString	typeToString (void) const
JString	toString (bool withTypes=false) const

Static Public Attributes
static const int	DATA_POOL_CAPACITY

Detailed Description

Represents outgoing data stream.

Member Function Documentation

removeSelf()

void removeSelf

(

void

)

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

.

getInfo()

const VoiceInfo & getInfo

(

void

)

const

Returns Info structure assigned on local voice cration.

getReliable()

bool getReliable

(

void

)

const

Send data reliable.

getEncrypt()

bool getEncrypt

(

void

)

const

Send data encrypted.

getInterestGroup()

nByte getInterestGroup

(

void

)

const

If InterestGroup != 0, voice's data is sent only to clients listening to this group.

getIsCurrentlyTransmitting()

bool getIsCurrentlyTransmitting

(

void

)

const

Returns true if stream broadcasts.

getFramesSent()

int getFramesSent

(

void

)

const

Sent frames counter.

getFramesSentBytes()

int getFramesSentBytes

(

void

)

const

Sent frames bytes counter.

getDebugEchoMode()

bool getDebugEchoMode

(

void

)

const

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.

toString() [1/3]

JString & toString ( Common::JString &  retStr, bool  withTypes = false  ) const

virtual

Remarks

The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.

Parameters

retStr	reference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypes	set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

Implements ToString.

toString() [2/3]

toString

Remarks

The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.

Parameters

retStr	reference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypes	set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

toString() [3/3]

JString toString

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

withTypes

set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

See also

JString