Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
M
O
R
S
T
U
V
W
A
AddImage(String, Image, String, Long, String, Boolean)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Add a new thumbnail or video still image to a video, or assign an existing image to another video.
B
BrightcoveException
- Exception in
com.brightcove.mediaapi.exceptions
All calls to the Media API Wrapper can throw a BrightcoveException.
BrightcoveException()
- Constructor for exception com.brightcove.mediaapi.exceptions.
BrightcoveException
Creates a generic exception with type UNKNOWN_TYPE.
BrightcoveException(String)
- Constructor for exception com.brightcove.mediaapi.exceptions.
BrightcoveException
Creates an exception of type JAVA_EXCEPTION.
BrightcoveException(Exception)
- Constructor for exception com.brightcove.mediaapi.exceptions.
BrightcoveException
Creates an exception of type JAVA_EXCEPTION.
BrightcoveExceptionHandler
- Interface in
com.brightcove.mediaapi.exceptions
Allows users to specify their own logic on what to do when an exception is thrown by the Media API or the Java wraper.
C
com.brightcove.mediaapi.exceptions
- package com.brightcove.mediaapi.exceptions
com.brightcove.mediaapi.wrapper
- package com.brightcove.mediaapi.wrapper
com.brightcove.mediaapi.wrapper.test
- package com.brightcove.mediaapi.wrapper.test
CreatePlaylist(String, Playlist)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Creates a playlist.
CreateVideo(String, Video, String, EncodeToEnum, Boolean, Boolean, Boolean)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Create a new video in the account.
D
DeletePlaylist(String, Long, String, Boolean)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Deletes a playlist, specified by playlist id.
DeleteVideo(String, Long, String, Boolean, Boolean)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Deletes a video.
E
ExceptionType
- Enum in
com.brightcove.mediaapi.exceptions
Types of BrightcoveException that can be thrown by calls to the Wrapper
F
FindAllPlaylists(String, Integer, Integer, SortByTypeEnum, SortOrderTypeEnum, EnumSet<VideoFieldEnum>, Set<String>, EnumSet<PlaylistFieldEnum>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for all playlists
FindAllVideos(String, Integer, Integer, SortByTypeEnum, SortOrderTypeEnum, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for all videos
FindModifiedVideos(String, Long, Set<VideoStateFilterEnum>, Integer, Integer, SortByTypeEnum, SortOrderTypeEnum, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Gets all the videos that have been modified since the given time
FindPlaylistById(String, Long, EnumSet<VideoFieldEnum>, Set<String>, EnumSet<PlaylistFieldEnum>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for the specified playlist
FindPlaylistByReferenceId(String, String, EnumSet<VideoFieldEnum>, Set<String>, EnumSet<PlaylistFieldEnum>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for the specified playlist
FindPlaylistsByIds(String, Set<Long>, EnumSet<VideoFieldEnum>, Set<String>, EnumSet<PlaylistFieldEnum>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for the specified playlists
FindPlaylistsByReferenceIds(String, Set<String>, EnumSet<VideoFieldEnum>, Set<String>, EnumSet<PlaylistFieldEnum>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for the specified playlists
FindPlaylistsForPlayerId(String, String, Integer, Integer, EnumSet<VideoFieldEnum>, Set<String>, EnumSet<PlaylistFieldEnum>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for the specified playlists
FindRelatedVideos(String, Long, String, Integer, Integer, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for related videos.
FindVideoById(String, Long, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for a video with the specified video id (
not
the reference id).
FindVideoByIdUnfiltered(String, Long, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for a video with the specified video id (
not
the reference id).
FindVideoByReferenceId(String, String, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for a video with the specified reference id (
not
the video id).
FindVideoByReferenceIdUnfiltered(String, String, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for a video with the specified reference id (
not
the video id).
FindVideosByCampaignId(String, String, Integer, Integer, SortByTypeEnum, SortOrderTypeEnum, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Gets all the videos associated with the given campaign id.
FindVideosByIds(String, Set<Long>, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for videos with the specified video ids (
not
the reference id).
FindVideosByIdsUnfiltered(String, Set<Long>, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for videos with the specified video ids (
not
the reference id).
FindVideosByReferenceIds(String, Set<String>, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for videos with the specified reference ids (
not
the video id).
FindVideosByReferenceIdsUnfiltered(String, Set<String>, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Looks in the specified account for videos with the specified reference ids (
not
the video id).
FindVideosByTags(String, Set<String>, Set<String>, Integer, Integer, SortByTypeEnum, SortOrderTypeEnum, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Performs a search on all the tags of the videos in this account, and returns a collection of videos that contain the specified tags.
FindVideosByText(String, String, Integer, Integer, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Searches through all the videos in this account, and returns a collection of videos whose name, short description, or long description contain a match for the specified text
FindVideosByUserId(String, String, Integer, Integer, SortByTypeEnum, SortOrderTypeEnum, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Retrieves the videos uploaded by the specified user id.
G
getCode()
- Method in exception com.brightcove.mediaapi.exceptions.
WrapperException
Gets the error code reported by the wrapper
getCode()
- Method in enum com.brightcove.mediaapi.exceptions.
WrapperExceptionCode
getDeliveryProtocol()
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
For advanced users...
getDescription()
- Method in enum com.brightcove.mediaapi.exceptions.
WrapperExceptionCode
getEnableUds()
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Deprecated.
getExtraPostParams()
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
This shouldn't commonly be used, but before the post request is submitted, these parameters can be added to the method.
getJsonObject()
- Method in exception com.brightcove.mediaapi.exceptions.
MediaApiException
Returns the JSON reported by the Media API server
getMessage()
- Method in exception com.brightcove.mediaapi.exceptions.
WrapperException
getResponseCode()
- Method in exception com.brightcove.mediaapi.exceptions.
MediaApiException
Returns the numeric error code reported by the Media API server
getResponseMessage()
- Method in exception com.brightcove.mediaapi.exceptions.
MediaApiException
Returns the textual description of the error as reported by the Media API server
getType()
- Method in exception com.brightcove.mediaapi.exceptions.
BrightcoveException
Gets the type of exception.
GetUploadStatus(String, Long, String)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Call this function in an HTTP POST request to determine the status of an upload.
H
handleException(BrightcoveException, String)
- Method in interface com.brightcove.mediaapi.exceptions.
BrightcoveExceptionHandler
Called whenever the Media API wrapper encounters an exception
M
main(String[])
- Static method in class com.brightcove.mediaapi.wrapper.test.
ReadTests
Main execution kickoff
main(String[])
- Static method in class com.brightcove.mediaapi.wrapper.test.
WriteTests
Main execution kickoff
MEDIA_API_ERROR_UNPARSABLE
- Static variable in exception com.brightcove.mediaapi.exceptions.
MediaApiException
MediaApiException
- Exception in
com.brightcove.mediaapi.exceptions
This is an exception thrown by the Media API (not the Java wrapper)
MediaApiException(JSONObject)
- Constructor for exception com.brightcove.mediaapi.exceptions.
MediaApiException
Creates a new Media API Exception using JSON returned by the Media API server to populate any details.
O
OverrideHttpClientFactory(HttpClientFactory)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Overrides the standard factory used to create HTTPClients to connect to the Read API Server.
OverrideHttpClientFactory(HttpClientFactory)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Overrides the standard factory used to create HTTPClients to connect to the Write API Server.
OverrideReadApiServerSettings(String, String, Integer, String)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Overrides the standard Read API Server settings to make calls against a test/staging server.
OverrideWriteApiServerSettings(String, String, Integer, String)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Overrides the standard Write API Server settings to make calls against a test/staging server.
R
ReadApi
- Class in
com.brightcove.mediaapi.wrapper
This is a wrapper for the HTTP/JSON Media API provided by Brightcove (
http://www.brightcove.com
)
ReadApi()
- Constructor for class com.brightcove.mediaapi.wrapper.
ReadApi
Default constructor
ReadApi(Logger)
- Constructor for class com.brightcove.mediaapi.wrapper.
ReadApi
Constructor with logging
ReadApi(String)
- Constructor for class com.brightcove.mediaapi.wrapper.
ReadApi
Constructor with character set
ReadApi(Logger, String)
- Constructor for class com.brightcove.mediaapi.wrapper.
ReadApi
Constructor with character set and logging
ReadTests
- Class in
com.brightcove.mediaapi.wrapper.test
ReadTests()
- Constructor for class com.brightcove.mediaapi.wrapper.test.
ReadTests
Constructor
run(String[])
- Method in class com.brightcove.mediaapi.wrapper.test.
ReadTests
run(String[])
- Method in class com.brightcove.mediaapi.wrapper.test.
WriteTests
S
SearchVideos(String, List<String>, List<String>, List<String>, Boolean, SortByTypeEnum, SortOrderTypeEnum, Integer, Integer, EnumSet<VideoFieldEnum>, Set<String>)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Searches videos according to the criteria provided by the user.
setBrightcoveExceptionHandler(BrightcoveExceptionHandler)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
setBrightcoveExceptionHandler(BrightcoveExceptionHandler)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
setDeliveryProtocol(String)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
For advanced users...
setEnableUds(Boolean)
- Method in class com.brightcove.mediaapi.wrapper.
ReadApi
Deprecated.
setExtraPostParams(BcHttpParams)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
This shouldn't commonly be used, but before the post request is submitted, these parameters can be added to the method.
setJsonObject(JSONObject)
- Method in exception com.brightcove.mediaapi.exceptions.
MediaApiException
Sets the JSON reported by the Media API server
setResponseCode(Integer)
- Method in exception com.brightcove.mediaapi.exceptions.
MediaApiException
Sets the numeric error code reported by the Media API server
setResponseMessage(String)
- Method in exception com.brightcove.mediaapi.exceptions.
MediaApiException
Sets the textual description of the error as reported by the Media API server
ShareVideo(String, Long, Boolean, List<Long>)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Shares the specified video with a list of sharee accounts
ShareVideo(String, Long, Boolean, List<Long>, Boolean)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Shares the specified video with a list of sharee accounts
T
toString()
- Method in exception com.brightcove.mediaapi.exceptions.
BrightcoveException
toString()
- Method in exception com.brightcove.mediaapi.exceptions.
MediaApiException
toString()
- Method in exception com.brightcove.mediaapi.exceptions.
WrapperException
type
- Variable in exception com.brightcove.mediaapi.exceptions.
BrightcoveException
U
UpdatePlaylist(String, Playlist)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Updates a playlist, specified by playlist id.
UpdateVideo(String, Video)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Use this method to modify the metadata for a single video in your Brightcove Media Library.
UpdateVideo(String, Video, EnumSet<VideoFieldEnum>)
- Method in class com.brightcove.mediaapi.wrapper.
WriteApi
Use this method to modify the metadata for a single video in your Brightcove Media Library.
V
valueOf(String)
- Static method in enum com.brightcove.mediaapi.exceptions.
ExceptionType
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum com.brightcove.mediaapi.exceptions.
WrapperExceptionCode
Returns the enum constant of this type with the specified name.
values()
- Static method in enum com.brightcove.mediaapi.exceptions.
ExceptionType
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum com.brightcove.mediaapi.exceptions.
WrapperExceptionCode
Returns an array containing the constants of this enum type, in the order they are declared.
W
WrapperException
- Exception in
com.brightcove.mediaapi.exceptions
A Media API Wrapper exception - e.g.
WrapperException(WrapperExceptionCode, String)
- Constructor for exception com.brightcove.mediaapi.exceptions.
WrapperException
Creates a Media API Wrapper exception - this usually indicates that the server couldn't be contacted, or the response couldn't be parsed.
WrapperExceptionCode
- Enum in
com.brightcove.mediaapi.exceptions
Custom error codes that can be reported by the Media API Wrapper
WriteApi
- Class in
com.brightcove.mediaapi.wrapper
This is a wrapper for the HTTP/JSON Media API provided by Brightcove (
http://www.brightcove.com
)
WriteApi()
- Constructor for class com.brightcove.mediaapi.wrapper.
WriteApi
Default constructor
WriteApi(Logger)
- Constructor for class com.brightcove.mediaapi.wrapper.
WriteApi
Constructor with logging
WriteApi(String)
- Constructor for class com.brightcove.mediaapi.wrapper.
WriteApi
Constructor with character set
WriteApi(Logger, String)
- Constructor for class com.brightcove.mediaapi.wrapper.
WriteApi
Constructor with character set and logging
WriteTests
- Class in
com.brightcove.mediaapi.wrapper.test
WriteTests()
- Constructor for class com.brightcove.mediaapi.wrapper.test.
WriteTests
Constructor
A
B
C
D
E
F
G
H
M
O
R
S
T
U
V
W
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
http://opensource.brightcove.com/.