Convenience module to pull in generic application dependencies that are required both in live and preview mode. You might want to use this module in the basic application module to pull in the typical SDK dependencies.

Example:

import { AcNgAppBaseModule } from '@acoustic-content-sdk/ng-app-base';

@NgModule({
  declarations: [AppComponent],
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    RouterModule.forRoot(routes, { useHash: false }),
    AcNgAppBaseModule,
    ...MODULES
  ]
})
export class AppModule {}

Table of Contents

• API Documentation

General Concepts

Applications on Acoustic Content can run in preview mode and in live mode. In preview mode they are augmented with inline edit capabilities and optimited for inline edit experience, in live mode they run in read-only mode optimized for size and performance.

The difference in runtime behaviour is achieved by building the application twice with different dependency providers for services that the application relies on.

Providers for preview mode are supplied by the ng-app-preview module, for live mode via the ng-app-live module and general purpose providers that apply to both modes by the ng-app-base module.

Home > @acoustic-content-sdk/ng-app-base

ng-app-base package

Module that contains a default configuration to run an Angular application against Acoustic Content in live and preview mode.

Classes

| Class | Description | | --- | --- | | AcNgAppBaseModule | Imports the modules required for basic functionality |

Variables

| Variable | Description | | --- | --- | | MODULE | Module name | | VERSION | Version and build number of the package |

Home > @acoustic-content-sdk/ng-app-base > AcNgAppBaseModule

AcNgAppBaseModule class

Imports the modules required for basic functionality

Signature:

export declare class AcNgAppBaseModule 

Constructors

| Constructor | Modifiers | Description | | --- | --- | --- | | (constructor)(aLoggerService) | | Constructs a new instance of the AcNgAppBaseModule class |

Properties

| Property | Modifiers | Type | Description | | --- | --- | --- | --- | | VERSION | | WchSdkVersion | Exposes the version information of this module |

Home > @acoustic-content-sdk/ng-app-base > MODULE

MODULE variable

Module name

Signature:

MODULE = "@acoustic-content-sdk/ng-app-base"

Home > @acoustic-content-sdk/ng-app-base > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

Home > @acoustic-content-sdk/ng-app-base > AcNgAppBaseModule > (constructor)

AcNgAppBaseModule.(constructor)

Constructs a new instance of the AcNgAppBaseModule class

Signature:

constructor(aLoggerService: LoggerService);

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aLoggerService | LoggerService | |

Home > @acoustic-content-sdk/ng-app-base > AcNgAppBaseModule > VERSION

AcNgAppBaseModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;