Class HyperdeckDevice

This is a wrapper for the Hyperdeck Device. Commands to any and all hyperdeck devices will be sent through here.

Hierarchy

Device<HyperdeckOptions, HyperdeckDeviceState, HyperdeckCommandWithContext>
- HyperdeckDevice

Constructors

constructor

new HyperdeckDevice(context: DeviceContextAPI<HyperdeckDeviceState>): HyperdeckDevice
Parameters
- context: DeviceContextAPI<HyperdeckDeviceState>
Returns HyperdeckDevice
Inherited from Device<HyperdeckOptions, HyperdeckDeviceState, HyperdeckCommandWithContext>.constructor
- Defined in packages/timeline-state-resolver/src/service/device.ts:31

Properties

`Private` _connected

_connected: boolean = false

`Private` _expectedTransportStatus

_expectedTransportStatus: undefined | TransportStatus

`Private` `Readonly` _hyperdeck

_hyperdeck: Hyperdeck = ...

`Private` _minRecordingTime

_minRecordingTime: number = 0

`Private` _recTimePollTimer

_recTimePollTimer: undefined | Timer

`Private` _recordingTime

_recordingTime: number = 0

`Private` _slotCount

_slotCount: number = 0

`Private` _slotStatus

_slotStatus: Record<number, SlotInfoCommandResponse> = {}

`Private` _suppressEmptySlotWarnings

_suppressEmptySlotWarnings: boolean = false

`Private` _transportStatus

_transportStatus: undefined | TransportStatus

`Readonly` actions

actions: {
formatDisks: ((id: string, payload?: Record<string, any>) => Promise<ActionExecutionResult<undefined>>);
resync: ((id: string, payload?: Record<string, any>) => Promise<ActionExecutionResult<undefined>>);
} = ...

Type declaration

formatDisks: ((id: string, payload?: Record<string, any>) => Promise<ActionExecutionResult<undefined>>)
- - (id: string, payload?: Record<string, any>): Promise<ActionExecutionResult<undefined>>
  - Parameters
    - id: string
    - Optional payload: Record<string, any>
    Returns Promise<ActionExecutionResult<undefined>>
resync: ((id: string, payload?: Record<string, any>) => Promise<ActionExecutionResult<undefined>>)
- - (id: string, payload?: Record<string, any>): Promise<ActionExecutionResult<undefined>>
  - Parameters
    - id: string
    - Optional payload: Record<string, any>
    Returns Promise<ActionExecutionResult<undefined>>

`Protected` context

context: DeviceContextAPI<HyperdeckDeviceState>

Accessors

connected

get connected(): boolean
Returns boolean
Overrides Device.connected
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:236

Methods

`Private` _connectionChanged

_connectionChanged(): void
Returns void
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:378

`Private` _queryCurrentState

_queryCurrentState(): Promise<HyperdeckDeviceState>
Gets the current state of the device

Returns Promise<HyperdeckDeviceState>
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:312

_queryRecordingTime

_queryRecordingTime(): Promise<void>
Queries the recording time left in seconds of the device and mutates this._recordingTime This is public for the unit tests

Returns Promise<void>
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:333

`Private` _querySlotNumber

_querySlotNumber(): Promise<number>
Returns Promise<number>
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:369

convertTimelineStateToDeviceState

convertTimelineStateToDeviceState(timelineState: Timeline.TimelineState<TSRTimelineContent>, mappings: Mappings<unknown>): HyperdeckDeviceState
Convert a timeline state into an hyperdeck state.
Parameters
- timelineState: Timeline.TimelineState<TSRTimelineContent>
  
  The state to be converted
- mappings: Mappings<unknown>
Returns HyperdeckDeviceState
Overrides Device.convertTimelineStateToDeviceState
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:244

diffStates

diffStates(oldHyperdeckState: undefined | HyperdeckDeviceState, newHyperdeckState: HyperdeckDeviceState): HyperdeckCommandWithContext[]
Compares the new timeline-state with the old one, and generates commands to account for the difference
Parameters
- oldHyperdeckState: undefined | HyperdeckDeviceState
  
  The assumed current state
- newHyperdeckState: HyperdeckDeviceState
  
  The desired state of the device
Returns HyperdeckCommandWithContext[]
Overrides Device.diffStates
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:197

`Private` formatDisks

formatDisks(): Promise<ActionExecutionResult<undefined>>
Sends commands to the HyperDeck to format disks. Afterwards, calls this._queryRecordingTime

