From d9886869ad460dfa4b14c22b821ae2b1fe9ac662 Mon Sep 17 00:00:00 2001 From: littlespex Date: Wed, 28 Aug 2024 14:36:29 +0000 Subject: [PATCH] deploy: 2fbc22dbe83d40b5c6d38a530bc87179638a72fb --- classes/CaptionScreen.html | 10 +++---- classes/CaptionsLogger.html | 4 +-- classes/Cta608Channel.html | 4 +-- classes/Cta608Parser.html | 10 +++---- classes/PenState.html | 4 +-- classes/Row.html | 10 +++---- classes/SccParser.html | 4 +-- classes/SfItem.html | 4 +-- classes/SfToken.html | 4 +-- classes/StyledUnicodeChar.html | 4 +-- enums/CmcdEncoding.html | 8 ++--- enums/CmcdHeaderField.html | 10 +++---- enums/CmcdObjectType.html | 20 ++++++------- enums/CmcdStreamType.html | 6 ++-- enums/CmcdStreamingFormat.html | 10 +++---- enums/CmsdHeaderField.html | 6 ++-- enums/CmsdObjectType.html | 20 ++++++------- enums/CmsdStreamType.html | 6 ++-- enums/CmsdStreamingFormat.html | 10 +++---- enums/VerboseLevel.html | 4 +-- functions/appendCmcdHeaders.html | 2 +- functions/appendCmcdQuery.html | 2 +- functions/base64decode.html | 2 +- functions/base64encode.html | 2 +- functions/canParseId3.html | 2 +- functions/dashToHam.html | 2 +- functions/decodeCmcd.html | 2 +- functions/decodeCmsdDynamic.html | 2 +- functions/decodeCmsdStatic.html | 2 +- functions/decodeSfDict.html | 2 +- functions/decodeSfItem.html | 2 +- functions/decodeSfList.html | 2 +- functions/encodeCmcd.html | 2 +- functions/encodeCmsdDynamic.html | 4 +-- functions/encodeCmsdStatic.html | 2 +- functions/encodeSfDict.html | 2 +- functions/encodeSfItem.html | 4 +-- functions/encodeSfList.html | 2 +- functions/extractCta608Data.html | 2 +- functions/findCta608Nalus.html | 2 +- functions/fromCmcdHeaders.html | 2 +- functions/fromCmcdQuery.html | 2 +- functions/getId3Frames.html | 2 +- functions/getId3Timestamp.html | 2 +- functions/getTracksFromPresentation.html | 2 +- functions/getTracksFromSelectionSet.html | 2 +- functions/getTracksFromSwitchingSet.html | 2 +- functions/hamToDash.html | 2 +- functions/hamToHls.html | 2 +- functions/hlsToHam.html | 2 +- functions/roundToEven.html | 2 +- functions/toCmcdHeaders.html | 2 +- functions/toCmcdJson.html | 2 +- functions/toCmcdQuery.html | 2 +- functions/urlToRelativePath.html | 2 +- functions/utf8ArrayToStr.html | 2 +- functions/uuid.html | 2 +- functions/validatePresentation.html | 2 +- functions/validateSegment.html | 2 +- functions/validateSegments.html | 2 +- functions/validateSelectionSet.html | 2 +- functions/validateSelectionSets.html | 2 +- functions/validateSwitchingSet.html | 2 +- functions/validateSwitchingSets.html | 2 +- functions/validateTrack.html | 2 +- functions/validateTracks.html | 2 +- interfaces/Cmcd.html | 38 ++++++++++++------------ interfaces/CmcdEncodeOptions.html | 10 +++---- interfaces/CmsdDynamic.html | 6 ++-- interfaces/CmsdDynamicParams.html | 12 ++++---- interfaces/CmsdEncodeOptions.html | 4 +-- interfaces/CmsdStatic.html | 26 ++++++++-------- interfaces/CommonMediaRequest.html | 20 ++++++------- interfaces/CommonMediaResponse.html | 20 ++++++------- interfaces/CueHandler.html | 4 +-- interfaces/PACData.html | 4 +-- interfaces/ResourceTiming.html | 4 +-- types/AlignedSwitchingSet.html | 2 +- types/AudioTrack.html | 2 +- types/CaptionModes.html | 2 +- types/CmcdCustomKey.html | 2 +- types/CmcdFormatter.html | 2 +- types/CmcdHeadersMap.html | 2 +- types/CmcdKey.html | 2 +- types/CmcdValue.html | 2 +- types/CmsdCustomKey.html | 2 +- types/CmsdValue.html | 2 +- types/DecodedId3Frame.html | 2 +- types/FrameRate.html | 2 +- types/Ham.html | 2 +- types/Id3Frame.html | 2 +- types/Manifest.html | 2 +- types/ManifestFormat.html | 2 +- types/PenStyles.html | 2 +- types/Presentation.html | 2 +- types/RequestInterceptor.html | 2 +- types/ResponseInterceptor.html | 2 +- types/Segment.html | 2 +- types/SelectionSet.html | 2 +- types/SfBareItem.html | 2 +- types/SfDecodeOptions.html | 2 +- types/SfDictionary.html | 2 +- types/SfEncodeOptions.html | 2 +- types/SfInnerList.html | 2 +- types/SfMember.html | 2 +- types/SfParameters.html | 2 +- types/SupportedField.html | 2 +- types/SwitchingSet.html | 2 +- types/TextTrack.html | 2 +- types/Track.html | 2 +- types/TrackType.html | 2 +- types/Validation.html | 2 +- types/VideoTrack.html | 2 +- variables/CMCD_PARAM.html | 2 +- variables/CMCD_V1.html | 2 +- variables/CMSD_DYNAMIC.html | 2 +- variables/CMSD_STATIC.html | 2 +- variables/CMSD_V1.html | 2 +- variables/CmcdFormatters.html | 2 +- 119 files changed, 243 insertions(+), 243 deletions(-) diff --git a/classes/CaptionScreen.html b/classes/CaptionScreen.html index de9ef920..e4d1e0ef 100644 --- a/classes/CaptionScreen.html +++ b/classes/CaptionScreen.html @@ -1,5 +1,5 @@ CaptionScreen | @svta/common-media-library

Class CaptionScreenBeta

Keep a CTA-608 screen of 32x15 styled characters

-

Constructors

constructor +

Constructors

constructor

Methods

backSpace clearToEndOfRow copy @@ -16,7 +16,7 @@ setPAC setPen setRollUpRows -

Constructors

constructor

Methods

backSpace

clearToEndOfRow

copy

equals

getDisplayText

  • getDisplayText(asOneRow?): string

  • Get all non-empty rows with as unicode text.

    -

    Parameters

    • Optional asOneRow: boolean

    Returns string

getTextAndFormat

insertChar

  • insertChar(char): void

  • Insert a character (without styling) in the current row.

    -

    Parameters

    • char: number

    Returns void

isEmpty

moveCursor

reset

rollUp

setBkgData

  • setBkgData(bkgData): void

  • Set background/extra foreground, but first do back_space, and then insert space (backwards compatibility).

    -

    Parameters

    Returns void

setCursor

setPAC

setPen

setRollUpRows

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Methods

backSpace

clearToEndOfRow

copy

equals

getDisplayText

  • getDisplayText(asOneRow?): string

  • Get all non-empty rows with as unicode text.

    +

    Parameters

    • Optional asOneRow: boolean

    Returns string

getTextAndFormat

insertChar

  • insertChar(char): void

  • Insert a character (without styling) in the current row.

    +

    Parameters

    • char: number

    Returns void

isEmpty

moveCursor

reset

rollUp

setBkgData

  • setBkgData(bkgData): void

  • Set background/extra foreground, but first do back_space, and then insert space (backwards compatibility).

    +

    Parameters

    Returns void

setCursor

setPAC

setPen

setRollUpRows

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/classes/CaptionsLogger.html b/classes/CaptionsLogger.html index 3d559828..e0ea1114 100644 --- a/classes/CaptionsLogger.html +++ b/classes/CaptionsLogger.html @@ -1,6 +1,6 @@ CaptionsLogger | @svta/common-media-library

Class CaptionsLoggerBeta

CaptionsLogger. To be removed in the future.

-

Constructors

constructor +

Constructors

constructor

Properties

time verboseLevel

Methods

log -

Constructors

constructor

Properties

time

time: null | number = null

verboseLevel

verboseLevel: VerboseLevel = VerboseLevel.ERROR

Methods

log

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

time

time: null | number = null

verboseLevel

verboseLevel: VerboseLevel = VerboseLevel.ERROR

Methods

log

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/classes/Cta608Channel.html b/classes/Cta608Channel.html index 66b40d7d..aaab38a7 100644 --- a/classes/Cta608Channel.html +++ b/classes/Cta608Channel.html @@ -1,5 +1,5 @@ Cta608Channel | @svta/common-media-library

Class Cta608ChannelBeta

CTA-608 Channel

-

Constructors

constructor +

Constructors

constructor

Methods

ccAOF ccAON ccBS @@ -23,4 +23,4 @@ setBkgData setMode setPAC -

Constructors

constructor

Methods

ccAOF

ccAON

ccBS

ccCR

ccDER

ccEDM

ccENM

ccEOC

ccFON

ccMIDROW

ccRCL

ccRDC

ccRTD

ccRU

ccTO

ccTR

cueSplitAtTime

insertChars

outputDataUpdate

reset

setBkgData

setMode

setPAC

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Methods

ccAOF

ccAON

ccBS

ccCR

ccDER

ccEDM

ccENM

ccEOC

ccFON

ccMIDROW

ccRCL

ccRDC

ccRTD

ccRU

ccTO

ccTR

cueSplitAtTime

insertChars

outputDataUpdate

reset

setBkgData

setMode

setPAC

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/classes/Cta608Parser.html b/classes/Cta608Parser.html index d29f4fa6..e8efacb7 100644 --- a/classes/Cta608Parser.html +++ b/classes/Cta608Parser.html @@ -1,11 +1,11 @@ Cta608Parser | @svta/common-media-library

Class Cta608ParserBeta

CEA-608 caption parser.

-

Constructors

constructor +

Constructors

constructor

Methods

addData cueSplitAtTime reset -

Constructors

constructor

Methods

addData

  • addData(time, byteList): void

  • Add data for time t in forms of list of bytes (unsigned ints). The bytes are treated as pairs.

    +

Constructors

constructor

Methods

addData

  • addData(time, byteList): void

  • Add data for time t in forms of list of bytes (unsigned ints). The bytes are treated as pairs.

    Parameters

    • time: null | number

      The time in milliseconds

    • byteList: number[]

      The list of bytes

      -

    Returns void

cueSplitAtTime

  • cueSplitAtTime(t): void

  • Trigger the generation of a cue, and the start of a new one if displayScreens are not empty.

    -

    Parameters

    • t: number

    Returns void

reset

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Returns void

cueSplitAtTime

reset

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/classes/PenState.html b/classes/PenState.html index f73a91f9..75d438b8 100644 --- a/classes/PenState.html +++ b/classes/PenState.html @@ -1,5 +1,5 @@ PenState | @svta/common-media-library

