# Index

A B C G I M N O P R S
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## A

AD_PROVIDER_NAME - Static variable in class com.castlabs.sdk.broadpeak.BroadpeakPlugin
  Identifier used to register Broadpeak as an ad provider with `Adverts`.
addAdDataListener(AdManager.AdDataListener) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Registers a listener that receives Broadpeak ad data updates.
addAdEventsListener(AdManager.AdEventsListener) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Registers a Broadpeak ad events listener.
adParameters(Bundle) - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin.MetadataBuilder
  Sets custom Broadpeak ad parameters which will be forwarded through `AbstractSession.setAdParameter(String, String)`.
adTracking - Static variable in class com.castlabs.sdk.broadpeak.BroadpeakPlugin
  Indicates whether to enable Broadpeak's advertising.
adUserInteraction(String) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Notifies Broadpeak about an ad user interaction event.

## B

BroadpeakComponent - Class in com.castlabs.sdk.broadpeak
  Broadpeak player component.
BroadpeakPlugin - Class in com.castlabs.sdk.broadpeak
  This plugin integrates Broadpeak Analytics with the Castlabs Player SDK.
BroadpeakPlugin(String, String, String) - Constructor for class com.castlabs.sdk.broadpeak.BroadpeakPlugin
  Creates a new instance of `BroadpeakPlugin`.
BroadpeakPlugin.MetadataBuilder - Class in com.castlabs.sdk.broadpeak
  A helper class to build `AnalyticsMetaData` objects for the Broadpeak plugin.
BroadpeakSdkElementExtension - Class in com.castlabs.sdk.broadpeak
  Extension for Broadpeak SDK elements.
BroadpeakSdkElementExtension() - Constructor for class com.castlabs.sdk.broadpeak.BroadpeakSdkElementExtension
  Default constructor
BroadpeakSdkElementExtension(AnalyticsMetaData) - Constructor for class com.castlabs.sdk.broadpeak.BroadpeakSdkElementExtension
  Constructor with Broadpeak analytics metadata
BroadpeakSessionException - Exception Class in com.castlabs.sdk.broadpeak
  Exception to represent an issue from Broadpeak.

## C

com.castlabs.sdk.broadpeak - package com.castlabs.sdk.broadpeak
createAdLoader(PlayerConfig) - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin
createMetadata(boolean, String, Bundle, SparseArray<Object>) - Static method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin
  Deprecated.
  Use `BroadpeakPlugin.MetadataBuilder` instead.
createMetadata(AnalyticsMetaData, Bundle, SparseArray<Object>) - Static method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin
  Deprecated.
  Use `BroadpeakPlugin.MetadataBuilder` instead.
customParameters(Bundle) - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin.MetadataBuilder
  Sets custom Broadpeak parameters, which will be added to the `StreamingSession`.

## G

get() - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin.MetadataBuilder
  Returns the final `AnalyticsMetaData` object.
getAdApi() - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Exposes the current Broadpeak `AdApi` instance, if one is available.
getAdBreaks() - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Returns the list of known Broadpeak ad breaks for the active session.
getCause() - Method in exception class com.castlabs.sdk.broadpeak.BroadpeakSessionException
  Returns the cause of the exception, if any.
getCurrentAd() - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Provides the ad currently being rendered by Broadpeak.
getId() - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin
getMessage() - Method in exception class com.castlabs.sdk.broadpeak.BroadpeakSessionException
  Returns the message of the exception.
getName() - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin
getPositionForBookmark() - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Calculates the position that should be used to create a bookmark.
getPositionForPlayback(long) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Normalizes the playback position that should be used when resuming from a bookmark.
getState() - Method in class com.castlabs.sdk.broadpeak.SessionWrapper
  Get the current state of the wrapper.

## I

id() - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
id() - Method in class com.castlabs.sdk.broadpeak.BroadpeakSdkElementExtension
init(Context) - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin

## M

MetadataBuilder(boolean, String) - Constructor for class com.castlabs.sdk.broadpeak.BroadpeakPlugin.MetadataBuilder
  Creates a new builder.
MetadataBuilder(AnalyticsMetaData) - Constructor for class com.castlabs.sdk.broadpeak.BroadpeakPlugin.MetadataBuilder
  Creates a new builder starting from an existing `AnalyticsMetaData` object.

## N

notifyFirstImage() - Method in class com.castlabs.sdk.broadpeak.SessionWrapper
notifyLayerSwitch(int) - Method in class com.castlabs.sdk.broadpeak.SessionWrapper
notifyPause() - Method in class com.castlabs.sdk.broadpeak.SessionWrapper
notifyResume() - Method in class com.castlabs.sdk.broadpeak.SessionWrapper
notifySeek(long, long) - Method in class com.castlabs.sdk.broadpeak.SessionWrapper
notifyStallEnd(boolean) - Method in class com.castlabs.sdk.broadpeak.SessionWrapper
notifyStallStart() - Method in class com.castlabs.sdk.broadpeak.SessionWrapper

## O

onDestroy(PlayerController) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
onDestroy(ExtensibleSdkElement) - Method in class com.castlabs.sdk.broadpeak.BroadpeakSdkElementExtension
onOpenBundle(PlayerController, Bundle) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
onOpenState(PlayerController, PlayerConfig) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
onPrepare(ExtensibleSdkElement) - Method in class com.castlabs.sdk.broadpeak.BroadpeakSdkElementExtension
options(SparseArray<Object>) - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin.MetadataBuilder
  Sets custom Broadpeak options, which will be added to the `StreamingSession`.

## P

precache(boolean) - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin.MetadataBuilder
  Enables or disables the precache feature.

## R

removeAdDataListener(AdManager.AdDataListener) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Unregisters a previously added Broadpeak ad data listener.
removeAdEventsListener(AdManager.AdEventsListener) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Removes a previously registered Broadpeak ad events listener.

## S

SESSION_START_RETRIES - Static variable in class com.castlabs.sdk.broadpeak.BroadpeakPlugin
  Number of retries to start a session.
SessionWrapper - Class in com.castlabs.sdk.broadpeak
  Wrapper around `SessionApi`.
setAdParameter(String, String) - Method in class com.castlabs.sdk.broadpeak.BroadpeakComponent
  Adds or overrides a Broadpeak ad parameter for the current session.
setEnabled(boolean) - Method in class com.castlabs.sdk.broadpeak.BroadpeakPlugin
  Enables or disables the BroadpeakPlugin.
STATE_IDLE - Static variable in class com.castlabs.sdk.broadpeak.SessionWrapper
  The Wrapper is IDLE.
STATE_READY - Static variable in class com.castlabs.sdk.broadpeak.SessionWrapper
  The Wrapper is ready.
STATE_STARTING - Static variable in class com.castlabs.sdk.broadpeak.SessionWrapper
  The Wrapper is starting or renewing a session.

A B C G I M N O P R S
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form