Show / Hide Table of Contents

Class BassWinamp

BassWinamp is a BASS addon adding support for Winamp Input plugins.

Inheritance
Object
BassWinamp
Namespace: System.Dynamic.ExpandoObject
Assembly: ManagedBass.Winamp.dll
Syntax
public static class BassWinamp : object
Remarks

BassWinamp doesn't support Bass plugin system.

Properties

InputTimeout

Winamp input timeout (in milliseconds) to wait until timing out, because the plugin is not using the output system.

Declaration
public static int InputTimeout { get; set; }
Property Value
Int32

Methods

AboutPlugin(Int32, IntPtr)

Shows the about dialog of the loaded Winamp input plug-in.

Declaration
public static void AboutPlugin(int Handle, IntPtr Window)
Parameters
Int32 Handle

The handle of the winamp input plugin.

IntPtr Window

The application's main window... = the current foreground window.

ConfigPlugin(Int32, IntPtr)

Shows the configuration dialog of the loaded Winamp input plug-in.

Declaration
public static void ConfigPlugin(int Handle, IntPtr Window)
Parameters
Int32 Handle

The handle of the winamp input plugin.

IntPtr Window

The application's main window... = the current foreground window.

CreateStream(String, BassFlags)

Creates a stream from a Winamp input plug-in.

Declaration
public static int CreateStream(string FileName, BassFlags Flags)
Parameters
String FileName

Filename for which a stream should be created.

BassFlags Flags

Any combination of BassFlags.

Returns
Int32

If successful, the new stream's handle is returned, else 0 is returned. Use LastError to get the error code.

FindPlugins(String, WinampFindPluginFlags)

Gets a list of all winamp input plug-ins in a given directory. CommaList is ignored.

Declaration
public static string[] FindPlugins(string PluginDirectory, WinampFindPluginFlags Flags)
Parameters
String PluginDirectory

The path of the directory to search in.

WinampFindPluginFlags Flags

Any combination of WinampFindPluginFlags.

Returns
String[]

GetExtentions(Int32)

Gets the supported file filter extensions of the given winamp input plug-in.

Declaration
public static string[] GetExtentions(int Handle)
Parameters
Int32 Handle

The handle of the winamp input plugin.

Returns
String[]

Returns a array of strings representing the supported extensions of the winamp input plugin.

GetFileInfo(String, out String, out Int32)

Returns information about a given file.

Declaration
public static bool GetFileInfo(string File, out string Title, out int LengthMs)
Parameters
String File

The name of the file to retrieve the information from.

String Title

Returns the title of the given file.

Int32 LengthMs

Returns the length of the given file in milliseconds.

Returns
Boolean

true if the information was retrieved successfully, else false is returned.

GetName(Int32)

Gets the name of the winamp input plugin.

Declaration
public static string GetName(int Handle)
Parameters
Int32 Handle

The handle of the winamp input plugin.

Returns
String

The name of the plugin, or null if the call failed.

GetUsesOutput(Int32)

Returns weather the Winamp input plugin make use of the winamp output?

Declaration
public static bool GetUsesOutput(int Handle)
Parameters
Int32 Handle

The handle of the winamp input plugin.

Returns
Boolean

true if the input plugin uses output, else false is returned.

GetVersion(Int32)

Gets the version of a loaded Winamp input plug-in.

Declaration
public static int GetVersion(int Handle)
Parameters
Int32 Handle

The handle of the winamp input plugin.

Returns
Int32

The version number. HIWORD = Major, LOWORD = Minor.

InfoDialog(String, IntPtr)

Shows the Winamp input plugin information dialog for a given file (like pressing Alt+3 in Winamp).

Declaration
public static bool InfoDialog(string File, IntPtr Window)
Parameters
String File

The name of the file to retrieve the information from.

IntPtr Window

The application's main window... = the current foreground window.

Returns
Boolean

true if the info dialog was called successfully, else false is returned.

IsSeekable(Int32)

Returns weather the Winamp input plugin supports seeking?

Declaration
public static bool IsSeekable(int Handle)
Parameters
Int32 Handle

The handle of the winamp input plugin.

Returns
Boolean

true if the input plugin support seeking, else false is returned.

LoadPlugin(String)

Loads a Winamp input plug-in.

Declaration
public static int LoadPlugin(string File)
Parameters
String File

The file name of the plug-in to load.

Returns
Int32

The handle of the loaded winamp input plug-in or 0 if it failed.

UnloadPlugin(Int32)

Unloads a Winamp input plug-in which had been loaded via LoadPlugin(String) before.

Declaration
public static void UnloadPlugin(int Handle)
Parameters
Int32 Handle

The handle of the winamp input plugin.

Back to top Copyright © 2017 Mathew Sachin
Generated by DocFx