OpenVeo Publish server

API Docs for: 8.0.0
Show:

MediaPlatformProvider

Extends EventEmitter
Defined in: app/server/providers/mediaPlatforms/MediaPlatformProvider.js:10
Module: providers

Summary

Defines a MediaPlatformProvider to interact with media platforms. Use factory to get an instance of the appropriate MediaPlatformProvider.

Constructor

MediaPlatformProvider

Defined in app/server/providers/mediaPlatforms/MediaPlatformProvider.js:10

Syntax

MediaPlatformProvider

(
  • providerConf
)

Summary

Parameters:

  • providerConf Object

    A media platform configuration object, it's structure depend on the provider's type, see extended objects for more information

Item Index

Methods

Properties

Methods

getMediaInfo

Defined in app/server/providers/mediaPlatforms/MediaPlatformProvider.js:103

Syntax

getMediaInfo

(
  • mediaId
  • expectedDefintion
  • callback
)
async

Summary

Gets information about a media from the platform.

Parameters:

  • mediaId String

    The platform id of the media

  • expectedDefintion String

    The expected media definition

  • callback Function

    The function to call when it's done

    • Error The error if an error occurred, null otherwise
    • Object Information about the media

remove

Defined in app/server/providers/mediaPlatforms/MediaPlatformProvider.js:71

Syntax

remove

(
  • mediaIds
  • callback
)
async

Summary

Removes a media from the platform.

Parameters:

  • mediaIds Array

    Platform media ids to remove

  • callback Function

    The function to call when it's done

    • Error The error if an error occurred, null otherwise

update

Defined in app/server/providers/mediaPlatforms/MediaPlatformProvider.js:84

Syntax

update

(
  • media
  • data
  • force
  • callback
)
async

Summary

Updates a media on the platform.

Depending on the platform and what is supported on it, some media properties might be updated and others not. If media has several resources on the platform, the same update will be performed on all resources.

Parameters:

  • media Object

    The media

    • mediaId Array

      The list of media resource ids

  • data Object

    The media datas to update

  • force Boolean

    true to force the update even if datas haven't changed, false otherwise

  • callback Function

    The function to call when it's done

    • Error The error if an error occurred, null otherwise

upload

Defined in app/server/providers/mediaPlatforms/MediaPlatformProvider.js:57

Syntax

upload

(
  • mediaFilePath
  • callback
)
async

Summary

Uploads a media to the platform.

Parameters:

  • mediaFilePath String

    The absolute path of the media to upload

  • callback Function

    The function to call when it's done

    • Error The error if an error occurred, null otherwise
    • String The media id on the platform

Properties

conf

Defined in app/server/providers/mediaPlatforms/MediaPlatformProvider.js:25

Syntax

conf

Object final

Summary

The media platform's configuration.

QUALITIES

Defined in app/server/providers/mediaPlatforms/MediaPlatformProvider.js:44

Syntax

QUALITIES

Object final static

Summary