EvoVoIP.h File Reference

EVO_Admin_SetChannelAudioFolder

WM_EVOVOIP_AUDIOFILE_STATUS

typedef enum _AudioFileStatus AudioFileStatus

Status messages for audio files being written to disk.

See also:: AudioFile

typedef struct _BannedUser BannedUser

A struct to hold a banned user. This structure is use by EVO_Admin_GetBannedUsers

See also:: EVO_Admin_GetBannedUsers

typedef int BOOL

typedef struct _Channel Channel

A struct for holding a channel. This structure is used by both the client and admin. As client the field szPassword will not be filled but instead the bPassword field.

See also:: EVO_Admin_GetChannel
EVO_GetChannel

typedef struct _FileInfo FileInfo

A struct for holding information about a file.

See also:: EVO_GetChannelFileInfo
EVO_Admin_GetChannelFileInfo

typedef struct _FileTransfer FileTransfer

A struct for holding a file transfer's information.

See also:: EVO_GetFileTransferInfo
EVO_Admin_GetFileTransferInfo

typedef int INT32

typedef long long INT64

typedef void* LPVOID

typedef int* PINT32

typedef enum _PlaybackMode PlaybackMode

An enum for the different playback modes.

Mode PLAYBACKMODE_STABLE allows playback to buffer audio and only starts skipping packets if the buffer holds more than 10 packets. Mode PLAYBACKMODE_LOWLATENCY tries to keep the buffer below 2 packets after which it will start skipping packets. Mode PLAYBACKMODE_VARIABLE changes the sample rate of playback in order to ensure low lantency. Mode PLAYBACKMODE_JITTER uses a jitter buffer for keeping low latency.

See also:: EVO_SetPlaybackMode
EVO_GetPlaybackMode

typedef void* PVOID

typedef struct _ServerProperties ServerProperties

A struct for holding information about a server. This structure is only used by the admin.

See also:: EVO_Admin_GetServerProperties

typedef struct _SoundDevice SoundDevice

An available sound device for either playback or recording. Use nDeviceID to pass to EVO_LaunchSoundSystem as either nInputDeviceID or nOutputDeviceID.

See also:

EVO_GetInputDevice

EVO_GetInputDevicesCount

EVO_GetOutputDevice

EVO_GetOutputDevicesCount

EVO_LaunchSoundSystem

typedef enum _SoundSystem SoundSystem

Which sound system to use. DirectSound is HIGHLY recommended on Windows.

See also:: EVO_LaunchSoundSystem

typedef enum _Subscriptions Subscriptions

Events and/or data users can subscribe to.

See also:

EVO_DoUserSubscribe

EVO_DoUserUnsubscribe

EVO_Admin_DoUserSubscribe

EVO_Admin_DoUnsubscribe

EVO_Admin_DoUserUnsubscribe

typedef void TalkingCallback(INT32 nUserID, INT32 nSampleRate, const short *pRawAudio, INT32 nSamples, PVOID pUserData)

Install a test hook so the HWND will be messaged when a key or mouse button is pressed. Capture the message WM_EVOVOIP_KEYTEST.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	hWnd	is the handle of the window which will be notified.

See also:: EVO_RemoveTestHook
WM_EVOVOIP_KEYTEST A function pointer for callbacks when a user is talking. The user's raw audio can be extracted and stored on disk.

Parameters:

	nUserID	The ID of the user who is talking. Note that nUserID will be 0 for yourself while unconnected.
	nSampleRate	The frequency/sample rate of the user's audio.
	pRawAudio	Array pointer to the user's raw audio. If pRawAudio is NULL it means that the user stopped talking.
	nSamples	The number of samples in the pRawAudio array. If nSamples is 0 it means that the user stopped talking.
	pUserData	User data.

typedef char TTCHAR

OS specific types.

typedef struct _TTMessage TTMessage

A struct for holding an event which can be retrieved by called EVO_GetMessage or EVO_Admin_GetMessage. This struct is only required on non-Windows systems.

typedef unsigned int UINT

typedef struct _User User

A struct for holding a user's information. This structure is used by both the client and admin.

See also:: EVO_GetUser
EVO_Admin_GetUser

Enumeration Type Documentation

enum _AudioFileStatus

Status messages for audio files being written to disk.

See also:: AudioFile

Enumerator:

AFS_WAV_ERROR
AFS_WAV_STARTED
AFS_WAV_FINISHED
AFS_ENCODING_ERROR
AFS_ENCODING_BEGIN
AFS_ENCODING_FINISHED

enum _PlaybackMode

An enum for the different playback modes.

Mode PLAYBACKMODE_STABLE allows playback to buffer audio and only starts skipping packets if the buffer holds more than 10 packets. Mode PLAYBACKMODE_LOWLATENCY tries to keep the buffer below 2 packets after which it will start skipping packets. Mode PLAYBACKMODE_VARIABLE changes the sample rate of playback in order to ensure low lantency. Mode PLAYBACKMODE_JITTER uses a jitter buffer for keeping low latency.

See also:: EVO_SetPlaybackMode
EVO_GetPlaybackMode

Enumerator:

PLAYBACKMODE_STABLE
PLAYBACKMODE_LOWLATENCY
PLAYBACKMODE_VARIABLE
PLAYBACKMODE_JITTER

enum _SoundSystem

Which sound system to use. DirectSound is HIGHLY recommended on Windows.

See also:: EVO_LaunchSoundSystem

Enumerator:

SOUNDSYSTEM_NOSOUND
SOUNDSYSTEM_WINMM
SOUNDSYSTEM_DSOUND
SOUNDSYSTEM_ALSA

enum _Subscriptions

Events and/or data users can subscribe to.

See also:

EVO_DoUserSubscribe

EVO_DoUserUnsubscribe

EVO_Admin_DoUserSubscribe

EVO_Admin_DoUnsubscribe

EVO_Admin_DoUserUnsubscribe

Enumerator:

SUBSCRIBE_NONE
SUBSCRIBE_AUDIO
SUBSCRIBE_USER_MSG
SUBSCRIBE_CHANNEL_MSG
SUBSCRIBE_BROADCAST_MSG
SUBSCRIBE_ALL

Function Documentation

EVOVOIPDLL_API BOOL EVO_Admin_CancelFileTranfer	(	IN LPVOID	pAdminInstance,
		IN INT32	nTransferID
	)

Cancel an active file transfer. An active file transfer is one which has been post through the message WM_EVOVOIP_TRANSFER_BEGIN.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nTransferID	The ID of the file transfer to investigate. Transfer ID is passed by WM_EVOVOIP_TRANSFER_BEGIN.

EVOVOIPDLL_API BOOL EVO_Admin_Close ( IN LPVOID pAdminInstance )

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

EVOVOIPDLL_API BOOL EVO_Admin_Connect	(	IN LPVOID	pAdminInstance,
		IN const TTCHAR *	szHostAddress,
		IN INT32	nTcpPort,
		IN INT32	nUdpPort
	)

Connect to a VoIP server.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	szHostAddress	The IP-address or hostname of the VoIP server.
	nTcpPort	The TCP host port of the VoIP server.
	nUdpPort	The UDP port of the VoIP server. Specify this to receive audio though the EVO_Admin_DoSubscribe or EVO_Admin_DoUserSubscribe

See also:

WM_EVOVOIP_CONNECTSUCCESS

WM_EVOVOIP_CONNECTFAILED

EVOVOIPDLL_API BOOL EVO_Admin_Disconnect ( IN LPVOID pAdminInstance )

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

