Interface IAimpCore

This interface provides an ability to access to services and an ability to register custom services and extensions.

Namespace: AIMP.SDK
Assembly: AIMP.SDK.dll
Syntax
public interface IAimpCore

Methods

CreateObject<TAimpObject>()

Creates the object.

Declaration
AimpActionResult<IAimpObject> CreateObject<TAimpObject>()

    where TAimpObject : IAimpObject

CreateStream()

Creates the Aimp stream instance.

Declaration
[Obsolete("Use CreateObject instead it")]
AimpActionResult<IAimpStream> CreateStream()

GetPath(AimpCorePathType)

Gets the path to one of the "system" folders of player.

Declaration
string GetPath(AimpCorePathType aimpCorePath)
Parameters
Type Name Description
AimpCorePathType aimpCorePath

The aimp core path type.

RegisterExtension(IAimpExtension)

Method provides an ability to register extension. An access to extensions provides by specified for it services.For example: IAimpServiceAudioDecoders. All extensions will be automatically unregistered from the application before plugin finalization.

Declaration
AimpActionResult RegisterExtension(IAimpExtension extension)
Parameters
Type Name Description
IAimpExtension extension

The Aimp extension.

SendMessage(AimpCoreMessageType, Int32, Object)

Sends the message.

Declaration
AimpActionResult SendMessage(AimpCoreMessageType message, int param, object objectParameter)
Parameters
Type Name Description
AimpCoreMessageType message

The message.
System.Int32 param

The parameter.
System.Object objectParameter

The object parameter.

UnregisterExtension(IAimpExtension)

Method provides an ability to unregister specified extension manually. Note 1: all extensions will be automatically unregistered from the application before plugin finalization.So, this method is optional. Note 2: extension may be used at the current time, in this case it will be completely unregistered only the after release

Declaration
AimpActionResult UnregisterExtension(IAimpExtension extension)
Parameters
Type Name Description
IAimpExtension extension

The Aimp extension.

Extension Methods