Package org.opencastproject.editor.api

Interface EditorService

All Known Implementing Classes:

EditorServiceImpl, EditorServiceRemoteImpl

public interface EditorService

Api for the Editor Service

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_TYPE
static final String	TARGET_FILE_NAME	The default file name for generated Smil catalogs.

Method Summary

Modifier and Type	Method	Description
EditingData	getEditData(String mediaPackageId)	Provide information to edit video and audio data relevant to the given mediaPackageId
String	getMetadata(String mediaPackageId)	Provide all meta information about the given mediaPackageId
void	lockMediaPackage(String mediaPackageId, LockData lockData)	Create or refresh lock for the mediapackage
void	setEditData(String mediaPackageId, EditingData editingData)	Store information about edited data relevant to the given mediaPackageId
void	unlockMediaPackage(String mediaPackageId, LockData lockData)	Remove lock for the mediapackage

Field Details

JOB_TYPE

static final String JOB_TYPE

See Also:

• Constant Field Values

TARGET_FILE_NAME

static final String TARGET_FILE_NAME

The default file name for generated Smil catalogs.

See Also:

• Constant Field Values

Method Details

getEditData

EditingData getEditData(String mediaPackageId)
                 throws EditorServiceException,
UnauthorizedException

Provide information to edit video and audio data relevant to the given mediaPackageId

Throws:

EditorServiceException

UnauthorizedException

lockMediaPackage

void lockMediaPackage(String mediaPackageId,
 LockData lockData)
               throws EditorServiceException

Create or refresh lock for the mediapackage

Parameters:

mediaPackageId -

lockData - identify the owner of the lock

Throws:

EditorServiceException - if invalid mediapackge or locked by other

unlockMediaPackage

void unlockMediaPackage(String mediaPackageId,
 LockData lockData)
                 throws EditorServiceException

Remove lock for the mediapackage

Parameters:

mediaPackageId -

lockData - identify the owner of the lock

Throws:

EditorServiceException - if invalid mediapackge or locked by other

setEditData

void setEditData(String mediaPackageId,
 EditingData editingData)
          throws EditorServiceException,
IOException

Store information about edited data relevant to the given mediaPackageId

Parameters:

editingData -

Throws:

EditorServiceException

IOException

getMetadata

String getMetadata(String mediaPackageId)
            throws EditorServiceException

Provide all meta information about the given mediaPackageId

Throws:

EditorServiceException