logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class MusicPlayerInstaller

    Abstract base class for installing a MusicPlayer component.

    Inheritance
    object
    MusicPlayerInstaller
    Implements
    IInstaller
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.MusicPlayer.Installation.Installers
    Assembly: Serenity.MusicPlayer.Installation.dll
    Syntax
    public abstract class MusicPlayerInstaller : IInstaller

    Constructors

    MusicPlayerInstaller()

    Declaration
    protected MusicPlayerInstaller()

    Fields

    AUDIO_SOURCE_WRAPPER_NAME

    Declaration
    protected const string AUDIO_SOURCE_WRAPPER_NAME = "AudioSourceWrapper"
    Field Value
    Type Description
    string

    The name of the audio source wrapper GameObject.

    SERVICE_NAME

    Declaration
    protected const string SERVICE_NAME = "MusicPlayerService"
    Field Value
    Type Description
    string

    The name of the music player service.

    _gateway

    Declaration
    protected IMusicPlayerGateway _gateway
    Field Value
    Type Description
    IMusicPlayerGateway

    The music player gateway.

    _musicPlayerGatewayFactory

    Declaration
    protected IMusicPlayerGatewayFactory _musicPlayerGatewayFactory
    Field Value
    Type Description
    IMusicPlayerGatewayFactory

    The music player gateway factory.

    _musicPlayerServiceFactory

    Declaration
    protected IMusicPlayerServiceFactory _musicPlayerServiceFactory
    Field Value
    Type Description
    IMusicPlayerServiceFactory

    The music player service factory.

    _services

    Declaration
    protected Dictionary<string, IMusicPlayerService> _services
    Field Value
    Type Description
    Dictionary<string, IMusicPlayerService>

    The dictionary of music player services.

    _useCases

    Declaration
    protected MusicPlayerUseCases _useCases
    Field Value
    Type Description
    MusicPlayerUseCases

    The music player use cases.

    Methods

    GetAudioPlayerService(AudioPlayerType)

    Get Audio Player Service by type.

    Declaration
    public IMusicPlayerService GetAudioPlayerService(AudioPlayerType type)
    Parameters
    Type Name Description
    AudioPlayerType type

    The type of audio player service to retrieve.

    Returns
    Type Description
    IMusicPlayerService

    The audio player service matching the specified type.

    GetServices()

    Gets the dictionary of music player services.

    Declaration
    public Dictionary<string, IMusicPlayerService> GetServices()
    Returns
    Type Description
    Dictionary<string, IMusicPlayerService>

    The dictionary of music player services.

    Install(ILogService)

    Installs the MusicPlayer component.

    Declaration
    public abstract void Install(ILogService logService)
    Parameters
    Type Name Description
    ILogService logService

    The log service to use for logging.

    InstallFactories(ILogService)

    Installs the music player factories.

    Declaration
    protected abstract void InstallFactories(ILogService logService)
    Parameters
    Type Name Description
    ILogService logService

    The log service to use for logging.

    InstallGateway(Dictionary<string, IMusicPlayerService>)

    Installs the music player gateway.

    Declaration
    protected abstract void InstallGateway(Dictionary<string, IMusicPlayerService> services)
    Parameters
    Type Name Description
    Dictionary<string, IMusicPlayerService> services

    The dictionary of music player services.

    InstallUseCases(IMusicPlayerGateway)

    Installs the music player use cases.

    Declaration
    protected void InstallUseCases(IMusicPlayerGateway gateway)
    Parameters
    Type Name Description
    IMusicPlayerGateway gateway

    The music player gateway to use for the use cases.

    Implements

    IInstaller
    In this article
    © 2026 Serenity. All Rights Reserved