Package com.brightcove.player.edge

Class Catalog

java.lang.Object

com.brightcove.player.event.AbstractComponent

com.brightcove.player.edge.Catalog

All Implemented Interfaces:

Component

Direct Known Subclasses:

AbstractOfflineCatalog

@Emits(events={"error","account","videoDownloadStarted","videoDownloadCompleted","videoDownloadCancelled","videoDownloadFailed"})
@ListensFor(events={})
public class Catalog
extends AbstractComponent

The Catalog class provides asynchronous methods for retrieving information about videos from Brightcove's Edge API services.

Network requests such as those implemented by the Catalog class sometimes fail. If the request succeeds, the listener's onVideo() method will be invoked. If an error occurs during the execution of the request, the listener's onError() method will be invoked.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Catalog.AbstractBuilder<T extends Catalog.AbstractBuilder<T>>	An abstract Builder which sets the bases to create the Catalog object.
static class	Catalog.Builder	The Builder to create the Catalog object.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EDGE_BASE_URL
static final String	DEFAULT_EPA_BASE_URL
protected static Catalog	INSTANCE

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

eventEmitter, listenerTokens

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Catalog(Catalog.AbstractBuilder<?> builder)	The Catalog constructor using the Catalog.AbstractBuilder
	Catalog(EventEmitter eventEmitter, String account, String policy)	Deprecated. Please use Catalog.Builder to create the Catalog.
	Catalog(EventEmitter eventEmitter, String account, String policy, String baseURL)	Deprecated. Please use Catalog.Builder to create the Catalog.

Method Summary

Modifier and Type	Method	Description
static Catalog	empty()
void	findPlaylistByID(String playlistID, PlaylistListener playlistListener)	Retrieves a Playlist from the Playback API service by its playlist ID.
void	findPlaylistByID(String playlistID, HttpRequestConfig httpRequestConfig, PlaylistListener playlistListener)	Retrieves a Playlist from the Playback API service by its playlist ID.
void	findPlaylistByID(String playlistID, Map<String,String> headers, PlaylistListener playlistListener)	Deprecated. Please use findPlaylistByID(String, HttpRequestConfig, PlaylistListener) instead.
void	findPlaylistByID(String playlistID, Map<String,String> headers, Map<String,String> queryParameters, PlaylistListener playlistListener)	Deprecated. Please use findPlaylistByID(String, HttpRequestConfig, PlaylistListener) instead.
void	findPlaylistByReferenceID(String referenceID, PlaylistListener playlistListener)	Retrieves a Playlist from the Playback API service by its reference ID, a customer supplied unique identifier.
void	findPlaylistByReferenceID(String referenceID, HttpRequestConfig httpRequestConfig, PlaylistListener playlistListener)	Retrieves a Playlist from the Playback API service by its reference ID, a customer supplied unique identifier.
void	findPlaylistByReferenceID(String referenceID, Map<String,String> headers, PlaylistListener playlistListener)	Deprecated. Please use findPlaylistByReferenceID(String, HttpRequestConfig, PlaylistListener) instead.
void	findPlaylistByReferenceID(String referenceID, Map<String,String> headers, Map<String,String> queryParameters, PlaylistListener playlistListener)	Deprecated. Please use findPlaylistByReferenceID(String, HttpRequestConfig, PlaylistListener) instead.
void	findVideoByID(String videoID, VideoListener videoListener)	Retrieves a Video from the Playback API service by its video ID.
void	findVideoByID(String videoID, HttpRequestConfig httpRequestConfig, VideoListener videoListener)	Retrieves a Video from the Playback API service by its video ID.
void	findVideoByID(String videoID, Map<String,String> headers, VideoListener videoListener)	Deprecated. Please use findVideoByID(String, HttpRequestConfig, VideoListener) instead.
void	findVideoByID(String videoID, Map<String,String> headers, Map<String,String> queryParameters, VideoListener videoListener)	Deprecated. Please use findVideoByID(String, HttpRequestConfig, VideoListener) instead.
void	findVideoByReferenceID(String referenceID, VideoListener videoListener)	Retrieves a Video from the Playback API service by its reference ID, a customer supplied unique identifier.
void	findVideoByReferenceID(String referenceID, HttpRequestConfig httpRequestConfig, VideoListener videoListener)	Retrieves a Video from the Playback API service by its reference ID, a customer supplied unique identifier.
void	findVideoByReferenceID(String referenceID, Map<String,String> headers, VideoListener videoListener)	Deprecated. Please use findVideoByReferenceID(String, HttpRequestConfig, VideoListener) instead.
void	findVideoByReferenceID(String referenceID, Map<String,String> headers, Map<String,String> queryParameters, VideoListener videoListener)	Deprecated. Please use findVideoByReferenceID(String, HttpRequestConfig, VideoListener) instead.
static Catalog	getInstance()
Map<String,String>	getProperties()	Get the Map of properties for this Offline Catalog

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