Class PenStateBeta

Pen state.

-

Constructors

constructor +

Constructors

constructor

Properties

background flash foreground @@ -10,4 +10,4 @@ isDefault reset setStyles -

Constructors

constructor

Properties

background

background: string = 'black'

flash

flash: boolean = false

foreground

foreground: string = 'white'

italics

italics: boolean = false

underline

underline: boolean = false

Methods

copy

equals

isDefault

reset

setStyles

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

background

background: string = 'black'

flash

flash: boolean = false

foreground

foreground: string = 'white'

italics

italics: boolean = false

underline

underline: boolean = false

Methods

copy

equals

isDefault

reset

setStyles

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/classes/Row.html b/classes/Row.html index 576e4f0a..39f52f1f 100644 --- a/classes/Row.html +++ b/classes/Row.html @@ -1,5 +1,5 @@ Row | @svta/common-media-library

Class RowBeta

CTA-608 row consisting of NR_COLS instances of StyledUnicodeChar.

-

Constructors

constructor +

Constructors

constructor

Properties

chars cueStartTime

Methods

backSpace @@ -14,7 +14,7 @@ moveCursor setCursor setPenStyles -

Constructors

constructor

Properties

chars

chars: StyledUnicodeChar[] = []

cueStartTime

cueStartTime: null | number = null

Methods

backSpace

  • backSpace(): void

  • Backspace, move one step back and clear character.

    -

    Returns void

clear

clearFromPos

  • clearFromPos(startPos): void

  • Parameters

    • startPos: number

    Returns void

clearToEndOfRow

copy

equals

getTextString

insertChar

isEmpty

moveCursor

  • moveCursor(relPos): void

  • Move the cursor relative to current position.

    -

    Parameters

    • relPos: number

    Returns void

setCursor

  • setCursor(absPos): void

  • Set the cursor to a valid column.

    -

    Parameters

    • absPos: number

    Returns void

setPenStyles

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

chars

chars: StyledUnicodeChar[] = []

cueStartTime

cueStartTime: null | number = null

Methods

backSpace

  • backSpace(): void

  • Backspace, move one step back and clear character.

    +

    Returns void

clear

clearFromPos

  • clearFromPos(startPos): void

  • Parameters

    • startPos: number

    Returns void

clearToEndOfRow

copy

equals

getTextString

insertChar

isEmpty

moveCursor

  • moveCursor(relPos): void

  • Move the cursor relative to current position.

    +

    Parameters

    • relPos: number

    Returns void

setCursor

  • setCursor(absPos): void

  • Set the cursor to a valid column.

    +

    Parameters

    • absPos: number

    Returns void

setPenStyles

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/classes/SccParser.html b/classes/SccParser.html index 71d1333d..d2b02f31 100644 --- a/classes/SccParser.html +++ b/classes/SccParser.html @@ -1,5 +1,5 @@ SccParser | @svta/common-media-library

Class SccParserBeta

SCC Parser

-

Constructors

constructor +

Constructors

constructor

Properties

field hasHeader nrLinesParsed @@ -10,4 +10,4 @@ parse parseDataLine timeConverter -

Constructors

constructor

Properties

field

field: any

hasHeader

hasHeader: boolean = false

nrLinesParsed

nrLinesParsed: number = 0

processor

processor: any

Methods

getField

getHeaderStatus

getLinesParsed

parse

parseDataLine

  • parseDataLine(line): null | [number, number[]]

  • Parameters

    • line: string

    Returns null | [number, number[]]

timeConverter

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

field

field: any

hasHeader

hasHeader: boolean = false

nrLinesParsed

nrLinesParsed: number = 0

processor

processor: any

Methods

getField

getHeaderStatus

getLinesParsed

parse

parseDataLine

  • parseDataLine(line): null | [number, number[]]

  • Parameters

    • line: string

    Returns null | [number, number[]]

timeConverter

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/classes/SfItem.html b/classes/SfItem.html index 7e40e1af..2ff80ab3 100644 --- a/classes/SfItem.html +++ b/classes/SfItem.html @@ -1,5 +1,5 @@ SfItem | @svta/common-media-library

Class SfItemBeta

Structured Field Item

-

Constructors

constructor +

Constructors

constructor

Properties

params? value -

Constructors

constructor

Properties

Optional params

params?: SfParameters

value

value: SfBareItem

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

Optional params

params?: SfParameters

value

value: SfBareItem

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/classes/SfToken.html b/classes/SfToken.html index 0f63f5be..c42cb198 100644 --- a/classes/SfToken.html +++ b/classes/SfToken.html @@ -1,4 +1,4 @@ SfToken | @svta/common-media-library

Class SfTokenBeta

A class to represent structured field tokens when Symbol is not available.

-

Constructors

constructor +

Constructors

constructor

Properties

description -

Constructors

constructor

Properties

description

description: string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

description

description: string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/classes/StyledUnicodeChar.html b/classes/StyledUnicodeChar.html index 6c9bdeb7..8020c87c 100644 --- a/classes/StyledUnicodeChar.html +++ b/classes/StyledUnicodeChar.html @@ -1,5 +1,5 @@ StyledUnicodeChar | @svta/common-media-library

Class StyledUnicodeCharBeta

Unicode character with styling and background.

-

Constructors

constructor +

Constructors

constructor

Properties

penState uchar

Methods

copy @@ -8,4 +8,4 @@ reset setChar setPenState -

Constructors

constructor

Properties

penState

penState: PenState = ...

uchar

uchar: string = ' '

Methods

copy

equals

isEmpty

reset

setChar

setPenState

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

penState

penState: PenState = ...

uchar

uchar: string = ' '

Methods

copy

equals

isEmpty

reset

setChar

setPenState

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/CmcdEncoding.html b/enums/CmcdEncoding.html index 4f490606..9cba72fc 100644 --- a/enums/CmcdEncoding.html +++ b/enums/CmcdEncoding.html @@ -1,8 +1,8 @@ CmcdEncoding | @svta/common-media-library

Enumeration CmcdEncodingBeta

CMCD encoding types.

-

Enumeration Members

HEADERS +

Enumeration Members

HEADERS JSON QUERY

Enumeration Members

HEADERS

HEADERS: "headers"

Request headers

-

JSON

JSON: "json"

JSON

-

QUERY

QUERY: "query"

Query string

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

JSON

JSON: "json"

JSON

+

QUERY

QUERY: "query"

Query string

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/CmcdHeaderField.html b/enums/CmcdHeaderField.html index 06ddfd80..b5c6c595 100644 --- a/enums/CmcdHeaderField.html +++ b/enums/CmcdHeaderField.html @@ -1,10 +1,10 @@ CmcdHeaderField | @svta/common-media-library

Enumeration CmcdHeaderFieldBeta

CMCD header fields.

-

Enumeration Members

OBJECT +

Enumeration Members

OBJECT REQUEST SESSION STATUS

Enumeration Members

OBJECT

OBJECT: "CMCD-Object"

keys whose values vary with the object being requested.

-

REQUEST

REQUEST: "CMCD-Request"

keys whose values vary with each request.

-

SESSION

SESSION: "CMCD-Session"

keys whose values are expected to be invariant over the life of the session.

-

STATUS

STATUS: "CMCD-Status"

keys whose values do not vary with every request or object.

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

REQUEST

REQUEST: "CMCD-Request"

keys whose values vary with each request.

+

SESSION

SESSION: "CMCD-Session"

keys whose values are expected to be invariant over the life of the session.

+

STATUS

STATUS: "CMCD-Status"

keys whose values do not vary with every request or object.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/CmcdObjectType.html b/enums/CmcdObjectType.html index ea70344c..39c08efd 100644 --- a/enums/CmcdObjectType.html +++ b/enums/CmcdObjectType.html @@ -1,5 +1,5 @@ CmcdObjectType | @svta/common-media-library

Enumeration CmcdObjectTypeBeta

Common Media Client Data Object Type

-

Enumeration Members

AUDIO +

Enumeration Members

AUDIO CAPTION INIT KEY @@ -9,12 +9,12 @@ TIMED_TEXT VIDEO

Enumeration Members

AUDIO

AUDIO: "a"

audio only

-

CAPTION

CAPTION: "c"

caption or subtitle

-

INIT

INIT: "i"

init segment

-

KEY

KEY: "k"

cryptographic key, license or certificate.

-

MANIFEST

MANIFEST: "m"

text file, such as a manifest or playlist

-

MUXED

MUXED: "av"

muxed audio and video

-

OTHER

OTHER: "o"

other

-

TIMED_TEXT

TIMED_TEXT: "tt"

ISOBMFF timed text track

-

VIDEO

VIDEO: "v"

video only

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

CAPTION

CAPTION: "c"

caption or subtitle

+

INIT

INIT: "i"

init segment

+

KEY

KEY: "k"

cryptographic key, license or certificate.

+

MANIFEST

MANIFEST: "m"

text file, such as a manifest or playlist

+

MUXED

MUXED: "av"

muxed audio and video

+

OTHER

OTHER: "o"

other

+

TIMED_TEXT

TIMED_TEXT: "tt"

ISOBMFF timed text track

+

VIDEO

VIDEO: "v"

video only

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/CmcdStreamType.html b/enums/CmcdStreamType.html index ca567093..8ebfc85c 100644 --- a/enums/CmcdStreamType.html +++ b/enums/CmcdStreamType.html @@ -1,6 +1,6 @@ CmcdStreamType | @svta/common-media-library

Enumeration CmcdStreamTypeBeta

Common Media Client Data Stream Type

-

Enumeration Members

LIVE +

Enumeration Members

LIVE VOD

Enumeration Members

LIVE

LIVE: "l"

Segments become available over time – e.g., LIVE

-

VOD

VOD: "v"

All segments are available – e.g., VOD

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

VOD

VOD: "v"

All segments are available – e.g., VOD

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/CmcdStreamingFormat.html b/enums/CmcdStreamingFormat.html index 44b44434..cc9069ec 100644 --- a/enums/CmcdStreamingFormat.html +++ b/enums/CmcdStreamingFormat.html @@ -1,10 +1,10 @@ CmcdStreamingFormat | @svta/common-media-library

Enumeration CmcdStreamingFormatBeta

Common Media Client Data Streaming Format

-

Enumeration Members

DASH +

Enumeration Members

DASH HLS OTHER SMOOTH

Enumeration Members

DASH

DASH: "d"

MPEG DASH

-

HLS

HLS: "h"

HTTP Live Streaming (HLS)

-

OTHER

OTHER: "o"

Other

-

SMOOTH

SMOOTH: "s"

Smooth Streaming

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

HLS

HLS: "h"

HTTP Live Streaming (HLS)

+

OTHER

OTHER: "o"

Other

+

SMOOTH

SMOOTH: "s"

Smooth Streaming

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/CmsdHeaderField.html b/enums/CmsdHeaderField.html index 9b7b3363..d58af445 100644 --- a/enums/CmsdHeaderField.html +++ b/enums/CmsdHeaderField.html @@ -1,8 +1,8 @@ CmsdHeaderField | @svta/common-media-library

