OpenVeo Publish server

API Docs for: 8.0.0
Show:

TlsProvider

Extends MediaPlatformProvider
Defined in: app/server/providers/mediaPlatforms/tls/TlsProvider.js:17
Module: providers

Summary

Defines a TlsProvider to interact with TLS platform.

Constructor

TlsProvider

Defined in app/server/providers/mediaPlatforms/tls/TlsProvider.js:17

Syntax

TlsProvider

(
  • providerConf
)

Summary

Parameters:

  • providerConf Object

    TLS configuration

    • nfsPath String

      The absolute path of the NFS directory shared with TLS

    • mediaDirectoryPath String

      The path of the directory where to store TLS medias. This is relative to nfsPath

    • accessToken String

      The TLS API authentication token

    • url String

      The TLS web service URL

    • [certificate] String optional

      The absolute path of the full certificate chain if the top level authority is not part of system well known authorities

Methods

getMediaInfo

Inherited from MediaPlatformProvider but overwritten in app/server/providers/mediaPlatforms/tls/TlsProvider.js:106

Syntax

getMediaInfo

(
  • mediaIds
  • expectedDefintion
  • callback
)
async

Summary

Gets information about a media hosted by TLS.

Parameters:

  • mediaIds Array

    The list of media ids

  • expectedDefintion String

    The expected media definition. This is not use for TLS provider as TLS doesn't transcode medias

  • callback Function

    The function to call when it's done

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

remove

Inherited from MediaPlatformProvider but overwritten in app/server/providers/mediaPlatforms/tls/TlsProvider.js:150

Syntax

remove

(
  • mediaIds
  • callback
)
async

Summary

Removes medias from TLS platform.

Parameters:

  • mediaIds Array

    TLS 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/tls/TlsProvider.js:182

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 and media custom properties are synchronized with TLS.

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

    • [properties] Object optional

      The media custom properties with id / value pairs, custom properties corresponding to the one in TLS configuration will be updated, others won't

  • force Boolean

    true to force the update even if title and properties 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

Inherited from MediaPlatformProvider but overwritten in app/server/providers/mediaPlatforms/tls/TlsProvider.js:68

Syntax

upload

(
  • mediaFilePath
  • callback
)
async

Summary

Uploads a media to the TLS platform.

Media is uploaded on a local directory as OpenVeo and TLS share a common directory through NFS.

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

Properties

client

Defined in app/server/providers/mediaPlatforms/tls/TlsProvider.js:40

Syntax

client

TlsClient final

Summary

The TLS client to interact with TLS web service.

conf

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

Syntax

conf

Object final

Summary

The media platform's configuration.

mediaDirectoryPath

Defined in app/server/providers/mediaPlatforms/tls/TlsProvider.js:51

Syntax

mediaDirectoryPath

String final

Summary

The absolute path to the directory containing medias.