MSE | @tv2media/v-connection

Representation of a Media Sequencer Engine.

Implementations of this interface are expected to hold minimal state, requesting information from an MSE when it is required. Users of this interface should be aware that every call may take some time to complete.

Rundowns are a v-connection concept held as special playlists in the MSE with a sub-element called sofie_show. It is safe to have more than one instance of a rundown or set up distributed access to a rundown.

Hierarchy

EventEmitter
- MSE

Properties

Readonly hostname

hostname: string

Hostname or IP address for the MSE.

Readonly restPort

restPort: number

Port for HTTP commands to the MSE.

Readonly wsPort

wsPort: number

Websocket port for PepTalk communication with the MSE.

Methods

addListener

addListener(event: string | symbol, listener: ((...args: any[]) => void)): MSE

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/globals.d.ts:636
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MSE

close

close(): Promise<boolean>

- Defined in src/v-connection.ts:527
Close all connections and release any resouces.

Returns Promise<boolean>
Resolves to true on success.

createProfile

createProfile(profileName: string, profileDetailsTbc: any): Promise<VProfile>

- Defined in src/v-connection.ts:503
Create a new profile for this MSE. A profile associated a show with the Vix Engine handlers that it controls, representing the current state of a rundown.

Parameters
- profileName: string
  
  Name of the profile to create.
- profileDetailsTbc: any
  
  TODO
Returns Promise<VProfile>
Resolves to provide details of the newly created profile.

createRundown

createRundown(profile: string, playlistID?: string, description?: string): Promise<VRundown>

- Defined in src/v-connection.ts:487
Create a new rundown to be executed on this MSE.

Parameters
- profile: string
- Optional playlistID: string
  
  Optional UUID identifier for the playlist. If none is provided, one will be generated.
- Optional description: string
  
  Optional rundown description. Used as a name in Viz Content Pilot.
Returns Promise<VRundown>
Resolves to a newly created rundown.

deleteProfile

deleteProfile(profileName: string): Promise<boolean>

- Defined in src/v-connection.ts:511
Delete a profile fot this MSE. A profile cannot be deleted if an associated rundown is active.

Parameters
- profileName: string
  
  Name of the profile to delete.
Returns Promise<boolean>
Resolves true on successful deletion of the profile, or false if the profile does not exist.

deleteRundown

deleteRundown(rundown: VRundown): Promise<boolean>

- Defined in src/v-connection.ts:494
Delete a rundown from this MSE. Note that rundowns can only be deleted when they are not activated.

Parameters
- rundown: VRundown
  
  Rundown to be deleted.
Returns Promise<boolean>
Was the delete operation successful?

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/globals.d.ts:646
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/globals.d.ts:651
Returns (string | symbol)[]

getEngines

getEngines(): Promise<VizEngine[]>

- Defined in src/v-connection.ts:438
Retrieve a list of all Viz Engines with handlers at this MSE.

Returns Promise<VizEngine[]>
Resolves to a list of Viz Engine handlers for this MSE.

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:643
Returns number

getPlaylist

getPlaylist(playlistName: string): Promise<VPlaylist>

- Defined in src/v-connection.ts:477
Retrieve details of a specific playlist as stored at this MSE.

Parameters
- playlistName: string
  
  Name or UUID of a playlist to query.
Returns Promise<VPlaylist>
Resolves to the details of the named playlist.

getProfile

getProfile(profileName: string): Promise<VProfile>

- Defined in src/v-connection.ts:449
Retrieve the details of a specific profile at this MSE.

Parameters
- profileName: string
  
  Name of the profile to query.
Returns Promise<VProfile>
Resolves to the details of the named profile.

getRundown

getRundown(playlistID: string): Promise<VRundown>

- Defined in src/v-connection.ts:433
Retrieve the details and controls for a single Sofie rundown.

Parameters
- playlistID: string
  
  Identifier of the playlist associated with the requested rundown.
Returns Promise<VRundown>
Rundown with the given identifier.

getRundowns

getRundowns(): Promise<VRundown[]>

- Defined in src/v-connection.ts:426
Retrieve the details and controls for all Sofie rundowns of this MSE.

Returns Promise<VRundown[]>
List of rundowns for this MSE.

getShow

getShow(showId: string): Promise<VShow>

- Defined in src/v-connection.ts:466
Retrieve details of a specific show as stored at this MSE.

Parameters
- showId: string
  
  Name of the show to query, a UUID.
Returns Promise<VShow>
Resolves to the details of the named show.

listPlaylists

