import CMCDController from 'hls.js/src/controller/cmcd-controller.ts'

public class | source

CMCDController

Controller to deal with Common Media Client Data (CMCD)

Static Method Summary

Static Public Methods
public static	appendQueryToUri(uri: undefined, query: undefined): string Append query args to a uri.
public static	serialize(data: CMCD): string Serialize a CMCD data object according to the rules defined in the section 3.2 of CTA-5004.
public static	toHeaders(data: CMCD): Partial Convert a CMCD data object to request headers according to the rules defined in the section 2.1 and 3.2 of CTA-5004.
public static	toQuery(data: CMCD): string Convert a CMCD data object to query args according to the rules defined in the section 2.2 and 3.2 of CTA-5004.
public static	uuid(): string Generate a random v4 UUI

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	applyFragmentData: * Apply CMCD data to a segment request
public	applyPlaylistData: * Apply CMCD data to a manifest request.
public	audioBuffer: *
public	buffering: boolean
public	cid: *
public	hls: *
public	initialized: boolean
public	media: *
public	onPlaying: *
public	onWaiting: *
public	sid: *
public	starved: boolean
public	useHeaders: boolean
public	videoBuffer: *

Method Summary

Public Methods
public	apply(context: LoaderContext, data: CMCD) Apply CMCD data to a request.
public	createData(): CMCD Create baseline CMCD data
public	createFragmentLoader(): * Create a playlist loader
public	createPlaylistLoader(): * Create a playlist loader
public	destroy()
public	getBufferLength(type: CMCDObjectType): * Get the buffer length for a media type in milliseconds
public	getObjectType(fragment: Fragment): * The CMCD object type.
public	getTopBandwidth(type: CMCDObjectType): * Get the highest bitrate.
public	onBufferCreated(event: undefined, data: BufferCreatedData)
public	onMediaAttached(event: undefined, data: MediaAttachedData)
public	onMediaDetached()
public	registerListeners()
public	unregisterListeners()

Static Public Methods

public static appendQueryToUri(uri: undefined, query: undefined): string source

Append query args to a uri.

Params:

Name	Type	Attribute	Description
uri	undefined
query	undefined

Return:

string

public static serialize(data: CMCD): string source

Serialize a CMCD data object according to the rules defined in the section 3.2 of CTA-5004.

Params:

Name	Type	Attribute	Description
data	CMCD

Return:

string

public static toHeaders(data: CMCD): Partial source

Convert a CMCD data object to request headers according to the rules defined in the section 2.1 and 3.2 of CTA-5004.

Params:

Name	Type	Attribute	Description
data	CMCD

Return:

Partial

public static toQuery(data: CMCD): string source

Convert a CMCD data object to query args according to the rules defined in the section 2.2 and 3.2 of CTA-5004.

Params:

Name	Type	Attribute	Description
data	CMCD

Return:

string

public static uuid(): string source

Generate a random v4 UUI

Return:

string

Public Constructors

public constructor() source

Public Members

public applyFragmentData: * source

Apply CMCD data to a segment request

public applyPlaylistData: * source

Apply CMCD data to a manifest request.

public audioBuffer: * source

public buffering: boolean source

public cid: * source

public hls: * source

public initialized: boolean source

public media: * source

public onPlaying: * source

public onWaiting: * source

public sid: * source

public starved: boolean source

public useHeaders: boolean source

public videoBuffer: * source

Public Methods

public apply(context: LoaderContext, data: CMCD) source

Apply CMCD data to a request.

Params:

Name	Type	Attribute	Description
context	LoaderContext
data	CMCD

public createData(): CMCD source

Create baseline CMCD data

Return:

CMCD

public createFragmentLoader(): * source

Create a playlist loader

Return:

public createPlaylistLoader(): * source

Create a playlist loader

Return:

public destroy() source

public getBufferLength(type: CMCDObjectType): * source

Get the buffer length for a media type in milliseconds

Params:

Name	Type	Attribute	Description
type	CMCDObjectType

Return:

public getObjectType(fragment: Fragment): * source

The CMCD object type.

Params:

Name	Type	Attribute	Description
fragment	Fragment

Return:

public getTopBandwidth(type: CMCDObjectType): * source

Get the highest bitrate.

Params:

Name	Type	Attribute	Description
type	CMCDObjectType

Return:

public onBufferCreated(event: undefined, data: BufferCreatedData) source

Params:

Name	Type	Attribute	Description
event	undefined
data	BufferCreatedData

public onMediaAttached(event: undefined, data: MediaAttachedData) source

Params:

Name	Type	Attribute	Description
event	undefined
data	MediaAttachedData

CMCDController

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Methods

public static appendQueryToUri(uri: undefined, query: undefined): string source

Params:

Return:

public static serialize(data: CMCD): string source

Params:

Return:

public static toHeaders(data: CMCD): Partial source

Params:

Return:

public static toQuery(data: CMCD): string source

Params:

Return:

public static uuid(): string source

Return:

Public Constructors

public constructor() source

Public Members

public applyFragmentData: * source

public applyPlaylistData: * source

public audioBuffer: * source

public buffering: boolean source

public cid: * source

public hls: * source

public initialized: boolean source

public media: * source

public onPlaying: * source

public onWaiting: * source

public sid: * source

public starved: boolean source

public useHeaders: boolean source

public videoBuffer: * source

Public Methods

public apply(context: LoaderContext, data: CMCD) source

Params:

public createData(): CMCD source

Return:

public createFragmentLoader(): * source

Return:

public createPlaylistLoader(): * source

Return:

public destroy() source

public getBufferLength(type: CMCDObjectType): * source

Params:

Return:

public getObjectType(fragment: Fragment): * source

Params:

Return:

public getTopBandwidth(type: CMCDObjectType): * source

Params:

Return:

public onBufferCreated(event: undefined, data: BufferCreatedData) source

Params:

public onMediaAttached(event: undefined, data: MediaAttachedData) source

Params:

public onMediaDetached() source

public registerListeners() source

public unregisterListeners() source