RtcPlayer

Playback player core class.

Constructor

new RtcPlayer(options: RtcPlayerOptions)

Methods

play() async

Start playback.

await player.play();

switchStream(url) async

Switch playback URL.

await player.switchStream('webrtc://localhost/live/newstream');

use(plugin) sync

Register and install a plugin. Returns this for chaining.

import { createPlayerLoggerPlugin } from '@webrtc-player/plugin-logger';

player.use(createPlayerLoggerPlugin());

See Plugin System for details.

unuse(name) sync

Uninstall a plugin by name.

player.unuse('player-logger');

destroy()

Destroy instance.

player.destroy();

Events

Event	Description
track	Remote stream received
state	Connection state
error	Error

Usage Example

import { RtcPlayer } from '@webrtc-player/core';

const player = new RtcPlayer({
  url: 'webrtc://localhost/live/livestream',
  api: 'http://localhost:1985/rtc/v1/play/',
  video: videoElement,
});

player.on('track', ({ stream }) => (video.srcObject = stream));
player.on('state', (state) => console.log(state));
player.play();