EVOVOIPDLL_API BOOL EVO_Admin_DoBanUser	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID
	)

Issue a ban command on a user in a specific channel. The ban applies to the user's IP-address. Call EVO_Admin_DoKickUser to kick the user off the server.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user to ban.

See also:: EVO_Admin_DoKickUser

EVOVOIPDLL_API BOOL EVO_Admin_DoBroadcastMessage	(	IN LPVOID	pAdminInstance,
		const TTCHAR *	szMessage
	)

Broadcast a message to all authorized users on the server.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	szMessage	The content of the message

EVOVOIPDLL_API BOOL EVO_Admin_DoChannelMessage	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		const TTCHAR *	szMessage
	)

Send a text-message to a channel.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	The ID of the channel
	szMessage	The content of the message

EVOVOIPDLL_API BOOL EVO_Admin_DoCloseStreamFile	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID
	)

Cancel a file which is being streamed to a user.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user.

See also:: EVO_Admin_DoStreamFileToUser

EVOVOIPDLL_API BOOL EVO_Admin_DoDeleteFile	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		IN INT32	nFileID
	)

Delete a file from a channel.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	The ID of the channel where the file is located.
	nFileID	The ID of the file to delete. The ID of the file which is passed by WM_EVOVOIP_ADDFILE.

See also:

EVO_Admin_GetChannelFilesCount

EVO_Admin_GetChannelFileID

EVOVOIPDLL_API BOOL EVO_Admin_DoFileShare	(	IN LPVOID	pAdminInstance,
		IN INT64	nChannelDiskQuota
	)

Set the default disk quota for new channels.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelDiskQuota	The number of bytes which each channel should have by default for file storage.

EVOVOIPDLL_API BOOL EVO_Admin_DoKickUser	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID
	)

Kick user off a server. To ban a user call EVO_Admin_DoBanUser.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user to kick.

See also:: EVO_Admin_DoBanUser

EVOVOIPDLL_API BOOL EVO_Admin_DoListBans ( IN LPVOID pAdminInstance )

Issue a command to the list of users.

This command issues a list command which will notify the HWND passed to EVO_Admin_Init when it's completed by sending the message WM_EVOVOIP_LISTCOMMAND_COMPLETED. Once completed call the function EVO_Admin_GetBannedUsers to get the list of users.

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

See also:

EVO_Admin_Init

WM_EVOVOIP_LISTCOMMAND_COMPLETED

EVO_Admin_GetBannedUsers

EVOVOIPDLL_API BOOL EVO_Admin_DoLogin	(	IN LPVOID	pAdminInstance,
		IN const TTCHAR *	szUsername,
		IN const TTCHAR *	szPasswd,
		IN const TTCHAR *	szNickName
	)

Log on a connected VoIP server. Make sure server has remote administration enabled in the server's config-file.

This function should be called once the WM_EVOVOIP_CONNECTSUCCESS has been sent to the HWND which was passed to the EVO_Admin_Init.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	szUsername	The administrator username.
	szPasswd	The administrator password.
	szNickName	Optional nickname.

See also:: EVO_Admin_Init
WM_EVOVOIP_CONNECTSUCCESS

EVOVOIPDLL_API BOOL EVO_Admin_DoMakeChannel	(	IN LPVOID	pAdminInstance,
		IN const Channel *	lpChanInfo
	)

Make a new channel. The new channel is static by default.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	lpChanInfo	A Channel-structure containing information about the channel being created. The Channel's member "nChannelID" is ignored.

EVOVOIPDLL_API BOOL EVO_Admin_DoMakeOperator	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		IN INT32	nChannelID
	)

Make user operator of a channel.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user to make operator.
	nChannelID	The ID of the channel the user should become operator of.

EVOVOIPDLL_API BOOL EVO_Admin_DoMoveUser	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		IN const TTCHAR *	szDestChannel
	)

Issue command to move a user from one channel to another.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	User to be moved.
	szDestChannel	Channel path of where user should be put into.

See also:: EVO_Admin_DoMoveUserByID

EVOVOIPDLL_API BOOL EVO_Admin_DoMoveUserByID	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		IN INT32	nDestChannelID
	)

Issue command to move a user from one channel to another.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	User to be moved.
	nDestChannelID	ID of channel where user should be move into.

EVOVOIPDLL_API BOOL EVO_Admin_DoQuerySubscribers	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		IN Subscriptions	uSubscriptions
	)

Query a user's subscriptions Result will be posted in WM_EVOVOIP_USER_SUBSCRIBERS_RESULT.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user.
	uSubscriptions	Mask of Subscriptions to unsubscribe.

EVOVOIPDLL_API BOOL EVO_Admin_DoQuit ( IN LPVOID pAdminInstance )

Quit from server.

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

EVOVOIPDLL_API BOOL EVO_Admin_DoRecvFile	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		IN INT32	nFileID,
		IN const TTCHAR *	szLocalFilePath
	)

Download a file from the specified channel.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	ID of the channel to download from.
	nFileID	The ID of the file which is passed by WM_EVOVOIP_ADDFILE.
	szLocalFilePath	The path of where to store the file, e.g. C:.txt.

See also:

EVO_Admin_GetChannelFilesCount

EVO_Admin_GetChannelFileID

EVOVOIPDLL_API BOOL EVO_Admin_DoRemoveChannel	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID
	)

Remove a channel from a server. Note that if there's any users in the channel they will be kicked and subchannels will be deleted as well.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	The ID of the channel to remove.

EVOVOIPDLL_API BOOL EVO_Admin_DoSaveConfig ( IN LPVOID pAdminInstance )

Save the server's current state to its settings file (typically the server's .xml file).

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

EVOVOIPDLL_API BOOL EVO_Admin_DoSendFile	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		IN const TTCHAR *	szLocalFilePath
	)

Send a file to the specified channel. Note that as admin the size of the disk quota does not apply. EVO_Admin_DoUpdateChannel can be used to modify the size of the disk quota of a channel.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	ID of the channel to send to.
	szLocalFilePath	The path of the file to upload, e.g. C:.txt.

See also:: EVO_Admin_UpdateChannel

EVOVOIPDLL_API BOOL EVO_Admin_DoStreamFileToUser	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		IN const TTCHAR *	szFileName,
		IN INT32	nSendSampleRate,
		IN INT32	nQuality
	)

Stream a .wav file to a user. The user must have called DoUserSubscribe on the admin before it's possible to receive the stream.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user.
	szFileName	File path to .wav file.
	nSendSampleRate	The samplerate to use for sending. Either 8000, 16000 or 32000.
	nQuality	The quality to use for the encoder (0-10).

See also:

EVO_DoUserSubscribe

EVO_DoUserUnsubscribe

EVO_Admin_DoCloseStreamFile

WM_EVOVOIP_STREAMFILE_COMPLETED

EVOVOIPDLL_API BOOL EVO_Admin_DoSubscribe	(	IN LPVOID	pAdminInstance,
		IN Subscriptions	uSubscriptions
	)

Subscribe to user events/data. This setting will affect the server globally unlike EVO_Admin_DoUserSubscribe() which only affects a single user.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	uSubscriptions	Union of Subscriptions to subscribe to.

See also:: Subscriptions

EVOVOIPDLL_API BOOL EVO_Admin_DoUnBanUser	(	IN LPVOID	pAdminInstance,
		IN const TTCHAR *	szIpAddress
	)

Unban the user with the specified IP-address.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	szIpAddress	The IP-address to unban.

