BASS_Encode_ServerKick


Kicks clients from a server.

DWORD BASS_Encode_ServerKick(
    HENCODE handle,
    char *client
);

Parameters

handleThe encoder handle.
clientThe client(s) to kick... "" (empty string) = all clients. Unless a port number is included, this string is compared with the start of the connected clients' IP address.

Return value

If successful, TRUE is returned, else FALSE is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_HANDLEhandle is not valid.
BASS_ERROR_NOTAVAILNo matching clients were found.

Remarks

The clients may not be kicked immediately, but shortly after the call. If the server has been setup with an ENCODECLIENTPROC callback function, that will receive notification of the disconnections.

Example

Kick a client connected from port 1234 at 1.2.3.4.
BASS_Encode_ServerKick(encoder, "1.2.3.4:1234");

Kick all clients connected from 1.2.3.4.

BASS_Encode_ServerKick(encoder, "1.2.3.4:");

See also

BASS_Encode_ServerInit, ENCODECLIENTPROC