Skip to main content

@auvious/media-tools / MediaPipe

Class: MediaPipe

Table of contents​

Constructors​

Properties​

Accessors​

Methods​

Constructors​

constructor​

• new MediaPipe(): MediaPipe

Returns​

MediaPipe

Properties​

effects​

• Private effects: { effect: IMediaEffect | InputEffect | SinkEffect ; stream?: MediaStream ; unsubscribe: () => void }[] = []


events​

• events: Events<IMediaPipeEvents>


input​

• input: InputEffect


sink​

• sink: SinkEffect


unusedTracks​

• Private unusedTracks: Set<MediaStreamTrack>

Accessors​

streamIn​

• get streamIn(): undefined | MediaStream

Returns​

undefined | MediaStream


streamOut​

• get streamOut(): undefined | MediaStream

Returns​

undefined | MediaStream

Methods​

addEffect​

▸ addEffect(effect): void

Parameters​

NameType
effectIMediaEffect

Returns​

void


deleteMetadata​

▸ deleteMetadata(effect): void

Parameters​

NameType
effectIMediaEffect | InputEffect | SinkEffect

Returns​

void


getMetadataIndex​

▸ getMetadataIndex(effect): number

Parameters​

NameType
effectIMediaEffect | InputEffect | SinkEffect

Returns​

number


handleOutput​

▸ handleOutput(effect, stream): void

Parameters​

NameType
effectIMediaEffect | InputEffect | SinkEffect
streamMediaStream

Returns​

void


outputChanged​

▸ outputChanged(a?, b?): boolean

Parameters​

NameType
a?MediaStream
b?MediaStream

Returns​

boolean


removeEffect​

▸ removeEffect(effect): void

Parameters​

NameType
effectIMediaEffect

Returns​

void


reset​

▸ reset(): void

Returns​

void


setup​

▸ setup(): void

Returns​

void


stopUnusedTracks​

▸ stopUnusedTracks(): void

Returns​

void