RemoteVoiceInfo Class Reference

Information about a remote voice (incoming stream). More...

Inheritance diagram for RemoteVoiceInfo:

Collaboration diagram for RemoteVoiceInfo:

Public Member Functions
	RemoteVoiceInfo (int channelId, int playerId, nByte voiceId, VoiceInfo info)
const VoiceInfo &	getInfo (void) const
	Remote voice info. More...
int	getChannelId (void) const
	ID of channel used for transmission. More...
int	getPlayerId (void) const
	Player ID of voice owner. More...
nByte	getVoiceId (void) const
	Voice ID (unique in the room). More...
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

Detailed Description

Information about a remote voice (incoming stream).

Member Function Documentation

getInfo()

const VoiceInfo & getInfo

(

void

)

const

Remote voice info.

getChannelId()

int getChannelId

(

void

)

const

ID of channel used for transmission.

getPlayerId()

int getPlayerId

(

void

)

const

Player ID of voice owner.

getVoiceId()

nByte getVoiceId

(

void

)

const

Voice ID (unique in the room).

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