Skip to content

grandi / Receiver

Interface: Receiver ​

Defined in: types.ts:188

Properties ​

allowVideoFields ​

allowVideoFields: boolean

Defined in: types.ts:192


bandwidth ​

bandwidth: Bandwidth

Defined in: types.ts:191


colorFormat ​

colorFormat: ColorFormat

Defined in: types.ts:190


name? ​

optional name?: string

Defined in: types.ts:193


source ​

source: Source

Defined in: types.ts:189

Methods ​

audio() ​

Call Signature ​

audio(timeoutMs?): Promise<ReceivedAudioFrame>

Defined in: types.ts:195

Parameters ​
timeoutMs? ​

number

Returns ​

Promise<ReceivedAudioFrame>

Call Signature ​

audio(options, timeoutMs?): Promise<ReceivedAudioFrame>

Defined in: types.ts:196

Parameters ​
options ​

AudioReceiveOptions

timeoutMs? ​

number

Returns ​

Promise<ReceivedAudioFrame>


connections() ​

connections(): number

Defined in: types.ts:210

Returns ​

number


data() ​

Call Signature ​

data(timeoutMs?): Promise<ReceiverDataFrame>

Defined in: types.ts:201

Parameters ​
timeoutMs? ​

number

Returns ​

Promise<ReceiverDataFrame>

Call Signature ​

data(options, timeoutMs?): Promise<ReceiverDataFrame>

Defined in: types.ts:202

Parameters ​
options ​

AudioReceiveOptions

timeoutMs? ​

number

Returns ​

Promise<ReceiverDataFrame>


destroy() ​

destroy(): boolean

Defined in: types.ts:207

Returns ​

boolean


metadata() ​

metadata(timeoutMs?): Promise<ReceivedMetadataFrame>

Defined in: types.ts:200

Parameters ​

timeoutMs? ​

number

Returns ​

Promise<ReceivedMetadataFrame>


performance() ​

performance(): ReceiverPerformance

Defined in: types.ts:208

Returns ​

ReceiverPerformance


queue() ​

queue(): ReceiverQueue

Defined in: types.ts:209

Returns ​

ReceiverQueue


tally() ​

tally(state): boolean

Defined in: types.ts:206

Parameters ​

state ​

ReceiverTallyState

Returns ​

boolean


video() ​

video(timeoutMs?): Promise<ReceivedVideoFrame>

Defined in: types.ts:194

Parameters ​

timeoutMs? ​

number

Returns ​

Promise<ReceivedVideoFrame>

Apache-2.0 licensed. NDI is a trademark of Vizrt NDI AB.