listPlaylists(): Promise<string[]>

- Defined in src/v-connection.ts:471
List the playlists stored for this MSE.

Returns Promise<string[]>
Resolves to a list of playlists stored for this MSE.

listProfiles

listProfiles(): Promise<string[]>

- Defined in src/v-connection.ts:443
List the names of all the profiles for this MSE.

Returns Promise<string[]>
List of the names of all the profiles known to this MSE.

listShows

listShows(): Promise<string[]>

- Defined in src/v-connection.ts:454
List the shows stored for this MSE.

Returns Promise<string[]>
List of all the shows stored for this MSE.

listShowsFromDirectory

listShowsFromDirectory(): Promise<Map<string, string>>

- Defined in src/v-connection.ts:460
List the shows in the MSE's directory.

Returns Promise<Map<string, string>>
A map of all the shows in the directory (paths relative to /directory/shows/), and their unique IDs. Example entry: ['overlay-shows/sample-show.show', '66E45216-9476-4BDC-9556-C3DB487ED9DF']

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:647
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/globals.d.ts:644
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: ((...args: any[]) => void)): MSE

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/globals.d.ts:640
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MSE

on

on(event: "connected", listener: (() => void)): MSE
on(event: "warning", listener: ((message: string) => void)): MSE
on(event: "disconnected", listener: ((err?: Error) => void)): MSE

Overrides EventEmitter.on
- Defined in src/v-connection.ts:531
Add a listener for all non-error messages and events from the server.

Parameters
- event: "connected"
- listener: (() => void)
  - - (): void
    - Returns void
Returns MSE
Overrides EventEmitter.on
- Defined in src/v-connection.ts:532
Parameters
- event: "warning"
- listener: ((message: string) => void)
  - - (message: string): void
    - Parameters
      - message: string
      Returns void
Returns MSE
Overrides EventEmitter.on
- Defined in src/v-connection.ts:534
Add a listener for all error messages from the server.

Parameters
- event: "disconnected"
- listener: ((err?: Error) => void)
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns MSE

once

once(event: string | symbol, listener: ((...args: any[]) => void)): MSE

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/globals.d.ts:638
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MSE

ping

ping(): Promise<CommandResult>

- Defined in src/v-connection.ts:516
Check the status of PepTalk websocket and HTTP API connections to the MSE.

Returns Promise<CommandResult>
Resolves if both connections were successful.

prependListener

prependListener(event: string | symbol, listener: ((...args: any[]) => void)): MSE

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/globals.d.ts:649
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MSE

prependOnceListener

prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): MSE

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/globals.d.ts:650
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MSE

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/globals.d.ts:645
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): MSE

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:641
Parameters
- Optional event: string | symbol
Returns MSE

removeListener

removeListener(event: string | symbol, listener: ((...args: any[]) => void)): MSE

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/globals.d.ts:639
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MSE

setMaxListeners

setMaxListeners(n: number): MSE

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:642
Parameters
- n: number
Returns MSE

timeout

timeout(t?: number): number

- Defined in src/v-connection.ts:522
Set the maximum amount of time that an operation can take.

Parameters
- Optional t: number
  
  Maximum number of milliseconds for any operation. Omit for query.
Returns number
Timeeout value set. May be different from request if outside range.

Hierarchy

Index

Properties

Methods

Properties

Readonly hostname

Readonly restPort

Readonly wsPort

Methods

addListener

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns MSE

close

Returns Promise<boolean>

createProfile

Parameters

profileName: string

profileDetailsTbc: any

Returns Promise<VProfile>

createRundown

Parameters

profile: string

Optional playlistID: string

Optional description: string

Returns Promise<VRundown>

deleteProfile

Parameters

profileName: string

Returns Promise<boolean>

deleteRundown

Parameters

rundown: VRundown

Returns Promise<boolean>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getEngines

Returns Promise<VizEngine[]>

getMaxListeners

Returns number

getPlaylist

Parameters

playlistName: string

Returns Promise<VPlaylist>

getProfile

Parameters

profileName: string

Returns Promise<VProfile>

getRundown

Parameters

playlistID: string

Returns Promise<VRundown>

getRundowns

Returns Promise<VRundown[]>

getShow

Parameters

showId: string

Returns Promise<VShow>

listPlaylists

Returns Promise<string[]>

listProfiles

Returns Promise<string[]>

listShows

Returns Promise<string[]>

listShowsFromDirectory

Returns Promise<Map<string, string>>

listenerCount

Parameters

type: string | symbol

Returns number

listeners