camera.ui Node SDK

Appearance

@camera.ui/sdk / camera / RtpSession

Interface: RtpSession ​

Defined in: camera/streaming.ts:276

RTP streaming session for RTP-based integrations. Provides raw RTP packet access for video and audio streams.

Extends ​

  • Subscribed

Properties ​

hasBackchannel ​

readonly hasBackchannel: boolean

Defined in: camera/streaming.ts:288

Whether backchannel is available.

onAudioRtp ​

readonly onAudioRtp: Subject<RtpPacket>

Defined in: camera/streaming.ts:286

Emits audio RTP packets.

onEnded ​

readonly onEnded: ReplaySubject<void>

Defined in: camera/streaming.ts:282

Emits when stream ends.

onError ​

readonly onError: Subject<Error>

Defined in: camera/streaming.ts:280

Emits on stream errors.

onStarted ​

readonly onStarted: ReplaySubject<void>

Defined in: camera/streaming.ts:278

Emits when stream successfully starts.

onVideoRtp ​

readonly onVideoRtp: Subject<RtpPacket>

Defined in: camera/streaming.ts:284

Emits video RTP packets.

Methods ​

addAdditionalSubscriptions() ​

addAdditionalSubscriptions(...subscriptions): void

Defined in: internal/streaming-internal.ts:18

Add additional subscriptions (separate cleanup).

Parameters ​

subscriptions ​

...Disposable[]

Returns ​

void

Inherited from ​

Subscribed.addAdditionalSubscriptions

addSubscriptions() ​

addSubscriptions(...subscriptions): void

Defined in: internal/streaming-internal.ts:16

Add subscriptions to be cleaned up on unsubscribe.

Parameters ​

subscriptions ​

...Disposable[]

Returns ​

void

Inherited from ​

Subscribed.addSubscriptions

sendAudioPacket() ​

sendAudioPacket(rtp): Promise<void>

Defined in: camera/streaming.ts:309

Send audio packet to camera via backchannel.

Parameters ​

rtp ​

Buffer<ArrayBufferLike> | RtpPacket

RTP packet or raw buffer

Returns ​

Promise<void>

startBackchannel() ​

startBackchannel(config?): Promise<void>

Defined in: camera/streaming.ts:302

Start backchannel for two-way audio.

Parameters ​

config? ​

RtpSessionBackchannelOptions

Backchannel configuration

Returns ​

Promise<void>

startStream() ​

startStream(config?): Promise<void>

Defined in: camera/streaming.ts:295

Start the RTP stream.

Parameters ​

config? ​

RtpSessionOptions

Stream configuration options

Returns ​

Promise<void>

stop() ​

stop(): Promise<void>

Defined in: camera/streaming.ts:312

Stop the stream and cleanup resources.

Returns ​

Promise<void>

unsubscribe() ​

unsubscribe(): void

Defined in: internal/streaming-internal.ts:20

Unsubscribe all main subscriptions.

Returns ​

void

Inherited from ​

Subscribed.unsubscribe

unsubscribeAdditional() ​

unsubscribeAdditional(): void

Defined in: internal/streaming-internal.ts:22

Unsubscribe additional subscriptions only.

Returns ​

void

Inherited from ​

Subscribed.unsubscribeAdditional