Enum AimpCoreMessageType

Core message type.

Namespace: AIMP.SDK.MessageDispatcher
Assembly: AIMP.SDK.dll
Syntax
public enum AimpCoreMessageType

Fields

Name Description
CmdAbout

Show the "About" dialog.

note

Param1 - Not used. Param2 - Not used.

CmdAddFiles

Show the "File Adding" dialog.

note

Param1 - Not used. Param2 - Not used.

CmdAddFolders

Show the "Folder adding" dialog.

note

Param1 - Not used. Param2 - Not used.

CmdAddPlaylists

Show the "Playlists adding" dialog.

note

Param1 - Not used. Param2 - Not used.

CmdAddUrl

Show the "Add URL" dialog.

note

Param1 - Not used. Param2 - Not used.

CmdBookmarks

Show the "Bookmarks Manager" dialog.

note

Param1 - Not used. Param2 - Not used.

CmdBookmarksAdd

Add file(s) to bookmarks.

note

Param1 - 0 - add playing file, 1 - add selected files from active playlist Param2 - Not used.

CmdDeleteSelectedFromHDD

Delete selected tracks from disk drive.

note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdDSPManager

    Show the "DSP Manager" dialog.

    note

    Param1 - Index of tab sheet to active, 0..3. 0 - Common settings (default) 1 - Equalizer 2 - Volume normalization 3 - Cross mixing settings Param2 - Not used.

    CmdDspManagerCrossmixing

    The command DSP manager crossmixing
    CmdDSPManagerEQ

    The command DSP manager eq
    CmdNext

    Jump to next track.

    note

    Note that function doesn't check if file playback really started. It just put the file into queue of loading thread (Refer to the AIMP_MSG_EVENT_STREAM_START).

    Param1 - Not used. Param2 - Not used.

    CmdOpenFiles

    Show the "Open files" dialog.

    Param1 - Not used. Param2 - Not used.

    CmdOpenFolders

    Show the "Open folders" dialog.

    Param1 - Not used. Param2 - Not used.

    CmdOpenPlaylists

    Show the "Open Playlists" dialog.

    Param1 - Not used. Param2 - Not used.

    CmdOptions

    Show options dialog.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPause

    Pause / Resume.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlay

    If player is stopped - starts playback. If player is paused - resumes playback. If player is playing - start playing from beginning.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistDeleteAll

    Delete all tracks from active playlist.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistDeleteDuplicates

    Delete duplicate tracks from active playlist. Tracks will be compared by full file name.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistDeleteNonExists

    Remove non exists tracks from active playlist.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistDeleteNonSelected

    Remove all tracks from active playlist except selected.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistDeletePlayingFromHDD

    Remove playable file from disk drive.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistDeleteSelected

    Delete selected tracks from active playlist.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistDeleteSwitchedOff

    Delete switched off tracks from active playlist.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistDeleteSwitchedOffFromHDD

    Delete switched off tracks from disk drive.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistFocusPlayable

    Activate playable playlist and focus playable file.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistReloadFromPreimage

    Synchronize active playlist with preimage if it presents.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistRescan

    Reload file tags for all tracks in active playlist

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistSortByArtist

    Sort tracks in active playlist by artist field.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistSortByDuration

    Sort tracks in active playlist by duration field.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistSortByPath

    Sort tracks in active playlist by path.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistSortByTitle

    Sort tracks in active playlist by title.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistSortInvert

    Invert tracks in active playlists.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistSortRandomize

    Shuffle tracks in active playlists.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistSwitchOff

    Switch off auto playing marker for selected tracks in active playlist.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlaylistSwitchOn

    Switch on auto playing marker for selected tracks in active playlist

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlayPause

    If player is stopped - starts playback. If player is paused - resumes playback. If player is playing - pauses playback.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPlugins

    Show options dialog and activate the "Plugins" sheet.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPrev

    Previous track. Note 1: Note that function doesn't check if file playback really started. It just put the file into queue of loading thread (Refer to the AIMP_MSG_EVENT_STREAM_START).

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdPrevPlaylist

    Start playback of previous playing playlist.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdQFIPlaybackTrack

    Show the "Quick File Information" card for playable file.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdQTEPlayableTrack

    Show the "File Information" dialog for playable track.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdQuit

    Close the application.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdSavePlaylists

    Show the "Save Playlist" dialog

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdScheduler

    Show settings dialog of the "Simple Scheduler" plugin.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdSearch

    Show the "Advanced Search" dialog.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdShowNotification

    Show custom text in the running line or text box.

    note

  • Param1: 0 - text will be automatically hidden (delay before hiding is 2 seconds), 1 - text will be hidden manually (you must send message with Param2 set to nil / null).
  • Param2: Showing text: pointer to first element of null-terminating widechar array Hiding text: nil / null (for Param set to 1 only)

    • CmdStateGet

    This messages provides an ability to check command accessibility.

    note

  • Param1: Command ID. See the "Commands" charter.
  • Param2 - Not used.

    		•
    CmdStop

    Stop playback.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdTogglePartRepeat

    Toggles state of the "Repeat part A-B" function.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdVisualNext

    Next visualization.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdVisualPrev

    Previous visualization.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdVisualStart

    Starts previous selected by user visualization. If visualization is not found - first will be started.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    CmdVisualStop

    Stop visualization.

    note

  • Param1 - Not used.
  • Param2 - Not used.

    		•
    EventCmdState

    Command state has been changed.

    note

  • Param1: Command ID. See the "Commands" charter.
  • Param2 - Not used.

    		•
    EventEqualizerPresetName

    Event occurs when name of currently used preset has been changed.

    note

  • Param1: Not used
  • Param2: Pointer to WideChar array, can be = nil (ReadOnly!)

    		•
    EventFileMark

    Event occurs when file mark has been changed.

    note

  • Param1: New mark (from 0 to 5)
  • Param2: File name - pointer to first element of null terminated widechar-array. If file name is nil / null or empty its mean that marks for all files have been changed.

    • EventLanguage

    Event occurs when localization has been changed.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventLoaded

    Event occurs when application completely initialized.

    note

    Note that plugin can be loaded after program initialization. You should check current state via the AIMP_MSG_PROPERTY_LOADED property if it needed.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventOptions

    Event occurs when some settings have been changed.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventOptionsFrameList

    Event occurs when list of sheet for Options Dialog has been changed.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventOptionsFrameModified

    Event occurs when one of settings in the Option Dialog sheet has been changed by user.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventPlayableFileInfo

    Event occurs when information about the playable file has been changed. Event not occurs:

    1. On start playback (See AIMP_MSG_EVENT_STREAM_START, AIMP_MSG_EVENT_STREAM_START_SUBTRACK)
    2. On stop playback(See AIMP_MSG_EVENT_STREAM_END)
    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventPlayerState

    Event occurs when player state has been changed.

    note

  • Param1: 0 - Stopped, 1 - Paused, 2 - Playing.
  • Param2: Not used.

    		•
    EventPlayerUpdatePosition

    Unlike the AIMP_MSG_EVENT_PROPERTY_VALUE event for the AIMP_MSG_PROPERTY_PLAYER_POSITION property, this event occurs even second. This event can be useful for update information about the playable track.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventPlayerUpdatePositionHr

    Unlike the AIMP_MSG_EVENT_PLAYER_UPDATE_POSITION event this event has higher resolution (about 10-15 calls per second).

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventPropertyValue

    Event occurs when property value has been changed. See the "Properties" charter.

    note

  • Param1: Property ID.
  • Param2: This parameter is same to Param2 for specified property.

    		•
    EventSkin

    Event occurs when skin has been applied.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventStatisticsChanged

    Event occurs when statistics has been changed.

    note

  • Param1: Not used.
  • Param2: File name - pointer to first element of null-terminated widechar-array. If file name is nil / null or empty its mean that statistic for all files have been changed.

    • EventStreamEnd

    Event occurs when track has been finished.

    note

  • Param1: Contains zero or combination of following flags: AIMP_MES_END_OF_QUEUE, AIMP_MES_END_OF_PLAYLIST.
  • Param2: Not used.

    		•
    EventStreamStart

    Event occurs when playback of track has been started.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventStreamStartSubtrack

    This event like to AIMP_MSG_EVENT_STREAM_START, but it occurs when playing radio stream and track has been changed.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventTerminating

    Event occurs when closing the application.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    EventVisualPlugin

    Event occurs when switching between visualizations.

    note

  • Param1: Not used.
  • Param2: Not used.

    		•
    PropertyActionOnEndOfPlaylist

    Action on end of playlist.

    note

  • Param1: Access direction: Read / Write ( / )
  • Param2: Pointer to the 32-bit integer variable (Integer). 0 - Jump to the next playlist 1 - Repeat current playlist 2 - Stand by

    • PropertyBalance

    Balance.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: -1.0 .. +1.0 Default: 0.0

    • PropertyChorus

    Chorus effect.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: 0.0 .. 1.0 Default: 0.0 (switched off)

    • PropertyEcho

    Echo effect.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: 0.0 .. 1.0 Default: 0.0 (switched off)

    • PropertyEnhancer

    Enhancer effect.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: 1.0 .. 5.0 Default: 1.0 (switched off)

    • PropertyEqualizer

    Equalizer state (switched on / off).

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Values: False / True Default: False

    • PropertyEqualizerBand
    note

  • Param1: LoWord: AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET HiWord: Band Index (from 0 to 17)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: -15.0 .. 15.0 dB Default: 0.0 dB

    • PropertyFlanger

    Flanger effect.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: 0.0 .. 1.0 Default: 0.0 (switched off)

    • PropertyHwnd

    Handle of one of application windows. Read only.

    note

  • Param1: One of following values: AIMP_MPH_MAINFORM AIMP_MPH_APPLICATION AIMP_MPH_TRAYCONTROL AIMP_MPH_PLAYLISTFORM AIMP_MPH_EQUALIZERFORM
  • Param2: Pointer to the HWND.

    		•
    PropertyLoaded

    Property shows whether an application is initialized.

    note

  • Param1: AIMP_MSG_PROPVALUE_GET. Read Only
  • Param2: Pointer to LongBool.

    		•
    PropertyMinimizedToTray
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Values: False / True Default: False

    • PropertyMute
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Values: False / True Default: False

    • PropertyPartRepeat

    Part repeat state. Read only.

    note

  • Param1: AIMP_MSG_PROPVALUE_GET Read Only
  • Param2: Pointer to the 32-bit integer variable (Integer). 0 - Repeat is switched off 1 - Point "A" is defined 2 - Point "B" is defined, repeat is switched on

    • PropertyPitch
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: -10.0 .. 10.0 Default: 0.0 (switched off)

    • PropertyPlayerBuffering

    Displays buffering progress of playing track.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Value in percents (from 0.0 to 100.0 %)

    		•
    PropertyPlayerDuration
    note

  • Param1: AIMP_MSG_PROPVALUE_GET. Read Only
  • Param2: Pointer to the 32-bit floating point variable (Single). Value is defined in seconds.

    		•
    PropertyPlayerPosition
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET).
  • Param2: Pointer to the 32-bit floating point variable (Single). Value is defined in seconds.

    		•
    PropertyPlayerState
    note

  • Param1: AIMP_MSG_PROPVALUE_GET. Read Only.
  • Param2: Pointer to the 32-bit integer variable (Integer). 0 = Stopped 1 = Paused 2 = Playing

    • PropertyPreamp

    Preamp. Equalizer must be switched on, see AIMP_MSG_PROPERTY_EQUALIZER.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: -15.0 .. 15.0 dB Default: 0.0 dB

    • PropertyRadioCap

    State of internet radio capture.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Values: False / True Default: False

    • PropertyRepeat

    Track repeat state.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Value: False / True Default: False

    • PropertyRepeatSingleFilePlaylists

    State of "repeat single file playlists" option. It is actual for "repeat playlist" mode only (see AIMP_MSG_PROPERTY_ACTION_ON_END_OF_PLAYLIST).

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Values: False / True Default: False

    • PropertyReverb

    Reverb effect.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: 0.0 .. 1.0 Default: 0.0 (switched off)

    • PropertyReverseTime

    Switching on/off countdown mode of playback time.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Value: False / True Default: False

    • PropertyShuffle
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Value: False / True Default: False

    • PropertySpeed
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: 0.5 .. 1.5 (50% .. 150%) Default: 1.0 (100%)

    • PropertyStayOnTop
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Value: False / True Default: False

    • PropertyStopAfterTrack

    Stop playback after playable file will finished.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Values: False / True Default: False

    • PropertyTempo
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Values: 0.8 .. 1.5 (80% .. 150%) Default: 1.0 (100%)

    • PropertyTruebass
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: 0.0 .. 2.0 Default: 0.0 (switched off)

    • PropertyVisualFullscreen

    Full screen visualization mode.

    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit logical variable (LongBool). Values: False / True Default: False

    • PropertyVolume
    note

  • Param1: Access direction: Read / Write (AIMP_MSG_PROPVALUE_GET / AIMP_MSG_PROPVALUE_SET)
  • Param2: Pointer to the 32-bit floating point variable (Single). Range: 0.0 .. 1.0