Skip to content

Type Alias: CmcdDecodeOptions ​

ts
type CmcdDecodeOptions = object;

Defined in: CmcdDecodeOptions.ts:6

Options for decoding CMCD data.

Properties ​

convertToLatest? ​

ts
convertToLatest?: boolean;

Defined in: CmcdDecodeOptions.ts:16

When true, up-converts version 1 data to version 2 format by wrapping scalar values in arrays for inner-list keys. Examples: bl, br, mtp.

The result has a consistent structure regardless of the source version. This conversion corresponds to the down-conversion during encoding.

Default Value ​

false


useSymbol? ​

ts
useSymbol?: boolean;

Defined in: CmcdDecodeOptions.ts:26

Controls how the decoded data represents RFC 8941 token values. If omitted, tokens decode to plain strings, which re-encoding cannot distinguish from string values. true decodes tokens as registry Symbols and false as SfToken instances. Either preserved representation re-encodes as a bare token, so a decode/encode round trip reproduces the wire bytes.

A Streaming Video Technology Alliance project.