Interface AgamaPlayerConfiguration

Describes the configuration of Agama.

Remarks


- Available since v2.45.6.

interface AgamaPlayerConfiguration {
    application?: string;
    applicationVersion?: string;
    config: string;
    deviceID?: string;
    integration: "agama";
    logLevel?: AgamaLogLevelType;
    userAccountID?: string;
}

Hierarchy (view full)

Properties

application?: string

The name of your application.

Remarks


- Available since v2.61.0.
- Will not be reported to Agama if not present

applicationVersion?: string

The version of your application

Remarks


- Available since v2.61.0.
- Will not be reported to Agama if not present

config: string

The initial base configuration.

Remarks


- For more information, consult the Agama documentation.

Example

<br/> - 'emp_service=http://127.0.0.1:8191/report;report_interval=60;id_report_interval=240;operator_id=fooSoo'
deviceID?: string

The identifier of the device.

Remarks


- Available since v4.1.0.
- Make sure to pass a valid string as indicated by the Agama SDK documentation. No specific value format validation is performed on this as that is deemed the responsibility of the one setting this value externally via this configuration property.
- Will be generated internally if not present

integration: "agama"

The identifier of the analytics integration.

The type of log level.

Default Value

'fatal'

userAccountID?: string

The identifier of the user account.

Remarks


- Available since v2.61.0.
- Will not be reported to Agama if not present

Generated using TypeDoc