BASS.NET API for the Un4seen BASS Audio Library

BassEncBASS_Encode_ServerKick Method

BASS.NET API for the Un4seen BASS Audio Library
Kicks clients from a server.

Namespace:  Un4seen.Bass.AddOn.Enc
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax
Copy
[DllImportAttribute("bassenc")]
public static bool BASS_Encode_ServerKick(
	int handle,
	string client
)

Parameters

handle
Type: SystemInt32
The encoder handle.
client
Type: SystemString
The address of the client(s) to kick... NULL (or empty string) = all clients. This should be an IPv4 or IPv6 address, optionally with a port number or netmask. If a port is not specified then all ports connected from the IP address are kicked. A netmask may be specified in CIDR notation to kick a block of IP addresses.

Return Value

Type: Boolean
If successful, is returned, else is returned. Use BASS_ErrorGetCode to get the error code.
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.

ERROR CODEDescription
BASS_ERROR_HANDLEhandle is not valid.
BASS_ERROR_NOTAVAILNo matching clients were found.

Platform-specific

This function is not available on Windows CE.

See Also

Reference

BassEnc Class
Un4seen.Bass.AddOn.Enc Namespace