Package org.opencastproject.publication.youtube

Class YouTubeAPIVersion3ServiceImpl

java.lang.Object

org.opencastproject.publication.youtube.YouTubeAPIVersion3ServiceImpl

All Implemented Interfaces:

YouTubeAPIVersion3Service

public class YouTubeAPIVersion3ServiceImpl
extends Object
implements YouTubeAPIVersion3Service

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.publication.youtube.YouTubeAPIVersion3Service

YouTubeAPIVersion3Service.PrivacyStatus

Constructor Summary

Constructors

Constructor	Description
YouTubeAPIVersion3ServiceImpl()

Method Summary

Modifier and Type	Method	Description
com.google.api.services.youtube.model.Caption	addCaptions(String videoId, File file, String language, String name)	Add captions to a video.
com.google.api.services.youtube.model.PlaylistItem	addPlaylistItem(String playlistId, String videoId)	Add a previously uploaded video to specified YouTube playlist.
com.google.api.services.youtube.model.Video	addVideoToMyChannel(VideoUpload videoUpload)	Upload a video to predefined YouTube channel.
com.google.api.services.youtube.model.Playlist	createPlaylist(String title, String description, YouTubeAPIVersion3Service.PrivacyStatus privacyStatus, String... tags)	Creates YouTube Playlist and adds it to the authorized account.
com.google.api.services.youtube.model.Playlist	getMyPlaylistByTitle(String title)	Get playlist by title.
com.google.api.services.youtube.model.PlaylistListResponse	getMyPlaylists(String pageToken, long maxResults)	Page through all YouTube playlists of predefined channel.
com.google.api.services.youtube.model.PlaylistItemListResponse	getPlaylistItems(String playlistId, String pageToken, long maxResults)	Find YouTube playlist by id.
com.google.api.services.youtube.model.Video	getVideoById(String videoId)	Get video by id.
void	initialize(ClientCredentials credentials)	Configure the underlying YouTube instance.
void	removeMyPlaylist(String playlistId)	Remove a previously created YouTube playlist.
void	removeMyVideo(String videoId)	Remove a previously uploaded video from YouTube.
void	removeVideoFromPlaylist(String playlistId, String videoId)	Remove a previously uploaded video from specified YouTube playlist.
void	setThumbnail(String videoId, File thumbnail, String mimeType)	Set a thumbnail for a video.

Methods inherited from class java.lang.Object

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

Constructor Details

YouTubeAPIVersion3ServiceImpl

public YouTubeAPIVersion3ServiceImpl()

Method Details

initialize

public void initialize(ClientCredentials credentials)
                throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Configure the underlying YouTube instance.

Specified by:

initialize in interface YouTubeAPIVersion3Service

Parameters:

credentials - may not be null

Throws:

IOException - when configuration files not found.

addVideoToMyChannel

public com.google.api.services.youtube.model.Video addVideoToMyChannel(VideoUpload videoUpload)
                                                                throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Upload a video to predefined YouTube channel.

Specified by:

addVideoToMyChannel in interface YouTubeAPIVersion3Service

Parameters:

videoUpload - may not be null

Returns:

YouTube object with non-null id.

Throws:

IOException - when transaction fails.

setThumbnail

public void setThumbnail(String videoId,
 File thumbnail,
 String mimeType)
                  throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Set a thumbnail for a video.

Specified by:

setThumbnail in interface YouTubeAPIVersion3Service

Parameters:

videoId - the video id

thumbnail - the thumbnail file

mimeType - the thumbnail mime type

Throws:

IOException - when transaction fails.

createPlaylist

public com.google.api.services.youtube.model.Playlist createPlaylist(String title,
 String description,
 YouTubeAPIVersion3Service.PrivacyStatus privacyStatus,
 String... tags)
                                                              throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Creates YouTube Playlist and adds it to the authorized account.

Specified by:

createPlaylist in interface YouTubeAPIVersion3Service

Parameters:

title - may not be null

description - may not be null

privacyStatus - may not be null

tags - zero or more tags to be applied to playlist on YouTube.

Throws:

IOException

addPlaylistItem

public com.google.api.services.youtube.model.PlaylistItem addPlaylistItem(String playlistId,
 String videoId)
                                                                   throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Add a previously uploaded video to specified YouTube playlist.

Specified by:

addPlaylistItem in interface YouTubeAPIVersion3Service

Parameters:

playlistId - may not be null

videoId - may not be null

Returns:

YouTube object which describes mapping, with non-null id.

Throws:

IOException

removeVideoFromPlaylist

public void removeVideoFromPlaylist(String playlistId,
 String videoId)
                             throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Remove a previously uploaded video from specified YouTube playlist.

Specified by:

removeVideoFromPlaylist in interface YouTubeAPIVersion3Service

Parameters:

playlistId - may not be null

videoId - may not be null

Throws:

IOException - when transaction fails.

removeMyVideo

public void removeMyVideo(String videoId)
                   throws Exception

Description copied from interface: YouTubeAPIVersion3Service

Remove a previously uploaded video from YouTube.

Specified by:

removeMyVideo in interface YouTubeAPIVersion3Service

Parameters:

videoId - may not be null

Throws:

Exception - when transaction fails.

removeMyPlaylist

public void removeMyPlaylist(String playlistId)
                      throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Remove a previously created YouTube playlist.

Specified by:

removeMyPlaylist in interface YouTubeAPIVersion3Service

Parameters:

playlistId - may not be null

Throws:

IOException - when transaction fails.

getVideoById

public com.google.api.services.youtube.model.Video getVideoById(String videoId)
                                                         throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Get video by id.

Specified by:

getVideoById in interface YouTubeAPIVersion3Service

Parameters:

videoId - may not be null

Returns:

null when not found.

Throws:

IOException

getMyPlaylistByTitle

public com.google.api.services.youtube.model.Playlist getMyPlaylistByTitle(String title)
                                                                    throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Get playlist by title.

Specified by:

getMyPlaylistByTitle in interface YouTubeAPIVersion3Service

Parameters:

title - may not be null

Returns:

null when not found.

Throws:

IOException - when lookup fails.

getMyPlaylists

public com.google.api.services.youtube.model.PlaylistListResponse getMyPlaylists(String pageToken,
 long maxResults)
                                                                          throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Page through all YouTube playlists of predefined channel.

Specified by:

getMyPlaylists in interface YouTubeAPIVersion3Service

Parameters:

pageToken - identifies a page in result-set.

maxResults - limit on number of results.

Returns:

zero or more Playlist

Throws:

IOException - when lookup fails.

getPlaylistItems

public com.google.api.services.youtube.model.PlaylistItemListResponse getPlaylistItems(String playlistId,
 String pageToken,
 long maxResults)
                                                                                throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Find YouTube playlist by id.

Specified by:

getPlaylistItems in interface YouTubeAPIVersion3Service

Parameters:

playlistId - may not be null

pageToken - may not be null

maxResults - may not be null

Returns:

will not be null

Throws:

IOException - when lookup fails.

addCaptions

public com.google.api.services.youtube.model.Caption addCaptions(String videoId,
 File file,
 String language,
 String name)
                                                          throws IOException

Description copied from interface: YouTubeAPIVersion3Service

Add captions to a video.

Specified by:

addCaptions in interface YouTubeAPIVersion3Service

Parameters:

videoId - the video id

file - the caption file

language - the language of the captions

name - the name of the captions

Returns:

the created caption object

Throws:

IOException - when transaction fails.