sdk/com.brightcove.player.edge/Catalog

Catalog

@Emits(events = [EventType.ERROR, EventType.ACCOUNT, EventType.VIDEO_DOWNLOAD_STARTED, EventType.VIDEO_DOWNLOAD_COMPLETED, EventType.VIDEO_DOWNLOAD_CANCELLED, EventType.VIDEO_DOWNLOAD_FAILED])
@ListensFor(events = [])
open class Catalog : 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.

Constructors

Link copied to clipboard
constructor(eventEmitter: EventEmitter, account: String, policy: String)
constructor(eventEmitter: EventEmitter, account: String, policy: String, baseURL: String)

Types

Link copied to clipboard
open class Builder : Catalog.AbstractBuilder<T>
The Builder to create the Catalog object.

Properties

Link copied to clipboard
val DEFAULT_EDGE_BASE_URL: String = "https://edge.api.brightcove.com/playback/v1"
Link copied to clipboard
val DEFAULT_EPA_BASE_URL: String = "https://edge-auth.api.brightcove.com/playback/v1"
Link copied to clipboard
open val properties: Map<String, String>

Functions

Link copied to clipboard
open fun addListener(eventType: String, listener: EventListener)
Convenience method to add an EventListener for the given type using the EventEmitter.on() method.
Link copied to clipboard
open fun addOnceListener(eventType: String, listener: EventListener)
Convenience method to add an EventListener for the given type using the EventEmitter.once() method.
Link copied to clipboard
open fun empty(): Catalog
Link copied to clipboard
open fun findPlaylistByID(playlistID: String, playlistListener: PlaylistListener)
open fun findPlaylistByID(playlistID: String, httpRequestConfig: HttpRequestConfig, playlistListener: PlaylistListener)
Retrieves a Playlist from the Playback API service by its playlist ID.
open fun findPlaylistByID(playlistID: String, headers: Map<String, String>, playlistListener: PlaylistListener)
open fun findPlaylistByID(playlistID: String, headers: Map<String, String>, queryParameters: Map<String, String>, playlistListener: PlaylistListener)
Link copied to clipboard
open fun findPlaylistByReferenceID(referenceID: String, playlistListener: PlaylistListener)
open fun findPlaylistByReferenceID(referenceID: String, httpRequestConfig: HttpRequestConfig, playlistListener: PlaylistListener)
Retrieves a Playlist from the Playback API service by its reference ID, a customer supplied unique identifier.
open fun findPlaylistByReferenceID(referenceID: String, headers: Map<String, String>, playlistListener: PlaylistListener)
open fun findPlaylistByReferenceID(referenceID: String, headers: Map<String, String>, queryParameters: Map<String, String>, playlistListener: PlaylistListener)
Link copied to clipboard
open fun findVideoByID(videoID: String, videoListener: VideoListener)
open fun findVideoByID(videoID: String, httpRequestConfig: HttpRequestConfig, videoListener: VideoListener)
Retrieves a Video from the Playback API service by its video ID.
open fun findVideoByID(videoID: String, headers: Map<String, String>, videoListener: VideoListener)
open fun findVideoByID(videoID: String, headers: Map<String, String>, queryParameters: Map<String, String>, videoListener: VideoListener)
Link copied to clipboard
open fun findVideoByReferenceID(referenceID: String, videoListener: VideoListener)
open fun findVideoByReferenceID(referenceID: String, httpRequestConfig: HttpRequestConfig, videoListener: VideoListener)
Retrieves a Video from the Playback API service by its reference ID, a customer supplied unique identifier.
open fun findVideoByReferenceID(referenceID: String, headers: Map<String, String>, videoListener: VideoListener)
open fun findVideoByReferenceID(referenceID: String, headers: Map<String, String>, queryParameters: Map<String, String>, videoListener: VideoListener)
Link copied to clipboard
open fun getEventEmitter(): EventEmitter
Provides a reference to the EventEmitter with which this component was initialized
Link copied to clipboard
open fun getInstance(): Catalog
Link copied to clipboard
open fun removeListener(eventType: String)
Removes the specified listener from the EventEmitter.
Link copied to clipboard
open fun removeListeners()
Removes all set listeners from the EventEmitter.