Documentation
    Preparing search index...

    Module @svta/cml-cmcdBeta

    A collection of tools for working with Common Media Client Data (CMCD).

    @svta/cml-cmcd

    Common Media Client Data (CMCD) encoding and decoding.

    npm i @svta/cml-cmcd
    
    import { CmcdReportingMode, encodeCmcd } from "@svta/cml-cmcd";

    const input = {
    br: 1000,
    "com.example-hello": "world",
    ec: ["ERR001", "ERR002"],
    su: true,
    };
    const options = { version: 2, reportingMode: CmcdReportingMode.REQUEST };
    const result = encodeCmcd(input, options);
    // result === 'br=1000,com.example-hello="world",ec=("ERR001" "ERR002"),su,v=2'

    Enumerations

    CmcdEncoding
    CmcdEventType
    CmcdHeaderField
    CmcdObjectType
    CmcdPlayerState
    CmcdReportingMode
    CmcdStreamingFormat
    CmcdStreamType
    CmcdTransmissionMode

    Type Aliases

    Cmcd
    CmcdCustomKey
    CmcdData
    CmcdEncodeOptions
    CmcdEvent
    CmcdEventExcludedKeys
    CmcdFormatter
    CmcdFormatterMap
    CmcdFormatterOptions
    CmcdHeaderMap
    CmcdHeadersMap
    CmcdKey
    CmcdReportTarget
    CmcdRequest
    CmcdResponse
    CmcdValue

    Variables

    CMCD_COMMON_KEYS
    CMCD_DEFAULT_TIME_INTERVAL
    CMCD_EVENT_KEYS
    CMCD_EVENT_MODE
    CMCD_FORMATTER_MAP
    CMCD_HEADERS
    CMCD_JSON
    CMCD_KEYS
    CMCD_OBJECT
    CMCD_PARAM
    CMCD_QUERY
    CMCD_REQUEST
    CMCD_REQUEST_KEYS
    CMCD_REQUEST_MODE
    CMCD_RESPONSE_KEYS
    CMCD_RESPONSE_MODE
    CMCD_SESSION
    CMCD_STATUS
    CMCD_V1
    CMCD_V1_KEYS
    CMCD_V2
    CmcdFormatters

    Functions

    appendCmcdHeaders
    appendCmcdQuery
    decodeCmcd
    encodeCmcd
    fromCmcdHeaders
    fromCmcdQuery
    fromCmcdUrl
    groupCmcdHeaders
    isCmcdCustomKey
    isCmcdEventKey
    isCmcdRequestKey
    isCmcdResponseKey
    isCmcdV1Key
    prepareCmcdData
    toCmcdHeaders
    toCmcdJson
    toCmcdQuery
    toCmcdReport
    toCmcdUrl