addListener, addOnceListener, getEventEmitter, removeListener, removeListeners

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_EDGE_BASE_URL

public static final String DEFAULT_EDGE_BASE_URL

See Also:

• Constant Field Values

DEFAULT_EPA_BASE_URL

public static final String DEFAULT_EPA_BASE_URL

See Also:

• Constant Field Values

INSTANCE

protected static Catalog INSTANCE

Constructor Details

Catalog

@Deprecated
public Catalog(@NonNull
 EventEmitter eventEmitter,
 @NonNull
 String account,
 @NonNull
 String policy)

Deprecated.

Please use Catalog.Builder to create the Catalog.

Catalog

@Deprecated
public Catalog(@NonNull
 EventEmitter eventEmitter,
 @NonNull
 String account,
 @NonNull
 String policy,
 @NonNull
 String baseURL)

Deprecated.

Please use Catalog.Builder to create the Catalog.

Catalog

protected Catalog(Catalog.AbstractBuilder<?> builder)

The Catalog constructor using the Catalog.AbstractBuilder

Method Details

getInstance

public static Catalog getInstance()

empty

public static Catalog empty()

findPlaylistByID

public void findPlaylistByID(@NonNull
 String playlistID,
 @NonNull
 HttpRequestConfig httpRequestConfig,
 @NonNull
 PlaylistListener playlistListener)

Retrieves a Playlist from the Playback API service by its playlist ID.

If your VideoCloud configuration requires a Brightcove Authorization token, provide it using HttpRequestConfig.Builder.setBrightcoveAuthorizationToken(String). This token will be configured when creating the Video object, and it will be used when requesting the Video license.

Parameters:

playlistID - string containing the ID of the playlist to find.

httpRequestConfig - a configuration class with values used in the request.

playlistListener - A callback which will be invoked when the request finishes or an error occurs.

findPlaylistByID

public void findPlaylistByID(@NonNull
 String playlistID,
 @NonNull
 PlaylistListener playlistListener)

Retrieves a Playlist from the Playback API service by its playlist ID.

Parameters:

playlistID - string containing the ID of the playlist to find.

playlistListener - A callback which will be invoked when the request finishes or an error occurs.

findPlaylistByID

@Deprecated
public void findPlaylistByID(@NonNull
 String playlistID,
 @Nullable
 Map<String,String> headers,
 @NonNull
 PlaylistListener playlistListener)

Deprecated.

Please use findPlaylistByID(String, HttpRequestConfig, PlaylistListener) instead.

findPlaylistByID

@Deprecated
public void findPlaylistByID(@NonNull
 String playlistID,
 @Nullable
 Map<String,String> headers,
 @Nullable
 Map<String,String> queryParameters,
 @NonNull
 PlaylistListener playlistListener)

Deprecated.

Please use findPlaylistByID(String, HttpRequestConfig, PlaylistListener) instead.

findPlaylistByReferenceID

public void findPlaylistByReferenceID(@NonNull
 String referenceID,
 @NonNull
 HttpRequestConfig httpRequestConfig,
 @NonNull
 PlaylistListener playlistListener)

Retrieves a Playlist from the Playback API service by its reference ID, a customer supplied unique identifier.

If your VideoCloud configuration requires a Brightcove Authorization token, provide it using HttpRequestConfig.Builder.setBrightcoveAuthorizationToken(String). This token will be configured when creating the Video object, and it will be used when requesting the Video license.

Parameters:

referenceID - string containing the reference ID of the playlist to find.

httpRequestConfig - a configuration class with values used in the request.

playlistListener - A callback which will be invoked when the request finishes or an error occurs.

findPlaylistByReferenceID

public void findPlaylistByReferenceID(@NonNull
 String referenceID,
 @NonNull
 PlaylistListener playlistListener)

Retrieves a Playlist from the Playback API service by its reference ID, a customer supplied unique identifier.

