TethrTethr
Guide
Capability Report
Playground
API
  • English
  • 日本語
GitHub
Guide
Capability Report
Playground
API
  • English
  • 日本語
GitHub
  • Abstract Class: Tethr

Abstract Class: Tethr

Defined in: core/src/Tethr.ts:135

Extends

  • EventEmitter<EventTypes>

Implements

  • ConfigSetters
  • ConfigGetters
  • ConfigDescGetters

Constructors

Constructor

new Tethr(): Tethr

Defined in: core/src/Tethr.ts:139

Returns

Tethr

Overrides

EventEmitter<EventTypes>.constructor

Action

runAutoFocus()

runAutoFocus(): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:781

Runs auto focus. Use getCanRunAutoFocus to check if the camera supports this action.

Returns

Promise<{ message?: string; status: OperationResultStatus; }>


runManualFocus()

runManualFocus(option): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:790

Runs manual focus. Use getCanRunAutoFocus to check if the camera supports this action.

Parameters

option

"near:2" | "near:1" | "near:3" | "far:2" | "far:1" | "far:3"

Returns

Promise<{ message?: string; status: OperationResultStatus; }>


startLiveview()

startLiveview(): Promise<{ message?: string; status: "unsupported" | "invalid parameter" | "busy" | "general error" | "cancelled"; } | { status: "ok"; value: MediaStream; }>

Defined in: core/src/Tethr.ts:809

Starts liveview. Use getCanStartLiveview to check if the camera supports this action.

Returns

Promise<{ message?: string; status: "unsupported" | "invalid parameter" | "busy" | "general error" | "cancelled"; } | { status: "ok"; value: MediaStream; }>


stopLiveview()

stopLiveview(): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:817

Stops liveview.

Returns

Promise<{ message?: string; status: OperationResultStatus; }>


takePhoto()

takePhoto(option?): Promise<{ message?: string; status: "unsupported" | "invalid parameter" | "busy" | "general error" | "cancelled"; } | { status: "ok"; value: TethrObject[]; }>

Defined in: core/src/Tethr.ts:798

Takes a photo. Use getCanTakePhoto to check if the camera supports this action.

Parameters

option?

TakePhotoOption

Returns

Promise<{ message?: string; status: "unsupported" | "invalid parameter" | "busy" | "general error" | "cancelled"; } | { status: "ok"; value: TethrObject[]; }>

Object Store

deleteObject()

deleteObject(id): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:890

Deletes an object from the camera’s storage.

Parameters

id

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>


getObject()

getObject(id, option?): Promise<{ message?: string; status: "unsupported" | "invalid parameter" | "busy" | "general error" | "cancelled"; } | { status: "ok"; value: TethrObject; }>

Defined in: core/src/Tethr.ts:859

Downloads a full object (e.g. a photo on the card) into a TethrObject. Large transfers are chunked internally and report progress events.

Parameters

id

number

option?

GetObjectOption

Returns

Promise<{ message?: string; status: "unsupported" | "invalid parameter" | "busy" | "general error" | "cancelled"; } | { status: "ok"; value: TethrObject; }>


getObjects()

getObjects(options?): Promise<TethrObjectInfo[]>

Defined in: core/src/Tethr.ts:835

Lists objects (images, movies, folders) on the camera’s storages.

Parameters

options?

GetObjectsOptions

Returns

Promise<TethrObjectInfo[]>


getObjectStream()

getObjectStream(id, option?): ReadableStream<Uint8Array>

Defined in: core/src/Tethr.ts:873

Streams a full object as chunks — pipe huge RAW files straight to disk (File System Access API) without holding the whole file in memory.

Parameters

id

number

option?

GetObjectOption

Returns

ReadableStream<Uint8Array>


getObjectThumbnail()

getObjectThumbnail(id): Promise<Blob | null>

Defined in: core/src/Tethr.ts:847

Fetches a small thumbnail for an object, for gallery grids. Returns null when no thumbnail is available.

Parameters

id

number

Returns

Promise<Blob | null>


getStorages()

getStorages(): Promise<TethrStorage[]>

Defined in: core/src/Tethr.ts:827

Lists the camera’s storages (memory cards / internal memory).

Returns

Promise<TethrStorage[]>

Other

prefixed

static prefixed: string | boolean

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

