Class: TethrManager

Defined in: core/src/TethrManager.ts:27

Extends

EventEmitter<TethrManagerEvents>

Constructors

Constructor

new TethrManager(): TethrManager

Defined in: core/src/TethrManager.ts:34

Returns

TethrManager

Overrides

EventEmitter<TethrManagerEvents>.constructor

Properties

prefixed

static prefixed: string | boolean

Defined in: node_modules/eventemitter3/index.d.ts:9

Inherited from

EventEmitter.prefixed

Accessors

pairedCameras

Get Signature

get pairedCameras(): Tethr[]

Defined in: core/src/TethrManager.ts:119

Returns

Methods

addListener()

addListener<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:45

Type Parameters

T

T extends "pairedCameraChange"

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Inherited from

EventEmitter.addListener

emit()

emit<T>(event, …args): boolean

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters

T

T extends "pairedCameraChange"

Parameters

event

T

args

…ArgumentMap<TethrManagerEvents>[Extract<T, "pairedCameraChange">]

Returns

boolean

Inherited from

EventEmitter.emit

eventNames()

eventNames(): "pairedCameraChange"[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns

"pairedCameraChange"[]

Inherited from

EventEmitter.eventNames

listenerCount()

listenerCount(event): number

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters

event

"pairedCameraChange"

Returns

number

Inherited from

EventEmitter.listenerCount

listeners()

listeners<T>(event): (…args) => void[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters

T

T extends "pairedCameraChange"

Parameters

event

T

Returns

(…args) => void[]

Inherited from

EventEmitter.listeners

off()

off<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:69

Type Parameters

T

T extends "pairedCameraChange"

Parameters

event

T

fn?

(…args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.off

on()

on<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters

T

T extends "pairedCameraChange"

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Inherited from

EventEmitter.on

once()

once<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters

T

T extends "pairedCameraChange"

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Inherited from

EventEmitter.once

removeAllListeners()

removeAllListeners(event?): this

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters

event?

"pairedCameraChange"

Returns

this

Inherited from

EventEmitter.removeAllListeners

removeListener()

removeListener<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters

T

T extends "pairedCameraChange"

Parameters

event

T

fn?

(…args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.removeListener

requestCamera()

requestCamera(query, __namedParameters?): Promise<Tethr | null>

Defined in: core/src/TethrManager.ts:136

Connect to a camera, either by type (prompting the user to pick one) or by a TethrIdentifier (reconnecting to a remembered device).

When given an identifier it first looks among the already-paired devices and returns a silent match if found. Only if none is found — and prompt is not false — does it show a picker (narrowed to the remembered device’s vendor/product for USB). Pass {prompt: false} from contexts that are not a user gesture (e.g. auto-reconnect on load), where requestDevice() / getUserMedia() would otherwise throw.

Parameters

query

TethrDeviceType | TethrIdentifier

__namedParameters?

prompt?

boolean = true

Returns

Promise<Tethr | null>

The (not-yet-opened) camera instance, or null if none matched.