EVOVOIPDLL_API BOOL EVO_Admin_DoUnsubscribe	(	IN LPVOID	pAdminInstance,
		IN Subscriptions	uSubscriptions
	)

Unsubscribe to user events/data. This setting will affect the server globally unlike EVO_Admin_DoUserUnsubscribe() which only affects a single user.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	uSubscriptions	Union of Subscriptions to unsubscribe.

See also:: Subscriptions

EVOVOIPDLL_API BOOL EVO_Admin_DoUpdateAdmin	(	IN LPVOID	pAdminInstance,
		IN const TTCHAR *	szUsername,
		IN const TTCHAR *	szPassword
	)

Issue command to set a new username and password for the remote administrator. An empty username or password will disable remote logins.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	szUsername	The new username for admin.
	szPassword	The new password for admin.

EVOVOIPDLL_API BOOL EVO_Admin_DoUpdateChannel	(	IN LPVOID	pAdminInstance,
		IN const Channel *	lpChanInfo
	)

Update a channel's properties.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	lpChanInfo	A Channel-structure containing information about the channel being created. The Channel's member "nParentChannelID" and "szName" are ignored.

EVOVOIPDLL_API BOOL EVO_Admin_DoUpdateServer	(	IN LPVOID	pAdminInstance,
		IN const ServerProperties *	lpServerInfo
	)

Update server properties.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	lpServerInfo	A structure holding the information to be set on the server.

EVOVOIPDLL_API BOOL EVO_Admin_DoUserMessage	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		const TTCHAR *	szMessage
	)

Send administrator message to a user. The WM_EVOVOIP_USERMESSAGE will be posted in the client. The user should reply to the admin with EVO_DoUserMessage(.) and the WM_EVOVOIP_USERMESSAGE will be posted in the admin.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The user who should receive the message
	szMessage	The content of the message

See also:

EVO_DoUserMessage

EVO_GetUserMessage

EVO_DoSendChannelMessage

EVOVOIPDLL_API BOOL EVO_Admin_DoUserSubscribe	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		IN Subscriptions	uSubscriptions
	)

Subscribe to user events/data.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user this should affect.
	uSubscriptions	Union of Subscriptions to subscribe to.

See also:: Subscriptions

EVOVOIPDLL_API BOOL EVO_Admin_DoUserUnsubscribe	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		IN Subscriptions	uSubscriptions
	)

Unsubscribe to user events/data. This can be used to ignore messages or voice data from a specific user.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user this should affect.
	uSubscriptions	Mask of Subscriptions to unsubscribe.

See also:: Subscriptions

EVOVOIPDLL_API BOOL EVO_Admin_GetBannedUsers	(	IN LPVOID	pAdminInstance,
		OUT BannedUser *	lpBannedUsers,
		IN INT32	nCount,
		OUT INT32 *	lpnHowMany
	)

Get a list of banned users.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	lpBannedUsers	A preallocated array to hold banned users.
	nCount	The max number of banned users the lpBannedUsers array can hold.
	lpnHowMany	The number of banned users in the list to extract. This parameter can be NULL.

EVOVOIPDLL_API BOOL EVO_Admin_GetBroadcastMessage	(	IN LPVOID	pAdminInstance,
		IN INT32	nMsgID,
		OUT TTCHAR	szContent[EVO_STRLEN]
	)

Get a message which was broadcasted to all users from an administrator. This function will most likely be called as a result of the message WM_EVOVOIP_BROADCASTMESSAGE.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nMsgID	The ID of the message broadcasted.
	szContent	The content of the message broadcasted.

See also:: WM_EVOVOIP_BROADCASTMESSAGE

EVOVOIPDLL_API BOOL EVO_Admin_GetChannel	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		OUT Channel *	lpChannel
	)

Get the channel with a specific ID.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	The ID of the channel to get information about.
	lpChannel	A pointer to a Channel struct which will receive the channel's data.

Returns:: FALSE if unable to retrieve channel otherwise TRUE

EVOVOIPDLL_API BOOL EVO_Admin_GetChannelFileID	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		IN INT32	nFileIndex,
		OUT INT32 *	lpnFileID
	)

Get information about a file in a channel.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	The ID of the channel where the file is located.
	nFileIndex	The index of the file (nFileIndex >= 0 && nFileIndex < EVO_Admin_GetChannelFilesCount).
	lpnFileID	A pointer which will received the ID of the file. Use EVO_Admin_GetChannelFileInfo to get more info.

See also:: EVO_GetChannelFilesCount

EVOVOIPDLL_API BOOL EVO_Admin_GetChannelFileInfo	(	IN LPVOID	pAdminInstance,
		IN INT32	nFileID,
		OUT FileInfo *	lpFileInfo
	)

Get information about a file which can be downloaded.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nFileID	The ID of the file.
	lpFileInfo	A pointer to a FileInfo-struct which will receive file information.

EVOVOIPDLL_API BOOL EVO_Admin_GetChannelFilesCount	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		OUT INT32 *	lpnFilesCount
	)

Get the number of files in the specified channel. Use EVO_Admin_GetChannelFileID to do an index-based sweep of the files in the channel.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	The ID of the channel where the file is located.
	lpnFilesCount	A pointer which will be passed the number of files.

See also:: EVO_Admin_GetChannelFileID

EVOVOIPDLL_API INT32 EVO_Admin_GetChannelID	(	IN LPVOID	pAdminInstance,
		IN const TTCHAR *	szChannelPath
	)

Get the ID of the specified channel

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	szChannelPath	The path of the channel which ID you want to obtain.

Returns:: The channel ID or -1 if the channel doesn't exist.

EVOVOIPDLL_API BOOL EVO_Admin_GetChannelMessage	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		IN INT32	nMsgID,
		OUT INT32 *	lpnFromUserID,
		OUT TTCHAR	szContent[EVO_STRLEN]
	)

Get a channel message.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	the ID of the channel to extract the message.
	nMsgID	the ID of the message to extract.
	lpnFromUserID	The ID of the user who sent the message.
	szContent	The content of the message.

EVOVOIPDLL_API BOOL EVO_Admin_GetChannelPath	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		OUT TTCHAR	szChannelPath[EVO_STRLEN]
	)

Get the channel's path. Channels are separated by '/'

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nChannelID	The channel's ID
	szChannelPath	Will receive the channel's path.

Returns:: Returns TRUE if channel exists.

EVOVOIPDLL_API BOOL EVO_Admin_GetFileShare	(	IN LPVOID	pAdminInstance,
		OUT TTCHAR	szFilesRoot[EVO_STRLEN],
		OUT INT64 *	lpnChannelDiskQuota,
		OUT INT64 *	lpnMaxDiskUsage
	)

Get information the current file share settings.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	szFilesRoot	The location where the server stores its files.
	lpnChannelDiskQuota	The default disk quota of a channel.
	lpnMaxDiskUsage	The server's maximum for file storage.

EVOVOIPDLL_API BOOL EVO_Admin_GetFileTransferInfo	(	IN LPVOID	pAdminInstance,
		IN INT32	nTransferID,
		OUT FileTransfer *	lpTransfer
	)

Get information about an active file transfer. An active file transfer is one which has been post through the message WM_EVOVOIP_TRANSFER_BEGIN.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nTransferID	The ID of the file transfer to investigate. Transfer ID is passed by WM_EVOVOIP_TRANSFER_BEGIN.
	lpTransfer	A pointer to a struct which will receive the file transfer information.

See also:: WM_EVOVOIP_TRANSFER_BEGIN

