CTR Pia  4.11.3
Game Communication Engine
nn::pia::chat Namespace Reference

Represents the PiaChat namespace. More...

Classes

struct  AudioInfo
 Contains audio streaming information. More...
 
class  VoiceProtocol
 Contains member functions that provide voice chat functionality. More...
 

Enumerations

Functions

nn::Result BeginSetup (void)
 Declares the start of setup. More...
 
nn::Result EndSetup (void)
 Declares the end of setup. More...
 
void Finalize (void)
 Finalizes the chat module. This function does nothing and returns if it is called before the Initialize function has been called. More...
 
nn::Result Initialize (void)
 Initializes the chat module. More...
 
bool IsInitialized (void)
 Determines whether the chat module is initialized. More...
 

Detailed Description

Represents the PiaChat namespace.


Revision History:

2015-09-02 Corrected the documentation, which omitted mentioning that ResultInvalidState is returned if Initialize() is called when PiaCommon is not initialized.

2013-04-24 Initial version.

Enumeration Type Documentation

Enumerates audio codecs.

Enumerator
CODEC_8BIT_RAW 

Specifies 8-bit 8 kHz raw audio (unsupported).

CODEC_G711_ULAW 

Specifies G711 u-Law (unsupported).

CODEC_2BIT_ADPCM 

Specifies 2-bit IMA-ADPCM (non-standard format).

CODEC_3BIT_ADPCM 

Specifies 3-bit IMA-ADPCM (unsupported).

CODEC_4BIT_ADPCM 

Specifies 4-bit IMA-ADPCM.

Enumerates the modes of echo cancellation.

Enumerator
EC_STANDARD 

Specifies standard echo cancellation.

EC_HIGHPERFORMANCE 

Specifies advanced echo cancellation (only usable in debug mode).

Function Documentation

nn::Result nn::pia::chat::BeginSetup ( void  )

Declares the start of setup.

Call this function before creating a singleton in the chat module. Always call this function and EndSetup even if your application does not create any singletons in the chat module.

Returns
Returns a Result value indicating success if called at the right time. You must make sure that the implementation of this function in your application does not return any errors.
Error Return Values:

ResultNotInitialized Indicates that the chat::Initialize function has not been called. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Indicates that the function was called at the wrong time. Programming error. Fix your program so that this error is not returned.

See also
EndSetup
nn::Result nn::pia::chat::EndSetup ( void  )

Declares the end of setup.

Call this function after creation of a singleton in the chat module is complete. Calling this function configures memory to be used by the chat module singletons, and optimizes memory management within the library. Always call BeginSetup and this function even if your application does not create any singletons in the chat module.

Returns
Returns a Result value indicating success if called at the right time. You must make sure that the implementation of this function in your application does not return any errors.
Error Return Values:

ResultNotInitialized Indicates that the chat::Initialize function has not been called. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Indicates that the function was called at the wrong time. Programming error. Fix your program so that this error is not returned.

See also
BeginSetup
void nn::pia::chat::Finalize ( void  )

Finalizes the chat module. This function does nothing and returns if it is called before the Initialize function has been called.

See also
IsInitialized, Initialize
nn::Result nn::pia::chat::Initialize ( void  )

Initializes the chat module.

Returns
Returns a Result value indicating success if initialization succeeds. You must make sure that the implementation of this function in your application does not return any errors.
Error Return Values:

ResultAlreadyInitialized Indicates that the chat module is already initialized. Programming error. Fix your program so that this error is not returned.

ResultInvalidState PiaCommon has not been initialized. Programming error. Fix your program so that this error is not returned.

See also
IsInitialized, Finalize
bool nn::pia::chat::IsInitialized ( void  )

Determines whether the chat module is initialized.

This function is thread-safe.

Returns
Returns true if it is initialized, and false otherwise.
See also
Initialize, Finalize