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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_EDGE_BASE_URL

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

eventEmitter, listenerTokens

Constructor Summary

Constructors

Constructor and Description
Catalog(EventEmitter eventEmitter, java.lang.String account, java.lang.String policy)
Catalog(EventEmitter eventEmitter, java.lang.String account, java.lang.String policy, java.lang.String baseURL)

Method Summary

Modifier and Type	Method and Description
void	findPlaylistByID(java.lang.String playlistID, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> queryParameters, PlaylistListener playlistListener) Retrieves a Playlist from the Playback API service by its playlist ID.
void	findPlaylistByID(java.lang.String playlistID, java.util.Map<java.lang.String,java.lang.String> headers, PlaylistListener playlistListener) Retrieves a Playlist from the Playback API service by its playlist ID.
void	findPlaylistByID(java.lang.String playlistID, PlaylistListener playlistListener) Retrieves a Playlist from the Playback API service by its playlist ID.
void	findPlaylistByReferenceID(java.lang.String referenceID, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> queryParameters, PlaylistListener playlistListener) Retrieves a Playlist from the Playback API service by its reference ID, a customer supplied unique identifier.
void	findPlaylistByReferenceID(java.lang.String referenceID, java.util.Map<java.lang.String,java.lang.String> headers, PlaylistListener playlistListener) Retrieves a Playlist from the Playback API service by its reference ID, a customer supplied unique identifier.
void	findPlaylistByReferenceID(java.lang.String referenceID, PlaylistListener playlistListener) Retrieves a Playlist from the Playback API service by its reference ID, a customer supplied unique identifier.
void	findVideoByID(java.lang.String videoID, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> queryParameters, VideoListener videoListener) Retrieves a Video from the Playback API service by its video ID.
void	findVideoByID(java.lang.String videoID, java.util.Map<java.lang.String,java.lang.String> headers, VideoListener videoListener) Retrieves a Video from the Playback API service by its video ID.
void	findVideoByID(java.lang.String videoID, VideoListener videoListener) Retrieves a Video from the Playback API service by its video ID.
void	findVideoByReferenceID(java.lang.String referenceID, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> queryParameters, VideoListener videoListener) Retrieves a Video from the Playback API service by its reference ID, a customer supplied unique identifier.
void	findVideoByReferenceID(java.lang.String referenceID, java.util.Map<java.lang.String,java.lang.String> headers, VideoListener videoListener) Retrieves a Video from the Playback API service by its reference ID, a customer supplied unique identifier.
void	findVideoByReferenceID(java.lang.String referenceID, VideoListener videoListener) Retrieves a Video from the Playback API service by its reference ID, a customer supplied unique identifier.

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 Detail

DEFAULT_EDGE_BASE_URL

public static final java.lang.String DEFAULT_EDGE_BASE_URL

See Also:

Constant Field Values

Constructor Detail

Catalog

public Catalog(EventEmitter eventEmitter,
               java.lang.String account,
               java.lang.String policy)

Catalog

public Catalog(EventEmitter eventEmitter,
               java.lang.String account,
               java.lang.String policy,
               java.lang.String baseURL)

Method Detail

findPlaylistByID

public void findPlaylistByID(@NonNull
                             java.lang.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

public void findPlaylistByID(@NonNull
                             java.lang.String playlistID,
                             @Nullable
                             java.util.Map<java.lang.String,java.lang.String> headers,
                             @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.

headers - An optional Map of key-value pairs for the Playback API request headers.

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

findPlaylistByID

public void findPlaylistByID(@NonNull
                             java.lang.String playlistID,
                             @Nullable
                             java.util.Map<java.lang.String,java.lang.String> headers,
                             @Nullable
                             java.util.Map<java.lang.String,java.lang.String> queryParameters,
                             @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.

headers - An optional Map of key-value pairs for the Playback API request headers.

queryParameters - An optional Map of key-value pairs for the Playback API request query parameters.

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

findPlaylistByReferenceID

public void findPlaylistByReferenceID(@NonNull
                                      java.lang.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

public void findPlaylistByReferenceID(@NonNull
                                      java.lang.String referenceID,
                                      @Nullable
                                      java.util.Map<java.lang.String,java.lang.String> headers,
                                      @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.

headers - An optional Map of key-value pairs for the Playback API request headers.

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

findPlaylistByReferenceID

public void findPlaylistByReferenceID(@NonNull
                                      java.lang.String referenceID,
                                      @Nullable
                                      java.util.Map<java.lang.String,java.lang.String> headers,
                                      @Nullable
                                      java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                      @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.

headers - An optional Map of key-value pairs for the Playback API request headers.

queryParameters - An optional Map of key-value pairs for the Playback API request query parameters.

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

findVideoByID

public void findVideoByID(@NonNull
                          java.lang.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

public void findVideoByID(@NonNull
                          java.lang.String videoID,
                          @Nullable
                          java.util.Map<java.lang.String,java.lang.String> headers,
                          @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.

headers - An optional Map of key-value pairs for the Playback API request headers.

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

findVideoByID

public void findVideoByID(@NonNull
                          java.lang.String videoID,
                          @Nullable
                          java.util.Map<java.lang.String,java.lang.String> headers,
                          @Nullable
                          java.util.Map<java.lang.String,java.lang.String> queryParameters,
                          @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.

headers - An optional Map of key-value pairs for the Playback API request headers.

queryParameters - An optional Map of key-value pairs for the Playback API request query parameters.

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

findVideoByReferenceID

public void findVideoByReferenceID(@NonNull
                                   java.lang.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

public void findVideoByReferenceID(@NonNull
                                   java.lang.String referenceID,
                                   @Nullable
                                   java.util.Map<java.lang.String,java.lang.String> headers,
                                   @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.

headers - An optional Map of key-value pairs for the Playback API request headers.

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

findVideoByReferenceID

public void findVideoByReferenceID(@NonNull
                                   java.lang.String referenceID,
                                   @Nullable
                                   java.util.Map<java.lang.String,java.lang.String> headers,
                                   @Nullable
                                   java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                   @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.

headers - An optional Map of key-value pairs for the Playback API request headers.

queryParameters - An optional Map of key-value pairs for the Playback API request query parameters.

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