Version

menu_open

Managing Receiving Streams

Set the mapping between a Wwise game object ID and a user’s GME user ID.

  • To receive an individual voice stream specified by userID, configure the gameObjectID and the userID to bind together.

  • To receive a mix of all voice streams within the current room, do not set a mapping (there is no need to call this function). If a mapping to a gameObjectID was previously set, clear it by setting the userID to NULL or “” (empty string).

/**
* @brief Set the mapping between a Wwise game object ID and a GME user ID
*	corresponding to a user. A mapping between gameObjectID and userID is used
*	by GME to decide whether a GME Receive plug-in instance should play a
*	specific userID or, if there is no mapping, the mix of all voice streams within
*	the currently set roomID.
* @param[in] gameObjectID The gameObjectID allocated in the game.
* @param[in] userID The user ID of the GME user. Passing NULL or “” (empty string)
*	clears a previously set mapping.
*/
void GMEWWisePlugin_ReceivePlugin_SetReceiveOpenIDWithGameObjectID(
AkUInt64 gameObjectID,
const char* userID
);
/**
* @brief Get the mapping between a Wwise game object ID and a GME user ID
*	corresponding to a user.
* @param[in] gameObjectID The gameObjectID allocated in the game.
* @param[out] userID User-allocated character buffer of maximum size specified by maxlen.
*	The userID mapped to the gameObjectID will be copied to the buffer if one exists.
* @param[in] maxlen The maximum size of the character buffer userID.
*/
void GMEWWisePlugin_ReceivePlugin_GetReceiveOpenIDWithGameObjectID(
AkUInt64 gameObjectID,
char* userID,
int maxlen
);
/**
* @brief Get real-time level of a receiving voice stream specified by the targetID.
* @param[in] targetID The identifier of the GME user.
* @return Normalized level values from 0 to 100.
*/
int GMEWWisePlugin_GetAudioRecvStreamLevel(const char* targetID);

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise