Jive API (3.0.13) Core Javadocs

com.jivesoftware.community.media.video
Interface VideoSettingsManager

All Known Implementing Classes:
DefaultVideoSettingsManager

public interface VideoSettingsManager

Allows for configuration of the video feature. Enables custom player and publish profiles to be used. The goal is that if a customer wants any custom player profiles default implementations of this can be overrridden or a new implmentations can be created.


Field Summary
static String AUTH
           
static String BLOG_PLAYER
           
static String DEFAULT_PLAYER
           
static String DISCUSSION_PLAYER
           
static String DOCUMENT_PLAYER
           
static String EMBED_WORKFLOW
           
static String EMBED_WORKFLOW_NOCAM
           
static String MAX_PLAYS_PER_TOKEN
           
static String MAX_TIME_PER_TOKEN
           
static String VIDEO_PLAYER
           
static String WATERMARKID
           
static String WEBCAM
           
static String WORKFLOW
           
static String WORKFLOW_NOCAM
           
 
Method Summary
 String getBlogPlayerName()
          Returns the name of the video player skin used for videos embedded in blog posts.
 String getDefaultPlayerName()
          Returns the name of the default video player
 String getDiscussionPlayerName()
          Returns the name of the video player used for videos embedded in discussions.
 String getDocumentPlayerName()
          Returns the name of the video player used for videos embedded in documents.
 String getEmbedNoCamWorkflowName()
          Retrieves the name of the workflow for uploading video as embedded content with no support for webcam video embedding
 String getEmbedWorkflowName()
          Retrieves the name of the workflow for uploading video as embedded content or inserting webcam recorded video as embedded content.
 int getMaxPlaysPerToken()
          Returns the maximum number of video plays allowed before a token is invalidated
 int getTokenTimeOut()
          Returns the timeout period before a token is invalidated
 String getVideoNoCamWorkflowName()
          Retrieves the name of the workflow for uploading video content with no webcam support.
 String getVideoPlayerName()
          Returns the name of the video player used for videos that are not embedded.
 String getVideoWorkflowName()
          Retrieves the name of the workflow for uploading video content or creating a new video from a webcam recording session.
 boolean isAuthenticationEnabled()
          Returns true if authenticated video streams are enabled, false otherwise.
 boolean isWebCamEnabled()
          Returns true if the webcam recording feature is turned on, false otherwise
 

Field Detail

WEBCAM

static final String WEBCAM
See Also:
Constant Field Values

AUTH

static final String AUTH
See Also:
Constant Field Values

MAX_PLAYS_PER_TOKEN

static final String MAX_PLAYS_PER_TOKEN
See Also:
Constant Field Values

MAX_TIME_PER_TOKEN

static final String MAX_TIME_PER_TOKEN
See Also:
Constant Field Values

DISCUSSION_PLAYER

static final String DISCUSSION_PLAYER
See Also:
Constant Field Values

DOCUMENT_PLAYER

static final String DOCUMENT_PLAYER
See Also:
Constant Field Values

BLOG_PLAYER

static final String BLOG_PLAYER
See Also:
Constant Field Values

VIDEO_PLAYER

static final String VIDEO_PLAYER
See Also:
Constant Field Values

DEFAULT_PLAYER

static final String DEFAULT_PLAYER
See Also:
Constant Field Values

EMBED_WORKFLOW

static final String EMBED_WORKFLOW
See Also:
Constant Field Values

WORKFLOW

static final String WORKFLOW
See Also:
Constant Field Values

EMBED_WORKFLOW_NOCAM

static final String EMBED_WORKFLOW_NOCAM
See Also:
Constant Field Values

WORKFLOW_NOCAM

static final String WORKFLOW_NOCAM
See Also:
Constant Field Values

WATERMARKID

static final String WATERMARKID
See Also:
Constant Field Values
Method Detail

isWebCamEnabled

boolean isWebCamEnabled()
Returns true if the webcam recording feature is turned on, false otherwise

Returns:
true if webcam recording is enabled

isAuthenticationEnabled

boolean isAuthenticationEnabled()
Returns true if authenticated video streams are enabled, false otherwise. If authenticated streams are enabled, then before video playback the video player will perform a callback to determine if the effective user is permitted to view the given video. If authenticated streams are disabled, then streams can be intercepted and anyone one with access to the video url can play the video. Authenticated streams are appropriate for sites with stringent security requirments and that only allow registered users to view videos. It is recommended that high volume publicly accessible (on the WWW) sites only use unauthenticated streams since bypassing the authentication process will speed video playback

Returns:
true if authenticated video streams are enabled, false otherwise.

getMaxPlaysPerToken

int getMaxPlaysPerToken()
Returns the maximum number of video plays allowed before a token is invalidated

Returns:
the maximum plays per token

getTokenTimeOut

int getTokenTimeOut()
Returns the timeout period before a token is invalidated


getVideoPlayerName

String getVideoPlayerName()
Returns the name of the video player used for videos that are not embedded.

Returns:
player name

getDiscussionPlayerName

String getDiscussionPlayerName()
Returns the name of the video player used for videos embedded in discussions.

Returns:
player name

getDocumentPlayerName

String getDocumentPlayerName()
Returns the name of the video player used for videos embedded in documents.

Returns:
player name

getDefaultPlayerName

String getDefaultPlayerName()
Returns the name of the default video player

Returns:
player name

getBlogPlayerName

String getBlogPlayerName()
Returns the name of the video player skin used for videos embedded in blog posts.

Returns:
player skin name

getEmbedWorkflowName

String getEmbedWorkflowName()
Retrieves the name of the workflow for uploading video as embedded content or inserting webcam recorded video as embedded content.

Returns:
the workflow name

getEmbedNoCamWorkflowName

String getEmbedNoCamWorkflowName()
Retrieves the name of the workflow for uploading video as embedded content with no support for webcam video embedding

Returns:
the workflow name

getVideoWorkflowName

String getVideoWorkflowName()
Retrieves the name of the workflow for uploading video content or creating a new video from a webcam recording session.

Returns:
the workflow name

getVideoNoCamWorkflowName

String getVideoNoCamWorkflowName()
Retrieves the name of the workflow for uploading video content with no webcam support.

Returns:
the workflow name

Jive Product Page

Copyright © 1999-2007 Jive Software.