PolyOs API/com.poly.polyos.camera/IPolyCameraService

IPolyCameraService

interface IPolyCameraService
Content copied to clipboard

Camera service exposed for PolyOs Clients

Functions

Link copied to clipboard
abstract fun deletePreset(cameraId: String, preset: Int): Boolean
Content copied to clipboard
Deletes the preset for the given camera Presets are available per camera.
Link copied to clipboard
abstract fun getCamera(cameraId: String): Camera
Content copied to clipboard
Returns the Camera with the given id
Link copied to clipboard
abstract fun getCameraCapability(cameraId: String): CameraCapability
Content copied to clipboard
Returns the CameraCapability for given camera
Link copied to clipboard
abstract fun getCameraDeviceType(cameraId: String): Int
Content copied to clipboard
Get camera device type CameraDeviceType
Link copied to clipboard
abstract fun getCameraImageDataFormat(cameraId: String): Int
Content copied to clipboard
Get the camera image data format that is only for camera 2 API now.
Link copied to clipboard
abstract fun getCameras(filter: CameraType): List<Camera>
Content copied to clipboard
Returns all the Camera of the given filter type.
Link copied to clipboard
@Deprecated
abstract fun getMaxVirtualCameras(): Int
Content copied to clipboard
Returns the global maximum virtual cameras that may be created.
abstract fun getMaxVirtualCameras(cameraID: String): Int
Content copied to clipboard
Returns the maximum virtual cameras that may be created for specific cameraID.
Link copied to clipboard
abstract fun getNumberOfPresets(cameraId: String): Int
Content copied to clipboard
Returns the total number of presets that can be set for the given camera.
Link copied to clipboard
abstract fun getPresenterTrackingInfo(cameraId: String): PresenterTrackingInfo
Content copied to clipboard
Returns the PresenterTrackingInfo for the given camera, if the camera supports it and its current tracking mode is "FramePresenter", otherwise null.
Link copied to clipboard
abstract fun getPresetImageURL(cameraId: String, preset: Int): String
Content copied to clipboard
Internal API.
Link copied to clipboard
abstract fun getPTZ(cameraId: String): CameraPTZValue
Content copied to clipboard
Get the absolute value of current PTZ Camera.
Link copied to clipboard
abstract fun getTrackingMode(cameraId: String): CameraTrackingMode
Content copied to clipboard
Returns the CameraTrackingMode for the given camera.
Link copied to clipboard
abstract fun goToPreset(cameraId: String, preset: Int): Boolean
Content copied to clipboard
Go to the given preset for the given camera.
Link copied to clipboard
abstract fun isAutoFramingOn(cameraId: String): Boolean
Content copied to clipboard
Returns whether auto framing is on for given camera
Link copied to clipboard
abstract fun isCameraShutterOpen(cameraId: String): Boolean
Content copied to clipboard
Get the status of the shutter for camera.
Link copied to clipboard
abstract fun isPresetSaved(cameraId: String, preset: Int): Boolean
Content copied to clipboard
Checks if the preset for the given camera has been saved.
Link copied to clipboard
abstract fun isVirtualCamerasEnabled(cameraId: String): Boolean
Content copied to clipboard
Returns whether virtual cameras are enabled for the given camera.
Link copied to clipboard
abstract fun moveToHomePosition(cameraId: String): Boolean
Content copied to clipboard
Moves the camera's pan, tilt and zoom position back to its home/center coordinates.
Link copied to clipboard
abstract fun registerCameraListener(cameraListener: IPolyCameraListener)
Content copied to clipboard
Register IPolyCameraListener
Link copied to clipboard
abstract fun selectCamera(cameraId: String)
Content copied to clipboard
Set the given camera as selected
Link copied to clipboard
abstract fun setAutoFraming(cameraId: String, on: Boolean): Boolean
Content copied to clipboard
Enable/disable auto framing
Link copied to clipboard
abstract fun setMaxVirtualCameras(max: Int): Boolean
Content copied to clipboard
Sets the global maximum virtual cameras to be created across all logical cameras.
Link copied to clipboard
abstract fun setPresenterTrackingInfo(cameraId: String, presenterTrackingInfo: PresenterTrackingInfo): Boolean
Content copied to clipboard
Sets the PresenterTrackingInfo for the given camera, if the camera supports "FramePresenter" as an available tracking mode.
Link copied to clipboard
abstract fun setPreset(cameraId: String, preset: Int): Boolean
Content copied to clipboard
Sets the current position for the given camera as the given preset.
Link copied to clipboard
abstract fun setPTZ(cameraId: String, value: CameraPTZValue): Boolean
Content copied to clipboard
Set the absolute moving value of PTZ.
Link copied to clipboard
abstract fun setTrackingMode(cameraId: String, trackingMode: String): Boolean
Content copied to clipboard
Sets tracking mode of the given camera.
Link copied to clipboard
abstract fun setVirtualCamerasEnabled(cameraId: String, enabled: Boolean): Boolean
Content copied to clipboard
Enable / Disable virtual cameras for the given logical camera.
Link copied to clipboard
abstract fun startMoving(cameraId: String, direction: CameraMoveDirection)
Content copied to clipboard
Start moving the camera in the given direction
Link copied to clipboard
abstract fun stopMoving(cameraId: String)
Content copied to clipboard
Stop moving the camera
Link copied to clipboard
abstract fun unRegisterCameraListener(cameraListener: IPolyCameraListener)
Content copied to clipboard
Un Register IPolyCameraListener

Properties

Link copied to clipboard
val DEVICE_TYPE_CAMERA: Int
Content copied to clipboard
Indicating that the device is a camera.
Link copied to clipboard
val DEVICE_TYPE_DEFAULT: Int
Content copied to clipboard
Indicating that this is a default device.
Link copied to clipboard
val DEVICE_TYPE_DOCUMENT_CAMERA: Int
Content copied to clipboard
Indicating that the device is a document camera.
Link copied to clipboard
val DEVICE_TYPE_HDMI_INPUT: Int
Content copied to clipboard
Indicating that the device is an HDMI input camera.
Link copied to clipboard
val DEVICE_TYPE_WHITEBOARD_CAMERA: Int
Content copied to clipboard
Indicating that the device is a whiteboard camera.
Link copied to clipboard
val IMAGE_DATA_FORMAT_NV12: Int
Content copied to clipboard
Indicating the NV12 format.
Link copied to clipboard
val IMAGE_DATA_FORMAT_YUV_420_888: Int
Content copied to clipboard
Indicating the YUV_420_888 format.