Jive API (3.0.13) Core Javadocs

com.jivesoftware.community.media.video
Interface VideoScreenGrabManager


public interface VideoScreenGrabManager

CRUD for video screen grabs/key frames


Method Summary
 void add(Video video, String name, String contentType, InputStream data, boolean isDefault)
          Adds a screen grab to a video
 void delete(long id)
          Deletes the screen grab with the given id
 long getDefault(long videoID)
          Retrieves the default screen grab for the video with the given id
 List<Long> getPublishedVideosWithoutScreenGrabs()
          Returns a list of all published videos that are missing a generated screen grab
 List<Long> getScreenGrabsForVideo(Video video)
          Retreives a list of all screen grabs for the given video
 void setDefault(long id)
          Deprecated. 
 

Method Detail

add

void add(Video video,
         String name,
         String contentType,
         InputStream data,
         boolean isDefault)
         throws IllegalStateException,
                AttachmentException,
                UnauthorizedException
Adds a screen grab to a video

Parameters:
video - that the screen grab is from
contentType - of the screen grab
data - representing the screen grab
isDefault - is this screen the default screen grab
Throws:
IllegalStateException
AttachmentException
UnauthorizedException

delete

void delete(long id)
Deletes the screen grab with the given id

Parameters:
id - of the screen grab to delete

setDefault

@Deprecated
void setDefault(long id)
Deprecated. 


getDefault

long getDefault(long videoID)
Retrieves the default screen grab for the video with the given id

Parameters:
videoID - id of video with screen grabs
Returns:
id of the default screen grab

getScreenGrabsForVideo

List<Long> getScreenGrabsForVideo(Video video)
Retreives a list of all screen grabs for the given video

Parameters:
video - to retrieve screen grabs for
Returns:
a list of all screen grabs from the given video

getPublishedVideosWithoutScreenGrabs

List<Long> getPublishedVideosWithoutScreenGrabs()
Returns a list of all published videos that are missing a generated screen grab

Returns:
a list of videos missing screen grabs

Jive Product Page

Copyright © 1999-2007 Jive Software.