VibeLive Documentation

Docs Hub

This page organizes docs by intent: tutorials for first success, how-to guides for task execution, reference docs for exact API behavior, and examples for copy-and-run implementation patterns.

Recommended Learning Path

Progressive disclosure: easy start → practical build → full precision

Tutorial

Step 1: First working room

Get two people on live video with the smallest possible code and event set.

Open build_helloworld.html
How-to

Step 2: Practical room behavior

Add state handling, tile behavior, and event wiring patterns for production UI.

Open build_helloworld.html
Reference

Step 3: API details and gotchas

Read precise method contracts, states, events, and implementation caveats.

Open API_MINI_v0.1.md

API Reference

Server-side and integration guides

Reference

Account API

Server-to-server REST API for managing projects, rooms, and members from your backend. Uses project key or account token auth.

Open account-api.html

Examples Library

Runnable code in testmd1/docs

Example

Minimal baseline

Canonical hello-world app: room creation/join, tiles, registerTile, and startLive path.

Open helloworld.jsp
Example

Expanded app flow example

A richer implementation pattern beyond hello-world for more complete room UX and behavior.

Open CloneTiny_June4.jsp

Feature to Resource Matrix

Source-of-truth map for coverage and gaps

Feature Tutorial
feature_hello
Quick Ref
feature_mini1
Overview
feature_overview
Example
helloworld
API Spec
API_MINI
SDK init + projectId YesYesYesYesYes
Anonymous signup + room entry YesYesYesYesYes
startLive flow YesYesYesYesYes
registerTile pattern YesYesYesYesYes
memberStateChange and tile visibility YesYesYes
Display names with getMembers/getMember YesYesYes
Screenshare toggles + stream handling YesYesYes
Error and kicked handling YesYesYes
Version tagging on every example PlannedPlannedPlannedPlannedPlanned
Suggested convention: add a short banner comment at top of each example/doc, e.g. Verified against SDK v0.1.x on 2026-05-27.