-
- All Implemented Interfaces:
-
com.brightcove.player.event.Component
@Emits(events = {EventType.ERROR, EventType.ACCOUNT, EventType.VIDEO_DOWNLOAD_STARTED, EventType.VIDEO_DOWNLOAD_COMPLETED, EventType.VIDEO_DOWNLOAD_CANCELLED, EventType.VIDEO_DOWNLOAD_FAILED})@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 public class
Catalog.Builder
The Builder to create the Catalog object.
-
Field Summary
Fields Modifier and Type Field Description public final static String
DEFAULT_EDGE_BASE_URL
public final static String
DEFAULT_EPA_BASE_URL
Map<String, String>
properties
-
Constructor Summary
Constructors Constructor Description Catalog(EventEmitter eventEmitter, String account, String policy)
Catalog(EventEmitter eventEmitter, String account, String policy, String baseURL)
-
Method Summary
Modifier and Type Method Description Map<String, String>
getProperties()
Get the Map of properties for this Offline Catalog static Catalog
getInstance()
static Catalog
empty()
void
findPlaylistByID(@NonNull() String playlistID, @NonNull() HttpRequestConfig httpRequestConfig, @NonNull() PlaylistListener playlistListener)
Retrieves a Playlist from the Playback API service by its playlist ID. void
findPlaylistByID(@NonNull() String playlistID, @NonNull() PlaylistListener playlistListener)
Retrieves a Playlist from the Playback API service by its playlist ID. void
findPlaylistByID(@NonNull() String playlistID, @Nullable() Map<String, String> headers, @NonNull() PlaylistListener playlistListener)
void
findPlaylistByID(@NonNull() String playlistID, @Nullable() Map<String, String> headers, @Nullable() Map<String, String> queryParameters, @NonNull() PlaylistListener playlistListener)
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. 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. void
findPlaylistByReferenceID(@NonNull() String referenceID, @Nullable() Map<String, String> headers, @NonNull() PlaylistListener playlistListener)
void
findPlaylistByReferenceID(@NonNull() String referenceID, @Nullable() Map<String, String> headers, @Nullable() Map<String, String> queryParameters, @NonNull() PlaylistListener playlistListener)
void
findVideoByID(@NonNull() String videoID, @NonNull() HttpRequestConfig httpRequestConfig, @NonNull() VideoListener videoListener)
Retrieves a Video from the Playback API service by its video ID. void
findVideoByID(@NonNull() String videoID, @NonNull() VideoListener videoListener)
Retrieves a Video from the Playback API service by its video ID. void
findVideoByID(@NonNull() String videoID, @Nullable() Map<String, String> headers, @NonNull() VideoListener videoListener)
void
findVideoByID(@NonNull() String videoID, @Nullable() Map<String, String> headers, @Nullable() Map<String, String> queryParameters, @NonNull() VideoListener videoListener)
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. 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. void
findVideoByReferenceID(@NonNull() String referenceID, @Nullable() Map<String, String> headers, @NonNull() VideoListener videoListener)
void
findVideoByReferenceID(@NonNull() String referenceID, @Nullable() Map<String, String> headers, @Nullable() Map<String, String> queryParameters, @NonNull() VideoListener videoListener)
-
-
Constructor Detail
-
Catalog
Catalog(EventEmitter eventEmitter, String account, String policy)
-
Catalog
Catalog(EventEmitter eventEmitter, String account, String policy, String baseURL)
-
-
Method Detail
-
getProperties
Map<String, String> getProperties()
Get the Map of properties for this Offline Catalog
-
getInstance
static Catalog getInstance()
-
findPlaylistByID
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 setBrightcoveAuthorizationToken. This token will beconfigured when creating the com.brightcove.player.model.Video object, and it will be usedwhen 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
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() void findPlaylistByID(@NonNull() String playlistID, @Nullable() Map<String, String> headers, @NonNull() PlaylistListener playlistListener)
-
findPlaylistByID
@Deprecated() void findPlaylistByID(@NonNull() String playlistID, @Nullable() Map<String, String> headers, @Nullable() Map<String, String> queryParameters, @NonNull() PlaylistListener playlistListener)
-
findPlaylistByReferenceID
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 setBrightcoveAuthorizationToken. This token will beconfigured when creating the com.brightcove.player.model.Video object, and it will be usedwhen 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
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() void findPlaylistByReferenceID(@NonNull() String referenceID, @Nullable() Map<String, String> headers, @NonNull() PlaylistListener playlistListener)
-
findPlaylistByReferenceID
@Deprecated() void findPlaylistByReferenceID(@NonNull() String referenceID, @Nullable() Map<String, String> headers, @Nullable() Map<String, String> queryParameters, @NonNull() PlaylistListener playlistListener)
-
findVideoByID
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 setBrightcoveAuthorizationToken. This token will beconfigured when creating the com.brightcove.player.model.Video object, and it will be usedwhen 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
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() void findVideoByID(@NonNull() String videoID, @Nullable() Map<String, String> headers, @NonNull() VideoListener videoListener)
-
findVideoByID
@Deprecated() void findVideoByID(@NonNull() String videoID, @Nullable() Map<String, String> headers, @Nullable() Map<String, String> queryParameters, @NonNull() VideoListener videoListener)
-
findVideoByReferenceID
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 setBrightcoveAuthorizationToken. This token will beconfigured when creating the com.brightcove.player.model.Video object, and it will be usedwhen 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
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() void findVideoByReferenceID(@NonNull() String referenceID, @Nullable() Map<String, String> headers, @NonNull() VideoListener videoListener)
-
findVideoByReferenceID
@Deprecated() void findVideoByReferenceID(@NonNull() String referenceID, @Nullable() Map<String, String> headers, @Nullable() Map<String, String> queryParameters, @NonNull() VideoListener videoListener)
-
-
-
-