Skip to content

Latest commit

 

History

History
1042 lines (587 loc) · 17.5 KB

RTSPClient.md

File metadata and controls

1042 lines (587 loc) · 17.5 KB

Yellowstone / RTSPClient

Class: RTSPClient

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new RTSPClient(username, password, headers?)

Parameters

Name Type
username string
password string
headers? Object

Overrides

EventEmitter.constructor

Defined in

lib/RTSPClient.ts:128

Properties

_cSeq

_cSeq: number = 0

Defined in

lib/RTSPClient.ts:96


_client

Optional _client: Socket

Defined in

lib/RTSPClient.ts:95


_keepAliveID

Optional _keepAliveID: Timeout

Defined in

lib/RTSPClient.ts:100


_nextFreeInterleavedChannel

_nextFreeInterleavedChannel: number = 0

Defined in

lib/RTSPClient.ts:101


_nextFreeUDPPort

_nextFreeUDPPort: number = 5000

Defined in

lib/RTSPClient.ts:102


_session

Optional _session: string

Defined in

lib/RTSPClient.ts:99


_unsupportedExtensions

Optional _unsupportedExtensions: string[]

Defined in

lib/RTSPClient.ts:97


_url

Optional _url: string

Defined in

lib/RTSPClient.ts:94


clientSSRC

clientSSRC: number

Defined in

lib/RTSPClient.ts:124


closed

closed: boolean = false

Defined in

lib/RTSPClient.ts:90


headers

headers: Object

Index signature

▪ [key: string]: string

Defined in

lib/RTSPClient.ts:87


isConnected

isConnected: boolean = false

Defined in

lib/RTSPClient.ts:89


messageBytes

messageBytes: number[] = []

Defined in

lib/RTSPClient.ts:108


password

password: string

Defined in

lib/RTSPClient.ts:86


readState

readState: ReadStates = ReadStates.SEARCHING

Defined in

lib/RTSPClient.ts:104


rtspContentLength

rtspContentLength: number = 0

Defined in

lib/RTSPClient.ts:113


rtspHeaders

rtspHeaders: Headers = {}

Defined in

lib/RTSPClient.ts:115


rtspPacket

rtspPacket: Buffer

Defined in

lib/RTSPClient.ts:120


rtspPacketLength

rtspPacketLength: number = 0

Defined in

lib/RTSPClient.ts:119


rtspPacketPointer

rtspPacketPointer: number = 0

Defined in

lib/RTSPClient.ts:121


rtspStatusLine

rtspStatusLine: string = ""

Defined in

lib/RTSPClient.ts:114


setupResult

setupResult: Detail[] = []

Defined in

lib/RTSPClient.ts:127


tcpSocket

tcpSocket: Socket

Defined in

lib/RTSPClient.ts:126


username

username: string

Defined in

lib/RTSPClient.ts:85


defaultMaxListeners

Static defaultMaxListeners: number

Inherited from

EventEmitter.defaultMaxListeners

Defined in

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

Methods

_emptyReceiverReport

_emptyReceiverReport(): Buffer

Returns

Buffer

Defined in

lib/RTSPClient.ts:879


_netConnect

_netConnect(hostname, port): Promise<RTSPClient>

Parameters

Name Type
hostname string
port number

Returns

Promise<RTSPClient>

Defined in

lib/RTSPClient.ts:150


_onData

_onData(data): void

Parameters

Name Type
data Buffer

Returns

void

Defined in

lib/RTSPClient.ts:693


_sendInterleavedData

_sendInterleavedData(channel, buffer): void

Parameters

Name Type
channel number
buffer Buffer

Returns

void

Defined in

lib/RTSPClient.ts:853


_sendUDPData

_sendUDPData(host, port, buffer): void

Parameters

Name Type
host string
port number
buffer Buffer

Returns

void

Defined in

lib/RTSPClient.ts:871


_socketWrite

_socketWrite(socket, data): Promise<any>

Parameters

Name Type
socket Socket
data Buffer

Returns

Promise<any>

Defined in

lib/RTSPClient.ts:898


addListener

addListener(event, listener): RTSPClient

Parameters

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

Returns

RTSPClient

Inherited from

EventEmitter.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>

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[]>

Defined in

lib/RTSPClient.ts:198


emit

emit(event, ...args): boolean

Parameters

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

Returns

boolean

Inherited from

EventEmitter.emit

Defined in

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


eventNames

eventNames(): (string | symbol)[]

Returns

(string | symbol)[]

Inherited from

EventEmitter.eventNames

Defined in

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


getMaxListeners

getMaxListeners(): number

Returns

number

Inherited from

EventEmitter.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

EventEmitter.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

EventEmitter.listeners

Defined in

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


off

off(event, listener): RTSPClient

Parameters

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

Returns

RTSPClient

Inherited from

EventEmitter.off

Defined in

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


on

on(event, listener): RTSPClient

Parameters

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

Returns

RTSPClient

Inherited from

EventEmitter.on

Defined in

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


once

once(event, listener): RTSPClient

Parameters

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

Returns

RTSPClient

Inherited from

EventEmitter.once

Defined in

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


pause

pause(): Promise<void>

Returns

Promise<void>

Defined in

lib/RTSPClient.ts:622


play

play(): Promise<void>

Returns

Promise<void>

Defined in

lib/RTSPClient.ts:614


prependListener

prependListener(event, listener): RTSPClient

Parameters

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

Returns

RTSPClient

Inherited from

EventEmitter.prependListener

Defined in

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


prependOnceListener

prependOnceListener(event, listener): RTSPClient

Parameters

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

Returns

RTSPClient

Inherited from

EventEmitter.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

EventEmitter.rawListeners

Defined in

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


removeAllListeners

removeAllListeners(event?): RTSPClient

Parameters

Name Type
event? string | symbol

Returns

RTSPClient

Inherited from

EventEmitter.removeAllListeners

Defined in

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


removeListener

removeListener(event, listener): RTSPClient

Parameters

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

Returns

RTSPClient

Inherited from

EventEmitter.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[] }>

Defined in

lib/RTSPClient.ts:466


respond

respond(status, headersParam?): void

Parameters

Name Type
status string
headersParam Headers

Returns

void

Defined in

lib/RTSPClient.ts:593


sendAudioBackChannel

sendAudioBackChannel(audioChunk): Promise<void>

Parameters

Name Type
audioChunk Buffer

Returns

Promise<void>

Defined in

lib/RTSPClient.ts:630


setMaxListeners

setMaxListeners(n): RTSPClient

Parameters

Name Type
n number

Returns

RTSPClient

Inherited from

EventEmitter.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

EventEmitter.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

EventEmitter.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

EventEmitter.once

Defined in

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