Returns Promise<ActionExecutionResult<undefined>>
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:155

getStatus

getStatus(): Omit<DeviceStatus, "active">
Returns Omit<DeviceStatus, "active">
Overrides Device.getStatus
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:251

init

init(initOptions: HyperdeckOptions): Promise<boolean>
Initiates the connection with the Hyperdeck through the hyperdeck-connection lib.
Parameters
- initOptions: HyperdeckOptions
Returns Promise<boolean>
Overrides Device.init
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:49

makeReady

makeReady(_okToDestroyStuff?: boolean): Promise<void>
Deprecated
Parameters
- Optional _okToDestroyStuff: boolean
Returns Promise<void>
Inherited from Device.makeReady
- Defined in packages/timeline-state-resolver/src/service/device.ts:45

`Private` resyncState

resyncState(): Promise<ActionExecutionResult<undefined>>
Returns Promise<ActionExecutionResult<undefined>>
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:136

sendCommand

sendCommand(__namedParameters: HyperdeckCommandWithContext): Promise<void>
Parameters
- __namedParameters: HyperdeckCommandWithContext
Returns Promise<void>
Overrides Device.sendCommand
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:206

standDown

standDown(): Promise<void>
Deprecated

Returns Promise<void>
Inherited from Device.standDown
- Defined in packages/timeline-state-resolver/src/service/device.ts:49

terminate

terminate(): Promise<void>
Makes this device ready for garbage collection.

Returns Promise<void>
Overrides Device.terminate
- Defined in packages/timeline-state-resolver/src/integrations/hyperdeck/index.ts:129

Class HyperdeckDevice

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

context: DeviceContextAPI<HyperdeckDeviceState>

Returns HyperdeckDevice

Properties

Private _connected

Private _expectedTransportStatus

Private Readonly _hyperdeck

Private _minRecordingTime

Private _recTimePollTimer

Private _recordingTime

Private _slotCount

Private _slotStatus

Private _suppressEmptySlotWarnings

Private _transportStatus

Readonly actions

Type declaration

formatDisks: ((id: string, payload?: Record<string, any>) => Promise<ActionExecutionResult<undefined>>)

Parameters

id: string

Optional payload: Record<string, any>

Returns Promise<ActionExecutionResult<undefined>>

resync: ((id: string, payload?: Record<string, any>) => Promise<ActionExecutionResult<undefined>>)

Parameters

id: string

Optional payload: Record<string, any>

Returns Promise<ActionExecutionResult<undefined>>

Protected context

Accessors

connected

Returns boolean

Methods

Private _connectionChanged

Returns void

Private _queryCurrentState

Returns Promise<HyperdeckDeviceState>

_queryRecordingTime

Returns Promise<void>

Private _querySlotNumber

Returns Promise<number>

convertTimelineStateToDeviceState

Parameters

timelineState: Timeline.TimelineState<TSRTimelineContent>

mappings: Mappings<unknown>

Returns HyperdeckDeviceState

diffStates

Parameters

oldHyperdeckState: undefined | HyperdeckDeviceState

newHyperdeckState: HyperdeckDeviceState

Returns HyperdeckCommandWithContext[]

Private formatDisks

Returns Promise<ActionExecutionResult<undefined>>

getStatus

Returns Omit<DeviceStatus, "active">

init

Parameters

initOptions: HyperdeckOptions

Returns Promise<boolean>

makeReady

Deprecated

Parameters

Optional _okToDestroyStuff: boolean

Returns Promise<void>

Private resyncState

Returns Promise<ActionExecutionResult<undefined>>

sendCommand

Parameters

__namedParameters: HyperdeckCommandWithContext

Returns Promise<void>

standDown

Deprecated

Returns Promise<void>

`Private` _connected

`Private` _expectedTransportStatus

`Private` `Readonly` _hyperdeck

`Private` _minRecordingTime

`Private` _recTimePollTimer

`Private` _recordingTime

`Private` _slotCount

`Private` _slotStatus

`Private` _suppressEmptySlotWarnings

`Private` _transportStatus

`Readonly` actions

`Optional` payload: Record<string, any>

`Optional` payload: Record<string, any>

`Protected` context

`Private` _connectionChanged

`Private` _queryCurrentState

`Private` _querySlotNumber

`Private` formatDisks

`Optional` _okToDestroyStuff: boolean

`Private` resyncState