Inherited from

EventEmitter.prefixed


identifier

Get Signature

get abstract identifier(): TethrIdentifier

Defined in: core/src/Tethr.ts:161

A JSON-serializable descriptor for reconnecting to this camera later.

Returns

TethrIdentifier


name

Get Signature

get abstract name(): string

Defined in: core/src/Tethr.ts:158

Returns

string


opened

Get Signature

get abstract opened(): boolean

Defined in: core/src/Tethr.ts:156

Returns

boolean


type

Get Signature

get abstract type(): TethrDeviceType

Defined in: core/src/Tethr.ts:157

Returns

TethrDeviceType


addListener()

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

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

Type Parameters

T

T extends "progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect"

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Inherited from

EventEmitter.addListener


close()

abstract close(): Promise<void>

Defined in: core/src/Tethr.ts:154

Returns

Promise<void>


emit()

emit(eventName, …args): boolean

Defined in: core/src/Tethr.ts:143

Calls each of the listeners registered for a given event.

Parameters

eventName

"progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect"

args

…any[]

Returns

boolean

Overrides

EventEmitter.emit


eventNames()

eventNames(): ("progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect")[]

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

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

Returns

("progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect")[]

Inherited from

EventEmitter.eventNames


exportConfigs()

exportConfigs(): Promise<Partial<ConfigType>>

Defined in: core/src/Tethr.ts:171

Export all writable configs to a plain object.

Returns

Promise<Partial<ConfigType>>


get()

get<N>(name): Promise<ConfigType[N] | null>

Defined in: core/src/Tethr.ts:207

Type Parameters

N

N extends keyof ConfigType

Parameters

name

N

Returns

Promise<ConfigType[N] | null>


getAperture()

getAperture(): Promise<Aperture | null>

Defined in: core/src/Tethr.ts:242

Returns

Promise<Aperture | null>

Implementation of

ConfigGetters.getAperture


getApertureDesc()

getApertureDesc(): Promise<ConfigDesc<Aperture>>

Defined in: core/src/Tethr.ts:245

Returns

Promise<ConfigDesc<Aperture>>

Implementation of

ConfigDescGetters.getApertureDesc


getAutoFocusFrameCenter()

getAutoFocusFrameCenter(): Promise<vec2 | null>

Defined in: core/src/Tethr.ts:253

Returns

Promise<vec2 | null>

Implementation of

ConfigGetters.getAutoFocusFrameCenter


getAutoFocusFrameCenterDesc()

getAutoFocusFrameCenterDesc(): Promise<ConfigDesc<vec2>>

Defined in: core/src/Tethr.ts:256

Returns

Promise<ConfigDesc<vec2>>

Implementation of

ConfigDescGetters.getAutoFocusFrameCenterDesc


getAutoFocusFrameSize()

getAutoFocusFrameSize(): Promise<string | null>

Defined in: core/src/Tethr.ts:264

Returns

Promise<string | null>

Implementation of

ConfigGetters.getAutoFocusFrameSize


getAutoFocusFrameSizeDesc()

getAutoFocusFrameSizeDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:267

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getAutoFocusFrameSizeDesc


getBatteryLevel()

getBatteryLevel(): Promise<BatteryLevel | null>

Defined in: core/src/Tethr.ts:275

Returns

Promise<BatteryLevel | null>

Implementation of

ConfigGetters.getBatteryLevel


getBatteryLevelDesc()

getBatteryLevelDesc(): Promise<ConfigDesc<BatteryLevel>>

Defined in: core/src/Tethr.ts:278

Returns

Promise<ConfigDesc<BatteryLevel>>

Implementation of

ConfigDescGetters.getBatteryLevelDesc


getBurstInterval()

getBurstInterval(): Promise<number | null>

Defined in: core/src/Tethr.ts:286

Returns

Promise<number | null>

Implementation of

ConfigGetters.getBurstInterval


getBurstIntervalDesc()

getBurstIntervalDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:289

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getBurstIntervalDesc


getBurstNumber()

getBurstNumber(): Promise<number | null>

Defined in: core/src/Tethr.ts:297

Returns

Promise<number | null>

Implementation of

ConfigGetters.getBurstNumber


getBurstNumberDesc()

getBurstNumberDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:300

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getBurstNumberDesc


getCanRunAutoFocus()

getCanRunAutoFocus(): Promise<boolean | null>

Defined in: core/src/Tethr.ts:308

Returns

Promise<boolean | null>

Implementation of

ConfigGetters.getCanRunAutoFocus


getCanRunAutoFocusDesc()

getCanRunAutoFocusDesc(): Promise<ConfigDesc<boolean>>

Defined in: core/src/Tethr.ts:311

Returns

Promise<ConfigDesc<boolean>>

Implementation of

ConfigDescGetters.getCanRunAutoFocusDesc


getCanRunManualFocus()

getCanRunManualFocus(): Promise<boolean | null>

Defined in: core/src/Tethr.ts:319

Returns

Promise<boolean | null>

Implementation of

ConfigGetters.getCanRunManualFocus


getCanRunManualFocusDesc()

getCanRunManualFocusDesc(): Promise<ConfigDesc<boolean>>

Defined in: core/src/Tethr.ts:322

Returns

Promise<ConfigDesc<boolean>>

Implementation of

ConfigDescGetters.getCanRunManualFocusDesc


getCanStartLiveview()

getCanStartLiveview(): Promise<boolean | null>

Defined in: core/src/Tethr.ts:330

Returns

Promise<boolean | null>

Implementation of

ConfigGetters.getCanStartLiveview


getCanStartLiveviewDesc()

getCanStartLiveviewDesc(): Promise<ConfigDesc<boolean>>

Defined in: core/src/Tethr.ts:333

Returns

Promise<ConfigDesc<boolean>>

Implementation of

ConfigDescGetters.getCanStartLiveviewDesc


getCanTakePhoto()

getCanTakePhoto(): Promise<boolean | null>

Defined in: core/src/Tethr.ts:341

Returns

Promise<boolean | null>

Implementation of

ConfigGetters.getCanTakePhoto


getCanTakePhotoDesc()

getCanTakePhotoDesc(): Promise<ConfigDesc<boolean>>

Defined in: core/src/Tethr.ts:344

Returns

Promise<ConfigDesc<boolean>>

Implementation of

ConfigDescGetters.getCanTakePhotoDesc


getCaptureDelay()

getCaptureDelay(): Promise<number | null>

Defined in: core/src/Tethr.ts:352

Returns

Promise<number | null>

Implementation of

ConfigGetters.getCaptureDelay


getCaptureDelayDesc()

getCaptureDelayDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:355

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getCaptureDelayDesc


getColorMode()

getColorMode(): Promise<string | null>

Defined in: core/src/Tethr.ts:363

Returns

Promise<string | null>

Implementation of

ConfigGetters.getColorMode


getColorModeDesc()

getColorModeDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:366

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getColorModeDesc


getColorTemperature()

getColorTemperature(): Promise<number | null>

Defined in: core/src/Tethr.ts:374

Returns

Promise<number | null>

Implementation of

ConfigGetters.getColorTemperature


getColorTemperatureDesc()

getColorTemperatureDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:377

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getColorTemperatureDesc


getCompressionSetting()

getCompressionSetting(): Promise<number | null>

Defined in: core/src/Tethr.ts:385

Returns

Promise<number | null>


getCompressionSettingDesc()

getCompressionSettingDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:388

Returns

Promise<ConfigDesc<number>>


getContrast()

getContrast(): Promise<number | null>

Defined in: core/src/Tethr.ts:396

Returns

Promise<number | null>

Implementation of

ConfigGetters.getContrast


getContrastDesc()

getContrastDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:399

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getContrastDesc


getDateTime()

getDateTime(): Promise<Date | null>

Defined in: core/src/Tethr.ts:407

Returns

Promise<Date | null>

Implementation of

ConfigGetters.getDateTime


getDateTimeDesc()

getDateTimeDesc(): Promise<ConfigDesc<Date>>

Defined in: core/src/Tethr.ts:410

Returns

Promise<ConfigDesc<Date>>

Implementation of

ConfigDescGetters.getDateTimeDesc


getDepthOfFieldPreview()

getDepthOfFieldPreview(): Promise<boolean | null>

Defined in: core/src/Tethr.ts:418

Returns

Promise<boolean | null>

Implementation of

