OpenVeo Publish server

API Docs for: 8.0.0
Show:

VimeoProvider

Extends MediaPlatformProvider
Defined in: app/server/providers/mediaPlatforms/VimeoProvider.js:14
Module: providers

Summary

Defines a VimeoProvider class to interact with vimeo platform.

Constructor

VimeoProvider

Defined in app/server/providers/mediaPlatforms/VimeoProvider.js:14

Syntax

VimeoProvider

(
  • providerConf
)

Summary

Parameters:

  • providerConf Object

    A vimeo configuration object

    • clientId String

      Vimeo client id

    • clientSecret String

      Vimeo client secret

    • accessToken String

      Vimeo client access token

Item Index

Methods

Properties

Methods

getMediaInfo

Inherited from MediaPlatformProvider but overwritten in app/server/providers/mediaPlatforms/VimeoProvider.js:124

Syntax

getMediaInfo

(
  • mediaId
  • expectedDefintion
  • callback
)
async

Summary

Gets information about a media hosted by Vimeo.

Media is considered available if the expected media definition has been transcoded by the media platform.

Parameters:

  • mediaId String

    The Vimeo 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

Inherited from MediaPlatformProvider but overwritten in app/server/providers/mediaPlatforms/VimeoProvider.js:204

Syntax

remove

(
  • mediaIds
  • callback
)
async

Summary

Removes a media from the Vimeo platform.

Parameters:

  • mediaIds Array

    Vimeo media ids to remove

  • callback Function

    The function to call when it's done

    • Error The error if an error occurred, null otherwise

update

Inherited from MediaPlatformProvider but overwritten in app/server/providers/mediaPlatforms/VimeoProvider.js:241

Syntax

update

(
  • media
  • data
  • force
  • callback
)
async

Summary

Updates a media resources on the platform.

If media has several resources on the platform, the same update will be performed for all resources. Actually only the media title is synchronized with Vimeo.

Parameters:

  • media Object

    The media

    • mediaId Array

      The list of media resource ids

  • data Object

    The datas to update

    • [title] String optional

      The media title. Be careful only the first 128 characters will be used. Also HTML tags will be removed

  • force Boolean

    true to force the update even if title hasn't changed, false otherwise

  • callback Function

    The function to call when it's done

    • Error The error if an error occurred, null otherwise

upload

Inherited from MediaPlatformProvider but overwritten in app/server/providers/mediaPlatforms/VimeoProvider.js:60

Syntax

upload

(
  • mediaFilePath
  • callback
)
async

Summary

Uploads a media to the Vimeo platform.

Parameters:

  • mediaFilePath String

    The absolute system 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 Vimeo platform

Properties

conf

Inherited from MediaPlatformProvider: app/server/providers/mediaPlatforms/MediaPlatformProvider.js:25

Syntax

conf

Object final

Summary

The media platform's configuration.

qualitiesMap

Defined in app/server/providers/mediaPlatforms/VimeoProvider.js:39

Syntax

qualitiesMap

Object final

Summary

List of accepted media qualities.

vimeo

Defined in app/server/providers/mediaPlatforms/VimeoProvider.js:30

Syntax

vimeo

Vimeo final

Summary

Vimeo client library.