Class BitmovinConnector

Index

Constructors

Methods

destroy getImpressionId programChange sendCustomDataEvent updateCustomData updateSourceMetadata

Constructors

constructor

new BitmovinConnector(
    player: THEOplayer,
    config: AnalyticsConfig,
    defaultMetadata?: DefaultMetadata,
): BitmovinConnector
Create BitmovinConnector
Parameters
- player: THEOplayer
  THEOplayer instance.
- config: AnalyticsConfig
  Configuration for Bitmovin Analytics.
- OptionaldefaultMetadata: DefaultMetadata
  Initial source-independent data.
Returns BitmovinConnector
- Defined in api/BitmovinConnector.ts:18

Methods

destroy

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

Returns void
- Defined in api/BitmovinConnector.ts:73

getImpressionId

getImpressionId(): Promise<string>
Returns the impression ID of the current analytics session.

Resolves to undefined when there is no active impression or session.

Returns Promise<string>
- Defined in api/BitmovinConnector.ts:66

programChange

programChange(sourceMetadata: SourceMetadata): void
Notifies the connector about a program change in a live stream.
Parameters
- sourceMetadata: SourceMetadata
Returns void
- Defined in api/BitmovinConnector.ts:48

sendCustomDataEvent

sendCustomDataEvent(customData: CustomData): void
Sends a custom data event with the provided custom data. This method allows you to change the value of a customData field temporarily for one sample.
Parameters
- customData: CustomData
Returns void
- Defined in api/BitmovinConnector.ts:57

updateCustomData

updateCustomData(customData: CustomData): void
Set or update custom data for the current session. This method allows you to change the value of a customData field during a session. The method can be called multiple times during a session and will be merged with the existing customData.
Parameters
- customData: CustomData
Returns void
- Defined in api/BitmovinConnector.ts:40

updateSourceMetadata

updateSourceMetadata(sourceMetadata: SourceMetadata): void
Set or update metadata for the current source.

IMPORTANT: Call this method before setting a new source on the player, otherwise the metadata will not be associated with the correct source.
Parameters
- sourceMetadata: SourceMetadata
  contains the key value pairs with data.
Returns void
- Defined in api/BitmovinConnector.ts:30