Version

menu_open

General Settings

/**
* @brief Set the local user ID for the local user. Each GME user must have a unique identifier.
*	This function must be called before posting events sending or receiving to 
*	GME servers.
* @param[in] userID The identifier of the local GME user.
*	The value is a 64-bit integer data and should be greater than 0. It needs to be
*	converted into character type.
* @return Code to indicate if UserID is a valid value.
*	0: UserID is set successfully.
*	-1: NULL or empty string, -2: non-digit character, -3: not greater than 0
*/
int GMEWWisePlugin_SetUserID(const char* userID);
/**
* @brief Set the GME chat room ID.
*	This function must be called before posting events sending or receiving to 
*	GME servers.
*	Setting a new roomID will not affect already playing voices.
* @param[in] roomID Alphanumeric character string of up to 127 characters identifying a 
*	GME chatting room.
* @return Code to indicate if UserID is a valid value.
*	0: RoomID is set successfully.
*	-1: NULL or empty string
*/
int GMEWWisePlugin_SetRoomID(const char* roomID);
/**
* @brief Set the level of logging for the GME SDK library.
*	For log files, default values are GMESDK_LOGLEVEL_INFO in debug builds and
*	GMESDK_LOGLEVEL_ERROR in release builds.
*	For console print, default values are GMESDK_LOGLEVEL_INFO in debug builds and
*	GMESDK_LOGLEVEL_NONE in release builds.
* @param[in] levelWrite Logging level for saved log file.
* @param[in] levelPrint Logging level for console printing.
* @sa GMEWWisePlugin_LogLevel
*/
void GMEWWisePlugin_SetLogLevel(
	GMEWWisePlugin_LogLevel levelWrite
GMEWWisePlugin_LogLevel levelPrint
);
/**
* @brief When Bluetooth headset is connected, use headset mic or use device mic,
*	this API is only for the mobile device.
* @param[in] enable Ture means use headset mic, false means use device mic.
*/
void GMEWWisePlugin_EnableBluetoothMic(bool enable);
/**
* @brief Set audio profile of the chat room
* @param[in] profile The room type profile index
*      STREAMPROFILE_LOW_LATENCY: Smooth sound quality and ultra-low delay, 
*			which is suitable for group chat in games like FPS and MOBA games.
*      STREAMPROFILE_STANDARD: Good sound quality and acceptable delay, 
*			which is suitable for voice chat scenarios in casual games like Werewolf and board games.
*      STREAMPROFILE_HD: HD sound quality and relative high delay, 
*			which is suitable for scenarios demanding high sound quality such as music playback and online karaoke.
*/
void GMEWWisePlugin_SetAudioStreamProfile(GMEWWisePlugin_STREAMPROIFLE profile);
/**
* @brief Get GME specific messages.
* @param[out] localUTCTime Unix time of the message.
* @param[out] messageType Message type, ref to the following detailed description.
* @param[out] code Message code according to the message type, ref to the 
*	following detailed description.
* @param[out] message1 Content of Message1
* @param[in] len1 Length of the message1 array.
* @param[out] message2 Content of Message2
* @param[in] len2 Length of the message2 array.
* @return Flag to indicate if there are any new messages. 
*	0: There are new messages to be received.
*	1: No messages to be received.
*/
int GMEWWisePlugin_GetMessage(
int* localUTCTime,
int* messageType,
int* code,
char* message1,
int len1,
char* message2,
int len2
);
/**
* @brief Pauses GME audio capture and playback while maintaining connection to server and chat room status.
*/
void GMEWWisePlugin_Pause();
/**
* @brief Resumes GME audio capture and playback.
*/
void GMEWWisePlugin_Resume();
/**
* @brief Get version information of GME plugin lib
* @return GME plugin version.
*/
const char* GMEWWisePlugin_GetVersion();

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