@svta/common-media-library/dist/cjs/cmcd/CmcdEncodeOptions.d.ts

A common library for media playback in JavaScript

import type { CmcdFormatterMap } from './CmcdFormatterMap.js';
import type { CmcdHeaderMap } from './CmcdHeaderMap.js';
import type { CmcdKey } from './CmcdKey.js';
import type { CmcdReportingMode } from './CmcdReportingMode.js';
/**
 * Options for encoding CMCD values.
 *
 * @group CMCD
 *
 * @beta
 */
export type CmcdEncodeOptions = {
    /**
     * The version of the CMCD specification to use.
     *
     * @defaultValue `1`
     */
    version?: number;
    /**
     * The reporting mode to use.
     *
     * @defaultValue `CmcdReportingMode.REQUEST`
     */
    reportingMode?: CmcdReportingMode;
    /**
     * A map of CMCD keys to custom formatters.
     */
    formatters?: Partial<CmcdFormatterMap>;
    /**
     * A map of CMCD header fields to custom CMCD keys.
     */
    customHeaderMap?: Partial<CmcdHeaderMap>;
    /**
     * A filter function for CMCD keys.
     *
     * @param key - The CMCD key to filter.
     *
     * @returns `true` if the key should be included, `false` otherwise.
     */
    filter?: (key: CmcdKey) => boolean;
    /**
     * The base URL to use for relative URLs.
     */
    baseUrl?: string;
};
//# sourceMappingURL=CmcdEncodeOptions.d.ts.map