Skip to content

Latest commit

 

History

History
1231 lines (685 loc) · 22.5 KB

ONVIFClient.md

File metadata and controls

1231 lines (685 loc) · 22.5 KB

Yellowstone / ONVIFClient

Class: ONVIFClient

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ONVIFClient(username, password)

Parameters

Name Type
username string
password string

Overrides

RTSPClient.constructor

Defined in

lib/ONVIFClient.ts:5

Properties

_cSeq

_cSeq: number = 0

Inherited from

RTSPClient._cSeq

Defined in

lib/RTSPClient.ts:96


_client

Optional _client: Socket

Inherited from

RTSPClient._client

Defined in

lib/RTSPClient.ts:95


_keepAliveID

Optional _keepAliveID: Timeout

Inherited from

RTSPClient._keepAliveID

Defined in

lib/RTSPClient.ts:100


_nextFreeInterleavedChannel

_nextFreeInterleavedChannel: number = 0

Inherited from

RTSPClient._nextFreeInterleavedChannel

Defined in

lib/RTSPClient.ts:101


_nextFreeUDPPort

_nextFreeUDPPort: number = 5000

Inherited from

RTSPClient._nextFreeUDPPort

Defined in

lib/RTSPClient.ts:102


_session

Optional _session: string

Inherited from

RTSPClient._session

Defined in

lib/RTSPClient.ts:99


_unsupportedExtensions

Optional _unsupportedExtensions: string[]

Inherited from

RTSPClient._unsupportedExtensions

Defined in

lib/RTSPClient.ts:97


_url

Optional _url: string

Inherited from

RTSPClient._url

Defined in

lib/RTSPClient.ts:94


clientSSRC

clientSSRC: number

Inherited from

RTSPClient.clientSSRC

Defined in

lib/RTSPClient.ts:124


closed

closed: boolean = false

Inherited from

RTSPClient.closed

Defined in

lib/RTSPClient.ts:90


headers

headers: Object

Index signature

▪ [key: string]: string

Inherited from

RTSPClient.headers

Defined in

lib/RTSPClient.ts:87


isConnected

isConnected: boolean = false

Inherited from

RTSPClient.isConnected

Defined in

lib/RTSPClient.ts:89


messageBytes

messageBytes: number[] = []

Inherited from

RTSPClient.messageBytes

Defined in

lib/RTSPClient.ts:108


password

password: string

Inherited from

RTSPClient.password

Defined in

lib/RTSPClient.ts:86


readState

readState: ReadStates = ReadStates.SEARCHING

Inherited from

RTSPClient.readState

Defined in

lib/RTSPClient.ts:104


rtspContentLength

rtspContentLength: number = 0

Inherited from

RTSPClient.rtspContentLength

Defined in

lib/RTSPClient.ts:113


rtspHeaders

rtspHeaders: Headers = {}

Inherited from

RTSPClient.rtspHeaders

Defined in

lib/RTSPClient.ts:115


rtspPacket

rtspPacket: Buffer

Inherited from

RTSPClient.rtspPacket

Defined in

lib/RTSPClient.ts:120


rtspPacketLength

rtspPacketLength: number = 0

Inherited from

RTSPClient.rtspPacketLength

Defined in

lib/RTSPClient.ts:119


rtspPacketPointer

rtspPacketPointer: number = 0

Inherited from

RTSPClient.rtspPacketPointer

Defined in

lib/RTSPClient.ts:121


rtspStatusLine

rtspStatusLine: string = ""

Inherited from

RTSPClient.rtspStatusLine

Defined in

lib/RTSPClient.ts:114


setupResult

setupResult: Detail[] = []

Inherited from

RTSPClient.setupResult

Defined in

lib/RTSPClient.ts:127


tcpSocket

tcpSocket: Socket

Inherited from

RTSPClient.tcpSocket

Defined in

lib/RTSPClient.ts:126


username

username: string

Inherited from

RTSPClient.username

Defined in

lib/RTSPClient.ts:85


defaultMaxListeners

