Options
All
  • Public
  • Public/Protected
  • All
Menu

@tv2media/v-connection

Index

Interfaces

Type Aliases

Functions

Type Aliases

ElementId

ElementId: InternalElementId | ExternalElementId

Functions

createMSE

  • createMSE(hostname: string, restPort?: number, wsPort?: number, resthost?: string): MSE

  • Factory to create an MSE instance to manage commumication between a Node application and a Viz Media Sequencer Engine.

    Parameters

    • hostname: string

      Hostname or IP address for the instance of the MSE to control.

    • Optional restPort: number

      Optional port number for HTTP traffic, is different from the default of 8580.

    • Optional wsPort: number

      Optional port number for PepTalk traffic over websockets, if different from the default of 8695.

    • Optional resthost: string

      Optional different host name for rest connection - for testing purposes only.

    Returns MSE

    New MSE that will start to initialize a connection based on the parameters.

isExternalElement

isInternalElement

Generated using TypeDoc