var MP3SEFuncs: TMP3SEFuncs; begin //* Get it MP3SEFuncs := MP3SEFuncsInit; //* Call the Log function MP3SEFuncs.Log('Hello', False); |
t_RemoveDSP = procedure(DSPHandle: HDSP; Channel: DWORD); stdcall; | ||||||
Description: Remove (unassign) DSP from a stream channel | ||||||
| ||||||
Return value: none | ||||||
Remarks:
Do not call this function from within a DSP callback with the same channel handle as received by the callback. Never try to remove a vis plugin with DSPHandle := 1! Use RemoveDSPbyName() instead! | ||||||
See also: RemoveDSPbyName, StreamsGetInfo, StreamsDSPAdd |
t_RemoveDSPbyName = procedure(DSPName: String; StreamName: String); stdcall; | ||||||
Description: Remove (unassign) DSP or plugin from stream channel by plugin's name | ||||||
| ||||||
Return value: none | ||||||
Remarks: Do not call this function from within a DSP callback with the same channel handle as received by the callback. | ||||||
See also: RemoveDSP, StreamsGetInfo, StreamsDSPAdd |
t_Log = procedure(Text: String; DebugInfo: Boolean); stdcall; | |||
Description: Log strings | |||
| |||
Return value: none | |||
Remarks: | |||
See also: |
t_SetProgress = procedure(Value: Integer); stdcall; | |||
Description: Set Processing progress indicator in % | |||
| |||
Return value: none | |||
Remarks: Set to 0 when finished! | |||
See also: StatusMsg |
t_GetTempFileName = function(Extension: String): String; stdcall; | |||
Description: Construct a new unique filename in the folder specified in Settings/Temp File will be deleted automaticaly on program termination | |||
| |||
Return value: Unique temp filename | |||
Remarks: You should delete the file yourself after it's not needed if working with large temp files! | |||
See also: |
t_DXError2Str = function(Err: HResult): String; stdcall; | |||
Description: Query text description of a DirectX HRESULT Error code. Returns 'Unknown' if DXErr9ab.dll is not found | |||
| |||
Return value: Description in format "ERROR: DESCRIPTION" | |||
Remarks: none | |||
See also: |
t_StatusMsg = procedure(Status1, Status2: String); stdcall; | |||
Description: Set status panel caption. If StatusX = '' then won't change. | |||
| |||
Return value: None | |||
Remarks: None | |||
See also: SetProgress |
t_MPEGFrameCopy = function(FileName: String; FirstFrame: Int64; Frames2copy: Int64; OutFile: String; AppendMode: Boolean): Int64; stdcall; | |||||||||||||||
Description: MPEG frames copy | |||||||||||||||
| |||||||||||||||
Return value: Frames succesfully copied | |||||||||||||||
Remarks: Unregistered version will cut max. 11538 frames ~5mins. | |||||||||||||||
See also: MPEGCountFrames, MPEGFindFirstFrame, MPEGGetFrameLength |
t_MPEGCountFrames = function(FileName: String): Int64; stdcall; | ||||||
Description: Count number of MPEG frames in a file | ||||||
| ||||||
Return value: Number of MPEG frames detected in file | ||||||
Remarks: | ||||||
See also: MPEGFrameCopy, MPEGFindFirstFrame, MPEGGetFrameLength |
t_MPEGFindFirstFrame = function(FileName: String; SearchLength: Integer): Int64; stdcall; | ||||||
Description: Find First MPEG frame's position in bytes | ||||||
| ||||||
Return value: First MPEG frame's position in bytes | ||||||
Remarks: | ||||||
See also: MPEGCountFrames, MPEGGetFrameLength |
t_MPEGGetHeader = function(FileName: String; HeaderPos: Int64): LongWord; stdcall; t_MPEGFindNextFrame = function(FileName: String; SearchPos: Int64): Int64; stdcall; t_MPEGGetFrameLength = function(Header: LongWord): Integer; stdcall; t_MPEGGetFrameRate = function(Header: LongWord): Integer; stdcall; t_MPEGProcessHeader = function(FileName: String; Position: Int64): TMP3StreamHeader; stdcall; | ||||||||||||
Description: Seek in MPEG streams with these functions. FindFirstFrame, Find next frame, get header from resulting position, ProcessHeader to get a readable frame info. Use MPEGGetFrameLength + Position to advance to the next frame logicaly (corrupted frames not tested). | ||||||||||||
| ||||||||||||
| ||||||||||||
Remarks: | ||||||||||||
See also: MPEGCountFrames, MPEGFindFirstFrame |
t_StreamsDSPAdd = function(Index: Integer; Sync: HDSP; DSPName: String): Boolean; stdcall; | |||||||||
Description: Add DSP plugin to the Stream | |||||||||
| |||||||||
Return value: True: successfuly assigned DSP to stream | |||||||||
Remarks: | |||||||||
See also: RemoveDSP, StreamsGetInfo, RemoveDSPbyName |
t_StreamsFindStream = function(FileName: String): Integer; stdcall; stdcall; | |||
Description: Main function for the StreamList, always returns index of the requested Stream | |||
| |||
Return value: -1: not found else stream's index | |||
Remarks: | |||
See also: StreamsGetInfo, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsQuery |
t_StreamsGetInfo = function(Index: Integer): TBassStreamItem; stdcall; | |||
Description: Get Stream's parameters | |||
| |||
Return value: TBassStreamItem | |||
Remarks: | |||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsQuery |
t_StreamsFindStream = function(FileName: String): Integer; stdcall; stdcall; | |||
Description: Main function for the StreamList, always returns index of the requested Stream | |||
| |||
Return value: -1: not found else stream's index | |||
Remarks: | |||
See also: StreamsGetInfo, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsQuery |
t_StreamsBassAcquire = function(Index: Integer; Force: Boolean): Boolean; stdcall; | ||||||
Description: Create a Bass channel handle for the stream according to it's format MOD, MPG, URL... | ||||||
| ||||||
Return value: False if there was an error | ||||||
Remarks: Do not use Force when not needed! It can take minutes to initialize larger streams. | ||||||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsQuery |
t_StreamsSetInfo = procedure(Index: Integer; var Stream: TBassStreamItem); stdcall; | ||||||
Description: Changing Stream parameters is critical, use this function only if you know what you are doing! | ||||||
| ||||||
Return value: None | ||||||
Remarks: Use this function with care! | ||||||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsAdd, StreamsQuery |
t_StreamsGetList = function: TBassStreams; stdcall; | |||
Description: Retrieve the StreamList. | |||
| |||
Return value: TBassStreams | |||
Remarks: A stream TListItem's index is not equal to TBassStreams index. Use StreamsFindStream(TListItem.Caption) to get the stream index of an Item. | |||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsQuery |
t_StreamsGetListView = function: TListView; stdcall; | |||
Description: Retrieve the StreamList's ListView. | |||
| |||
Return value: TListView | |||
Remarks: A stream TListItem's index is not equal to TBassStreams index. Use StreamsFindStream(TListItem.Caption) to get the stream index of an Item. If your plugin doesn't use this function, you should comment it out from MP3SE_Types.pas together with the Uses declaration for ComCtrls to prevent linking more than 100K of useless code into your dll. | |||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsQuery |
t_StreamsAdd = function(FileName: String; URL: Boolean): Boolean; stdcall; | ||||||
Description: Add files to the StreamList. The way files are added are determined by Settings (Count frames, Init Bass etc.) | ||||||
| ||||||
Return value: False there was an error | ||||||
Remarks: | ||||||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsQuery |
t_StreamsRemove = function(Index: Integer): Boolean; stdcall; | |||
Description: Remove stream from the StreamList | |||
| |||
Return value: False there was an error | |||
Remarks: | |||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsQuery |
t_StreamsPlay = function(Index: Integer; StartPos: Int64; FadeIn: Boolean): Boolean; stdcall; | |||||||||
Description: Play particular stream from the StreamList | |||||||||
| |||||||||
Return value: False there was an error | |||||||||
Remarks: | |||||||||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsStop, StreamsPause, StreamsQuery |
t_StreamsStop = procedure(Index: Integer); stdcall; | |||
Description: Stop playing stream | |||
| |||
Return value: none | |||
Remarks: | |||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsPlay, StreamsPause, StreamsQuery |
t_StreamsPause = procedure(Index: Integer); stdcall; | |||
Description: Pause playing stream | |||
| |||
Return value: none | |||
Remarks: | |||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsStop, StreamsPlay, StreamsQuery |
t_StreamsListPlay = procedure(Index: Integer; FadeIn: Boolean); stdcall; | ||||||
Description: Playlist play StreamList starting from Index | ||||||
| ||||||
Return value: none | ||||||
Remarks: | ||||||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsListStop, StreamsQuery |
t_StreamsListStop = procedure; stdcall; | |||
Description: Stop Playlist playing the StreamList | |||
| |||
Return value: none | |||
Remarks: | |||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsListPlay, StreamsQuery |
t_StreamsPicked = function: Integer; stdcall; | |||
Description: Stop Playlist playing the StreamList | |||
| |||
Return value: First stream the user selected in the StreamList | |||
Remarks: | |||
See also: StreamsFindStream, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsStop, StreamsPlay, StreamsQuery |
t_StreamsSetItem = procedure(Index: Integer); stdcall; | |||
Description: Update stream's info in StreamList (icon, title, artist, etc.) | |||
| |||
Return value: none | |||
Remarks: | |||
See also: StreamsFindStream, StreamsPicked, StreamsSetInfo, StreamsAdd, StreamsStop, StreamsPlay, StreamsQuery |
t_StreamsQuery = function: TTagSelection; stdcall; | |||
Description: Popup a dialog and let the user select a Stream from the StreamList | |||
| |||
Return value: TTagSelection.FileName is the filename of the stream the user selected | |||
Remarks: | |||
See also: StreamsGetInfo, StreamsPicked, StreamsSetItem, StreamsSetInfo, StreamsAdd, StreamsFindStream |
t_EncodeListAdd = function(FileName, OutFileName, EncodeParams, EncodeParamsName, ID3_SourceFileName: String; ID3v1, ID3v2, DeleteAfter: Boolean): Boolean; stdcall; | ||||||||||||||||||||||||
Description: Add files to the EncodeList | ||||||||||||||||||||||||
| ||||||||||||||||||||||||
Return value: none | ||||||||||||||||||||||||
Remarks: | ||||||||||||||||||||||||
See also: EncodeListClear, EncodeListProcess, EncodeListGet, EncodeParamsGet |
t_EncodeListClear = procedure; stdcall; | |||
Description: Clear the EncodeList | |||
| |||
Return value: none | |||
Remarks: | |||
See also: EncodeListAdd, EncodeListProcess, EncodeListGet, EncodeParamsGet |
t_EncodeListProcess = procedure; stdcall; | |||
Description: Start and process the EncodeList | |||
| |||
Return value: none | |||
Remarks: | |||
See also: EncodeListAdd, EncodeListClear, EncodeListGet, EncodeParamsGet |
t_EncodeListGet = function: TEncodeList; stdcall; | |||
Description: Retrieve the EncodeList | |||
| |||
Return value: TEncodeList | |||
Remarks: Read only | |||
See also: EncodeListAdd, EncodeListProcess, EncodeListClear, EncodeParamsGet |
t_EncodeParamsGet = function(Query: Boolean): TPresetList; stdcall; | |||
Description: Retrieve the PresetList | |||
| |||
Return value: TPresetList.PresetIndex stores the index of the preset the user selected use TPresetList.Index[TPresetList.PresetIndex].Params to get the command line parameters | |||
Remarks: | |||
See also: EncodeListAdd, EncodeListProcess, EncodeListGet, EncodeListClear |