Static defaultMaxListeners: number

Inherited from

RTSPClient.defaultMaxListeners

Defined in

node_modules/@types/node/events.d.ts:20

Methods

_emptyReceiverReport

_emptyReceiverReport(): Buffer

Returns

Buffer

Inherited from

RTSPClient._emptyReceiverReport

Defined in

lib/RTSPClient.ts:879


_netConnect

_netConnect(hostname, port): Promise<ONVIFClient>

Parameters

Name Type
hostname string
port number

Returns

Promise<ONVIFClient>

Inherited from

RTSPClient._netConnect

Defined in

lib/RTSPClient.ts:150


_onData

_onData(data): void

Parameters

Name Type
data Buffer

Returns

void

Inherited from

RTSPClient._onData

Defined in

lib/RTSPClient.ts:693


_sendInterleavedData

_sendInterleavedData(channel, buffer): void

Parameters

Name Type
channel number
buffer Buffer

Returns

void

Inherited from

RTSPClient._sendInterleavedData

Defined in

lib/RTSPClient.ts:853


_sendUDPData

_sendUDPData(host, port, buffer): void

Parameters

Name Type
host string
port number
buffer Buffer

Returns

void

Inherited from

RTSPClient._sendUDPData

Defined in

lib/RTSPClient.ts:871


_socketWrite

_socketWrite(socket, data): Promise<any>

Parameters

Name Type
socket Socket
data Buffer

Returns

Promise<any>

Inherited from

RTSPClient._socketWrite

Defined in

lib/RTSPClient.ts:898


addListener

addListener(event, listener): ONVIFClient

Parameters

Name Type
event string | symbol
listener (...args: any[]) => void

Returns

ONVIFClient

Inherited from

RTSPClient.addListener

Defined in

node_modules/@types/node/globals.d.ts:554


close

close(isImmediate?): Promise<void>

Parameters

Name Type Default value
isImmediate boolean false

Returns

Promise<void>

Inherited from

RTSPClient.close

Defined in

lib/RTSPClient.ts:667


connect

connect(url, «destructured»?): Promise<Detail[]>

Parameters

Name Type
url string
«destructured» Object
› connection? Connection
› keepAlive boolean

Returns

Promise<Detail[]>

Inherited from

RTSPClient.connect

Defined in

lib/RTSPClient.ts:198


emit

emit(event, ...args): boolean

Parameters

Name Type
event string | symbol
...args any[]

Returns

boolean

Inherited from

RTSPClient.emit

Defined in

node_modules/@types/node/globals.d.ts:564


eventNames

eventNames(): (string | symbol)[]

Returns

(string | symbol)[]

Inherited from

RTSPClient.eventNames

Defined in

node_modules/@types/node/globals.d.ts:569


getMaxListeners

getMaxListeners(): number

Returns

number

Inherited from

RTSPClient.getMaxListeners

Defined in

node_modules/@types/node/globals.d.ts:561


listenerCount

listenerCount(type): number

Parameters

Name Type
type string | symbol

Returns

number

Inherited from

RTSPClient.listenerCount

Defined in

node_modules/@types/node/globals.d.ts:565


listeners

listeners(event): Function[]

Parameters

Name Type
event string | symbol

Returns

Function[]

Inherited from

RTSPClient.listeners

Defined in

node_modules/@types/node/globals.d.ts:562


off

off(event, listener): ONVIFClient

Parameters

Name Type
event string | symbol
listener (...args: any[]) => void

Returns

ONVIFClient

Inherited from

RTSPClient.off

Defined in

node_modules/@types/node/globals.d.ts:558


on

on(event, listener): ONVIFClient

Parameters

Name Type
event string | symbol
listener (...args: any[]) => void

Returns

ONVIFClient

Inherited from

RTSPClient.on

Defined in

node_modules/@types/node/globals.d.ts:555


once

once(event, listener): ONVIFClient

Parameters

Name Type
event string | symbol
listener (...args: any[]) => void

Returns

ONVIFClient

Inherited from

