PublishManager
Summary
Defines the PublishManager which handles the media publication's process.
Media publications are handled in parallel. Media publication's process can be different regarding the type of the media.
Constructor
PublishManager
Syntax
PublishManager
-
videoProvider
-
[maxConcurrentPackage=3]
Summary
Parameters:
-
videoProvider
VideoProviderThe media provider
-
[maxConcurrentPackage=3]
Number optionalThe maximum number of medias to treat in parallel
Example:
var coreApi = process.api.getCoreApi();
var database = coreApi.getDatabase();
var PublishManager = process.requirePublish('app/server/PublishManager.js');
var videoProvider = new VideoProvider(database);
var publishManager = new PublishManager(videoProvider, 5);
// Listen publish manager's errors
publishManager.on('error', function(error) {
// Do something
});
// Listen to publish manager's end of processing for a media
publishManager.on('complete', function(mediaPackage){
// Do something
});
// Listen to publish manager's event informing that a media processing is retrying
publishManager.on('retry', function(mediaPackage) {
// Do something
});
// Listen to publish manager's event informing that a media, waiting for upload, starts uploading
publishManager.on('upload', function(mediaPackage) {
// Do something
});
publishManager.publish({
type: 'youtube', // The media platform to use for this media
originalPackagePath: '/home/openveo/medias/media-package.tar', // Path of the media package
originalFileName: 'media-package' // File name without extension
});
Item Index
Methods
Properties
Events
Methods
addPackage
Syntax
Summary
Adds media package to the list of pending packages.
Parameters:
-
mediaPackage
ObjectThe media package to add to pending packages
Returns:
true if the media package is successfully added to pending packages false if it has been added to queue
createMediaPackageManager
Syntax
Summary
Creates a media package manager corresponding to the media type.
Parameters:
-
mediaPackage
ObjectThe media to manage
Returns:
A media package manager
get
Syntax
Summary
Gets an instance of the PublishManager.
Parameters:
-
videoProvider
VideoProviderThe media provider
-
[maxConcurrentPackage]
Number optionalThe maximum number of medias to treat in parallel
Returns:
The PublishManager singleton instance
onComplete
Syntax
onComplete
-
mediaPackage
Summary
Handles media complete event.
Parameters:
-
mediaPackage
ObjectThe package on error
onError
Syntax
onError
-
error
-
mediaPackage
Summary
Handles media error event.
publish
Syntax
publish
-
mediaPackage
Summary
Publishes the given media package.
Media package must be of one of the supported type.
removeFromPending
Syntax
removeFromPending
-
mediaPackage
Summary
Removes a media from pending medias.
Parameters:
-
mediaPackage
ObjectThe media package to remove
retry
Syntax
retry
-
packageId
-
forceRetry
Summary
Retries publishing a media package which is on error.
retryAll
Syntax
retryAll
()
Summary
Retries publishing all packages in a non stable state.
Stable states are :
- STATES.ERROR
- STATES.WAITING_FOR_UPLOAD
- STATES.READY
- STATES.PUBLISHED
Properties
maxConcurrentPackage
Syntax
Summary
Maximum number of medias to treat in parallel.
Events
complete
Syntax
complete
Summary
Fired when a package process has succeed.
Event Payload:
-
The
Objectprocessed package
error
Syntax
error
Summary
Fired when an error occurred while processing a package.
Event Payload:
-
The
Errorerror
stateChanged
Syntax
stateChanged
Summary
Fired when media state has changed.
Event Payload:
-
The
Objectmedia
upload
Syntax
upload
Summary
Fired when a media stuck in "waiting for upload" state starts uploading.
Event Payload:
-
The
Objectmedia