Class P2CameraConnection

Hierarchy

EventEmitter<P2Events>
- P2CameraConnection

Index

Constructors

Properties

Methods

addListener connect disconnect emit eventNames getCameraState getOpticalState listenerCount listeners off on once removeAllListeners removeListener sendP2Control

Constructors

constructor

new P2CameraConnection(host: string, port: number, username: string, password: string, reconnectInterval?: number): P2CameraConnection
Parameters
- host: string
- port: number
- username: string
- password: string
- reconnectInterval: number = 100
Returns P2CameraConnection
Overrides EventEmitter<P2Events>.constructor
- Defined in src/index.ts:25

Properties

camCtl

camCtl: CamCtlCommands

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void), context?: any): P2CameraConnection
Type Parameters
- T extends keyof P2Events
Parameters
- event: T
- fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)
  - - (...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]
      
      Returns void
- Optional context: any
Returns P2CameraConnection
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

connect

connect(): void
Returns void
- Defined in src/index.ts:63

disconnect

disconnect(): void
Returns void
- Defined in src/index.ts:93

emit

emit<T>(event: T, ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof P2Events
Parameters
- event: T
- Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof P2Events)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof P2Events)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

getCameraState

getCameraState(): null | P2CameraState
Returns null | P2CameraState
- Defined in src/index.ts:281

getOpticalState

getOpticalState(): null | P2OpticalState
Returns null | P2OpticalState
- Defined in src/index.ts:285

listenerCount

listenerCount(event: keyof P2Events): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof P2Events
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof P2Events
Parameters
- event: T
Returns ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T>(event: T, fn?: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void), context?: any, once?: boolean): P2CameraConnection
Type Parameters
- T extends keyof P2Events
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)
  - - (...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns P2CameraConnection
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void), context?: any): P2CameraConnection
Add a listener for a given event.
Type Parameters
- T extends keyof P2Events
Parameters
- event: T
- fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)
  - - (...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]
      
      Returns void
- Optional context: any
Returns P2CameraConnection
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event: T, fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void), context?: any): P2CameraConnection
Add a one-time listener for a given event.
Type Parameters
- T extends keyof P2Events
Parameters
- event: T
- fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)
  - - (...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]
      
      Returns void
- Optional context: any
Returns P2CameraConnection
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: keyof P2Events): P2CameraConnection
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof P2Events
Returns P2CameraConnection
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void), context?: any, once?: boolean): P2CameraConnection
Remove the listeners of a given event.
Type Parameters
- T extends keyof P2Events
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)
  - - (...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns P2CameraConnection
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

sendP2Control

sendP2Control(data: string): void
Parameters
- data: string
Returns void
- Defined in src/index.ts:101

Class P2CameraConnection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

host: string

port: number

username: string

password: string

reconnectInterval: number = 100

Returns P2CameraConnection

Properties

camCtl

Static prefixed

Methods

addListener

Type Parameters

T extends keyof P2Events

Parameters

event: T

fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)

Parameters

Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

Returns void

Optional context: any

Returns P2CameraConnection

connect

Returns void

disconnect

Returns void

emit

Type Parameters

T extends keyof P2Events

Parameters

event: T

Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

Returns boolean

eventNames

Returns (keyof P2Events)[]

getCameraState

Returns null | P2CameraState

getOpticalState

Returns null | P2OpticalState

listenerCount

Parameters

event: keyof P2Events

Returns number

listeners

Type Parameters

T extends keyof P2Events

Parameters

event: T

Returns ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)[]

off

Type Parameters

T extends keyof P2Events

Parameters

event: T

Optional fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)

Parameters

Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

Returns void

Optional context: any

Optional once: boolean

Returns P2CameraConnection

on

Type Parameters

T extends keyof P2Events

Parameters

event: T

fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)

Parameters

Rest ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

Returns void

Optional context: any

Returns P2CameraConnection

`Static` prefixed

`Rest` ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

`Optional` context: any

`Rest` ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

`Optional` fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)

`Rest` ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

`Optional` context: any

`Rest` ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

`Optional` context: any

`Optional` event: keyof P2Events

`Optional` fn: ((...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]) => void)

`Rest` ...args: ArgumentMap<P2Events>[Extract<T, keyof P2Events>]

`Optional` context: any

`Optional` once: boolean