• Articles
  • Api Documentation
Show / Hide Table of Contents
  • Actions
    • IAimpAction
    • IAimpActionEvent
    • IAimpServiceActionManager
  • AlbumArt
    • IAimpServiceAlbumArtCache
    • IAimpAlbumArtSearchOptions
    • IAimpExtensionAlbumArtCatalog
    • IAimpExtensionAlbumArtCatalog2
    • AimpAlbumArtProviderCategory
    • IAimpExtensionAlbumArtProvider
    • IAimpExtensionAlbumArtProvider2
    • AimpFindCovertArtType
    • AimpGetAlbumArtEventArgs
    • IAimpServiceAlbumArt
  • Core
    • AimpActionException
    • AimpInternalLogger
    • Extensions
    • IAimpLogger
    • IAimpService
    • IAimpConfig
    • IAimpExternalSettingsDialog
    • AimpErrorArgs
    • IAimpObject
    • IAimpObjectList`1
    • IAimpObjectList
    • IAimpStream
    • ActionResultType
    • AimpActionResult
    • AimpActionResult`1
    • AimpActionResult`2
    • IAimpExtension
    • AimpPluginType
    • AimpPluginAttribute
    • AimpPlayerState
    • AimpWindowHandleTypes
    • AimpEventsDelegate
    • IAimpCore
    • IAimpPlugin
    • AimpPlugin
    • CustomAssemblyResolver
    • PluginLoadUnloadEvent
    • PluginInformation
    • DotNetPluginInfo
    • PluginShortInfoForLoad
    • PluginLoadingStrategy
    • AssemblyScanPluginLoadStrategy
    • PluginInfoLoader
    • AimpDotNetPlugin
  • File Manager
    • Extensions
      • IAimpExtensionFileExpander
      • FileFormatsCategoryTypes
      • IAimpExtensionFileFormat
      • IAimpExtensionFileInfoProvider
      • IAimpExtensionFileSystem
    • Commands
      • IAimpFileSystemCommand
      • IAimpFileSystemCommandCopyToClipboard
      • IAimpFileSystemCommandDelete
      • IAimpFileSystemCommandDropSource
      • IAimpFileSystemCommandFileInfo
      • IAimpFileSystemCommandOpenFileFolder
      • IAimpFileSystemCommandStreaming
      • IAimpFileSystemCustomFileCommand
    • FileCommandType
    • FileFormats
    • IAimpServiceFileFormats
    • ServiceFileInfoFlags
    • IAimpServiceFileInfo
    • IAimpServiceFileInfoFormatter
    • IAimpServiceFileInfoFormatterUtils
    • IAimpServiceFileManager
    • FileStreamingType
    • CeateStreamResult
    • IAimpServiceFileStreaming
    • IAimpServiceFileSystems
    • IAimpVirtualFile
    • AimpFileAttributes
    • IAimpFileInfo
  • Lyrics
    • LyricsProviderCategory
    • IAimpExtensionLyricsProvider
    • LyricsType
    • LyricsFormat
    • IAimpLyrics
    • LyricsFlags
    • AimpServiceLyricsReceive
    • IAimpServiceLyrics
  • Menu
    • MenuItemStyle
    • IAimpMenuItem
    • ParentMenuType
    • IAimpServiceMenuManager
  • Message Dispatcher
    • Constants
    • AimpCoreMessageType
    • AimpCorePathType
    • IAimpMessageHook
    • MessageDirectionType
    • IAimpServiceMessageDispatcher
  • Multi-Language UI
    • IAimpServiceMUI
  • Music Library
    • Presets
      • IAimpGroupingPreset
      • IAimpGroupingPresets
      • IAimpGroupingPresetStandard
    • Extension
      • Command
        • IAimpDataStorageCommandAddFiles
        • IAimpDataStorageCommandAddFilesDialog
        • IAimpDataStorageCommandDeleteFiles
        • IAimpDataStorageCommandDropData
        • IAimpDataStorageCommandReloadTags
        • IAimpDataStorageCommandReportDialog
        • IAimpDataStorageCommandUserMark
      • CapabilitiesType
      • SchemaType
      • GroupingPresetsSchemaType
      • IAimpExtensionDataStorage
    • DataStorage
      • AimpDataField
      • AimpDataFieldType
      • AimpDataFieldFlagsType
      • ImageType
      • IAimpDataField
      • IAimpDataFieldDisplayValue
      • IAimpDataStorage
      • CapabilitiesFlags
      • IAimpGroupingTreeDataProvider
      • GroupingTreeNodeFlags
      • FieldImageIndex
      • IAimpGroupingTreeDataProviderSelection
      • IAimpGroupingTreeSelection
      • IAimpDataProvider
    • DataFilter
      • FieldFilterOperationType
      • IAimpDataFieldFilter
      • IAimpDataFieldFilterByArray
      • FilterGroupOperationType
      • IAimpDataFilterGroup
    • SortDirectionType
    • IAimpDataFilter
    • IAimpDataProviderSelection
    • IAimpDataStorageManager
    • IAimpFileList
    • IAimpMusicLibraryPlaylistPreimage
    • IAimpServiceMusicLibrary
    • FilesType
    • IAimpServiceMusicLibraryUI
  • Options Dialog
    • IAimpOptionsDialogFrameKeyboardHelper
    • IAimpServiceOptionsDialog
    • OptionsDialogFrameNotificationType
    • IAimpOptionsDialogFrame
  • Player
    • IAimpPlayer
  • Playlists
    • IAimpPlayer
  • Tag Editor
    • IAimpFileTag
    • IAimpFileTagEditor
    • TagType
    • IAimpServiceFileTagEditor
  • Threading
    • IAimpServiceThreads
    • IAimpTask
    • IAimpTaskOwner
    • IAimpServiceSynchronizer
    • AimpServiceThreadPoolType
    • IAimpServiceThreadPool
    • AimpTaskPriority
    • IAimpTaskPriority
  • Visuals
    • AimpVisualData
    • AimpVisualFlags
    • IAimpExtensionCustomVisualization
    • AimpVisualClickButtonType
    • IAimpExtensionEmbeddedVisualization
    • IAimpServiceVisualizations

Interface IAimpAction

Main feature of Action is an ability to display it in hotkey list, and provide an ability to customize it hotkey. Implements the IAimpActionEvent Implements the IAimpObject

Inherited Members
IAimpActionEvent.OnExecute
Namespace: AIMP.SDK.ActionManager
Assembly: AIMP.SDK.dll
Syntax
public interface IAimpAction : IAimpActionEvent, IAimpObject

Properties

AlternativeGlobalHotKey

Gets or sets the alternative global hot key. Can be 0.

Declaration
int AlternativeGlobalHotKey { get; set; }

CustomData

Gets or sets the custom data.

Declaration
string CustomData { get; set; }

DefaultGlobalHotKey

Gets or sets the default global hot key. Can be 0.

Declaration
int DefaultGlobalHotKey { get; set; }

DefaultLocalHotKey

Gets or sets the default hot key. Can be 0.

Declaration
int DefaultLocalHotKey { get; set; }

Enabled

Gets or sets a value indicating whether this IAimpAction is enabled.

Declaration
bool Enabled { get; set; }

GroupName

Gets or sets the group name. Optional, can be undefined.

Declaration
string GroupName { get; set; }

Id

Gets or sets the unique action identity, must be unique for all plugins.

Declaration
string Id { get; set; }

Name

Gets or sets the command name, value is displaying in the hotkey list.

Declaration
string Name { get; set; }

See Also

IAimpActionEvent
IAimpObject
In This Article
Back to top Generated by DocFX