SourceCamera
Defined in: core/source/icamera.ts:156
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SourceCamera():
SourceCamera
Returns
Section titled “Returns”SourceCamera
Properties
Section titled “Properties”isAudioAvailable
Section titled “isAudioAvailable”isAudioAvailable: () =>
Promise<boolean>
Defined in: core/source/icamera.ts:558
Returns
Section titled “Returns”Promise<boolean>
Methods
Section titled “Methods”getAudioInput()
Section titled “getAudioInput()”getAudioInput():
Promise<MicrophoneDevice>
Defined in: core/source/icamera.ts:269
return: Promise
Gets the microphone device tied as an audio input, rejected if no microphone device is used
Returns
Section titled “Returns”Promise<MicrophoneDevice>
Implementation of
Section titled “Implementation of”getAudioOffset()
Section titled “getAudioOffset()”getAudioOffset():
Promise<number>
Defined in: core/source/icamera.ts:192
return: Promise
Gets audio delay with respect to video feed in milliseconds
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getDelay()
Section titled “getDelay()”getDelay():
Promise<number>
Defined in: core/source/icamera.ts:426
return: Promise
Gets feed capture delay in milliseconds
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getDeviceId()
Section titled “getDeviceId()”getDeviceId():
Promise<string>
Defined in: core/source/icamera.ts:168
return: Promise
Gets the device ID of the underlying camera device.
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”getResolution()
Section titled “getResolution()”getResolution():
Promise<Rectangle>
Defined in: core/source/icamera.ts:183
return: Promise
Gets the camera’s native resolution.
Returns
Section titled “Returns”Promise<Rectangle>
Implementation of
Section titled “Implementation of”getValue()
Section titled “getValue()”getValue():
Promise<string>
Defined in: core/source/icamera.ts:560
return: Promise
Gets the camera device used as a source
source.getValue().then(function(value) { // Do something with the value});Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”isActive()
Section titled “isActive()”isActive():
Promise<boolean>
Defined in: core/source/icamera.ts:409
return: Promise
Checks if camera device is active and present.
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isForceDeinterlace()
Section titled “isForceDeinterlace()”isForceDeinterlace():
Promise<boolean>
Defined in: core/source/icamera.ts:518
return: Promise
Checks whether deinterlacing is enforced
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceCamera.isForceDeinterlace
isHardwareEncoder()
Section titled “isHardwareEncoder()”isHardwareEncoder():
Promise<boolean>
Defined in: core/source/icamera.ts:380
return: Promise
Checks if camera device is a hardware encoder or not. This check may fail if camera device is reinitializing or not present (value defaults to false)
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceCamera.isHardwareEncoder
isStreamPaused()
Section titled “isStreamPaused()”isStreamPaused():
Promise<boolean>
Defined in: core/source/icamera.ts:335
return: Promise
Checks if camera feed is paused
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”setAudioInput()
Section titled “setAudioInput()”setAudioInput(
value):Promise<ISourceCamera>
Defined in: core/source/icamera.ts:312
param: (value: number)
Sets the microphone device to be tied as an audio input
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<ISourceCamera>
Implementation of
Section titled “Implementation of”setAudioOffset()
Section titled “setAudioOffset()”setAudioOffset(
value):Promise<ISourceCamera>
Defined in: core/source/icamera.ts:222
param: (value: number)
Sets audio delay with respect to video feed in milliseconds
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ISourceCamera>
Implementation of
Section titled “Implementation of”setDelay()
Section titled “setDelay()”setDelay(
value):Promise<ISourceCamera>
Defined in: core/source/icamera.ts:457
param: (value: number)
Sets feed capture delay in milliseconds, accepts only positive delay
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ISourceCamera>
Implementation of
Section titled “Implementation of”setForceDeinterlace()
Section titled “setForceDeinterlace()”setForceDeinterlace(
value):Promise<ISourceCamera>
Defined in: core/source/icamera.ts:535
param: (value: boolean)
Enables or disables forcing of deinterlacing
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceCamera>
Implementation of
Section titled “Implementation of”ISourceCamera.setForceDeinterlace
setStreamPaused()
Section titled “setStreamPaused()”setStreamPaused(
value):Promise<ISourceCamera>
Defined in: core/source/icamera.ts:352
param: (value: boolean)
Sets whether camera feed is paused or not
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceCamera>
Implementation of
Section titled “Implementation of”setValue()
Section titled “setValue()”setValue(
camDevice):Promise<SourceCamera>
Defined in: core/source/icamera.ts:579
param: (value: string)
return: Promise<CameraSource>Set the camera device to be used as source
source.setValue('<camera device>') .then(function(source) { // Promise resolves with same Source instance});Parameters
Section titled “Parameters”camDevice
Section titled “camDevice”any
Returns
Section titled “Returns”Promise<SourceCamera>