Skip to main content

Interface: Plugin

Properties

playbackVolume

readonly playbackVolume: Volume

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:13


supportedTransports

readonly supportedTransports: Transport[]

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:14


version

readonly version: "3"

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:12

Methods

close()

close(): void

Returns

void

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:23


createAudioCapture()

createAudioCapture(parameters): Promise<AudioCapture>

Parameters

parameters: CreateAudioCaptureParameters

Returns

Promise<AudioCapture>

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:17


createAudioPlayback()

createAudioPlayback(parameters): Promise<AudioPlayback>

Parameters

parameters: CreateAudioPlaybackParameters

Returns

Promise<AudioPlayback>

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:16


createVideoCapture()

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

Parameters

ms: MediaStream

customType?: string

Returns

Promise<VideoCapture>

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:18


createVideoPlayback()

createVideoPlayback(parameters): Promise<VideoPlayback>

Parameters

parameters: CreateVideoPlaybackParameters

Returns

Promise<VideoPlayback>

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:19


enumerateDevices()

enumerateDevices(): Promise<Device[]>

Returns

Promise<Device[]>

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:20


joinRoom()

joinRoom(parameters): Room

Parameters

parameters: JoinRoomParameters

Returns

Room

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:15


setOutputDevice()

setOutputDevice(device): Promise<void>

Parameters

device: DeviceParameters

Returns

Promise<void>

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:22


setOutputVolume()

setOutputVolume(volume): void

Parameters

volume: Volume

Returns

void

Defined in

Odin/odin-typescript/node_modules/@4players/odin-common/lib/plugin/api.d.ts:21