ConfigGetters.getDepthOfFieldPreview


getDepthOfFieldPreviewDesc()

getDepthOfFieldPreviewDesc(): Promise<ConfigDesc<boolean>>

Defined in: core/src/Tethr.ts:421

Returns

Promise<ConfigDesc<boolean>>

Implementation of

ConfigDescGetters.getDepthOfFieldPreviewDesc


getDesc()

getDesc<N>(name): Promise<ConfigDesc<ConfigType[N]>>

Defined in: core/src/Tethr.ts:225

Type Parameters

N

N extends keyof ConfigType

Parameters

name

N

Returns

Promise<ConfigDesc<ConfigType[N]>>


getDestinationToSave()

getDestinationToSave(): Promise<string | null>

Defined in: core/src/Tethr.ts:429

Returns

Promise<string | null>

Implementation of

ConfigGetters.getDestinationToSave


getDestinationToSaveDesc()

getDestinationToSaveDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:432

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getDestinationToSaveDesc


getDigitalZoom()

getDigitalZoom(): Promise<number | null>

Defined in: core/src/Tethr.ts:440

Returns

Promise<number | null>

Implementation of

ConfigGetters.getDigitalZoom


getDigitalZoomDesc()

getDigitalZoomDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:443

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getDigitalZoomDesc


getDriveMode()

getDriveMode(): Promise<DriveMode | null>

Defined in: core/src/Tethr.ts:451

Returns

Promise<DriveMode | null>

Implementation of

ConfigGetters.getDriveMode


getDriveModeDesc()

getDriveModeDesc(): Promise<ConfigDesc<DriveMode>>

Defined in: core/src/Tethr.ts:454

Returns

Promise<ConfigDesc<DriveMode>>

Implementation of

ConfigDescGetters.getDriveModeDesc


getExposureComp()

getExposureComp(): Promise<string | null>

Defined in: core/src/Tethr.ts:462

Returns

Promise<string | null>

Implementation of

ConfigGetters.getExposureComp


getExposureCompDesc()

getExposureCompDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:465

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getExposureCompDesc


getExposureMeteringMode()

getExposureMeteringMode(): Promise<ExposureMeteringMode | null>

Defined in: core/src/Tethr.ts:475

Returns

Promise<ExposureMeteringMode | null>

Implementation of

ConfigGetters.getExposureMeteringMode


getExposureMeteringModeDesc()

getExposureMeteringModeDesc(): Promise<ConfigDesc<ExposureMeteringMode>>

Defined in: core/src/Tethr.ts:478

Returns

Promise<ConfigDesc<ExposureMeteringMode>>

Implementation of

ConfigDescGetters.getExposureMeteringModeDesc


getExposureMode()

getExposureMode(): Promise<ExposureMode | null>

Defined in: core/src/Tethr.ts:488

Returns

Promise<ExposureMode | null>

Implementation of

ConfigGetters.getExposureMode


getExposureModeDesc()

getExposureModeDesc(): Promise<ConfigDesc<ExposureMode>>

Defined in: core/src/Tethr.ts:491

Returns

Promise<ConfigDesc<ExposureMode>>

Implementation of

ConfigDescGetters.getExposureModeDesc


getFlashMode()

getFlashMode(): Promise<FlashMode | null>

Defined in: core/src/Tethr.ts:499

Returns

Promise<FlashMode | null>

Implementation of

ConfigGetters.getFlashMode


getFlashModeDesc()

getFlashModeDesc(): Promise<ConfigDesc<FlashMode>>

Defined in: core/src/Tethr.ts:502

Returns

Promise<ConfigDesc<FlashMode>>

Implementation of

ConfigDescGetters.getFlashModeDesc


getFocalLength()

getFocalLength(): Promise<FocalLength | null>

Defined in: core/src/Tethr.ts:510

Returns

Promise<FocalLength | null>

Implementation of

ConfigGetters.getFocalLength


getFocalLengthDesc()

getFocalLengthDesc(): Promise<ConfigDesc<FocalLength>>

Defined in: core/src/Tethr.ts:513

Returns

Promise<ConfigDesc<FocalLength>>

Implementation of

ConfigDescGetters.getFocalLengthDesc


getFocusDistance()

getFocusDistance(): Promise<number | null>