Enumeration CmsdHeaderFieldBeta

CMSD header fields.

-

Enumeration Members

DYNAMIC +

Enumeration Members

DYNAMIC STATIC

Enumeration Members

DYNAMIC

DYNAMIC: "CMSD-Dynamic"

Keys whose values apply only to the next transmission hop. Typically a new CMSD-Dynamic header instance will be added by each intermediary participating in the delivery.

-

STATIC

STATIC: "CMSD-Static"

Keys whose values persist over multiple requests for the object.

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

STATIC

STATIC: "CMSD-Static"

Keys whose values persist over multiple requests for the object.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/CmsdObjectType.html b/enums/CmsdObjectType.html index 304e4cec..663af881 100644 --- a/enums/CmsdObjectType.html +++ b/enums/CmsdObjectType.html @@ -1,5 +1,5 @@ CmsdObjectType | @svta/common-media-library

Enumeration CmsdObjectTypeBeta

Common Media Server Data Object Type

-

Enumeration Members

AUDIO +

Enumeration Members

AUDIO CAPTION INIT KEY @@ -9,12 +9,12 @@ TIMED_TEXT VIDEO

Enumeration Members

AUDIO

AUDIO: "a"

audio only

-

CAPTION

CAPTION: "c"

caption or subtitle

-

INIT

INIT: "i"

init segment

-

KEY

KEY: "k"

cryptographic key, license or certificate.

-

MANIFEST

MANIFEST: "m"

text file, such as a manifest or playlist

-

MUXED

MUXED: "av"

muxed audio and video

-

OTHER

OTHER: "o"

other

-

TIMED_TEXT

TIMED_TEXT: "tt"

ISOBMFF timed text track

-

VIDEO

VIDEO: "v"

video only

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

CAPTION

CAPTION: "c"

caption or subtitle

+

INIT

INIT: "i"

init segment

+

KEY

KEY: "k"

cryptographic key, license or certificate.

+

MANIFEST

MANIFEST: "m"

text file, such as a manifest or playlist

+

MUXED

MUXED: "av"

muxed audio and video

+

OTHER

OTHER: "o"

other

+

TIMED_TEXT

TIMED_TEXT: "tt"

ISOBMFF timed text track

+

VIDEO

VIDEO: "v"

video only

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/CmsdStreamType.html b/enums/CmsdStreamType.html index fa4b0664..d0b7dad0 100644 --- a/enums/CmsdStreamType.html +++ b/enums/CmsdStreamType.html @@ -1,6 +1,6 @@ CmsdStreamType | @svta/common-media-library

Enumeration CmsdStreamTypeBeta

Common Media Server Data Stream Type

-

Enumeration Members

LIVE +

Enumeration Members

LIVE VOD

Enumeration Members

LIVE

LIVE: "l"

Segments become available over time – e.g., LIVE

-

VOD

VOD: "v"

All segments are available – e.g., VOD

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

VOD

VOD: "v"

All segments are available – e.g., VOD

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/CmsdStreamingFormat.html b/enums/CmsdStreamingFormat.html index d49869b4..2119882e 100644 --- a/enums/CmsdStreamingFormat.html +++ b/enums/CmsdStreamingFormat.html @@ -1,10 +1,10 @@ CmsdStreamingFormat | @svta/common-media-library

Enumeration CmsdStreamingFormatBeta

Common Media Server Data Streaming Format

-

Enumeration Members

DASH +

Enumeration Members

DASH HLS OTHER SMOOTH

Enumeration Members

DASH

DASH: "d"

MPEG DASH

-

HLS

HLS: "h"

HTTP Live Streaming (HLS)

-

OTHER

OTHER: "o"

Other

-

SMOOTH

SMOOTH: "s"

Smooth Streaming

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

HLS

HLS: "h"

HTTP Live Streaming (HLS)

+

OTHER

OTHER: "o"

Other

+

SMOOTH

SMOOTH: "s"

Smooth Streaming

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/enums/VerboseLevel.html b/enums/VerboseLevel.html index 9df1dc24..d3e54469 100644 --- a/enums/VerboseLevel.html +++ b/enums/VerboseLevel.html @@ -1,8 +1,8 @@ VerboseLevel | @svta/common-media-library

Enumeration VerboseLevelConst Beta

Logging levels for the CTA-608 parser.

-

Enumeration Members

DATA +

Enumeration Members

DATA DEBUG ERROR INFO TEXT WARNING -

Enumeration Members

DATA

DATA: 3

DEBUG

DEBUG: 3

ERROR

ERROR: 0

INFO

INFO: 2

TEXT

TEXT: 1

WARNING

WARNING: 2

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Enumeration Members

DATA

DATA: 3

DEBUG

DEBUG: 3

ERROR

ERROR: 0

INFO

INFO: 2

TEXT

TEXT: 1

WARNING

