CTR Pia
4.11.3
Game Communication Engine
|
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... | |
Represents the PiaChat
namespace.
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.
enum nn::pia::chat::Codec |
Enumerates audio codecs.
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.
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. 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.
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.
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. 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.
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.
nn::Result nn::pia::chat::Initialize | ( | void | ) |
Initializes the chat
module.
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. 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.
bool nn::pia::chat::IsInitialized | ( | void | ) |
Determines whether the chat
module is initialized.
This function is thread-safe.
true
if it is initialized, and false
otherwise.