Defined in: core/src/Tethr.ts:521

Returns

Promise<number | null>

Implementation of

ConfigGetters.getFocusDistance


getFocusDistanceDesc()

getFocusDistanceDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:524

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getFocusDistanceDesc


getFocusMeteringMode()

getFocusMeteringMode(): Promise<FocusMeteringMode | null>

Defined in: core/src/Tethr.ts:534

Returns

Promise<FocusMeteringMode | null>

Implementation of

ConfigGetters.getFocusMeteringMode


getFocusMeteringModeDesc()

getFocusMeteringModeDesc(): Promise<ConfigDesc<FocusMeteringMode>>

Defined in: core/src/Tethr.ts:537

Returns

Promise<ConfigDesc<FocusMeteringMode>>

Implementation of

ConfigDescGetters.getFocusMeteringModeDesc


getFocusMode()

getFocusMode(): Promise<FocusMode | null>

Defined in: core/src/Tethr.ts:545

Returns

Promise<FocusMode | null>

Implementation of

ConfigGetters.getFocusMode


getFocusModeDesc()

getFocusModeDesc(): Promise<ConfigDesc<FocusMode>>

Defined in: core/src/Tethr.ts:548

Returns

Promise<ConfigDesc<FocusMode>>

Implementation of

ConfigDescGetters.getFocusModeDesc


getFocusPeaking()

getFocusPeaking(): Promise<FocusPeaking | null>

Defined in: core/src/Tethr.ts:556

Returns

Promise<FocusPeaking | null>

Implementation of

ConfigGetters.getFocusPeaking


getFocusPeakingDesc()

getFocusPeakingDesc(): Promise<ConfigDesc<FocusPeaking>>

Defined in: core/src/Tethr.ts:559

Returns

Promise<ConfigDesc<FocusPeaking>>

Implementation of

ConfigDescGetters.getFocusPeakingDesc


getFunctionalMode()

getFunctionalMode(): Promise<FunctionalMode | null>

Defined in: core/src/Tethr.ts:567

Returns

Promise<FunctionalMode | null>

Implementation of

ConfigGetters.getFunctionalMode


getFunctionalModeDesc()

getFunctionalModeDesc(): Promise<ConfigDesc<FunctionalMode>>

Defined in: core/src/Tethr.ts:570

Returns

Promise<ConfigDesc<FunctionalMode>>

Implementation of

ConfigDescGetters.getFunctionalModeDesc


getImageAspect()

getImageAspect(): Promise<ImageAspect | null>

Defined in: core/src/Tethr.ts:578

Returns

Promise<ImageAspect | null>

Implementation of

ConfigGetters.getImageAspect


getImageAspectDesc()

getImageAspectDesc(): Promise<ConfigDesc<ImageAspect>>

Defined in: core/src/Tethr.ts:581

Returns

Promise<ConfigDesc<ImageAspect>>

Implementation of

ConfigDescGetters.getImageAspectDesc


getImageQuality()

getImageQuality(): Promise<string | null>

Defined in: core/src/Tethr.ts:589

Returns

Promise<string | null>

Implementation of

ConfigGetters.getImageQuality


getImageQualityDesc()

getImageQualityDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:592

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getImageQualityDesc


getImageSize()

getImageSize(): Promise<string | null>

Defined in: core/src/Tethr.ts:600

Returns

Promise<string | null>

Implementation of

ConfigGetters.getImageSize


getImageSizeDesc()

getImageSizeDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:603

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getImageSizeDesc


getIso()

getIso(): Promise<ISO | null>

Defined in: core/src/Tethr.ts:611

Returns

Promise<ISO | null>

Implementation of

ConfigGetters.getIso


getIsoDesc()

getIsoDesc(): Promise<ConfigDesc<ISO>>

Defined in: core/src/Tethr.ts:614

Returns

Promise<ConfigDesc<ISO>>

Implementation of

ConfigDescGetters.getIsoDesc


getLiveview()

getLiveview(): Promise<MediaStream | null>

Defined in: core/src/Tethr.ts:626

Get the liveview stream when liveview is running. Use getCanStartLiveview to check if the camera supports this action, and startLiveview or stopLiveview to control liveview.

Returns

Promise<MediaStream | null>

Implementation of

ConfigGetters.getLiveview