EVOVOIPDLL_API BOOL EVO_Admin_GetMessage	(	IN LPVOID	pAdminInstance,
		OUT TTMessage *	pMsg,
		IN const INT32 *	pnWaitMs
	)

Event handling on Linux must be processed by calling EVO_GetMessage or EVO_Admin_GetMessage.

On Windows a each client sends its events to a HWND but on Linux event handling has to be done manually by calling this function.

Parameters:

	pAdminInstance	Pointer to client instance created by
	pMsg	Pointer to a TTMessage instance which will hold the events that has occured.
	pnWaitMs	The amount of time to wait for the event. If NULL the function will block forever or until the next event occurs.

Returns:: Returns TRUE if an event has occured otherwise FALSE.

See also:: EVO_GetMessage

EVOVOIPDLL_API INT32 EVO_Admin_GetMyUserID ( IN LPVOID pAdminInstance )

Get the User ID assigned to the administrator login.

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

Returns:: Returns -1 on error.

EVOVOIPDLL_API BOOL EVO_Admin_GetServerProperties	(	IN LPVOID	pAdminInstance,
		OUT ServerProperties *	lpServerInfo
	)

Get the server's settings in a ServerProperties-struct.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	lpServerInfo	Pointer to the struct to hold the ServerProperties.

EVOVOIPDLL_API INT32 EVO_Admin_GetServerTimeout ( IN LPVOID pAdminInstance )

Get the number of seconds the client should allow the server not to respond to keepalive requests

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

Returns:: The number of seconds. On error -1.

EVOVOIPDLL_API INT32 EVO_Admin_GetTcpKeepAliveInterval ( IN LPVOID pAdminInstance )

Gets how often the ping command should be sent to the server

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

Returns:: The number of seconds. On error -1.

EVOVOIPDLL_API BOOL EVO_Admin_GetUser	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		OUT User *	lpUser
	)

Get information about a user.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user to get information about.
	lpUser	A User struct to be filled with user information.

See also:: USERSTATUS_AVAILABLE
USERSTATUS_AWAY

EVOVOIPDLL_API BOOL EVO_Admin_GetUserMessage	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		IN INT32	nMsgID,
		OUT TTCHAR	szContent[EVO_STRLEN]
	)

Get a private message from a user.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user who sent the message.
	nMsgID	The ID of the message to extract.
	szContent	Will receive the content of the message to extract.

EVOVOIPDLL_API BOOL EVO_Admin_Init ( OUT LPVOID * pNewAdminInstance )

Initialize the VoIP administrator module. The administrator module works in similar was as the client by sending message to the HWND which is passed to the function.

Parameters:

pNewAdminInstance

Pointer to a new instance admin instance. Call EVO_Admin_Close to destroy the instance and release its resources.

See also:: EVO_Admin_Close

EVOVOIPDLL_API BOOL EVO_Admin_IsAuthorized ( IN LPVOID pAdminInstance )

Check if admin has performed login and has been authorized.

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

EVOVOIPDLL_API BOOL EVO_Admin_IsChannelOperator	(	IN LPVOID	pAdminInstance,
		IN INT32	nUserID,
		IN INT32	nChannelID
	)

Check wheher a user is operator of a channel.

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nUserID	The ID of the user.
	nChannelID	The ID of the channel.

EVOVOIPDLL_API BOOL EVO_Admin_IsConnected ( IN LPVOID pAdminInstance )

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

EVOVOIPDLL_API BOOL EVO_Admin_IsConnecting ( IN LPVOID pAdminInstance )

Parameters:

pAdminInstance

Pointer to admin instance created by EVO_Admin_Init.

EVOVOIPDLL_API BOOL EVO_Admin_SetChannelAudioFolder	(	IN LPVOID	pAdminInstance,
		IN INT32	nChannelID,
		IN const TTCHAR *	szFolderPath
	)

Set the path of where to store audio from a channel to disk. In order to use the LAME MP3 encoder the file lame_enc.dll must be place in the same directory as the VoIP3.dll file.

See also:: Channel
WM_EVOVOIP_AUDIOFILE_STATUS

EVOVOIPDLL_API BOOL EVO_Admin_SetServerTimeout	(	IN LPVOID	pAdminInstance,
		IN INT32	nTimeoutSec
	)

Set the number of seconds the client should allow the server not to respond to keepalive requests

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nTimeoutSec	Seconds before dropping connection if it hasn't replied

EVOVOIPDLL_API BOOL EVO_Admin_SetTcpKeepAliveInterval	(	IN LPVOID	pAdminInstance,
		IN INT32	nPingIntervalSec
	)

Sets how often the ping command should be sent to the server

Parameters:

	pAdminInstance	Pointer to admin instance created by EVO_Admin_Init.
	nPingIntervalSec	Seconds between issuing the ping-command

EVOVOIPDLL_API BOOL EVO_AutoPositionUsers ( IN LPVOID pClientInstance )

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:: EVO_SetUserPosition

EVOVOIPDLL_API BOOL EVO_CancelFileTranfer	(	IN LPVOID	pClientInstance,
		IN INT32	nTransferID
	)

Cancel an active file transfer. An active file transfer is one which has been post through the message WM_EVOVOIP_TRANSFER_BEGIN.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nTransferID	The ID of the file transfer to investigate. Transfer ID is passed by WM_EVOVOIP_TRANSFER_BEGIN.

EVOVOIPDLL_API BOOL EVO_CloseVoIP ( IN LPVOID pClientInstance )

Close the VoIP client and release its resources. You'll need to call EVO_InitVoIP before you call any of the other EVO_* functions.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:: EVO_InitVoIP

EVOVOIPDLL_API BOOL EVO_Connect	(	IN LPVOID	pClientInstance,
		IN const TTCHAR *	lpszHostAddress,
		IN INT32	nTcpPort,
		IN INT32	nUdpPort,
		IN INT32	nLocalTcpPort,
		IN INT32	nLocalUdpPort
	)

Connect to a server. This is a non-blocking call, the message WM_EVOVOIP_CONNECTSUCCESS will be sent once the connection has been established or WM_EVOVOIP_CONNECTFAILED if connection could not be established. Sound system must be initialized before you connect

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	lpszHostAddress	The IP-address or hostname of the server.
	nTcpPort	The host port of the server (TCP).
	nUdpPort	The sound port of the server (UDP).
	nLocalTcpPort	The local Tcp port which should be used. Setting it to 0 makes Windows select a port number (recommended).
	nLocalUdpPort	The local Udp port which should be used. Setting it to 0 makes Windows select a port number (recommended).

See also:: WM_EVOVOIP_CONNECTSUCCESS
WM_EVOVOIP_CONNECTFAILED

EVOVOIPDLL_API BOOL EVO_Disconnect ( IN LPVOID pClientInstance )

Disconnect from a server.

Remember to disconnect from the server and afterwards shutdown the sound system when you quit your application.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

EVOVOIPDLL_API BOOL EVO_DoChangeNick	(	IN LPVOID	pClientInstance,
		IN const TTCHAR *	lpszNewNick
	)

Change your nick name.

The message WM_EVOVOIP_UPDATEUSER will be posted if the update was successful.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	lpszNewNick	is the new nick name to use.

See also:: WM_EVOVOIP_UPDATEUSER

EVOVOIPDLL_API BOOL EVO_DoChangeStatus	(	IN LPVOID	pClientInstance,
		IN INT32	nStatusMode,
		IN const TTCHAR *	lpszStatusMessage
	)

Change you currect status

The message WM_EVOVOIP_UPDATEUSER will be posted if the update was successful.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nStatusMode	should be 0 for available and 1 for away.
	lpszStatusMessage	The users message associated with the status mode.

See also:

USERSTATUS_AVAILABLE

USERSTATUS_AWAY

WM_EVOVOIP_UPDATEUSER

EVOVOIPDLL_API BOOL EVO_DoChannelMessage	(	IN LPVOID	pClientInstance,
		IN const TTCHAR *	lpszContent
	)

Send a message to the channel you're currently parcipating in. Note that the server supports channel commands which are messages which start with a '/', e.g. /stats.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	lpszContent	is the message. The message can be multi line but should not be longer than EVO_STRLEN - 1 characters.

EVOVOIPDLL_API BOOL EVO_DoChannelOp	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID
	)

Make another user channel operator. Requires that you are channel operator.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	is the user who should become channel operator.

EVOVOIPDLL_API BOOL EVO_DoDeleteFile	(	IN LPVOID	pClientInstance,
		IN INT32	nFileID
	)

Delete a file from a channel. The user must be operator of the channel where the file is located.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nFileID	The ID of the file to delete. The ID of the file which is passed by WM_EVOVOIP_ADDFILE.

See also:

EVO_GetChannelFilesCount

EVO_GetChannelFileID

EVOVOIPDLL_API BOOL EVO_DoJoinChannel	(	IN LPVOID	pClientInstance,
		IN const TTCHAR *	lpszChannelPath,
		IN const TTCHAR *	lpszPassword,
		IN const TTCHAR *	lpszTopic,
		IN const TTCHAR *	lpszOpPassword
	)

EVO_DoJoinChannel(...) is used for joining a channel but also creating a new channel if the server allows it. Whether users should be allowed to create channels can be configured in the server's .xml file. If EVO_DoJoinChannel is being used to join a channel the parameters "lpszTopic" and "lpszOpPassword" are ignored.

When EVO_DoJoinChannel(...) is used to create channels it work a bit like IRC. If you try to join a channel which does not exist it will be created as a new channel. If you are the last user to leave a channel the channel will be removed on the server (unless it's a static channel). In the server's configuration file you can see how to set up static channels and whether users should be allowed to create channels. Subchannels are separated by '/' so to create a channel called "foo" with the password "bar" and the topic "FooBar" you call EVO_DoJoinChannel in the following way: EVO_DoJoinChannel("/foo", "bar", "FooBar").

If the channel is created successfully the message WM_EVOVOIP_ADDCHANNEL will be sent, followed by WM_EVOVOIP_JOINEDCHANNEL.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	lpszChannelPath	The channel to join. Channels are separated by a '/'.
	lpszPassword	The password for the channel to join or for a new channel.
	lpszTopic	A topic that can be set for a new channel. Don't include a topic if the channel already exists.
	lpszOpPassword	The password a user can specify to become channel operator. The password must be sent as a channel message using the prefix "/op".

See also:

EVO_DoChannelMessage

EVO_DoLeaveChannel

WM_EVOVOIP_ADDCHANNEL

WM_EVOVOIP_JOINEDCHANNEL

EVOVOIPDLL_API BOOL EVO_DoJoinChannelByID	(	IN LPVOID	pClientInstance,
		IN INT32	nChannelID,
		IN const TTCHAR *	lpszPassword
	)

This command calls EVO_DoJoinChannel but omits the unnecessary parameters for only joining a channel and not creating a new one.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nChannelID	The ID of the channel to join.
	lpszPassword	The password for the channel to join.

See also:

EVO_DoChannelMessage

EVO_DoLeaveChannel

WM_EVOVOIP_ADDCHANNEL

WM_EVOVOIP_JOINEDCHANNEL

EVOVOIPDLL_API BOOL EVO_DoKickUser	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID
	)

Kick a user from the channel you are currently participating in.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	The ID of the user to kick.

EVOVOIPDLL_API BOOL EVO_DoLeaveChannel ( IN LPVOID pClientInstance )

Leave a channel.

Note that EVO_DoLeaveChannel() doesn't take any parameters since a user can only participate in one channel at the time. If command is successful the message WM_EVOVOIP_REMOVEUSER will be sent.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:

DoJoinChannel

WM_EVOVOIP_REMOVEUSER

WM_EVOVOIP_LEFTCHANNEL

EVOVOIPDLL_API BOOL EVO_DoLogin	(	IN LPVOID	pClientInstance,
		IN const TTCHAR *	lpszNickName,
		IN const TTCHAR *	lpszServerPassword
	)

Logon to a VoIP server.

Once connected to a server call EVO_DoLogin(..) to logon. If the login is successful WM_EVOVOIP_ACCEPTED is posted to your HWND, otherwise WM_EVOVOIP_ERROR. Once logged on you're not in a channel. Call EVO_DoJoinChannel to join a channel.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	lpszNickName	is the nick name to use.
	lpszServerPassword	is the server's password.

See also:

EVO_DoJoinChannel

WM_EVOVOIP_ACCEPTED

WM_EVOVOIP_ERROR

EVOVOIPDLL_API BOOL EVO_DoLogout ( IN LPVOID pClientInstance )

Logout of a server.

If successful the message WM_EVOVOIP_LOGGEDOUT will be posted.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:: WM_EVOVOIP_LOGGEDOUT

EVOVOIPDLL_API BOOL EVO_DoRecvFile	(	IN LPVOID	pClientInstance,
		IN INT32	nFileID,
		IN const TTCHAR *	szLocalFilePath
	)

Download a file from the specified channel. It must be the same channel as the user is currently partipating in.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nFileID	The ID of the file which is passed by WM_EVOVOIP_ADDFILE.
	szLocalFilePath	The path of where to store the file, e.g. C:.txt.

See also:

EVO_GetChannelFilesCount

EVO_GetChannelFileID

EVOVOIPDLL_API BOOL EVO_DoSendFile	(	IN LPVOID	pClientInstance,
		IN const TTCHAR *	szLocalFilePath
	)

Send a file to the specified channel. It must be the same channel as the user is currently partipating in. The file being uploaded must have a file size which is less than the disk quota of the channel, minus the sum of all the files in the channel. The disk quota of a channel can be obtained in the nDiskQuota of the Channel-struct passed to EVO_GetChannel.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	szLocalFilePath	The path of the file to upload, e.g. C:.txt.

See also:: Channel
EVO_GetChannel

EVOVOIPDLL_API BOOL EVO_DoUserMessage	(	IN LPVOID	pClientInstance,
		IN INT32	nToUserID,
		IN const TTCHAR *	lpszContent
	)

Send a private message to a user.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nToUserID	The user who'll receive the message.
	lpszContent	The message can be multi-line (include EOL) but should not be longer than EVO_STRLEN - 1 characters.

EVOVOIPDLL_API BOOL EVO_DoUserSubscribe	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID,
		IN Subscriptions	uSubscriptions
	)

Subscribe to user events/data.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	The ID of the user this should affect.
	uSubscriptions	Union of Subscriptions to subscribe to.

See also:: Subscriptions

EVOVOIPDLL_API BOOL EVO_DoUserUnsubscribe	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID,
		IN Subscriptions	uSubscriptions
	)

Unsubscribe to user events/data. This can be used to ignore messages or voice data from a specific user.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	The ID of the user this should affect.
	uSubscriptions	Union of Subscriptions to unsubscribe.

See also:: Subscriptions

