Skip to main content

Interface: Plugin

Properties​

playbackVolume​

readonly playbackVolume: OutputVolume

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:10

supportedTransports​

readonly supportedTransports: Transport[]

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:11

version​

readonly version: "7"

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:9

Methods​

close()​

close(): void

Returns​

void

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:20

createAudioCapture()​

createAudioCapture(parameters): Promise<AudioCapture>

Parameters​

• parameters: CreateAudioCaptureParameters

Returns​

Promise<AudioCapture>

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:14

createAudioPlayback()​

createAudioPlayback(parameters): Promise<AudioPlayback>

Parameters​

• parameters: CreateAudioPlaybackParameters

Returns​

Promise<AudioPlayback>

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:13

createVideoCapture()​

createVideoCapture(ms, options?): Promise<VideoCapture>

Parameters​

• ms: MediaStream

• options?: VideoInputOptions

Returns​

Promise<VideoCapture>

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:15

createVideoPlayback()​

createVideoPlayback(parameters): Promise<VideoPlayback>

Parameters​

• parameters: CreateVideoPlaybackParameters

Returns​

Promise<VideoPlayback>

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:16

enumerateDevices()​

enumerateDevices(): Promise<Device[]>

Returns​

Promise<Device[]>

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:17

joinRoom()​

joinRoom(parameters): Room

Parameters​

• parameters: JoinRoomParameters

Returns​

Room

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:12

setOutputDevice()​

setOutputDevice(device): Promise<void>

Parameters​

• device: DeviceParameters

Returns​

Promise<void>

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:19

setOutputVolume()​

setOutputVolume(volume): void

Parameters​

• volume: OutputVolume

Returns​

void

Defined in​

ari/node_modules/@4players/odin-common/plugin/api.d.ts:18