RTSPClient.once

Defined in

node_modules/@types/node/globals.d.ts:556


pause

pause(): Promise<void>

Returns

Promise<void>

Inherited from

RTSPClient.pause

Defined in

lib/RTSPClient.ts:622


play

play(): Promise<void>

Returns

Promise<void>

Inherited from

RTSPClient.play

Defined in

lib/RTSPClient.ts:614


playFrom

playFrom(from, to?): Promise<ONVIFClient>

Parameters

Name Type
from Date
to? Date

Returns

Promise<ONVIFClient>

Defined in

lib/ONVIFClient.ts:9


playReverse

playReverse(from?, to?): Promise<ONVIFClient>

Parameters

Name Type
from? Date
to? Date

Returns

Promise<ONVIFClient>

Defined in

lib/ONVIFClient.ts:24


prependListener

prependListener(event, listener): ONVIFClient

Parameters

Name Type
event string | symbol
listener (...args: any[]) => void

Returns

ONVIFClient

Inherited from

RTSPClient.prependListener

Defined in

node_modules/@types/node/globals.d.ts:567


prependOnceListener

prependOnceListener(event, listener): ONVIFClient

Parameters

Name Type
event string | symbol
listener (...args: any[]) => void

Returns

ONVIFClient

Inherited from

RTSPClient.prependOnceListener

Defined in

node_modules/@types/node/globals.d.ts:568


rawListeners

rawListeners(event): Function[]

Parameters

Name Type
event string | symbol

Returns

Function[]

Inherited from

RTSPClient.rawListeners

Defined in

node_modules/@types/node/globals.d.ts:563


removeAllListeners

removeAllListeners(event?): ONVIFClient

Parameters

Name Type
event? string | symbol

Returns

ONVIFClient

Inherited from

RTSPClient.removeAllListeners

Defined in

node_modules/@types/node/globals.d.ts:559


removeListener

removeListener(event, listener): ONVIFClient

Parameters

Name Type
event string | symbol
listener (...args: any[]) => void

Returns

ONVIFClient

Inherited from

RTSPClient.removeListener

Defined in

node_modules/@types/node/globals.d.ts:557


request

request(requestName, headersParam?, url?): Promise<void | { headers: Headers ; mediaHeaders?: string[] }>

Parameters

Name Type
requestName string
headersParam Headers
url? string

Returns

Promise<void | { headers: Headers ; mediaHeaders?: string[] }>

Inherited from

RTSPClient.request

Defined in

lib/RTSPClient.ts:466


respond

respond(status, headersParam?): void

Parameters

Name Type
status string
headersParam Headers

Returns

void

Inherited from

RTSPClient.respond

Defined in

lib/RTSPClient.ts:593


sendAudioBackChannel

sendAudioBackChannel(audioChunk): Promise<void>

Parameters

Name Type
audioChunk Buffer

Returns

Promise<void>

Inherited from

RTSPClient.sendAudioBackChannel

Defined in

lib/RTSPClient.ts:630


setMaxListeners

setMaxListeners(n): ONVIFClient

Parameters

Name Type
n number

Returns

ONVIFClient

Inherited from

RTSPClient.setMaxListeners

Defined in

node_modules/@types/node/globals.d.ts:560


listenerCount

Static listenerCount(emitter, event): number

Deprecated

since v4.0.0

Parameters

Name Type
emitter EventEmitter
event string | symbol

Returns

number

Inherited from

RTSPClient.listenerCount

Defined in

node_modules/@types/node/events.d.ts:17


once

Static once(emitter, event): Promise<any[]>

Parameters

Name Type
emitter NodeEventTarget
event string | symbol

Returns

Promise<any[]>

Inherited from

RTSPClient.once

Defined in

node_modules/@types/node/events.d.ts:13

Static once(emitter, event): Promise<any[]>

Parameters

Name Type
emitter DOMEventTarget
event string

Returns

Promise<any[]>

Inherited from

RTSPClient.once

Defined in

node_modules/@types/node/events.d.ts:14