EVOVOIPDLL_API BOOL EVO_EnableAGC	(	IN LPVOID	pClientInstance,
		IN BOOL	bEnable
	)

Enable Automatic Gain Control

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	bEnable	Whether to enable AGC.

EVOVOIPDLL_API BOOL EVO_EnableAutoPositioning	(	IN LPVOID	pClientInstance,
		IN BOOL	bEnable
	)

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	bEnable	TRUE to enable, otherwise FALSE.

See also:: EVO_SetUserPosition

EVOVOIPDLL_API BOOL EVO_EnableDenoising	(	IN LPVOID	pClientInstance,
		IN BOOL	bEnable
	)

Enable denoising of outgoing audio

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	bEnable	TRUE to enable, otherwise FALSE.

See also:: EVO_IsDenoising

EVOVOIPDLL_API BOOL EVO_EnableEchoCancellation	(	IN LPVOID	pClientInstance,
		IN BOOL	bEnable
	)

Enable echo cancellation (experimental). Still not working properly.

Note that it's very CPU intensive.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	bEnable	TRUE to enable, otherwise FALSE.

EVOVOIPDLL_API BOOL EVO_EnableVoiceActivation	(	IN LPVOID	pClientInstance,
		BOOL	bEnable
	)

Enable voice activation.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	bEnable	TRUE to enable, otherwise FALSE.

EVOVOIPDLL_API BOOL EVO_ForwardToAll	(	IN LPVOID	pClientInstance,
		IN BOOL	bForward
	)

When set to true the server will broadcast audio packets instead of the client. Forwarding through the server is enabled by default.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	bForward	TRUE to enable, otherwise FALSE.

EVOVOIPDLL_API BOOL EVO_GetAGCSettings	(	IN LPVOID	pClientInstance,
		IN PINT32	lpnGainLevel,
		OUT PINT32	lpnMaxIncrement,
		OUT PINT32	lpnMaxDecrement,
		OUT PINT32	lpnMaxGain
	)

Get Automatic Gain Control settings.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	lpnGainLevel	A value from 0 to 32768.
	lpnMaxIncrement	Used so volume should not be amplified too quickly (maximal gain increase in dB/second).
	lpnMaxDecrement	Negative value! Used so volume should not be attenuated too quickly (maximal gain decrease in dB/second).
	lpnMaxGain	Ensure volume doesn't become too loud (maximal gain in dB).

See also:: EVO_EnableAGC

EVOVOIPDLL_API BOOL EVO_GetBroadcastMessage	(	IN LPVOID	pClientInstance,
		IN INT32	nMsgID,
		OUT TTCHAR	szContent[EVO_STRLEN]
	)

Get a message which was broadcasted to all users from an administrator. This function will most likely be called as a result of the message WM_EVOVOIP_BROADCASTMESSAGE.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nMsgID	The ID of the message broadcasted.
	szContent	The content of the message broadcasted.

See also:: WM_EVOVOIP_BROADCASTMESSAGE

EVOVOIPDLL_API INT32 EVO_GetBytesReceived ( IN LPVOID pClientInstance )

Get the number of bytes sent. Note that the number of bytes transferred does not include TCP/IP overhead.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

EVOVOIPDLL_API INT32 EVO_GetBytesSent ( IN LPVOID pClientInstance )

Get the number of bytes received. Note that the number of bytes transferred does not include TCP/IP overhead.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

EVOVOIPDLL_API BOOL EVO_GetChannel	(	IN LPVOID	pClientInstance,
		IN INT32	nChannelID,
		OUT Channel *	lpChannel
	)

Get the channel with a specific ID.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nChannelID	The ID of the channel to get information about.
	lpChannel	A pointer to a Channel struct which will receive the channel's data.

Returns:: FALSE if unable to retrieve channel otherwise TRUE

EVOVOIPDLL_API BOOL EVO_GetChannelFileID	(	IN LPVOID	pClientInstance,
		IN INT32	nChannelID,
		IN INT32	nFileIndex,
		OUT INT32 *	lpnFileID
	)

Get information about a file in a channel.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nChannelID	The ID of the channel where the file is located.
	nFileIndex	The index of the file (nFileIndex >= 0 && nFileIndex < EVO_GetChannelFilesCount).
	lpnFileID	A pointer which will received the ID of the file. Use EVO_GetChannelFileInfo to get more info.

See also:: EVO_GetChannelFilesCount

EVOVOIPDLL_API BOOL EVO_GetChannelFileInfo	(	IN LPVOID	pClientInstance,
		IN INT32	nFileID,
		OUT FileInfo *	lpFileInfo
	)

Get information about a file which can be downloaded.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nFileID	The ID of the file.
	lpFileInfo	A pointer to a FileInfo-struct which will receive file information.

EVOVOIPDLL_API BOOL EVO_GetChannelFilesCount	(	IN LPVOID	pClientInstance,
		IN INT32	nChannelID,
		OUT INT32 *	lpnFilesCount
	)

Get the number of files in the specified channel. Use EVO_GetChannelFileID to do an index-based sweep of the files in the channel.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nChannelID	The ID of the channel where the file is located.
	lpnFilesCount	A pointer which will be passed the number of files.

See also:: EVO_GetChannelFileID

EVOVOIPDLL_API BOOL EVO_GetChannelMessage	(	IN LPVOID	pClientInstance,
		IN INT32	nChannelID,
		IN INT32	nMsgID,
		OUT INT32 *	lpnFromUserID,
		OUT TTCHAR	szContent[EVO_STRLEN]
	)

Get a channel message.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nChannelID	the ID of the channel to extract the message.
	nMsgID	the ID of the message to extract.
	lpnFromUserID	The ID of the user who sent the message.
	szContent	The content of the message.

See also:: WM_EVOVOIP_CHANNELMESSAGE

EVOVOIPDLL_API INT32 EVO_GetChannelParentID	(	IN LPVOID	pClientInstance,
		IN INT32	nChannelID
	)

Get the ID of the channel's parent.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nChannelID	The ID of the channel.

Returns:: Returns -1 if there's no parent channel, otherwise the channel's parent ID.

EVOVOIPDLL_API BOOL EVO_GetChannelPath	(	IN LPVOID	pClientInstance,
		IN INT32	nChannelID,
		OUT TTCHAR	szChannelPath[EVO_STRLEN]
	)

Get the channel's path. Channels are separated by '/'

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nChannelID	The channel's ID
	szChannelPath	Will receive the channel's path.

Returns:: Returns TRUE if channel exists.

EVOVOIPDLL_API INT32 EVO_GetChannelUserCount	(	IN LPVOID	pClientInstance,
		IN INT32	nChannelID
	)

Get the number of users in a channel.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nChannelID	is the ID of the channel.

EVOVOIPDLL_API INT32 EVO_GetCurrentInputLevel ( IN LPVOID pClientInstance )

Get the value of the currently recorded audio.

Returns a value between SOUND_VU_MIN and SOUND_VU_MAX

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:: SOUND_VU_MIN
SOUND_VU_MAX

EVOVOIPDLL_API BOOL EVO_GetDefaultDevices	(	IN LPVOID	pClientInstance,
		OUT SoundSystem *	lpnSoundSystem,
		OUT INT32 *	lpnInputDeviceID,
		OUT INT32 *	lpnOutputDeviceID
	)

Get the default audio devices.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	lpnSoundSystem	The default sound system
	lpnInputDeviceID	The ID of the default input device
	lpnOutputDeviceID	The ID of the default output device

