THEOplayer Web SDK Connectors
    Preparing search index...

    Interface Configuration

    The configuration object for the Common Media Client Data (CTA-5004) connector.

    interface Configuration {
        contentID?: string;
        customKeys?: { [key: string]: string | number | boolean };
        jsonObjectTargetURI?: string;
        sendRequestID?: boolean;
        sessionID?: string;
        transmissionMode: TransmissionMode;
    }
    Index

    Properties

    contentID? customKeys? jsonObjectTargetURI? sendRequestID? sessionID? transmissionMode

    Properties

    contentID?: string

    The content ID parameter which should be passed as a CMCD value. If left empty, no content ID will be sent.

    customKeys?: { [key: string]: string | number | boolean }

    An object containing custom keys which should be added to the generated CMCD parameters. Note custom keys MUST carry a hyphenated prefix to ensure that there will not be a namespace collision with future revisions to the specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.

    jsonObjectTargetURI?: string

    The target URI where client data is to be delivered in case the Configuration.transmissionMode is set to TransmissionMode.JSON_OBJECT.

    sendRequestID?: boolean

    A flag to indicate if request IDs should be sent or not. When set to a truthly value, a UUIDv4 will be sent as a request id (rid) with every request to allow for request tracing.

    sessionID?: string

    The session ID parameter which should be passed as a CMCD value. If left empty, a UUIDv4 will be generated when applying the configuration.

    transmissionMode: TransmissionMode

    The data transmission mode as defined in section 2 of the specification. When no transmission mode is selected, TransmissionMode.QUERY_ARGUMENT will be used in order to avoid CORS preflight requests in browsers.

    Settings

    Member Visibility

    On This Page

    Properties