@omniview/cameras-sdk NPM

Omniview Cameras SDK

Cameras SDK is a library for managament all cameras types includes in Omniview Platform

Installation

Use the package manager npm to install Cameras SDK.

npm i @omniview/cameras-sdk

Usage

Initialization

import { Camera } from '@omniview/cameras-sdk';

let omniviewCamera = new Camera('camera_manager', {
    cameraId: `${id}`,
    token: `${token}`,
    htmlElement: `${container}`, // can be a class selector or DOM Object
    apiUrl: `${apiUrl}`,
});

Live Video

omniviewCamera.buildPlayer();

Recorded Video

omniviewCamera.buildPlayer('historical', `2022-08-05 03:53:58`, `2022-08-05 05:52:58`);

Options

cameraId

Description:

It's the id for camera that you want watch live video or recorded video

Type: String

Required: true

Default: undefined

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    cameraId: `${id}`,
    ...
})

token

Description:

It's the token provided from the API of Omniview

Type: String

Required: true

Default: undefined

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    token: `${token}`,
    ...
})

htmlElement

Description:

It could be an string query selector or DOM object

Type: String | DOM Object

Required: true

Default: undefined

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    htmlElement: `.container`,
    ...
})

nameSufix

Description:

It's a text that attaches after of name of the camera

Type: String

Required: false

Default:

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    htmlElement: `.container`,
    ...
})

mode

Description:

It's for bind this SDK with timeline SDK, it could be timeline or default

Type: String

Required: false

Default: default

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    mode: `timeline`,
    ...
})

groupId

Description:

It's unique identifier for timeline SDK

Type: String

Required: true if mode is timeline

Default:

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    groupId: `ee30a647-4b65-4a75-9f47-289d1d63e593`,
    ...
})

style

Description:

Allow two styles for video element, it could be design float or fixed for bottom an top tools

Type: String

Required: false

Default: float

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    style: `float`,
    ...
})

debugMode

Description:

Allow to show debug messages in browser console. You may set the log level info, error or both info|error

Type: String

Required: false

Default: ''

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    debugMode: `info|error`,
    ...
})

capabilities

Description:

It defines which capabilities would be used

Type: Object

Required: false

Default: {}

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    capabilities: {
        closeBtn: false
    },
    ...
})

List of capabilities

liveBtn

Description:

Show live video button

Type: boolean

Required: false

Default: false

reloadBtn

Description:

Show reload button

Type: boolean

Required: false

Default: false

speedBtns

Description:

Show speed buttons

Type: boolean

Required: false

Default: true

snapshotBtn

Description:

Show snapshot button

Type: boolean

Required: false

Default: false

dateRangeBtn

Description:

Show date range button

Type: boolean

Required: false

Default: false

closeBtn

Description:

Show close button

Type: boolean

Required: false

Default: false

downloadBtn

Description:

Show download button

Type: boolean

Required: false

Default: false

Time zone option

Description:

Allows to set the time zone for the live cameras timestamp.

Type: String

Required: false

Default: 'Etc/GMT+6'

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    tz: 'Etc/GMT+6',
    ...
})

Time zones list

i18n option

Allows to set the language for the interface.

Type: String

Required: false

Default: 'en'

Available options:

en (English)
es (Spanish)
pt (Portuguese)

import { Camera } from "@omniview/cameras-sdk"

let omniviewCamera = new Camera('camera_manager', {
    locale: 'en',
    ...
})

Changelog

v1.1.32

add: support for luxriot cameras (live video only)

v1.1.31

add: facial recognition enrollment feature
minor fixes

v1.1.30

update: improve timeline mode
minor fixes

v1.1.29

update: default timezone Etc/GMT+6

v1.1.28

feature: support for rtsp streams

v1.1.27

minor fix

v1.1.26

update: ptz widget visible in fullscreen
improved error messages in error cases

v1.1.25

update: show timeline options even if no recordings found
minor fixes

v1.1.24

feat: support for i18n
minor fixes

v1.1.23

feat: support for WebRTC in VXG
update: update ptz controls ui

v1.1.22

feat: ptz controls

v1.1.21

feat: set video speed from timeline

v1.1.20

feat: allow create video tags from video

v1.1.19

feat: timezone option

v1.1.18

feat: support for download videos in vms type

v1.1.17

fix: minor errors

v1.1.16

fix: minor error with recording for body cam type

v1.1.15

fix: video shaking when hidden loading

v1.1.14

fix: minor errors

v1.1.13

fix: minor errors

v1.1.12

fix: minor errors

v1.1.11

fix: minor errors

v1.1.10

fix: issue with een cameras

v1.1.9

fix: timeline mode issues
fix: issue with workers in download stream

v1.1.8

fix: minor ui fixes
feat: add debug mode option

v1.1.7

fix: minor fixes

v1.1.6

feat: add support to configure download video to add a watermark fix: download videos issue fix: minor style issues

v1.1.5

update: set name and timestamp like a watermark in video element

v1.1.4

fix: minor fixes

v1.1.3

feat: buttons to sync camera with timeline

v1.1.2

fix: minor fixes

v1.1.1

add: improvements in timeline SDK implementation

v1.1.0

add: integration with timeline SDK add: design float or fixed for bottom an top tools

v1.0.9

fix: dewrap bugs

v1.0.8

fix: styling errors

v1.0.7

fix: minor errors

v1.0.6

add: dewrap for body cams

v1.0.5

fix: minor error with menu of options

v1.0.4

fix: show camera details above video component

v1.0.3

Fixed header and control bar

v1.0.2

fix: live video vms reload each five minutes

v1.0.1

add: recording button with event emit

v1.0.0

fix: permissions by camera add: options capabilities from instace sdk

v0.0.10

fix: modals errors

v0.0.9

fix: acls and modal calendar

v0.0.8

fix: video recording for vxg cameras add: acl's library add: show error when doesn't have recording vms video fix: error message for vxg cameras when not there recording

v0.0.7

add: show errors in video container

v0.0.6

Fix: minor errors

v0.0.5

Fix: video recording for vms type

v0.0.4

Add: show cuts in record video Fix: when recording video has cuts only show the first slice of video Fix: tooltip seek bar isn't visible Add: video dowload for camera manager types