getLiveviewDesc()

getLiveviewDesc(): Promise<ConfigDesc<MediaStream>>

Defined in: core/src/Tethr.ts:629

Returns

Promise<ConfigDesc<MediaStream>>

Implementation of

ConfigDescGetters.getLiveviewDesc


getLiveviewMagnifyRatio()

getLiveviewMagnifyRatio(): Promise<number | null>

Defined in: core/src/Tethr.ts:637

Returns

Promise<number | null>

Implementation of

ConfigGetters.getLiveviewMagnifyRatio


getLiveviewMagnifyRatioDesc()

getLiveviewMagnifyRatioDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:640

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getLiveviewMagnifyRatioDesc


getLiveviewSize()

getLiveviewSize(): Promise<string | null>

Defined in: core/src/Tethr.ts:658

Returns

Promise<string | null>

Implementation of

ConfigGetters.getLiveviewSize


getLiveviewSizeDesc()

getLiveviewSizeDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:661

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getLiveviewSizeDesc


getManualFocusOptions()

getManualFocusOptions(): Promise<("near:2" | "near:1" | "near:3" | "far:2" | "far:1" | "far:3")[] | null>

Defined in: core/src/Tethr.ts:671

Returns

Promise<("near:2" | "near:1" | "near:3" | "far:2" | "far:1" | "far:3")[] | null>

Implementation of

ConfigGetters.getManualFocusOptions


getManualFocusOptionsDesc()

getManualFocusOptionsDesc(): Promise<ConfigDesc<("near:2" | "near:1" | "near:3" | "far:2" | "far:1" | "far:3")[]>>

Defined in: core/src/Tethr.ts:674

Returns

Promise<ConfigDesc<("near:2" | "near:1" | "near:3" | "far:2" | "far:1" | "far:3")[]>>

Implementation of

ConfigDescGetters.getManualFocusOptionsDesc


getManufacturer()

getManufacturer(): Promise<string | null>

Defined in: core/src/Tethr.ts:682

Returns

Promise<string | null>

Implementation of

ConfigGetters.getManufacturer


getManufacturerDesc()

getManufacturerDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:685

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getManufacturerDesc


getModel()

getModel(): Promise<string | null>

Defined in: core/src/Tethr.ts:693

Returns

Promise<string | null>

Implementation of

ConfigGetters.getModel


getModelDesc()

getModelDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:696

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getModelDesc


getSerialNumber()

getSerialNumber(): Promise<string | null>

Defined in: core/src/Tethr.ts:704

Returns

Promise<string | null>

Implementation of

ConfigGetters.getSerialNumber


getSerialNumberDesc()

getSerialNumberDesc(): Promise<ConfigDesc<string>>

Defined in: core/src/Tethr.ts:707

Returns

Promise<ConfigDesc<string>>

Implementation of

ConfigDescGetters.getSerialNumberDesc


getSharpness()

getSharpness(): Promise<number | null>

Defined in: core/src/Tethr.ts:715

Returns

Promise<number | null>

Implementation of

ConfigGetters.getSharpness


getSharpnessDesc()

getSharpnessDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:718

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getSharpnessDesc


getShutterSound()

getShutterSound(): Promise<number | null>

Defined in: core/src/Tethr.ts:737

Returns

Promise<number | null>

Implementation of

ConfigGetters.getShutterSound


getShutterSoundDesc()

getShutterSoundDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:740

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getShutterSoundDesc


getShutterSpeed()

getShutterSpeed(): Promise<ShutterSpeed | null>

Defined in: core/src/Tethr.ts:726

Returns

Promise<ShutterSpeed | null>

Implementation of

ConfigGetters.getShutterSpeed


getShutterSpeedDesc()

getShutterSpeedDesc(): Promise<ConfigDesc<ShutterSpeed>>

Defined in: core/src/Tethr.ts:729

Returns

Promise<ConfigDesc<ShutterSpeed>>

Implementation of

ConfigDescGetters.getShutterSpeedDesc


getTimelapseInterval()

getTimelapseInterval(): Promise<number | null>

Defined in: core/src/Tethr.ts:748

Returns

Promise<number | null>

Implementation of

ConfigGetters.getTimelapseInterval


getTimelapseIntervalDesc()

getTimelapseIntervalDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:751

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getTimelapseIntervalDesc


getTimelapseNumber()

getTimelapseNumber(): Promise<number | null>

Defined in: core/src/Tethr.ts:759

Returns

Promise<number | null>

Implementation of

ConfigGetters.getTimelapseNumber


getTimelapseNumberDesc()

getTimelapseNumberDesc(): Promise<ConfigDesc<number>>

Defined in: core/src/Tethr.ts:762

Returns

Promise<ConfigDesc<number>>

Implementation of

ConfigDescGetters.getTimelapseNumberDesc


getWhiteBalance()

getWhiteBalance(): Promise<WhiteBalance | null>

Defined in: core/src/Tethr.ts:770

Returns

Promise<WhiteBalance | null>

Implementation of

ConfigGetters.getWhiteBalance


getWhiteBalanceDesc()

getWhiteBalanceDesc(): Promise<ConfigDesc<WhiteBalance>>

Defined in: core/src/Tethr.ts:773

Returns

Promise<ConfigDesc<WhiteBalance>>

Implementation of

ConfigDescGetters.getWhiteBalanceDesc


importConfigs()

importConfigs(configs): Promise<void>

Defined in: core/src/Tethr.ts:189

Apply all writable configs.

Parameters

configs

Partial<ConfigType>

Returns

Promise<void>


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

"progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect"

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 "progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect"

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 "progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect"

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 "progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect"

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 "progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect"

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Inherited from

EventEmitter.once


open()

abstract open(): Promise<void>

Defined in: core/src/Tethr.ts:153

Returns

Promise<void>


removeAllListeners()

removeAllListeners(event?): this

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

Remove all listeners, or those of the specified event.

Parameters

event?

"progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect"

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 "progress" | "apertureChange" | "autoFocusFrameCenterChange" | "autoFocusFrameSizeChange" | "batteryLevelChange" | "burstIntervalChange" | "burstNumberChange" | "canRunAutoFocusChange" | "canRunManualFocusChange" | "canStartLiveviewChange" | "canTakePhotoChange" | "captureDelayChange" | "colorModeChange" | "colorTemperatureChange" | "contrastChange" | "dateTimeChange" | "depthOfFieldPreviewChange" | "destinationToSaveChange" | "digitalZoomChange" | "driveModeChange" | "exposureCompChange" | "exposureMeteringModeChange" | "exposureModeChange" | "flashModeChange" | "focalLengthChange" | "focusDistanceChange" | "focusMeteringModeChange" | "focusModeChange" | "focusPeakingChange" | "functionalModeChange" | "imageAspectChange" | "imageQualityChange" | "imageSizeChange" | "isoChange" | "liveviewChange" | "liveviewMagnifyRatioChange" | "liveviewSizeChange" | "manualFocusOptionsChange" | "manufacturerChange" | "modelChange" | "serialNumberChange" | "sharpnessChange" | "shutterSpeedChange" | "shutterSoundChange" | "timelapseIntervalChange" | "timelapseNumberChange" | "whiteBalanceChange" | "change" | "disconnect"

Parameters

event

T

fn?

