sdk/com.brightcove.player.analytics/Analytics

Analytics

@Emits(events = [EventType.ACCOUNT, EventType.ANALYTICS_METRICS_REQUEST, EventType.DID_SET_ANALYTICS_BASE_PARAMS, EventType.ERROR])

@ListensFor(events = [EventType.ACCOUNT, EventType.ACTIVITY_STARTED, EventType.ACTIVITY_STOPPED, EventType.ACTIVITY_DESTROYED, EventType.AD_BREAK_STARTED, EventType.AD_BREAK_COMPLETED, EventType.AD_PROGRESS, EventType.ADD_ANALYTICS_BASE_PARAMS, EventType.ANALYTICS_CATALOG_REQUEST, EventType.ANALYTICS_CATALOG_RESPONSE, EventType.ANALYTICS_VIDEO_ENGAGEMENT, EventType.BUFFERING_COMPLETED, EventType.BUFFERING_STARTED, EventType.COMPLETED, EventType.DID_PAUSE, EventType.DID_PLAY, EventType.DID_SEEK_TO, EventType.DID_SET_VIDEO, EventType.ERROR, EventType.FRAGMENT_STARTED, EventType.FRAGMENT_STOPPED, EventType.FRAGMENT_DESTROYED, EventType.PLAY, EventType.PROGRESS, EventType.SET_ANALYTICS_BASE_PARAMS, EventType.VERSION, EventType.VIDEO_DURATION_CHANGED, EventType.VIDEO_SIZE_KNOWN, EventType.WILL_CHANGE_VIDEO, EventType.VIDEO_DOWNLOAD_STARTED, EventType.VIDEO_DOWNLOAD_COMPLETED, EventType.VIDEO_DOWNLOAD_CANCELLED, EventType.VIDEO_DOWNLOAD_FAILED, EventType.AD_VIEWABLE_IMPRESSION, EventType.AD_ERROR, EventType.AD_STARTED, EventType.AD_COMPLETED])

open class Analytics : AbstractComponent

Constructors

Analytics

constructor(emitter: EventEmitter, context: Context)

Types

DeliveryType

enum DeliveryType

Fields

open class Fields

MediaType

enum MediaType

Properties

account

open var account: String

The global account override.

destination

open var destination: String

The value that will be passed as the 'destination' parameter for all analytics events.

TAG

val TAG: String

uniqueIdentifierEnabled

open var uniqueIdentifierEnabled: Boolean

userAgentDeviceType

open val userAgentDeviceType: String

Functions

addListener

open fun addListener(eventType: String, listener: EventListener)

Convenience method to add an EventListener for the given type using the EventEmitter.on() method.

addOnceListener

open fun addOnceListener(eventType: String, listener: EventListener)

Convenience method to add an EventListener for the given type using the EventEmitter.once() method.

copy

open fun copy(analytics: Analytics, emitter: EventEmitter, context: Context): Analytics

Creates a new instance with the properties from the provided Analytics.

getEventEmitter

open fun getEventEmitter(): EventEmitter

Provides a reference to the EventEmitter with which this component was initialized

getSessionKey

open fun getSessionKey(): String

Gets the globally unique session key for this application session.

removeListener

open fun removeListener(eventType: String)

Removes the specified listener from the EventEmitter.

removeListeners

open fun removeListeners()

Removes all set listeners from the EventEmitter.

setApplication

open fun setApplication(application: String)

Set an ID to the application

setBcovAuthToken

open fun setBcovAuthToken(brightcoveAuthorizationToken: String)

Set the authorization token.

setDeliveryType

open fun setDeliveryType(deliveryType: Analytics.DeliveryType)

Set the DeliveryType for the currently playing item.

setDestination

open fun setDestination(destination: String)

The destination must be a valid URI.

setIsPlaybackForegrounded

open fun setIsPlaybackForegrounded(foregrounded: Boolean)

Set if the playback is attached to an on-going notification in a foreground service.

setMediaPlayback

open fun setMediaPlayback(playback: MediaPlayback<out Any>): Analytics

setMediaType

open fun setMediaType(mediaType: Analytics.MediaType)

Set the MediaType for the currently playing item.

setPlayerID

open fun setPlayerID(playerID: String)

Set an ID to the player

setPlayerName

open fun setPlayerName(playerName: String)

Set a name to the player

setSource

open fun setSource(source: String)

The source must be a valid URI.

setVideo

open fun setVideo(video: Video)