grandi / FrameSync

Interface: FrameSync

Defined in: types.ts:280

Methods

audio()

audio(options): Promise<ReceivedAudioFrame>

Defined in: types.ts:293

Captures audio using NDI frame-synchronization (resampled to match your calls). Always returns immediately and may insert silence if no audio is present. samples must be greater than zero.

Parameters

options

FrameSyncAudioOptions

Returns

Promise<ReceivedAudioFrame>

---

audioFormat()

audioFormat(): FrameSyncAudioFormat | undefined

Defined in: types.ts:298

Returns the current incoming audio format, or undefined when no audio format has been received yet.

Returns

FrameSyncAudioFormat | undefined

---

audioQueueDepth()

audioQueueDepth(): number

Defined in: types.ts:302

Returns an approximate depth of the internal audio queue in samples.

Returns

number

---

destroy()

destroy(): boolean

Defined in: types.ts:303

Returns

boolean

---

video()

video(fieldType?): Promise<ReceivedVideoFrame | TimeoutEvent>

Defined in: types.ts:287

Captures a video frame using NDI frame-synchronization (time base correction). Always returns immediately.

If no video has ever been received, resolves with { type: "timeout" }.

Parameters

fieldType?

FrameType

Returns

Promise<ReceivedVideoFrame | TimeoutEvent>