com.brightcove.onceux

Class OnceUxComponent

java.lang.Object

com.brightcove.player.event.AbstractComponent

com.brightcove.onceux.OnceUxComponent

All Implemented Interfaces:

Component

public class OnceUxComponent
extends AbstractComponent

Provide a class to support the Brightcove Server Side Ad Insetion (SSAI) functionality, i.e. given a URL to a VMAP server, ensure that the player hides player controls, provides tracking beacons, allows clickthrough and clickthrough tracking during ad playback.

Field Summary

Fields inherited from class com.brightcove.player.event.AbstractComponent

eventEmitter, listenerTokens

Constructor Summary

Constructors

Constructor and Description
OnceUxComponent(android.content.Context context, BaseVideoView videoView) Create a default Once UX plugin using VMAP and XML.
OnceUxComponent(android.content.Context context, BaseVideoView videoView, com.brightcove.player.onceux.ProtocolType protocol, com.brightcove.player.onceux.FormatType format) Create a new Brightcove Media Once UX plugin for the supplied Android context and video view.

Method Summary

Modifier and Type	Method and Description
void	addCompanionContainer(android.view.ViewGroup companionContainer) Add an additional companion ad container.
void	clearCompanionContainers() Clear all companion ad containers currently being used in the plugin.
void	processVideo(java.lang.String adDataUrl) Process a video given an ad metadata URL and a content URL.
void	processVideo(Video video) Process a video that has a VMAP url in at least one if its sources.
protected void	registerEventHandlers() Procedural abstraction used to setup event handlers for the OnceUX plugin.
void	removeListeners() Removes all set listeners from the EventEmitter.

Methods inherited from class com.brightcove.player.event.AbstractComponent

addListener, addOnceListener, getEventEmitter, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OnceUxComponent

public OnceUxComponent(android.content.Context context,
                       BaseVideoView videoView)

Create a default Once UX plugin using VMAP and XML.

Parameters:

context - The given Android context set up by the Application.

videoView - The player object rendering the video provided via the SDK.

OnceUxComponent

public OnceUxComponent(android.content.Context context,
                       BaseVideoView videoView,
                       com.brightcove.player.onceux.ProtocolType protocol,
                       com.brightcove.player.onceux.FormatType format)

Create a new Brightcove Media Once UX plugin for the supplied Android context and video view.

Parameters:

context - The given Android context set up by the Application.

videoView - The player object rendering the video provided via the SDK.

protocol - The Once protocol choice.

format - The Once data format choice.

Method Detail

processVideo

public void processVideo(Video video)
                  throws NoSourceFoundException

Process a video that has a VMAP url in at least one if its sources.

Parameters:

video - the video to play.

Throws:

NoSourceFoundException - if no VMAP url was found in neither of the Video Sources.

See Also:

Source

processVideo

public void processVideo(java.lang.String adDataUrl)

Process a video given an ad metadata URL and a content URL. Default to using the VMAP technology and XML data bindings.

Parameters:

adDataUrl - The given VMAP ad server URL.

addCompanionContainer

public void addCompanionContainer(android.view.ViewGroup companionContainer)

Add an additional companion ad container.

Parameters:

companionContainer - The new companion ad container.

clearCompanionContainers

public void clearCompanionContainers()

Clear all companion ad containers currently being used in the plugin.

removeListeners

public void removeListeners()

Description copied from class: AbstractComponent

Removes all set listeners from the EventEmitter.

Overrides:

removeListeners in class AbstractComponent

registerEventHandlers

protected void registerEventHandlers()

Procedural abstraction used to setup event handlers for the OnceUX plugin.