VDO.Ninja SDK — API Reference

Tip: avoid reserved SDK types (subscribe | unsubscribe | channelMessage) for custom protocols.

Constructor

const vdo = new VDONinjaSDK(options)

• host: WebSocket URL (default: wss://wss.vdo.ninja)
• room: Initial room to join (optional)
• password: Room password or false to disable encryption
• label: Optional human-readable label
• debug: Enable verbose logs
• turnServers: null=auto, false=disable, or custom ICE servers
• forceTURN: Force relay mode (boolean)

Connection

• connect(), disconnect()
• joinRoom({ room, password }), leaveRoom()
• autoConnect(roomOrOptions, filter?) → { stop, streamID }

Publishing

• publish(stream, { streamID, room?, label?, password? })
• announce({ streamID?, room?, label?, password? })
• stopPublishing()

Viewing

• view(streamID, { audio=true, video=true, label? })
• stopViewing(streamID)

Quick Helpers

• quickPublish({ stream, room?, streamID?, label?, password? })
• quickView({ streamID, room?, audio?, video?, label?, password?, dataOnly? })
• quickSubscribe({ streamID, room?, ... }) (defaults to data-only)

Data Communication

• sendData(data, target?) — flexible targeting with DC and fallback
• sendPing(uuid?)
• request(type, data, targetUUID, timeout?), respond(id, data, targetUUID)
• onRequest(type, handler)

Pub/Sub

• subscribe(channels), unsubscribe(channels), getSubscriptions()
• publishToChannel(channel, data, target='all')
• getPeerSubscriptions(uuid)
• Events: channelMessage, peerSubscribed, peerUnsubscribed

Utilities & Aliases

• getStats(uuid?)
• Aliases: play|watch|startViewing → view, stream|broadcast|startPublishing|share → publish, quickStream|quickBroadcast|quickShare → quickPublish, stop|stopPlaying|stopWatching → stopViewing, stopStreaming|stopBroadcasting|stopSharing|unpublish → stopPublishing, join|enterRoom|enter → joinRoom, leave|exitRoom → leaveRoom

Events (Selected)

• Connection: connected, disconnected, reconnecting, reconnected, reconnectFailed
• Room: roomJoined, roomLeft, listing, peerListing
• Peer/DC: peerConnected, peerDisconnected, dataChannelOpen, dataChannelClose, peerInfo, peerLatency
• Data: dataReceived (dataRecieved alias), data
• Media: track, trackAdded, trackRemoved, trackReplaced
• State: publishing, publishingStopped, viewingStopped, iceRestart, connectionFailed, alert, error

See README and demos for examples.