OpenVeo Publish server

API Docs for: 8.0.0
Show:

WowzaProvider

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

Summary

Defines a WowzaProvider class to interact with wowza platform.

Constructor

WowzaProvider

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

Syntax

WowzaProvider

(
  • providerConf
)

Summary

Parameters:

  • providerConf Object

    A wowza configuration object

    • host String

      Server host

    • user String

      Wowza user

    • pwd String

      Wowza user password

    • [protocol=ftp] String optional

      Server protocol (ftp, frtp, sftp or ftps)

    • [port] Number optional

      Server port

Item Index

Methods

Properties

Methods

getMediaInfo

Inherited from MediaPlatformProvider but overwritten in app/server/providers/mediaPlatforms/WowzaProvider.js:99

Syntax

getMediaInfo

(
  • mediaId
  • expectedDefintion
  • callback
)
async

Summary

Gets information about a media hosted by Wowza.

Parameters:

  • mediaId String

    The Wowza id of the media

  • expectedDefintion String

    The expected media definition, not used for this provider

  • 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/WowzaProvider.js:142

Syntax

remove

(
  • mediaIds
  • callback
)
async

Summary

Removes a media from the Wowza platform.

Parameters:

  • mediaIds Array

    Wowza 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: 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

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

Syntax

upload

(
  • mediaFilePath
  • callback
)
async

Summary

Uploads a media to the Wowza 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.

ftps

Defined in app/server/providers/mediaPlatforms/WowzaProvider.js:32

Syntax

ftps

FTPS final

Summary

FTPS client.