Version

menu_open

Server Audio Route

Control which users send or receive in the chat room.

/**
* @brief Set voice routing rules to the server. Setting is only valid for players in the same chat room.
*	The available routing type(same definition for sending and receiving) are as follows,
*		GMESDK_AUDIO_ROUTE_RULE_NONE: local voice is not sent to any one or not any voices are received.
*		GMESDK_AUDIO_ROUTE_RULE_ALL: default setting, local voice is sent to everyone or all voices are received.
*		GMESDK_AUDIO_ROUTE_RULE_BLOCKLIST: block list that local voice is not sent to or that the voices are not received from.
*		GMESDK_AUDIO_ROUTE_RULE_ALLOWLIST: allow list that local voice is sent to or that the voices are receied from.
*	If routing type is set to NONE or ALL, the send_list and recv_list are ignored.
*	If routing type is set to BLOCKLIST or ALLOWLIST, the corresponding send_list or recv_list must be set.
*	The maximun size of the send_list and recv_list is 10.		
* @param[in] sendType The routing type for sending voice to other players
* @param[in] sendList The blocklist/allowlist(depends on the routing type) array for sending voice to other players
*	The users in the list should be separated by comma in the array. For example "userID_1,userID_2,...,userID_k"  
* @param[in] recvType The routing type for receiving voice from other players
* @param[in] recvList The blocklist/allowlist(depends on the routing type) array for receiving voice from other players
*	The users in the list should be separated by comma in the array. For example "userID_1,userID_2,...,userID_k"
* @return Code to indicate if operation is correct.
*/
int GMEWWisePlugin_SetServerAudioRoute(int sendType, const char* sendList, int recvType, const char* recvList);
        
/**
* @brief Get voice routing rules from the server. Only in a chat room can this API call be valid. 
* @param[out] sendType The routing type for sending voice to other players
* @param[out] sendListBuf The blocklist/allowlist(depends on the routing type) buffer for sending voice to other players
*	The output sendListBuf is an array for the users in the list separated by comma.
* @param[out] sendListBufLen Length of the sendListBuf array
* @param[out] recvType The routing type for receiving voice from other players
* @param[out] recvListBuf The blocklist/allowlist(depends on the routing type) buffer for receiving voice from other players
*	The output recvListBuf is an array for the users in the list separated by comma.
* @param[out] recvListBufLen Length of the recvListBuf array
* @return Code to indicate if operation is correct.
*/
int GMEWWisePlugin_GetServerAudioRoute(int* sendType, char* sendListBuf, int sendListBufLen, int* recvType, char* recvListBuf, int recvListBufLen);
        

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