See also:: EVO_LaunchSoundSystem

EVOVOIPDLL_API INT32 EVO_GetEncoderComplexity ( IN LPVOID pClientInstance )

Experimental

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

EVOVOIPDLL_API void EVO_GetErrorMessage	(	IN INT32	nError,
		OUT TTCHAR	szErrorMsg[EVO_STRLEN]
	)

Get a description of an error code posted by either WM_EVOVOIP_ERROR or WM_EVOVOIP_TRANSFER_FAILED

Parameters:

	nError	The number of the error.
	szErrorMsg	A text description of the error.

See also:: WM_EVOVOIP_ERROR
WM_EVOVOIP_TRANSFER_FAILED

EVOVOIPDLL_API BOOL EVO_GetFileTransferInfo	(	IN LPVOID	pClientInstance,
		IN INT32	nTransferID,
		OUT FileTransfer *	lpTransfer
	)

Get information about an active file transfer. An active file transfer is one which has been post through the message WM_EVOVOIP_TRANSFER_BEGIN.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nTransferID	The ID of the file transfer to investigate. Transfer ID is passed by WM_EVOVOIP_TRANSFER_BEGIN.
	lpTransfer	A pointer to a struct which will receive the file transfer information.

See also:: WM_EVOVOIP_TRANSFER_BEGIN

EVOVOIPDLL_API BOOL EVO_GetInputDevice	(	IN LPVOID	pClientInstance,
		IN SoundSystem	nSoundSystem,
		IN INT32	nIndex,
		OUT SoundDevice *	pSoundDevice
	)

Get information about an input device. Note that DirectSound is HIGHLY recommended.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nSoundSystem	The sound system to examine. Can be either SOUNDSYSTEM_DSOUND or SOUNDSYSTEM_WINMM
	nIndex	The index of the device to extract.
	pSoundDevice	Struct to hold the sound device's properties. Pass nDeviceID to EVO_LaunchSoundSystem

See also:

EVO_GetInputDevicesCount

EVO_LaunchSoundSystem

EVOVOIPDLL_API INT32 EVO_GetInputDevicesCount	(	IN LPVOID	pClientInstance,
		IN SoundSystem	nSoundSystem
	)

Get the number of input devices.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nSoundSystem	the sound system to examine.

See also:

EVO_GetInputDevice

EVOVOIPDLL_API INT32 EVO_GetMasterVolume ( IN LPVOID pClientInstance )

Get master volume.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:: SOUND_VOLUME_MAX
SOUND_VOLUME_MIN

Returns:: Returns the master volume.

EVOVOIPDLL_API BOOL EVO_GetMessage	(	IN LPVOID	pClientInstance,
		OUT TTMessage *	pMsg,
		IN const INT32 *	pnWaitMs
	)

Event handling on Linux must be processed by calling EVO_GetMessage.

On Windows a each client sends its events to a HWND but on Linux event handling has to be done manually by calling this function.

Parameters:

	pClientInstance	Pointer to client instance created by
	pMsg	Pointer to a TTMessage instance which will hold the events that has occured.
	pnWaitMs	The amount of time to wait for the event. If NULL the function will block forever or until the next event occurs.

Returns:: Returns TRUE if an event has occured otherwise FALSE.

See also:: EVO_Admin_GetMessage

EVOVOIPDLL_API BOOL EVO_GetMessageOfTheDay	(	IN LPVOID	pClientInstance,
		OUT TTCHAR	szMotd[EVO_STRLEN]
	)

Get the server's message of the day (MOTD). Deprecated, use EVO_GetServerProperties.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	szMotd	will receive the MOTD.

See also:: EVO_GetServerProperties

EVOVOIPDLL_API INT32 EVO_GetMyChannelID ( IN LPVOID pClientInstance )

Get the channel current user is participating in.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

Returns:: Returns the ID of the current channel. If 0 is returned the user is not participating in a channel.

EVOVOIPDLL_API INT32 EVO_GetMyUserID ( IN LPVOID pClientInstance )

Get the user's user ID

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

Returns:: Returns the user ID assigned to the current user on the server. -1 is returned if no ID has been assigned to the user.

EVOVOIPDLL_API BOOL EVO_GetOutputDevice	(	IN LPVOID	pClientInstance,
		IN SoundSystem	nSoundSystem,
		IN INT32	nIndex,
		OUT SoundDevice *	pSoundDevice
	)

Get information about an input device.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nSoundSystem	the sound system to examine.
	nIndex	the index of the device to extract.
	pSoundDevice	Struct to hold the sound device's properties. Pass nDeviceID to EVO_LaunchSoundSystem

See also:

EVO_GetOutputDevicesCount

EVOVOIPDLL_API INT32 EVO_GetOutputDevicesCount	(	IN LPVOID	pClientInstance,
		IN SoundSystem	nSoundSystem
	)

Get the number of output devices.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nSoundSystem	the sound system to examine.

See also:

EVO_GetOutputDevice

EVOVOIPDLL_API INT32 EVO_GetPacketSize	(	IN INT32	nRecorderFreq,
		IN INT32	nQuality
	)

Get the number of bytes in a packet with the specified settings.

Parameters:

	nRecorderFreq	Should be either 8000, 16000 or 32000 Hz.
	nQuality	A value between ENC_QUALITY_MIN and ENC_QUALITY_MAX

See also:: ENC_QUALITY_MIN
ENC_QUALITY_MAX

EVOVOIPDLL_API PlaybackMode EVO_GetPlaybackMode ( IN LPVOID pClientInstance )

The currently selected playback mode.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

Returns:: See PlaybackMode enumeration for types of playback

See also:: EVO_SetPlaybackMode
PlaybackMode

EVOVOIPDLL_API INT32 EVO_GetRootChannelID ( IN LPVOID pClientInstance )

Get the root channel's ID

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

Returns:: Returns the ID of the root channel. If -1 is returned no root channel exists.

EVOVOIPDLL_API INT32 EVO_GetSamplesPerPacket	(	IN INT32	nRecorderFreq,
		IN INT32	nQuality
	)

Get the number of samples required for VoIP to send a packet using the specified recorder frequency and quality.

Parameters:

	nRecorderFreq	Should be either 8000, 16000 or 32000 Hz.
	nQuality	A value between ENC_QUALITY_MIN and ENC_QUALITY_MAX

See also:: ENC_QUALITY_MIN
ENC_QUALITY_MAX

EVOVOIPDLL_API BOOL EVO_GetServerName	(	IN LPVOID	pClientInstance,
		OUT TTCHAR	szName[EVO_STRLEN]
	)

Get the server's name. Deprecated, use EVO_GetServerProperties.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	szName	will receive the server's name.

See also:: EVO_GetServerProperties

EVOVOIPDLL_API BOOL EVO_GetServerProperties	(	IN LPVOID	pClientInstance,
		OUT ServerProperties *	lpProperties
	)

Get the server's client properties

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	lpProperties	A struct to hold the server's properties.

EVOVOIPDLL_API INT32 EVO_GetServerTimeout ( IN LPVOID pClientInstance )

Get the number of seconds the client should allow the server not to respond to keepalive requests

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

Returns:: The number of seconds. On error -1.

EVOVOIPDLL_API INT32 EVO_GetTcpKeepAliveInterval ( IN LPVOID pClientInstance )

Gets how often the ping command should be sent to the server

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

Returns:: The number of seconds. On error -1.

EVOVOIPDLL_API BOOL EVO_GetUser	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID,
		OUT User *	lpUser
	)

