PartyTextToSpeechProfile::SetCustomContext

Configures an optional, custom pointer-sized context value with this profile.

Syntax

PartyError SetCustomContext(  
    void* customContext  
)  

Parameters

customContext   void*
optional

An arbitrary, pointer-sized value to store with the profile object.

Return value

PartyError

c_partyErrorSuccess if configuring the custom context succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

The custom context is typically used as a "shortcut" that simplifies accessing local, title-specific memory associated with the profile without requiring a mapping lookup. The value is retrieved using the GetCustomContext() method.

Any configured value is treated as opaque by the library, and is only valid on the local device; it is not transmitted over the network.

Requirements

Header: Party.h

See also

PartyTextToSpeechProfile
PartyTextToSpeechProfile::GetCustomContext