Parameters:

referenceID - string containing the reference ID of the playlist to find.

playlistListener - A callback which will be invoked when the request finishes or an error occurs.

findPlaylistByReferenceID

@Deprecated
public void findPlaylistByReferenceID(@NonNull
 String referenceID,
 @Nullable
 Map<String,String> headers,
 @NonNull
 PlaylistListener playlistListener)

Deprecated.

Please use findPlaylistByReferenceID(String, HttpRequestConfig, PlaylistListener) instead.

findPlaylistByReferenceID

@Deprecated
public void findPlaylistByReferenceID(@NonNull
 String referenceID,
 @Nullable
 Map<String,String> headers,
 @Nullable
 Map<String,String> queryParameters,
 @NonNull
 PlaylistListener playlistListener)

Deprecated.

Please use findPlaylistByReferenceID(String, HttpRequestConfig, PlaylistListener) instead.

findVideoByID

public void findVideoByID(@NonNull
 String videoID,
 @NonNull
 HttpRequestConfig httpRequestConfig,
 @NonNull
 VideoListener videoListener)

Retrieves a Video from the Playback API service by its video ID.

If your VideoCloud configuration requires a Brightcove Authorization token, provide it using HttpRequestConfig.Builder.setBrightcoveAuthorizationToken(String). This token will be configured when creating the Video object, and it will be used when requesting the Video license.

Parameters:

videoID - string containing the ID of the video to find.

httpRequestConfig - a configuration class with values used in the request.

videoListener - A callback which will be invoked when the request finishes or an error occurs.

findVideoByID

public void findVideoByID(@NonNull
 String videoID,
 @NonNull
 VideoListener videoListener)

Retrieves a Video from the Playback API service by its video ID.

Parameters:

videoID - string containing the ID of the video to find.

videoListener - A callback which will be invoked when the request finishes or an error occurs.

findVideoByID

@Deprecated
public void findVideoByID(@NonNull
 String videoID,
 @Nullable
 Map<String,String> headers,
 @NonNull
 VideoListener videoListener)

Deprecated.

Please use findVideoByID(String, HttpRequestConfig, VideoListener) instead.

findVideoByID

@Deprecated
public void findVideoByID(@NonNull
 String videoID,
 @Nullable
 Map<String,String> headers,
 @Nullable
 Map<String,String> queryParameters,
 @NonNull
 VideoListener videoListener)

Deprecated.

Please use findVideoByID(String, HttpRequestConfig, VideoListener) instead.

findVideoByReferenceID

public void findVideoByReferenceID(@NonNull
 String referenceID,
 @NonNull
 HttpRequestConfig httpRequestConfig,
 @NonNull
 VideoListener videoListener)

Retrieves a Video from the Playback API service by its reference ID, a customer supplied unique identifier.

If your VideoCloud configuration requires a Brightcove Authorization token, provide it using HttpRequestConfig.Builder.setBrightcoveAuthorizationToken(String). This token will be configured when creating the Video object, and it will be used when requesting the Video license.

Parameters:

referenceID - string containing the reference ID of the video to find.

httpRequestConfig - a configuration class with values used in the request.

videoListener - A callback which will be invoked when the request finishes or an error occurs.

findVideoByReferenceID

public void findVideoByReferenceID(@NonNull
 String referenceID,
 @NonNull
 VideoListener videoListener)

Retrieves a Video from the Playback API service by its reference ID, a customer supplied unique identifier.

Parameters:

referenceID - string containing the reference ID of the video to find.

videoListener - A callback which will be invoked when the request finishes or an error occurs.

findVideoByReferenceID

@Deprecated
public void findVideoByReferenceID(@NonNull
 String referenceID,
 @Nullable
 Map<String,String> headers,
 @NonNull
 VideoListener videoListener)

Deprecated.

Please use findVideoByReferenceID(String, HttpRequestConfig, VideoListener) instead.

findVideoByReferenceID

@Deprecated
public void findVideoByReferenceID(@NonNull
 String referenceID,
 @Nullable
 Map<String,String> headers,
 @Nullable
 Map<String,String> queryParameters,
 @NonNull
 VideoListener videoListener)

Deprecated.

Please use findVideoByReferenceID(String, HttpRequestConfig, VideoListener) instead.

getProperties

public Map<String,String> getProperties()

Get the Map of properties for this Offline Catalog

Returns:

The map of optional properties