Get the user with the specified ID.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	the ID of the user to extract.
	lpUser	will receive the user's nick name.

See also:: USERSTATUS_AVAILABLE
USERSTATUS_AWAY

EVOVOIPDLL_API INT32 EVO_GetUserGainLevel	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID
	)

Get the software gain level for a user.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	The ID of the user whose gain level should be retrieved.

See also:

Returns:: The gain level for the user. A value from GAIN_LEVEL_MIN to GAIN_LEVEL_MAX

EVOVOIPDLL_API BOOL EVO_GetUserMessage	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID,
		IN INT32	nMsgID,
		OUT TTCHAR	szContent[EVO_STRLEN]
	)

Get a private message from a user.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	The ID of the user who sent the message.
	nMsgID	The ID of the message to extract.
	szContent	Will receive the content of the message to extract.

EVOVOIPDLL_API BOOL EVO_GetUserPosition	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID,
		OUT float *	x,
		OUT float *	y,
		OUT float *	z
	)

Get a user's position.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	ID of user.
	x	Distance in meters to user (left/right).
	y	Distance in meters to user (back/forward.
	z	Distance in meters to user (up/down).

EVOVOIPDLL_API BOOL EVO_GetUserStereo	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID,
		OUT BOOL *	lpbLeftSpeaker,
		OUT BOOL *	lpbRightSpeaker
	)

Check what speaker a user is outputting to.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	ID of user.
	lpbLeftSpeaker	True if playing in left speaker
	lpbRightSpeaker	True if playing in right speaker

See also:: EVO_SetUserStereo

EVOVOIPDLL_API INT32 EVO_GetUserVolume	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID
	)

Get the volume of a user. Note that it's a virtual volume which is being set since the master volume affects the user volume.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	The ID of the User.

See also:: SOUND_VOLUME_MIN
SOUND_VOLUME_MAX

EVOVOIPDLL_API INT32 EVO_GetVoiceActivationLevel ( IN LPVOID pClientInstance )

Get voice activation level.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

Returns:: Returns a value between SOUND_VU_MIN and SOUND_VU_MAX

See also:: SOUND_VU_MIN
SOUND_VU_MAX

EVOVOIPDLL_API INT32 EVO_GetVoiceGainLevel ( IN LPVOID pClientInstance )

Get voice gain level of outgoing audio

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

Returns:: A value from GAIN_LEVEL_MIN - GAIN_LEVEL_MAX.

See also:: EVO_SetVoiceGainLevel

EVOVOIPDLL_API BOOL EVO_InitVoIP ( OUT LPVOID * pNewClientInstance )

Initialize a new VoIP client. This function must be invoked before any other of the EVO_* functions can be called. Call EVO_CloseVoIP to shutdown the VoIP client and release its resources.

Parameters:

	hWnd	The window handle which will receive the WM_EVOVOIP_* messages.
	bLLMouseHook	Install low-level mouse. When debugging it's best to to disable it otherwise the mouse cursor will be slow.
	pNewClientInstance	Pointer to new a client instance. To destroy the new client instance called EVO_CloseVoIP.

See also:: EVO_CloseVoIP

EVOVOIPDLL_API BOOL EVO_IsAllMute ( IN LPVOID pClientInstance )

Is all users set to mute.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

EVOVOIPDLL_API BOOL EVO_IsAuthorized ( IN LPVOID pClientInstance )

Whether the client is authorized on the server (has received the WM_EVOVOIP_ACCEPTED message). Use EVO_DoLogin(..) to log on to server and EVO_DoLogout() to log out of the server.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:: WM_EVOVOIP_ACCEPTED

EVOVOIPDLL_API BOOL EVO_IsAutoPositioning ( IN LPVOID pClientInstance )

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:: EVO_SetUserPosition

EVOVOIPDLL_API BOOL EVO_IsChannelOperator	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID,
		IN INT32	nChannelID
	)

Check whether user is operator of a channel

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	the ID of the user to check.
	nChannelID	the ID of the channel to check whether user is operator of.

EVOVOIPDLL_API BOOL EVO_IsConnected ( IN LPVOID pClientInstance )

Whether the client is connected to a server.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

EVOVOIPDLL_API BOOL EVO_IsConnecting ( IN LPVOID pClientInstance )

Whether the client is currently connecting to a server.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

EVOVOIPDLL_API BOOL EVO_IsDenoising ( IN LPVOID pClientInstance )

Is denoising outgoing audio

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:: EVO_EnableDenoising

EVOVOIPDLL_API BOOL EVO_IsEchoCancelling ( IN LPVOID pClientInstance )

Whether echo cancellation is active. Default is false.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

EVOVOIPDLL_API BOOL EVO_IsForwardingToAll ( IN LPVOID pClientInstance )

Whether server is broadcasting packets or the client is doing it.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

Returns:: Returns true if the server is forwarding the client's voice packets.

EVOVOIPDLL_API BOOL EVO_IsHotKeyActive	(	IN LPVOID	pClientInstance,
		IN INT32	nHotKeyID
	)

Check whether hotkey is active.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nHotKeyID	is the ID of the registered hotkey.

EVOVOIPDLL_API BOOL EVO_IsSoundSystemInitialized ( IN LPVOID pClientInstance )

Whether sound system has been initialized successfully.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

See also:: EVO_LaunchSoundSystem
EVO_ShutdownSoundSystem

EVOVOIPDLL_API BOOL EVO_IsUserMute	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID
	)

Check if a user is muted.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	ID of user.

See also:: EVO_SetUserMute

EVOVOIPDLL_API BOOL EVO_IsUserTalking	(	IN LPVOID	pClientInstance,
		IN INT32	nUserID
	)

Check if a user is talking.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nUserID	ID of user.

See also:: WM_EVOVOIP_USERTALKING
WM_EVOVOIP_USERSTOPPEDTALKING

EVOVOIPDLL_API BOOL EVO_IsVoiceActivated ( IN LPVOID pClientInstance )

Whether voice activation is enabled.

Parameters:

pClientInstance

Pointer to client instance created by EVO_InitVoIP.

EVOVOIPDLL_API BOOL EVO_LaunchSoundSystem	(	IN LPVOID	pClientInstance,
		IN SoundSystem	nSoundSystem,
		IN INT32	nInputDeviceID,
		IN INT32	nOutputDeviceID,
		IN INT32	nRecorderFreq,
		IN INT32	nQuality,
		IN BOOL	bStereoPlayback
	)

Launch the sound system.

Parameters:

	pClientInstance	Pointer to client instance created by EVO_InitVoIP.
	nSoundSystem	Choose SOUNDSYSTEM_DSOUND for DirectSound and SOUNDSYSTEM_WINMM for Windows sound system. DirectSound is highly recommended on Win32 whereas WinCE only supports Windows sound system (SOUNDSYSTEM_WINMM).
	nInputDeviceID	Should be the device ID extracted through EVO_GetInputDevice. Pass -1 to use the default device.
	nOutputDeviceID	Should be the device ID extracted through EVO_GetOutputDevice. Pass -1 to use the default device.
	nRecorderFreq	The frequency the client's recorder should use. It can either be 8000 Hz, 16000 Hz or 32000 Hz.
	nQuality	is the quality that the client's encoder should use. A value between 1 and 10 is accepted. 4 gives an acceptable voice quality for most use.
	bStereoPlayback	Whether to playback in stereo so EVO_SetUserStereo can be used to either play in left or right speaker. If stereo is enabled 3D-sound will be disabled.

See also: