sdk/com.brightcove.player.event

Package-level declarations

Types

abstract class AbstractComponent : Component

Provides some common implementation that useful to all that interact with RegisteringEventEmitters components, including:

Maintaining a reference to an EventEmitter
Wraps incoming EventEmitter in a RegisteringEventEmitter
Ensures incoming EventEmitter is not null
Maintains a collection of EventListener tokens for use with EventEmitter.off()
Provides standard required method for initializing Event listeners

AbstractEvent

abstract class AbstractEvent<PropertyValueType>

BackgroundEventListener

abstract class BackgroundEventListener : EventListener

Implements an EventListener and calls processEvent on a background thread.

Component

@Emits(events = [""sample"", ""event"", ""list""])

@ListensFor(events = [EventType.PLAY, EventType.STOP])

interface Component

Classes that implement this interface will be designed to work with the EventEmitter System Classes that implement this interface should use the Emits and ListensFor annotations

Default

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Documented

annotation class Default

This annotation should be used to mark the processEvent method when declaring a subclass of EventListener.

Emits

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.TYPE)

@Documented

annotation class Emits

Annotation used for Component classes in order to describe what EventTypes this Component will Emits

Event

open class Event : AbstractEvent<PropertyValueType>

Represents a single Event, that is designed to be passed down a chain of listeners.

EventEmitter

interface EventEmitter

Defines the public facing api for classes that wish to emit events.

EventEmitterImpl

open class EventEmitterImpl : EventEmitter

The 'Main' implementation of EventEmitter.

EventListener

interface EventListener

Abstract class used as part of the event registration process.

EventLogger

open class EventLogger

Simple class that can be used to listen to and log out information on all emitted events.

EventType

class EventType

Maintains a list of Event types that the system is aware of.

ListensFor

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.TYPE)

@Documented

annotation class ListensFor

Annotation used for Component classes in order to describe what EventTypes this Component will ListensFor.

MediaEvent

open class MediaEvent : AbstractEvent<PropertyValueType>

Immutable object the describes a media event.

RegisteringEventEmitter

open class RegisteringEventEmitter : EventEmitter

The RegisteringEventEmitter allows developers to constrain which events their Components are intended to listen for and emit.