Class AudioPlayerInstaller
Abstract base class for installing audio player services, gateways, and use cases.
Implements
Inherited Members
Namespace: Serenity.AudioPlayer.Installation.Installers
Assembly: Serenity.AudioPlayer.Installation.dll
Syntax
public abstract class AudioPlayerInstaller : IInstaller
Constructors
AudioPlayerInstaller()
Declaration
protected AudioPlayerInstaller()
Fields
AUDIO_SOURCE_WRAPPER_NAME
Declaration
protected const string AUDIO_SOURCE_WRAPPER_NAME = "AudioSourceWrapper"
Field Value
| Type | Description |
|---|---|
| string | Name of the audio source wrapper component. |
SERVICE_NAME
Declaration
protected const string SERVICE_NAME = "AudioPlayerService"
Field Value
| Type | Description |
|---|---|
| string | Name of the audio player service. |
_gateway
Declaration
protected IAudioPlayerGateway _gateway
Field Value
| Type | Description |
|---|---|
| IAudioPlayerGateway | Gateway for audio player operations. |
_services
Declaration
protected Dictionary<string, IAudioPlayerService> _services
Field Value
| Type | Description |
|---|---|
| Dictionary<string, IAudioPlayerService> | Dictionary to hold registered audio player services. |
_useCases
Declaration
protected AudioPlayerUseCases _useCases
Field Value
| Type | Description |
|---|---|
| AudioPlayerUseCases | Use cases for audio player operations. |
Methods
GetAudioPlayerService(AudioPlayerType)
Gets a specific audio player service by its type.
Declaration
public IAudioPlayerService GetAudioPlayerService(AudioPlayerType type)
Parameters
| Type | Name | Description |
|---|---|---|
| AudioPlayerType | type | The type of the audio player service. |
Returns
| Type | Description |
|---|---|
| IAudioPlayerService | The audio player service. |
GetAudioPlayerService(string)
Gets a specific audio player service by its identifier.
Declaration
public IAudioPlayerService GetAudioPlayerService(string id)
Parameters
| Type | Name | Description |
|---|---|---|
| string | id | The identifier of the audio player service. |
Returns
| Type | Description |
|---|---|
| IAudioPlayerService | The audio player service. |
GetGateway()
Gets the audio player gateway.
Declaration
public IAudioPlayerGateway GetGateway()
Returns
| Type | Description |
|---|---|
| IAudioPlayerGateway | The audio player gateway. |
GetServices()
Gets the registered audio player services.
Declaration
public Dictionary<string, IAudioPlayerService> GetServices()
Returns
| Type | Description |
|---|---|
| Dictionary<string, IAudioPlayerService> | Dictionary of audio player services. |
GetUseCases()
Gets the audio player use cases.
Declaration
public AudioPlayerUseCases GetUseCases()
Returns
| Type | Description |
|---|---|
| AudioPlayerUseCases | The audio player use cases. |
Install(ILogService)
Installs the audio player services, gateways, and use cases.
Declaration
public abstract void Install(ILogService logService)
Parameters
| Type | Name | Description |
|---|---|---|
| ILogService | logService | The logging service. |
InstallUseCases(IAudioPlayerGateway)
Installs the audio player use cases with the provided gateway.
Declaration
protected void InstallUseCases(IAudioPlayerGateway gateway)
Parameters
| Type | Name | Description |
|---|---|---|
| IAudioPlayerGateway | gateway | The audio player gateway. |