Segmenter

Extends

- Process<Partial<RendererOptions>>

Properties

Property	Type	Inherited from
status	| "closed" | "closing" | "Error" | "destroyed" | "destroying" | "idle" | "new" | "opened" | "opening" | "processing" | "updated" | "updating"	Process.status
modelAsset	SegmentationModelAsset	-
backgroundImage?	BackgroundImage	-

Methods

close()

close(): Promise<void>;

Returns

Promise<void>

Inherited from

Process.close

---

destroy()

destroy(): Promise<void>;

Returns

Promise<void>

Inherited from

Process.destroy

---

open()

open(options?): Promise<Partial<RendererOptions>>;

Initialize the Segmenter as well as the underlying worker. It is expected to be called once.

Parameters

Parameter	Type
options?	ProcessorOptions

Returns

Promise<Partial<RendererOptions>>

Overrides

Process.open

---

update()

update(options): Promise<Partial<RendererOptions>>;

Update the processor options

Parameters

Parameter	Type
options	ProcessorOptions

Returns

Promise<Partial<RendererOptions>>

---

mute()

mute(muted): void;

Mute/unmute the track in the worker

Parameters

Parameter	Type
muted	boolean

Returns

void

---

process()

Call Signature

process(input, options?): Promise<MediaStreamTrack>;

Process provided input

Parameters

Parameter	Type
input	MediaStreamTrack
options?	RendererOptions

Returns

Promise<MediaStreamTrack>

Call Signature

process(input, options?): Promise<
  | ReadWritableStream<VideoFrame>
| undefined>;

Parameters

Parameter	Type
input	ReadWritableStream<VideoFrame>
options?	RendererOptions

Returns

Promise<

| ReadWritableStream<VideoFrame>

| undefined>

Call Signature

process(input, options?): Promise<
  | MediaStreamTrack
  | ReadWritableStream<VideoFrame>
| undefined>;

Parameters

Parameter	Type
input	| MediaStreamTrack | ReadWritableStream<VideoFrame>
options?	RendererOptions

Returns

Promise<

| MediaStreamTrack

| ReadWritableStream<VideoFrame>

| undefined>

---

subscribe()

subscribe(event, callback): Unsubscribe;

Subscribe rendering events,

Parameters

Parameter	Type
event	| "Error" | "ContextCreationError" | "ContextLost" | "ContextRestored" | "ProcessorRestarted" | "SamplingError"
callback	Callback<void>

Returns

Unsubscribe

See

RenderingEvents