THEOplayer Web SDK
    Preparing search index...

    Interface AgamaSourceConfiguration

    Describes the configuration of Agama for this source.


    - Available since v2.45.6.
    - Overrides the AgamaPlayerConfiguration.

    interface AgamaSourceConfiguration {
        asset: string;
        cdn?: string;
        contentDescription?: string;
        contentTitle?: string;
        contentType?: string;
        integration: "agama";
        serviceName?: AgamaServiceName;
        streamType: AgamaStreamType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    asset cdn? contentDescription? contentTitle? contentType? integration serviceName? streamType

    Properties

    asset: string

    The identifier of the asset.

    cdn?: string

    The CDN from which the content is served.


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

    contentDescription?: string

    The description of the content.


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

    contentTitle?: string

    The title of the content.


    - Available since v2.61.0.
    - Will not be reported to Agama if not present
    - The format is title or title/season or title/season/episode (e.g. Game of Thrones/Season 4/Episode 7)

    contentType?: string

    The type of the content.


    - Available since v2.61.0.
    - Will not be reported to Agama if not present
    - Suggested values are 'trailer', 'movie', 'news', 'documentary', ...

    integration: "agama"

    The identifier of the analytics integration.

    serviceName?: AgamaServiceName

    The service name.


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

    streamType: AgamaStreamType

    The stream type of the session.

    Settings

    Member Visibility

    On This Page

    Properties