(…args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.removeListener


set()

set<N>(name, value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:211

Type Parameters

N

N extends keyof ConfigType

Parameters

name

N

value

ConfigType[N]

Returns

Promise<{ message?: string; status: OperationResultStatus; }>


setAperture()

setAperture(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:239

Parameters

value

Aperture

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setAperture


setAutoFocusFrameCenter()

setAutoFocusFrameCenter(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:250

Parameters

value

vec2

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setAutoFocusFrameCenter


setAutoFocusFrameSize()

setAutoFocusFrameSize(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:261

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setAutoFocusFrameSize


setBatteryLevel()

setBatteryLevel(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:272

Parameters

value

BatteryLevel

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setBatteryLevel


setBurstInterval()

setBurstInterval(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:283

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setBurstInterval


setBurstNumber()

setBurstNumber(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:294

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setBurstNumber


setCanRunAutoFocus()

setCanRunAutoFocus(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:305

Parameters

value

boolean

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setCanRunAutoFocus


setCanRunManualFocus()

setCanRunManualFocus(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:316

Parameters

value

boolean

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setCanRunManualFocus


setCanStartLiveview()

setCanStartLiveview(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:327

Parameters

value

boolean

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setCanStartLiveview


setCanTakePhoto()

setCanTakePhoto(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:338

Parameters

value

boolean

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setCanTakePhoto


setCaptureDelay()

setCaptureDelay(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:349

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setCaptureDelay


setColorMode()

setColorMode(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:360

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setColorMode


setColorTemperature()

setColorTemperature(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:371

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setColorTemperature


setCompressionSetting()

setCompressionSetting(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:382

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>


setContrast()

setContrast(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:393

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setContrast


setDateTime()

setDateTime(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:404

Parameters

value

Date

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setDateTime


setDepthOfFieldPreview()

setDepthOfFieldPreview(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:415

Parameters

value

boolean

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setDepthOfFieldPreview


setDestinationToSave()

setDestinationToSave(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:426

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setDestinationToSave


setDigitalZoom()

setDigitalZoom(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:437

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setDigitalZoom


setDriveMode()

setDriveMode(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:448

Parameters

value

DriveMode

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setDriveMode


setExposureComp()

setExposureComp(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:459

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setExposureComp


setExposureMeteringMode()

setExposureMeteringMode(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:469

Parameters

value

ExposureMeteringMode

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setExposureMeteringMode


setExposureMode()

setExposureMode(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:485

Parameters

value

ExposureMode

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setExposureMode


setFlashMode()

setFlashMode(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:496

Parameters

value

FlashMode

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setFlashMode


setFocalLength()

setFocalLength(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:507

Parameters

value

FocalLength

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setFocalLength


setFocusDistance()

setFocusDistance(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:518

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setFocusDistance


setFocusMeteringMode()

setFocusMeteringMode(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:528

Parameters

value

FocusMeteringMode

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setFocusMeteringMode


setFocusMode()

setFocusMode(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:542

Parameters

value

FocusMode

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setFocusMode


setFocusPeaking()

setFocusPeaking(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:553

Parameters

value

FocusPeaking

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setFocusPeaking


setFunctionalMode()

setFunctionalMode(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:564

Parameters

value

FunctionalMode

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setFunctionalMode


setImageAspect()

setImageAspect(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:575

Parameters

value

ImageAspect

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setImageAspect


setImageQuality()

setImageQuality(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:586

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setImageQuality


setImageSize()

setImageSize(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:597

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setImageSize


setIso()

setIso(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:608

Parameters

value

ISO

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setIso


setLiveview()

setLiveview(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:619

Parameters

value

MediaStream

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setLiveview


setLiveviewMagnifyPos()

setLiveviewMagnifyPos(x, y): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:645

Centre the magnified live-view region on a normalized [0,1] frame position.

Parameters

x

number

y

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>


setLiveviewMagnifyRatio()

setLiveviewMagnifyRatio(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:634

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setLiveviewMagnifyRatio


setLiveviewSize()

setLiveviewSize(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:655

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setLiveviewSize


setLog()

setLog(log): void

Defined in: core/src/Tethr.ts:164

Parameters

log

boolean

Returns

void


setManualFocusOptions()

setManualFocusOptions(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:665

Parameters

value

("near:2" | "near:1" | "near:3" | "far:2" | "far:1" | "far:3")[]

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setManualFocusOptions


setManufacturer()

setManufacturer(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:679

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setManufacturer


setModel()

setModel(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:690

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setModel


setSerialNumber()

setSerialNumber(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:701

Parameters

value

string

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setSerialNumber


setSharpness()

setSharpness(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:712

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setSharpness


setShutterSound()

setShutterSound(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:734

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setShutterSound


setShutterSpeed()

setShutterSpeed(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:723

Parameters

value

ShutterSpeed

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setShutterSpeed


setTimelapseInterval()

setTimelapseInterval(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:745

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setTimelapseInterval


setTimelapseNumber()

setTimelapseNumber(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:756

Parameters

value

number

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setTimelapseNumber


setWhiteBalance()

setWhiteBalance(value): Promise<{ message?: string; status: OperationResultStatus; }>

Defined in: core/src/Tethr.ts:767

Parameters

value

WhiteBalance

Returns

Promise<{ message?: string; status: OperationResultStatus; }>

Implementation of

ConfigSetters.setWhiteBalance

Edit this page