sdk/com.brightcove.player.concurrency/ConcurrencyClient

ConcurrencyClient

@Emits(events = [EventType.GSC_MAX_CONCURRENCY_REACHED, EventType.GSC_HEARTBEAT_STOPPED, EventType.GSC_ERROR])

@ListensFor(events = [EventType.ACTIVITY_PAUSED, EventType.ACTIVITY_RESUMED, EventType.COMPLETED, EventType.DID_PLAY, EventType.FRAGMENT_PAUSED, EventType.FRAGMENT_RESUMED, EventType.STOP, EventType.SET_VIDEO_STILL, EventType.ENTER_PICTURE_IN_PICTURE_MODE, EventType.DID_ENTER_PICTURE_IN_PICTURE_MODE, EventType.DID_EXIT_PICTURE_IN_PICTURE_MODE])

open class ConcurrencyClient : AbstractComponent

Constructors

ConcurrencyClient

constructor(context: Context, eventEmitter: EventEmitter, brightcoveVideoView: BaseVideoView)

Types

SessionsListener

interface SessionsListener

Properties

defaultConcurrencyHandler

val defaultConcurrencyHandler: DefaultConcurrencyHandler

HEARTBEAT_ACCOUNTID_HEADER_KEY

val HEARTBEAT_ACCOUNTID_HEADER_KEY: String = "accid"

HEARTBEAT_VIDEO_HEADER_KEY

val HEARTBEAT_VIDEO_HEADER_KEY: String = "video"

Functions

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.

getEventEmitter

open fun getEventEmitter(): EventEmitter

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

initializeEvents

open fun initializeEvents()

Initializes the events that the GSC should be listening to work properly.

open fun removeListener(eventType: String)

Removes the specified listener from the EventEmitter.

removeListeners

open fun removeListeners()

Removes all set listeners from the EventEmitter.

requestActiveSessions

open fun requestActiveSessions()

Request the current active sessions.

setRequestHeaders

open fun setRequestHeaders(requestHeaders: Map<String, String>)

Set the headers that will be included in the request

setSessionsListener

open fun setSessionsListener(listener: ConcurrencyClient.SessionsListener)

Set a SessionsListener to get the current active sessions

open fun stopAndClear()