Class AdobeConnector

Index

Constructors

Methods

destroy setDebug setError stopAndStartNewSession updateMetadata

Constructors

constructor

new AdobeConnector(
    player: THEOplayer,
    uri: string,
    ecid: string,
    sid: string,
    trackingUrl: string,
    metadata?: AdobeMetaData,
    userAgent?: string,
    useDebug?: boolean,
    useNative?: boolean,
): AdobeConnector
Parameters
- player: THEOplayer
- uri: string
- ecid: string
- sid: string
- trackingUrl: string
- Optionalmetadata: AdobeMetaData
- OptionaluserAgent: string
- OptionaluseDebug: boolean
- useNative: boolean = false
Returns AdobeConnector
- Defined in api/AdobeConnector.ts:13

Methods

destroy

destroy(): void
Stops video and ad analytics and closes all sessions.

Returns void
- Defined in api/AdobeConnector.ts:70

setDebug

setDebug(debug: boolean): void
Set debug flag.
Parameters
- debug: boolean
  whether to write debug info or not.
Returns void
- Defined in api/AdobeConnector.ts:51

setError

setError(metadata: AdobeMetaData): void
Dispatch error event to adobe
Parameters
- metadata: AdobeMetaData
  containing at least the qoeData with the errorID and the errorSource set to external.
Returns void
- Defined in api/AdobeConnector.ts:43

stopAndStartNewSession

stopAndStartNewSession(metadata?: AdobeMetaData): void
Explicitly stop the current session and start a new one.

This can be used to manually mark the start of a new session during a live stream, for example when a new program starts.
Parameters
- Optionalmetadata: AdobeMetaData
  object of key value pairs.
Returns void
- Defined in api/AdobeConnector.ts:63

updateMetadata

updateMetadata(metadata: AdobeMetaData): void
Sets metadata which will be passed for the session start request.
Parameters
- metadata: AdobeMetaData
Returns void
- Defined in api/AdobeConnector.ts:35