CML
    Preparing search index...

    Module @svta/cml-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'

    Documents

    User Guide
    Validation Guide

    Enumerations

    CmcdEventType
    CmcdHeaderField
    CmcdObjectType
    CmcdPlayerState
    CmcdReportingMode
    CmcdStreamingFormat
    CmcdStreamType
    CmcdTransmissionMode

    Classes

    CmcdReporter

    Type Aliases

    Cmcd
    CmcdCustomKey
    CmcdCustomValue
    CmcdData
    CmcdDataValidationResult
    CmcdDecodeOptions
    CmcdEncodeOptions
    CmcdEvent
    CmcdEventReportConfig
    CmcdEventsValidationResult
    CmcdFormatter
    CmcdFormatterMap
    CmcdFormatterOptions
    CmcdHeaderKey
    CmcdHeaderMap
    CmcdHeaderValue
    CmcdKey
    CmcdObjectTypeList
    CmcdReportConfig
    CmcdReporterConfig
    CmcdRequest
    CmcdRequestKey
    CmcdRequestReport
    CmcdRequestReportConfig
    CmcdResponse
    CmcdV1
    CmcdV1Data
    CmcdV2Data
    CmcdValidationIssue
    CmcdValidationOptions
    CmcdValidationResult
    CmcdValidationSeverity
    CmcdValue
    CmcdVersion

    Variables

    CMCD_DEFAULT_TIME_INTERVAL
    CMCD_EVENT_AD_BREAK_END
    CMCD_EVENT_AD_BREAK_START
    CMCD_EVENT_AD_END
    CMCD_EVENT_AD_START
    CMCD_EVENT_BACKGROUNDED_MODE
    CMCD_EVENT_BITRATE_CHANGE
    CMCD_EVENT_CONTENT_ID
    CMCD_EVENT_CUSTOM_EVENT
    CMCD_EVENT_ERROR
    CMCD_EVENT_KEYS
    CMCD_EVENT_MODE
    CMCD_EVENT_MUTE
    CMCD_EVENT_PLAY_STATE
    CMCD_EVENT_PLAYER_COLLAPSE
    CMCD_EVENT_PLAYER_EXPAND
    CMCD_EVENT_RESPONSE_RECEIVED
    CMCD_EVENT_SKIP
    CMCD_EVENT_TIME_INTERVAL
    CMCD_EVENT_UNMUTE
    CMCD_FORMATTER_MAP
    CMCD_HEADER_FIELDS
    CMCD_HEADER_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_SESSION
    CMCD_STATUS
    CMCD_V1
    CMCD_V1_KEYS
    CMCD_V2
    CMCD_VALIDATION_SEVERITY_ERROR
    CMCD_VALIDATION_SEVERITY_WARNING
    CmcdValidationSeverity

    Functions

    appendCmcdHeaders
    appendCmcdQuery
    decodeCmcd
    encodeCmcd
    fromCmcdHeaders
    fromCmcdQuery
    fromCmcdUrl
    groupCmcdHeaders
    isCmcdCustomKey
    isCmcdEventKey
    isCmcdRequestKey
    isCmcdResponseReceivedKey
    isCmcdV1Data
    isCmcdV1Key
    isCmcdV2Data
    prepareCmcdData
    toCmcdHeaders
    toCmcdQuery
    toCmcdUrl
    toCmcdValue
    validateCmcd
    validateCmcdEvents
    validateCmcdHeaders
    validateCmcdKeys
    validateCmcdRequest
    validateCmcdStructure
    validateCmcdValues