WARNING: 2

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/functions/appendCmcdHeaders.html b/functions/appendCmcdHeaders.html index c2e572b4..5acaf0ab 100644 --- a/functions/appendCmcdHeaders.html +++ b/functions/appendCmcdHeaders.html @@ -3,4 +3,4 @@
  • cmcd: Cmcd

    The CMCD object to append.

  • Optional options: CmcdEncodeOptions

    Encode options.

    • Returns Record<string, string>

    The headers with the CMCD header shards appended.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/appendCmcdQuery.html b/functions/appendCmcdQuery.html index 91c2a21f..fafaf97d 100644 --- a/functions/appendCmcdQuery.html +++ b/functions/appendCmcdQuery.html @@ -3,4 +3,4 @@
  • cmcd: Cmcd

    The CMCD object to append.

  • Optional options: CmcdEncodeOptions

    Options for encoding the CMCD object.

    • Returns string

    The URL with the CMCD query args appended.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/base64decode.html b/functions/base64decode.html index 39d43b9b..be1b9ba2 100644 --- a/functions/base64decode.html +++ b/functions/base64decode.html @@ -1,4 +1,4 @@ base64decode | @svta/common-media-library

    Function base64decode

    • base64decode(str): Uint8Array
    • Beta

      Decodes a base64 encoded string into binary data

      Parameters

      • str: string

        The base64 encoded string to decode

      Returns Uint8Array

      The decoded binary data

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/base64encode.html b/functions/base64encode.html index 9e041162..4622a010 100644 --- a/functions/base64encode.html +++ b/functions/base64encode.html @@ -1,4 +1,4 @@ base64encode | @svta/common-media-library

    Function base64encode

    • base64encode(binary): string
    • Beta

      Encodes binary data to base64

      Parameters

      • binary: Uint8Array

        The binary data to encode

      Returns string

      The base64 encoded string

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/canParseId3.html b/functions/canParseId3.html index 9c20f683..4a0b6223 100644 --- a/functions/canParseId3.html +++ b/functions/canParseId3.html @@ -2,4 +2,4 @@

    Parameters

    Returns boolean

    true if an ID3 tag is found

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/dashToHam.html b/functions/dashToHam.html index 1fa7aa6a..04f2b474 100644 --- a/functions/dashToHam.html +++ b/functions/dashToHam.html @@ -5,4 +5,4 @@ into the ham manifest.

    import cmaf from '@svta/common-media-library/cmaf-ham';

    const manifest = cmaf.dashToHam(dashManifest);
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/decodeCmcd.html b/functions/decodeCmcd.html index 4f06cbf7..cdae84cc 100644 --- a/functions/decodeCmcd.html +++ b/functions/decodeCmcd.html @@ -1,4 +1,4 @@ decodeCmcd | @svta/common-media-library

    Function decodeCmcd

    • decodeCmcd(cmcd): Cmcd
    • Beta

      Decode a CMCD string to an object.

      Parameters

      • cmcd: string

        The CMCD string to decode.

      Returns Cmcd

      The decoded CMCD object.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/decodeCmsdDynamic.html b/functions/decodeCmsdDynamic.html index f6d95ee6..789e217c 100644 --- a/functions/decodeCmsdDynamic.html +++ b/functions/decodeCmsdDynamic.html @@ -1,4 +1,4 @@ decodeCmsdDynamic | @svta/common-media-library

    Function decodeCmsdDynamic

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/decodeCmsdStatic.html b/functions/decodeCmsdStatic.html index 1a7f63d5..eb7a02e6 100644 --- a/functions/decodeCmsdStatic.html +++ b/functions/decodeCmsdStatic.html @@ -1,4 +1,4 @@ decodeCmsdStatic | @svta/common-media-library

    Function decodeCmsdStatic

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/decodeSfDict.html b/functions/decodeSfDict.html index d276b7e0..60d2c824 100644 --- a/functions/decodeSfDict.html +++ b/functions/decodeSfDict.html @@ -1,4 +1,4 @@ decodeSfDict | @svta/common-media-library

    Function decodeSfDict

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/decodeSfItem.html b/functions/decodeSfItem.html index 52729aff..9f1f7359 100644 --- a/functions/decodeSfItem.html +++ b/functions/decodeSfItem.html @@ -1,4 +1,4 @@ decodeSfItem | @svta/common-media-library

    Function decodeSfItem

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/decodeSfList.html b/functions/decodeSfList.html index 115ebc11..f446732b 100644 --- a/functions/decodeSfList.html +++ b/functions/decodeSfList.html @@ -1,4 +1,4 @@ decodeSfList | @svta/common-media-library

    Function decodeSfList

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/encodeCmcd.html b/functions/encodeCmcd.html index fa61c7b5..f2685328 100644 --- a/functions/encodeCmcd.html +++ b/functions/encodeCmcd.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The encoded CMCD string.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/encodeCmsdDynamic.html b/functions/encodeCmsdDynamic.html index 928a8d38..80f58708 100644 --- a/functions/encodeCmsdDynamic.html +++ b/functions/encodeCmsdDynamic.html @@ -1,8 +1,8 @@ encodeCmsdDynamic | @svta/common-media-library

    Function encodeCmsdDynamic

    • encodeCmsdDynamic(value): string
    • Beta

      Encode a list of CMSD Dynamic objects.

      Parameters

      • value: SfItem[]

        The list of SfItems to encode.

      Returns string

      The encoded CMSD string.

      -
    • encodeCmsdDynamic(value, cmsd): string
    • Beta

      Encode a single CMSD Dynamic object.

      +
    • encodeCmsdDynamic(value, cmsd): string
    • Beta

      Encode a single CMSD Dynamic object.

      Parameters

      • value: string

        The server name

      • cmsd: CmsdDynamic

        The CMSD object to encode.

      Returns string

      The encoded CMSD string.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/encodeCmsdStatic.html b/functions/encodeCmsdStatic.html index c49f6f67..87b452d4 100644 --- a/functions/encodeCmsdStatic.html +++ b/functions/encodeCmsdStatic.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The encoded CMSD string.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/encodeSfDict.html b/functions/encodeSfDict.html index 25401560..318db0b5 100644 --- a/functions/encodeSfDict.html +++ b/functions/encodeSfDict.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The structured field string

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/encodeSfItem.html b/functions/encodeSfItem.html index 4aee0d9e..f79c632a 100644 --- a/functions/encodeSfItem.html +++ b/functions/encodeSfItem.html @@ -1,8 +1,8 @@ encodeSfItem | @svta/common-media-library

    Function encodeSfItem

    • encodeSfItem(value): string
    • Beta

      Encode a structured field item to a string

      Parameters

      • value: SfItem

        The structured field item to encode

      Returns string

      The structured field string

      -
    • encodeSfItem(value, params?): string
    • Beta

      Encode a structured field value to a string with optional parameters.

      +
    • encodeSfItem(value, params?): string
    • Beta

      Encode a structured field value to a string with optional parameters.

      Parameters

      • value: SfBareItem

        The structured field value to encode

      • Optional params: SfParameters

        The structured field parameters

      Returns string

      The structured field string

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/encodeSfList.html b/functions/encodeSfList.html index 83a9dca5..1afdf19b 100644 --- a/functions/encodeSfList.html +++ b/functions/encodeSfList.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The structured field string

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/extractCta608Data.html b/functions/extractCta608Data.html index c259a255..6450490d 100644 --- a/functions/extractCta608Data.html +++ b/functions/extractCta608Data.html @@ -2,4 +2,4 @@

    Parameters

    Returns number[][]

    The extracted CTA-608 data

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/findCta608Nalus.html b/functions/findCta608Nalus.html index 92b14e35..4a08f856 100644 --- a/functions/findCta608Nalus.html +++ b/functions/findCta608Nalus.html @@ -3,4 +3,4 @@
  • startPos: number

    The start position of the data

  • size: number

    The size of the data

    • Returns number[][]

    The extracted CTA-608 NAL units

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/fromCmcdHeaders.html b/functions/fromCmcdHeaders.html index 51e2864b..ecf31c56 100644 --- a/functions/fromCmcdHeaders.html +++ b/functions/fromCmcdHeaders.html @@ -1,4 +1,4 @@ fromCmcdHeaders | @svta/common-media-library

    Function fromCmcdHeaders

    • fromCmcdHeaders(headers): Cmcd
    • Beta

      Decode CMCD data from request headers.

      Parameters

      • headers: Record<string, string> | Headers

        The request headers to decode.

      Returns Cmcd

      The decoded CMCD data.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/fromCmcdQuery.html b/functions/fromCmcdQuery.html index 019fe50c..af94efce 100644 --- a/functions/fromCmcdQuery.html +++ b/functions/fromCmcdQuery.html @@ -1,4 +1,4 @@ fromCmcdQuery | @svta/common-media-library

    Function fromCmcdQuery

    • fromCmcdQuery(query): Cmcd
    • Beta

      Decode CMCD data from a query string.

      Parameters

      • query: string | URLSearchParams

        The query string to decode.

      Returns Cmcd

      The decoded CMCD data.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getId3Frames.html b/functions/getId3Frames.html index 1e6c317a..df3c431c 100644 --- a/functions/getId3Frames.html +++ b/functions/getId3Frames.html @@ -1,4 +1,4 @@ getId3Frames | @svta/common-media-library

    Function getId3Frames

    • getId3Frames(id3Data): Id3Frame[]
    • Beta

      Returns an array of ID3 frames found in all the ID3 tags in the id3Data

      Parameters

      • id3Data: Uint8Array

        The ID3 data containing one or more ID3 tags

      Returns Id3Frame[]

      Array of ID3 frame objects

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getId3Timestamp.html b/functions/getId3Timestamp.html index 0fad6f3d..3f13b4cd 100644 --- a/functions/getId3Timestamp.html +++ b/functions/getId3Timestamp.html @@ -1,4 +1,4 @@ getId3Timestamp | @svta/common-media-library

    Function getId3Timestamp

    • getId3Timestamp(data): number | undefined
    • Beta

      Searches for the Elementary Stream timestamp found in the ID3 data chunk

      Parameters

      • data: Uint8Array

        Block of data containing one or more ID3 tags

      Returns number | undefined

      The timestamp

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getTracksFromPresentation.html b/functions/getTracksFromPresentation.html index 821841a3..02054b3c 100644 --- a/functions/getTracksFromPresentation.html +++ b/functions/getTracksFromPresentation.html @@ -2,4 +2,4 @@

    Parameters

    Returns Track[]

    Track[]

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getTracksFromSelectionSet.html b/functions/getTracksFromSelectionSet.html index 6a701985..d9ab0b97 100644 --- a/functions/getTracksFromSelectionSet.html +++ b/functions/getTracksFromSelectionSet.html @@ -2,4 +2,4 @@

    Parameters

    Returns Track[]

    Track[]

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getTracksFromSwitchingSet.html b/functions/getTracksFromSwitchingSet.html index 65b28cfc..793aa298 100644 --- a/functions/getTracksFromSwitchingSet.html +++ b/functions/getTracksFromSwitchingSet.html @@ -2,4 +2,4 @@

    Parameters

    Returns Track[]

    Track[]

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hamToDash.html b/functions/hamToDash.html index f637831f..68e3df5d 100644 --- a/functions/hamToDash.html +++ b/functions/hamToDash.html @@ -5,4 +5,4 @@ array into the dash manifest.

    import cmaf from '@svta/common-media-library/cmaf-ham';

    const manifest = cmaf.hamToDash(presentations);
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hamToHls.html b/functions/hamToHls.html index 8e4f90b9..6486e8ce 100644 --- a/functions/hamToHls.html +++ b/functions/hamToHls.html @@ -5,4 +5,4 @@ array into the hls manifest.

    import cmaf from '@svta/common-media-library/cmaf-ham';

    const manifest = cmaf.hamToHls(presentations);
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hlsToHam.html b/functions/hlsToHam.html index 8ac617b4..f58af40a 100644 --- a/functions/hlsToHam.html +++ b/functions/hlsToHam.html @@ -6,4 +6,4 @@ ancillaryManifests array into the ham manifest.

    import cmaf from '@svta/common-media-library/cmaf-ham';

    const manifest = cmaf.hlsToHam(hlsManifest);
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/roundToEven.html b/functions/roundToEven.html index be54104d..0b16766e 100644 --- a/functions/roundToEven.html +++ b/functions/roundToEven.html @@ -3,4 +3,4 @@

    Parameters

    Returns number

    The rounded value

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toCmcdHeaders.html b/functions/toCmcdHeaders.html index 21b89d70..a695f7cb 100644 --- a/functions/toCmcdHeaders.html +++ b/functions/toCmcdHeaders.html @@ -2,4 +2,4 @@

    Parameters

    Returns Record<CmcdHeaderField, string>

    The CMCD header shards.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toCmcdJson.html b/functions/toCmcdJson.html index 0b94f4fa..10c8dae9 100644 --- a/functions/toCmcdJson.html +++ b/functions/toCmcdJson.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The CMCD JSON.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toCmcdQuery.html b/functions/toCmcdQuery.html index d2fcd73c..bb20281d 100644 --- a/functions/toCmcdQuery.html +++ b/functions/toCmcdQuery.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The CMCD query arg.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/urlToRelativePath.html b/functions/urlToRelativePath.html index 22db0b82..d9892ca2 100644 --- a/functions/urlToRelativePath.html +++ b/functions/urlToRelativePath.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The relative path

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/utf8ArrayToStr.html b/functions/utf8ArrayToStr.html index cb349af4..94841a3d 100644 --- a/functions/utf8ArrayToStr.html +++ b/functions/utf8ArrayToStr.html @@ -1,4 +1,4 @@ utf8ArrayToStr | @svta/common-media-library

    Function utf8ArrayToStr

    • utf8ArrayToStr(array, exitOnNull?): string
    • Beta

      Converts a UTF-8 array to a string.

      Parameters

      • array: Uint8Array

        The UTF-8 array to convert

      • exitOnNull: boolean = false

      Returns string

      The string

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/uuid.html b/functions/uuid.html index e6204b7e..409470e3 100644 --- a/functions/uuid.html +++ b/functions/uuid.html @@ -1,3 +1,3 @@ uuid | @svta/common-media-library

    Function uuid

    • uuid(): string
    • Beta

      Generate a random v4 UUID

      Returns string

      A random v4 UUID

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validatePresentation.html b/functions/validatePresentation.html index 5dabf039..7560a8a8 100644 --- a/functions/validatePresentation.html +++ b/functions/validatePresentation.html @@ -9,4 +9,4 @@

    Example

    import cmaf, { Presentation } from '@svta/common-media-library/cmaf-ham';
    ...

    // const presentation: Presentation = ...;

    const validation = cmaf.validatePresentation(presentation);

    Example output: { status: true|false, errorMessages: [...] }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validateSegment.html b/functions/validateSegment.html index 525f74d6..1504a269 100644 --- a/functions/validateSegment.html +++ b/functions/validateSegment.html @@ -8,4 +8,4 @@
  • Optional trackId: string

    Optional: parent track id

  • Optional prevValidation: Validation

    Optional: validation object from parent previous validate method call

    • Returns Validation

    Validation

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validateSegments.html b/functions/validateSegments.html index f8f2f846..406d0167 100644 --- a/functions/validateSegments.html +++ b/functions/validateSegments.html @@ -6,4 +6,4 @@

    Example

    import cmaf, { Segment } from '@svta/common-media-library/cmaf-ham';
    ...

    // const segments: Segment[] = ...;

    const validation = cmaf.validateSegments(segments);

    Example output: { status: true|false, errorMessages: [...] }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validateSelectionSet.html b/functions/validateSelectionSet.html index 682b00b4..064b5e5a 100644 --- a/functions/validateSelectionSet.html +++ b/functions/validateSelectionSet.html @@ -11,4 +11,4 @@

    Example

    import cmaf, { SelectionSet } from '@svta/common-media-library/cmaf-ham';
    ...

    // const selectionSet: SelectionSet = ...;

    const validation = cmaf.validateSelectionSet(selectionSet);

    Example output: { status: true|false, errorMessages: [...] }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validateSelectionSets.html b/functions/validateSelectionSets.html index 5d4693c8..89843a32 100644 --- a/functions/validateSelectionSets.html +++ b/functions/validateSelectionSets.html @@ -7,4 +7,4 @@

    Example

    import cmaf, { SelectionSet } from '@svta/common-media-library/cmaf-ham';
    ...

    // const selectionSets: SelectionSet[] = ...;

    const validation = cmaf.validateSelectionSets(selectionSets);

    Example output: { status: true|false, errorMessages: [...] }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validateSwitchingSet.html b/functions/validateSwitchingSet.html index 2315869a..53ac8905 100644 --- a/functions/validateSwitchingSet.html +++ b/functions/validateSwitchingSet.html @@ -11,4 +11,4 @@

    Example

    import cmaf, { SwitchingSet } from '@svta/common-media-library/cmaf-ham';
    ...

    // const switchingSet: SwitchingSet = ...;

    const validation = cmaf.validateSwitchingSet(switchingSet);

    Example output: { status: true|false, errorMessages: [...] }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validateSwitchingSets.html b/functions/validateSwitchingSets.html index 7c5ed6e7..ae836909 100644 --- a/functions/validateSwitchingSets.html +++ b/functions/validateSwitchingSets.html @@ -7,4 +7,4 @@

    Example

    import cmaf, { SwitchingSet } from '@svta/common-media-library/cmaf-ham';
    ...

    // const switchingSets: SwitchingSet[] = ...;

    const validation = cmaf.validateSwitchingSets(switchingSets);

    Example output: { status: true|false, errorMessages: [...] }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validateTrack.html b/functions/validateTrack.html index 51edce3c..1f0b7c89 100644 --- a/functions/validateTrack.html +++ b/functions/validateTrack.html @@ -12,4 +12,4 @@

    Example

    import cmaf, { Track } from '@svta/common-media-library/cmaf-ham';
    ...

    // const track: Track = ...;

    const validation = cmaf.validateTrack(track);

    Example output: { status: true|false, errorMessages: [...] }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validateTracks.html b/functions/validateTracks.html index 3a0e21f6..719f77be 100644 --- a/functions/validateTracks.html +++ b/functions/validateTracks.html @@ -7,4 +7,4 @@

    Example

    import cmaf, { Track } from '@svta/common-media-library/cmaf-ham';
    ...

    // const tracks: Track[] = ...;

    const validation = cmaf.validateTracks(tracks);

    Example output: { status: true|false, errorMessages: [...] }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/Cmcd.html b/interfaces/Cmcd.html index 36be313b..0976f879 100644 --- a/interfaces/Cmcd.html +++ b/interfaces/Cmcd.html @@ -2,7 +2,7 @@

    See

    Spec

    interface Cmcd {
        bl?: number;
        br?: number;
        bs?: boolean;
        cid?: string;
        d?: number;
        dl?: number;
        mtp?: number;
        nor?: string;
        nrr?: string;
        ot?: CmcdObjectType;
        pr?: number;
        rtp?: number;
        sf?: CmcdStreamingFormat;
        sid?: string;
        st?: CmcdStreamType;
        su?: boolean;
        tb?: number;
        v?: number;
        [index: CmcdCustomKey]: CmcdValue;
    }

    Indexable

    [index: CmcdCustomKey]: CmcdValue

    Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.

    -

    Properties

    bl? +

    Properties

    bl? br? bs? cid? @@ -24,44 +24,44 @@

    The buffer length associated with the media object being requested. This value MUST be rounded to the nearest 100 ms. This key SHOULD only be sent with an object type of ‘a’, ‘v’ or ‘av’.

    Integer milliseconds

    -

    Optional br

    br?: number

    Encoded bitrate

    +

    Optional br

    br?: number

    Encoded bitrate

    The encoded bitrate of the audio or video object being requested. This may not be known precisely by the player; however, it MAY be estimated based upon playlist/manifest declarations. If the playlist declares both peak and average bitrate values, the peak value should be transmitted.

    Integer kbps

    -

    Optional bs

    bs?: boolean

    Buffer starvation

    +

    Optional bs

    bs?: boolean

    Buffer starvation

    Key is included without a value if the buffer was starved at some point between the prior request and this object request, resulting in the player being in a rebuffering state and the video or audio playback being stalled. This key MUST NOT be sent if the buffer was not starved since the prior request.

    If the object type ot key is sent along with this key, then the bs key refers to the buffer associated with the particular object type. If no object type is communicated, then the buffer state applies to the current session.

    Boolean

    -

    Optional cid

    cid?: string

    Content ID

    +

    Optional cid

    cid?: string

    Content ID

    A unique string identifying the current content. Maximum length is 64 characters. This value is consistent across multiple different sessions and devices and is defined and updated at the discretion of the service provider.

    String

    -

    Optional d

    d?: number

    Object duration

    +

    Optional d

    d?: number

    Object duration

    The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the estimated duration if the explicit value is not known.

    Integer milliseconds

    -

    Optional dl

    dl?: number

    Deadline

    +

    Optional dl

    dl?: number

    Deadline

    Deadline from the request time until the first sample of this Segment/Object needs to be available in order to not create a buffer underrun or any other playback problems. This value MUST be rounded to the nearest 100ms. For a playback rate of 1, this may be equivalent to the player’s remaining buffer length.

    Integer milliseconds

    -

    Optional mtp

    mtp?: number

    Measured mtp CMCD throughput

    +

    Optional mtp

    mtp?: number

    Measured mtp CMCD throughput

    The throughput between client and server, as measured by the client and MUST be rounded to the nearest 100 kbps. This value, however derived, SHOULD be the value that the client is using to make its next Adaptive Bitrate switching decision. If the client is connected to multiple servers concurrently, it must take care to report only the throughput measured against the receiving server. If the client has multiple concurrent connections to the server, then the intent is that this value communicates the aggregate throughput the client sees across all those connections.

    Integer kbps

    -

    Optional nor

    nor?: string

    Next object request

    +

    Optional nor

    nor?: string

    Next object request

    Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current request. This string MUST be URLEncoded. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a pre-fetch to take place.

    String

    -

    Optional nrr

    nrr?: string

    Next range request

    +

    Optional nrr

    nrr?: string

    Next range request

    If the next request will be a partial object request, then this string denotes the byte range to be requested. If the ‘nor’ field is not set, then the object is assumed to match the object currently being requested. The client SHOULD NOT depend upon any pre-fetch action being taken – it is merely a request for such a pre-fetch to take place. Formatting is similar to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’ prefix is @@ -72,7 +72,7 @@

  • "-\<suffix-length\>"

    • String

    -

    Optional ot

    ot?: CmcdObjectType

    Object type

    +

    Optional ot

    ot?: CmcdObjectType

    Object type

    The media type of the current object being requested:

    • m = text file, such as a manifest or playlist
      • @@ -86,10 +86,10 @@
    • o = other

    If the object type being requested is unknown, then this key MUST NOT be used.

    -

    Optional pr

    pr?: number

    Playback rate

    +

    Optional pr

    pr?: number

    Playback rate

    1 if real-time, 2 if double speed, 0 if not playing. SHOULD only be sent if not equal to 1.

    Decimal

    -

    Optional rtp

    rtp?: number

    Requested maximum throughput

    +

    Optional rtp

    rtp?: number

    Requested maximum throughput

    The requested maximum throughput that the client considers sufficient for delivery of the asset. Values MUST be rounded to the nearest 100kbps. For example, a client would indicate that the current segment, encoded at 2Mbps, is to be delivered at no more than 10Mbps, by using rtp=10000.

    @@ -97,7 +97,7 @@ through fair-share delivery. The concept is that each client receives the throughput necessary for great performance, but no more. The CDN may not support the rtp feature.

    Integer kbps

    -

    Optional sf

    sf?: CmcdStreamingFormat

    Streaming format

    +

    Optional sf

    sf?: CmcdStreamingFormat

    Streaming format

    The streaming format that defines the current request.

    • d = MPEG DASH
      • @@ -106,25 +106,25 @@
    • o = other

    If the streaming format being requested is unknown, then this key MUST NOT be used.

    -

    Optional sid

    sid?: string

    Session ID

    +

    Optional sid

    sid?: string

    Session ID

    A GUID identifying the current playback session. A playback session typically ties together segments belonging to a single media asset. Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification.

    String

    -

    Optional st

    st?: CmcdStreamType

    Stream type

    +

    Optional st

    st?: CmcdStreamType

    Stream type

    • v = all segments are available – e.g., VOD
    • l = segments become available over time – e.g., LIVE
    -

    Optional su

    su?: boolean

    Startup

    +

    Optional su

    su?: boolean

    Startup

    Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be rendering when this request is made. This key MUST not be sent if it is FALSE.

    Boolean

    -

    Optional tb

    tb?: number

    Top bitrate

    +

    Optional tb

    tb?: number

    Top bitrate

    The highest bitrate rendition in the manifest or playlist that the client is allowed to play, given current codec, licensing and sizing constraints.

    Integer Kbps

    -

    Optional v

    v?: number

    CMCD version

    +

    Optional v

    v?: number

    CMCD version

    The version of this specification used for interpreting the defined key names and values. If this key is omitted, the client and server MUST interpret the values as being defined by version 1. Client SHOULD omit this field if the version is 1.

    Integer

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CmcdEncodeOptions.html b/interfaces/CmcdEncodeOptions.html index b2ff79ba..c3737b7a 100644 --- a/interfaces/CmcdEncodeOptions.html +++ b/interfaces/CmcdEncodeOptions.html @@ -1,15 +1,15 @@ CmcdEncodeOptions | @svta/common-media-library

    Interface CmcdEncodeOptionsBeta

    Options for encoding CMCD values.

    -
    interface CmcdEncodeOptions {
        baseUrl?: string;
        customHeaderMap?: CmcdHeadersMap;
        filter?: ((key) => boolean);
        formatters?: Record<keyof Cmcd, CmcdFormatter>;
    }

    Properties

    baseUrl? +
    interface CmcdEncodeOptions {
        baseUrl?: string;
        customHeaderMap?: CmcdHeadersMap;
        filter?: ((key) => boolean);
        formatters?: Record<keyof Cmcd, CmcdFormatter>;
    }

    Properties

    baseUrl? customHeaderMap? filter? formatters?

    Properties

    Optional baseUrl

    baseUrl?: string

    The base URL to use for relative URLs.

    -

    Optional customHeaderMap

    customHeaderMap?: CmcdHeadersMap

    A map of CMCD header fields to custom CMCD keys.

    -

    Optional filter

    filter?: ((key) => boolean)

    A filter function for CMCD keys.

    +

    Optional customHeaderMap

    customHeaderMap?: CmcdHeadersMap

    A map of CMCD header fields to custom CMCD keys.

    +

    Optional filter

    filter?: ((key) => boolean)

    A filter function for CMCD keys.

    Type declaration

      • (key): boolean

      • A filter function for CMCD keys.

        Parameters

        • key: keyof Cmcd

          The CMCD key to filter.

        Returns boolean

        true if the key should be included, false otherwise.

    Param: key

    The CMCD key to filter.

    Returns

    true if the key should be included, false otherwise.

    -

    Optional formatters

    formatters?: Record<keyof Cmcd, CmcdFormatter>

    A map of CMCD keys to custom formatters.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Optional formatters

    formatters?: Record<keyof Cmcd, CmcdFormatter>

    A map of CMCD keys to custom formatters.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CmsdDynamic.html b/interfaces/CmsdDynamic.html index f5202c6b..6ad71f1b 100644 --- a/interfaces/CmsdDynamic.html +++ b/interfaces/CmsdDynamic.html @@ -1,7 +1,7 @@ CmsdDynamic | @svta/common-media-library

    Interface CmsdDynamicBeta

    Common Media Server Data (CMSD) dynamic response header fields.

    See

    Spec

    -
    interface CmsdDynamic {
        params: CmsdDynamicParams;
        value: string;
    }

    Properties

    params +
    interface CmsdDynamic {
        params: CmsdDynamicParams;
        value: string;
    }

    Properties

    params value

    Properties

    params

    params: CmsdDynamicParams

    The CMSD dynamic parameters.

    -

    value

    value: string

    The server name.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    value

    value: string

    The server name.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CmsdDynamicParams.html b/interfaces/CmsdDynamicParams.html index 21c37718..65206bc3 100644 --- a/interfaces/CmsdDynamicParams.html +++ b/interfaces/CmsdDynamicParams.html @@ -2,7 +2,7 @@

    See

    Spec

    interface CmsdDynamicParams {
        du?: boolean;
        etp?: number;
        mb?: number;
        rd?: number;
        rtt?: number;
        [index: CmsdCustomKey]: CmsdValue;
    }

    Indexable

    [index: CmsdCustomKey]: CmsdValue

    Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.

    -

    Properties

    du? +

    Properties

    du? etp? mb? rd? @@ -12,7 +12,7 @@ thresholds for signaling duress are left to the discretion of the server operator. The intent is that the client will use this signal to move away to an alternate server if possible. This key MUST NOT be sent if it is false.

    Boolean

    -

    Optional etp

    etp?: number

    Estimated Throughput

    +

    Optional etp

    etp?: number

    Estimated Throughput

    The throughput between the server and the client over the currently negotiated transport as estimated by the server at the start of the response. The value is expressed in units of kilobits per second and rounded to the nearest integer. The time window for this estimate is expected to be the duration of the current response at most. The throughput may vary during the response and the @@ -24,17 +24,17 @@ their requests into the same connection to the server. In this case the server estimate of throughput will be against the entirety of the connection, not all of which will be accessible to the media player.

    Integer Kbps

    -

    Optional mb

    mb?: number

    Max suggested bitrate

    +

    Optional mb

    mb?: number

    Max suggested bitrate

    The maximum bitrate value that the player SHOULD play in its Adaptive Bit Rate (ABR) ladder. If the player is playing a bitrate higher than this value, it SHOULD immediately switch to a bitrate lower than or equal to this value.

    Integer Kbps

    -

    Optional rd

    rd?: number

    Response delay

    +

    Optional rd

    rd?: number

    Response delay

    The time elapsed between the receipt of the request and when the first byte of the body becomes available to send to the client. The intention is for receivers to use this value to more accurately calculate the throughput of the connection [MHV22].

    Integer milliseconds

    -

    Optional rtt

    rtt?: number

    Round Trip Time

    +

    Optional rtt

    rtt?: number

    Round Trip Time

    Estimated round trip time between client and server. This estimate may be derived from the transport handshake. For subsequent requests over the same connection, the value can be refined to be an exponentially weighted moving average of prior instantaneous values. An informative example algorithm for this averaging is provided by [18].

    Integer Kbps

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CmsdEncodeOptions.html b/interfaces/CmsdEncodeOptions.html index 614325b0..85345626 100644 --- a/interfaces/CmsdEncodeOptions.html +++ b/interfaces/CmsdEncodeOptions.html @@ -1,5 +1,5 @@ CmsdEncodeOptions | @svta/common-media-library

    Interface CmsdEncodeOptionsBeta

    Options for encoding CMCD values.

    -
    interface CmsdEncodeOptions {
        useSymbol?: boolean;
    }

    Properties

    useSymbol? +
    interface CmsdEncodeOptions {
        useSymbol?: boolean;
    }

    Properties

    useSymbol?

    Properties

    Optional useSymbol

    useSymbol?: boolean

    Use Symbol to represent token values

    Default Value

    true

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CmsdStatic.html b/interfaces/CmsdStatic.html index b6ed57fb..e53d5abf 100644 --- a/interfaces/CmsdStatic.html +++ b/interfaces/CmsdStatic.html @@ -2,7 +2,7 @@

    See

    Spec

    interface CmsdStatic {
        at?: number;
        br?: number;
        d?: number;
        ht?: number;
        n?: string;
        nor?: string;
        nrr?: string;
        ot?: CmsdObjectType;
        sf?: CmsdStreamingFormat;
        st?: CmsdStreamType;
        su?: boolean;
        v?: number;
        [index: CmsdCustomKey]: CmsdValue;
    }

    Indexable

    [index: CmsdCustomKey]: CmsdValue

    Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.

    -

    Properties

    at? +

    Properties

    at? br? d? ht? @@ -19,30 +19,30 @@ expressed as integer milliseconds since the Unix Epoch, i.e., the number of milliseconds that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds (in ISO 8601: 1970- 01-01T00:00:000Z).

    Integer Milliseconds

    -

    Optional br

    br?: number

    Encoded bitrate

    +

    Optional br

    br?: number

    Encoded bitrate

    The encoded bitrate of the audio or video object being requested. If the instantaneous bitrate varies over the duration of the object, the average value over the duration of the object SHOULD be communicated. This key should only accompany objects that have an implicit bitrate.

    Integer kbps

    -

    Optional d

    d?: number

    Object duration

    +

    Optional d

    d?: number

    Object duration

    The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the estimated duration if the explicit value is not known.

    Integer milliseconds

    -

    Optional ht

    ht?: number

    Held time

    +

    Optional ht

    ht?: number

    Held time

    The number of milliseconds that this response was held back by an origin before returning. This is applicable to blocking responses under LL-HLS [HLSbis].

    Integer Milliseconds

    -

    Optional n

    n?: string

    Intermediary identifier

    +

    Optional n

    n?: string

    Intermediary identifier

    An identifier for the processing server. The value SHOULD identify both the organization and the intermediary that is writing the key. Identifiers SHOULD be as concise as possible to reduce log file and transferred size, while still remaining unique.

    String

    -

    Optional nor

    nor?: string

    Next object request

    +

    Optional nor

    nor?: string

    Next object request

    Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current request. This string MUST be URLEncoded. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a pre-fetch to take place.

    String

    -

    Optional nrr

    nrr?: string

    Next range request

    +

    Optional nrr

    nrr?: string

    Next range request

    If the next request will be a partial object request, then this string denotes the byte range to be requested. If the ‘nor’ field is not set, then the object is assumed to match the object currently being requested. The client SHOULD NOT depend upon any pre-fetch action being taken – it is merely a request for such a pre-fetch to take place. Formatting is similar to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’ prefix is @@ -53,7 +53,7 @@

  • "-\<suffix-length\>"

    • String

    -

    Optional ot

    ot?: CmsdObjectType

    Object type

    +

    Optional ot

    ot?: CmsdObjectType

    Object type

    The media type of the current object being requested:

    • m = text file, such as a manifest or playlist
      • @@ -68,7 +68,7 @@

    If the object type being requested is unknown, then this key MUST NOT be used.

    Token

    -

    Optional sf

    sf?: CmsdStreamingFormat

    Streaming format

    +

    Optional sf

    sf?: CmsdStreamingFormat

    Streaming format

    The streaming format that defines the current request.

    • d = MPEG DASH
      • @@ -78,18 +78,18 @@

    If the streaming format being requested is unknown, then this key MUST NOT be used.

    Token

    -

    Optional st

    st?: CmsdStreamType

    Stream type

    +

    Optional st

    st?: CmsdStreamType

    Stream type

    • v = all segments are available – e.g., VOD
    • l = segments become available over time – e.g., LIVE

    Token

    -

    Optional su

    su?: boolean

    Startup

    +

    Optional su

    su?: boolean

    Startup

    Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be rendering when this request is made. This key MUST not be sent if it is FALSE.

    Boolean

    -

    Optional v

    v?: number

    CMSD version

    +

    Optional v

    v?: number

    CMSD version

    The version of this specification used for interpreting the defined key names and values. If this key is omitted, the client and server MUST interpret the values as being defined by version 1. Client SHOULD omit this field if the version is 1.

    Integer

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CommonMediaRequest.html b/interfaces/CommonMediaRequest.html index 5428079e..4c36037b 100644 --- a/interfaces/CommonMediaRequest.html +++ b/interfaces/CommonMediaRequest.html @@ -1,5 +1,5 @@ CommonMediaRequest | @svta/common-media-library

    Interface CommonMediaRequestBeta

    Common request API.

    -
    interface CommonMediaRequest {
        cmcd?: Cmcd;
        credentials?: RequestCredentials;
        customData?: any;
        headers?: Record<string, string>;
        method: string;
        mode?: RequestMode;
        responseType?: string;
        timeout?: number;
        url: string;
    }

    Properties

    cmcd? +
    interface CommonMediaRequest {
        cmcd?: Cmcd;
        credentials?: RequestCredentials;
        customData?: any;
        headers?: Record<string, string>;
        method: string;
        mode?: RequestMode;
        responseType?: string;
        timeout?: number;
        url: string;
    }

    Properties

    cmcd? credentials? customData? headers? @@ -9,13 +9,13 @@ timeout? url

    Properties

    Optional cmcd

    cmcd?: Cmcd

    The Common Media Client Data (CMCD) that comprises media and request related information.

    -

    Optional credentials

    credentials?: RequestCredentials

    Indicates whether the user agent should send or receive cookies from the other domain in the case of cross-origin requests.

    -

    Optional customData

    customData?: any

    Any custom data.

    -

    Optional headers

    headers?: Record<string, string>

    The headers object associated with the request.

    -

    method

    method: string

    The request's method (GET, POST, etc).

    -

    Optional mode

    mode?: RequestMode

    The mode of the request (e.g., cors, no-cors, same-origin, etc).

    -

    Optional responseType

    responseType?: string

    The response type with which the response from the server shall be compatible.

    -

    Optional timeout

    timeout?: number

    The number of milliseconds the request can take before automatically being terminated. +

    Optional credentials

    credentials?: RequestCredentials

    Indicates whether the user agent should send or receive cookies from the other domain in the case of cross-origin requests.

    +

    Optional customData

    customData?: any

    Any custom data.

    +

    Optional headers

    headers?: Record<string, string>

    The headers object associated with the request.

    +

    method

    method: string

    The request's method (GET, POST, etc).

    +

    Optional mode

    mode?: RequestMode

    The mode of the request (e.g., cors, no-cors, same-origin, etc).

    +

    Optional responseType

    responseType?: string

    The response type with which the response from the server shall be compatible.

    +

    Optional timeout

    timeout?: number

    The number of milliseconds the request can take before automatically being terminated. If undefined or value is 0 then there is no timeout.

    -

    url

    url: string

    The URL of the request.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    url

    url: string

    The URL of the request.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CommonMediaResponse.html b/interfaces/CommonMediaResponse.html index e86c3792..6058c284 100644 --- a/interfaces/CommonMediaResponse.html +++ b/interfaces/CommonMediaResponse.html @@ -1,5 +1,5 @@ CommonMediaResponse | @svta/common-media-library

    Interface CommonMediaResponseBeta

    Common response API.

    -
    interface CommonMediaResponse {
        data?: any;
        headers?: Record<string, string>;
        redirected?: boolean;
        request: CommonMediaRequest;
        resourceTiming: ResourceTiming;
        status?: number;
        statusText?: string;
        type?: string;
        url?: string;
    }

    Properties

    data? +
    interface CommonMediaResponse {
        data?: any;
        headers?: Record<string, string>;
        redirected?: boolean;
        request: CommonMediaRequest;
        resourceTiming: ResourceTiming;
        status?: number;
        statusText?: string;
        type?: string;
        url?: string;
    }

    Properties

    data? headers? redirected? request @@ -9,12 +9,12 @@ type? url?

    Properties

    Optional data

    data?: any

    The response data.

    -

    Optional headers

    headers?: Record<string, string>

    The response headers.

    -

    Optional redirected

    redirected?: boolean

    Indicates whether or not the request was redirected.

    -

    request

    request: CommonMediaRequest

    The origin request.

    -

    resourceTiming

    resourceTiming: ResourceTiming

    The network timing of the request/response.

    -

    Optional status

    status?: number

    The HTTP status code of the response.

    -

    Optional statusText

    statusText?: string

    The status message corresponding to the HTTP status code.

    -

    Optional type

    type?: string

    The type of the response.

    -

    Optional url

    url?: string

    The final URL obtained after any redirects.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Optional headers

    headers?: Record<string, string>

    The response headers.

    +

    Optional redirected

    redirected?: boolean

    Indicates whether or not the request was redirected.

    +

    request

    request: CommonMediaRequest

    The origin request.

    +

    resourceTiming

    resourceTiming: ResourceTiming

    The network timing of the request/response.

    +

    Optional status

    status?: number

    The HTTP status code of the response.

    +

    Optional statusText

    statusText?: string

    The status message corresponding to the HTTP status code.

    +

    Optional type

    type?: string

    The type of the response.

    +

    Optional url

    url?: string

    The final URL obtained after any redirects.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CueHandler.html b/interfaces/CueHandler.html index 1fc2f16b..39cf173c 100644 --- a/interfaces/CueHandler.html +++ b/interfaces/CueHandler.html @@ -1,5 +1,5 @@ CueHandler | @svta/common-media-library

    Interface CueHandlerBeta

    A handler for CTA-608 cues.

    -
    interface CueHandler {
        dispatchCue?(): void;
        newCue(startTime, endTime, screen): void;
        reset?(): void;
    }

    Methods

    dispatchCue? +
    interface CueHandler {
        dispatchCue?(): void;
        newCue(startTime, endTime, screen): void;
        reset?(): void;
    }

    Methods

    dispatchCue? newCue reset? -

    Methods

    Optional dispatchCue

    newCue

    Optional reset

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Methods

    Optional dispatchCue

    newCue

    Optional reset

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/PACData.html b/interfaces/PACData.html index 239dc902..2f04433c 100644 --- a/interfaces/PACData.html +++ b/interfaces/PACData.html @@ -1,7 +1,7 @@ PACData | @svta/common-media-library

    Interface PACDataBeta

    Represents a single PAC (Preamble Address Code) data.

    -
    interface PACData {
        color: null | string;
        indent: null | number;
        italics: boolean;
        row: number;
        underline: boolean;
    }

    Properties

    color +
    interface PACData {
        color: null | string;
        indent: null | number;
        italics: boolean;
        row: number;
        underline: boolean;
    }

    Properties

    color indent italics row underline -

    Properties

    color

    color: null | string

    indent

    indent: null | number

    italics

    italics: boolean

    row

    row: number

    underline

    underline: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    color

    color: null | string

    indent

    indent: null | number

    italics

    italics: boolean

    row

    row: number

    underline

    underline: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/ResourceTiming.html b/interfaces/ResourceTiming.html index c141ed61..35d53087 100644 --- a/interfaces/ResourceTiming.html +++ b/interfaces/ResourceTiming.html @@ -1,7 +1,7 @@ ResourceTiming | @svta/common-media-library

    Interface ResourceTimingBeta

    Resource Timing.

    -
    interface ResourceTiming {
        duration?: number;
        encodedBodySize: number;
        responseEnd?: number;
        responseStart?: number;
        startTime: number;
    }

    Properties

    duration? +
    interface ResourceTiming {
        duration?: number;
        encodedBodySize: number;
        responseEnd?: number;
        responseStart?: number;
        startTime: number;
    }

    Properties

    duration? encodedBodySize responseEnd? responseStart? startTime -

    Properties

    Optional duration

    duration?: number

    encodedBodySize

    encodedBodySize: number

    Optional responseEnd

    responseEnd?: number

    Optional responseStart

    responseStart?: number

    startTime

    startTime: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional duration

    duration?: number

    encodedBodySize

    encodedBodySize: number

    Optional responseEnd

    responseEnd?: number

    Optional responseStart

    responseStart?: number

    startTime

    startTime: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/types/AlignedSwitchingSet.html b/types/AlignedSwitchingSet.html index b0327676..b8a6a459 100644 --- a/types/AlignedSwitchingSet.html +++ b/types/AlignedSwitchingSet.html @@ -1,2 +1,2 @@ AlignedSwitchingSet | @svta/common-media-library

    Type alias AlignedSwitchingSetAlpha

    AlignedSwitchingSet: {
        switchingSets: SwitchingSet[];
    }

    CMAF-HAM Aligned Switching Set type

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AudioTrack.html b/types/AudioTrack.html index 47ce2b03..d27251de 100644 --- a/types/AudioTrack.html +++ b/types/AudioTrack.html @@ -3,4 +3,4 @@ For example, if the sample rate is 44100, it means there are 44100 samples in each second of the audio.

    channels - The number of channels in the audio track. It defines the number of separate audio signals that are encoded in the audio. For example, if the channels is 2, it means the audio is stereo with a separate signal for left and right.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CaptionModes.html b/types/CaptionModes.html index 11dff39f..4f867048 100644 --- a/types/CaptionModes.html +++ b/types/CaptionModes.html @@ -1,2 +1,2 @@ CaptionModes | @svta/common-media-library

    Type alias CaptionModesBeta

    CaptionModes: "MODE_ROLL-UP" | "MODE_POP-ON" | "MODE_PAINT-ON" | "MODE_TEXT" | null

    The different caption modes that can be used.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CmcdCustomKey.html b/types/CmcdCustomKey.html index ad8b0ce5..3cc1126d 100644 --- a/types/CmcdCustomKey.html +++ b/types/CmcdCustomKey.html @@ -2,4 +2,4 @@ to ensure that there will not be a namespace collision with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CmcdFormatter.html b/types/CmcdFormatter.html index 0b121edf..d6f928b5 100644 --- a/types/CmcdFormatter.html +++ b/types/CmcdFormatter.html @@ -1,4 +1,4 @@ CmcdFormatter | @svta/common-media-library

    Type alias CmcdFormatterBeta

    CmcdFormatter: ((value, options?) => string | number)

    A formatter for CMCD values.

    Type declaration

      • (value, options?): string | number

      • Parameters

        Returns string | number

    Returns

    The formatted value.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CmcdHeadersMap.html b/types/CmcdHeadersMap.html index af95cdfd..1592bea2 100644 --- a/types/CmcdHeadersMap.html +++ b/types/CmcdHeadersMap.html @@ -1,2 +1,2 @@ CmcdHeadersMap | @svta/common-media-library

    Type alias CmcdHeadersMapBeta

    CmcdHeadersMap: Record<CmcdHeaderField, CmcdKey[]>

    A map of CMCD header fields to CMCD keys.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CmcdKey.html b/types/CmcdKey.html index 024a7033..b4ccc684 100644 --- a/types/CmcdKey.html +++ b/types/CmcdKey.html @@ -1,2 +1,2 @@ CmcdKey | @svta/common-media-library

    Type alias CmcdKeyBeta

    CmcdKey: keyof Cmcd

    A CMCD key.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CmcdValue.html b/types/CmcdValue.html index bd28c66c..6487d736 100644 --- a/types/CmcdValue.html +++ b/types/CmcdValue.html @@ -1,2 +1,2 @@ CmcdValue | @svta/common-media-library

    Type alias CmcdValueBeta

    CmcdValue: CmcdObjectType | CmcdStreamingFormat | CmcdStreamType | string | number | boolean | symbol | SfToken

    CMCD Value

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CmsdCustomKey.html b/types/CmsdCustomKey.html index 6a6c1543..ba1325ec 100644 --- a/types/CmsdCustomKey.html +++ b/types/CmsdCustomKey.html @@ -2,4 +2,4 @@ to ensure that there will not be a namespace collision with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CmsdValue.html b/types/CmsdValue.html index c503d9f9..4e70c8b0 100644 --- a/types/CmsdValue.html +++ b/types/CmsdValue.html @@ -1,2 +1,2 @@ CmsdValue | @svta/common-media-library

    Type alias CmsdValueBeta

    CmsdValue: CmsdObjectType | CmsdStreamingFormat | CmsdStreamType | string | number | boolean | symbol | SfToken

    CMSD Value

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/DecodedId3Frame.html b/types/DecodedId3Frame.html index 4f82c989..645b2b29 100644 --- a/types/DecodedId3Frame.html +++ b/types/DecodedId3Frame.html @@ -2,4 +2,4 @@

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/FrameRate.html b/types/FrameRate.html index 8e979e35..ac89681c 100644 --- a/types/FrameRate.html +++ b/types/FrameRate.html @@ -2,4 +2,4 @@ Used to express the framerate as numerator and denominator.

    frameRateNumerator - Numerator. frameRateDenominator - Denominator.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Ham.html b/types/Ham.html index d8e2f39b..51cbfc4b 100644 --- a/types/Ham.html +++ b/types/Ham.html @@ -1,3 +1,3 @@ Ham | @svta/common-media-library

    Type alias HamAlpha

    Ham: {
        id: string;
    }

    CMAF-HAM base HAM type

    id - Identifier of the object

    -

    Type declaration

    • id: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Id3Frame.html b/types/Id3Frame.html index ae81264a..d5b7f4f0 100644 --- a/types/Id3Frame.html +++ b/types/Id3Frame.html @@ -1,2 +1,2 @@ Id3Frame | @svta/common-media-library

    Type alias Id3FrameBeta

    Id3Frame: DecodedId3Frame<ArrayBuffer | string | number>

    ID3 frame.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Manifest.html b/types/Manifest.html index 08d77dcc..77679b84 100644 --- a/types/Manifest.html +++ b/types/Manifest.html @@ -1,2 +1,2 @@ Manifest | @svta/common-media-library

    Type alias ManifestAlpha

    Manifest: {
        ancillaryManifests?: Manifest[];
        fileName?: string;
        manifest: string;
        metadata?: Map<string, string>;
        type: ManifestFormat;
    }

    Manifest object received as an input by the conversion to HAM object

    -

    Type declaration

    • Optional ancillaryManifests?: Manifest[]
    • Optional fileName?: string
    • manifest: string
    • Optional metadata?: Map<string, string>
    • type: ManifestFormat

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ManifestFormat.html b/types/ManifestFormat.html index d62962c3..780aee3b 100644 --- a/types/ManifestFormat.html +++ b/types/ManifestFormat.html @@ -1,2 +1,2 @@ ManifestFormat | @svta/common-media-library

    Type alias ManifestFormatAlpha

    ManifestFormat: "hls" | "dash"

    The format of the manifest.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/PenStyles.html b/types/PenStyles.html index 4c252f07..7e221675 100644 --- a/types/PenStyles.html +++ b/types/PenStyles.html @@ -1,2 +1,2 @@ PenStyles | @svta/common-media-library

    Type alias PenStylesBeta

    PenStyles: {
        background: string;
        flash: boolean;
        foreground: string | null;
        italics: boolean;
        underline: boolean;
    }

    PenStyles

    -

    Type declaration

    • background: string
    • flash: boolean
    • foreground: string | null
    • italics: boolean
    • underline: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Presentation.html b/types/Presentation.html index ae8024f1..ac92841c 100644 --- a/types/Presentation.html +++ b/types/Presentation.html @@ -1,3 +1,3 @@ Presentation | @svta/common-media-library

    Type alias PresentationAlpha

    Presentation: Ham & {
        selectionSets: SelectionSet[];
    }

    CMAF-HAM Presentation type

    selectionSets - List of SelectionSets

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RequestInterceptor.html b/types/RequestInterceptor.html index 9c40b45c..89b3720a 100644 --- a/types/RequestInterceptor.html +++ b/types/RequestInterceptor.html @@ -1,4 +1,4 @@ RequestInterceptor | @svta/common-media-library

    Type alias RequestInterceptorBeta

    RequestInterceptor: ((request) => Promise<CommonMediaRequest>)

    Request interceptor API.

    Type declaration

    Returns

    A promise with updated request that is resolved when the interceptor has completed the process of the request.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ResponseInterceptor.html b/types/ResponseInterceptor.html index b5e2ff19..27e7d834 100644 --- a/types/ResponseInterceptor.html +++ b/types/ResponseInterceptor.html @@ -1,4 +1,4 @@ ResponseInterceptor | @svta/common-media-library

    Type alias ResponseInterceptorBeta

    ResponseInterceptor: ((response) => Promise<CommonMediaResponse>)

    Response interceptor API.

    Type declaration

    Returns

    A promise with updated response that is resolved when the interceptor has completed the process of the response.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Segment.html b/types/Segment.html index 01babddc..18927bac 100644 --- a/types/Segment.html +++ b/types/Segment.html @@ -1,2 +1,2 @@ Segment | @svta/common-media-library

    Type alias SegmentAlpha

    Segment: {
        byteRange?: string;
        duration: number;
        url: string;
    }

    CMAF-HAM Segment type

    -

    Type declaration

    • Optional byteRange?: string
    • duration: number
    • url: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SelectionSet.html b/types/SelectionSet.html index c7023886..60070cce 100644 --- a/types/SelectionSet.html +++ b/types/SelectionSet.html @@ -1,2 +1,2 @@ SelectionSet | @svta/common-media-library

    Type alias SelectionSetAlpha

    SelectionSet: Ham & {
        alignedSwitchingSets?: AlignedSwitchingSet[];
        switchingSets: SwitchingSet[];
    }

    CMAF-HAM SelectionSet type

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SfBareItem.html b/types/SfBareItem.html index 08f80737..e1e1dd3d 100644 --- a/types/SfBareItem.html +++ b/types/SfBareItem.html @@ -1,2 +1,2 @@ SfBareItem | @svta/common-media-library

    Type alias SfBareItemBeta

    SfBareItem: string | Uint8Array | boolean | number | symbol | Date | SfToken

    A type to represent structured field bare items.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SfDecodeOptions.html b/types/SfDecodeOptions.html index cd5ce451..b0bc2fe0 100644 --- a/types/SfDecodeOptions.html +++ b/types/SfDecodeOptions.html @@ -1,3 +1,3 @@ SfDecodeOptions | @svta/common-media-library

    Type alias SfDecodeOptionsBeta

    SfDecodeOptions: {
        useSymbol?: boolean;
    }

    Options for decoding Structured Field values

    Type declaration

    • Optional useSymbol?: boolean

      Use JS Symbol to represent token values

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SfDictionary.html b/types/SfDictionary.html index 6ce41f0d..1746529a 100644 --- a/types/SfDictionary.html +++ b/types/SfDictionary.html @@ -1,2 +1,2 @@ SfDictionary | @svta/common-media-library

    Type alias SfDictionaryBeta

    SfDictionary: Record<string, SfMember> | Map<string, SfMember>

    A dictionary of structured field members.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SfEncodeOptions.html b/types/SfEncodeOptions.html index aa4eaf6a..a8c306de 100644 --- a/types/SfEncodeOptions.html +++ b/types/SfEncodeOptions.html @@ -1,3 +1,3 @@ SfEncodeOptions | @svta/common-media-library

    Type alias SfEncodeOptionsBeta

    SfEncodeOptions: {
        whitespace?: boolean;
    }

    Options for encoding a structured field.

    Type declaration

    • Optional whitespace?: boolean

      Include whitespace in the output.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SfInnerList.html b/types/SfInnerList.html index 0ed1018d..27ead207 100644 --- a/types/SfInnerList.html +++ b/types/SfInnerList.html @@ -1,2 +1,2 @@ SfInnerList | @svta/common-media-library

    Type alias SfInnerListBeta

    SfInnerList: {
        params: SfParameters;
        value: SfItem[] | SfBareItem[];
    }

    Structured Field Inner List

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SfMember.html b/types/SfMember.html index d0c7b7f3..fa785ac9 100644 --- a/types/SfMember.html +++ b/types/SfMember.html @@ -1,2 +1,2 @@ SfMember | @svta/common-media-library

    Type alias SfMemberBeta

    SfMember: SfItem | SfInnerList | SfBareItem

    A member of a structured field.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SfParameters.html b/types/SfParameters.html index 98998004..f52904bf 100644 --- a/types/SfParameters.html +++ b/types/SfParameters.html @@ -1,2 +1,2 @@ SfParameters | @svta/common-media-library

    Type alias SfParametersBeta

    SfParameters: Record<string, any>

    Structured Field Parameters

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SupportedField.html b/types/SupportedField.html index 9a7ddd6e..7e1d1412 100644 --- a/types/SupportedField.html +++ b/types/SupportedField.html @@ -1,2 +1,2 @@ SupportedField | @svta/common-media-library

    Type alias SupportedFieldBeta

    SupportedField: 1 | 3

    SupportedField

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SwitchingSet.html b/types/SwitchingSet.html index 3c29039c..eee7b78b 100644 --- a/types/SwitchingSet.html +++ b/types/SwitchingSet.html @@ -1,2 +1,2 @@ SwitchingSet | @svta/common-media-library

    Type alias SwitchingSetAlpha

    SwitchingSet: Ham & {
        tracks: Track[];
    }

    CMAF-HAM SwitchingSet type

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TextTrack.html b/types/TextTrack.html index 4afa83f4..e71f73b7 100644 --- a/types/TextTrack.html +++ b/types/TextTrack.html @@ -1,2 +1,2 @@ TextTrack | @svta/common-media-library

    Type alias TextTrackAlpha

    TextTrack: Track

    CMAF-HAM Text Track type

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Track.html b/types/Track.html index 5b3c5f6b..a570d78d 100644 --- a/types/Track.html +++ b/types/Track.html @@ -10,4 +10,4 @@ segments - List of segments of the track.

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TrackType.html b/types/TrackType.html index 339bfd81..5a396993 100644 --- a/types/TrackType.html +++ b/types/TrackType.html @@ -1,3 +1,3 @@ TrackType | @svta/common-media-library

    Type alias TrackTypeAlpha

    TrackType: "audio" | "video" | "text"

    CMAF-HAM TrackType type This can be 'audio' or 'video' or 'text'

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Validation.html b/types/Validation.html index 09ba4e2d..650346b0 100644 --- a/types/Validation.html +++ b/types/Validation.html @@ -1,2 +1,2 @@ Validation | @svta/common-media-library

    Type alias ValidationAlpha

    Validation: {
        errorMessages: string[];
        status: boolean;
    }

    CMAF-HAM Validation type

    -

    Type declaration

    • errorMessages: string[]
    • status: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/VideoTrack.html b/types/VideoTrack.html index f3036192..577c1cdf 100644 --- a/types/VideoTrack.html +++ b/types/VideoTrack.html @@ -5,4 +5,4 @@ par - Pixel Aspect Ratio of the video track as string. sar - Sample Aspect Ratio of the video track in string. scanType - The method used to display the video track.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/CMCD_PARAM.html b/variables/CMCD_PARAM.html index 9c413c9a..4c180824 100644 --- a/variables/CMCD_PARAM.html +++ b/variables/CMCD_PARAM.html @@ -1,2 +1,2 @@ CMCD_PARAM | @svta/common-media-library

    Variable CMCD_PARAMConst Beta

    CMCD_PARAM: "CMCD" = 'CMCD'

    CMCD parameter name.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/CMCD_V1.html b/variables/CMCD_V1.html index cf188516..394273bf 100644 --- a/variables/CMCD_V1.html +++ b/variables/CMCD_V1.html @@ -1,2 +1,2 @@ CMCD_V1 | @svta/common-media-library

    Variable CMCD_V1Const Beta

    CMCD_V1: 1 = 1

    CMCD Version 1

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/CMSD_DYNAMIC.html b/variables/CMSD_DYNAMIC.html index bc00c849..e82e3b1c 100644 --- a/variables/CMSD_DYNAMIC.html +++ b/variables/CMSD_DYNAMIC.html @@ -1,2 +1,2 @@ CMSD_DYNAMIC | @svta/common-media-library

    Variable CMSD_DYNAMICConst Beta

    CMSD_DYNAMIC: string = 'CMSD-Dynamic'

    CMSD dynamic header name.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/CMSD_STATIC.html b/variables/CMSD_STATIC.html index 5069fbcd..241af39b 100644 --- a/variables/CMSD_STATIC.html +++ b/variables/CMSD_STATIC.html @@ -1,2 +1,2 @@ CMSD_STATIC | @svta/common-media-library

    Variable CMSD_STATICConst Beta

    CMSD_STATIC: string = 'CMSD-Static'

    CMSD static header name.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/CMSD_V1.html b/variables/CMSD_V1.html index d6069c51..bd72a8b4 100644 --- a/variables/CMSD_V1.html +++ b/variables/CMSD_V1.html @@ -1,2 +1,2 @@ CMSD_V1 | @svta/common-media-library

    Variable CMSD_V1Const Beta

    CMSD_V1: 1 = 1

    CMSD Version 1

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/CmcdFormatters.html b/variables/CmcdFormatters.html index 29e67aea..c77618b1 100644 --- a/variables/CmcdFormatters.html +++ b/variables/CmcdFormatters.html @@ -1,2 +1,2 @@ CmcdFormatters | @svta/common-media-library

    Variable CmcdFormattersConst Beta

    CmcdFormatters: Record<string, CmcdFormatter> = ...

    The default formatters for CMCD values.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file